src/runtime/bsd-os.c

   1 /*
   2  * OS-dependent routines for BSD-ish systems
   3  *
   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.
   8  */
   9
  10 /*
  11  * This software is part of the SBCL system. See the README file for
  12  * more information.
  13  *
  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.
  19  */
  20
  21 #include <stdio.h>
  22 #include <sys/param.h>
  23 #include <sys/file.h>
  24 #include <unistd.h>
  25 #include <assert.h>
  26 #include <errno.h>
  27 #include "sbcl.h"
  28 #include "./signal.h"
  29 #include "os.h"
  30 #include "arch.h"
  31 #include "globals.h"
  32 #include "interrupt.h"
  33 #include "interr.h"
  34 #include "lispregs.h"
  35 #include "thread.h"
  36 #include "runtime.h"
  37 #include "genesis/static-symbols.h"
  38 #include "genesis/fdefn.h"
  39
  40 #include <sys/types.h>
  41 #include <signal.h>
  42 /* #include <sys/sysinfo.h> */
  43 #include "validate.h"
  44 #if defined LISP_FEATURE_GENCGC
  45 #include "gencgc-internal.h"
  46 #endif
  47 \f
  48 os_vm_size_t os_vm_page_size;
  49
  50 #ifdef __NetBSD__
  51 #include <sys/resource.h>
  52 #include <sys/sysctl.h>
  53 #include <string.h>
  54 #include <sys/stat.h> /* For the stat-family wrappers. */
  55 #include <dirent.h>   /* For the opendir()/readdir() wrappers */
  56 #include <sys/socket.h> /* For the socket() wrapper */
  57 static void netbsd_init();
  58 #endif /* __NetBSD__ */
  59
  60 #ifdef __FreeBSD__
  61 #include <sys/sysctl.h>
  62 #if defined(LISP_FEATURE_SB_THREAD) && !defined(LISP_FEATURE_SB_PTHREAD_FUTEX)
  63 #include <sys/umtx.h>
  64 #endif
  65
  66 static void freebsd_init();
  67 #endif /* __FreeBSD__ */
  68
  69 #ifdef __OpenBSD__
  70 #include <sys/types.h>
  71 #include <sys/resource.h>
  72 #include <sys/stat.h>
  73 #include <dlfcn.h>
  74
  75 static void openbsd_init();
  76 #endif
  77
  78 void
  79 os_init(char *argv[], char *envp[])
  80 {
  81     os_vm_page_size = getpagesize();
  82
  83 #ifdef __NetBSD__
  84     netbsd_init();
  85 #elif defined(__FreeBSD__)
  86     freebsd_init();
  87 #elif defined(__OpenBSD__)
  88     openbsd_init();
  89 #endif
  90 }
  91
  92 sigset_t *
  93 os_context_sigmask_addr(os_context_t *context)
  94 {
  95     /* (Unlike most of the other context fields that we access, the
  96      * signal mask field is a field of the basic, outermost context
  97      * struct itself both in FreeBSD 4.0 and in OpenBSD 2.6.) */
  98 #if defined(__FreeBSD__)  || defined(__NetBSD__) || defined(LISP_FEATURE_DARWIN)
  99     return &context->uc_sigmask;
 100 #elif defined (__OpenBSD__)
 101     return &context->sc_mask;
 102 #else
 103 #error unsupported BSD variant
 104 #endif
 105 }
 106
 107 os_vm_address_t
 108 os_validate(os_vm_address_t addr, os_vm_size_t len)
 109 {
 110     int flags = MAP_PRIVATE | MAP_ANON;
 111
 112     if (addr)
 113         flags |= MAP_FIXED;
 114
 115     addr = mmap(addr, len, OS_VM_PROT_ALL, flags, -1, 0);
 116
 117     if (addr == MAP_FAILED) {
 118         perror("mmap");
 119         return NULL;
 120     }
 121
 122     return addr;
 123 }
 124
 125 void
 126 os_invalidate(os_vm_address_t addr, os_vm_size_t len)
 127 {
 128     if (munmap(addr, len) == -1)
 129         perror("munmap");
 130 }
 131
 132 os_vm_address_t
 133 os_map(int fd, int offset, os_vm_address_t addr, os_vm_size_t len)
 134 {
 135     addr = mmap(addr, len,
 136                 OS_VM_PROT_ALL,
 137                 MAP_PRIVATE | MAP_FILE | MAP_FIXED,
 138                 fd, (off_t) offset);
 139
 140     if (addr == MAP_FAILED) {
 141         perror("mmap");
 142         lose("unexpected mmap(..) failure\n");
 143     }
 144
 145     return addr;
 146 }
 147
 148 void
 149 os_protect(os_vm_address_t address, os_vm_size_t length, os_vm_prot_t prot)
 150 {
 151     if (mprotect(address, length, prot) == -1) {
 152         perror("mprotect");
 153     }
 154 }
 155 \f
 156 static boolean
 157 in_range_p(os_vm_address_t a, lispobj sbeg, size_t slen)
 158 {
 159     char* beg = (char*) sbeg;
 160     char* end = (char*) sbeg + slen;
 161     char* adr = (char*) a;
 162     return (adr >= beg && adr < end);
 163 }
 164
 165 boolean
 166 is_valid_lisp_addr(os_vm_address_t addr)
 167 {
 168     struct thread *th;
 169
 170     if (in_range_p(addr, READ_ONLY_SPACE_START, READ_ONLY_SPACE_SIZE) ||
 171         in_range_p(addr, STATIC_SPACE_START, STATIC_SPACE_SIZE) ||
 172         in_range_p(addr, DYNAMIC_SPACE_START, dynamic_space_size))
 173         return 1;
 174     for_each_thread(th) {
 175         if (((os_vm_address_t)th->control_stack_start <= addr) &&
 176             (addr < (os_vm_address_t)th->control_stack_end))
 177             return 1;
 178         if (in_range_p(addr, (lispobj) th->binding_stack_start,
 179                        BINDING_STACK_SIZE))
 180             return 1;
 181     }
 182     return 0;
 183 }
 184 \f
 185 /*
 186  * any OS-dependent special low-level handling for signals
 187  */
 188
 189 #if defined LISP_FEATURE_GENCGC
 190
 191 /*
 192  * The GENCGC needs to be hooked into whatever signal is raised for
 193  * page fault on this OS.
 194  */
 195
 196 void
 197 memory_fault_handler(int signal, siginfo_t *siginfo, void *void_context
 198 #if defined(LISP_FEATURE_FREEBSD) && defined(LISP_FEATURE_X86_64)
 199 /* FreeBSD/amd64 stores fault address only in undocumented 4th arg. */
 200                      ,void *fault_addr
 201 #endif
 202     )
 203 {
 204     os_context_t *context = arch_os_get_context(&void_context);
 205 #if defined(LISP_FEATURE_FREEBSD) && defined(LISP_FEATURE_X86_64)
 206     /* KLUDGE: Store fault address into si_addr for compatibilities. */
 207     siginfo->si_addr = fault_addr;
 208 #else
 209     void *fault_addr = arch_get_bad_addr(signal, siginfo, context);
 210 #endif
 211
 212 #if defined(LISP_FEATURE_RESTORE_TLS_SEGMENT_REGISTER_FROM_CONTEXT)
 213     FSHOW_SIGNAL((stderr, "/ TLS: restoring fs: %p in memory_fault_handler\n",
 214                   *CONTEXT_ADDR_FROM_STEM(fs)));
 215     os_restore_tls_segment_register(context);
 216 #endif
 217
 218     FSHOW((stderr, "Memory fault at: %p, PC: %p\n", fault_addr, *os_context_pc_addr(context)));
 219
 220     if (!gencgc_handle_wp_violation(fault_addr))
 221         if(!handle_guard_page_triggered(context,fault_addr)) {
 222 #ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
 223             lisp_memory_fault_error(context, fault_addr);
 224 #else
 225             /* FIXME: never returns 0 */
 226             if (!maybe_gc(context)) {
 227                 interrupt_handle_now(signal, siginfo, context);
 228             }
 229 #endif
 230         }
 231 }
 232
 233 #if defined(LISP_FEATURE_MACH_EXCEPTION_HANDLER)
 234 void
 235 mach_error_memory_fault_handler(int signal, siginfo_t *siginfo, void *void_context) {
 236     lose("Unhandled memory fault. Exiting.");
 237 }
 238 #endif
 239
 240 void
 241 os_install_interrupt_handlers(void)
 242 {
 243     SHOW("os_install_interrupt_handlers()/bsd-os/defined(GENCGC)");
 244 #if defined(LISP_FEATURE_MACH_EXCEPTION_HANDLER)
 245     undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
 246                                                  mach_error_memory_fault_handler);
 247 #else
 248     undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
 249 #ifdef LISP_FEATURE_FREEBSD
 250                                                  (__siginfohandler_t *)
 251 #endif
 252                                                  memory_fault_handler);
 253 #endif
 254
 255 #ifdef LISP_FEATURE_SB_THREAD
 256     undoably_install_low_level_interrupt_handler(SIG_INTERRUPT_THREAD,
 257                                                  interrupt_thread_handler);
 258     undoably_install_low_level_interrupt_handler(SIG_STOP_FOR_GC,
 259                                                  sig_stop_for_gc_handler);
 260 #endif
 261     SHOW("leaving os_install_interrupt_handlers()");
 262 }
 263
 264 #else /* Currently PPC/Darwin/Cheney only */
 265
 266 static void
 267 sigsegv_handler(int signal, siginfo_t *info, void* void_context)
 268 {
 269     os_context_t *context = arch_os_get_context(&void_context);
 270 #if 0
 271     unsigned int pc =  (unsigned int *)(*os_context_pc_addr(context));
 272 #endif
 273     os_vm_address_t addr;
 274
 275     addr = arch_get_bad_addr(signal, info, context);
 276     if (!cheneygc_handle_wp_violation(context, addr))
 277         if (!handle_guard_page_triggered(context, addr))
 278             interrupt_handle_now(signal, info, context);
 279 }
 280
 281 void
 282 os_install_interrupt_handlers(void)
 283 {
 284     SHOW("os_install_interrupt_handlers()/bsd-os/!defined(GENCGC)");
 285     undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
 286                                                  sigsegv_handler);
 287 }
 288
 289 #endif /* defined GENCGC */
 290
 291 #ifdef __NetBSD__
 292 static void netbsd_init()
 293 {
 294     struct rlimit rl;
 295     int mib[2], osrev;
 296     size_t len;
 297
 298     /* Are we running on a sufficiently functional kernel? */
 299     mib[0] = CTL_KERN;
 300     mib[1] = KERN_OSREV;
 301
 302     len = sizeof(osrev);
 303     sysctl(mib, 2, &osrev, &len, NULL, 0);
 304
 305     /* If we're older than 2.0... */
 306     if (osrev < 200000000) {
 307         fprintf(stderr, "osrev = %d (needed at least 200000000).\n", osrev);
 308         lose("NetBSD kernel too old to run sbcl.\n");
 309     }
 310
 311     /* NetBSD counts mmap()ed space against the process's data size limit,
 312      * so yank it up. This might be a nasty thing to do? */
 313     getrlimit (RLIMIT_DATA, &rl);
 314     /* Amazingly for such a new port, the provenance and meaning of
 315        this number are unknown.  It might just mean REALLY_BIG_LIMIT,
 316        or possibly it should be calculated from dynamic space size.
 317        -- CSR, 2004-04-08 */
 318     rl.rlim_cur = 1073741824;
 319     if (setrlimit (RLIMIT_DATA, &rl) < 0) {
 320         fprintf (stderr,
 321                  "RUNTIME WARNING: unable to raise process data size limit:\n\
 322   %s.\n\
 323 The system may fail to start.\n",
 324                  strerror(errno));
 325     }
 326 }
 327
 328 /* Various routines in NetBSD's C library are compatibility wrappers
 329    for old versions. Programs must be processed by the C toolchain in
 330    order to get up-to-date definitions of such routines. */
 331 /* The stat-family, opendir, and readdir are used only in sb-posix, as
 332    of 2007-01-16. -- RMK */
 333 int
 334 _stat(const char *path, struct stat *sb)
 335 {
 336     return stat(path, sb);
 337 }
 338 int
 339 _lstat(const char *path, struct stat *sb)
 340 {
 341     return lstat(path, sb);
 342 }
 343 int
 344 _fstat(int fd, struct stat *sb)
 345 {
 346     return fstat(fd, sb);
 347 }
 348
 349 DIR *
 350 _opendir(const char *filename)
 351 {
 352     return opendir(filename);
 353 }
 354 struct dirent *
 355 _readdir(DIR *dirp)
 356 {
 357     return readdir(dirp);
 358 }
 359
 360 /* Used in sb-bsd-sockets. */
 361 int
 362 _socket(int domain, int type, int protocol)
 363 {
 364     return socket(domain, type, protocol);
 365 }
 366 #endif /* __NetBSD__ */
 367
 368 #ifdef __FreeBSD__
 369 extern int getosreldate(void);
 370
 371 int sig_memory_fault;
 372
 373 static void freebsd_init()
 374 {
 375     /* Memory fault signal on FreeBSD was changed from SIGBUS to
 376      * SIGSEGV. */
 377     if (getosreldate() < 700004)
 378         sig_memory_fault = SIGBUS;
 379     else
 380         sig_memory_fault = SIGSEGV;
 381
 382     /* Quote from sbcl-devel (NIIMI Satoshi): "Some OSes, like FreeBSD
 383      * 4.x with GENERIC kernel, does not enable SSE support even on
 384      * SSE capable CPUs". Detect this situation and skip the
 385      * fast_bzero sse/base selection logic that's normally done in
 386      * x86-assem.S.
 387      */
 388 #ifdef LISP_FEATURE_X86
 389     {
 390         size_t len;
 391         int instruction_sse;
 392
 393         len = sizeof(instruction_sse);
 394         if (sysctlbyname("hw.instruction_sse", &instruction_sse, &len,
 395                          NULL, 0) == 0 && instruction_sse != 0) {
 396             /* Use the SSE detector */
 397             fast_bzero_pointer = fast_bzero_detect;
 398         }
 399     }
 400 #endif /* LISP_FEATURE_X86 */
 401 }
 402
 403 #if defined(LISP_FEATURE_SB_THREAD) && !defined(LISP_FEATURE_SB_PTHREAD_FUTEX)
 404 int
 405 futex_wait(int *lock_word, long oldval, long sec, unsigned long usec)
 406 {
 407     struct timespec timeout;
 408     int ret;
 409
 410 again:
 411     if (sec < 0)
 412         ret = umtx_wait((void *)lock_word, oldval, NULL);
 413     else {
 414         timeout.tv_sec = sec;
 415         timeout.tv_nsec = usec * 1000;
 416         ret = umtx_wait((void *)lock_word, oldval, &timeout);
 417     }
 418
 419     switch (ret) {
 420     case 0:
 421         return 0;
 422     case ETIMEDOUT:
 423         return 1;
 424     case EINTR:
 425         /* spurious wakeup from interrupt */
 426         goto again;
 427     default:
 428         /* EWOULDBLOCK and others, need to check the lock */
 429         return -1;
 430     }
 431 }
 432
 433 int
 434 futex_wake(int *lock_word, int n)
 435 {
 436     return umtx_wake((void *)lock_word, n);
 437 }
 438 #endif
 439 #endif /* __FreeBSD__ */
 440
 441 #ifdef LISP_FEATURE_DARWIN
 442 /* defined in ppc-darwin-os.c instead */
 443 #elif defined(LISP_FEATURE_FREEBSD)
 444 #ifndef KERN_PROC_PATHNAME
 445 #define KERN_PROC_PATHNAME 12
 446 #endif
 447
 448 char *
 449 os_get_runtime_executable_path()
 450 {
 451     char path[PATH_MAX + 1];
 452
 453     if (getosreldate() >= 600024) {
 454         /* KERN_PROC_PATHNAME is available */
 455         size_t len = PATH_MAX + 1;
 456         int mib[4];
 457
 458         mib[0] = CTL_KERN;
 459         mib[1] = KERN_PROC;
 460         mib[2] = KERN_PROC_PATHNAME;
 461         mib[3] = -1;
 462         if (sysctl(mib, 4, &path, &len, NULL, 0) != 0)
 463             return NULL;
 464     } else {
 465         int size;
 466         size = readlink("/proc/curproc/file", path, sizeof(path) - 1);
 467         if (size < 0)
 468             return NULL;
 469         path[size] = '\0';
 470     }
 471     if (strcmp(path, "unknown") == 0)
 472         return NULL;
 473     return copied_string(path);
 474 }
 475 #elif defined(LISP_FEATURE_NETBSD) || defined(LISP_FEATURE_OPENBSD)
 476 char *
 477 os_get_runtime_executable_path()
 478 {
 479     struct stat sb;
 480     char *path = strdup("/proc/curproc/file");
 481     if (path && ((stat(path, &sb)) == 0))
 482         return path;
 483     else {
 484         fprintf(stderr, "Couldn't stat /proc/curproc/file; is /proc mounted?\n");
 485         return NULL;
 486     }
 487 }
 488 #else /* Not DARWIN or FREEBSD or NETBSD or OPENBSD */
 489 char *
 490 os_get_runtime_executable_path()
 491 {
 492     return NULL;
 493 }
 494 #endif
 495
 496 #ifdef __OpenBSD__
 497 void
 498 openbsd_init()
 499 {
 500     struct rlimit rl;
 501
 502     /* OpenBSD, like NetBSD, counts mmap()ed space against the
 503      * process's data size limit. If the soft limit is lower than the
 504      * hard limit then try to yank it up, this lets users in the
 505      * "staff" login class run sbcl with a default /etc/login.conf
 506      */
 507     getrlimit (RLIMIT_DATA, &rl);
 508     if (rl.rlim_cur < rl.rlim_max) {
 509         rl.rlim_cur = rl.rlim_max;
 510         if (setrlimit (RLIMIT_DATA, &rl) < 0) {
 511             fprintf (stderr,
 512                      "RUNTIME WARNING: unable to raise process data size limit:\n\
 513   %s.\n\
 514 The system may fail to start.\n",
 515                      strerror(errno));
 516         }
 517     }
 518
 519     /* Display a (hopefully) helpful warning if it looks like we won't
 520      * be able to allocate enough memory. In testing I found that on
 521      * my system at least, a minimum of 25M on top of the three space
 522      * sizes was needed to start SBCL. Show a warning below 32M so as
 523      * to leave a little breathing room.
 524      */
 525     getrlimit (RLIMIT_DATA, &rl);
 526     if (dynamic_space_size + READ_ONLY_SPACE_SIZE + STATIC_SPACE_SIZE +
 527         LINKAGE_TABLE_SPACE_SIZE + (32*1024*1024) > rl.rlim_cur)
 528         fprintf (stderr,
 529                  "RUNTIME WARNING: data size resource limit may be too low,\n"
 530                  "  try decreasing the dynamic space size with --dynamic-space-size\n");
 531 }
 532
 533 /* OpenBSD's dlsym() relies on the gcc bulitin
 534  * __builtin_return_address(0) returning an address in the
 535  * executable's text segment, but when called from lisp it will return
 536  * an address in the dynamic space.  Work around this by calling this
 537  * wrapper function instead. Note that tail-call optimization will
 538  * defeat this, disable it by saving the dlsym() return value in a
 539  * volatile variable.
 540 */
 541 void *
 542 os_dlsym(void *handle, const char *symbol)
 543 {
 544     void * volatile ret = dlsym(handle, symbol);
 545     return ret;
 546 }
 547
 548 #endif