29b059c873adf62ded52c2456c55a7132208c45f
[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" "rL1"
323 ,fieldOffset Both "StgRegTable" "rSp"
324 ,fieldOffset Both "StgRegTable" "rSpLim"
325 ,fieldOffset Both "StgRegTable" "rHp"
326 ,fieldOffset Both "StgRegTable" "rHpLim"
327 ,fieldOffset Both "StgRegTable" "rCCCS"
328 ,fieldOffset Both "StgRegTable" "rCurrentTSO"
329 ,fieldOffset Both "StgRegTable" "rCurrentNursery"
330 ,fieldOffset Both "StgRegTable" "rHpAlloc"
331 ,structField C "StgRegTable" "rRet"
332 ,structField C "StgRegTable" "rNursery"
333
334 ,defIntOffset Both "stgEagerBlackholeInfo"
335 "FUN_OFFSET(stgEagerBlackholeInfo)"
336 ,defIntOffset Both "stgGCEnter1" "FUN_OFFSET(stgGCEnter1)"
337 ,defIntOffset Both "stgGCFun" "FUN_OFFSET(stgGCFun)"
338
339 ,fieldOffset Both "Capability" "r"
340 ,fieldOffset C "Capability" "lock"
341 ,structField C "Capability" "no"
342 ,structField C "Capability" "mut_lists"
343 ,structField C "Capability" "context_switch"
344 ,structField C "Capability" "interrupt"
345 ,structField C "Capability" "sparks"
346
347 ,structField Both "bdescr" "start"
348 ,structField Both "bdescr" "free"
349 ,structField Both "bdescr" "blocks"
350 ,structField C "bdescr" "gen_no"
351 ,structField C "bdescr" "link"
352
353 ,structSize C "generation"
354 ,structField C "generation" "n_new_large_words"
355 ,structField C "generation" "weak_ptr_list"
356
357 ,structSize Both "CostCentreStack"
358 ,structField C "CostCentreStack" "ccsID"
359 ,structFieldH Both "CostCentreStack" "mem_alloc"
360 ,structFieldH Both "CostCentreStack" "scc_count"
361 ,structField C "CostCentreStack" "prevStack"
362
363 ,structField C "CostCentre" "ccID"
364 ,structField C "CostCentre" "link"
365
366 ,structField C "StgHeader" "info"
367 ,structField_ Both "StgHeader_ccs" "StgHeader" "prof.ccs"
368 ,structField_ Both "StgHeader_ldvw" "StgHeader" "prof.hp.ldvw"
369
370 ,structSize Both "StgSMPThunkHeader"
371
372 ,closurePayload C "StgClosure" "payload"
373
374 ,structFieldH Both "StgEntCounter" "allocs"
375 ,structFieldH Both "StgEntCounter" "allocd"
376 ,structField Both "StgEntCounter" "registeredp"
377 ,structField Both "StgEntCounter" "link"
378 ,structField Both "StgEntCounter" "entry_count"
379
380 ,closureSize Both "StgUpdateFrame"
381 ,closureSize C "StgCatchFrame"
382 ,closureSize C "StgStopFrame"
383
384 ,closureSize Both "StgMutArrPtrs"
385 ,closureField Both "StgMutArrPtrs" "ptrs"
386 ,closureField Both "StgMutArrPtrs" "size"
387
388 ,closureSize Both "StgArrWords"
389 ,closureField C "StgArrWords" "bytes"
390 ,closurePayload C "StgArrWords" "payload"
391
392 ,closureField C "StgTSO" "_link"
393 ,closureField C "StgTSO" "global_link"
394 ,closureField C "StgTSO" "what_next"
395 ,closureField C "StgTSO" "why_blocked"
396 ,closureField C "StgTSO" "block_info"
397 ,closureField C "StgTSO" "blocked_exceptions"
398 ,closureField C "StgTSO" "id"
399 ,closureField C "StgTSO" "cap"
400 ,closureField C "StgTSO" "saved_errno"
401 ,closureField C "StgTSO" "trec"
402 ,closureField C "StgTSO" "flags"
403 ,closureField C "StgTSO" "dirty"
404 ,closureField C "StgTSO" "bq"
405 ,closureField_ Both "StgTSO_cccs" "StgTSO" "prof.cccs"
406 ,closureField Both "StgTSO" "stackobj"
407
408 ,closureField Both "StgStack" "sp"
409 ,closureFieldOffset Both "StgStack" "stack"
410 ,closureField C "StgStack" "stack_size"
411 ,closureField C "StgStack" "dirty"
412
413 ,structSize C "StgTSOProfInfo"
414
415 ,closureField Both "StgUpdateFrame" "updatee"
416
417 ,closureField C "StgCatchFrame" "handler"
418 ,closureField C "StgCatchFrame" "exceptions_blocked"
419
420 ,closureSize C "StgPAP"
421 ,closureField C "StgPAP" "n_args"
422 ,closureFieldGcptr C "StgPAP" "fun"
423 ,closureField C "StgPAP" "arity"
424 ,closurePayload C "StgPAP" "payload"
425
426 ,thunkSize C "StgAP"
427 ,closureField C "StgAP" "n_args"
428 ,closureFieldGcptr C "StgAP" "fun"
429 ,closurePayload C "StgAP" "payload"
430
431 ,thunkSize C "StgAP_STACK"
432 ,closureField C "StgAP_STACK" "size"
433 ,closureFieldGcptr C "StgAP_STACK" "fun"
434 ,closurePayload C "StgAP_STACK" "payload"
435
436 ,thunkSize C "StgSelector"
437
438 ,closureFieldGcptr C "StgInd" "indirectee"
439
440 ,closureSize C "StgMutVar"
441 ,closureField C "StgMutVar" "var"
442
443 ,closureSize C "StgAtomicallyFrame"
444 ,closureField C "StgAtomicallyFrame" "code"
445 ,closureField C "StgAtomicallyFrame" "next_invariant_to_check"
446 ,closureField C "StgAtomicallyFrame" "result"
447
448 ,closureField C "StgInvariantCheckQueue" "invariant"
449 ,closureField C "StgInvariantCheckQueue" "my_execution"
450 ,closureField C "StgInvariantCheckQueue" "next_queue_entry"
451
452 ,closureField C "StgAtomicInvariant" "code"
453
454 ,closureField C "StgTRecHeader" "enclosing_trec"
455
456 ,closureSize C "StgCatchSTMFrame"
457 ,closureField C "StgCatchSTMFrame" "handler"
458 ,closureField C "StgCatchSTMFrame" "code"
459
460 ,closureSize C "StgCatchRetryFrame"
461 ,closureField C "StgCatchRetryFrame" "running_alt_code"
462 ,closureField C "StgCatchRetryFrame" "first_code"
463 ,closureField C "StgCatchRetryFrame" "alt_code"
464
465 ,closureField C "StgTVarWatchQueue" "closure"
466 ,closureField C "StgTVarWatchQueue" "next_queue_entry"
467 ,closureField C "StgTVarWatchQueue" "prev_queue_entry"
468
469 ,closureSize C "StgTVar"
470 ,closureField C "StgTVar" "current_value"
471 ,closureField C "StgTVar" "first_watch_queue_entry"
472 ,closureField C "StgTVar" "num_updates"
473
474 ,closureSize C "StgWeak"
475 ,closureField C "StgWeak" "link"
476 ,closureField C "StgWeak" "key"
477 ,closureField C "StgWeak" "value"
478 ,closureField C "StgWeak" "finalizer"
479 ,closureField C "StgWeak" "cfinalizers"
480
481 ,closureSize C "StgCFinalizerList"
482 ,closureField C "StgCFinalizerList" "link"
483 ,closureField C "StgCFinalizerList" "fptr"
484 ,closureField C "StgCFinalizerList" "ptr"
485 ,closureField C "StgCFinalizerList" "eptr"
486 ,closureField C "StgCFinalizerList" "flag"
487
488 ,closureSize C "StgMVar"
489 ,closureField C "StgMVar" "head"
490 ,closureField C "StgMVar" "tail"
491 ,closureField C "StgMVar" "value"
492
493 ,closureSize C "StgMVarTSOQueue"
494 ,closureField C "StgMVarTSOQueue" "link"
495 ,closureField C "StgMVarTSOQueue" "tso"
496
497 ,closureSize C "StgBCO"
498 ,closureField C "StgBCO" "instrs"
499 ,closureField C "StgBCO" "literals"
500 ,closureField C "StgBCO" "ptrs"
501 ,closureField C "StgBCO" "arity"
502 ,closureField C "StgBCO" "size"
503 ,closurePayload C "StgBCO" "bitmap"
504
505 ,closureSize C "StgStableName"
506 ,closureField C "StgStableName" "sn"
507
508 ,closureSize C "StgBlockingQueue"
509 ,closureField C "StgBlockingQueue" "bh"
510 ,closureField C "StgBlockingQueue" "owner"
511 ,closureField C "StgBlockingQueue" "queue"
512 ,closureField C "StgBlockingQueue" "link"
513
514 ,closureSize C "MessageBlackHole"
515 ,closureField C "MessageBlackHole" "link"
516 ,closureField C "MessageBlackHole" "tso"
517 ,closureField C "MessageBlackHole" "bh"
518
519 ,structField_ C "RtsFlags_ProfFlags_showCCSOnException"
520 "RTS_FLAGS" "ProfFlags.showCCSOnException"
521 ,structField_ C "RtsFlags_DebugFlags_apply"
522 "RTS_FLAGS" "DebugFlags.apply"
523 ,structField_ C "RtsFlags_DebugFlags_sanity"
524 "RTS_FLAGS" "DebugFlags.sanity"
525 ,structField_ C "RtsFlags_DebugFlags_weak"
526 "RTS_FLAGS" "DebugFlags.weak"
527 ,structField_ C "RtsFlags_GcFlags_initialStkSize"
528 "RTS_FLAGS" "GcFlags.initialStkSize"
529 ,structField_ C "RtsFlags_MiscFlags_tickInterval"
530 "RTS_FLAGS" "MiscFlags.tickInterval"
531
532 ,structSize C "StgFunInfoExtraFwd"
533 ,structField C "StgFunInfoExtraFwd" "slow_apply"
534 ,structField C "StgFunInfoExtraFwd" "fun_type"
535 ,structField C "StgFunInfoExtraFwd" "arity"
536 ,structField_ C "StgFunInfoExtraFwd_bitmap" "StgFunInfoExtraFwd" "b.bitmap"
537
538 ,structSize Both "StgFunInfoExtraRev"
539 ,structField C "StgFunInfoExtraRev" "slow_apply_offset"
540 ,structField C "StgFunInfoExtraRev" "fun_type"
541 ,structField C "StgFunInfoExtraRev" "arity"
542 ,structField_ C "StgFunInfoExtraRev_bitmap" "StgFunInfoExtraRev" "b.bitmap"
543
544 ,structField C "StgLargeBitmap" "size"
545 ,fieldOffset C "StgLargeBitmap" "bitmap"
546
547 ,structSize C "snEntry"
548 ,structField C "snEntry" "sn_obj"
549 ,structField C "snEntry" "addr"
550
551 ,structSize C "spEntry"
552 ,structField C "spEntry" "addr"
553
554 -- Note that this conditional part only affects the C headers.
555 -- That's important, as it means we get the same PlatformConstants
556 -- type on all platforms.
557 ,if os == "mingw32"
558 then concat [structSize C "StgAsyncIOResult"
559 ,structField C "StgAsyncIOResult" "reqID"
560 ,structField C "StgAsyncIOResult" "len"
561 ,structField C "StgAsyncIOResult" "errCode"]
562 else []
563
564 -- pre-compiled thunk types
565 ,constantWord Haskell "MAX_SPEC_SELECTEE_SIZE" "MAX_SPEC_SELECTEE_SIZE"
566 ,constantWord Haskell "MAX_SPEC_AP_SIZE" "MAX_SPEC_AP_SIZE"
567
568 -- closure sizes: these do NOT include the header (see below for
569 -- header sizes)
570 ,constantWord Haskell "MIN_PAYLOAD_SIZE" "MIN_PAYLOAD_SIZE"
571
572 ,constantInt Haskell "MIN_INTLIKE" "MIN_INTLIKE"
573 ,constantWord Haskell "MAX_INTLIKE" "MAX_INTLIKE"
574
575 ,constantWord Haskell "MIN_CHARLIKE" "MIN_CHARLIKE"
576 ,constantWord Haskell "MAX_CHARLIKE" "MAX_CHARLIKE"
577
578 ,constantWord Haskell "MUT_ARR_PTRS_CARD_BITS" "MUT_ARR_PTRS_CARD_BITS"
579
580 -- A section of code-generator-related MAGIC CONSTANTS.
581 ,constantWord Haskell "MAX_Vanilla_REG" "MAX_VANILLA_REG"
582 ,constantWord Haskell "MAX_Float_REG" "MAX_FLOAT_REG"
583 ,constantWord Haskell "MAX_Double_REG" "MAX_DOUBLE_REG"
584 ,constantWord Haskell "MAX_Long_REG" "MAX_LONG_REG"
585 ,constantWord Haskell "MAX_XMM_REG" "MAX_XMM_REG"
586 ,constantWord Haskell "MAX_Real_Vanilla_REG" "MAX_REAL_VANILLA_REG"
587 ,constantWord Haskell "MAX_Real_Float_REG" "MAX_REAL_FLOAT_REG"
588 ,constantWord Haskell "MAX_Real_Double_REG" "MAX_REAL_DOUBLE_REG"
589 ,constantWord Haskell "MAX_Real_XMM_REG" "MAX_REAL_XMM_REG"
590 ,constantWord Haskell "MAX_Real_Long_REG" "MAX_REAL_LONG_REG"
591
592 -- This tells the native code generator the size of the spill
593 -- area is has available.
594 ,constantWord Haskell "RESERVED_C_STACK_BYTES" "RESERVED_C_STACK_BYTES"
595 -- The amount of (Haskell) stack to leave free for saving
596 -- registers when returning to the scheduler.
597 ,constantWord Haskell "RESERVED_STACK_WORDS" "RESERVED_STACK_WORDS"
598 -- Continuations that need more than this amount of stack
599 -- should do their own stack check (see bug #1466).
600 ,constantWord Haskell "AP_STACK_SPLIM" "AP_STACK_SPLIM"
601
602 -- Size of a word, in bytes
603 ,constantWord Haskell "WORD_SIZE" "SIZEOF_HSWORD"
604
605 -- Size of a double in StgWords.
606 ,constantWord Haskell "DOUBLE_SIZE" "SIZEOF_DOUBLE"
607
608 -- Size of a C int, in bytes. May be smaller than wORD_SIZE.
609 ,constantWord Haskell "CINT_SIZE" "SIZEOF_INT"
610 ,constantWord Haskell "CLONG_SIZE" "SIZEOF_LONG"
611 ,constantWord Haskell "CLONG_LONG_SIZE" "SIZEOF_LONG_LONG"
612
613 -- Number of bits to shift a bitfield left by in an info table.
614 ,constantWord Haskell "BITMAP_BITS_SHIFT" "BITMAP_BITS_SHIFT"
615
616 -- Amount of pointer bits used for semi-tagging constructor closures
617 ,constantWord Haskell "TAG_BITS" "TAG_BITS"
618
619 ,constantBool Haskell "WORDS_BIGENDIAN" "defined(WORDS_BIGENDIAN)"
620 ,constantBool Haskell "DYNAMIC_BY_DEFAULT" "defined(DYNAMIC_BY_DEFAULT)"
621
622 ,constantWord Haskell "LDV_SHIFT" "LDV_SHIFT"
623 ,constantNatural Haskell "ILDV_CREATE_MASK" "LDV_CREATE_MASK"
624 ,constantNatural Haskell "ILDV_STATE_CREATE" "LDV_STATE_CREATE"
625 ,constantNatural Haskell "ILDV_STATE_USE" "LDV_STATE_USE"
626 ]
627
628 getWanted :: Bool -> FilePath -> FilePath -> [String] -> FilePath -> IO Results
629 getWanted verbose tmpdir gccProgram gccFlags nmProgram
630 = do let cStuff = unlines (headers ++ concatMap (doWanted . snd) wanteds)
631 cFile = tmpdir </> "tmp.c"
632 oFile = tmpdir </> "tmp.o"
633 writeFile cFile cStuff
634 execute verbose gccProgram (gccFlags ++ ["-c", cFile, "-o", oFile])
635 xs <- readProcess nmProgram [oFile] ""
636 let ls = lines xs
637 ms = map parseNmLine ls
638 m = Map.fromList $ catMaybes ms
639 rs <- mapM (lookupResult m) wanteds
640 return rs
641 where headers = ["#define IN_STG_CODE 0",
642 "",
643 "/*",
644 " * We need offsets of profiled things...",
645 " * better be careful that this doesn't",
646 " * affect the offsets of anything else.",
647 " */",
648 "",
649 "#define PROFILING",
650 "#define THREADED_RTS",
651 "",
652 "#include \"PosixSource.h\"",
653 "#include \"Rts.h\"",
654 "#include \"Stable.h\"",
655 "#include \"Capability.h\"",
656 "",
657 "#include <inttypes.h>",
658 "#include <stddef.h>",
659 "#include <stdio.h>",
660 "#include <string.h>",
661 "",
662 "#define FIELD_SIZE(s_type, field) ((size_t)sizeof(((s_type*)0)->field))",
663 "#define TYPE_SIZE(type) (sizeof(type))",
664 "#define FUN_OFFSET(sym) (offsetof(Capability,f.sym) - offsetof(Capability,r))",
665 "",
666 "#pragma GCC poison sizeof"
667 ]
668
669 prefix = "derivedConstant"
670 mkFullName name = prefix ++ name
671
672 -- We add 1 to the value, as some platforms will make a symbol
673 -- of size 1 when for
674 -- char foo[0];
675 -- We then subtract 1 again when parsing.
676 doWanted (GetFieldType name (Fst (CExpr cExpr)))
677 = ["char " ++ mkFullName name ++ "[1 + " ++ cExpr ++ "];"]
678 doWanted (GetClosureSize name (Fst (CExpr cExpr)))
679 = ["char " ++ mkFullName name ++ "[1 + " ++ cExpr ++ "];"]
680 doWanted (GetWord name (Fst (CExpr cExpr)))
681 = ["char " ++ mkFullName name ++ "[1 + " ++ cExpr ++ "];"]
682 doWanted (GetInt name (Fst (CExpr cExpr)))
683 = ["char " ++ mkFullName name ++ "Mag[1 + ((intptr_t)(" ++ cExpr ++ ") >= 0 ? (" ++ cExpr ++ ") : -(" ++ cExpr ++ "))];",
684 "char " ++ mkFullName name ++ "Sig[(intptr_t)(" ++ cExpr ++ ") >= 0 ? 3 : 1];"]
685 doWanted (GetNatural name (Fst (CExpr cExpr)))
686 = -- These casts fix "right shift count >= width of type"
687 -- warnings
688 let cExpr' = "(uint64_t)(size_t)(" ++ cExpr ++ ")"
689 in ["char " ++ mkFullName name ++ "0[1 + ((" ++ cExpr' ++ ") & 0xFFFF)];",
690 "char " ++ mkFullName name ++ "1[1 + (((" ++ cExpr' ++ ") >> 16) & 0xFFFF)];",
691 "char " ++ mkFullName name ++ "2[1 + (((" ++ cExpr' ++ ") >> 32) & 0xFFFF)];",
692 "char " ++ mkFullName name ++ "3[1 + (((" ++ cExpr' ++ ") >> 48) & 0xFFFF)];"]
693 doWanted (GetBool name (Fst (CPPExpr cppExpr)))
694 = ["#if " ++ cppExpr,
695 "char " ++ mkFullName name ++ "[1];",
696 "#else",
697 "char " ++ mkFullName name ++ "[2];",
698 "#endif"]
699 doWanted (StructFieldMacro {}) = []
700 doWanted (ClosureFieldMacro {}) = []
701 doWanted (ClosurePayloadMacro {}) = []
702 doWanted (FieldTypeGcptrMacro {}) = []
703
704 -- parseNmLine parses nm output that looks like
705 -- "0000000b C derivedConstantMAX_Vanilla_REG"
706 -- and returns ("MAX_Vanilla_REG", 11)
707 parseNmLine xs0 = case break (' ' ==) xs0 of
708 (x1, ' ' : xs1) ->
709 case break (' ' ==) xs1 of
710 (x2, ' ' : x3) ->
711 case readHex x1 of
712 [(size, "")] ->
713 case x2 of
714 "C" ->
715 let x3' = case x3 of
716 '_' : rest -> rest
717 _ -> x3
718 in case stripPrefix prefix x3' of
719 Just name ->
720 Just (name, size)
721 _ -> Nothing
722 _ -> Nothing
723 _ -> Nothing
724 _ -> Nothing
725 _ -> Nothing
726
727 -- If an Int value is larger than 2^28 or smaller
728 -- than -2^28, then fail.
729 -- This test is a bit conservative, but if any
730 -- constants are roughly maxBound or minBound then
731 -- we probably need them to be Integer rather than
732 -- Int so that -- cross-compiling between 32bit and
733 -- 64bit platforms works.
734 lookupSmall :: Map String Integer -> Name -> IO Integer
735 lookupSmall m name
736 = case Map.lookup name m of
737 Just v
738 | v > 2^(28 :: Int) ||
739 v < -(2^(28 :: Int)) ->
740 die ("Value too large for GetWord: " ++ show v)
741 | otherwise -> return v
742 Nothing -> die ("Can't find " ++ show name)
743
744 lookupResult :: Map String Integer -> (Where, What Fst)
745 -> IO (Where, What Snd)
746 lookupResult m (w, GetWord name _)
747 = do v <- lookupSmall m name
748 return (w, GetWord name (Snd (v - 1)))
749 lookupResult m (w, GetInt name _)
750 = do mag <- lookupSmall m (name ++ "Mag")
751 sig <- lookupSmall m (name ++ "Sig")
752 return (w, GetWord name (Snd ((mag - 1) * (sig - 2))))
753 lookupResult m (w, GetNatural name _)
754 = do v0 <- lookupSmall m (name ++ "0")
755 v1 <- lookupSmall m (name ++ "1")
756 v2 <- lookupSmall m (name ++ "2")
757 v3 <- lookupSmall m (name ++ "3")
758 let v = (v0 - 1)
759 + shiftL (v1 - 1) 16
760 + shiftL (v2 - 1) 32
761 + shiftL (v3 - 1) 48
762 return (w, GetWord name (Snd v))
763 lookupResult m (w, GetBool name _)
764 = do v <- lookupSmall m name
765 case v of
766 1 -> return (w, GetBool name (Snd True))
767 2 -> return (w, GetBool name (Snd False))
768 _ -> die ("Bad boolean: " ++ show v)
769 lookupResult m (w, GetFieldType name _)
770 = do v <- lookupSmall m name
771 return (w, GetFieldType name (Snd (v - 1)))
772 lookupResult m (w, GetClosureSize name _)
773 = do v <- lookupSmall m name
774 return (w, GetClosureSize name (Snd (v - 1)))
775 lookupResult _ (w, StructFieldMacro name)
776 = return (w, StructFieldMacro name)
777 lookupResult _ (w, ClosureFieldMacro name)
778 = return (w, ClosureFieldMacro name)
779 lookupResult _ (w, ClosurePayloadMacro name)
780 = return (w, ClosurePayloadMacro name)
781 lookupResult _ (w, FieldTypeGcptrMacro name)
782 = return (w, FieldTypeGcptrMacro name)
783
784 writeHaskellType :: FilePath -> [What Fst] -> IO ()
785 writeHaskellType fn ws = writeFile fn xs
786 where xs = unlines (headers ++ body ++ footers)
787 headers = ["data PlatformConstants = PlatformConstants {"
788 -- Now a kludge that allows the real entries to
789 -- all start with a comma, which makes life a
790 -- little easier
791 ," pc_platformConstants :: ()"]
792 footers = [" } deriving Read"]
793 body = concatMap doWhat ws
794 doWhat (GetClosureSize name _) = [" , pc_" ++ name ++ " :: Int"]
795 doWhat (GetFieldType name _) = [" , pc_" ++ name ++ " :: Int"]
796 doWhat (GetWord name _) = [" , pc_" ++ name ++ " :: Int"]
797 doWhat (GetInt name _) = [" , pc_" ++ name ++ " :: Int"]
798 doWhat (GetNatural name _) = [" , pc_" ++ name ++ " :: Integer"]
799 doWhat (GetBool name _) = [" , pc_" ++ name ++ " :: Bool"]
800 doWhat (StructFieldMacro {}) = []
801 doWhat (ClosureFieldMacro {}) = []
802 doWhat (ClosurePayloadMacro {}) = []
803 doWhat (FieldTypeGcptrMacro {}) = []
804
805 writeHaskellValue :: FilePath -> [What Snd] -> IO ()
806 writeHaskellValue fn rs = writeFile fn xs
807 where xs = unlines (headers ++ body ++ footers)
808 headers = ["PlatformConstants {"
809 ," pc_platformConstants = ()"]
810 footers = [" }"]
811 body = concatMap doWhat rs
812 doWhat (GetClosureSize name (Snd v)) = [" , pc_" ++ name ++ " = " ++ show v]
813 doWhat (GetFieldType name (Snd v)) = [" , pc_" ++ name ++ " = " ++ show v]
814 doWhat (GetWord name (Snd v)) = [" , pc_" ++ name ++ " = " ++ show v]
815 doWhat (GetInt name (Snd v)) = [" , pc_" ++ name ++ " = " ++ show v]
816 doWhat (GetNatural name (Snd v)) = [" , pc_" ++ name ++ " = " ++ show v]
817 doWhat (GetBool name (Snd v)) = [" , pc_" ++ name ++ " = " ++ show v]
818 doWhat (StructFieldMacro {}) = []
819 doWhat (ClosureFieldMacro {}) = []
820 doWhat (ClosurePayloadMacro {}) = []
821 doWhat (FieldTypeGcptrMacro {}) = []
822
823 writeHaskellWrappers :: FilePath -> [What Fst] -> IO ()
824 writeHaskellWrappers fn ws = writeFile fn xs
825 where xs = unlines body
826 body = concatMap doWhat ws
827 doWhat (GetFieldType {}) = []
828 doWhat (GetClosureSize {}) = []
829 doWhat (GetWord name _) = [haskellise name ++ " :: DynFlags -> Int",
830 haskellise name ++ " dflags = pc_" ++ name ++ " (sPlatformConstants (settings dflags))"]
831 doWhat (GetInt name _) = [haskellise name ++ " :: DynFlags -> Int",
832 haskellise name ++ " dflags = pc_" ++ name ++ " (sPlatformConstants (settings dflags))"]
833 doWhat (GetNatural name _) = [haskellise name ++ " :: DynFlags -> Integer",
834 haskellise name ++ " dflags = pc_" ++ name ++ " (sPlatformConstants (settings dflags))"]
835 doWhat (GetBool name _) = [haskellise name ++ " :: DynFlags -> Bool",
836 haskellise name ++ " dflags = pc_" ++ name ++ " (sPlatformConstants (settings dflags))"]
837 doWhat (StructFieldMacro {}) = []
838 doWhat (ClosureFieldMacro {}) = []
839 doWhat (ClosurePayloadMacro {}) = []
840 doWhat (FieldTypeGcptrMacro {}) = []
841
842 writeHaskellExports :: FilePath -> [What Fst] -> IO ()
843 writeHaskellExports fn ws = writeFile fn xs
844 where xs = unlines body
845 body = concatMap doWhat ws
846 doWhat (GetFieldType {}) = []
847 doWhat (GetClosureSize {}) = []
848 doWhat (GetWord name _) = [" " ++ haskellise name ++ ","]
849 doWhat (GetInt name _) = [" " ++ haskellise name ++ ","]
850 doWhat (GetNatural name _) = [" " ++ haskellise name ++ ","]
851 doWhat (GetBool name _) = [" " ++ haskellise name ++ ","]
852 doWhat (StructFieldMacro {}) = []
853 doWhat (ClosureFieldMacro {}) = []
854 doWhat (ClosurePayloadMacro {}) = []
855 doWhat (FieldTypeGcptrMacro {}) = []
856
857 writeHeader :: FilePath -> [What Snd] -> IO ()
858 writeHeader fn rs = writeFile fn xs
859 where xs = unlines (headers ++ body)
860 headers = ["/* This file is created automatically. Do not edit by hand.*/", ""]
861 body = concatMap doWhat rs
862 doWhat (GetFieldType name (Snd v)) = ["#define " ++ name ++ " b" ++ show (v * 8)]
863 doWhat (GetClosureSize name (Snd v)) = ["#define " ++ name ++ " (SIZEOF_StgHeader+" ++ show v ++ ")"]
864 doWhat (GetWord name (Snd v)) = ["#define " ++ name ++ " " ++ show v]
865 doWhat (GetInt name (Snd v)) = ["#define " ++ name ++ " " ++ show v]
866 doWhat (GetNatural name (Snd v)) = ["#define " ++ name ++ " " ++ show v]
867 doWhat (GetBool name (Snd v)) = ["#define " ++ name ++ " " ++ show (fromEnum v)]
868 doWhat (StructFieldMacro nameBase) =
869 ["#define " ++ nameBase ++ "(__ptr__) REP_" ++ nameBase ++ "[__ptr__+OFFSET_" ++ nameBase ++ "]"]
870 doWhat (ClosureFieldMacro nameBase) =
871 ["#define " ++ nameBase ++ "(__ptr__) REP_" ++ nameBase ++ "[__ptr__+SIZEOF_StgHeader+OFFSET_" ++ nameBase ++ "]"]
872 doWhat (ClosurePayloadMacro nameBase) =
873 ["#define " ++ nameBase ++ "(__ptr__,__ix__) W_[__ptr__+SIZEOF_StgHeader+OFFSET_" ++ nameBase ++ " + WDS(__ix__)]"]
874 doWhat (FieldTypeGcptrMacro nameBase) =
875 ["#define REP_" ++ nameBase ++ " gcptr"]
876
877 die :: String -> IO a
878 die err = do hPutStrLn stderr err
879 exitFailure
880
881 execute :: Bool -> FilePath -> [String] -> IO ()
882 execute verbose prog args
883 = do when verbose $ putStrLn $ showCommandForUser prog args
884 ec <- rawSystem prog args
885 unless (ec == ExitSuccess) $
886 die ("Executing " ++ show prog ++ " failed")
887