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