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