ghc-9.6.3: The GHC API
Safe HaskellSafe-Inferred




data CLabel Source #

CLabel is an abstract type that supports the following operations:

  • Pretty printing
  • In a C file, does it need to be declared before use? (i.e. is it guaranteed to be already in scope in the places we need to refer to it?)
  • If it needs to be declared, what type (code or data) should it be declared to have?
  • Is it visible outside this object file or not?
  • Is it "dynamic" (see details below)
  • Eq and Ord, so that we can make sets of CLabels (currently only used in outputting C as far as I can tell, to avoid generating more than one declaration for any given label).
  • Converting an info table label into an entry label.

CLabel usage is a bit messy in GHC as they are used in a number of different contexts:

  • By the C-- AST to identify labels
  • By the unregisterised C code generator ("PprC") for naming functions (hence the name CLabel)
  • By the native and LLVM code generators to identify labels

For extra fun, each of these uses a slightly different subset of constructors (e.g. AsmTempLabel and AsmTempDerivedLabel are used only in the NCG and LLVM backends).

In general, we use IdLabel to represent Haskell things early in the pipeline. However, later optimization passes will often represent blocks they create with LocalBlockLabel where there is no obvious Name to hang off the label.


Instances details
Show CLabel Source # 
Instance details

Defined in GHC.Cmm.CLabel

Eq CLabel Source # 
Instance details

Defined in GHC.Cmm.CLabel


(==) :: CLabel -> CLabel -> Bool #

(/=) :: CLabel -> CLabel -> Bool #

Ord CLabel Source # 
Instance details

Defined in GHC.Cmm.CLabel

OutputableP Platform CLabel Source # 
Instance details

Defined in GHC.Cmm.CLabel


pdoc :: Platform -> CLabel -> SDoc Source #

newtype NeedExternDecl Source #

Indicate if GHC.CmmToC has to generate an extern declaration for the label (e.g. "extern StgWordArray(foo)"). The type is fixed to StgWordArray.

Symbols from the RTS don't need "extern" declarations because they are exposed via "rtsincludeStg.h" with the appropriate type. See needsCDecl.

The fixed StgWordArray type led to "conflicting types" issues with user provided Cmm files (not in the RTS) that declare data of another type (#15467 and test for #17920). Hence the Cmm parser considers that labels in data sections don't need the "extern" declaration (just add one explicitly if you need it).

See for why extern declaration are needed at all.


NeedExternDecl Bool 

data ForeignLabelSource Source #

Record where a foreign label is stored.


ForeignLabelInPackage UnitId

Label is in a named package


Label is in some external, system package that doesn't also contain compiled Haskell code, and is not associated with any .hi files. We don't have to worry about Haskell code being inlined from external packages. It is safe to treat the RTS package as "external".


Label is in the package currently being compiled. This is only used for creating hacky tmp labels during code generation. Don't use it in any code that might be inlined across a package boundary (ie, core code) else the information will be wrong relative to the destination module.


mkInfoTableLabel :: Name -> CafInfo -> CLabel Source #

Decides between external and local labels based on the names externality.

mkAsmTempProcEndLabel :: CLabel -> CLabel Source #

A label indicating the end of a procedure.

mkAsmTempDieLabel :: CLabel -> CLabel Source #

Construct a label for a DWARF Debug Information Entity (DIE) describing another symbol.

mkRtsUnpackCStringLabel :: CLabel Source #

A standard string unpacking thunk. See Note [unpack_cstring closures] in StgStdThunks.cmm.

mkRtsUnpackCStringUtf8Label :: CLabel Source #

A standard string unpacking thunk. See Note [unpack_cstring closures] in StgStdThunks.cmm.

data InfoProvEnt Source #

Info Table Provenance Entry See Note [Mapping Info Tables to Source Positions]


maybeLocalBlockLabel :: CLabel -> Maybe BlockId Source #

If a label is a local block label then return just its BlockId, otherwise Nothing.

externallyVisibleCLabel :: CLabel -> Bool Source #

Is a CLabel visible outside this object file or not? From the point of view of the code generator, a name is externally visible if it has to be declared as exported in the .o file's symbol table; that is, made non-static.

isMathFun :: CLabel -> Bool Source #

Check whether a label corresponds to a C function that has a prototype in a system header somewhere, or is built-in to the C compiler. For these labels we avoid generating our own C prototypes.

labelDynamic :: Module -> Platform -> Bool -> CLabel -> Bool Source #

Does a CLabel need dynamic linkage?

When referring to data in code, we need to know whether that data resides in a DLL or not. [Win32 only.] labelDynamic returns True if the label is located in a DLL, be it a data reference or not.

isLocalCLabel :: Module -> CLabel -> Bool Source #

Is a CLabel defined in the current module being compiled?

Sometimes we can optimise references within a compilation unit in ways that we couldn't for inter-module references. This provides a conservative estimate of whether a CLabel lives in the current module.

isInfoTableLabel :: CLabel -> Bool Source #

Whether label is points to some kind of info table

isCmmInfoTableLabel :: CLabel -> Bool Source #

Whether label points to an info table defined in Cmm

isConInfoTableLabel :: CLabel -> Bool Source #

Whether label is points to constructor info table

hasIdLabelInfo :: CLabel -> Maybe IdLabelInfo Source #

isBytesLabel :: CLabel -> Bool Source #

Whether label is a top-level string literal

isForeignLabel :: CLabel -> Bool Source #

Whether label is a non-haskell label (defined in C code)

isSomeRODataLabel :: CLabel -> Bool Source #

Whether label is a .rodata label

isStaticClosureLabel :: CLabel -> Bool Source #

Whether label is a static closure label (can come from haskell or cmm)



data LabelStyle Source #

Style of label pretty-printing.

When we produce C sources or headers, we have to take into account that C compilers transform C labels when they convert them into symbols. For example, they can add prefixes (e.g., "_" on Darwin) or suffixes (size for stdcalls on Windows). So we provide two ways to pretty-print CLabels: C style or Asm style.



C label style (used by C and LLVM backends)


Asm label style (used by NCG backend)

pprDebugCLabel :: Platform -> CLabel -> SDoc Source #

For debugging problems with the CLabel representation. We can't make a Show instance for CLabel because lots of its components don't have instances. The regular Outputable instance only shows the label name, and not its other info.

pprCLabel :: IsLine doc => Platform -> CLabel -> doc Source #

ppInternalProcLabel Source #


:: IsLine doc 
=> Module

the current module

-> CLabel 
-> Maybe doc

the internal proc label

Generate a label for a procedure internal to a module (if Opt_ExposeAllSymbols is enabled). See Note [Internal proc labels].


addLabelSize :: CLabel -> Int -> CLabel Source #

Update the label size field in a ForeignLabel

foreignLabelStdcallInfo :: CLabel -> Maybe Int Source #

Get the label size field from a ForeignLabel