0f9f49286a00a91c6c6f58b28d52a27ec9054fdc
[ghc-hetmet.git] / 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 (module Constants) where
8
9 -- This magical #include brings in all the everybody-knows-these magic
10 -- constants unfortunately, we need to be *explicit* about which one
11 -- we want; if we just hope a -I... will get the right one, we could
12 -- be in trouble.
13
14 #include "HsVersions.h"
15 #include "../includes/MachRegs.h"
16 #include "../includes/Constants.h"
17 #include "../includes/MachDeps.h"
18 #include "../includes/DerivedConstants.h"
19
20 -- import Util
21 \end{code}
22
23 All pretty arbitrary:
24
25 \begin{code}
26 mAX_TUPLE_SIZE = (62 :: Int)    -- Should really match the number
27                                 -- of decls in Data.Tuple
28 mAX_CONTEXT_REDUCTION_DEPTH = (20 :: Int)
29 \end{code}
30
31
32 \begin{code}
33 -- specialised fun/thunk/constr closure types
34 mAX_SPEC_THUNK_SIZE   = (MAX_SPEC_THUNK_SIZE :: Int)
35 mAX_SPEC_FUN_SIZE     = (MAX_SPEC_FUN_SIZE :: Int)
36 mAX_SPEC_CONSTR_SIZE  = (MAX_SPEC_CONSTR_SIZE :: Int)
37
38 -- pre-compiled thunk types
39 mAX_SPEC_SELECTEE_SIZE  = (MAX_SPEC_SELECTEE_SIZE :: Int)
40 mAX_SPEC_AP_SIZE        = (MAX_SPEC_AP_SIZE :: Int)
41
42 -- closure sizes: these do NOT include the header (see below for header sizes)
43 mIN_UPD_SIZE                    = (MIN_UPD_SIZE::Int)
44 mIN_SIZE_NonUpdHeapObject       = (MIN_NONUPD_SIZE::Int)
45 \end{code}
46
47 \begin{code}
48 mIN_INTLIKE, mAX_INTLIKE :: Int 
49 mIN_INTLIKE = MIN_INTLIKE
50 mAX_INTLIKE = MAX_INTLIKE
51
52 mIN_CHARLIKE, mAX_CHARLIKE :: Int
53 mIN_CHARLIKE = MIN_CHARLIKE
54 mAX_CHARLIKE = MAX_CHARLIKE
55 \end{code}
56
57 A section of code-generator-related MAGIC CONSTANTS.
58
59 \begin{code}
60 mAX_FAMILY_SIZE_FOR_VEC_RETURNS = (MAX_VECTORED_RTN::Int)  -- pretty arbitrary
61 -- If you change this, you may need to change runtimes/standard/Update.lhc
62 \end{code}
63
64 \begin{code}
65 mAX_Vanilla_REG = (MAX_VANILLA_REG :: Int)
66 mAX_Float_REG   = (MAX_FLOAT_REG :: Int)
67 mAX_Double_REG  = (MAX_DOUBLE_REG :: Int)
68 mAX_Long_REG    = (MAX_LONG_REG  :: Int)
69
70 mAX_Real_Vanilla_REG    = (MAX_REAL_VANILLA_REG :: Int)
71 mAX_Real_Float_REG      = (MAX_REAL_FLOAT_REG :: Int)
72 mAX_Real_Double_REG     = (MAX_REAL_DOUBLE_REG :: Int)
73 #ifdef MAX_REAL_LONG_REG
74 mAX_Real_Long_REG       = (MAX_REAL_LONG_REG :: Int)
75 #else
76 mAX_Real_Long_REG       = (0::Int)
77 #endif
78 \end{code}
79
80 Closure header sizes.
81
82 \begin{code}
83 sTD_HDR_SIZE       = (STD_HDR_SIZE       :: Int)
84 pROF_HDR_SIZE      = (PROF_HDR_SIZE      :: Int)
85 gRAN_HDR_SIZE      = (GRAN_HDR_SIZE      :: Int)
86 \end{code}
87
88 Info Table sizes.
89
90 \begin{code}
91 sTD_ITBL_SIZE   = (STD_ITBL_SIZE   :: Int)
92 rET_ITBL_SIZE   = (RET_ITBL_SIZE   :: Int)
93 pROF_ITBL_SIZE  = (PROF_ITBL_SIZE  :: Int)
94 gRAN_ITBL_SIZE  = (GRAN_ITBL_SIZE  :: Int)
95 tICKY_ITBL_SIZE = (TICKY_ITBL_SIZE :: Int)
96 \end{code}
97
98 Size of a double in StgWords.
99
100 \begin{code}
101 dOUBLE_SIZE     = SIZEOF_DOUBLE :: Int
102 wORD64_SIZE     = 8 :: Int
103 iNT64_SIZE      = wORD64_SIZE
104 \end{code}
105
106 This tells the native code generator the size of the spill
107 area is has available.
108
109 \begin{code}
110 rESERVED_C_STACK_BYTES = (RESERVED_C_STACK_BYTES :: Int)
111 \end{code}
112
113 The amount of (Haskell) stack to leave free for saving registers when
114 returning to the scheduler.
115
116 \begin{code}
117 rESERVED_STACK_WORDS = (RESERVED_STACK_WORDS :: Int)
118 \end{code}
119
120 Size of a word, in bytes
121
122 \begin{code}
123 wORD_SIZE = (SIZEOF_HSWORD :: Int)
124 wORD_SIZE_IN_BITS = wORD_SIZE * 8 :: Int
125 \end{code}
126
127 Size of a C int, in bytes. May be smaller than wORD_SIZE.
128
129 \begin{code}
130 cINT_SIZE = (SIZEOF_INT :: Int)
131 \end{code}
132
133 Size of a storage manager block (in bytes).
134
135 \begin{code}
136 bLOCK_SIZE = (BLOCK_SIZE :: Int)
137 bLOCK_SIZE_W = (bLOCK_SIZE `quot` wORD_SIZE :: Int)
138 \end{code}
139
140 Number of bits to shift a bitfield left by in an info table.
141
142 \begin{code}
143 bITMAP_BITS_SHIFT = (BITMAP_BITS_SHIFT :: Int)
144 \end{code}
145
146 Constants derived from headers in ghc/includes, generated by the program
147 ../includes/mkDerivedConstants.c.
148
149 \begin{code}
150 #include "../includes/GHCConstants.h"
151 \end{code}