improve the SB-EXT:GC docstring(s)
[sbcl.git] / src / runtime / validate.h
1 /*
2  * This software is part of the SBCL system. See the README file for
3  * more information.
4  *
5  * This software is derived from the CMU CL system, which was
6  * written at Carnegie Mellon University and released into the
7  * public domain. The software is in the public domain and is
8  * provided with absolutely no warranty. See the COPYING and CREDITS
9  * files for more information.
10  */
11
12 #if !defined(_INCLUDE_VALIDATE_H_)
13 #define _INCLUDE_VALIDATE_H_
14
15 #ifndef LISP_FEATURE_GENCGC
16 /* FIXME: genesis/constants.h also defines this with a constant value */
17 #define DYNAMIC_SPACE_START current_dynamic_space
18 #endif
19
20 #define BINDING_STACK_SIZE (1024*1024)   /* chosen at random */
21 #define ALIEN_STACK_SIZE (1024*1024)     /* chosen at random */
22
23 /* eventually choosable per-thread: */
24 #define DEFAULT_CONTROL_STACK_SIZE (2*1024*1024)
25
26 /* constants derived from the fundamental constants in passed by GENESIS */
27 #ifdef LISP_FEATURE_GENCGC
28 #define DEFAULT_DYNAMIC_SPACE_SIZE (DYNAMIC_SPACE_END - DYNAMIC_SPACE_START)
29 #else
30 #define DEFAULT_DYNAMIC_SPACE_SIZE (DYNAMIC_0_SPACE_END - DYNAMIC_0_SPACE_START)
31 #endif
32 #define READ_ONLY_SPACE_SIZE (READ_ONLY_SPACE_END - READ_ONLY_SPACE_START)
33 #define STATIC_SPACE_SIZE (STATIC_SPACE_END - STATIC_SPACE_START)
34 #ifdef LISP_FEATURE_LINKAGE_TABLE
35 #define LINKAGE_TABLE_SPACE_SIZE \
36     (LINKAGE_TABLE_SPACE_END - LINKAGE_TABLE_SPACE_START)
37 #endif
38
39 #if !defined(LANGUAGE_ASSEMBLY)
40 #include <thread.h>
41 #ifdef LISP_FEATURE_STACK_GROWS_DOWNWARD_NOT_UPWARD
42
43 #define CONTROL_STACK_HARD_GUARD_PAGE(th) \
44     ((os_vm_address_t)(th->control_stack_start))
45 #define CONTROL_STACK_GUARD_PAGE(th) \
46     (CONTROL_STACK_HARD_GUARD_PAGE(th) + os_vm_page_size)
47 #define CONTROL_STACK_RETURN_GUARD_PAGE(th) \
48     (CONTROL_STACK_GUARD_PAGE(th) + os_vm_page_size)
49
50 #define ALIEN_STACK_HARD_GUARD_PAGE(th) \
51     ((os_vm_address_t)(th->alien_stack_start))
52 #define ALIEN_STACK_GUARD_PAGE(th) \
53     (ALIEN_STACK_HARD_GUARD_PAGE(th) + os_vm_page_size)
54 #define ALIEN_STACK_RETURN_GUARD_PAGE(th) \
55     (ALIEN_STACK_GUARD_PAGE(th) + os_vm_page_size)
56
57 #else
58
59 #define CONTROL_STACK_HARD_GUARD_PAGE(th) \
60     (((os_vm_address_t)(th->control_stack_end)) - os_vm_page_size)
61 #define CONTROL_STACK_GUARD_PAGE(th) \
62     (CONTROL_STACK_HARD_GUARD_PAGE(th) - os_vm_page_size)
63 #define CONTROL_STACK_RETURN_GUARD_PAGE(th) \
64     (CONTROL_STACK_GUARD_PAGE(th) - os_vm_page_size)
65
66 #define ALIEN_STACK_HARD_GUARD_PAGE(th)                            \
67     (((os_vm_address_t)th->alien_stack_start) + ALIEN_STACK_SIZE - \
68      os_vm_page_size)
69 #define ALIEN_STACK_GUARD_PAGE(th) \
70     (ALIEN_STACK_HARD_GUARD_PAGE(th) - os_vm_page_size)
71 #define ALIEN_STACK_RETURN_GUARD_PAGE(th) \
72     (ALIEN_STACK_GUARD_PAGE(th) - os_vm_page_size)
73
74 #endif
75
76 #define BINDING_STACK_HARD_GUARD_PAGE(th)                              \
77     (((os_vm_address_t)th->binding_stack_start) + BINDING_STACK_SIZE - \
78      os_vm_page_size)
79 #define BINDING_STACK_GUARD_PAGE(th) \
80     (BINDING_STACK_HARD_GUARD_PAGE(th) - os_vm_page_size)
81 #define BINDING_STACK_RETURN_GUARD_PAGE(th) \
82     (BINDING_STACK_GUARD_PAGE(th) - os_vm_page_size)
83
84 extern void validate(void);
85
86 extern void
87 protect_control_stack_hard_guard_page(int protect_p, struct thread *thread);
88 extern void
89 protect_control_stack_guard_page(int protect_p, struct thread *thread);
90 extern void
91 protect_control_stack_return_guard_page(int protect_p, struct thread *thread);
92 extern void
93 protect_binding_stack_hard_guard_page(int protect_p, struct thread *thread);
94 extern void
95 protect_binding_stack_guard_page(int protect_p, struct thread *thread);
96 extern void
97 protect_binding_stack_return_guard_page(int protect_p, struct thread *thread);
98 extern void
99 protect_alien_stack_hard_guard_page(int protect_p, struct thread *thread);
100 extern void
101 protect_alien_stack_guard_page(int protect_p, struct thread *thread);
102 extern void
103 protect_alien_stack_return_guard_page(int protect_p, struct thread *thread);
104 extern os_vm_address_t undefined_alien_address;
105 #endif
106
107 /* note for anyone trying to port an architecture's support files
108  * from CMU CL to SBCL:
109  *
110  * CMU CL had architecture-dependent header files included here to
111  * define memory map data:
112  *   #ifdef LISP_FEATURE_X86
113  *   #include "x86-validate.h"
114  *   #endif
115  * and so forth. In SBCL, the memory map data are defined at the Lisp
116  * level (compiler/target/parms.lisp) and stuffed into the sbcl.h file
117  * created by GENESIS, so there's no longer a need for an
118  * architecture-dependent header file of memory map data.
119  */
120
121 #endif