HORIZON HASKELLDocslts/ghc-9.10.x248f8f02026-10-05Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · 248f8f0 · 2026-10-05

Moduleghc-9.10.3GHC2021

GHC.Llvm.Types

The LLVM Type System.

  • 22 types
  • 39 values
  • Packageghc-9.10.3
  • Exports61
  • LanguageGHC2021
  • LicenceBSD-3-Clause
  • SourceTypes.hs

LLVM Basic Types and Variables

12 declarations
datadata LlvmType
#

Llvm Types

Constructors

Instances2Eq, Outputable
datadata LMConst
#

Constructors

Instances1Eq
  • Eq LMConstDefined in ghc-9.10.3 · GHC.Llvm.Types
datadata LlvmStatic
#

Llvm Static Data.

These represent the possible global level variables and constants.

Constructors

Operations on LLVM Basic Types and Variables

Shortcut for Common Types

LLVM Function Types

13 declarations
datadata LlvmFunctionDecl
#

An LLVM Function

Constructors

Instances1Eq
datadata LlvmParamAttr
#

LLVM Parameter Attributes.

Parameter attributes are used to communicate additional information about the result or parameters of a function

Constructors

  • ZeroExt

    This indicates to the code generator that the parameter or return value should be zero-extended to a 32-bit value by the caller (for a parameter) or the callee (for a return value).

  • SignExt

    This indicates to the code generator that the parameter or return value should be sign-extended to a 32-bit value by the caller (for a parameter) or the callee (for a return value).

  • InReg

    This indicates that this parameter or return value should be treated in a special target-dependent fashion during while emitting code for a function call or return (usually, by putting it in a register as opposed to memory).

  • ByVal

    This indicates that the pointer parameter should really be passed by value to the function.

  • SRet

    This indicates that the pointer parameter specifies the address of a structure that is the return value of the function in the source program.

  • NoAlias

    This indicates that the pointer does not alias any global or any other parameter.

  • NoCapture

    This indicates that the callee does not make any copies of the pointer that outlive the callee itself

  • Nest

    This indicates that the pointer parameter can be excised using the trampoline intrinsics.

Instances2Eq, Outputable
datadata LlvmFuncAttr
#

Llvm Function Attributes.

Function attributes are set to communicate additional information about a function. Function attributes are considered to be part of the function, not of the function type, so functions with different parameter attributes can have the same function type. Functions can have multiple attributes.

Descriptions taken from http://llvm.org/docs/LangRef.html#fnattrs

Constructors

  • AlwaysInline

    This attribute indicates that the inliner should attempt to inline this function into callers whenever possible, ignoring any active inlining size threshold for this caller.

  • InlineHint

    This attribute indicates that the source code contained a hint that inlining this function is desirable (such as the "inline" keyword in C/C++). It is just a hint; it imposes no requirements on the inliner.

  • NoInline

    This attribute indicates that the inliner should never inline this function in any situation. This attribute may not be used together with the alwaysinline attribute.

  • OptSize

    This attribute suggests that optimization passes and code generator passes make choices that keep the code size of this function low, and otherwise do optimizations specifically to reduce code size.

  • NoReturn

    This function attribute indicates that the function never returns normally. This produces undefined behavior at runtime if the function ever does dynamically return.

  • NoUnwind

    This function attribute indicates that the function never returns with an unwind or exceptional control flow. If the function does unwind, its runtime behavior is undefined.

  • ReadNone

    This attribute indicates that the function computes its result (or decides to unwind an exception) based strictly on its arguments, without dereferencing any pointer arguments or otherwise accessing any mutable state (e.g. memory, control registers, etc) visible to caller functions. It does not write through any pointer arguments (including byval arguments) and never changes any state visible to callers. This means that it cannot unwind exceptions by calling the C++ exception throwing methods, but could use the unwind instruction.

  • ReadOnly

    This attribute indicates that the function does not write through any pointer arguments (including byval arguments) or otherwise modify any state (e.g. memory, control registers, etc) visible to caller functions. It may dereference pointer arguments and read state that may be set in the caller. A readonly function always returns the same value (or unwinds an exception identically) when called with the same set of arguments and global state. It cannot unwind an exception by calling the C++ exception throwing methods, but may use the unwind instruction.

  • Ssp

    This attribute indicates that the function should emit a stack smashing protector. It is in the form of a "canary"—a random value placed on the stack before the local variables that's checked upon return from the function to see if it has been overwritten. A heuristic is used to determine if a function needs stack protectors or not.

    If a function that has an ssp attribute is inlined into a function that doesn't have an ssp attribute, then the resulting function will have an ssp attribute.

  • SspReq

    This attribute indicates that the function should always emit a stack smashing protector. This overrides the ssp function attribute.

    If a function that has an sspreq attribute is inlined into a function that doesn't have an sspreq attribute or which has an ssp attribute, then the resulting function will have an sspreq attribute.

  • NoRedZone

    This attribute indicates that the code generator should not use a red zone, even if the target-specific ABI normally permits it.

  • NoImplicitFloat

    This attributes disables implicit floating point instructions.

  • Naked

    This attribute disables prologue / epilogue emission for the function. This can have very system-specific consequences.

Instances2Eq, Outputable
datadata LlvmCallType
#

Different types to call a function.

Constructors

  • StdCall

    Normal call, allocate a new stack frame.

  • TailCall

    Tail call, perform the call in the current stack frame.

Instances2Eq, Show
datadata LlvmCallConvention
#

Different calling conventions a function can use.

Constructors

  • CC_Ccc

    The C calling convention. This calling convention (the default if no other calling convention is specified) matches the target C calling conventions. This calling convention supports varargs function calls and tolerates some mismatch in the declared prototype and implemented declaration of the function (as does normal C).

  • CC_Fastcc

    This calling convention attempts to make calls as fast as possible (e.g. by passing things in registers). This calling convention allows the target to use whatever tricks it wants to produce fast code for the target, without having to conform to an externally specified ABI (Application Binary Interface). Implementations of this convention should allow arbitrary tail call optimization to be supported. This calling convention does not support varargs and requires the prototype of al callees to exactly match the prototype of the function definition.

  • CC_Coldcc

    This calling convention attempts to make code in the caller as efficient as possible under the assumption that the call is not commonly executed. As such, these calls often preserve all registers so that the call does not break any live ranges in the caller side. This calling convention does not support varargs and requires the prototype of all callees to exactly match the prototype of the function definition.

  • CC_Ghc

    The GHC-specific registerised calling convention.

  • CC_Ncc Int

    Any calling convention may be specified by number, allowing target-specific calling conventions to be used. Target specific calling conventions start at 64.

  • CC_X86_Stdcc

    X86 Specific StdCall convention. LLVM includes a specific alias for it rather than just using CC_Ncc.

Instances2Eq, Outputable
datadata LlvmLinkageType
#

Linkage type of a symbol.

The description of the constructors is copied from the Llvm Assembly Language Reference Manual http://www.llvm.org/docs/LangRef.html#linkage, because they correspond to the Llvm linkage types.

Constructors

  • Internal

    Global values with internal linkage are only directly accessible by objects in the current module. In particular, linking code into a module with an internal global value may cause the internal to be renamed as necessary to avoid collisions. Because the symbol is internal to the module, all references can be updated. This corresponds to the notion of the static keyword in C.

  • LinkOnce

    Globals with linkonce linkage are merged with other globals of the same name when linkage occurs. This is typically used to implement inline functions, templates, or other code which must be generated in each translation unit that uses it. Unreferenced linkonce globals are allowed to be discarded.

  • Weak

    weak linkage is exactly the same as linkonce linkage, except that unreferenced weak globals may not be discarded. This is used for globals that may be emitted in multiple translation units, but that are not guaranteed to be emitted into every translation unit that uses them. One example of this are common globals in C, such as int X; at global scope.

  • Appending

    appending linkage may only be applied to global variables of pointer to array type. When two global variables with appending linkage are linked together, the two global arrays are appended together. This is the Llvm, typesafe, equivalent of having the system linker append together sections with identical names when .o files are linked.

  • ExternWeak

    The semantics of this linkage follow the ELF model: the symbol is weak until linked, if not linked, the symbol becomes null instead of being an undefined reference.

  • ExternallyVisible

    The symbol participates in linkage and can be used to resolve external symbol references.

  • External

    Alias for ExternallyVisible but with explicit textual form in LLVM assembly.

  • Private

    Symbol is private to the module and should not appear in the symbol table

Instances2Eq, Outputable

LLVM Operations

6 declarations
datadata LlvmMachOp
#

Llvm binary operators machine operations.

Constructors

Instances2Eq, Outputable
datadata LlvmCmpOp
#

Llvm compare operations.

Constructors

Instances2Eq, Outputable
datadata LlvmCastOp
#

Llvm cast operations.

Constructors

Instances2Eq, Outputable

Floating point conversion

4 declarations
valueppDouble :: IsLine doc => Platform -> Double -> doc
#

Convert a Haskell Double to an LLVM hex encoded floating point form. In Llvm float literals can be printed in a big-endian hexadecimal format, regardless of underlying architecture.

See Note [LLVM Float Types].

Misc functions

2 declarations