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 /*
  22  * $Header$
  23  */
  24
  25 #include <stdio.h>
  26 #include <sys/param.h>
  27 #include <sys/file.h>
  28 #include "./signal.h"
  29 #include "os.h"
  30 #include "arch.h"
  31 #include "globals.h"
  32 #include "interrupt.h"
  33 #include "lispregs.h"
  34 #include "sbcl.h"
  35
  36 #include <sys/types.h>
  37 #include <signal.h>
  38 /* #include <sys/sysinfo.h> */
  39 #include <sys/proc.h>
  40 #include "validate.h"
  41 vm_size_t os_vm_page_size;
  42
  43 #if defined GENCGC
  44 #include "gencgc.h"
  45 #endif
  46
  47 /* The different BSD variants have diverged in exactly where they
  48  * store signal context information, but at least they tend to use the
  49  * same stems to name the structure fields, so by using this macro we
  50  * can share a fair amount of code between different variants. */
  51 #if defined __FreeBSD__
  52 #define CONTEXT_ADDR_FROM_STEM(stem) &context->uc_mcontext.mc_ ## stem
  53 #elif defined __OpenBSD__
  54 #define CONTEXT_ADDR_FROM_STEM(stem) &context->sc_ ## stem
  55 #else
  56 #error unsupported BSD variant
  57 #endif
  58 \f
  59 void
  60 os_init(void)
  61 {
  62     os_vm_page_size = getpagesize();
  63 }
  64
  65 /* KLUDGE: There is strong family resemblance in the signal context
  66  * stuff in FreeBSD and OpenBSD, but in detail they're different in
  67  * almost every line of code. It would be nice to find some way to
  68  * factor out the commonality better; failing that, it might be best
  69  * just to split this generic-BSD code into one variant for each BSD. */
  70
  71 int *
  72 os_context_register_addr(os_context_t *context, int offset)
  73 {
  74     switch(offset) {
  75     case  0:
  76         return CONTEXT_ADDR_FROM_STEM(eax);
  77     case  2:
  78         return CONTEXT_ADDR_FROM_STEM(ecx);
  79     case  4:
  80         return CONTEXT_ADDR_FROM_STEM(edx);
  81     case  6:
  82         return CONTEXT_ADDR_FROM_STEM(ebx);
  83     case  8:
  84         return CONTEXT_ADDR_FROM_STEM(esp);
  85     case 10:
  86         return CONTEXT_ADDR_FROM_STEM(ebp);
  87     case 12:
  88         return CONTEXT_ADDR_FROM_STEM(esi);
  89     case 14:
  90         return CONTEXT_ADDR_FROM_STEM(edi);
  91     default:
  92         return 0;
  93     }
  94 }
  95
  96 int *
  97 os_context_pc_addr(os_context_t *context)
  98 {
  99 #if defined __FreeBSD__
 100     return CONTEXT_ADDR_FROM_STEM(eip);
 101 #elif defined __OpenBSD__
 102     return CONTEXT_ADDR_FROM_STEM(pc);
 103 #else
 104 #error unsupported BSD variant
 105 #endif
 106 }
 107
 108 int *
 109 os_context_sp_addr(os_context_t *context)
 110 {
 111     return CONTEXT_ADDR_FROM_STEM(esp);
 112 }
 113
 114 sigset_t *
 115 os_context_sigmask_addr(os_context_t *context)
 116 {
 117     /* (Unlike most of the other context fields that we access, the
 118      * signal mask field is a field of the basic, outermost context
 119      * struct itself both in FreeBSD 4.0 and in OpenBSD 2.6.) */
 120 #if defined __FreeBSD__
 121     return &context->uc_sigmask;
 122 #elif defined __OpenBSD__
 123     return &context->sc_mask;
 124 #else
 125 #error unsupported BSD variant
 126 #endif
 127 }
 128
 129 os_vm_address_t
 130 os_validate(os_vm_address_t addr, os_vm_size_t len)
 131 {
 132     int flags = MAP_PRIVATE | MAP_ANON;
 133
 134     if (addr)
 135         flags |= MAP_FIXED;
 136
 137     addr = mmap(addr, len, OS_VM_PROT_ALL, flags, -1, 0);
 138
 139     if (addr == MAP_FAILED) {
 140         perror("mmap");
 141         return NULL;
 142     }
 143
 144     return addr;
 145 }
 146
 147 void
 148 os_invalidate(os_vm_address_t addr, os_vm_size_t len)
 149 {
 150     if (munmap(addr, len) == -1)
 151         perror("munmap");
 152 }
 153
 154 os_vm_address_t
 155 os_map(int fd, int offset, os_vm_address_t addr, os_vm_size_t len)
 156 {
 157     addr = mmap(addr, len,
 158                 OS_VM_PROT_ALL,
 159                 MAP_PRIVATE | MAP_FILE | MAP_FIXED,
 160                 fd, (off_t) offset);
 161
 162     if (addr == MAP_FAILED) {
 163         perror("mmap");
 164         lose("unexpected mmap(..) failure");
 165     }
 166
 167     return addr;
 168 }
 169
 170 void
 171 os_flush_icache(os_vm_address_t address, os_vm_size_t length)
 172 {
 173 }
 174
 175 void
 176 os_protect(os_vm_address_t address, os_vm_size_t length, os_vm_prot_t prot)
 177 {
 178     if (mprotect(address, length, prot) == -1) {
 179         perror("mprotect");
 180     }
 181 }
 182 \f
 183 static boolean
 184 in_range_p(os_vm_address_t a, lispobj sbeg, size_t slen)
 185 {
 186     char* beg = (char*) sbeg;
 187     char* end = (char*) sbeg + slen;
 188     char* adr = (char*) a;
 189     return (adr >= beg && adr < end);
 190 }
 191
 192 boolean
 193 is_valid_lisp_addr(os_vm_address_t addr)
 194 {
 195     return in_range_p(addr, READ_ONLY_SPACE_START, READ_ONLY_SPACE_SIZE)
 196         || in_range_p(addr, STATIC_SPACE_START   , STATIC_SPACE_SIZE   )
 197         || in_range_p(addr, DYNAMIC_SPACE_START  , DYNAMIC_SPACE_SIZE  )
 198         || in_range_p(addr, CONTROL_STACK_START  , CONTROL_STACK_SIZE  )
 199         || in_range_p(addr, BINDING_STACK_START  , BINDING_STACK_SIZE  );
 200 }
 201 \f
 202 /*
 203  * any OS-dependent special low-level handling for signals
 204  */
 205
 206 #if !defined GENCGC
 207
 208 void
 209 os_install_interrupt_handlers(void)
 210 {}
 211
 212 #else
 213
 214 /*
 215  * The GENCGC needs to be hooked into whatever signal is raised for
 216  * page fault on this OS.
 217  */
 218 static void
 219 memory_fault_handler(int signal, siginfo_t *siginfo, void *void_context)
 220 {
 221     /* The way that we extract low level information like the fault
 222      * address is not specified by POSIX. */
 223 #if defined __FreeBSD__
 224     void *fault_addr = siginfo->si_addr;
 225 #elif defined __OpenBSD__
 226     void *fault_addr = siginfo->si_addr;
 227 #else
 228 #error unsupported BSD variant
 229 #endif
 230     if (!gencgc_handle_wp_violation(fault_addr)) {
 231         interrupt_handle_now(signal, siginfo, void_context);
 232     }
 233 }
 234 void
 235 os_install_interrupt_handlers(void)
 236 {
 237 #if defined __FreeBSD__
 238     interrupt_install_low_level_handler(SIGBUS, memory_fault_handler);
 239 #elif defined __OpenBSD__
 240     interrupt_install_low_level_handler(SIGSEGV, memory_fault_handler);
 241 #else
 242 #error unsupported BSD variant
 243 #endif
 244 }
 245
 246 #endif /* !defined GENCGC */
 247 \f
 248 /*
 249  * stuff to help work with dynamically linked libraries
 250  */
 251
 252 /* feh!
 253  *
 254  * DL_WORKAROUND enables "stubbing" of various functions from libc et
 255  * al. This is necessary when using dynamic linking in FreeBSD, as the
 256  * symbols in the dynamic libraries will not have known addresses (in
 257  * sbcl.nm).
 258  *
 259  * FIXME: This flag should be set in Config.bsd */
 260 #if defined __FreeBSD__
 261 #define DL_WORKAROUND 1
 262 #elif defined __OpenBSD__
 263 /* SBCL doesn't (yet?) work at all with dynamic libs on OpenBSD, so we
 264  * wouldn't get any use out of these stubs. -- WHN 20001001 */
 265 #define DL_WORKAROUND 0
 266 #else
 267 #error unsupported BSD variant
 268 #endif
 269
 270 #if DL_WORKAROUND
 271 #include <unistd.h>
 272 #include <dlfcn.h>
 273 #include <math.h>
 274 #include <sys/types.h>
 275 #include <dirent.h>
 276 #include <stdlib.h>
 277 #include <sys/stat.h>
 278 #include <time.h>
 279 #include <sys/resource.h>
 280 #include <signal.h>
 281 #include <fcntl.h>
 282
 283 void *ldso_stub__dlopen(const char *path, int mode)
 284 {
 285   return dlopen(path, mode);
 286 }
 287
 288 void *ldso_stub__dlsym(void *handle, const char *symbol)
 289 {
 290   return dlsym(handle, symbol);
 291 }
 292
 293 const char *ldso_stub__dlerror(void)
 294 {
 295   return dlerror();
 296 }
 297 int ldso_stub__access(const char *path, int mode)
 298 {
 299   return access(path, mode);
 300 }
 301
 302 double ldso_stub__acos(double x)
 303 {
 304   return acos(x);
 305 }
 306
 307 double ldso_stub__acosh(double x)
 308 {
 309   return acosh(x);
 310 }
 311
 312 double ldso_stub__asin(double x)
 313 {
 314   return asin(x);
 315 }
 316
 317 double ldso_stub__asinh(double x)
 318 {
 319   return asin(x);
 320 }
 321
 322 double ldso_stub__atanh(double x)
 323 {
 324   return atanh(x);
 325 }
 326
 327
 328 int ldso_stub__chdir(const char *path)
 329 {
 330   return chdir(path);
 331 }
 332
 333 int ldso_stub__close(int d)
 334 {
 335   return close(d);
 336 }
 337
 338 int ldso_stub__closedir(DIR *dirp)
 339 {
 340   return closedir(dirp);
 341 }
 342
 343 double ldso_stub__cosh(double x)
 344 {
 345   return cosh(x);
 346 }
 347
 348 void ldso_stub__exit(int status)
 349 {
 350   exit(status);
 351 }
 352
 353 void ldso_stub__free(void *ptr)
 354 {
 355   free(ptr);
 356 }
 357
 358 int ldso_stub__fstat(int fd, struct stat *sb)
 359 {
 360   return fstat(fd, sb);
 361 }
 362
 363 int ldso_stub__fsync(int fd)
 364 {
 365   return fsync(fd);
 366 }
 367
 368 char *ldso_stub__getenv(const char *name)
 369 {
 370   return getenv(name);
 371 }
 372
 373 int ldso_stub__gethostname(char *name, int namelen)
 374 {
 375   return gethostname(name, namelen);
 376 }
 377
 378 pid_t ldso_stub__getpid(void)
 379 {
 380   return getpid();
 381 }
 382
 383 int ldso_stub__getrusage(int who, struct rusage *rusage)
 384 {
 385   return getrusage(who, rusage);
 386 }
 387
 388 int ldso_stub__gettimeofday(struct timeval *tp, struct timezone *tzp)
 389 {
 390   return gettimeofday(tp, tzp);
 391 }
 392
 393 uid_t ldso_stub__getuid(void)
 394 {
 395   return getuid();
 396 }
 397
 398 char *ldso_stub__getwd(char *buf)
 399 {
 400   return getwd(buf);
 401 }
 402
 403 double ldso_stub__hypot(double x, double y)
 404 {
 405   return hypot(x, y);
 406 }
 407
 408 int ldso_stub__kill(pid_t pid, int sig)
 409 {
 410   return kill(pid, sig);
 411 }
 412
 413 int ldso_stub__killpg(pid_t pgrp, int sig)
 414 {
 415   return killpg(pgrp, sig);
 416 }
 417
 418 off_t ldso_stub__lseek(int fildes, off_t offset, int whence)
 419 {
 420   return lseek(fildes, offset, whence);
 421 }
 422
 423 int ldso_stub__lstat(const char *path, struct stat *sb)
 424 {
 425   return lstat(path, sb);
 426 }
 427
 428 void *ldso_stub__malloc(size_t size)
 429 {
 430   return malloc(size);
 431 }
 432
 433 int ldso_stub__mkdir(const char *path, mode_t mode)
 434 {
 435   return mkdir(path, mode);
 436 }
 437
 438 int ldso_stub__open(const char *path, int flags, mode_t mode)
 439 {
 440   return open(path, flags, mode);
 441 }
 442
 443 DIR *ldso_stub__opendir(const char *filename)
 444 {
 445   return opendir(filename);
 446 }
 447
 448 double ldso_stub__pow(double x, double y)
 449 {
 450   return pow(x, y);
 451 }
 452
 453 ssize_t ldso_stub__read(int d, void *buf, size_t nbytes)
 454 {
 455   return read(d, buf, nbytes);
 456 }
 457
 458 struct dirent *ldso_stub__readdir(DIR *dirp)
 459 {
 460   return readdir(dirp);
 461 }
 462
 463 int ldso_stub__readlink(const char *path, char *buf, int bufsiz)
 464 {
 465   return readlink(path, buf, bufsiz);
 466 }
 467
 468 int ldso_stub__rename(const char *from, const char *to)
 469 {
 470   return rename(from, to);
 471 }
 472
 473 int ldso_stub__select(int nfds, fd_set *readfs, fd_set *writefds,
 474                       fd_set *exceptfds, struct timeval *timeout)
 475 {
 476   return select(nfds, readfs, writefds, exceptfds, timeout);
 477 }
 478
 479 int ldso_stub__sigblock(int mask)
 480 {
 481   return sigblock(mask);
 482 }
 483
 484 int ldso_stub__sigpause(int sigmask)
 485 {
 486   return sigpause(sigmask);
 487 }
 488
 489 int ldso_stub__sigsetmask(int mask)
 490 {
 491   return sigsetmask(mask);
 492 }
 493
 494 double ldso_stub__sinh(double x)
 495 {
 496   return sin(x);
 497 }
 498
 499 int ldso_stub__stat(const char *path, struct stat *sb)
 500 {
 501   return stat(path, sb);
 502 }
 503
 504 double ldso_stub__tanh(double x)
 505 {
 506   return tanh(x);
 507 }
 508
 509 /* tzname */
 510
 511 int ldso_stub__unlink(const char *path)
 512 {
 513   return unlink(path);
 514 }
 515
 516 ssize_t ldso_stub__write(int d, const void *buf, size_t nbytes)
 517 {
 518   return write(d, buf, nbytes);
 519 }
 520
 521 pid_t ldso_stub__wait3(int *status, int options, struct rusage *rusage)
 522 {
 523   return wait3(status, options, rusage);
 524 }
 525
 526 #endif /* DL_WORKAROUND */