Pass 512-bit-wide vectors in registers.
[ghc.git] / utils / deriveConstants / DeriveConstants.hs
1
2 {- ------------------------------------------------------------------------
3
4 (c) The GHC Team, 1992-2012
5
6 DeriveConstants is a program that extracts information from the C
7 declarations in the header files (primarily struct field offsets)
8 and generates various files, such as a header file that can be #included
9 into non-C source containing this information.
10
11 ------------------------------------------------------------------------ -}
12
13 import Control.Monad
14 import Data.Bits
15 import Data.Char
16 import Data.List
17 import Data.Map (Map)
18 import qualified Data.Map as Map
19 import Data.Maybe
20 import Numeric
21 import System.Environment
22 import System.Exit
23 import System.FilePath
24 import System.IO
25 import System.Info
26 import System.Process
27
28 main :: IO ()
29 main = do opts <- parseArgs
30 let getOption descr opt = case opt opts of
31 Just x -> return x
32 Nothing -> die ("No " ++ descr ++ " given")
33 mode <- getOption "mode" o_mode
34 fn <- getOption "output filename" o_outputFilename
35 case mode of
36 Gen_Haskell_Type -> writeHaskellType fn haskellWanteds
37 Gen_Haskell_Wrappers -> writeHaskellWrappers fn haskellWanteds
38 Gen_Haskell_Exports -> writeHaskellExports fn haskellWanteds
39 Gen_Computed cm ->
40 do tmpdir <- getOption "tmpdir" o_tmpdir
41 gccProg <- getOption "gcc program" o_gccProg
42 nmProg <- getOption "nm program" o_nmProg
43 let verbose = o_verbose opts
44 gccFlags = o_gccFlags opts
45 rs <- getWanted verbose tmpdir gccProg gccFlags nmProg
46 let haskellRs = [ what
47 | (wh, what) <- rs
48 , wh `elem` [Haskell, Both] ]
49 cRs = [ what
50 | (wh, what) <- rs
51 , wh `elem` [C, Both] ]
52 case cm of
53 ComputeHaskell -> writeHaskellValue fn haskellRs
54 ComputeHeader -> writeHeader fn cRs
55 where haskellWanteds = [ what | (wh, what) <- wanteds,
56 wh `elem` [Haskell, Both] ]
57
58 data Options = Options {
59 o_verbose :: Bool,
60 o_mode :: Maybe Mode,
61 o_tmpdir :: Maybe FilePath,
62 o_outputFilename :: Maybe FilePath,
63 o_gccProg :: Maybe FilePath,
64 o_gccFlags :: [String],
65 o_nmProg :: Maybe FilePath
66 }
67
68 parseArgs :: IO Options
69 parseArgs = do args <- getArgs
70 opts <- f emptyOptions args
71 return (opts {o_gccFlags = reverse (o_gccFlags opts)})
72 where emptyOptions = Options {
73 o_verbose = False,
74 o_mode = Nothing,
75 o_tmpdir = Nothing,
76 o_outputFilename = Nothing,
77 o_gccProg = Nothing,
78 o_gccFlags = [],
79 o_nmProg = Nothing
80 }
81 f opts [] = return opts
82 f opts ("-v" : args')
83 = f (opts {o_verbose = True}) args'
84 f opts ("--gen-haskell-type" : args')
85 = f (opts {o_mode = Just Gen_Haskell_Type}) args'
86 f opts ("--gen-haskell-value" : args')
87 = f (opts {o_mode = Just (Gen_Computed ComputeHaskell)}) args'
88 f opts ("--gen-haskell-wrappers" : args')
89 = f (opts {o_mode = Just Gen_Haskell_Wrappers}) args'
90 f opts ("--gen-haskell-exports" : args')
91 = f (opts {o_mode = Just Gen_Haskell_Exports}) args'
92 f opts ("--gen-header" : args')
93 = f (opts {o_mode = Just (Gen_Computed ComputeHeader)}) args'
94 f opts ("--tmpdir" : dir : args')
95 = f (opts {o_tmpdir = Just dir}) args'
96 f opts ("-o" : fn : args')
97 = f (opts {o_outputFilename = Just fn}) args'
98 f opts ("--gcc-program" : prog : args')
99 = f (opts {o_gccProg = Just prog}) args'
100 f opts ("--gcc-flag" : flag : args')
101 = f (opts {o_gccFlags = flag : o_gccFlags opts}) args'
102 f opts ("--nm-program" : prog : args')
103 = f (opts {o_nmProg = Just prog}) args'
104 f _ (flag : _) = die ("Unrecognised flag: " ++ show flag)
105
106 data Mode = Gen_Haskell_Type
107 | Gen_Haskell_Wrappers
108 | Gen_Haskell_Exports
109 | Gen_Computed ComputeMode
110
111 data ComputeMode = ComputeHaskell | ComputeHeader
112
113 type Wanteds = [(Where, What Fst)]
114 type Results = [(Where, What Snd)]
115
116 type Name = String
117 newtype CExpr = CExpr String
118 newtype CPPExpr = CPPExpr String
119 data What f = GetFieldType Name (f CExpr Integer)
120 | GetClosureSize Name (f CExpr Integer)
121 | GetWord Name (f CExpr Integer)
122 | GetInt Name (f CExpr Integer)
123 | GetNatural Name (f CExpr Integer)
124 | GetBool Name (f CPPExpr Bool)
125 | StructFieldMacro Name
126 | ClosureFieldMacro Name
127 | ClosurePayloadMacro Name
128 | FieldTypeGcptrMacro Name
129
130 data Fst a b = Fst a
131 data Snd a b = Snd b
132
133 data Where = C | Haskell | Both
134 deriving Eq
135
136 constantInt :: Where -> Name -> String -> Wanteds
137 constantInt w name expr = [(w, GetInt name (Fst (CExpr expr)))]
138
139 constantWord :: Where -> Name -> String -> Wanteds
140 constantWord w name expr = [(w, GetWord name (Fst (CExpr expr)))]
141
142 constantNatural :: Where -> Name -> String -> Wanteds
143 constantNatural w name expr = [(w, GetNatural name (Fst (CExpr expr)))]
144
145 constantBool :: Where -> Name -> String -> Wanteds
146 constantBool w name expr = [(w, GetBool name (Fst (CPPExpr expr)))]
147
148 fieldOffset :: Where -> String -> String -> Wanteds
149 fieldOffset w theType theField = fieldOffset_ w nameBase theType theField
150 where nameBase = theType ++ "_" ++ theField
151
152 fieldOffset_ :: Where -> Name -> String -> String -> Wanteds
153 fieldOffset_ w nameBase theType theField = [(w, GetWord name (Fst (CExpr expr)))]
154 where name = "OFFSET_" ++ nameBase
155 expr = "offsetof(" ++ theType ++ ", " ++ theField ++ ")"
156
157 -- FieldType is for defining REP_x to be b32 etc
158 -- These are both the C-- types used in a load
159 -- e.g. b32[addr]
160 -- and the names of the CmmTypes in the compiler
161 -- b32 :: CmmType
162 fieldType' :: Where -> String -> String -> Wanteds
163 fieldType' w theType theField
164 = fieldType_' w nameBase theType theField
165 where nameBase = theType ++ "_" ++ theField
166
167 fieldType_' :: Where -> Name -> String -> String -> Wanteds
168 fieldType_' w nameBase theType theField
169 = [(w, GetFieldType name (Fst (CExpr expr)))]
170 where name = "REP_" ++ nameBase
171 expr = "FIELD_SIZE(" ++ theType ++ ", " ++ theField ++ ")"
172
173 structField :: Where -> String -> String -> Wanteds
174 structField = structFieldHelper C
175
176 structFieldH :: Where -> String -> String -> Wanteds
177 structFieldH w = structFieldHelper w w
178
179 structField_ :: Where -> Name -> String -> String -> Wanteds
180 structField_ w nameBase theType theField
181 = fieldOffset_ w nameBase theType theField
182 ++ fieldType_' C nameBase theType theField
183 ++ structFieldMacro nameBase
184
185 structFieldMacro :: Name -> Wanteds
186 structFieldMacro nameBase = [(C, StructFieldMacro nameBase)]
187
188 -- Outputs the byte offset and MachRep for a field
189 structFieldHelper :: Where -> Where -> String -> String -> Wanteds
190 structFieldHelper wFT w theType theField = fieldOffset w theType theField
191 ++ fieldType' wFT theType theField
192 ++ structFieldMacro nameBase
193 where nameBase = theType ++ "_" ++ theField
194
195 closureFieldMacro :: Name -> Wanteds
196 closureFieldMacro nameBase = [(C, ClosureFieldMacro nameBase)]
197
198 closurePayload :: Where -> String -> String -> Wanteds
199 closurePayload w theType theField
200 = closureFieldOffset_ w nameBase theType theField
201 ++ closurePayloadMacro nameBase
202 where nameBase = theType ++ "_" ++ theField
203
204 closurePayloadMacro :: Name -> Wanteds
205 closurePayloadMacro nameBase = [(C, ClosurePayloadMacro nameBase)]
206
207 -- Byte offset and MachRep for a closure field, minus the header
208 closureField_ :: Where -> Name -> String -> String -> Wanteds
209 closureField_ w nameBase theType theField
210 = closureFieldOffset_ w nameBase theType theField
211 ++ fieldType_' C nameBase theType theField
212 ++ closureFieldMacro nameBase
213
214 closureField :: Where -> String -> String -> Wanteds
215 closureField w theType theField = closureField_ w nameBase theType theField
216 where nameBase = theType ++ "_" ++ theField
217
218 closureFieldOffset_ :: Where -> Name -> String -> String -> Wanteds
219 closureFieldOffset_ w nameBase theType theField
220 = defOffset w nameBase (CExpr ("offsetof(" ++ theType ++ ", " ++ theField ++ ") - TYPE_SIZE(StgHeader)"))
221
222 -- Size of a closure type, minus the header, named SIZEOF_<type>_NoHdr
223 -- Also, we #define SIZEOF_<type> to be the size of the whole closure for .cmm.
224 closureSize :: Where -> String -> Wanteds
225 closureSize w theType = defSize w (theType ++ "_NoHdr") (CExpr expr)
226 ++ defClosureSize C theType (CExpr expr)
227 where expr = "TYPE_SIZE(" ++ theType ++ ") - TYPE_SIZE(StgHeader)"
228
229 -- Byte offset and MachRep for a closure field, minus the header
230 closureFieldGcptr :: Where -> String -> String -> Wanteds
231 closureFieldGcptr w theType theField
232 = closureFieldOffset_ w nameBase theType theField
233 ++ fieldTypeGcptr nameBase
234 ++ closureFieldMacro nameBase
235 where nameBase = theType ++ "_" ++ theField
236
237 fieldTypeGcptr :: Name -> Wanteds
238 fieldTypeGcptr nameBase = [(C, FieldTypeGcptrMacro nameBase)]
239
240 closureFieldOffset :: Where -> String -> String -> Wanteds
241 closureFieldOffset w theType theField
242 = defOffset w nameBase (CExpr expr)
243 where nameBase = theType ++ "_" ++ theField
244 expr = "offsetof(" ++ theType ++ ", " ++ theField ++ ") - TYPE_SIZE(StgHeader)"
245
246 thunkSize :: Where -> String -> Wanteds
247 thunkSize w theType
248 = defSize w (theType ++ "_NoThunkHdr") (CExpr expr)
249 ++ closureSize w theType
250 where expr = "TYPE_SIZE(" ++ theType ++ ") - TYPE_SIZE(StgThunkHeader)"
251
252 defIntOffset :: Where -> Name -> String -> Wanteds
253 defIntOffset w nameBase cExpr = [(w, GetInt ("OFFSET_" ++ nameBase) (Fst (CExpr cExpr)))]
254
255 defOffset :: Where -> Name -> CExpr -> Wanteds
256 defOffset w nameBase cExpr = [(w, GetWord ("OFFSET_" ++ nameBase) (Fst cExpr))]
257
258 structSize :: Where -> String -> Wanteds
259 structSize w theType = defSize w theType (CExpr ("TYPE_SIZE(" ++ theType ++ ")"))
260
261 defSize :: Where -> Name -> CExpr -> Wanteds
262 defSize w nameBase cExpr = [(w, GetWord ("SIZEOF_" ++ nameBase) (Fst cExpr))]
263
264 defClosureSize :: Where -> Name -> CExpr -> Wanteds
265 defClosureSize w nameBase cExpr = [(w, GetClosureSize ("SIZEOF_" ++ nameBase) (Fst cExpr))]
266
267 haskellise :: Name -> Name
268 haskellise (c : cs) = toLower c : cs
269 haskellise "" = ""
270
271 wanteds :: Wanteds
272 wanteds = concat
273 [-- Closure header sizes.
274 constantWord Both "STD_HDR_SIZE"
275 -- grrr.. PROFILING is on so we need to
276 -- subtract sizeofW(StgProfHeader)
277 "sizeofW(StgHeader) - sizeofW(StgProfHeader)"
278 ,constantWord Both "PROF_HDR_SIZE" "sizeofW(StgProfHeader)"
279
280 -- Size of a storage manager block (in bytes).
281 ,constantWord Both "BLOCK_SIZE" "BLOCK_SIZE"
282 ,constantWord C "MBLOCK_SIZE" "MBLOCK_SIZE"
283 -- blocks that fit in an MBlock, leaving space for the block
284 -- descriptors
285 ,constantWord Both "BLOCKS_PER_MBLOCK" "BLOCKS_PER_MBLOCK"
286 -- could be derived, but better to save doing the calculation twice
287
288 ,fieldOffset Both "StgRegTable" "rR1"
289 ,fieldOffset Both "StgRegTable" "rR2"
290 ,fieldOffset Both "StgRegTable" "rR3"
291 ,fieldOffset Both "StgRegTable" "rR4"
292 ,fieldOffset Both "StgRegTable" "rR5"
293 ,fieldOffset Both "StgRegTable" "rR6"
294 ,fieldOffset Both "StgRegTable" "rR7"
295 ,fieldOffset Both "StgRegTable" "rR8"
296 ,fieldOffset Both "StgRegTable" "rR9"
297 ,fieldOffset Both "StgRegTable" "rR10"
298 ,fieldOffset Both "StgRegTable" "rF1"
299 ,fieldOffset Both "StgRegTable" "rF2"
300 ,fieldOffset Both "StgRegTable" "rF3"
301 ,fieldOffset Both "StgRegTable" "rF4"
302 ,fieldOffset Both "StgRegTable" "rF5"
303 ,fieldOffset Both "StgRegTable" "rF6"
304 ,fieldOffset Both "StgRegTable" "rD1"
305 ,fieldOffset Both "StgRegTable" "rD2"
306 ,fieldOffset Both "StgRegTable" "rD3"
307 ,fieldOffset Both "StgRegTable" "rD4"
308 ,fieldOffset Both "StgRegTable" "rD5"
309 ,fieldOffset Both "StgRegTable" "rD6"
310 ,fieldOffset Both "StgRegTable" "rXMM1"
311 ,fieldOffset Both "StgRegTable" "rXMM2"
312 ,fieldOffset Both "StgRegTable" "rXMM3"
313 ,fieldOffset Both "StgRegTable" "rXMM4"
314 ,fieldOffset Both "StgRegTable" "rXMM5"
315 ,fieldOffset Both "StgRegTable" "rXMM6"
316 ,fieldOffset Both "StgRegTable" "rYMM1"
317 ,fieldOffset Both "StgRegTable" "rYMM2"
318 ,fieldOffset Both "StgRegTable" "rYMM3"
319 ,fieldOffset Both "StgRegTable" "rYMM4"
320 ,fieldOffset Both "StgRegTable" "rYMM5"
321 ,fieldOffset Both "StgRegTable" "rYMM6"
322 ,fieldOffset Both "StgRegTable" "rZMM1"
323 ,fieldOffset Both "StgRegTable" "rZMM2"
324 ,fieldOffset Both "StgRegTable" "rZMM3"
325 ,fieldOffset Both "StgRegTable" "rZMM4"
326 ,fieldOffset Both "StgRegTable" "rZMM5"
327 ,fieldOffset Both "StgRegTable" "rZMM6"
328 ,fieldOffset Both "StgRegTable" "rL1"
329 ,fieldOffset Both "StgRegTable" "rSp"
330 ,fieldOffset Both "StgRegTable" "rSpLim"
331 ,fieldOffset Both "StgRegTable" "rHp"
332 ,fieldOffset Both "StgRegTable" "rHpLim"
333 ,fieldOffset Both "StgRegTable" "rCCCS"
334 ,fieldOffset Both "StgRegTable" "rCurrentTSO"
335 ,fieldOffset Both "StgRegTable" "rCurrentNursery"
336 ,fieldOffset Both "StgRegTable" "rHpAlloc"
337 ,structField C "StgRegTable" "rRet"
338 ,structField C "StgRegTable" "rNursery"
339
340 ,defIntOffset Both "stgEagerBlackholeInfo"
341 "FUN_OFFSET(stgEagerBlackholeInfo)"
342 ,defIntOffset Both "stgGCEnter1" "FUN_OFFSET(stgGCEnter1)"
343 ,defIntOffset Both "stgGCFun" "FUN_OFFSET(stgGCFun)"
344
345 ,fieldOffset Both "Capability" "r"
346 ,fieldOffset C "Capability" "lock"
347 ,structField C "Capability" "no"
348 ,structField C "Capability" "mut_lists"
349 ,structField C "Capability" "context_switch"
350 ,structField C "Capability" "interrupt"
351 ,structField C "Capability" "sparks"
352
353 ,structField Both "bdescr" "start"
354 ,structField Both "bdescr" "free"
355 ,structField Both "bdescr" "blocks"
356 ,structField C "bdescr" "gen_no"
357 ,structField C "bdescr" "link"
358
359 ,structSize C "generation"
360 ,structField C "generation" "n_new_large_words"
361 ,structField C "generation" "weak_ptr_list"
362
363 ,structSize Both "CostCentreStack"
364 ,structField C "CostCentreStack" "ccsID"
365 ,structFieldH Both "CostCentreStack" "mem_alloc"
366 ,structFieldH Both "CostCentreStack" "scc_count"
367 ,structField C "CostCentreStack" "prevStack"
368
369 ,structField C "CostCentre" "ccID"
370 ,structField C "CostCentre" "link"
371
372 ,structField C "StgHeader" "info"
373 ,structField_ Both "StgHeader_ccs" "StgHeader" "prof.ccs"
374 ,structField_ Both "StgHeader_ldvw" "StgHeader" "prof.hp.ldvw"
375
376 ,structSize Both "StgSMPThunkHeader"
377
378 ,closurePayload C "StgClosure" "payload"
379
380 ,structFieldH Both "StgEntCounter" "allocs"
381 ,structFieldH Both "StgEntCounter" "allocd"
382 ,structField Both "StgEntCounter" "registeredp"
383 ,structField Both "StgEntCounter" "link"
384 ,structField Both "StgEntCounter" "entry_count"
385
386 ,closureSize Both "StgUpdateFrame"
387 ,closureSize C "StgCatchFrame"
388 ,closureSize C "StgStopFrame"
389
390 ,closureSize Both "StgMutArrPtrs"
391 ,closureField Both "StgMutArrPtrs" "ptrs"
392 ,closureField Both "StgMutArrPtrs" "size"
393
394 ,closureSize Both "StgArrWords"
395 ,closureField C "StgArrWords" "bytes"
396 ,closurePayload C "StgArrWords" "payload"
397
398 ,closureField C "StgTSO" "_link"
399 ,closureField C "StgTSO" "global_link"
400 ,closureField C "StgTSO" "what_next"
401 ,closureField C "StgTSO" "why_blocked"
402 ,closureField C "StgTSO" "block_info"
403 ,closureField C "StgTSO" "blocked_exceptions"
404 ,closureField C "StgTSO" "id"
405 ,closureField C "StgTSO" "cap"
406 ,closureField C "StgTSO" "saved_errno"
407 ,closureField C "StgTSO" "trec"
408 ,closureField C "StgTSO" "flags"
409 ,closureField C "StgTSO" "dirty"
410 ,closureField C "StgTSO" "bq"
411 ,closureField_ Both "StgTSO_cccs" "StgTSO" "prof.cccs"
412 ,closureField Both "StgTSO" "stackobj"
413
414 ,closureField Both "StgStack" "sp"
415 ,closureFieldOffset Both "StgStack" "stack"
416 ,closureField C "StgStack" "stack_size"
417 ,closureField C "StgStack" "dirty"
418
419 ,structSize C "StgTSOProfInfo"
420
421 ,closureField Both "StgUpdateFrame" "updatee"
422
423 ,closureField C "StgCatchFrame" "handler"
424 ,closureField C "StgCatchFrame" "exceptions_blocked"
425
426 ,closureSize C "StgPAP"
427 ,closureField C "StgPAP" "n_args"
428 ,closureFieldGcptr C "StgPAP" "fun"
429 ,closureField C "StgPAP" "arity"
430 ,closurePayload C "StgPAP" "payload"
431
432 ,thunkSize C "StgAP"
433 ,closureField C "StgAP" "n_args"
434 ,closureFieldGcptr C "StgAP" "fun"
435 ,closurePayload C "StgAP" "payload"
436
437 ,thunkSize C "StgAP_STACK"
438 ,closureField C "StgAP_STACK" "size"
439 ,closureFieldGcptr C "StgAP_STACK" "fun"
440 ,closurePayload C "StgAP_STACK" "payload"
441
442 ,thunkSize C "StgSelector"
443
444 ,closureFieldGcptr C "StgInd" "indirectee"
445
446 ,closureSize C "StgMutVar"
447 ,closureField C "StgMutVar" "var"
448
449 ,closureSize C "StgAtomicallyFrame"
450 ,closureField C "StgAtomicallyFrame" "code"
451 ,closureField C "StgAtomicallyFrame" "next_invariant_to_check"
452 ,closureField C "StgAtomicallyFrame" "result"
453
454 ,closureField C "StgInvariantCheckQueue" "invariant"
455 ,closureField C "StgInvariantCheckQueue" "my_execution"
456 ,closureField C "StgInvariantCheckQueue" "next_queue_entry"
457
458 ,closureField C "StgAtomicInvariant" "code"
459
460 ,closureField C "StgTRecHeader" "enclosing_trec"
461
462 ,closureSize C "StgCatchSTMFrame"
463 ,closureField C "StgCatchSTMFrame" "handler"
464 ,closureField C "StgCatchSTMFrame" "code"
465
466 ,closureSize C "StgCatchRetryFrame"
467 ,closureField C "StgCatchRetryFrame" "running_alt_code"
468 ,closureField C "StgCatchRetryFrame" "first_code"
469 ,closureField C "StgCatchRetryFrame" "alt_code"
470
471 ,closureField C "StgTVarWatchQueue" "closure"
472 ,closureField C "StgTVarWatchQueue" "next_queue_entry"
473 ,closureField C "StgTVarWatchQueue" "prev_queue_entry"
474
475 ,closureSize C "StgTVar"
476 ,closureField C "StgTVar" "current_value"
477 ,closureField C "StgTVar" "first_watch_queue_entry"
478 ,closureField C "StgTVar" "num_updates"
479
480 ,closureSize C "StgWeak"
481 ,closureField C "StgWeak" "link"
482 ,closureField C "StgWeak" "key"
483 ,closureField C "StgWeak" "value"
484 ,closureField C "StgWeak" "finalizer"
485 ,closureField C "StgWeak" "cfinalizers"
486
487 ,closureSize C "StgCFinalizerList"
488 ,closureField C "StgCFinalizerList" "link"
489 ,closureField C "StgCFinalizerList" "fptr"
490 ,closureField C "StgCFinalizerList" "ptr"
491 ,closureField C "StgCFinalizerList" "eptr"
492 ,closureField C "StgCFinalizerList" "flag"
493
494 ,closureSize C "StgMVar"
495 ,closureField C "StgMVar" "head"
496 ,closureField C "StgMVar" "tail"
497 ,closureField C "StgMVar" "value"
498
499 ,closureSize C "StgMVarTSOQueue"
500 ,closureField C "StgMVarTSOQueue" "link"
501 ,closureField C "StgMVarTSOQueue" "tso"
502
503 ,closureSize C "StgBCO"
504 ,closureField C "StgBCO" "instrs"
505 ,closureField C "StgBCO" "literals"
506 ,closureField C "StgBCO" "ptrs"
507 ,closureField C "StgBCO" "arity"
508 ,closureField C "StgBCO" "size"
509 ,closurePayload C "StgBCO" "bitmap"
510
511 ,closureSize C "StgStableName"
512 ,closureField C "StgStableName" "sn"
513
514 ,closureSize C "StgBlockingQueue"
515 ,closureField C "StgBlockingQueue" "bh"
516 ,closureField C "StgBlockingQueue" "owner"
517 ,closureField C "StgBlockingQueue" "queue"
518 ,closureField C "StgBlockingQueue" "link"
519
520 ,closureSize C "MessageBlackHole"
521 ,closureField C "MessageBlackHole" "link"
522 ,closureField C "MessageBlackHole" "tso"
523 ,closureField C "MessageBlackHole" "bh"
524
525 ,structField_ C "RtsFlags_ProfFlags_showCCSOnException"
526 "RTS_FLAGS" "ProfFlags.showCCSOnException"
527 ,structField_ C "RtsFlags_DebugFlags_apply"
528 "RTS_FLAGS" "DebugFlags.apply"
529 ,structField_ C "RtsFlags_DebugFlags_sanity"
530 "RTS_FLAGS" "DebugFlags.sanity"
531 ,structField_ C "RtsFlags_DebugFlags_weak"
532 "RTS_FLAGS" "DebugFlags.weak"
533 ,structField_ C "RtsFlags_GcFlags_initialStkSize"
534 "RTS_FLAGS" "GcFlags.initialStkSize"
535 ,structField_ C "RtsFlags_MiscFlags_tickInterval"
536 "RTS_FLAGS" "MiscFlags.tickInterval"
537
538 ,structSize C "StgFunInfoExtraFwd"
539 ,structField C "StgFunInfoExtraFwd" "slow_apply"
540 ,structField C "StgFunInfoExtraFwd" "fun_type"
541 ,structField C "StgFunInfoExtraFwd" "arity"
542 ,structField_ C "StgFunInfoExtraFwd_bitmap" "StgFunInfoExtraFwd" "b.bitmap"
543
544 ,structSize Both "StgFunInfoExtraRev"
545 ,structField C "StgFunInfoExtraRev" "slow_apply_offset"
546 ,structField C "StgFunInfoExtraRev" "fun_type"
547 ,structField C "StgFunInfoExtraRev" "arity"
548 ,structField_ C "StgFunInfoExtraRev_bitmap" "StgFunInfoExtraRev" "b.bitmap"
549
550 ,structField C "StgLargeBitmap" "size"
551 ,fieldOffset C "StgLargeBitmap" "bitmap"
552
553 ,structSize C "snEntry"
554 ,structField C "snEntry" "sn_obj"
555 ,structField C "snEntry" "addr"
556
557 ,structSize C "spEntry"
558 ,structField C "spEntry" "addr"
559
560 -- Note that this conditional part only affects the C headers.
561 -- That's important, as it means we get the same PlatformConstants
562 -- type on all platforms.
563 ,if os == "mingw32"
564 then concat [structSize C "StgAsyncIOResult"
565 ,structField C "StgAsyncIOResult" "reqID"
566 ,structField C "StgAsyncIOResult" "len"
567 ,structField C "StgAsyncIOResult" "errCode"]
568 else []
569
570 -- pre-compiled thunk types
571 ,constantWord Haskell "MAX_SPEC_SELECTEE_SIZE" "MAX_SPEC_SELECTEE_SIZE"
572 ,constantWord Haskell "MAX_SPEC_AP_SIZE" "MAX_SPEC_AP_SIZE"
573
574 -- closure sizes: these do NOT include the header (see below for
575 -- header sizes)
576 ,constantWord Haskell "MIN_PAYLOAD_SIZE" "MIN_PAYLOAD_SIZE"
577
578 ,constantInt Haskell "MIN_INTLIKE" "MIN_INTLIKE"
579 ,constantWord Haskell "MAX_INTLIKE" "MAX_INTLIKE"
580
581 ,constantWord Haskell "MIN_CHARLIKE" "MIN_CHARLIKE"
582 ,constantWord Haskell "MAX_CHARLIKE" "MAX_CHARLIKE"
583
584 ,constantWord Haskell "MUT_ARR_PTRS_CARD_BITS" "MUT_ARR_PTRS_CARD_BITS"
585
586 -- A section of code-generator-related MAGIC CONSTANTS.
587 ,constantWord Haskell "MAX_Vanilla_REG" "MAX_VANILLA_REG"
588 ,constantWord Haskell "MAX_Float_REG" "MAX_FLOAT_REG"
589 ,constantWord Haskell "MAX_Double_REG" "MAX_DOUBLE_REG"
590 ,constantWord Haskell "MAX_Long_REG" "MAX_LONG_REG"
591 ,constantWord Haskell "MAX_XMM_REG" "MAX_XMM_REG"
592 ,constantWord Haskell "MAX_Real_Vanilla_REG" "MAX_REAL_VANILLA_REG"
593 ,constantWord Haskell "MAX_Real_Float_REG" "MAX_REAL_FLOAT_REG"
594 ,constantWord Haskell "MAX_Real_Double_REG" "MAX_REAL_DOUBLE_REG"
595 ,constantWord Haskell "MAX_Real_XMM_REG" "MAX_REAL_XMM_REG"
596 ,constantWord Haskell "MAX_Real_Long_REG" "MAX_REAL_LONG_REG"
597
598 -- This tells the native code generator the size of the spill
599 -- area is has available.
600 ,constantWord Haskell "RESERVED_C_STACK_BYTES" "RESERVED_C_STACK_BYTES"
601 -- The amount of (Haskell) stack to leave free for saving
602 -- registers when returning to the scheduler.
603 ,constantWord Haskell "RESERVED_STACK_WORDS" "RESERVED_STACK_WORDS"
604 -- Continuations that need more than this amount of stack
605 -- should do their own stack check (see bug #1466).
606 ,constantWord Haskell "AP_STACK_SPLIM" "AP_STACK_SPLIM"
607
608 -- Size of a word, in bytes
609 ,constantWord Haskell "WORD_SIZE" "SIZEOF_HSWORD"
610
611 -- Size of a double in StgWords.
612 ,constantWord Haskell "DOUBLE_SIZE" "SIZEOF_DOUBLE"
613
614 -- Size of a C int, in bytes. May be smaller than wORD_SIZE.
615 ,constantWord Haskell "CINT_SIZE" "SIZEOF_INT"
616 ,constantWord Haskell "CLONG_SIZE" "SIZEOF_LONG"
617 ,constantWord Haskell "CLONG_LONG_SIZE" "SIZEOF_LONG_LONG"
618
619 -- Number of bits to shift a bitfield left by in an info table.
620 ,constantWord Haskell "BITMAP_BITS_SHIFT" "BITMAP_BITS_SHIFT"
621
622 -- Amount of pointer bits used for semi-tagging constructor closures
623 ,constantWord Haskell "TAG_BITS" "TAG_BITS"
624
625 ,constantBool Haskell "WORDS_BIGENDIAN" "defined(WORDS_BIGENDIAN)"
626 ,constantBool Haskell "DYNAMIC_BY_DEFAULT" "defined(DYNAMIC_BY_DEFAULT)"
627
628 ,constantWord Haskell "LDV_SHIFT" "LDV_SHIFT"
629 ,constantNatural Haskell "ILDV_CREATE_MASK" "LDV_CREATE_MASK"
630 ,constantNatural Haskell "ILDV_STATE_CREATE" "LDV_STATE_CREATE"
631 ,constantNatural Haskell "ILDV_STATE_USE" "LDV_STATE_USE"
632 ]
633
634 getWanted :: Bool -> FilePath -> FilePath -> [String] -> FilePath -> IO Results
635 getWanted verbose tmpdir gccProgram gccFlags nmProgram
636 = do let cStuff = unlines (headers ++ concatMap (doWanted . snd) wanteds)
637 cFile = tmpdir </> "tmp.c"
638 oFile = tmpdir </> "tmp.o"
639 writeFile cFile cStuff
640 execute verbose gccProgram (gccFlags ++ ["-c", cFile, "-o", oFile])
641 xs <- readProcess nmProgram [oFile] ""
642 let ls = lines xs
643 ms = map parseNmLine ls
644 m = Map.fromList $ catMaybes ms
645 rs <- mapM (lookupResult m) wanteds
646 return rs
647 where headers = ["#define IN_STG_CODE 0",
648 "",
649 "/*",
650 " * We need offsets of profiled things...",
651 " * better be careful that this doesn't",
652 " * affect the offsets of anything else.",
653 " */",
654 "",
655 "#define PROFILING",
656 "#define THREADED_RTS",
657 "",
658 "#include \"PosixSource.h\"",
659 "#include \"Rts.h\"",
660 "#include \"Stable.h\"",
661 "#include \"Capability.h\"",
662 "",
663 "#include <inttypes.h>",
664 "#include <stddef.h>",
665 "#include <stdio.h>",
666 "#include <string.h>",
667 "",
668 "#define FIELD_SIZE(s_type, field) ((size_t)sizeof(((s_type*)0)->field))",
669 "#define TYPE_SIZE(type) (sizeof(type))",
670 "#define FUN_OFFSET(sym) (offsetof(Capability,f.sym) - offsetof(Capability,r))",
671 "",
672 "#pragma GCC poison sizeof"
673 ]
674
675 prefix = "derivedConstant"
676 mkFullName name = prefix ++ name
677
678 -- We add 1 to the value, as some platforms will make a symbol
679 -- of size 1 when for
680 -- char foo[0];
681 -- We then subtract 1 again when parsing.
682 doWanted (GetFieldType name (Fst (CExpr cExpr)))
683 = ["char " ++ mkFullName name ++ "[1 + " ++ cExpr ++ "];"]
684 doWanted (GetClosureSize name (Fst (CExpr cExpr)))
685 = ["char " ++ mkFullName name ++ "[1 + " ++ cExpr ++ "];"]
686 doWanted (GetWord name (Fst (CExpr cExpr)))
687 = ["char " ++ mkFullName name ++ "[1 + " ++ cExpr ++ "];"]
688 doWanted (GetInt name (Fst (CExpr cExpr)))
689 = ["char " ++ mkFullName name ++ "Mag[1 + ((intptr_t)(" ++ cExpr ++ ") >= 0 ? (" ++ cExpr ++ ") : -(" ++ cExpr ++ "))];",
690 "char " ++ mkFullName name ++ "Sig[(intptr_t)(" ++ cExpr ++ ") >= 0 ? 3 : 1];"]
691 doWanted (GetNatural name (Fst (CExpr cExpr)))
692 = -- These casts fix "right shift count >= width of type"
693 -- warnings
694 let cExpr' = "(uint64_t)(size_t)(" ++ cExpr ++ ")"
695 in ["char " ++ mkFullName name ++ "0[1 + ((" ++ cExpr' ++ ") & 0xFFFF)];",
696 "char " ++ mkFullName name ++ "1[1 + (((" ++ cExpr' ++ ") >> 16) & 0xFFFF)];",
697 "char " ++ mkFullName name ++ "2[1 + (((" ++ cExpr' ++ ") >> 32) & 0xFFFF)];",
698 "char " ++ mkFullName name ++ "3[1 + (((" ++ cExpr' ++ ") >> 48) & 0xFFFF)];"]
699 doWanted (GetBool name (Fst (CPPExpr cppExpr)))
700 = ["#if " ++ cppExpr,
701 "char " ++ mkFullName name ++ "[1];",
702 "#else",
703 "char " ++ mkFullName name ++ "[2];",
704 "#endif"]
705 doWanted (StructFieldMacro {}) = []
706 doWanted (ClosureFieldMacro {}) = []
707 doWanted (ClosurePayloadMacro {}) = []
708 doWanted (FieldTypeGcptrMacro {}) = []
709
710 -- parseNmLine parses nm output that looks like
711 -- "0000000b C derivedConstantMAX_Vanilla_REG"
712 -- and returns ("MAX_Vanilla_REG", 11)
713 parseNmLine xs0 = case break (' ' ==) xs0 of
714 (x1, ' ' : xs1) ->
715 case break (' ' ==) xs1 of
716 (x2, ' ' : x3) ->
717 case readHex x1 of
718 [(size, "")] ->
719 case x2 of
720 "C" ->
721 let x3' = case x3 of
722 '_' : rest -> rest
723 _ -> x3
724 in case stripPrefix prefix x3' of
725 Just name ->
726 Just (name, size)
727 _ -> Nothing
728 _ -> Nothing
729 _ -> Nothing
730 _ -> Nothing
731 _ -> Nothing
732
733 -- If an Int value is larger than 2^28 or smaller
734 -- than -2^28, then fail.
735 -- This test is a bit conservative, but if any
736 -- constants are roughly maxBound or minBound then
737 -- we probably need them to be Integer rather than
738 -- Int so that -- cross-compiling between 32bit and
739 -- 64bit platforms works.
740 lookupSmall :: Map String Integer -> Name -> IO Integer
741 lookupSmall m name
742 = case Map.lookup name m of
743 Just v
744 | v > 2^(28 :: Int) ||
745 v < -(2^(28 :: Int)) ->
746 die ("Value too large for GetWord: " ++ show v)
747 | otherwise -> return v
748 Nothing -> die ("Can't find " ++ show name)
749
750 lookupResult :: Map String Integer -> (Where, What Fst)
751 -> IO (Where, What Snd)
752 lookupResult m (w, GetWord name _)
753 = do v <- lookupSmall m name
754 return (w, GetWord name (Snd (v - 1)))
755 lookupResult m (w, GetInt name _)
756 = do mag <- lookupSmall m (name ++ "Mag")
757 sig <- lookupSmall m (name ++ "Sig")
758 return (w, GetWord name (Snd ((mag - 1) * (sig - 2))))
759 lookupResult m (w, GetNatural name _)
760 = do v0 <- lookupSmall m (name ++ "0")
761 v1 <- lookupSmall m (name ++ "1")
762 v2 <- lookupSmall m (name ++ "2")
763 v3 <- lookupSmall m (name ++ "3")
764 let v = (v0 - 1)
765 + shiftL (v1 - 1) 16
766 + shiftL (v2 - 1) 32
767 + shiftL (v3 - 1) 48
768 return (w, GetWord name (Snd v))
769 lookupResult m (w, GetBool name _)
770 = do v <- lookupSmall m name
771 case v of
772 1 -> return (w, GetBool name (Snd True))
773 2 -> return (w, GetBool name (Snd False))
774 _ -> die ("Bad boolean: " ++ show v)
775 lookupResult m (w, GetFieldType name _)
776 = do v <- lookupSmall m name
777 return (w, GetFieldType name (Snd (v - 1)))
778 lookupResult m (w, GetClosureSize name _)
779 = do v <- lookupSmall m name
780 return (w, GetClosureSize name (Snd (v - 1)))
781 lookupResult _ (w, StructFieldMacro name)
782 = return (w, StructFieldMacro name)
783 lookupResult _ (w, ClosureFieldMacro name)
784 = return (w, ClosureFieldMacro name)
785 lookupResult _ (w, ClosurePayloadMacro name)
786 = return (w, ClosurePayloadMacro name)
787 lookupResult _ (w, FieldTypeGcptrMacro name)
788 = return (w, FieldTypeGcptrMacro name)
789
790 writeHaskellType :: FilePath -> [What Fst] -> IO ()
791 writeHaskellType fn ws = writeFile fn xs
792 where xs = unlines (headers ++ body ++ footers)
793 headers = ["data PlatformConstants = PlatformConstants {"
794 -- Now a kludge that allows the real entries to
795 -- all start with a comma, which makes life a
796 -- little easier
797 ," pc_platformConstants :: ()"]
798 footers = [" } deriving Read"]
799 body = concatMap doWhat ws
800 doWhat (GetClosureSize name _) = [" , pc_" ++ name ++ " :: Int"]
801 doWhat (GetFieldType name _) = [" , pc_" ++ name ++ " :: Int"]
802 doWhat (GetWord name _) = [" , pc_" ++ name ++ " :: Int"]
803 doWhat (GetInt name _) = [" , pc_" ++ name ++ " :: Int"]
804 doWhat (GetNatural name _) = [" , pc_" ++ name ++ " :: Integer"]
805 doWhat (GetBool name _) = [" , pc_" ++ name ++ " :: Bool"]
806 doWhat (StructFieldMacro {}) = []
807 doWhat (ClosureFieldMacro {}) = []
808 doWhat (ClosurePayloadMacro {}) = []
809 doWhat (FieldTypeGcptrMacro {}) = []
810
811 writeHaskellValue :: FilePath -> [What Snd] -> IO ()
812 writeHaskellValue fn rs = writeFile fn xs
813 where xs = unlines (headers ++ body ++ footers)
814 headers = ["PlatformConstants {"
815 ," pc_platformConstants = ()"]
816 footers = [" }"]
817 body = concatMap doWhat rs
818 doWhat (GetClosureSize name (Snd v)) = [" , pc_" ++ name ++ " = " ++ show v]
819 doWhat (GetFieldType name (Snd v)) = [" , pc_" ++ name ++ " = " ++ show v]
820 doWhat (GetWord name (Snd v)) = [" , pc_" ++ name ++ " = " ++ show v]
821 doWhat (GetInt name (Snd v)) = [" , pc_" ++ name ++ " = " ++ show v]
822 doWhat (GetNatural name (Snd v)) = [" , pc_" ++ name ++ " = " ++ show v]
823 doWhat (GetBool name (Snd v)) = [" , pc_" ++ name ++ " = " ++ show v]
824 doWhat (StructFieldMacro {}) = []
825 doWhat (ClosureFieldMacro {}) = []
826 doWhat (ClosurePayloadMacro {}) = []
827 doWhat (FieldTypeGcptrMacro {}) = []
828
829 writeHaskellWrappers :: FilePath -> [What Fst] -> IO ()
830 writeHaskellWrappers fn ws = writeFile fn xs
831 where xs = unlines body
832 body = concatMap doWhat ws
833 doWhat (GetFieldType {}) = []
834 doWhat (GetClosureSize {}) = []
835 doWhat (GetWord name _) = [haskellise name ++ " :: DynFlags -> Int",
836 haskellise name ++ " dflags = pc_" ++ name ++ " (sPlatformConstants (settings dflags))"]
837 doWhat (GetInt name _) = [haskellise name ++ " :: DynFlags -> Int",
838 haskellise name ++ " dflags = pc_" ++ name ++ " (sPlatformConstants (settings dflags))"]
839 doWhat (GetNatural name _) = [haskellise name ++ " :: DynFlags -> Integer",
840 haskellise name ++ " dflags = pc_" ++ name ++ " (sPlatformConstants (settings dflags))"]
841 doWhat (GetBool name _) = [haskellise name ++ " :: DynFlags -> Bool",
842 haskellise name ++ " dflags = pc_" ++ name ++ " (sPlatformConstants (settings dflags))"]
843 doWhat (StructFieldMacro {}) = []
844 doWhat (ClosureFieldMacro {}) = []
845 doWhat (ClosurePayloadMacro {}) = []
846 doWhat (FieldTypeGcptrMacro {}) = []
847
848 writeHaskellExports :: FilePath -> [What Fst] -> IO ()
849 writeHaskellExports fn ws = writeFile fn xs
850 where xs = unlines body
851 body = concatMap doWhat ws
852 doWhat (GetFieldType {}) = []
853 doWhat (GetClosureSize {}) = []
854 doWhat (GetWord name _) = [" " ++ haskellise name ++ ","]
855 doWhat (GetInt name _) = [" " ++ haskellise name ++ ","]
856 doWhat (GetNatural name _) = [" " ++ haskellise name ++ ","]
857 doWhat (GetBool name _) = [" " ++ haskellise name ++ ","]
858 doWhat (StructFieldMacro {}) = []
859 doWhat (ClosureFieldMacro {}) = []
860 doWhat (ClosurePayloadMacro {}) = []
861 doWhat (FieldTypeGcptrMacro {}) = []
862
863 writeHeader :: FilePath -> [What Snd] -> IO ()
864 writeHeader fn rs = writeFile fn xs
865 where xs = unlines (headers ++ body)
866 headers = ["/* This file is created automatically. Do not edit by hand.*/", ""]
867 body = concatMap doWhat rs
868 doWhat (GetFieldType name (Snd v)) = ["#define " ++ name ++ " b" ++ show (v * 8)]
869 doWhat (GetClosureSize name (Snd v)) = ["#define " ++ name ++ " (SIZEOF_StgHeader+" ++ show v ++ ")"]
870 doWhat (GetWord name (Snd v)) = ["#define " ++ name ++ " " ++ show v]
871 doWhat (GetInt name (Snd v)) = ["#define " ++ name ++ " " ++ show v]
872 doWhat (GetNatural name (Snd v)) = ["#define " ++ name ++ " " ++ show v]
873 doWhat (GetBool name (Snd v)) = ["#define " ++ name ++ " " ++ show (fromEnum v)]
874 doWhat (StructFieldMacro nameBase) =
875 ["#define " ++ nameBase ++ "(__ptr__) REP_" ++ nameBase ++ "[__ptr__+OFFSET_" ++ nameBase ++ "]"]
876 doWhat (ClosureFieldMacro nameBase) =
877 ["#define " ++ nameBase ++ "(__ptr__) REP_" ++ nameBase ++ "[__ptr__+SIZEOF_StgHeader+OFFSET_" ++ nameBase ++ "]"]
878 doWhat (ClosurePayloadMacro nameBase) =
879 ["#define " ++ nameBase ++ "(__ptr__,__ix__) W_[__ptr__+SIZEOF_StgHeader+OFFSET_" ++ nameBase ++ " + WDS(__ix__)]"]
880 doWhat (FieldTypeGcptrMacro nameBase) =
881 ["#define REP_" ++ nameBase ++ " gcptr"]
882
883 die :: String -> IO a
884 die err = do hPutStrLn stderr err
885 exitFailure
886
887 execute :: Bool -> FilePath -> [String] -> IO ()
888 execute verbose prog args
889 = do when verbose $ putStrLn $ showCommandForUser prog args
890 ec <- rawSystem prog args
891 unless (ec == ExitSuccess) $
892 die ("Executing " ++ show prog ++ " failed")
893