Constants.h 10.1 KB
Newer Older
1
/* ----------------------------------------------------------------------------
2
 *
3
 * (c) The GHC Team, 1998-2009
4
5
6
 *
 * Constants
 *
7
8
9
10
11
12
13
 * NOTE: this information is used by both the compiler and the RTS.
 * Some of it is tweakable, and some of it must be kept up to date
 * with various other parts of the system.
 *
 * Constants which are derived automatically from other definitions in
 * the system (eg. structure sizes) are generated into the file
 * DerivedConstants.h by a C program (mkDerivedConstantsHdr).
14
 *
15
16
17
 * To understand the structure of the RTS headers, see the wiki:
 *   http://hackage.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
 *
18
19
 * -------------------------------------------------------------------------- */

Simon Marlow's avatar
Simon Marlow committed
20
21
#ifndef RTS_CONSTANTS_H
#define RTS_CONSTANTS_H
22
23
24
25

/* -----------------------------------------------------------------------------
   Minimum closure sizes

26
27
28
   This is the minimum number of words in the payload of a
   heap-allocated closure, so that the closure has enough room to be
   overwritten with a forwarding pointer during garbage collection.
29
30
   -------------------------------------------------------------------------- */

31
#define MIN_PAYLOAD_SIZE 1
32
33
34
35
36

/* -----------------------------------------------------------------------------
   Constants to do with specialised closure types.
   -------------------------------------------------------------------------- */

sof's avatar
sof committed
37
/* We have some pre-compiled selector thunks defined in rts/StgStdThunks.hc.
dterei's avatar
dterei committed
38
 * This constant defines the highest selectee index that we can replace with a
sof's avatar
sof committed
39
 * reference to the pre-compiled code.
40
41
42
43
44
45
46
 */

#define MAX_SPEC_SELECTEE_SIZE 15

/* Vector-apply thunks.  These thunks just push their free variables
 * on the stack and enter the first one.  They're a bit like PAPs, but
 * don't have a dynamic size.  We've pre-compiled a few to save
dterei's avatar
dterei committed
47
 * space.
48
49
 */

50
#define MAX_SPEC_AP_SIZE       7
51

52
53
54
55
56
57
/* Specialised FUN/THUNK/CONSTR closure types */

#define MAX_SPEC_THUNK_SIZE    2
#define MAX_SPEC_FUN_SIZE      2
#define MAX_SPEC_CONSTR_SIZE   2

dterei's avatar
dterei committed
58
59
/* Range of built-in table of static small int-like and char-like closures.
 *
60
61
62
 *   NB. This corresponds with the number of actual INTLIKE/CHARLIKE
 *   closures defined in rts/StgMiscClosures.cmm.
 */
dterei's avatar
dterei committed
63
64
#define MAX_INTLIKE             16
#define MIN_INTLIKE             (-16)
65

dterei's avatar
dterei committed
66
67
#define MAX_CHARLIKE            255
#define MIN_CHARLIKE            0
68

69
70
71
72
73
74
75
/* Each byte in the card table for an StgMutaArrPtrs covers
 * (1<<MUT_ARR_PTRS_CARD_BITS) elements in the array.  To find a good
 * value for this, I used the benchmarks nofib/gc/hash,
 * nofib/gc/graph, and nofib/gc/gc_bench.
 */
#define MUT_ARR_PTRS_CARD_BITS 7

76
77
78
79
80
81
82
/* -----------------------------------------------------------------------------
   STG Registers.

   Note that in MachRegs.h we define how many of these registers are
   *real* machine registers, and not just offsets in the Register Table.
   -------------------------------------------------------------------------- */

83
#define MAX_VANILLA_REG 10
84
85
#define MAX_FLOAT_REG   6
#define MAX_DOUBLE_REG  6
86
#define MAX_LONG_REG    1
gmainland's avatar
gmainland committed
87
#define MAX_XMM_REG     6
88
89
90
91
92
93
94
95

/* -----------------------------------------------------------------------------
   Semi-Tagging constants

   Old Comments about this stuff:

   Tags for indirection nodes and ``other'' (probably unevaluated) nodes;
   normal-form values of algebraic data types will have tags 0, 1, ...
dterei's avatar
dterei committed
96

97
98
99
100
101
102
   @INFO_IND_TAG@ is different from @INFO_OTHER_TAG@ just so we can count
   how often we bang into indirection nodes; that's all.  (WDP 95/11)

   ToDo: find out if we need any of this.
   -------------------------------------------------------------------------- */

dterei's avatar
dterei committed
103
104
105
#define INFO_OTHER_TAG          (-1)
#define INFO_IND_TAG            (-2)
#define INFO_FIRST_TAG          0
106
107
108

/* -----------------------------------------------------------------------------
   How much C stack to reserve for local temporaries when in the STG
sof's avatar
sof committed
109
   world.  Used in StgCRun.c.
110
111
   -------------------------------------------------------------------------- */

112
#define RESERVED_C_STACK_BYTES (2048 * SIZEOF_LONG)
113
114
115
116

/* -----------------------------------------------------------------------------
   How much Haskell stack space to reserve for the saving of registers
   etc. in the case of a stack/heap overflow.
dterei's avatar
dterei committed
117

118
119
   This must be large enough to accomodate the largest stack frame
   pushed in one of the heap check fragments in HeapStackCheck.hc
120
   (ie. currently the generic heap checks - 3 words for StgRetDyn,
dterei's avatar
dterei committed
121
   18 words for the saved registers, see StgMacros.h).
122
123
   -------------------------------------------------------------------------- */

124
#define RESERVED_STACK_WORDS 21
125

126
127
128
129
130
131
132
/* -----------------------------------------------------------------------------
   The limit on the size of the stack check performed when we enter an
   AP_STACK, in words.  See raiseAsync() and bug #1466.
   -------------------------------------------------------------------------- */

#define AP_STACK_SPLIM 1024

133
134
135
136
/* -----------------------------------------------------------------------------
   Storage manager constants
   -------------------------------------------------------------------------- */

137
/* The size of a block (2^BLOCK_SHIFT bytes) */
138
#define BLOCK_SHIFT  12
139

140
/* The size of a megablock (2^MBLOCK_SHIFT bytes) */
141
142
#define MBLOCK_SHIFT   20

143
144
145
/* -----------------------------------------------------------------------------
   Bitmap/size fields (used in info tables)
   -------------------------------------------------------------------------- */
146

147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/* In a 32-bit bitmap field, we use 5 bits for the size, and 27 bits
 * for the bitmap.  If the bitmap requires more than 27 bits, then we
 * store it in a separate array, and leave a pointer in the bitmap
 * field.  On a 64-bit machine, the sizes are extended accordingly.
 */
#if SIZEOF_VOID_P == 4
#define BITMAP_SIZE_MASK     0x1f
#define BITMAP_BITS_SHIFT    5
#elif SIZEOF_VOID_P == 8
#define BITMAP_SIZE_MASK     0x3f
#define BITMAP_BITS_SHIFT    6
#else
#error unknown SIZEOF_VOID_P
#endif

162
163
164
165
166
/* -----------------------------------------------------------------------------
   Lag/Drag/Void constants
   -------------------------------------------------------------------------- */

/*
dterei's avatar
dterei committed
167
168
  An LDV word is divided into 3 parts: state bits (LDV_STATE_MASK), creation
  time bits (LDV_CREATE_MASK), and last use time bits (LDV_LAST_MASK).
169
170
171
172
173
174
175
176
177
178
 */
#if SIZEOF_VOID_P == 8
#define LDV_SHIFT               30
#define LDV_STATE_MASK          0x1000000000000000
#define LDV_CREATE_MASK         0x0FFFFFFFC0000000
#define LDV_LAST_MASK           0x000000003FFFFFFF
#define LDV_STATE_CREATE        0x0000000000000000
#define LDV_STATE_USE           0x1000000000000000
#else
#define LDV_SHIFT               15
dterei's avatar
dterei committed
179
#define LDV_STATE_MASK          0x40000000
180
181
182
183
#define LDV_CREATE_MASK         0x3FFF8000
#define LDV_LAST_MASK           0x00007FFF
#define LDV_STATE_CREATE        0x00000000
#define LDV_STATE_USE           0x40000000
184
#endif /* SIZEOF_VOID_P */
185
186
187
188
189
190
191
192
193

/* -----------------------------------------------------------------------------
   TSO related constants
   -------------------------------------------------------------------------- */

/*
 * Constants for the what_next field of a TSO, which indicates how it
 * is to be run.
 */
dterei's avatar
dterei committed
194
195
196
#define ThreadRunGHC    1       /* return to address on top of stack */
#define ThreadInterpret 2       /* interpret this thread */
#define ThreadKilled    3       /* thread has died, don't run it */
197
#define ThreadComplete  4       /* thread has finished */
198
199
200

/*
 * Constants for the why_blocked field of a TSO
201
 * NB. keep these in sync with GHC/Conc.lhs: threadStatus
202
203
204
 */
#define NotBlocked          0
#define BlockedOnMVar       1
205
206
207
208
209
210
#define BlockedOnMVarRead   2
#define BlockedOnBlackHole  3
#define BlockedOnRead       4
#define BlockedOnWrite      5
#define BlockedOnDelay      6
#define BlockedOnSTM        7
211
212

/* Win32 only: */
213
#define BlockedOnDoProc     8
214
215
216

/* Only relevant for PAR: */
  /* blocked on a remote closure represented by a Global Address: */
217
#define BlockedOnGA         9
218
  /* same as above but without sending a Fetch message */
219
#define BlockedOnGA_NoSend  10
220
/* Only relevant for THREADED_RTS: */
221
222
#define BlockedOnCCall      11
#define BlockedOnCCall_Interruptible 12
223
   /* same as above but permit killing the worker thread */
224

225
/* Involved in a message sent to tso->msg_cap */
226
#define BlockedOnMsgThrowTo 13
227

dterei's avatar
dterei committed
228
/* The thread is not on any run queues, but can be woken up
229
   by tryWakeupThread() */
230
#define ThreadMigrating     14
231

232
233
234
235
236
/*
 * These constants are returned to the scheduler by a thread that has
 * stopped for one reason or another.  See typedef StgThreadReturnCode
 * in TSO.h.
 */
dterei's avatar
dterei committed
237
#define HeapOverflow   1                /* might also be StackOverflow */
238
239
240
241
242
#define StackOverflow  2
#define ThreadYielding 3
#define ThreadBlocked  4
#define ThreadFinished 5

dterei's avatar
dterei committed
243
/*
244
245
246
247
248
249
250
251
252
253
254
255
256
 * Flags for the tso->flags field.
 */

/*
 * TSO_LOCKED is set when a TSO is locked to a particular Capability.
 */
#define TSO_LOCKED  2

/*
 * TSO_BLOCKEX: the TSO is blocking exceptions
 *
 * TSO_INTERRUPTIBLE: the TSO can be interrupted if it blocks
 * interruptibly (eg. with BlockedOnMVar).
257
258
 *
 * TSO_STOPPED_ON_BREAKPOINT: the thread is currently stopped in a breakpoint
259
260
261
 */
#define TSO_BLOCKEX       4
#define TSO_INTERRUPTIBLE 8
dterei's avatar
dterei committed
262
#define TSO_STOPPED_ON_BREAKPOINT 16
263

Simon Marlow's avatar
Simon Marlow committed
264
265
266
267
/*
 * Used by the sanity checker to check whether TSOs are on the correct
 * mutable list.
 */
268
269
#define TSO_MARKED 64

270
271
272
273
274
275
276
/*
 * Used to communicate between stackSqueeze() and
 * threadStackOverflow() that a thread's stack was squeezed and the
 * stack may not need to be expanded.
 */
#define TSO_SQUEEZED 128

277
278
279
280
281
282
283
284
285
/*
 * The number of times we spin in a spin lock before yielding (see
 * #3758).  To tune this value, use the benchmark in #3758: run the
 * server with -N2 and the client both on a dual-core.  Also make sure
 * that the chosen value doesn't slow down any of the parallel
 * benchmarks in nofib/parallel.
 */
#define SPIN_COUNT 1000

286
287
288
289
290
291
292
293
294
/* -----------------------------------------------------------------------------
   Spare workers per Capability in the threaded RTS

   No more than MAX_SPARE_WORKERS will be kept in the thread pool
   associated with each Capability.
   -------------------------------------------------------------------------- */

#define MAX_SPARE_WORKERS 6

Simon Marlow's avatar
Simon Marlow committed
295
#endif /* RTS_CONSTANTS_H */