Fix cut-to-width in the presence of bad constants in dead code.
[sbcl.git] / src / runtime / sunos-os.c
index 2a6bf34..eb84223 100644 (file)
 #include <sys/param.h>
 #include <sys/utsname.h>
 
+#include "sbcl.h"
 #include "os.h"
 #include "arch.h"
 #include "interr.h"
 #include "interrupt.h"
 #include "globals.h"
 #include "validate.h"
-#include "sbcl.h"
 #include "target-arch-os.h"
 
-#define OS_VM_DEFAULT_PAGESIZE 8192
-
-long os_vm_page_size=(-1);
-static long os_real_page_size=(-1);
-
-static os_vm_size_t real_page_size_difference=0;
-
-/* So, this sucks. Versions of Solaris prior to 8 (SunOS releases
-   earlier than 5.8) do not support MAP_ANON passed as a flag to
-   mmap(). However, we would like SBCL compiled on SunOS 5.7 but
-   running on 5.8 to use MAP_ANON, but because of C's lack of
-   introspection at runtime, we can't grab the right value because
-   it's stuffed in a header file somewhere. We can, however, hardcode
-   it, and test at runtime for whether to use it... -- CSR, 2002-05-06 
-
-   And, in fact, it sucks slightly more, as if you don't use MAP_ANON
-   you need to have /dev/zero open and pass the file descriptor to
-   mmap().  So overall, this counts as a KLUDGE. -- CSR, 2002-05-20 */
-int KLUDGE_MAYBE_MAP_ANON = 0x0;
-int kludge_mmap_fd = -1; /* default for MAP_ANON */
-
-void os_init(void)
-{
-    struct utsname name;
-    int major_version;
-    int minor_version;
-    
-    uname(&name);
-    major_version = atoi(name.release);
-    if (major_version != 5) {
-       lose("sunos major version=%d (which isn't 5!)", major_version);
-    }
-    minor_version = atoi(name.release+2);
-    if ((minor_version == 8) || (minor_version == 9)) {
-       KLUDGE_MAYBE_MAP_ANON = 0x100;
-    } else if (minor_version > 9) {
-       FSHOW((stderr, "os_init: Solaris version greater than 9?\nUnknown MAP_ANON behaviour.\n"));
-       lose("Unknown mmap() interaction with MAP_ANON");
-    } else { /* minor_version < 8 */
-       kludge_mmap_fd = open("/dev/zero",O_RDONLY);
-       if (kludge_mmap_fd < 0) {
-           perror("open");
-           lose("Error in open(..)");
-       }
-    }
+#ifdef LISP_FEATURE_X86
+#include "genesis/static-symbols.h"
+#include "genesis/fdefn.h"
+#endif
 
-    /* I do not understand this at all. FIXME. */
-    os_vm_page_size = os_real_page_size = sysconf(_SC_PAGESIZE);
-
-    if(os_vm_page_size>OS_VM_DEFAULT_PAGESIZE){
-       fprintf(stderr,"os_init: Pagesize too large (%d > %d)\n",
-               os_vm_page_size,OS_VM_DEFAULT_PAGESIZE);
-       exit(1);
-    } else {
-       /*
-        * we do this because there are apparently dependencies on
-        * the pagesize being OS_VM_DEFAULT_PAGESIZE somewhere...
-        * but since the OS doesn't know we're using this restriction,
-        * we have to grovel around a bit to enforce it, thus anything
-        * that uses real_page_size_difference.
-        */
-       /* FIXME: Is this still true? */
-       real_page_size_difference=OS_VM_DEFAULT_PAGESIZE-os_vm_page_size;
-       os_vm_page_size=OS_VM_DEFAULT_PAGESIZE;
-    }
+#ifdef LISP_FEATURE_GENCGC
+#include "gencgc-internal.h"
+#endif
+
+#ifdef LISP_FEATURE_SB_WTIMER
+# include <port.h>
+# include <time.h>
+# include <errno.h>
+#endif
+
+os_vm_size_t os_vm_page_size=0;
+
+void
+os_init(char *argv[], char *envp[])
+{
+    /*
+     * historically, this used sysconf to select the runtime page size
+     * per recent changes on other arches and discussion on sbcl-devel,
+     * however, this is not necessary -- the VM page size need not match
+     * the OS page size (and the default backend page size has been
+     * ramped up accordingly for efficiency reasons).
+     */
+    os_vm_page_size = BACKEND_PAGE_BYTES;
 }
 
 os_vm_address_t os_validate(os_vm_address_t addr, os_vm_size_t len)
 {
-    int flags = MAP_PRIVATE | MAP_NORESERVE | KLUDGE_MAYBE_MAP_ANON;
-    if (addr) 
-       flags |= MAP_FIXED;
+    int flags = MAP_PRIVATE | MAP_NORESERVE | MAP_ANON;
+    if (addr)
+        flags |= MAP_FIXED;
 
-    addr = mmap(addr, len, 
-               OS_VM_PROT_ALL, 
-               flags, 
-               kludge_mmap_fd, 0);
+    addr = mmap(addr, len, OS_VM_PROT_ALL, flags, -1, 0);
 
     if (addr == MAP_FAILED) {
-       perror("mmap");
-       lose ("Error in mmap(..)");
+        perror("mmap");
+        /* While it is generally hard to recover from out-of-memory
+         * situations, we require callers to decide on the right course
+         * of action here.  Consider thread creation: Failure to mmap
+         * here is common if users have started too many threads, and
+         * often we can recover from that and treat it as an ordinary
+         * error. */
+        return 0;
     }
-    
+
     return addr;
 }
 
 void os_invalidate(os_vm_address_t addr, os_vm_size_t len)
 {
     if(munmap((void*) addr, len) == -1)
-       perror("munmap");
+        perror("munmap");
 }
 
 \f
 
-os_vm_address_t 
+os_vm_address_t
 os_map(int fd, int offset, os_vm_address_t addr, os_vm_size_t len)
 {
 
     addr = mmap(addr, len,
-               OS_VM_PROT_ALL,
-               MAP_PRIVATE | MAP_FIXED,
-               fd, (off_t) offset);
+                OS_VM_PROT_ALL,
+                MAP_PRIVATE | MAP_FIXED,
+                fd, (off_t) offset);
 
     if (addr == MAP_FAILED) {
-       perror("mmap");
-       lose("Unexpedted mmap(..) failure");
+        perror("mmap");
+        lose("Unexpedted mmap(..) failure\n");
     }
-  
+
     return addr;
 }
 
@@ -132,7 +98,7 @@ void
 os_protect(os_vm_address_t address, os_vm_size_t length, os_vm_prot_t prot)
 {
     if(mprotect((void*)address, length, prot) == -1) {
-       perror("mprotect");
+        perror("mprotect");
     }
 }
 
@@ -147,35 +113,63 @@ static boolean in_range_p(os_vm_address_t a, lispobj sbeg, size_t slen)
 boolean is_valid_lisp_addr(os_vm_address_t addr)
 {
     /* Old CMUCL comment:
-       
+
        Just assume address is valid if it lies within one of the known
        spaces.  (Unlike sunos-os which keeps track of every valid page.) */
-    return (   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_0_SPACE_START, DYNAMIC_SPACE_SIZE  )
-              || in_range_p(addr, DYNAMIC_1_SPACE_START, DYNAMIC_SPACE_SIZE  )
-              || in_range_p(addr, CONTROL_STACK_START  , CONTROL_STACK_SIZE  )
-              || in_range_p(addr, BINDING_STACK_START  , BINDING_STACK_SIZE  ));
-}
 
+    /* FIXME: this looks like a valid definition for all targets with
+       cheney-gc; it may not be impressively smart (witness the
+       comment above) but maybe associating these functions with the
+       GC rather than the OS would be a maintainability win.  -- CSR,
+       2003-04-04 */
+    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) ||
+#ifdef LISP_FEATURE_GENCGC
+       in_range_p(addr, DYNAMIC_SPACE_START  , dynamic_space_size)
+#else
+       in_range_p(addr, DYNAMIC_0_SPACE_START, dynamic_space_size) ||
+       in_range_p(addr, DYNAMIC_1_SPACE_START, dynamic_space_size)
+#endif
+       )
+        return 1;
+    for_each_thread(th) {
+        if((th->control_stack_start <= addr) && (addr < th->control_stack_end))
+            return 1;
+        if(in_range_p(addr, th->binding_stack_start, BINDING_STACK_SIZE))
+            return 1;
+    }
+    return 0;
+}
 \f
 
-#if defined GENCGC
+#if defined LISP_FEATURE_GENCGC
+
+void
+sigsegv_handler(int signal, siginfo_t *info, os_context_t *context)
+{
+    void* fault_addr = (void*)info->si_addr;
+
+#ifdef LISP_FEATURE_SB_SAFEPOINT
+    if (handle_safepoint_violation(context, fault_addr))
+            return;
+#endif
 
-#error "GENCGC is not yet supported (presumably on x86 solaris?)"
+    if (!gencgc_handle_wp_violation(fault_addr))
+        if(!handle_guard_page_triggered(context, fault_addr))
+            lisp_memory_fault_error(context, fault_addr);
+}
 
 #else
 
 static void
-sigsegv_handler(int signal, siginfo_t *info, void* void_context)
+sigsegv_handler(int signal, siginfo_t *info, os_context_t *context)
 {
-    os_context_t *context = arch_os_get_context(&void_context);
-    os_vm_address_t addr;
+    os_vm_address_t addr = arch_get_bad_addr(signal, info, context);
 
-    addr = arch_get_bad_addr(signal, info, context);
-    if(!interrupt_maybe_gc(signal, info, context)) {
-       if(!handle_control_stack_guard_triggered(context,addr))
-           interrupt_handle_now(signal, info, context);
+    if (!cheneygc_handle_wp_violation(context, addr)) {
+        if (!handle_guard_page_triggered(context,addr))
+            lisp_memory_fault_error(context, addr);
     }
 }
 
@@ -185,5 +179,125 @@ void
 os_install_interrupt_handlers()
 {
     undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
-                                                sigsegv_handler);
+                                                 sigsegv_handler);
+
+    /* OAOOM c.f. linux-os.c.
+     * Should we have a reusable function gc_install_interrupt_handlers? */
+#ifdef LISP_FEATURE_SB_THREAD
+# ifdef LISP_FEATURE_SB_SAFEPOINT
+#  ifdef LISP_FEATURE_SB_THRUPTION
+    undoably_install_low_level_interrupt_handler(SIGPIPE, thruption_handler);
+#  endif
+# else
+    undoably_install_low_level_interrupt_handler(SIG_STOP_FOR_GC,
+                                                 sig_stop_for_gc_handler);
+# endif
+#endif
+}
+
+char *
+os_get_runtime_executable_path(int external)
+{
+    char path[] = "/proc/self/object/a.out";
+
+    if (external || access(path, R_OK) == -1)
+        return NULL;
+
+    return copied_string(path);
+}
+
+#ifdef LISP_FEATURE_SB_WTIMER
+/*
+ * Waitable timer implementation for the safepoint-based (SIGALRM-free)
+ * timer facility using SunOS completion ports.
+ */
+
+struct os_wtimer {
+    int port;
+    int timer;
+};
+
+struct os_wtimer *
+os_create_wtimer()
+{
+    int port = port_create();
+    if (port == -1) {
+        perror("port_create");
+        lose("os_create_wtimer");
+    }
+
+    port_notify_t pn;
+    pn.portnfy_port = port;
+    pn.portnfy_user = 0;
+
+    struct sigevent ev;
+    memset(&ev, 0, sizeof(ev));
+    ev.sigev_notify = SIGEV_PORT;
+    ev.sigev_value.sival_ptr = &pn;
+
+    timer_t timer;
+    if (timer_create(CLOCK_HIGHRES, &ev, &timer) == -1
+        && (errno != EPERM || timer_create(CLOCK_REALTIME, &ev, &timer) == -1))
+    {
+        perror("timer_create");
+        lose("os_create_wtimer");
+    }
+
+    struct os_wtimer *wt = malloc(sizeof(struct os_wtimer));
+    if (!wt)
+        lose("os_create_wtimer: malloc");
+
+    wt->port = port;
+    wt->timer = timer;
+    return wt;
+}
+
+int
+os_wait_for_wtimer(struct os_wtimer *wt)
+{
+    port_event_t pe;
+    if (port_get(wt->port, &pe, 0) == -1) {
+        if (errno == EINTR)
+            return 1;
+        perror("port_get");
+        lose("os_wtimer_listen failed");
+    }
+    return 0;
 }
+
+void
+os_close_wtimer(struct os_wtimer *wt)
+{
+    if (close(wt->port) == -1) {
+        perror("close");
+        lose("os_close_wtimer");
+    }
+    if (timer_delete(wt->timer) == -1) {
+        perror("timer_delete");
+        lose("os_close_wtimer");
+    }
+    free(wt);
+}
+
+void
+os_set_wtimer(struct os_wtimer *wt, int sec, int nsec)
+{
+    struct itimerspec spec;
+    spec.it_value.tv_sec = sec;
+    spec.it_value.tv_nsec = nsec;
+    spec.it_interval.tv_sec = 0;
+    spec.it_interval.tv_nsec = 0;
+    if (timer_settime(wt->timer, 0, &spec, 0) == -1) {
+        int x = errno;
+        perror("timer_settime");
+        if (x != EINVAL)
+            lose("os_set_wtimer");
+    }
+}
+
+void
+os_cancel_wtimer(struct os_wtimer *wt)
+{
+    os_set_wtimer(wt, 0, 0);
+}
+#endif