ghc/compiler/main/Constants.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[Constants]{Info about this compilation}
   5
   6 \begin{code}
   7 module Constants (
   8         mAX_CONTEXT_REDUCTION_DEPTH,
   9         mAX_TUPLE_SIZE,
  10
  11         mAX_SPEC_THUNK_SIZE,
  12         mAX_SPEC_FUN_SIZE,
  13         mAX_SPEC_CONSTR_SIZE,
  14         mAX_SPEC_SELECTEE_SIZE,
  15         mAX_SPEC_AP_SIZE,
  16
  17         mIN_UPD_SIZE,
  18         mIN_SIZE_NonUpdHeapObject,
  19
  20         sTD_HDR_SIZE,
  21         pROF_HDR_SIZE,
  22         gRAN_HDR_SIZE,
  23         aRR_WORDS_HDR_SIZE,
  24         aRR_PTRS_HDR_SIZE,
  25         rESERVED_C_STACK_BYTES,
  26         rESERVED_STACK_WORDS,
  27
  28         sTD_ITBL_SIZE,
  29         rET_ITBL_SIZE,
  30         pROF_ITBL_SIZE,
  31         gRAN_ITBL_SIZE,
  32         tICKY_ITBL_SIZE,
  33
  34         mAX_FAMILY_SIZE_FOR_VEC_RETURNS,
  35
  36         uF_SIZE,
  37         pROF_UF_SIZE,
  38         gRAN_UF_SIZE,  -- HWL
  39         uF_RET,
  40         uF_UPDATEE,
  41
  42         mAX_Vanilla_REG,
  43         mAX_Float_REG,
  44         mAX_Double_REG,
  45         mAX_Long_REG,
  46
  47         mAX_Real_Vanilla_REG,
  48         mAX_Real_Float_REG,
  49         mAX_Real_Double_REG,
  50         mAX_Real_Long_REG,
  51
  52         oTHER_TAG,
  53
  54         mAX_INTLIKE, mIN_INTLIKE,
  55         mAX_CHARLIKE, mIN_CHARLIKE,
  56
  57         spRelToInt,
  58
  59         dOUBLE_SIZE,
  60         iNT64_SIZE,
  61         wORD64_SIZE,
  62
  63         wORD_SIZE,
  64         wORD_SIZE_IN_BITS,
  65
  66         bLOCK_SIZE,
  67         bLOCK_SIZE_W,
  68
  69         bITMAP_BITS_SHIFT,
  70     ) where
  71
  72 -- This magical #include brings in all the everybody-knows-these magic
  73 -- constants unfortunately, we need to be *explicit* about which one
  74 -- we want; if we just hope a -I... will get the right one, we could
  75 -- be in trouble.
  76
  77 #include "HsVersions.h"
  78 #include "../includes/config.h"
  79 #include "../includes/MachRegs.h"
  80 #include "../includes/Constants.h"
  81 #include "../includes/MachDeps.h"
  82 #include "../includes/DerivedConstants.h"
  83
  84 -- import Util
  85 \end{code}
  86
  87 All pretty arbitrary:
  88
  89 \begin{code}
  90 mAX_TUPLE_SIZE = (62 :: Int)    -- Should really match the number
  91                                 -- of decls in Data.Tuple
  92 mAX_CONTEXT_REDUCTION_DEPTH = (20 :: Int)
  93 \end{code}
  94
  95
  96 \begin{code}
  97 -- specialised fun/thunk/constr closure types
  98 mAX_SPEC_THUNK_SIZE   = (MAX_SPEC_THUNK_SIZE :: Int)
  99 mAX_SPEC_FUN_SIZE     = (MAX_SPEC_FUN_SIZE :: Int)
 100 mAX_SPEC_CONSTR_SIZE  = (MAX_SPEC_CONSTR_SIZE :: Int)
 101
 102 -- pre-compiled thunk types
 103 mAX_SPEC_SELECTEE_SIZE  = (MAX_SPEC_SELECTEE_SIZE :: Int)
 104 mAX_SPEC_AP_SIZE        = (MAX_SPEC_AP_SIZE :: Int)
 105
 106 -- closure sizes: these do NOT include the header (see below for header sizes)
 107 mIN_UPD_SIZE                    = (MIN_UPD_SIZE::Int)
 108 mIN_SIZE_NonUpdHeapObject       = (MIN_NONUPD_SIZE::Int)
 109 \end{code}
 110
 111 Constants for semi-tagging; the tags associated with the data
 112 constructors will start at 0 and go up.
 113
 114 \begin{code}
 115 oTHER_TAG = (INFO_OTHER_TAG :: Integer) -- (-1) unevaluated, probably
 116 \end{code}
 117
 118 \begin{code}
 119 mIN_INTLIKE, mAX_INTLIKE :: Integer     -- Only used to compare with (MachInt Integer)
 120 mIN_INTLIKE = MIN_INTLIKE
 121 mAX_INTLIKE = MAX_INTLIKE
 122
 123 mIN_CHARLIKE, mAX_CHARLIKE :: Int       -- Only used to compare with (MachChar Int)
 124 mIN_CHARLIKE = MIN_CHARLIKE
 125 mAX_CHARLIKE = MAX_CHARLIKE
 126 \end{code}
 127
 128 A little function that abstracts the stack direction.  Note that most
 129 of the code generator is dependent on the stack direction anyway, so
 130 changing this on its own spells certain doom.  ToDo: remove?
 131
 132 \begin{code}
 133 -- THIS IS DIRECTION SENSITIVE!
 134
 135 -- stack grows down, positive virtual offsets correspond to negative
 136 -- additions to the stack pointer.
 137
 138 spRelToInt :: Int{-VirtualSpOffset-} -> Int{-VirtualSpOffset-} -> Int
 139 spRelToInt sp off = sp - off
 140 \end{code}
 141
 142 A section of code-generator-related MAGIC CONSTANTS.
 143
 144 \begin{code}
 145 mAX_FAMILY_SIZE_FOR_VEC_RETURNS = (MAX_VECTORED_RTN::Int)  -- pretty arbitrary
 146 -- If you change this, you may need to change runtimes/standard/Update.lhc
 147
 148 -- The update frame sizes
 149 uF_SIZE = (STD_UF_SIZE::Int)
 150
 151 -- Same again, with profiling
 152 pROF_UF_SIZE = (PROF_UF_SIZE::Int)
 153
 154 -- Same again, with gransim
 155 gRAN_UF_SIZE = (GRAN_UF_SIZE::Int)
 156
 157 -- Offsets in an update frame.  They don't change with profiling!
 158 uF_RET         = (UF_RET::Int)
 159 uF_UPDATEE     = (UF_UPDATEE::Int)
 160 \end{code}
 161
 162 \begin{code}
 163 mAX_Vanilla_REG = (MAX_VANILLA_REG :: Int)
 164 mAX_Float_REG   = (MAX_FLOAT_REG :: Int)
 165 mAX_Double_REG  = (MAX_DOUBLE_REG :: Int)
 166 mAX_Long_REG    = (MAX_LONG_REG  :: Int)
 167
 168 mAX_Real_Vanilla_REG    = (MAX_REAL_VANILLA_REG :: Int)
 169 mAX_Real_Float_REG      = (MAX_REAL_FLOAT_REG :: Int)
 170 mAX_Real_Double_REG     = (MAX_REAL_DOUBLE_REG :: Int)
 171 #ifdef MAX_REAL_LONG_REG
 172 mAX_Real_Long_REG       = (MAX_REAL_LONG_REG :: Int)
 173 #else
 174 mAX_Real_Long_REG       = (0::Int)
 175 #endif
 176 \end{code}
 177
 178 Closure header sizes.
 179
 180 \begin{code}
 181 sTD_HDR_SIZE       = (STD_HDR_SIZE       :: Int)
 182 pROF_HDR_SIZE      = (PROF_HDR_SIZE      :: Int)
 183 gRAN_HDR_SIZE      = (GRAN_HDR_SIZE      :: Int)
 184 aRR_WORDS_HDR_SIZE = (ARR_WORDS_HDR_SIZE :: Int)
 185 aRR_PTRS_HDR_SIZE  = (ARR_PTRS_HDR_SIZE  :: Int)
 186 \end{code}
 187
 188 Info Table sizes.
 189
 190 \begin{code}
 191 sTD_ITBL_SIZE   = (STD_ITBL_SIZE   :: Int)
 192 rET_ITBL_SIZE   = (RET_ITBL_SIZE   :: Int)
 193 pROF_ITBL_SIZE  = (PROF_ITBL_SIZE  :: Int)
 194 gRAN_ITBL_SIZE  = (GRAN_ITBL_SIZE  :: Int)
 195 tICKY_ITBL_SIZE = (TICKY_ITBL_SIZE :: Int)
 196 \end{code}
 197
 198 Size of a double in StgWords.
 199
 200 \begin{code}
 201 dOUBLE_SIZE     = (SIZEOF_DOUBLE `quot` SIZEOF_HSWORD :: Int)
 202 wORD64_SIZE     = (8 `quot` SIZEOF_HSWORD :: Int)
 203 iNT64_SIZE      = wORD64_SIZE
 204 \end{code}
 205
 206 This tells the native code generator the size of the spill
 207 area is has available.
 208
 209 \begin{code}
 210 rESERVED_C_STACK_BYTES = (RESERVED_C_STACK_BYTES :: Int)
 211 \end{code}
 212
 213 The amount of (Haskell) stack to leave free for saving registers when
 214 returning to the scheduler.
 215
 216 \begin{code}
 217 rESERVED_STACK_WORDS = (RESERVED_STACK_WORDS :: Int)
 218 \end{code}
 219
 220 Size of a word, in bytes
 221
 222 \begin{code}
 223 wORD_SIZE = (SIZEOF_HSWORD :: Int)
 224 wORD_SIZE_IN_BITS = wORD_SIZE * 8 :: Int
 225 \end{code}
 226
 227 Size of a storage manager block (in bytes).
 228
 229 \begin{code}
 230 bLOCK_SIZE = (BLOCK_SIZE :: Int)
 231 bLOCK_SIZE_W = (bLOCK_SIZE `div` wORD_SIZE :: Int)
 232 \end{code}
 233
 234 Number of bits to shift a bitfield left by in an info table.
 235
 236 \begin{code}
 237 bITMAP_BITS_SHIFT = (BITMAP_BITS_SHIFT :: Int)
 238 \end{code}