2 * OS-dependent routines for BSD-ish systems
4 * This file (along with os.h) exports an OS-independent interface to
5 * the operating system VM facilities. This interface looks a lot like
6 * the Mach interface (but simpler in some places). For some operating
7 * systems, a subset of these functions will have to be emulated.
11 * This software is part of the SBCL system. See the README file for
14 * This software is derived from the CMU CL system, which was
15 * written at Carnegie Mellon University and released into the
16 * public domain. The software is in the public domain and is
17 * provided with absolutely no warranty. See the COPYING and CREDITS
18 * files for more information.
22 #include <sys/param.h>
33 #include "interrupt.h"
38 #include "genesis/static-symbols.h"
39 #include "genesis/fdefn.h"
41 #include <sys/types.h>
43 /* #include <sys/sysinfo.h> */
45 #if defined LISP_FEATURE_GENCGC
46 #include "gencgc-internal.h"
49 #if defined(LISP_FEATURE_SB_WTIMER) && !defined(LISP_FEATURE_DARWIN)
50 # include <sys/event.h>
54 os_vm_size_t os_vm_page_size;
57 #include <sys/resource.h>
58 #include <sys/sysctl.h>
60 #include <sys/stat.h> /* For the stat-family wrappers. */
61 #include <dirent.h> /* For the opendir()/readdir() wrappers */
62 #include <sys/socket.h> /* For the socket() wrapper */
63 static void netbsd_init();
64 #endif /* __NetBSD__ */
67 #include <sys/sysctl.h>
68 #if defined(LISP_FEATURE_SB_THREAD) && !defined(LISP_FEATURE_SB_PTHREAD_FUTEX)
72 static void freebsd_init();
73 #endif /* __FreeBSD__ */
76 #include <sys/types.h>
77 #include <sys/resource.h>
79 #include <sys/sysctl.h>
81 #ifdef LISP_FEATURE_X86
82 #include <machine/cpu.h>
85 static void openbsd_init();
89 os_init(char *argv[], char *envp[])
91 os_vm_page_size = BACKEND_PAGE_BYTES;
95 #elif defined(__FreeBSD__)
97 #elif defined(__OpenBSD__)
99 #elif defined(LISP_FEATURE_DARWIN)
105 os_context_sigmask_addr(os_context_t *context)
107 /* (Unlike most of the other context fields that we access, the
108 * signal mask field is a field of the basic, outermost context
109 * struct itself both in FreeBSD 4.0 and in OpenBSD 2.6.) */
110 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(LISP_FEATURE_DARWIN)
111 return &context->uc_sigmask;
112 #elif defined (__OpenBSD__)
113 return &context->sc_mask;
115 #error unsupported BSD variant
120 os_validate(os_vm_address_t addr, os_vm_size_t len)
122 int flags = MAP_PRIVATE | MAP_ANON;
127 addr = mmap(addr, len, OS_VM_PROT_ALL, flags, -1, 0);
129 if (addr == MAP_FAILED) {
138 os_invalidate(os_vm_address_t addr, os_vm_size_t len)
140 if (munmap(addr, len) == -1)
145 os_map(int fd, int offset, os_vm_address_t addr, os_vm_size_t len)
147 addr = mmap(addr, len,
149 MAP_PRIVATE | MAP_FILE | MAP_FIXED,
152 if (addr == MAP_FAILED) {
154 lose("unexpected mmap(..) failure\n");
161 os_protect(os_vm_address_t address, os_vm_size_t length, os_vm_prot_t prot)
163 if (mprotect(address, length, prot) == -1) {
169 in_range_p(os_vm_address_t a, lispobj sbeg, size_t slen)
171 char* beg = (char*) sbeg;
172 char* end = (char*) sbeg + slen;
173 char* adr = (char*) a;
174 return (adr >= beg && adr < end);
178 is_valid_lisp_addr(os_vm_address_t addr)
182 if (in_range_p(addr, READ_ONLY_SPACE_START, READ_ONLY_SPACE_SIZE) ||
183 in_range_p(addr, STATIC_SPACE_START, STATIC_SPACE_SIZE) ||
184 in_range_p(addr, DYNAMIC_SPACE_START, dynamic_space_size))
186 for_each_thread(th) {
187 if (((os_vm_address_t)th->control_stack_start <= addr) &&
188 (addr < (os_vm_address_t)th->control_stack_end))
190 if (in_range_p(addr, (lispobj) th->binding_stack_start,
198 * any OS-dependent special low-level handling for signals
201 #if defined LISP_FEATURE_GENCGC
204 * The GENCGC needs to be hooked into whatever signal is raised for
205 * page fault on this OS.
209 memory_fault_handler(int signal, siginfo_t *siginfo, os_context_t *context)
211 void *fault_addr = arch_get_bad_addr(signal, siginfo, context);
213 #if defined(LISP_FEATURE_RESTORE_TLS_SEGMENT_REGISTER_FROM_CONTEXT)
214 FSHOW_SIGNAL((stderr, "/ TLS: restoring fs: %p in memory_fault_handler\n",
215 *CONTEXT_ADDR_FROM_STEM(fs)));
216 os_restore_tls_segment_register(context);
219 FSHOW((stderr, "Memory fault at: %p, PC: %p\n", fault_addr, *os_context_pc_addr(context)));
221 #ifdef LISP_FEATURE_SB_SAFEPOINT
222 if (!handle_safepoint_violation(context, fault_addr))
225 if (!gencgc_handle_wp_violation(fault_addr))
226 if(!handle_guard_page_triggered(context,fault_addr))
227 lisp_memory_fault_error(context, fault_addr);
230 #if defined(LISP_FEATURE_MACH_EXCEPTION_HANDLER)
232 mach_error_memory_fault_handler(int signal, siginfo_t *siginfo,
233 os_context_t *context) {
234 lose("Unhandled memory fault. Exiting.");
239 os_install_interrupt_handlers(void)
241 SHOW("os_install_interrupt_handlers()/bsd-os/defined(GENCGC)");
242 #if defined(LISP_FEATURE_MACH_EXCEPTION_HANDLER)
243 undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
244 mach_error_memory_fault_handler);
246 undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
247 #ifdef LISP_FEATURE_FREEBSD
248 (__siginfohandler_t *)
250 memory_fault_handler);
253 #ifdef LISP_FEATURE_SB_THREAD
254 # ifdef LISP_FEATURE_SB_SAFEPOINT
255 # ifdef LISP_FEATURE_SB_THRUPTION
256 undoably_install_low_level_interrupt_handler(SIGPIPE, thruption_handler);
259 undoably_install_low_level_interrupt_handler(SIG_STOP_FOR_GC,
260 sig_stop_for_gc_handler);
263 SHOW("leaving os_install_interrupt_handlers()");
266 #else /* Currently PPC/Darwin/Cheney only */
269 sigsegv_handler(int signal, siginfo_t *info, os_context_t *context)
272 unsigned int pc = (unsigned int *)(*os_context_pc_addr(context));
274 os_vm_address_t addr;
276 addr = arch_get_bad_addr(signal, info, context);
277 if (!cheneygc_handle_wp_violation(context, addr))
278 if (!handle_guard_page_triggered(context, addr))
279 interrupt_handle_now(signal, info, context);
283 os_install_interrupt_handlers(void)
285 SHOW("os_install_interrupt_handlers()/bsd-os/!defined(GENCGC)");
286 undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
290 #endif /* defined GENCGC */
293 static void netbsd_init()
299 /* Are we running on a sufficiently functional kernel? */
304 sysctl(mib, 2, &osrev, &len, NULL, 0);
306 /* If we're older than 2.0... */
307 if (osrev < 200000000) {
308 fprintf(stderr, "osrev = %d (needed at least 200000000).\n", osrev);
309 lose("NetBSD kernel too old to run sbcl.\n");
312 /* NetBSD counts mmap()ed space against the process's data size limit,
313 * so yank it up. This might be a nasty thing to do? */
314 getrlimit (RLIMIT_DATA, &rl);
315 /* Amazingly for such a new port, the provenance and meaning of
316 this number are unknown. It might just mean REALLY_BIG_LIMIT,
317 or possibly it should be calculated from dynamic space size.
318 -- CSR, 2004-04-08 */
319 rl.rlim_cur = 1073741824;
320 if (setrlimit (RLIMIT_DATA, &rl) < 0) {
322 "RUNTIME WARNING: unable to raise process data size limit:\n\
324 The system may fail to start.\n",
329 /* Various routines in NetBSD's C library are compatibility wrappers
330 for old versions. Programs must be processed by the C toolchain in
331 order to get up-to-date definitions of such routines. */
332 /* The stat-family, opendir, and readdir are used only in sb-posix, as
333 of 2007-01-16. -- RMK */
335 _stat(const char *path, struct stat *sb)
337 return stat(path, sb);
340 _lstat(const char *path, struct stat *sb)
342 return lstat(path, sb);
345 _fstat(int fd, struct stat *sb)
347 return fstat(fd, sb);
351 _opendir(const char *filename)
353 return opendir(filename);
358 return readdir(dirp);
362 _utime(const char *file, const struct utimbuf *timep)
364 return utime(file, timep);
367 /* Used in sb-bsd-sockets. */
369 _socket(int domain, int type, int protocol)
371 return socket(domain, type, protocol);
373 #endif /* __NetBSD__ */
376 extern int getosreldate(void);
378 int sig_memory_fault;
380 static void freebsd_init()
382 /* Memory fault signal on FreeBSD was changed from SIGBUS to
384 if (getosreldate() < 700004)
385 sig_memory_fault = SIGBUS;
387 sig_memory_fault = SIGSEGV;
389 /* Quote from sbcl-devel (NIIMI Satoshi): "Some OSes, like FreeBSD
390 * 4.x with GENERIC kernel, does not enable SSE support even on
391 * SSE capable CPUs". Detect this situation and skip the
392 * fast_bzero sse/base selection logic that's normally done in
395 #ifdef LISP_FEATURE_X86
400 len = sizeof(instruction_sse);
401 if (sysctlbyname("hw.instruction_sse", &instruction_sse, &len,
402 NULL, 0) == 0 && instruction_sse != 0) {
403 /* Use the SSE detector */
404 fast_bzero_pointer = fast_bzero_detect;
407 #endif /* LISP_FEATURE_X86 */
410 #if defined(LISP_FEATURE_SB_THREAD) && defined(LISP_FEATURE_SB_FUTEX) \
411 && !defined(LISP_FEATURE_SB_PTHREAD_FUTEX)
413 futex_wait(int *lock_word, long oldval, long sec, unsigned long usec)
415 struct timespec timeout;
419 ret = umtx_wait((void *)lock_word, oldval, NULL);
421 timeout.tv_sec = sec;
422 timeout.tv_nsec = usec * 1000;
423 ret = umtx_wait((void *)lock_word, oldval, &timeout);
434 /* EWOULDBLOCK and others, need to check the lock */
440 futex_wake(int *lock_word, int n)
442 return umtx_wake((void *)lock_word, n);
445 #endif /* __FreeBSD__ */
447 #ifdef LISP_FEATURE_DARWIN
448 /* defined in ppc-darwin-os.c instead */
449 #elif defined(LISP_FEATURE_FREEBSD)
450 #ifndef KERN_PROC_PATHNAME
451 #define KERN_PROC_PATHNAME 12
455 os_get_runtime_executable_path(int external)
457 char path[PATH_MAX + 1];
459 if (getosreldate() >= 600024) {
460 /* KERN_PROC_PATHNAME is available */
461 size_t len = PATH_MAX + 1;
466 mib[2] = KERN_PROC_PATHNAME;
468 if (sysctl(mib, 4, &path, &len, NULL, 0) != 0)
472 size = readlink("/proc/curproc/file", path, sizeof(path) - 1);
477 if (strcmp(path, "unknown") == 0)
479 return copied_string(path);
481 #elif defined(LISP_FEATURE_NETBSD) || defined(LISP_FEATURE_OPENBSD)
483 os_get_runtime_executable_path(int external)
486 if (!external && stat("/proc/curproc/file", &sb) == 0)
487 return copied_string("/proc/curproc/file");
490 #else /* Not DARWIN or FREEBSD or NETBSD or OPENBSD */
492 os_get_runtime_executable_path(int external)
500 int openbsd_use_fxsave = 0;
505 #ifdef LISP_FEATURE_X86
510 * Show a warning if it looks like the memory available after
511 * allocating the spaces won't be at least this much.
513 #ifdef LISP_FEATURE_X86_64
514 const int wantfree = 64 * 1024 * 1024;
516 const int wantfree = 32 * 1024 * 1024;
520 #ifdef LISP_FEATURE_X86
521 /* Save the machdep.osfxsr sysctl for use by os_restore_fp_control() */
522 mib[0] = CTL_MACHDEP;
524 size = sizeof (openbsd_use_fxsave);
525 sysctl(mib, 2, &openbsd_use_fxsave, &size, NULL, 0);
528 /* OpenBSD, like NetBSD, counts mmap()ed space against the
529 * process's data size limit. If the soft limit is lower than the
530 * hard limit then try to yank it up, this lets users in the
531 * "staff" or "daemon" login classes run sbcl with larger dynamic
534 getrlimit (RLIMIT_DATA, &rl);
535 if (rl.rlim_cur < rl.rlim_max) {
536 rl.rlim_cur = rl.rlim_max;
537 if (setrlimit (RLIMIT_DATA, &rl) < 0) {
539 "RUNTIME WARNING: unable to raise process data size limit:\n\
541 The system may fail to start.\n",
547 * Display a (hopefully) helpful warning if it looks like we won't
548 * be able to allocate enough memory.
550 getrlimit (RLIMIT_DATA, &rl);
551 if (dynamic_space_size + READ_ONLY_SPACE_SIZE + STATIC_SPACE_SIZE +
552 LINKAGE_TABLE_SPACE_SIZE + wantfree > rl.rlim_cur)
554 "RUNTIME WARNING: data size resource limit may be too low,\n"
555 " try decreasing the dynamic space size with --dynamic-space-size\n"
556 " or raising the datasize or datasize-max limits in /etc/login.conf\n");
559 /* OpenBSD's dlsym() relies on the gcc bulitin
560 * __builtin_return_address(0) returning an address in the
561 * executable's text segment, but when called from lisp it will return
562 * an address in the dynamic space. Work around this by calling this
563 * wrapper function instead. Note that tail-call optimization will
564 * defeat this, disable it by saving the dlsym() return value in a
568 os_dlsym(void *handle, const char *symbol)
570 void * volatile ret = dlsym(handle, symbol);
576 #if defined(LISP_FEATURE_SB_WTIMER) && !defined(LISP_FEATURE_DARWIN)
578 * Waitable timer implementation for the safepoint-based (SIGALRM-free)
579 * timer facility using kqueue.
586 lose("os_create_wtimer: kqueue");
591 os_wait_for_wtimer(int kq)
595 if ( (n = kevent(kq, 0, 0, &ev, 1, 0)) == -1) {
597 lose("os_wtimer_listen failed");
604 os_close_wtimer(int kq)
607 lose("os_close_wtimer failed");
611 os_set_wtimer(int kq, int sec, int nsec)
614 = ((long long) sec) * 1000 + (long long) (nsec+999999) / 1000000;
615 if (msec > INT_MAX) msec = INT_MAX;
618 EV_SET(&ev, 1, EVFILT_TIMER, EV_ADD|EV_ENABLE|EV_ONESHOT, 0, (int)msec, 0);
619 if (kevent(kq, &ev, 1, 0, 0, 0) == -1)
620 perror("os_set_wtimer: kevent");
624 os_cancel_wtimer(int kq)
627 EV_SET(&ev, 1, EVFILT_TIMER, EV_DISABLE, 0, 0, 0);
628 if (kevent(kq, &ev, 1, 0, 0, 0) == -1 && errno != ENOENT)
629 perror("os_cancel_wtimer: kevent");