1.0.13.18: Revived OpenBSD support, contributed by Josh Elsasser
[sbcl.git] / src / runtime / bsd-os.c
index 10c2fd4..a364d5a 100644 (file)
@@ -41,6 +41,9 @@
 #include <signal.h>
 /* #include <sys/sysinfo.h> */
 #include "validate.h"
+#if defined LISP_FEATURE_GENCGC
+#include "gencgc-internal.h"
+#endif
 \f
 os_vm_size_t os_vm_page_size;
 
@@ -48,17 +51,30 @@ os_vm_size_t os_vm_page_size;
 #include <sys/resource.h>
 #include <sys/sysctl.h>
 #include <string.h>
-
+#include <sys/stat.h> /* For the stat-family wrappers. */
+#include <dirent.h>   /* For the opendir()/readdir() wrappers */
+#include <sys/socket.h> /* For the socket() wrapper */
 static void netbsd_init();
 #endif /* __NetBSD__ */
 
 #ifdef __FreeBSD__
 #include <sys/sysctl.h>
-#include <osreldate.h>
+#if defined(LISP_FEATURE_SB_THREAD) && !defined(LISP_FEATURE_SB_PTHREAD_FUTEX)
+#include <sys/umtx.h>
+#endif
 
 static void freebsd_init();
 #endif /* __FreeBSD__ */
 
+#ifdef __OpenBSD__
+#include <sys/types.h>
+#include <sys/resource.h>
+#include <sys/stat.h>
+#include <dlfcn.h>
+
+static void openbsd_init();
+#endif
+
 void
 os_init(char *argv[], char *envp[])
 {
@@ -66,26 +82,10 @@ os_init(char *argv[], char *envp[])
 
 #ifdef __NetBSD__
     netbsd_init();
-#endif /* __NetBSD__ */
-#ifdef __FreeBSD__
+#elif defined(__FreeBSD__)
     freebsd_init();
-#endif /* __FreeBSD__ */
-}
-
-int *os_context_pc_addr(os_context_t *context)
-{
-#if defined __FreeBSD__
-    return CONTEXT_ADDR_FROM_STEM(eip);
-#elif defined __OpenBSD__
-    return CONTEXT_ADDR_FROM_STEM(pc);
-#elif defined __NetBSD__
-    return CONTEXT_ADDR_FROM_STEM(EIP);
-#elif defined(LISP_FEATURE_DARWIN) && defined(LISP_FEATURE_X86)
-    return CONTEXT_ADDR_FROM_STEM(eip);
-#elif defined LISP_FEATURE_DARWIN
-    return &context->uc_mcontext->ss.srr0;
-#else
-#error unsupported BSD variant
+#elif defined(__OpenBSD__)
+    openbsd_init();
 #endif
 }
 
@@ -166,14 +166,17 @@ boolean
 is_valid_lisp_addr(os_vm_address_t addr)
 {
     struct thread *th;
-    if(in_range_p(addr, READ_ONLY_SPACE_START, READ_ONLY_SPACE_SIZE) ||
-       in_range_p(addr, STATIC_SPACE_START   , STATIC_SPACE_SIZE) ||
-       in_range_p(addr, DYNAMIC_SPACE_START  , DYNAMIC_SPACE_SIZE))
+
+    if (in_range_p(addr, READ_ONLY_SPACE_START, READ_ONLY_SPACE_SIZE) ||
+        in_range_p(addr, STATIC_SPACE_START, STATIC_SPACE_SIZE) ||
+        in_range_p(addr, DYNAMIC_SPACE_START, dynamic_space_size))
         return 1;
     for_each_thread(th) {
-        if((th->control_stack_start <= addr) && (addr < th->control_stack_end))
+        if (((os_vm_address_t)th->control_stack_start <= addr) &&
+            (addr < (os_vm_address_t)th->control_stack_end))
             return 1;
-        if(in_range_p(addr, th->binding_stack_start, BINDING_STACK_SIZE))
+        if (in_range_p(addr, (lispobj) th->binding_stack_start,
+                       BINDING_STACK_SIZE))
             return 1;
     }
     return 0;
@@ -189,11 +192,22 @@ is_valid_lisp_addr(os_vm_address_t addr)
  * The GENCGC needs to be hooked into whatever signal is raised for
  * page fault on this OS.
  */
-static void
-memory_fault_handler(int signal, siginfo_t *siginfo, void *void_context)
+
+void
+memory_fault_handler(int signal, siginfo_t *siginfo, void *void_context
+#if defined(LISP_FEATURE_FREEBSD) && defined(LISP_FEATURE_X86_64)
+/* FreeBSD/amd64 stores fault address only in undocumented 4th arg. */
+                     ,void *fault_addr
+#endif
+    )
 {
     os_context_t *context = arch_os_get_context(&void_context);
+#if defined(LISP_FEATURE_FREEBSD) && defined(LISP_FEATURE_X86_64)
+    /* KLUDGE: Store fault address into si_addr for compatibilities. */
+    siginfo->si_addr = fault_addr;
+#else
     void *fault_addr = arch_get_bad_addr(signal, siginfo, context);
+#endif
 
 #if defined(LISP_FEATURE_RESTORE_TLS_SEGMENT_REGISTER_FROM_CONTEXT)
     FSHOW_SIGNAL((stderr, "/ TLS: restoring fs: %p in memory_fault_handler\n",
@@ -201,32 +215,39 @@ memory_fault_handler(int signal, siginfo_t *siginfo, void *void_context)
     os_restore_tls_segment_register(context);
 #endif
 
-    FSHOW((stderr, "Memory fault at: %p, PC: %x\n", fault_addr, *os_context_pc_addr(context)));
+    FSHOW((stderr, "Memory fault at: %p, PC: %p\n", fault_addr, *os_context_pc_addr(context)));
 
     if (!gencgc_handle_wp_violation(fault_addr))
         if(!handle_guard_page_triggered(context,fault_addr)) {
 #ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
-            arrange_return_to_lisp_function(context, SymbolFunction(MEMORY_FAULT_ERROR));
+            lisp_memory_fault_error(context, fault_addr);
 #else
-            if (!interrupt_maybe_gc_int(signal, siginfo, context)) {
+            if (!maybe_gc(context)) {
                 interrupt_handle_now(signal, siginfo, context);
             }
-#if defined(LISP_FEATURE_DARWIN)
-            /* Work around G5 bug; fix courtesy gbyers */
-            DARWIN_FIX_CONTEXT(context);
-#endif
 #endif
         }
 }
 
+#if defined(LISP_FEATURE_MACH_EXCEPTION_HANDLER)
+void
+mach_error_memory_fault_handler(int signal, siginfo_t *siginfo, void *void_context) {
+    lose("Unhandled memory fault. Exiting.");
+}
+#endif
+
 void
 os_install_interrupt_handlers(void)
 {
     SHOW("os_install_interrupt_handlers()/bsd-os/defined(GENCGC)");
+#if defined(LISP_FEATURE_MACH_EXCEPTION_HANDLER)
     undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
-                                                 memory_fault_handler);
-#ifdef SIG_MEMORY_FAULT2
-    undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT2,
+                                                 mach_error_memory_fault_handler);
+#else
+    undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
+#ifdef LISP_FEATURE_FREEBSD
+                                                 (__siginfohandler_t *)
+#endif
                                                  memory_fault_handler);
 #endif
 
@@ -240,7 +261,6 @@ os_install_interrupt_handlers(void)
                                                  sig_stop_for_gc_handler);
 #endif
 #endif
-
     SHOW("leaving os_install_interrupt_handlers()");
 }
 
@@ -250,15 +270,15 @@ static void
 sigsegv_handler(int signal, siginfo_t *info, void* void_context)
 {
     os_context_t *context = arch_os_get_context(&void_context);
+#if 0
     unsigned int pc =  (unsigned int *)(*os_context_pc_addr(context));
+#endif
     os_vm_address_t addr;
 
-    addr = arch_get_bad_addr(signal,info,context);
-    if(!interrupt_maybe_gc(signal, info, context))
-        if(!handle_guard_page_triggered(context,addr))
+    addr = arch_get_bad_addr(signal, info, context);
+    if (!cheneygc_handle_wp_violation(context, addr))
+        if (!handle_guard_page_triggered(context, addr))
             interrupt_handle_now(signal, info, context);
-    /* Work around G5 bug; fix courtesy gbyers */
-    DARWIN_FIX_CONTEXT(context);
 }
 
 void
@@ -267,10 +287,6 @@ os_install_interrupt_handlers(void)
     SHOW("os_install_interrupt_handlers()/bsd-os/!defined(GENCGC)");
     undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
                                                  sigsegv_handler);
-#ifdef SIG_MEMORY_FAULT2
-    undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT2,
-                                                 sigsegv_handler);
-#endif
 }
 
 #endif /* defined GENCGC */
@@ -311,11 +327,61 @@ The system may fail to start.\n",
                  strerror(errno));
     }
 }
+
+/* Various routines in NetBSD's C library are compatibility wrappers
+   for old versions. Programs must be processed by the C toolchain in
+   order to get up-to-date definitions of such routines. */
+/* The stat-family, opendir, and readdir are used only in sb-posix, as
+   of 2007-01-16. -- RMK */
+int
+_stat(const char *path, struct stat *sb)
+{
+    return stat(path, sb);
+}
+int
+_lstat(const char *path, struct stat *sb)
+{
+    return lstat(path, sb);
+}
+int
+_fstat(int fd, struct stat *sb)
+{
+    return fstat(fd, sb);
+}
+
+DIR *
+_opendir(const char *filename)
+{
+    return opendir(filename);
+}
+struct dirent *
+_readdir(DIR *dirp)
+{
+    return readdir(dirp);
+}
+
+/* Used in sb-bsd-sockets. */
+int
+_socket(int domain, int type, int protocol)
+{
+    return socket(domain, type, protocol);
+}
 #endif /* __NetBSD__ */
 
 #ifdef __FreeBSD__
+extern int getosreldate(void);
+
+int sig_memory_fault;
+
 static void freebsd_init()
 {
+    /* Memory fault signal on FreeBSD was changed from SIGBUS to
+     * SIGSEGV. */
+    if (getosreldate() < 700004)
+        sig_memory_fault = SIGBUS;
+    else
+        sig_memory_fault = SIGSEGV;
+
     /* Quote from sbcl-devel (NIIMI Satoshi): "Some OSes, like FreeBSD
      * 4.x with GENERIC kernel, does not enable SSE support even on
      * SSE capable CPUs". Detect this situation and skip the
@@ -323,17 +389,56 @@ static void freebsd_init()
      * x86-assem.S.
      */
 #ifdef LISP_FEATURE_X86
-    size_t len;
-    int instruction_sse;
-
-    len = sizeof(instruction_sse);
-    if (sysctlbyname("hw.instruction_sse", &instruction_sse, &len, NULL, 0) == 0
-        && instruction_sse != 0) {
-        /* Use the SSE detector */
-        fast_bzero_pointer = fast_bzero_detect;
+    {
+        size_t len;
+        int instruction_sse;
+
+        len = sizeof(instruction_sse);
+        if (sysctlbyname("hw.instruction_sse", &instruction_sse, &len,
+                         NULL, 0) == 0 && instruction_sse != 0) {
+            /* Use the SSE detector */
+            fast_bzero_pointer = fast_bzero_detect;
+        }
     }
 #endif /* LISP_FEATURE_X86 */
 }
+
+#if defined(LISP_FEATURE_SB_THREAD) && !defined(LISP_FEATURE_SB_PTHREAD_FUTEX)
+int
+futex_wait(int *lock_word, long oldval, long sec, unsigned long usec)
+{
+    struct timespec timeout;
+    int ret;
+
+again:
+    if (sec < 0)
+        ret = umtx_wait((void *)lock_word, oldval, NULL);
+    else {
+        timeout.tv_sec = sec;
+        timeout.tv_nsec = usec * 1000;
+        ret = umtx_wait((void *)lock_word, oldval, &timeout);
+    }
+
+    switch (ret) {
+    case 0:
+        return 0;
+    case ETIMEDOUT:
+        return 1;
+    case EINTR:
+        /* spurious wakeup from interrupt */
+        goto again;
+    default:
+        /* EWOULDBLOCK and others, need to check the lock */
+        return -1;
+    }
+}
+
+int
+futex_wake(int *lock_word, int n)
+{
+    return umtx_wake((void *)lock_word, n);
+}
+#endif
 #endif /* __FreeBSD__ */
 
 #ifdef LISP_FEATURE_DARWIN
@@ -370,10 +475,77 @@ os_get_runtime_executable_path()
         return NULL;
     return copied_string(path);
 }
-#else /* Not DARWIN or FREEBSD */
+#elif defined(LISP_FEATURE_NETBSD) || defined(LISP_FEATURE_OPENBSD)
+char *
+os_get_runtime_executable_path()
+{
+    struct stat sb;
+    char *path = strdup("/proc/curproc/file");
+    if (path && ((stat(path, &sb)) == 0))
+        return path;
+    else {
+        fprintf(stderr, "Couldn't stat /proc/curproc/file; is /proc mounted?\n");
+        return NULL;
+    }
+}
+#else /* Not DARWIN or FREEBSD or NETBSD or OPENBSD */
 char *
 os_get_runtime_executable_path()
 {
     return NULL;
 }
 #endif
+
+#ifdef __OpenBSD__
+void
+openbsd_init()
+{
+    struct rlimit rl;
+
+    /* OpenBSD, like NetBSD, counts mmap()ed space against the
+     * process's data size limit. If the soft limit is lower than the
+     * hard limit then try to yank it up, this lets users in the
+     * "staff" login class run sbcl with a default /etc/login.conf
+     */
+    getrlimit (RLIMIT_DATA, &rl);
+    if (rl.rlim_cur < rl.rlim_max) {
+        rl.rlim_cur = rl.rlim_max;
+        if (setrlimit (RLIMIT_DATA, &rl) < 0) {
+            fprintf (stderr,
+                     "RUNTIME WARNING: unable to raise process data size limit:\n\
+  %s.\n\
+The system may fail to start.\n",
+                     strerror(errno));
+        }
+    }
+
+    /* Display a (hopefully) helpful warning if it looks like we won't
+     * be able to allocate enough memory. In testing I found that on
+     * my system at least, a minimum of 25M on top of the three space
+     * sizes was needed to start SBCL. Show a warning below 32M so as
+     * to leave a little breathing room.
+     */
+    getrlimit (RLIMIT_DATA, &rl);
+    if (dynamic_space_size + READ_ONLY_SPACE_SIZE + STATIC_SPACE_SIZE +
+        LINKAGE_TABLE_SPACE_SIZE + (32*1024*1024) > rl.rlim_cur)
+        fprintf (stderr,
+                 "RUNTIME WARNING: data size resource limit may be too low,\n"
+                 "  try decreasing the dynamic space size with --dynamic-space-size\n");
+}
+
+/* OpenBSD's dlsym() relies on the gcc bulitin
+ * __builtin_return_address(0) returning an address in the
+ * executable's text segment, but when called from lisp it will return
+ * an address in the dynamic space.  Work around this by calling this
+ * wrapper function instead. Note that tail-call optimization will
+ * defeat this, disable it by saving the dlsym() return value in a
+ * volatile variable.
+*/
+void *
+os_dlsym(void *handle, const char *symbol)
+{
+    void * volatile ret = dlsym(handle, symbol);
+    return ret;
+}
+
+#endif