2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 % $Id: CLabel.lhs,v 1.41 2000/11/06 08:15:20 simonpj Exp $
6 \section[CLabel]{@CLabel@: Information to make C Labels}
10 CLabel, -- abstract type
18 mkStaticConEntryLabel,
21 mkStaticInfoTableLabel,
48 mkCharlikeClosureLabel,
49 mkIntlikeClosureLabel,
50 mkMAP_FROZEN_infoLabel,
53 mkBlackHoleInfoTableLabel,
54 mkCAFBlackHoleInfoTableLabel,
55 mkSECAFBlackHoleInfoTableLabel,
65 mkCC_Label, mkCCS_Label,
67 needsCDecl, isAsmTemp, externallyVisibleCLabel,
69 CLabelType(..), labelType, labelDynamic,
72 #if ! OMIT_NATIVE_CODEGEN
78 #include "HsVersions.h"
80 #if ! OMIT_NATIVE_CODEGEN
81 import {-# SOURCE #-} MachMisc ( underscorePrefix, fmtAsmLbl )
84 import CmdLineOpts ( opt_Static, opt_DoTickyProfiling )
85 import CStrings ( pp_cSEP )
86 import DataCon ( ConTag )
87 import Module ( moduleName, moduleNameFS,
88 Module, isModuleInThisPackage )
89 import Name ( Name, getName, isDllName, isExternallyVisibleName )
90 import TyCon ( TyCon )
91 import Unique ( pprUnique, Unique )
92 import PrimOp ( PrimOp, pprPrimOp )
93 import CostCentre ( CostCentre, CostCentreStack )
97 things we want to find out:
99 * should the labelled things be declared "static" (visible only in this file)?
101 * should it be declared "const" (read-only text space)?
103 * does it need declarations at all? (v common Prelude things are pre-declared)
105 * what type does it have? (for generating accurate enough C declarations
106 so that the C compiler won't complain).
110 = IdLabel -- A family of labels related to the
111 Name -- definition of a particular Id
114 | DataConLabel -- Ditto data constructors
118 | CaseLabel -- A family of labels related to a particular case expression
119 Unique -- Unique says which case expression
122 | TyConLabel TyCon -- currently only one kind of TyconLabel,
123 -- a 'Closure Table'.
125 | AsmTempLabel Unique
127 | ModuleInitLabel Module
129 | RtsLabel RtsLabelInfo
131 | ForeignLabel FAST_STRING Bool -- a 'C' (or otherwise foreign) label
132 -- Bool <=> is dynamic
134 | CC_Label CostCentre
135 | CCS_Label CostCentreStack
142 = Closure -- Label for (static???) closure
144 | SRT -- Static reference table
146 | InfoTbl -- Info table for a closure; always read-only
148 | EntryStd -- Thunk, or "slow", code entry point
150 | EntryFast Int -- entry pt when no arg satisfaction chk needed;
151 -- Int is the arity of the function (to be
152 -- encoded into the name)
154 -- Ticky-ticky counting
155 | RednCounts -- Label of place to keep reduction-count info for
159 data DataConLabelInfo
160 = ConEntry -- the only kind of entry pt for constructors
161 | ConInfoTbl -- corresponding info table
162 | StaticConEntry -- static constructor entry point
163 | StaticInfoTbl -- corresponding info table
176 = RtsShouldNeverHappenCode
178 | RtsBlackHoleInfoTbl FAST_STRING -- black hole with info table name
180 | RtsUpdInfo -- upd_frame_info
181 | RtsSeqInfo -- seq_frame_info
182 | RtsGCEntryLabel String -- a heap check fail handler, eg stg_chk_2
183 | RtsMainRegTable -- MainRegTable (??? Capabilities wurble ???)
184 | Rts_Closure String -- misc rts closures, eg CHARLIKE_closure
185 | Rts_Info String -- misc rts itbls, eg MUT_ARR_PTRS_FROZEN_info
186 | Rts_Code String -- misc rts code
188 | RtsSelectorInfoTbl Bool{-updatable-} Int{-offset-} -- Selector thunks
189 | RtsSelectorEntry Bool{-updatable-} Int{-offset-}
191 | RtsApInfoTbl Bool{-updatable-} Int{-arity-} -- AP thunks
192 | RtsApEntry Bool{-updatable-} Int{-arity-}
202 -- Label Type: for generating C declarations.
214 mkClosureLabel id = IdLabel id Closure
215 mkSRTLabel id = IdLabel id SRT
216 mkInfoTableLabel id = IdLabel id InfoTbl
217 mkStdEntryLabel id = IdLabel id EntryStd
218 mkFastEntryLabel id arity = ASSERT(arity > 0)
219 IdLabel id (EntryFast arity)
221 mkRednCountsLabel id = IdLabel id RednCounts
223 mkStaticInfoTableLabel con = DataConLabel con StaticInfoTbl
224 mkConInfoTableLabel con = DataConLabel con ConInfoTbl
225 mkConEntryLabel con = DataConLabel con ConEntry
226 mkStaticConEntryLabel con = DataConLabel con StaticConEntry
229 mkReturnPtLabel uniq = CaseLabel uniq CaseReturnPt
230 mkReturnInfoLabel uniq = CaseLabel uniq CaseReturnInfo
231 mkVecTblLabel uniq = CaseLabel uniq CaseVecTbl
232 mkAltLabel uniq tag = CaseLabel uniq (CaseAlt tag)
233 mkDefaultLabel uniq = CaseLabel uniq CaseDefault
234 mkBitmapLabel uniq = CaseLabel uniq CaseBitmap
236 mkClosureTblLabel tycon = TyConLabel tycon
238 mkAsmTempLabel = AsmTempLabel
240 mkModuleInitLabel = ModuleInitLabel
242 -- Some fixed runtime system labels
244 mkErrorStdEntryLabel = RtsLabel RtsShouldNeverHappenCode
245 mkStgUpdatePAPLabel = RtsLabel (Rts_Code "stg_update_PAP")
246 mkSplitMarkerLabel = RtsLabel (Rts_Code "__stg_split_marker")
247 mkUpdInfoLabel = RtsLabel RtsUpdInfo
248 mkSeqInfoLabel = RtsLabel RtsSeqInfo
249 mkIndInfoLabel = RtsLabel (Rts_Info "IND_info")
250 mkIndStaticInfoLabel = RtsLabel (Rts_Info "IND_STATIC_info")
251 mkRtsGCEntryLabel str = RtsLabel (RtsGCEntryLabel str)
252 mkMainRegTableLabel = RtsLabel RtsMainRegTable
253 mkCharlikeClosureLabel = RtsLabel (Rts_Closure "CHARLIKE_closure")
254 mkIntlikeClosureLabel = RtsLabel (Rts_Closure "INTLIKE_closure")
255 mkMAP_FROZEN_infoLabel = RtsLabel (Rts_Info "MUT_ARR_PTRS_FROZEN_info")
257 mkTopTickyCtrLabel = RtsLabel RtsTopTickyCtr
258 mkBlackHoleInfoTableLabel = RtsLabel (RtsBlackHoleInfoTbl SLIT("BLACKHOLE_info"))
259 mkCAFBlackHoleInfoTableLabel = RtsLabel (RtsBlackHoleInfoTbl SLIT("CAF_BLACKHOLE_info"))
260 mkSECAFBlackHoleInfoTableLabel = if opt_DoTickyProfiling then
261 RtsLabel (RtsBlackHoleInfoTbl SLIT("SE_CAF_BLACKHOLE_info"))
262 else -- RTS won't have info table unless -ticky is on
263 panic "mkSECAFBlackHoleInfoTableLabel requires -ticky"
264 mkRtsPrimOpLabel primop = RtsLabel (RtsPrimOp primop)
266 moduleRegdLabel = RtsLabel RtsModuleRegd
268 mkSelectorInfoLabel upd off = RtsLabel (RtsSelectorInfoTbl upd off)
269 mkSelectorEntryLabel upd off = RtsLabel (RtsSelectorEntry upd off)
271 mkApInfoTableLabel upd off = RtsLabel (RtsApInfoTbl upd off)
272 mkApEntryLabel upd off = RtsLabel (RtsApEntry upd off)
276 mkForeignLabel :: FAST_STRING -> Bool -> CLabel
277 mkForeignLabel str is_dynamic = ForeignLabel str is_dynamic
281 mkCC_Label cc = CC_Label cc
282 mkCCS_Label ccs = CCS_Label ccs
286 needsCDecl :: CLabel -> Bool -- False <=> it's pre-declared; don't bother
287 isAsmTemp :: CLabel -> Bool -- is a local temporary for native code generation
288 externallyVisibleCLabel :: CLabel -> Bool -- not C "static"
291 @needsCDecl@ is @True@ unless the thing is a deeply-@PreludeCore@-ish
292 object. {\em Also:} No need to spit out labels for things generated
293 by the flattener (in @AbsCUtils@)---it is careful to ensure references
294 to them are always backwards. These are return-point and vector-table
297 Declarations for (non-prelude) @Id@-based things are needed because of
300 Declarations for direct return points are needed, because they may be
301 let-no-escapes, which can be recursive.
304 needsCDecl (IdLabel _ _) = True
305 needsCDecl (CaseLabel _ CaseReturnPt) = True
306 needsCDecl (DataConLabel _ _) = True
307 needsCDecl (TyConLabel _) = True
308 needsCDecl (ModuleInitLabel _) = True
310 needsCDecl (CaseLabel _ _) = False
311 needsCDecl (AsmTempLabel _) = False
312 needsCDecl (RtsLabel _) = False
313 needsCDecl (ForeignLabel _ _) = False
314 needsCDecl (CC_Label _) = False
315 needsCDecl (CCS_Label _) = False
318 Whether the label is an assembler temporary:
321 isAsmTemp (AsmTempLabel _) = True
325 C ``static'' or not...
326 From the point of view of the code generator, a name is
327 externally visible if it has to be declared as exported
328 in the .o file's symbol table; that is, made non-static.
331 externallyVisibleCLabel (DataConLabel _ _) = True
332 externallyVisibleCLabel (TyConLabel tc) = True
333 externallyVisibleCLabel (CaseLabel _ _) = False
334 externallyVisibleCLabel (AsmTempLabel _) = False
335 externallyVisibleCLabel (ModuleInitLabel _)= True
336 externallyVisibleCLabel (RtsLabel RtsModuleRegd) = False --hack
337 externallyVisibleCLabel (RtsLabel _) = True
338 externallyVisibleCLabel (ForeignLabel _ _) = True
339 externallyVisibleCLabel (IdLabel id _) = isExternallyVisibleName id
340 externallyVisibleCLabel (CC_Label _) = False -- not strictly true
341 externallyVisibleCLabel (CCS_Label _) = False -- not strictly true
344 For generating correct types in label declarations...
347 labelType :: CLabel -> CLabelType
348 labelType (RtsLabel (RtsBlackHoleInfoTbl _)) = InfoTblType
349 labelType (RtsLabel (RtsSelectorInfoTbl _ _)) = InfoTblType
350 labelType (RtsLabel (RtsApInfoTbl _ _)) = InfoTblType
351 labelType (RtsLabel RtsUpdInfo) = InfoTblType
352 labelType (CaseLabel _ CaseReturnInfo) = InfoTblType
353 labelType (CaseLabel _ CaseReturnPt) = CodeType
354 labelType (CaseLabel _ CaseVecTbl) = VecTblType
355 labelType (TyConLabel _) = ClosureTblType
356 labelType (ModuleInitLabel _ ) = CodeType
358 labelType (IdLabel _ info) =
360 InfoTbl -> InfoTblType
361 Closure -> ClosureType
364 labelType (DataConLabel _ info) =
366 ConInfoTbl -> InfoTblType
367 StaticInfoTbl -> InfoTblType
370 labelType _ = DataType
373 When referring to data in code, we need to know whether
374 that data resides in a DLL or not. [Win32 only.]
375 @labelDynamic@ returns @True@ if the label is located
376 in a DLL, be it a data reference or not.
379 labelDynamic :: CLabel -> Bool
382 -- The special case for RtsShouldNeverHappenCode is because the associated address is
383 -- NULL, i.e. not a DLL entry point
384 RtsLabel RtsShouldNeverHappenCode -> False
385 RtsLabel _ -> not opt_Static -- i.e., is the RTS in a DLL or not?
386 IdLabel n k -> isDllName n
387 DataConLabel n k -> isDllName n
388 TyConLabel tc -> isDllName (getName tc)
389 ForeignLabel _ d -> d
390 ModuleInitLabel m -> (not opt_Static) && (not (isModuleInThisPackage m))
395 OLD?: These GRAN functions are needed for spitting out GRAN_FETCH() at the
396 right places. It is used to detect when the abstractC statement of an
397 CCodeBlock actually contains the code for a slow entry point. -- HWL
399 We need at least @Eq@ for @CLabels@, because we want to avoid
400 duplicate declarations in generating C (see @labelSeenTE@ in
403 -----------------------------------------------------------------------------
404 Printing out CLabels.
410 where <name> is <Module>_<name> for external names and <unique> for
411 internal names. <type> is one of the following:
414 srt Static reference table
416 ret Direct return address
418 <n>_alt Case alternative (tag n)
419 dflt Default case alternative
420 btm Large bitmap vector
421 closure Static closure
422 con_entry Dynamic Constructor entry code
423 con_info Dynamic Constructor info table
424 static_entry Static Constructor entry code
425 static_info Static Constructor info table
426 sel_info Selector info table
427 sel_entry Selector entry code
429 ccs Cost centre stack
432 -- specialised for PprAsm: saves lots of arg passing in NCG
433 #if ! OMIT_NATIVE_CODEGEN
434 pprCLabel_asm = pprCLabel
437 pprCLabel :: CLabel -> SDoc
439 #if ! OMIT_NATIVE_CODEGEN
440 pprCLabel (AsmTempLabel u)
441 = text (fmtAsmLbl (show u))
445 #if ! OMIT_NATIVE_CODEGEN
446 getPprStyle $ \ sty ->
447 if asmStyle sty && underscorePrefix then
448 pp_cSEP <> pprCLbl lbl
453 pprCLbl (CaseLabel u CaseReturnPt)
454 = hcat [pprUnique u, pp_cSEP, ptext SLIT("ret")]
455 pprCLbl (CaseLabel u CaseReturnInfo)
456 = hcat [pprUnique u, pp_cSEP, ptext SLIT("info")]
457 pprCLbl (CaseLabel u CaseVecTbl)
458 = hcat [pprUnique u, pp_cSEP, ptext SLIT("vtbl")]
459 pprCLbl (CaseLabel u (CaseAlt tag))
460 = hcat [pprUnique u, pp_cSEP, int tag, pp_cSEP, ptext SLIT("alt")]
461 pprCLbl (CaseLabel u CaseDefault)
462 = hcat [pprUnique u, pp_cSEP, ptext SLIT("dflt")]
463 pprCLbl (CaseLabel u CaseBitmap)
464 = hcat [pprUnique u, pp_cSEP, ptext SLIT("btm")]
466 pprCLbl (RtsLabel RtsShouldNeverHappenCode) = ptext SLIT("NULL")
467 -- used to be stg_error_entry but Windows can't have DLL entry points as static
468 -- initialisers, and besides, this ShouldNeverHappen, right?
470 pprCLbl (RtsLabel RtsUpdInfo) = ptext SLIT("upd_frame_info")
471 pprCLbl (RtsLabel RtsSeqInfo) = ptext SLIT("seq_frame_info")
472 pprCLbl (RtsLabel RtsMainRegTable) = ptext SLIT("MainRegTable")
473 pprCLbl (RtsLabel (RtsGCEntryLabel str)) = text str
474 pprCLbl (RtsLabel (Rts_Closure str)) = text str
475 pprCLbl (RtsLabel (Rts_Info str)) = text str
476 pprCLbl (RtsLabel (Rts_Code str)) = text str
478 pprCLbl (RtsLabel RtsTopTickyCtr) = ptext SLIT("top_ct")
480 pprCLbl (RtsLabel (RtsBlackHoleInfoTbl info)) = ptext info
482 pprCLbl (RtsLabel (RtsSelectorInfoTbl upd_reqd offset))
483 = hcat [ptext SLIT("__sel_"), text (show offset),
485 then SLIT("_upd_info")
486 else SLIT("_noupd_info"))
489 pprCLbl (RtsLabel (RtsSelectorEntry upd_reqd offset))
490 = hcat [ptext SLIT("__sel_"), text (show offset),
492 then SLIT("_upd_entry")
493 else SLIT("_noupd_entry"))
496 pprCLbl (RtsLabel (RtsApInfoTbl upd_reqd arity))
497 = hcat [ptext SLIT("__ap_"), text (show arity),
499 then SLIT("_upd_info")
500 else SLIT("_noupd_info"))
503 pprCLbl (RtsLabel (RtsApEntry upd_reqd arity))
504 = hcat [ptext SLIT("__ap_"), text (show arity),
506 then SLIT("_upd_entry")
507 else SLIT("_noupd_entry"))
510 pprCLbl (RtsLabel (RtsPrimOp primop))
511 = pprPrimOp primop <> ptext SLIT("_fast")
513 pprCLbl (RtsLabel RtsModuleRegd)
514 = ptext SLIT("module_registered")
516 pprCLbl (ForeignLabel str _)
519 pprCLbl (TyConLabel tc)
520 = hcat [ppr tc, pp_cSEP, ptext SLIT("closure_tbl")]
522 pprCLbl (IdLabel id flavor) = ppr id <> ppIdFlavor flavor
523 pprCLbl (DataConLabel con flavor) = ppr con <> ppConFlavor flavor
525 pprCLbl (CC_Label cc) = ppr cc
526 pprCLbl (CCS_Label ccs) = ppr ccs
528 pprCLbl (ModuleInitLabel mod)
529 = ptext SLIT("__init_") <> ptext (moduleNameFS (moduleName mod))
531 ppIdFlavor :: IdLabelInfo -> SDoc
533 ppIdFlavor x = pp_cSEP <>
535 Closure -> ptext SLIT("closure")
536 SRT -> ptext SLIT("srt")
537 InfoTbl -> ptext SLIT("info")
538 EntryStd -> ptext SLIT("entry")
539 EntryFast arity -> --false:ASSERT (arity > 0)
540 (<>) (ptext SLIT("fast")) (int arity)
541 RednCounts -> ptext SLIT("ct")
544 ppConFlavor x = pp_cSEP <>
546 ConEntry -> ptext SLIT("con_entry")
547 ConInfoTbl -> ptext SLIT("con_info")
548 StaticConEntry -> ptext SLIT("static_entry")
549 StaticInfoTbl -> ptext SLIT("static_info")