src/runtime/os.h

   1 /*
   2  * common interface for OS-dependent functions
   3  */
   4
   5 /*
   6  * This software is part of the SBCL system. See the README file for
   7  * more information.
   8  *
   9  * This software is derived from the CMU CL system, which was
  10  * written at Carnegie Mellon University and released into the
  11  * public domain. The software is in the public domain and is
  12  * provided with absolutely no warranty. See the COPYING and CREDITS
  13  * files for more information.
  14  */
  15
  16 #if !defined(_OS_H_INCLUDED_)
  17
  18 #define _OS_H_INCLUDED_
  19
  20 #include "runtime.h"
  21
  22 /* Some standard preprocessor definitions and typedefs are needed from
  23  * the OS-specific #include files. This is an attempt to document
  24  * them on 20000729, by WHN the impatient reverse engineer.
  25  *
  26  * OS_VM_PROT_READ, OS_VM_PROT_WRITE, OS_VM_PROT_EXECUTE
  27  *   flags for mmap, mprotect, etc. controlling memory protection
  28  * os_vm_prot_t
  29  *   type used for flags for mmap, mprotect, etc.
  30  *
  31  * OS_VM_DEFAULT_PAGESIZE
  32  *   used by core dumping and loading logic (but dunno its exact
  33  *   definition, in particular why we can't just use getpagesize()
  34  *   instead)
  35  *
  36  * os_vm_address_t
  37  *   the type used to represent addresses? (dunno why not just void*)
  38  * os_vm_size_t, os_vm_off_t
  39  *   corresponding to standard (POSIX?) types size_t, off_t
  40  * os_context_t
  41  *   the type used to represent context in a POSIX sigaction SA_SIGACTION
  42  *   handler, i.e. the actual type of the thing pointed to by the
  43  *   void* third argument of a handler */
  44 #if defined __FreeBSD__
  45 #include "bsd-os.h"
  46 #elif defined __OpenBSD__
  47 #include "bsd-os.h"
  48 #elif defined __linux__
  49 #include "linux-os.h"
  50 #else
  51 #error unsupported OS
  52 #endif
  53
  54 #define OS_VM_PROT_ALL \
  55   (OS_VM_PROT_READ | OS_VM_PROT_WRITE | OS_VM_PROT_EXECUTE)
  56
  57 extern os_vm_size_t os_vm_page_size;
  58
  59 /* Do anything we need to do when starting up the runtime environment
  60  * in this OS. */
  61 extern void os_init(void);
  62
  63 /* Install any OS-dependent low-level signal handlers which are needed
  64  * by the runtime environment. E.g. the signals raised by a violation
  65  * of the gencgc write barrier need to be caught at a low level, and
  66  * they may be SIGSEGV on one OS and SIGBUS on another, so we install
  67  * them in an OS-dependent way. */
  68 extern void os_install_interrupt_handlers(void);
  69
  70 /* Clear a possibly-huge region of memory using any tricks available to
  71  * do it efficiently, e.g. possibly unmapping it and then remapping it.
  72  *
  73  * FIXME: For the x86 Linux/OpenBSD/FreeBSD ports, I'd be somewhat
  74  * surprised if bzero() wasn't substantially as efficient as
  75  * any tricks like this. It might make sense to benchmark it
  76  * and simplify if the difference isn't too large. */
  77 extern void os_zero(os_vm_address_t addr, os_vm_size_t length);
  78
  79 /* It looks as though this function allocates 'len' bytes at 'addr',
  80  * or at an OS-chosen address if 'addr' is zero.
  81  *
  82  * FIXME: There was some documentation for these functions in
  83  * "hp-ux.c" in the old CMU CL code. Perhaps move/merge it in here. */
  84 extern os_vm_address_t os_validate(os_vm_address_t addr, os_vm_size_t len);
  85
  86 /* This function seems to undo the effect of os_validate(..). */
  87 extern void os_invalidate(os_vm_address_t addr, os_vm_size_t len);
  88
  89 /* This maps a file into memory, or calls lose(..) for various
  90  * failures. */
  91 extern os_vm_address_t os_map(int fd,
  92                               int offset,
  93                               os_vm_address_t addr,
  94                               os_vm_size_t len);
  95
  96 /* This presumably flushes the instruction cache, if that can be done
  97  * explicitly. (It doesn't seem to be an issue for the i386 port,
  98  * which is all that exists for SBCL. It might be important for some
  99  * other architecture which CMU CL has been ported to, though. */
 100 extern void os_flush_icache(os_vm_address_t addr, os_vm_size_t len);
 101
 102 /* This sets access rights for an area of memory, e.g.
 103  * write-protecting a page so that the garbage collector can find out
 104  * whether it's modified by handling the signal. */
 105 extern void os_protect(os_vm_address_t addr,
 106                        os_vm_size_t len,
 107                        os_vm_prot_t protection);
 108
 109 /* This returns true for an address which makes sense at the Lisp level. */
 110 extern boolean is_valid_lisp_addr(os_vm_address_t test);
 111
 112 /* Given a signal context, return the address for storage of the
 113  * register, of the specified offset, for that context. The offset is
 114  * defined in the storage class (SC) defined in the Lisp virtual
 115  * machine (i.e. the file "vm.lisp" for the appropriate architecture). */
 116 int *os_context_register_addr(os_context_t *context, int offset);
 117
 118 /* Given a signal context, return the address for storage of the
 119  * program counter for that context. */
 120 int *os_context_pc_addr(os_context_t *context);
 121
 122 /* Given a signal context, return the address for storage of the
 123  * system stack pointer for that context. */
 124 int *os_context_sp_addr(os_context_t *context);
 125
 126 /* Given a signal context, return the address for storage of the
 127  * signal mask for that context. */
 128 sigset_t *os_context_sigmask_addr(os_context_t *context);
 129
 130 /* (Note that there may be other accessors for os_context_t which
 131  * depend not only on the OS, but also on the architecture, e.g.
 132  * getting at EFL/EFLAGS on the x86. Such things are defined in the
 133  * architecture-dependence files, not the OS-dependence files.) */
 134
 135 /* These are not architecture-specific functions, but are instead
 136  * general utilities defined in terms of the architecture-specific
 137  * function os_validate(..) and os_invalidate(..).
 138  *
 139  * FIXME: os_reallocate(..) is complicated and seems no longer to be
 140  * used for anything. Perhaps we could delete it? */
 141 extern os_vm_address_t os_allocate(os_vm_size_t len);
 142 extern os_vm_address_t os_allocate_at(os_vm_address_t addr, os_vm_size_t len);
 143 extern os_vm_address_t os_reallocate(os_vm_address_t addr,
 144                                      os_vm_size_t old_len,
 145                                      os_vm_size_t len);
 146 extern void os_deallocate(os_vm_address_t addr, os_vm_size_t len);
 147
 148
 149 /* FIXME: The os_trunc_foo(..) and os_round_foo(..) macros here could
 150  * be functions. */
 151
 152 #define os_trunc_to_page(addr) \
 153     (os_vm_address_t)(((long)(addr))&~(os_vm_page_size-1))
 154 #define os_round_up_to_page(addr) \
 155     os_trunc_to_page((addr)+(os_vm_page_size-1))
 156
 157 #define os_trunc_size_to_page(size) \
 158     (os_vm_size_t)(((long)(size))&~(os_vm_page_size-1))
 159 #define os_round_up_size_to_page(size) \
 160     os_trunc_size_to_page((size)+(os_vm_page_size-1))
 161
 162 /* KLUDGE: The errno error reporting system is an ugly nonreentrant
 163  * botch which nonetheless wasn't too painful in the old days.
 164  * However, it's obviously not good for multithreaded programs, and n
 165  * order to accommodate multithreading while retaining the C-level
 166  * syntax of the old UNIX interface, errno has now been changed from a
 167  * true variable to a preprocessor definition which is too hairy for
 168  * us to try to unscrew in Lisp code. Instead, Lisp code calls this
 169  * service routine to do whatever hackery is necessary in C code, and
 170  * to return the value in a way that Lisp can understand. */
 171 int os_get_errno(void);
 172
 173 #endif