Migrate cvs diff from fptools-assoc branch
[ghc-hetmet.git] / 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_PAYLOAD_SIZE        = (MIN_PAYLOAD_SIZE::Int)
44 \end{code}
45
46 \begin{code}
47 mIN_INTLIKE, mAX_INTLIKE :: Int 
48 mIN_INTLIKE = MIN_INTLIKE
49 mAX_INTLIKE = MAX_INTLIKE
50
51 mIN_CHARLIKE, mAX_CHARLIKE :: Int
52 mIN_CHARLIKE = MIN_CHARLIKE
53 mAX_CHARLIKE = MAX_CHARLIKE
54 \end{code}
55
56 A section of code-generator-related MAGIC CONSTANTS.
57
58 \begin{code}
59 mAX_FAMILY_SIZE_FOR_VEC_RETURNS = (MAX_VECTORED_RTN::Int)  -- pretty arbitrary
60 -- If you change this, you may need to change runtimes/standard/Update.lhc
61 \end{code}
62
63 \begin{code}
64 mAX_Vanilla_REG = (MAX_VANILLA_REG :: Int)
65 mAX_Float_REG   = (MAX_FLOAT_REG :: Int)
66 mAX_Double_REG  = (MAX_DOUBLE_REG :: Int)
67 mAX_Long_REG    = (MAX_LONG_REG  :: Int)
68
69 mAX_Real_Vanilla_REG    = (MAX_REAL_VANILLA_REG :: Int)
70 mAX_Real_Float_REG      = (MAX_REAL_FLOAT_REG :: Int)
71 mAX_Real_Double_REG     = (MAX_REAL_DOUBLE_REG :: Int)
72 #ifdef MAX_REAL_LONG_REG
73 mAX_Real_Long_REG       = (MAX_REAL_LONG_REG :: Int)
74 #else
75 mAX_Real_Long_REG       = (0::Int)
76 #endif
77 \end{code}
78
79 Closure header sizes.
80
81 \begin{code}
82 sTD_HDR_SIZE       = (STD_HDR_SIZE       :: Int)
83 pROF_HDR_SIZE      = (PROF_HDR_SIZE      :: Int)
84 gRAN_HDR_SIZE      = (GRAN_HDR_SIZE      :: Int)
85 \end{code}
86
87 Info Table sizes.
88
89 \begin{code}
90 sTD_ITBL_SIZE   = (STD_ITBL_SIZE   :: Int)
91 rET_ITBL_SIZE   = (RET_ITBL_SIZE   :: Int)
92 pROF_ITBL_SIZE  = (PROF_ITBL_SIZE  :: Int)
93 gRAN_ITBL_SIZE  = (GRAN_ITBL_SIZE  :: Int)
94 tICKY_ITBL_SIZE = (TICKY_ITBL_SIZE :: Int)
95 \end{code}
96
97 Size of a double in StgWords.
98
99 \begin{code}
100 dOUBLE_SIZE     = SIZEOF_DOUBLE :: Int
101 wORD64_SIZE     = 8 :: Int
102 iNT64_SIZE      = wORD64_SIZE
103 \end{code}
104
105 This tells the native code generator the size of the spill
106 area is has available.
107
108 \begin{code}
109 rESERVED_C_STACK_BYTES = (RESERVED_C_STACK_BYTES :: Int)
110 \end{code}
111
112 The amount of (Haskell) stack to leave free for saving registers when
113 returning to the scheduler.
114
115 \begin{code}
116 rESERVED_STACK_WORDS = (RESERVED_STACK_WORDS :: Int)
117 \end{code}
118
119 Size of a word, in bytes
120
121 \begin{code}
122 wORD_SIZE = (SIZEOF_HSWORD :: Int)
123 wORD_SIZE_IN_BITS = wORD_SIZE * 8 :: Int
124 \end{code}
125
126 Size of a C int, in bytes. May be smaller than wORD_SIZE.
127
128 \begin{code}
129 cINT_SIZE = (SIZEOF_INT :: Int)
130 \end{code}
131
132 Size of a storage manager block (in bytes).
133
134 \begin{code}
135 bLOCK_SIZE = (BLOCK_SIZE :: Int)
136 bLOCK_SIZE_W = (bLOCK_SIZE `quot` wORD_SIZE :: Int)
137 \end{code}
138
139 Number of bits to shift a bitfield left by in an info table.
140
141 \begin{code}
142 bITMAP_BITS_SHIFT = (BITMAP_BITS_SHIFT :: Int)
143 \end{code}
144
145 Constants derived from headers in ghc/includes, generated by the program
146 ../includes/mkDerivedConstants.c.
147
148 \begin{code}
149 #include "../includes/GHCConstants.h"
150 \end{code}