1.0.25.50: detect binding and alien stack exhaustion
[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 #define CONTROL_STACK_GUARD_PAGE(th) \
43     ((os_vm_address_t)(th->control_stack_start))
44 #define CONTROL_STACK_RETURN_GUARD_PAGE(th) \
45     (CONTROL_STACK_GUARD_PAGE(th) + os_vm_page_size)
46 #define ALIEN_STACK_GUARD_PAGE(th) \
47     ((os_vm_address_t)(th->alien_stack_start))
48 #define ALIEN_STACK_RETURN_GUARD_PAGE(th) \
49     (ALIEN_STACK_GUARD_PAGE(th) + os_vm_page_size)
50 #else
51 #define CONTROL_STACK_GUARD_PAGE(th) \
52     (((os_vm_address_t)(th->control_stack_end)) - os_vm_page_size)
53 #define CONTROL_STACK_RETURN_GUARD_PAGE(th) \
54     (CONTROL_STACK_GUARD_PAGE(th) - os_vm_page_size)
55 #define ALIEN_STACK_GUARD_PAGE(th)                                 \
56     (((os_vm_address_t)th->alien_stack_start) + ALIEN_STACK_SIZE - \
57      os_vm_page_size)
58 #define ALIEN_STACK_RETURN_GUARD_PAGE(th) \
59     (ALIEN_STACK_GUARD_PAGE(th) - os_vm_page_size)
60 #endif
61
62 #define BINDING_STACK_GUARD_PAGE(th)                                   \
63     (((os_vm_address_t)th->binding_stack_start) + BINDING_STACK_SIZE - \
64      os_vm_page_size)
65 #define BINDING_STACK_RETURN_GUARD_PAGE(th) \
66     (BINDING_STACK_GUARD_PAGE(th) - os_vm_page_size)
67
68 extern void validate(void);
69
70 extern void
71 protect_control_stack_guard_page(int protect_p, struct thread *thread);
72 extern void
73 protect_control_stack_return_guard_page(int protect_p, struct thread *thread);
74 extern void
75 protect_binding_stack_guard_page(int protect_p, struct thread *thread);
76 extern void
77 protect_binding_stack_return_guard_page(int protect_p, struct thread *thread);
78 extern void
79 protect_alien_stack_guard_page(int protect_p, struct thread *thread);
80 extern void
81 protect_alien_stack_return_guard_page(int protect_p, struct thread *thread);
82 extern os_vm_address_t undefined_alien_address;
83 #endif
84
85 /* note for anyone trying to port an architecture's support files
86  * from CMU CL to SBCL:
87  *
88  * CMU CL had architecture-dependent header files included here to
89  * define memory map data:
90  *   #ifdef LISP_FEATURE_X86
91  *   #include "x86-validate.h"
92  *   #endif
93  * and so forth. In SBCL, the memory map data are defined at the Lisp
94  * level (compiler/target/parms.lisp) and stuffed into the sbcl.h file
95  * created by GENESIS, so there's no longer a need for an
96  * architecture-dependent header file of memory map data.
97  */
98
99 #endif