0.9.4.16:
[sbcl.git] / src / runtime / linux-os.c
1 /*
2  * the Linux incarnation of OS-dependent routines.  See also
3  * $(sbcl_arch)-linux-os.c
4  *
5  * This file (along with os.h) exports an OS-independent interface to
6  * the operating system VM facilities. Surprise surprise, this
7  * interface looks a lot like the Mach interface (but simpler in some
8  * places). For some operating systems, a subset of these functions
9  * will have to be emulated.
10  */
11
12 /*
13  * This software is part of the SBCL system. See the README file for
14  * more information.
15  *
16  * This software is derived from the CMU CL system, which was
17  * written at Carnegie Mellon University and released into the
18  * public domain. The software is in the public domain and is
19  * provided with absolutely no warranty. See the COPYING and CREDITS
20  * files for more information.
21  */
22
23 #include <stdio.h>
24 #include <sys/param.h>
25 #include <sys/file.h>
26 #include "sbcl.h"
27 #include "./signal.h"
28 #include "os.h"
29 #include "arch.h"
30 #include "globals.h"
31 #include "interrupt.h"
32 #include "interr.h"
33 #include "lispregs.h"
34 #include "runtime.h"
35 #include "genesis/static-symbols.h"
36 #include "genesis/fdefn.h"
37 #include <sys/socket.h>
38 #include <sys/utsname.h>
39
40 #include <sys/types.h>
41 #include <signal.h>
42 /* #include <sys/sysinfo.h> */
43 #include <sys/time.h>
44 #include <sys/stat.h>
45 #include <unistd.h>
46 #include <linux/version.h>
47
48 #include "validate.h"
49 #include "thread.h"
50 #include "gc.h"
51 #if defined LISP_FEATURE_GENCGC
52 #include "gencgc-internal.h"
53 #endif
54
55 #ifdef LISP_FEATURE_LINUX
56 #include <sys/personality.h>
57 #endif
58
59 size_t os_vm_page_size;
60
61 #ifdef LISP_FEATURE_SB_THREAD
62 #include <sys/syscall.h>
63 #include <unistd.h>
64 #include <errno.h>
65
66 /* values taken from the kernel's linux/futex.h.  This header file
67    doesn't exist in userspace, which is our excuse for not grovelling
68    them automatically */
69 #define FUTEX_WAIT (0)
70 #define FUTEX_WAKE (1)
71 #define FUTEX_FD (2)
72 #define FUTEX_REQUEUE (3)
73
74 #define sys_futex sbcl_sys_futex
75 static inline int sys_futex (void *futex, int op, int val, struct timespec *rel)
76 {
77     return syscall (SYS_futex, futex, op, val, rel);
78 }
79
80 int
81 futex_wait(int *lock_word, int oldval)
82 {
83     int t= sys_futex(lock_word,FUTEX_WAIT,oldval, 0);
84     return t;
85 }
86
87 int
88 futex_wake(int *lock_word, int n)
89 {
90     return sys_futex(lock_word,FUTEX_WAKE,n,0);
91 }
92 #endif
93
94 \f
95 int linux_sparc_siginfo_bug = 0;
96 int linux_no_threads_p = 0;
97
98 void
99 os_init(char *argv[], char *envp[])
100 {
101     /* Conduct various version checks: do we have enough mmap(), is
102      * this a sparc running 2.2, can we do threads? */
103 #ifdef LISP_FEATURE_SB_THREAD
104     int *futex=0;
105 #endif
106     struct utsname name;
107     int major_version;
108     int minor_version;
109     char *p;
110     uname(&name);
111     p=name.release;
112     major_version = atoi(p);
113     p=strchr(p,'.')+1;
114     minor_version = atoi(p);
115     if (major_version<2) {
116         lose("linux kernel version too old: major version=%d (can't run in version < 2.0.0)",
117              major_version);
118     }
119     if (!(major_version>2 || minor_version >= 4)) {
120 #ifdef LISP_FEATURE_SPARC
121         FSHOW((stderr,"linux kernel %d.%d predates 2.4;\n enabling workarounds for SPARC kernel bugs in signal handling.\n", major_version,minor_version));
122         linux_sparc_siginfo_bug = 1;
123 #endif
124     }
125 #ifdef LISP_FEATURE_SB_THREAD
126     futex_wait(futex,-1);
127     if(errno==ENOSYS)  linux_no_threads_p = 1;
128     if(linux_no_threads_p)
129         fprintf(stderr,"Linux with NPTL support (e.g. kernel 2.6 or newer) required for \nthread-enabled SBCL.  Disabling thread support.\n\n");
130 #endif
131     os_vm_page_size = getpagesize();
132
133     /* KLUDGE: Disable memory randomization on new Linux kernels
134      * by setting a personality flag and re-executing. (We need
135      * to re-execute, since the memory maps that can conflict with
136      * the SBCL spaces have already been done at this point).
137      */
138 #if defined(LISP_FEATURE_X86)
139     if ((major_version == 2 && minor_version >= 6)
140         || major_version >= 3)
141      {
142        long pers = personality(-1);
143        /* 0x40000 aka. ADDR_NO_RANDOMIZE */
144        if (!(pers & 0x40000)) {
145           if (personality(pers | 0x40000) != -1) {
146              char runtime[PATH_MAX+1];
147              /* Use /proc/self/exe instead of trying to figure out the
148               * executable path from PATH and argv[0], since that's
149               * unreliable.
150               */
151              if (readlink("/proc/self/exe", runtime, PATH_MAX) != -1) {
152                 execve(runtime, argv, envp);
153              }
154           }
155           /* Either changing the personality or execve() failed. Either
156            * way we might as well continue, and hope that the random
157            * memory maps are ok this time around.
158            */
159           fprintf(stderr, "WARNING: Couldn't re-execute SBCL with the proper personality flags (maybe /proc isn't mounted?). Trying to continue anyway.\n");
160        }
161     }
162 #endif
163 }
164
165
166 #ifdef LISP_FEATURE_ALPHA
167 /* The Alpha is a 64 bit CPU.  SBCL is a 32 bit application.  Due to all
168  * the places that assume we can get a pointer into a fixnum with no
169  * information loss, we have to make sure it allocates all its ram in the
170  * 0-2Gb region.  */
171
172 static void * under_2gb_free_pointer=DYNAMIC_1_SPACE_END;
173 #endif
174
175 os_vm_address_t
176 os_validate(os_vm_address_t addr, os_vm_size_t len)
177 {
178     int flags =  MAP_PRIVATE | MAP_ANONYMOUS | MAP_NORESERVE;
179     os_vm_address_t actual;
180
181 #ifdef LISP_FEATURE_ALPHA
182     if (!addr) {
183         addr=under_2gb_free_pointer;
184     }
185 #endif
186     actual = mmap(addr, len, OS_VM_PROT_ALL, flags, -1, 0);
187     if (actual == MAP_FAILED || (addr && (addr!=actual))) {
188         perror("mmap");
189         return 0;               /* caller should check this */
190     }
191
192 #ifdef LISP_FEATURE_ALPHA
193
194     len=(len+(os_vm_page_size-1))&(~(os_vm_page_size-1));
195     under_2gb_free_pointer+=len;
196 #endif
197
198     return actual;
199 }
200
201 void
202 os_invalidate(os_vm_address_t addr, os_vm_size_t len)
203 {
204     if (munmap(addr,len) == -1) {
205         perror("munmap");
206     }
207 }
208
209 os_vm_address_t
210 os_map(int fd, int offset, os_vm_address_t addr, os_vm_size_t len)
211 {
212     os_vm_address_t actual;
213
214     actual = mmap(addr, len, OS_VM_PROT_ALL, MAP_PRIVATE | MAP_FIXED,
215                   fd, (off_t) offset);
216     if (actual == MAP_FAILED || (addr && (addr != actual))) {
217         perror("mmap");
218         lose("unexpected mmap(..) failure");
219     }
220
221     return actual;
222 }
223
224 void
225 os_protect(os_vm_address_t address, os_vm_size_t length, os_vm_prot_t prot)
226 {
227     if (mprotect(address, length, prot) == -1) {
228         perror("mprotect");
229     }
230 }
231 \f
232 boolean
233 is_valid_lisp_addr(os_vm_address_t addr)
234 {
235     struct thread *th;
236     size_t ad = (size_t) addr;
237
238     if ((READ_ONLY_SPACE_START <= ad && ad < READ_ONLY_SPACE_END)
239         || (STATIC_SPACE_START <= ad && ad < STATIC_SPACE_END)
240 #if defined LISP_FEATURE_GENCGC
241         || (DYNAMIC_SPACE_START <= ad && ad < DYNAMIC_SPACE_END)
242 #else
243         || (DYNAMIC_0_SPACE_START <= ad && ad < DYNAMIC_0_SPACE_END)
244         || (DYNAMIC_1_SPACE_START <= ad && ad < DYNAMIC_1_SPACE_END)
245 #endif
246         )
247         return 1;
248     for_each_thread(th) {
249         if((size_t)(th->control_stack_start) <= ad
250            && ad < (size_t)(th->control_stack_end))
251             return 1;
252         if((size_t)(th->binding_stack_start) <= ad
253            && ad < (size_t)(th->binding_stack_start + BINDING_STACK_SIZE))
254             return 1;
255     }
256     return 0;
257 }
258 \f
259 /*
260  * any OS-dependent special low-level handling for signals
261  */
262
263
264 #if defined LISP_FEATURE_GENCGC
265
266 /*
267  * The GENCGC needs to be hooked into whatever signal is raised for
268  * page fault on this OS.
269  */
270 static void
271 sigsegv_handler(int signal, siginfo_t *info, void* void_context)
272 {
273     os_context_t *context = arch_os_get_context(&void_context);
274     void* fault_addr = (void*)info->si_addr;
275     if (!gencgc_handle_wp_violation(fault_addr))
276         if(!handle_guard_page_triggered(context,fault_addr))
277 #ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
278             arrange_return_to_lisp_function(context, SymbolFunction(MEMORY_FAULT_ERROR));
279 #else
280             interrupt_handle_now(signal, info, context);
281 #endif
282 }
283
284 #else
285
286 static void
287 sigsegv_handler(int signal, siginfo_t *info, void* void_context)
288 {
289     os_context_t *context = arch_os_get_context(&void_context);
290     os_vm_address_t addr = arch_get_bad_addr(signal,info,context);
291
292 #ifdef LISP_FEATURE_ALPHA
293     /* Alpha stuff: This is the end of a pseudo-atomic section during
294        which a signal was received.  We must deal with the pending
295        interrupt (see also interrupt.c, ../code/interrupt.lisp)
296
297        (how we got here: when interrupting, we set bit 63 in reg_ALLOC.
298        At the end of the atomic section we tried to write to reg_ALLOC,
299        got a SIGSEGV (there's nothing mapped there) so ended up here. */
300     if (addr != NULL &&
301         *os_context_register_addr(context,reg_ALLOC) & (1L<<63)){
302         *os_context_register_addr(context,reg_ALLOC) -= (1L<<63);
303         interrupt_handle_pending(context);
304         return;
305     }
306 #endif
307
308     if(!interrupt_maybe_gc(signal, info, context))
309         if(!handle_guard_page_triggered(context,addr))
310             interrupt_handle_now(signal, info, context);
311 }
312 #endif
313
314 void
315 os_install_interrupt_handlers(void)
316 {
317     undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
318                                                  sigsegv_handler);
319 #ifdef LISP_FEATURE_SB_THREAD
320     undoably_install_low_level_interrupt_handler(SIG_INTERRUPT_THREAD,
321                                                  interrupt_thread_handler);
322     undoably_install_low_level_interrupt_handler(SIG_STOP_FOR_GC,
323                                                  sig_stop_for_gc_handler);
324 #endif
325 }