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
  42 #ifdef LISP_FEATURE_STACK_GROWS_DOWNWARD_NOT_UPWARD
  43
  44 #define CONTROL_STACK_HARD_GUARD_PAGE(th) \
  45     ((os_vm_address_t)(th->control_stack_start))
  46 #define CONTROL_STACK_GUARD_PAGE(th) \
  47     (CONTROL_STACK_HARD_GUARD_PAGE(th) + os_vm_page_size)
  48 #define CONTROL_STACK_RETURN_GUARD_PAGE(th) \
  49     (CONTROL_STACK_GUARD_PAGE(th) + os_vm_page_size)
  50 #else
  51
  52 #define CONTROL_STACK_HARD_GUARD_PAGE(th) \
  53     (((os_vm_address_t)(th->control_stack_end)) - os_vm_page_size)
  54 #define CONTROL_STACK_GUARD_PAGE(th) \
  55     (CONTROL_STACK_HARD_GUARD_PAGE(th) - os_vm_page_size)
  56 #define CONTROL_STACK_RETURN_GUARD_PAGE(th) \
  57     (CONTROL_STACK_GUARD_PAGE(th) - os_vm_page_size)
  58
  59 #endif
  60
  61 #ifdef ALIEN_STACK_GROWS_DOWNWARD
  62
  63 #define ALIEN_STACK_HARD_GUARD_PAGE(th)         \
  64     ((os_vm_address_t)(th->alien_stack_start))
  65 #define ALIEN_STACK_GUARD_PAGE(th) \
  66     (ALIEN_STACK_HARD_GUARD_PAGE(th) + os_vm_page_size)
  67 #define ALIEN_STACK_RETURN_GUARD_PAGE(th) \
  68     (ALIEN_STACK_GUARD_PAGE(th) + os_vm_page_size)
  69
  70 #elif ALIEN_STACK_GROWS_UPWARD
  71
  72 #define ALIEN_STACK_HARD_GUARD_PAGE(th)                            \
  73     (((os_vm_address_t)th->alien_stack_start) + ALIEN_STACK_SIZE - \
  74      os_vm_page_size)
  75 #define ALIEN_STACK_GUARD_PAGE(th) \
  76     (ALIEN_STACK_HARD_GUARD_PAGE(th) - os_vm_page_size)
  77 #define ALIEN_STACK_RETURN_GUARD_PAGE(th) \
  78     (ALIEN_STACK_GUARD_PAGE(th) - os_vm_page_size)
  79
  80 #else
  81 #error ALIEN_STACK_GROWS_DOWNWARD or ALIEN_STACK_GROWS_UPWARD has to be defined
  82 #endif
  83
  84 #define BINDING_STACK_HARD_GUARD_PAGE(th)                              \
  85     (((os_vm_address_t)th->binding_stack_start) + BINDING_STACK_SIZE - \
  86      os_vm_page_size)
  87 #define BINDING_STACK_GUARD_PAGE(th) \
  88     (BINDING_STACK_HARD_GUARD_PAGE(th) - os_vm_page_size)
  89 #define BINDING_STACK_RETURN_GUARD_PAGE(th) \
  90     (BINDING_STACK_GUARD_PAGE(th) - os_vm_page_size)
  91
  92 extern void validate(void);
  93
  94 extern void
  95 protect_control_stack_hard_guard_page(int protect_p, struct thread *thread);
  96 extern void
  97 protect_control_stack_guard_page(int protect_p, struct thread *thread);
  98 extern void
  99 protect_control_stack_return_guard_page(int protect_p, struct thread *thread);
 100 extern void
 101 protect_binding_stack_hard_guard_page(int protect_p, struct thread *thread);
 102 extern void
 103 protect_binding_stack_guard_page(int protect_p, struct thread *thread);
 104 extern void
 105 protect_binding_stack_return_guard_page(int protect_p, struct thread *thread);
 106 extern void
 107 protect_alien_stack_hard_guard_page(int protect_p, struct thread *thread);
 108 extern void
 109 protect_alien_stack_guard_page(int protect_p, struct thread *thread);
 110 extern void
 111 protect_alien_stack_return_guard_page(int protect_p, struct thread *thread);
 112 extern os_vm_address_t undefined_alien_address;
 113 #endif
 114
 115 /* note for anyone trying to port an architecture's support files
 116  * from CMU CL to SBCL:
 117  *
 118  * CMU CL had architecture-dependent header files included here to
 119  * define memory map data:
 120  *   #ifdef LISP_FEATURE_X86
 121  *   #include "x86-validate.h"
 122  *   #endif
 123  * and so forth. In SBCL, the memory map data are defined at the Lisp
 124  * level (compiler/target/parms.lisp) and stuffed into the sbcl.h file
 125  * created by GENESIS, so there's no longer a need for an
 126  * architecture-dependent header file of memory map data.
 127  */
 128
 129 #endif