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             lisp_memory_fault_error(context, fault_addr);
 223 }
 224
 225 #if defined(LISP_FEATURE_MACH_EXCEPTION_HANDLER)
 226 void
 227 mach_error_memory_fault_handler(int signal, siginfo_t *siginfo, void *void_context) {
 228     lose("Unhandled memory fault. Exiting.");
 229 }
 230 #endif
 231
 232 void
 233 os_install_interrupt_handlers(void)
 234 {
 235     SHOW("os_install_interrupt_handlers()/bsd-os/defined(GENCGC)");
 236 #if defined(LISP_FEATURE_MACH_EXCEPTION_HANDLER)
 237     undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
 238                                                  mach_error_memory_fault_handler);
 239 #else
 240     undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
 241 #ifdef LISP_FEATURE_FREEBSD
 242                                                  (__siginfohandler_t *)
 243 #endif
 244                                                  memory_fault_handler);
 245 #endif
 246
 247 #ifdef LISP_FEATURE_SB_THREAD
 248     undoably_install_low_level_interrupt_handler(SIG_STOP_FOR_GC,
 249                                                  sig_stop_for_gc_handler);
 250 #endif
 251     SHOW("leaving os_install_interrupt_handlers()");
 252 }
 253
 254 #else /* Currently PPC/Darwin/Cheney only */
 255
 256 static void
 257 sigsegv_handler(int signal, siginfo_t *info, void* void_context)
 258 {
 259     os_context_t *context = arch_os_get_context(&void_context);
 260 #if 0
 261     unsigned int pc =  (unsigned int *)(*os_context_pc_addr(context));
 262 #endif
 263     os_vm_address_t addr;
 264
 265     addr = arch_get_bad_addr(signal, info, context);
 266     if (!cheneygc_handle_wp_violation(context, addr))
 267         if (!handle_guard_page_triggered(context, addr))
 268             interrupt_handle_now(signal, info, context);
 269 }
 270
 271 void
 272 os_install_interrupt_handlers(void)
 273 {
 274     SHOW("os_install_interrupt_handlers()/bsd-os/!defined(GENCGC)");
 275     undoably_install_low_level_interrupt_handler(SIG_MEMORY_FAULT,
 276                                                  sigsegv_handler);
 277 }
 278
 279 #endif /* defined GENCGC */
 280
 281 #ifdef __NetBSD__
 282 static void netbsd_init()
 283 {
 284     struct rlimit rl;
 285     int mib[2], osrev;
 286     size_t len;
 287
 288     /* Are we running on a sufficiently functional kernel? */
 289     mib[0] = CTL_KERN;
 290     mib[1] = KERN_OSREV;
 291
 292     len = sizeof(osrev);
 293     sysctl(mib, 2, &osrev, &len, NULL, 0);
 294
 295     /* If we're older than 2.0... */
 296     if (osrev < 200000000) {
 297         fprintf(stderr, "osrev = %d (needed at least 200000000).\n", osrev);
 298         lose("NetBSD kernel too old to run sbcl.\n");
 299     }
 300
 301     /* NetBSD counts mmap()ed space against the process's data size limit,
 302      * so yank it up. This might be a nasty thing to do? */
 303     getrlimit (RLIMIT_DATA, &rl);
 304     /* Amazingly for such a new port, the provenance and meaning of
 305        this number are unknown.  It might just mean REALLY_BIG_LIMIT,
 306        or possibly it should be calculated from dynamic space size.
 307        -- CSR, 2004-04-08 */
 308     rl.rlim_cur = 1073741824;
 309     if (setrlimit (RLIMIT_DATA, &rl) < 0) {
 310         fprintf (stderr,
 311                  "RUNTIME WARNING: unable to raise process data size limit:\n\
 312   %s.\n\
 313 The system may fail to start.\n",
 314                  strerror(errno));
 315     }
 316 }
 317
 318 /* Various routines in NetBSD's C library are compatibility wrappers
 319    for old versions. Programs must be processed by the C toolchain in
 320    order to get up-to-date definitions of such routines. */
 321 /* The stat-family, opendir, and readdir are used only in sb-posix, as
 322    of 2007-01-16. -- RMK */
 323 int
 324 _stat(const char *path, struct stat *sb)
 325 {
 326     return stat(path, sb);
 327 }
 328 int
 329 _lstat(const char *path, struct stat *sb)
 330 {
 331     return lstat(path, sb);
 332 }
 333 int
 334 _fstat(int fd, struct stat *sb)
 335 {
 336     return fstat(fd, sb);
 337 }
 338
 339 DIR *
 340 _opendir(const char *filename)
 341 {
 342     return opendir(filename);
 343 }
 344 struct dirent *
 345 _readdir(DIR *dirp)
 346 {
 347     return readdir(dirp);
 348 }
 349
 350 /* Used in sb-bsd-sockets. */
 351 int
 352 _socket(int domain, int type, int protocol)
 353 {
 354     return socket(domain, type, protocol);
 355 }
 356 #endif /* __NetBSD__ */
 357
 358 #ifdef __FreeBSD__
 359 extern int getosreldate(void);
 360
 361 int sig_memory_fault;
 362
 363 static void freebsd_init()
 364 {
 365     /* Memory fault signal on FreeBSD was changed from SIGBUS to
 366      * SIGSEGV. */
 367     if (getosreldate() < 700004)
 368         sig_memory_fault = SIGBUS;
 369     else
 370         sig_memory_fault = SIGSEGV;
 371
 372     /* Quote from sbcl-devel (NIIMI Satoshi): "Some OSes, like FreeBSD
 373      * 4.x with GENERIC kernel, does not enable SSE support even on
 374      * SSE capable CPUs". Detect this situation and skip the
 375      * fast_bzero sse/base selection logic that's normally done in
 376      * x86-assem.S.
 377      */
 378 #ifdef LISP_FEATURE_X86
 379     {
 380         size_t len;
 381         int instruction_sse;
 382
 383         len = sizeof(instruction_sse);
 384         if (sysctlbyname("hw.instruction_sse", &instruction_sse, &len,
 385                          NULL, 0) == 0 && instruction_sse != 0) {
 386             /* Use the SSE detector */
 387             fast_bzero_pointer = fast_bzero_detect;
 388         }
 389     }
 390 #endif /* LISP_FEATURE_X86 */
 391 }
 392
 393 #if defined(LISP_FEATURE_SB_THREAD) && !defined(LISP_FEATURE_SB_PTHREAD_FUTEX)
 394 int
 395 futex_wait(int *lock_word, long oldval, long sec, unsigned long usec)
 396 {
 397     struct timespec timeout;
 398     int ret;
 399
 400     if (sec < 0)
 401         ret = umtx_wait((void *)lock_word, oldval, NULL);
 402     else {
 403         timeout.tv_sec = sec;
 404         timeout.tv_nsec = usec * 1000;
 405         ret = umtx_wait((void *)lock_word, oldval, &timeout);
 406     }
 407
 408     switch (ret) {
 409     case 0:
 410         return 0;
 411     case ETIMEDOUT:
 412         return 1;
 413     case EINTR:
 414         return 2;
 415     default:
 416         /* EWOULDBLOCK and others, need to check the lock */
 417         return -1;
 418     }
 419 }
 420
 421 int
 422 futex_wake(int *lock_word, int n)
 423 {
 424     return umtx_wake((void *)lock_word, n);
 425 }
 426 #endif
 427 #endif /* __FreeBSD__ */
 428
 429 #ifdef LISP_FEATURE_DARWIN
 430 /* defined in ppc-darwin-os.c instead */
 431 #elif defined(LISP_FEATURE_FREEBSD)
 432 #ifndef KERN_PROC_PATHNAME
 433 #define KERN_PROC_PATHNAME 12
 434 #endif
 435
 436 char *
 437 os_get_runtime_executable_path()
 438 {
 439     char path[PATH_MAX + 1];
 440
 441     if (getosreldate() >= 600024) {
 442         /* KERN_PROC_PATHNAME is available */
 443         size_t len = PATH_MAX + 1;
 444         int mib[4];
 445
 446         mib[0] = CTL_KERN;
 447         mib[1] = KERN_PROC;
 448         mib[2] = KERN_PROC_PATHNAME;
 449         mib[3] = -1;
 450         if (sysctl(mib, 4, &path, &len, NULL, 0) != 0)
 451             return NULL;
 452     } else {
 453         int size;
 454         size = readlink("/proc/curproc/file", path, sizeof(path) - 1);
 455         if (size < 0)
 456             return NULL;
 457         path[size] = '\0';
 458     }
 459     if (strcmp(path, "unknown") == 0)
 460         return NULL;
 461     return copied_string(path);
 462 }
 463 #elif defined(LISP_FEATURE_NETBSD) || defined(LISP_FEATURE_OPENBSD)
 464 char *
 465 os_get_runtime_executable_path()
 466 {
 467     struct stat sb;
 468     char *path = strdup("/proc/curproc/file");
 469     if (path && ((stat(path, &sb)) == 0))
 470         return path;
 471     else {
 472         fprintf(stderr, "Couldn't stat /proc/curproc/file; is /proc mounted?\n");
 473         return NULL;
 474     }
 475 }
 476 #else /* Not DARWIN or FREEBSD or NETBSD or OPENBSD */
 477 char *
 478 os_get_runtime_executable_path()
 479 {
 480     return NULL;
 481 }
 482 #endif
 483
 484 #ifdef __OpenBSD__
 485 void
 486 openbsd_init()
 487 {
 488     struct rlimit rl;
 489
 490     /* OpenBSD, like NetBSD, counts mmap()ed space against the
 491      * process's data size limit. If the soft limit is lower than the
 492      * hard limit then try to yank it up, this lets users in the
 493      * "staff" login class run sbcl with a default /etc/login.conf
 494      */
 495     getrlimit (RLIMIT_DATA, &rl);
 496     if (rl.rlim_cur < rl.rlim_max) {
 497         rl.rlim_cur = rl.rlim_max;
 498         if (setrlimit (RLIMIT_DATA, &rl) < 0) {
 499             fprintf (stderr,
 500                      "RUNTIME WARNING: unable to raise process data size limit:\n\
 501   %s.\n\
 502 The system may fail to start.\n",
 503                      strerror(errno));
 504         }
 505     }
 506
 507     /* Display a (hopefully) helpful warning if it looks like we won't
 508      * be able to allocate enough memory. In testing I found that on
 509      * my system at least, a minimum of 25M on top of the three space
 510      * sizes was needed to start SBCL. Show a warning below 32M so as
 511      * to leave a little breathing room.
 512      */
 513     getrlimit (RLIMIT_DATA, &rl);
 514     if (dynamic_space_size + READ_ONLY_SPACE_SIZE + STATIC_SPACE_SIZE +
 515         LINKAGE_TABLE_SPACE_SIZE + (32*1024*1024) > rl.rlim_cur)
 516         fprintf (stderr,
 517                  "RUNTIME WARNING: data size resource limit may be too low,\n"
 518                  "  try decreasing the dynamic space size with --dynamic-space-size\n");
 519 }
 520
 521 /* OpenBSD's dlsym() relies on the gcc bulitin
 522  * __builtin_return_address(0) returning an address in the
 523  * executable's text segment, but when called from lisp it will return
 524  * an address in the dynamic space.  Work around this by calling this
 525  * wrapper function instead. Note that tail-call optimization will
 526  * defeat this, disable it by saving the dlsym() return value in a
 527  * volatile variable.
 528 */
 529 void *
 530 os_dlsym(void *handle, const char *symbol)
 531 {
 532     void * volatile ret = dlsym(handle, symbol);
 533     return ret;
 534 }
 535
 536 #endif