Block labels
Moduleghc-9.10.3GHC2021
GHC.Llvm.Syntax
The LLVM abstract syntax.
- 11 types
- Packageghc-9.10.3
- Exports11
- LanguageGHC2021
- LicenceBSD-3-Clause
- SourceSyntax.hs
A block of LLVM code.
Constructors
LlvmBlockblockLabel :: LlvmBlockIdThe code label for this block
blockStmts :: [LlvmStatement]A list of LlvmStatement's representing the code for this block. This list must end with a control flow statement.
An LLVM Module. This is a top level container in LLVM.
Constructors
LlvmModulemodComments :: [LMString]Comments to include at the start of the module.
modAliases :: [LlvmAlias]LLVM Alias type definitions.
modMeta :: [MetaDecl]LLVM meta data.
modGlobals :: [LMGlobal]Global variables to include in the module.
modFwdDecls :: LlvmFunctionDeclsLLVM Functions used in this module but defined in other modules.
modFuncs :: LlvmFunctionsLLVM Functions defined in this module.
An LLVM Function
Constructors
LlvmFunctionfuncDecl :: LlvmFunctionDeclThe signature of this declared function.
funcArgs :: [LMString]The functions arguments
funcAttrs :: [LlvmFuncAttr]The function attributes.
funcSect :: LMSectionThe section to put the function into,
funcPrefix :: Maybe LlvmStaticPrefix data
funcBody :: LlvmBlocksThe body of the functions.
LLVM ordering types for synchronization purposes. (Introduced in LLVM 3.0). Please see the LLVM documentation for a better description.
Constructors
SyncUnordSome partial order of operations exists.
SyncMonotonicA single total order for operations at a single address exists.
SyncAcquireAcquire synchronization operation.
SyncReleaseRelease synchronization operation.
SyncAcqRelAcquire + Release synchronization operation.
SyncSeqCstFull sequential Consistency operation.
Instances2Eq, Show
Eq LlvmSyncOrderingDefined in ghc-9.10.3 · GHC.Llvm.SyntaxShow LlvmSyncOrderingDefined in ghc-9.10.3 · GHC.Llvm.Syntax
LLVM atomic operations. Please see the atomicrmw instruction in
the LLVM documentation for a complete description.
Instances2Eq, Show
Eq LlvmAtomicOpDefined in ghc-9.10.3 · GHC.Llvm.SyntaxShow LlvmAtomicOpDefined in ghc-9.10.3 · GHC.Llvm.Syntax
Llvm Statements
Constructors
Assignment LlvmVar LlvmExpressionAssign an expression to a variable: * dest: Variable to assign to * source: Source expression
Fence Bool LlvmSyncOrderingMemory fence operation
Branch LlvmVarAlways branch to the target label
BranchIf LlvmVar LlvmVar LlvmVarBranch to label targetTrue if cond is true otherwise to label targetFalse * cond: condition that will be tested, must be of type i1 * targetTrue: label to branch to if cond is true * targetFalse: label to branch to if cond is false
Comment [LMString]Comment Plain comment.
MkLabel LlvmBlockIdSet a label on this position. * name: Identifier of this label, unique for this module
Store LlvmVar LlvmVar LMAlign [MetaAnnot]Store variable value in pointer ptr. If value is of type t then ptr must be of type t*. * value: Variable/Constant to store. * ptr: Location to store the value in
Switch LlvmVar LlvmVar [(LlvmVar, LlvmVar)]Multiway branch * scrutinee: Variable or constant which must be of integer type that is determines which arm is chosen. * def: The default label if there is no match in target. * target: A list of (value,label) where the value is an integer constant and label the corresponding label to jump to if the scrutinee matches the value.
Return (Maybe LlvmVar)Return a result. * result: The variable or constant to return
UnreachableAn instruction for the optimizer that the code following is not reachable
Expr LlvmExpressionRaise an expression to a statement (if don't want result or want to use Llvm unnamed values.
NopA nop LLVM statement. Useful as its often more efficient to use this then to wrap LLvmStatement in a Just or [].
Instances1Eq
Eq LlvmStatementDefined in ghc-9.10.3 · GHC.Llvm.Syntax
Llvm Expressions
Constructors
Alloca LlvmType IntAllocate amount * sizeof(tp) bytes on the stack * tp: LlvmType to reserve room for * amount: The nr of tp's which must be allocated
LlvmOp LlvmMachOp LlvmVar LlvmVarPerform the machine operator op on the operands left and right * op: operator * left: left operand * right: right operand
Compare LlvmCmpOp LlvmVar LlvmVarPerform a compare operation on the operands left and right * op: operator * left: left operand * right: right operand
Extract LlvmVar LlvmVarExtract a scalar element from a vector * val: The vector * idx: The index of the scalar within the vector
ExtractV LlvmVar IntExtract a scalar element from a structure * val: The structure * idx: The index of the scalar within the structure Corresponds to "extractvalue" instruction.
Insert LlvmVar LlvmVar LlvmVarInsert a scalar element into a vector * val: The source vector * elt: The scalar to insert * index: The index at which to insert the scalar
Malloc LlvmType IntAllocate amount * sizeof(tp) bytes on the heap * tp: LlvmType to reserve room for * amount: The nr of tp's which must be allocated
Load LlvmVar LMAlignLoad the value at location ptr
ALoad LlvmSyncOrdering SingleThreaded LlvmVarAtomic load of the value at location ptr
GetElemPtr Bool LlvmVar [LlvmVar]Navigate in a structure, selecting elements * inbound: Is the pointer inbounds? (computed pointer doesn't overflow) * ptr: Location of the structure * indexes: A list of indexes to select the correct value.
Cast LlvmCastOp LlvmVar LlvmTypeCast the variable from to the to type. This is an abstraction of three cast operators in Llvm, inttoptr, ptrtoint and bitcast. * cast: Cast type * from: Variable to cast * to: type to cast to
AtomicRMW LlvmAtomicOp LlvmVar LlvmVar LlvmSyncOrderingAtomic read-modify-write operation * op: Atomic operation * addr: Address to modify * operand: Operand to operation * ordering: Ordering requirement
CmpXChg LlvmVar LlvmVar LlvmVar LlvmSyncOrdering LlvmSyncOrderingCompare-and-exchange operation * addr: Address to modify * old: Expected value * new: New value * suc_ord: Ordering required in success case * fail_ord: Ordering required in failure case, can be no stronger than suc_ord
Result is an
i1, true if store was successful.Call LlvmCallType LlvmVar [LlvmVar] [LlvmFuncAttr]Call a function. The result is the value of the expression. * tailJumps: CallType to signal if the function should be tail called * fnptrval: An LLVM value containing a pointer to a function to be invoked. Can be indirect. Should be LMFunction type. * args: Concrete arguments for the parameters * attrs: A list of function attributes for the call. Only NoReturn, NoUnwind, ReadOnly and ReadNone are valid here.
CallM LlvmCallType LlvmVar [MetaExpr] [LlvmFuncAttr]Call a function as above but potentially taking metadata as arguments. * tailJumps: CallType to signal if the function should be tail called * fnptrval: An LLVM value containing a pointer to a function to be invoked. Can be indirect. Should be LMFunction type. * args: Arguments that may include metadata. * attrs: A list of function attributes for the call. Only NoReturn, NoUnwind, ReadOnly and ReadNone are valid here.
Phi LlvmType [(LlvmVar, LlvmVar)]Merge variables from different basic blocks which are predecessors of this basic block in a new variable of type tp. * tp: type of the merged variable, must match the types of the predecessor variables. * predecessors: A list of variables and the basic block that they originate from.
Asm LMString LMString LlvmType [LlvmVar] Bool BoolInline assembly expression. Syntax is very similar to the style used by GCC. * assembly: Actual inline assembly code. * constraints: Operand constraints. * return ty: Return type of function. * vars: Any variables involved in the assembly code. * sideeffect: Does the expression have side effects not visible from the constraints list. * alignstack: Should the stack be conservatively aligned before this expression is executed.
MExpr [MetaAnnot] LlvmExpressionA LLVM expression with metadata attached to it.
Instances1Eq
Eq LlvmExpressionDefined in ghc-9.10.3 · GHC.Llvm.Syntax