0.9.5.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_X86
56 /* Prototype for personality(2). Done inline here since the header file
57  * for this isn't available on old versions of glibc. */
58 int personality (unsigned long);
59 #endif
60
61 size_t os_vm_page_size;
62
63 #ifdef LISP_FEATURE_SB_THREAD
64 #include <sys/syscall.h>
65 #include <unistd.h>
66 #include <errno.h>
67
68 /* values taken from the kernel's linux/futex.h.  This header file
69    doesn't exist in userspace, which is our excuse for not grovelling
70    them automatically */
71 #define FUTEX_WAIT (0)
72 #define FUTEX_WAKE (1)
73 #define FUTEX_FD (2)
74 #define FUTEX_REQUEUE (3)
75
76 #define sys_futex sbcl_sys_futex
77 static inline int sys_futex (void *futex, int op, int val, struct timespec *rel)
78 {
79     return syscall (SYS_futex, futex, op, val, rel);
80 }
81
82 int
83 futex_wait(int *lock_word, int oldval)
84 {
85     int t= sys_futex(lock_word,FUTEX_WAIT,oldval, 0);
86     return t;
87 }
88
89 int
90 futex_wake(int *lock_word, int n)
91 {
92     return sys_futex(lock_word,FUTEX_WAKE,n,0);
93 }
94 #endif
95
96 \f
97 int linux_sparc_siginfo_bug = 0;
98 int linux_no_threads_p = 0;
99
100 #ifdef LISP_FEATURE_SB_THREAD
101 int
102 isnptl (void)
103 {
104   size_t n = confstr (_CS_GNU_LIBPTHREAD_VERSION, NULL, 0);
105   if (n > 0) {
106       char *buf = alloca (n);
107       confstr (_CS_GNU_LIBPTHREAD_VERSION, buf, n);
108       if (strstr (buf, "NPTL")) {
109           return 1;
110       }
111   }
112   return 0;
113 }
114 #endif
115
116 void
117 os_init(char *argv[], char *envp[])
118 {
119     /* Conduct various version checks: do we have enough mmap(), is
120      * this a sparc running 2.2, can we do threads? */
121 #ifdef LISP_FEATURE_SB_THREAD
122     int *futex=0;
123 #endif
124     struct utsname name;
125     int major_version;
126     int minor_version;
127     char *p;
128     uname(&name);
129     p=name.release;
130     major_version = atoi(p);
131     p=strchr(p,'.')+1;
132     minor_version = atoi(p);
133     if (major_version<2) {
134         lose("linux kernel version too old: major version=%d (can't run in version < 2.0.0)",
135              major_version);
136     }
137     if (!(major_version>2 || minor_version >= 4)) {
138 #ifdef LISP_FEATURE_SPARC
139         FSHOW((stderr,"linux kernel %d.%d predates 2.4;\n enabling workarounds for SPARC kernel bugs in signal handling.\n", major_version,minor_version));
140         linux_sparc_siginfo_bug = 1;
141 #endif
142     }
143 #ifdef LISP_FEATURE_SB_THREAD
144     futex_wait(futex,-1);
145     if(errno==ENOSYS) {
146        lose("This version of SBCL is compiled with threading support, but your kernel is too old to support this.\n\
147 Please use a more recent kernel or a version of SBCL without threading support.\n");
148     }
149     if(! isnptl()) {
150        lose("This version of SBCL only works correctly with the NPTL threading library. Please use a newer glibc, use an older SBCL, or stop using LD_ASSUME_KERNEL");
151     }
152 #endif
153     os_vm_page_size = getpagesize();
154
155     /* KLUDGE: Disable memory randomization on new Linux kernels
156      * by setting a personality flag and re-executing. (We need
157      * to re-execute, since the memory maps that can conflict with
158      * the SBCL spaces have already been done at this point).
159      *
160      * Since randomization is currently implemented only on x86 kernels,
161      * don't do this trick on other platforms.
162      */
163 #ifdef LISP_FEATURE_X86
164     if ((major_version == 2 && minor_version >= 6)
165         || major_version >= 3)
166     {
167         int pers = personality(0xffffffffUL);
168         /* 0x40000 aka. ADDR_NO_RANDOMIZE */
169         if (!(pers & 0x40000)) {
170             int retval = personality(pers | 0x40000);
171             /* Allegedly some Linux kernels (the reported case was
172              * "hardened Linux 2.6.7") won't set the new personality,
173              * but nor will they return -1 for an error. So as a
174              * workaround query the new personality...
175              */
176             int newpers = personality(0xffffffffUL);
177             /* ... and don't re-execute if either the setting resulted
178              * in an error or if the value didn't change. Otherwise
179              * this might result in an infinite loop.
180              */
181             if (retval != -1 && newpers != pers) {
182                 /* Use /proc/self/exe instead of trying to figure out
183                  * the executable path from PATH and argv[0], since
184                  * that's unreliable. We follow the symlink instead of
185                  * executing the file directly in order to prevent top
186                  * from displaying the name of the process as "exe". */
187                 char runtime[PATH_MAX+1];
188                 int i = readlink("/proc/self/exe", runtime, PATH_MAX);
189                 if (i != -1) {
190                     runtime[i] = '\0';
191                     execve(runtime, argv, envp);
192                 }
193             }
194             /* Either changing the personality or execve() failed. Either
195              * way we might as well continue, and hope that the random
196              * memory maps are ok this time around.
197              */
198             fprintf(stderr, "WARNING: Couldn't re-execute SBCL with the proper personality flags (maybe /proc isn't mounted?). Trying to continue anyway.\n");
199         }
200     }
201 #endif
202 }
203
204
205 #ifdef LISP_FEATURE_ALPHA
206 /* The Alpha is a 64 bit CPU.  SBCL is a 32 bit application.  Due to all
207  * the places that assume we can get a pointer into a fixnum with no
208  * information loss, we have to make sure it allocates all its ram in the
209  * 0-2Gb region.  */
210
211 static void * under_2gb_free_pointer=DYNAMIC_1_SPACE_END;
212 #endif
213
214 os_vm_address_t
215 os_validate(os_vm_address_t addr, os_vm_size_t len)
216 {
217     int flags =  MAP_PRIVATE | MAP_ANONYMOUS | MAP_NORESERVE;
218     os_vm_address_t actual;
219
220 #ifdef LISP_FEATURE_ALPHA
221     if (!addr) {
222         addr=under_2gb_free_pointer;
223     }
224 #endif
225     actual = mmap(addr, len, OS_VM_PROT_ALL, flags, -1, 0);
226     if (actual == MAP_FAILED) {
227         perror("mmap");
228         return 0;               /* caller should check this */
229     }
230
231     if (addr && (addr!=actual)) {
232         fprintf(stderr, "mmap: wanted %lu bytes at %p, actually mapped at %p\n",
233                 (unsigned long) len, addr, actual);
234         return 0;
235     }
236
237 #ifdef LISP_FEATURE_ALPHA
238
239     len=(len+(os_vm_page_size-1))&(~(os_vm_page_size-1));
240     under_2gb_free_pointer+=len;
241 #endif
242
243     return actual;
244 }
245
246 void
247 os_invalidate(os_vm_address_t addr, os_vm_size_t len)
248 {
249     if (munmap(addr,len) == -1) {
250         perror("munmap");
251     }
252 }
253
254 os_vm_address_t
255 os_map(int fd, int offset, os_vm_address_t addr, os_vm_size_t len)
256 {
257     os_vm_address_t actual;
258
259     actual = mmap(addr, len, OS_VM_PROT_ALL, MAP_PRIVATE | MAP_FIXED,
260                   fd, (off_t) offset);
261     if (actual == MAP_FAILED || (addr && (addr != actual))) {
262         perror("mmap");
263         lose("unexpected mmap(..) failure");
264     }
265
266     return actual;
267 }
268
269 void
270 os_protect(os_vm_address_t address, os_vm_size_t length, os_vm_prot_t prot)
271 {
272     if (mprotect(address, length, prot) == -1) {
273         perror("mprotect");
274     }
275 }
276 \f
277 boolean
278 is_valid_lisp_addr(os_vm_address_t addr)
279 {
280     struct thread *th;
281     size_t ad = (size_t) addr;
282
283     if ((READ_ONLY_SPACE_START <= ad && ad < READ_ONLY_SPACE_END)
284         || (STATIC_SPACE_START <= ad && ad < STATIC_SPACE_END)
285 #if defined LISP_FEATURE_GENCGC
286         || (DYNAMIC_SPACE_START <= ad && ad < DYNAMIC_SPACE_END)
287 #else
288         || (DYNAMIC_0_SPACE_START <= ad && ad < DYNAMIC_0_SPACE_END)
289         || (DYNAMIC_1_SPACE_START <= ad && ad < DYNAMIC_1_SPACE_END)
290 #endif
291         )
292         return 1;
293     for_each_thread(th) {
294         if((size_t)(th->control_stack_start) <= ad
295            && ad < (size_t)(th->control_stack_end))
296             return 1;
297         if((size_t)(th->binding_stack_start) <= ad
298            && ad < (size_t)(th->binding_stack_start + BINDING_STACK_SIZE))
299             return 1;
300     }
301     return 0;
302 }
303 \f
304 /*
305  * any OS-dependent special low-level handling for signals
306  */
307
308
309 #if defined LISP_FEATURE_GENCGC
310
311 /*
312  * The GENCGC needs to be hooked into whatever signal is raised for
313  * page fault on this OS.
314  */
315 static void
316 sigsegv_handler(int signal, siginfo_t *info, void* void_context)
317 {
318     os_context_t *context = arch_os_get_context(&void_context);
319     void* fault_addr = (void*)info->si_addr;
320     if (!gencgc_handle_wp_violation(fault_addr))
321         if(!handle_guard_page_triggered(context,fault_addr))
322 #ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
323             arrange_return_to_lisp_function(context, SymbolFunction(MEMORY_FAULT_ERROR));
324 #else
325             interrupt_handle_now(signal, info, context);
326 #endif
327 }
328
329 #else
330
331 static void
332 sigsegv_handler(int signal, siginfo_t *info, void* void_context)
333 {
334     os_context_t *context = arch_os_get_context(&void_context);
335     os_vm_address_t addr = arch_get_bad_addr(signal,info,context);
336
337 #ifdef LISP_FEATURE_ALPHA
338     /* Alpha stuff: This is the end of a pseudo-atomic section during
339        which a signal was received.  We must deal with the pending
340        interrupt (see also interrupt.c, ../code/interrupt.lisp)
341
342        (how we got here: when interrupting, we set bit 63 in reg_ALLOC.
343        At the end of the atomic section we tried to write to reg_ALLOC,
344        got a SIGSEGV (there's nothing mapped there) so ended up here. */
345     if (addr != NULL &&
346         *os_context_register_addr(context,reg_ALLOC) & (1L<<63)){
347         *os_context_register_addr(context,reg_ALLOC) -= (1L<<63);
348         interrupt_handle_pending(context);
349         return;
350     }
351 #endif
352
353     if(!interrupt_maybe_gc(signal, info, context))
354         if(!handle_guard_page_triggered(context,addr))
355             interrupt_handle_now(signal, info, context);
356 }
357 #endif
358
359 void
360 os_install_interrupt_handlers(void)
361 {
362     undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
363                                                  sigsegv_handler);
364 #ifdef LISP_FEATURE_SB_THREAD
365     undoably_install_low_level_interrupt_handler(SIG_INTERRUPT_THREAD,
366                                                  interrupt_thread_handler);
367     undoably_install_low_level_interrupt_handler(SIG_STOP_FOR_GC,
368                                                  sig_stop_for_gc_handler);
369 #endif
370 }