0.8.20.30:
[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 size_t os_vm_page_size;
51
52 #ifdef LISP_FEATURE_SB_THREAD
53 #include <linux/unistd.h>
54 #include <errno.h>
55
56 /* values taken from the kernel's linux/futex.h.  This header file
57    doesn't exist in userspace, which is our excuse for not grovelling
58    them automatically */
59 #define FUTEX_WAIT (0)
60 #define FUTEX_WAKE (1)
61 #define FUTEX_FD (2)
62 #define FUTEX_REQUEUE (3)
63
64 #define __NR_sys_futex __NR_futex
65
66 _syscall4(int,sys_futex,
67           int *, futex,
68           int, op,
69           int, val,
70           struct timespec *, rel);
71 #endif
72
73 #include "gc.h"
74 \f
75 int linux_sparc_siginfo_bug = 0;
76 int linux_no_threads_p = 0;
77
78 void os_init(void)
79 {
80     /* Conduct various version checks: do we have enough mmap(), is
81      * this a sparc running 2.2, can we do threads? */
82     int *futex=0;
83     struct utsname name;
84     int major_version;
85     int minor_version;
86     char *p;
87     uname(&name);
88     p=name.release;  
89     major_version = atoi(p);
90     p=strchr(p,'.')+1;
91     minor_version = atoi(p);
92     if (major_version<2) {
93         lose("linux kernel version too old: major version=%d (can't run in version < 2.0.0)",
94              major_version);
95     }
96     if (!(major_version>2 || minor_version >= 4)) {
97 #ifdef LISP_FEATURE_SPARC
98         FSHOW((stderr,"linux kernel %d.%d predates 2.4;\n enabling workarounds for SPARC kernel bugs in signal handling.\n", major_version,minor_version));
99         linux_sparc_siginfo_bug = 1;
100 #endif
101     }
102 #ifdef LISP_FEATURE_SB_THREAD
103     futex_wait(futex,-1);
104     if(errno==ENOSYS)  linux_no_threads_p = 1;
105     if(linux_no_threads_p) 
106         fprintf(stderr,"Linux with NPTL support (e.g. kernel 2.6 or newer) required for \nthread-enabled SBCL.  Disabling thread support.\n\n");
107 #endif
108     os_vm_page_size = getpagesize();
109 }
110
111
112 #ifdef LISP_FEATURE_ALPHA
113 /* The Alpha is a 64 bit CPU.  SBCL is a 32 bit application.  Due to all
114  * the places that assume we can get a pointer into a fixnum with no 
115  * information loss, we have to make sure it allocates all its ram in the
116  * 0-2Gb region.  */
117
118 static void * under_2gb_free_pointer=DYNAMIC_1_SPACE_END;
119 #endif
120
121 os_vm_address_t
122 os_validate(os_vm_address_t addr, os_vm_size_t len)
123 {
124     int flags =  MAP_PRIVATE | MAP_ANONYMOUS | MAP_NORESERVE;
125     os_vm_address_t actual ;
126
127     if (addr) 
128         flags |= MAP_FIXED;
129 #ifdef LISP_FEATURE_ALPHA
130     else {
131         flags |= MAP_FIXED;
132         addr=under_2gb_free_pointer;
133     }
134 #endif  
135     actual = mmap(addr, len, OS_VM_PROT_ALL, flags, -1, 0);
136     if (actual == MAP_FAILED || (addr && (addr!=actual))) {
137         perror("mmap");
138         return 0;               /* caller should check this */
139     }
140
141 #ifdef LISP_FEATURE_ALPHA
142
143     len=(len+(os_vm_page_size-1))&(~(os_vm_page_size-1));
144     under_2gb_free_pointer+=len;
145 #endif
146
147     return actual;
148 }
149
150 void
151 os_invalidate(os_vm_address_t addr, os_vm_size_t len)
152 {
153     if (munmap(addr,len) == -1) {
154         perror("munmap");
155     }
156 }
157
158 os_vm_address_t
159 os_map(int fd, int offset, os_vm_address_t addr, os_vm_size_t len)
160 {
161     addr = mmap(addr, len,
162                 OS_VM_PROT_ALL,
163                 MAP_PRIVATE | MAP_FILE | MAP_FIXED,
164                 fd, (off_t) offset);
165
166     if (addr == MAP_FAILED) {
167         perror("mmap");
168         lose("unexpected mmap(..) failure");
169     }
170
171     return addr;
172 }
173
174 void
175 os_protect(os_vm_address_t address, os_vm_size_t length, os_vm_prot_t prot)
176 {
177     if (mprotect(address, length, prot) == -1) {
178         perror("mprotect");
179     }
180 }
181 \f
182 /* FIXME: Now that FOO_END, rather than FOO_SIZE, is the fundamental
183  * description of a space, we could probably punt this and just do
184  * (FOO_START <= x && x < FOO_END) everywhere it's called. */
185 static boolean
186 in_range_p(os_vm_address_t a, lispobj sbeg, size_t slen)
187 {
188     char* beg = (char*)((long)sbeg);
189     char* end = (char*)((long)sbeg) + slen;
190     char* adr = (char*)a;
191     return (adr >= beg && adr < end);
192 }
193
194 boolean
195 is_valid_lisp_addr(os_vm_address_t addr)
196 {
197     struct thread *th;
198     if(in_range_p(addr, READ_ONLY_SPACE_START, READ_ONLY_SPACE_SIZE) ||
199        in_range_p(addr, STATIC_SPACE_START   , STATIC_SPACE_SIZE) ||
200        in_range_p(addr, DYNAMIC_SPACE_START  , DYNAMIC_SPACE_SIZE))
201         return 1;
202     for_each_thread(th) {
203         if((th->control_stack_start <= addr) && (addr < th->control_stack_end))
204             return 1;
205         if(in_range_p(addr, th->binding_stack_start, BINDING_STACK_SIZE))
206             return 1;
207     }
208     return 0;
209 }
210 \f
211 /*
212  * any OS-dependent special low-level handling for signals
213  */
214
215
216 #if defined LISP_FEATURE_GENCGC
217
218 /*
219  * The GENCGC needs to be hooked into whatever signal is raised for
220  * page fault on this OS.
221  */
222 void
223 sigsegv_handler(int signal, siginfo_t *info, void* void_context)
224 {
225     os_context_t *context = arch_os_get_context(&void_context);
226     void* fault_addr = (void*)info->si_addr;
227     if (!gencgc_handle_wp_violation(fault_addr)) 
228         if(!handle_guard_page_triggered(context,fault_addr))
229 #ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
230             arrange_return_to_lisp_function(context, SymbolFunction(MEMORY_FAULT_ERROR));
231 #else
232             interrupt_handle_now(signal, info, context);
233 #endif
234 }
235
236 #else
237
238 static void
239 sigsegv_handler(int signal, siginfo_t *info, void* void_context)
240 {
241     os_context_t *context = arch_os_get_context(&void_context);
242     os_vm_address_t addr;
243
244     addr = arch_get_bad_addr(signal,info,context);
245     if (addr != NULL && 
246         *os_context_register_addr(context,reg_ALLOC) & (1L<<63)){
247         
248         /* Alpha stuff: This is the end of a pseudo-atomic section
249          * during which a signal was received.  We must deal with the
250          * pending interrupt (see also interrupt.c,
251          * ../code/interrupt.lisp)
252          */
253         /* (how we got here: when interrupting, we set bit 63 in
254          * reg_Alloc.  At the end of the atomic section we tried to
255          * write to reg_ALLOC, got a SIGSEGV (there's nothing mapped
256          * there) so ended up here
257          */
258         *os_context_register_addr(context,reg_ALLOC) -= (1L<<63);
259         interrupt_handle_pending(context);
260     } else {
261         if(!interrupt_maybe_gc(signal, info, context))
262             if(!handle_guard_page_triggered(context,addr))
263                 interrupt_handle_now(signal, info, context);
264     }
265 }
266 #endif
267
268 void sigcont_handler(int signal, siginfo_t *info, void *void_context)
269 {
270     /* We need to have a handler installed for this signal so that
271      * sigwaitinfo() for it actually returns at the appropriate time.
272      * We don't need it to actually do anything.  This mkes it
273      * possibly the only signal handler in SBCL that doesn't depend on
274      * not-guaranteed-by-POSIX features 
275      */    
276 }
277
278 void
279 os_install_interrupt_handlers(void)
280 {
281     undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
282                                                  sigsegv_handler);
283 #ifdef LISP_FEATURE_SB_THREAD
284     undoably_install_low_level_interrupt_handler(SIG_INTERRUPT_THREAD,
285                                                  interrupt_thread_handler);
286     undoably_install_low_level_interrupt_handler(SIG_STOP_FOR_GC,
287                                                  sig_stop_for_gc_handler);
288     undoably_install_low_level_interrupt_handler(SIG_THREAD_EXIT,
289                                                  thread_exit_handler);
290 #endif
291 }
292
293 #ifdef LISP_FEATURE_SB_THREAD
294 int futex_wait(int *lock_word, int oldval) {
295     int t= sys_futex(lock_word,FUTEX_WAIT,oldval, 0);
296     return t;
297 }
298 int futex_wake(int *lock_word, int n){
299     return sys_futex(lock_word,FUTEX_WAKE,n,0);
300 }
301 #endif