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