Safe Haskell	Safe-Inferred
Language	Haskell2010

Text.LLVM.AST

Synopsis

Documentation

commas :: [Doc] -> Doc Source

colons :: [Doc] -> Doc Source

breaks :: (a -> Bool) -> [a] -> [[a]] Source

uncons :: MonadPlus m => [a] -> m (a, [a]) Source

int32 :: Int32 -> Doc Source

angles :: Doc -> Doc Source

structBraces :: Doc -> Doc Source

ppMaybe :: (a -> Doc) -> Maybe a -> Doc Source

opt :: Bool -> Doc -> Doc Source

data Module Source

Constructors

Module
Fields modDataLayout :: DataLayout modTypes :: [TypeDecl] modNamedMd :: [NamedMd] modUnnamedMd :: [UnnamedMd] modGlobals :: [Global] modDeclares :: [Declare] modDefines :: [Define] modInlineAsm :: InlineAsm modAliases :: [GlobalAlias]

Instances

Show Module
Monoid Module

emptyModule :: Module Source

ppModule :: Module -> Doc Source

data NamedMd Source

Constructors

NamedMd
Fields nmName :: String nmValues :: [Int]

Instances

Show NamedMd

ppNamedMd :: NamedMd -> Doc Source

data UnnamedMd Source

Constructors

UnnamedMd
Fields umIndex :: !Int umValues :: [Maybe ValMd] umDistinct :: Bool

Instances

Show UnnamedMd

ppUnnamedMd :: UnnamedMd -> Doc Source

data GlobalAlias Source

Constructors

GlobalAlias
Fields aliasName :: Symbol aliasType :: Type aliasTarget :: Value

Instances

Show GlobalAlias

ppGlobalAlias :: GlobalAlias -> Doc Source

type DataLayout = [LayoutSpec] Source

ppDataLayout :: DataLayout -> Doc Source

Pretty print a data layout specification.

data LayoutSpec Source

Constructors

BigEndian
LittleEndian
PointerSize !Int !Int (Maybe Int)
IntegerSize !Int !Int (Maybe Int)
VectorSize !Int !Int (Maybe Int)
FloatSize !Int !Int (Maybe Int)
AggregateSize !Int !Int (Maybe Int)
StackObjSize !Int !Int (Maybe Int)
NativeIntSize [Int]
StackAlign !Int
Mangling Mangling

Instances

Show LayoutSpec

data Mangling Source

Constructors

ElfMangling
MipsMangling
MachOMangling
WindowsCoffMangling

Instances

Eq Mangling
Show Mangling

ppLayoutSpec :: LayoutSpec -> Doc Source

Pretty print a single layout specification.

ppLayoutBody :: Int -> Int -> Maybe Int -> Doc Source

Pretty-print the common case for data layout specifications.

ppMangling :: Mangling -> Doc Source

parseDataLayout :: MonadPlus m => String -> m DataLayout Source

Parse the data layout string.

parseLayoutSpec :: MonadPlus m => String -> m LayoutSpec Source

Parse a single layout specification from a string.

type InlineAsm = [String] Source

ppInlineAsm :: InlineAsm -> Doc Source

Pretty-print the inline assembly block.

newtype Ident Source

Constructors

Ident String

Instances

Eq Ident
Ord Ident
Show Ident
IsString Ident
IsValue Ident
DefineArgs Type (Typed Value -> BB ())
DefineArgs (Type, Type) (Typed Value -> Typed Value -> BB ())
DefineArgs as k => DefineArgs ((:>) Type as) (Typed Value -> k)
DefineArgs (Type, Type, Type) (Typed Value -> Typed Value -> Typed Value -> BB ())

ppIdent :: Ident -> Doc Source

newtype Symbol Source

Constructors

Symbol String

Instances

Eq Symbol
Ord Symbol
Show Symbol
IsString Symbol
IsValue Symbol

ppSymbol :: Symbol -> Doc Source

data PrimType Source

Constructors

Label
Void
Integer Int32
FloatType FloatType
X86mmx
Metadata

Instances

Eq PrimType
Ord PrimType
Show PrimType

ppPrimType :: PrimType -> Doc Source

data FloatType Source

Constructors

Half
Float
Double
Fp128
X86_fp80
PPC_fp128

Instances

Eq FloatType
Ord FloatType
Show FloatType

ppFloatType :: FloatType -> Doc Source

type Type = Type' Ident Source

data Type' ident Source

Constructors

PrimType PrimType
Alias ident
Array Int32 (Type' ident)
FunTy (Type' ident) [Type' ident] Bool
PtrTo (Type' ident)
Struct [Type' ident]
PackedStruct [Type' ident]
Vector Int32 (Type' ident)
Opaque

Instances

Functor Type'
DefineArgs Type (Typed Value -> BB ())
Eq ident => Eq (Type' ident)
Ord ident => Ord (Type' ident)
Show ident => Show (Type' ident)
DefineArgs (Type, Type) (Typed Value -> Typed Value -> BB ())
DefineArgs as k => DefineArgs ((:>) Type as) (Typed Value -> k)
DefineArgs (Type, Type, Type) (Typed Value -> Typed Value -> Typed Value -> BB ())

updateAliases :: (a -> Type' b) -> Type' a -> Type' b Source

Traverse a type, updating or removing aliases.

ppType :: Type -> Doc Source

isFloatingPoint :: PrimType -> Bool Source

isAlias :: Type -> Bool Source

isPrimTypeOf :: (PrimType -> Bool) -> Type -> Bool Source

isLabel :: PrimType -> Bool Source

isInteger :: PrimType -> Bool Source

isVector :: Type -> Bool Source

isVectorOf :: (Type -> Bool) -> Type -> Bool Source

isArray :: Type -> Bool Source

isPointer :: Type -> Bool Source

ppArgList :: Bool -> [Doc] -> Doc Source

Build a variable-argument argument list.

data NullResult lab Source

Constructors

HasNull (Value' lab)
ResolveNull Ident

primTypeNull :: PrimType -> Value' lab Source

floatTypeNull :: FloatType -> Value' lab Source

typeNull :: Type -> NullResult lab Source

elimFunTy :: MonadPlus m => Type -> m (Type, [Type], Bool) Source

elimAlias :: MonadPlus m => Type -> m Ident Source

elimPtrTo :: MonadPlus m => Type -> m Type Source

elimVector :: MonadPlus m => Type -> m (Int32, Type) Source

elimArray :: MonadPlus m => Type -> m (Int32, Type) Source

elimFunPtr :: MonadPlus m => Type -> m (Type, [Type], Bool) Source

elimPrimType :: MonadPlus m => Type -> m PrimType Source

elimFloatType :: MonadPlus m => PrimType -> m FloatType Source

elimSequentialType :: MonadPlus m => Type -> m Type Source

Eliminator for array, pointer and vector types.

data TypeDecl Source

Constructors

TypeDecl
Fields typeName :: Ident typeValue :: Type

Instances

Show TypeDecl

ppTypeDecl :: TypeDecl -> Doc Source

data Global Source

Constructors

Global
Fields globalSym :: Symbol globalAttrs :: GlobalAttrs globalType :: Type globalValue :: Maybe Value globalAlign :: Maybe Align

Instances

Show Global

ppGlobal :: Global -> Doc Source

addGlobal :: Global -> Module -> Module Source

data GlobalAttrs Source

Constructors

GlobalAttrs
Fields gaLinkage :: Maybe Linkage gaConstant :: Bool

Instances

Show GlobalAttrs

emptyGlobalAttrs :: GlobalAttrs Source

ppGlobalAttrs :: GlobalAttrs -> Doc Source

data Declare Source

Constructors

Declare
Fields decRetType :: Type decName :: Symbol decArgs :: [Type] decVarArgs :: Bool

Instances

Show Declare

decFunType :: Declare -> Type Source

The function type of this declaration

ppDeclare :: Declare -> Doc Source

data Define Source

Constructors

Define
Fields defAttrs :: FunAttrs defRetType :: Type defName :: Symbol defArgs :: [Typed Ident] defVarArgs :: Bool defSection :: Maybe String defBody :: [BasicBlock]

Instances

Show Define

defFunType :: Define -> Type Source

ppDefine :: Define -> Doc Source

addDefine :: Define -> Module -> Module Source

data FunAttrs Source

Constructors

FunAttrs
Fields funLinkage :: Maybe Linkage funGC :: Maybe GC

Instances

Show FunAttrs

emptyFunAttrs :: FunAttrs Source

data BlockLabel Source

Constructors

Named Ident
Anon Int

Instances

Eq BlockLabel
Ord BlockLabel
Show BlockLabel
IsString BlockLabel
IsValue Value
DefineArgs Type (Typed Value -> BB ())
DefineArgs (Type, Type) (Typed Value -> Typed Value -> BB ())
DefineArgs as k => DefineArgs ((:>) Type as) (Typed Value -> k)
DefineArgs (Type, Type, Type) (Typed Value -> Typed Value -> Typed Value -> BB ())

ppLabelDef :: BlockLabel -> Doc Source

ppLabel :: BlockLabel -> Doc Source

data BasicBlock' lab Source

Constructors

BasicBlock
Fields bbLabel :: Maybe lab bbStmts :: [Stmt' lab]

Instances

Show lab => Show (BasicBlock' lab)

type BasicBlock = BasicBlock' BlockLabel Source

ppBasicBlock :: BasicBlock -> Doc Source

brTargets :: BasicBlock' lab -> [lab] Source

data Linkage Source

Symbol Linkage

Constructors

Private
LinkerPrivate
LinkerPrivateWeak
LinkerPrivateWeakDefAuto
Internal
AvailableExternally
Linkonce
Weak
Common
Appending
ExternWeak
LinkonceODR
WeakODR
External
DLLImport
DLLExport

Instances

Eq Linkage
Show Linkage

ppLinkage :: Linkage -> Doc Source

newtype GC Source

Constructors

GC
Fields getGC :: String

Instances

Show GC

ppGC :: GC -> Doc Source

data Typed a Source

Constructors

Typed
Fields typedType :: Type typedValue :: a

Instances

Functor Typed
Foldable Typed
Traversable Typed
DefineArgs Type (Typed Value -> BB ())
Show a => Show (Typed a)
IsValue a => IsValue (Typed a)
DefineArgs (Type, Type) (Typed Value -> Typed Value -> BB ())
DefineArgs as k => DefineArgs ((:>) Type as) (Typed Value -> k)
DefineArgs (Type, Type, Type) (Typed Value -> Typed Value -> Typed Value -> BB ())

mapMTyped :: Monad m => (a -> m b) -> Typed a -> m (Typed b) Source

ppTyped :: (a -> Doc) -> Typed a -> Doc Source

data ArithOp Source

Constructors

Add Bool Bool	Integral addition. First boolean flag: check for unsigned overflow. Second boolean flag: check for signed overflow. If the checks fail, then the result is poisoned.
FAdd	Floating point addition.
Sub Bool Bool	Integral subtraction. First boolean flag: check for unsigned overflow. Second boolean flag: check for signed overflow. If the checks fail, then the result is poisoned.
FSub	Floating point subtraction.
Mul Bool Bool	Integral multiplication. First boolean flag: check for unsigned overflow. Second boolean flag: check for signed overflow. If the checks fail, then the result is poisoned.
FMul	Floating point multiplication.
UDiv Bool	Integral unsigned division. Boolean flag: check for exact result. If the check fails, then the result is poisoned.
SDiv Bool	Integral signed division. Boolean flag: check for exact result. If the check fails, then the result is poisoned.
FDiv	Floating point division.
URem	Integral unsigned reminder resulting from unsigned division. Division by 0 is undefined.
SRem	Integral signded reminder resulting from signed division. The sign of the reminder matches the divident (first parameter). Division by 0 is undefined.
FRem	Floating point reminder resulting from floating point division. The reminder has the same sign as the divident (first parameter).

Instances

Eq ArithOp
Show ArithOp

ppSignBits :: Bool -> Bool -> Doc Source

ppExact :: Bool -> Doc Source

ppArithOp :: ArithOp -> Doc Source

isIArith :: ArithOp -> Bool Source

isFArith :: ArithOp -> Bool Source

data BitOp Source

Constructors

Shl Bool Bool	Shift left. First bool flag: check for unsigned overflow (i.e., shifted out a 1). Second bool flag: check for signed overflow (i.e., shifted out something that does not match the sign bit) If a check fails, then the result is poisoned. The value of the second parameter must be strictly less than the nubmer of bits in the first parameter, otherwise the result is undefined.
Lshr Bool	Logical shift right. The boolean is for exact check: posion the result, if we shift out a 1 bit (i.e., had to round). The value of the second parameter must be strictly less than the nubmer of bits in the first parameter, otherwise the result is undefined.
Ashr Bool	Arithmetic shift right. The boolean is for exact check: posion the result, if we shift out a 1 bit (i.e., had to round). The value of the second parameter must be strictly less than the nubmer of bits in the first parameter, otherwise the result is undefined.
And
Or
Xor

Instances

Show BitOp

ppBitOp :: BitOp -> Doc Source

data ConvOp Source

Constructors

Trunc
ZExt
SExt
FpTrunc
FpExt
FpToUi
FpToSi
UiToFp
SiToFp
PtrToInt
IntToPtr
BitCast

Instances

Show ConvOp

ppConvOp :: ConvOp -> Doc Source

type Align = Int Source

data Instr' lab Source

Constructors

Ret (Typed (Value' lab))	Return from function with the given value. Ends basic block.
RetVoid	Return from function. Ends basic block.
Arith ArithOp (Typed (Value' lab)) (Value' lab)	Binary arithmetic operation, both operands have the same type. Middle of basic block. The result is the same as parameters.
Bit BitOp (Typed (Value' lab)) (Value' lab)	Binary bit-vector operation, both operands have the same type. Middle of basic block. The result is the same as parameters.
Conv ConvOp (Typed (Value' lab)) Type	Convert a value from one type to another. Middle of basic block. The result matches the 3rd parameter.
Call Bool Type (Value' lab) [Typed (Value' lab)]	Call a function. The boolean is tail-call hint (XXX: needs to be updated) Middle of basic block. The result is as indicated by the provided type.
Alloca Type (Maybe (Typed (Value' lab))) (Maybe Int)	Allocated space on the stack: type of elements; how many elements (1 if `Nothing`); required alignment. Middle of basic block. Returns a pointer to hold the given number of elemets.
Load (Typed (Value' lab)) (Maybe Align)	Read a value from the given address: address to read from; assumptions about alignment of the given pointer. Middle of basic block. Returns a value of type matching the pointer.
Store (Typed (Value' lab)) (Typed (Value' lab)) (Maybe Align)	Write a value ot memory: value to store; pointer to location where to store; assumptions about the alignment of the given pointer. Middle olf basic block. Effect.
ICmp ICmpOp (Typed (Value' lab)) (Value' lab)	Compare two integral values. Middle of basic block. Returns a boolean value.
FCmp FCmpOp (Typed (Value' lab)) (Value' lab)	Compare two floating point values. Middle of basic block. Returns a boolean value.
Phi Type [(Value' lab, lab)]	Join point for an SSA value: we get one value per predecessor basic block. Middle of basic block. Returns a value of the specified type.
GEP Bool (Typed (Value' lab)) [Typed (Value' lab)]	"Get element pointer", compute the address of a field in a structure: inbounds check (value poisoned if this fails); pointer to parent strucutre; path to a sub-component of a strucutre. Middle of basic block. Returns the address of the requiested member. The types in path are the types of the index, not the fields. The indexes are in units of a fields (i.e., the first element in a struct is field 0, the next one is 1, etc., regardless of the size of the fields in bytes).
Select (Typed (Value' lab)) (Typed (Value' lab)) (Value' lab)	Local if-then-else; the first argument is boolean, if true pick the 2nd argument, otherwise evaluate to the 3rd. Middle of basic block. Returns either the 2nd or the 3rd argument.
ExtractValue (Typed (Value' lab)) [Int32]	Get the value of a member of an aggregate value: the first argument is an aggregate value (not a pointer!), the second is a path of indexes, similar to the one in `GEP`. Middle of basic block. Returns the given member of the aggregate value.
InsertValue (Typed (Value' lab)) (Typed (Value' lab)) [Int32]	Set the value for a member of an aggregate value: the first argument is the value to insert, the second is the aggreagate value to be modified. Middle of basic block. Returns an updated aggregate value.
ExtractElt (Typed (Value' lab)) (Value' lab)	Get an element from a vector: the first argument is a vector, the second an index. Middle of basic block. Returns the element at the given positoin.
InsertElt (Typed (Value' lab)) (Typed (Value' lab)) (Value' lab)	Modify an element of a vector: the first argument is the vector, the second the value to be inserted, the third is the index where to insert the value. Middle of basic block. Returns an updated vector.
ShuffleVector (Typed (Value' lab)) (Value' lab) (Typed (Value' lab))
Jump lab	Jump to the given basic block. Ends basic block.
Br (Typed (Value' lab)) lab lab	Conditional jump: if the value is true jump to the first basic block, otherwise jump to the second. Ends basic block.
Invoke Type (Value' lab) [Typed (Value' lab)] lab lab
Comment String	Comment
Unreachable	No defined sematics, we should not get to here.
Unwind
VaArg (Typed (Value' lab)) Type
IndirectBr (Typed (Value' lab)) [lab]
Switch (Typed (Value' lab)) lab [(Integer, lab)]	Multi-way branch: the first value determines the direction of the branch, the label is a default direction, if the value does not appear in the jump table, the last argument is the jump table. Ends basic block.
LandingPad Type (Typed (Value' lab)) Bool [Clause' lab]
Resume (Typed (Value' lab))

Instances

Functor Instr'
HasLabel Instr'
Show lab => Show (Instr' lab)

type Instr = Instr' BlockLabel Source

data Clause' lab Source

Constructors

Catch (Typed (Value' lab))
Filter (Typed (Value' lab))

Instances

Functor Clause'
HasLabel Clause'
Show lab => Show (Clause' lab)

type Clause = Clause' BlockLabel Source

isTerminator :: Instr' lab -> Bool Source

isComment :: Instr' lab -> Bool Source

isPhi :: Instr' lab -> Bool Source

ppInstr :: Instr -> Doc Source

ppClauses :: Bool -> [Clause] -> Doc Source

ppClause :: Clause -> Doc Source

ppTypedLabel :: BlockLabel -> Doc Source

ppSwitchEntry :: Type -> (Integer, BlockLabel) -> Doc Source

ppVectorIndex :: Value -> Doc Source

ppAlign :: Maybe Align -> Doc Source

ppAlloca :: Type -> Maybe (Typed Value) -> Maybe Int -> Doc Source

ppCall :: Bool -> Type -> Value -> [Typed Value] -> Doc Source

ppCallSym :: Type -> Value -> Doc Source

ppGEP :: Bool -> Typed Value -> [Typed Value] -> Doc Source

ppInvoke :: Type -> Value -> [Typed Value] -> BlockLabel -> BlockLabel -> Doc Source

ppPhiArg :: (Value, BlockLabel) -> Doc Source

data ICmpOp Source

Constructors

Ieq
Ine
Iugt
Iuge
Iult
Iule
Isgt
Isge
Islt
Isle

Instances

Show ICmpOp

ppICmpOp :: ICmpOp -> Doc Source

data FCmpOp Source

Constructors

Ffalse
Foeq
Fogt
Foge
Folt
Fole
Fone
Ford
Fueq
Fugt
Fuge
Fult
Fule
Fune
Funo
Ftrue

Instances

Show FCmpOp

ppFCmpOp :: FCmpOp -> Doc Source

data Value' lab Source

Constructors

ValInteger Integer
ValBool Bool
ValFloat Float
ValDouble Double
ValIdent Ident
ValSymbol Symbol
ValNull
ValArray Type [Value' lab]
ValVector Type [Value' lab]
ValStruct [Typed (Value' lab)]
ValPackedStruct [Typed (Value' lab)]
ValString String
ValConstExpr (ConstExpr' lab)
ValUndef
ValLabel lab
ValZeroInit
ValAsm Bool Bool String String
ValMd (ValMd' lab)

Instances

Functor Value'
HasLabel Value'
IsValue Value
DefineArgs Type (Typed Value -> BB ())
Show lab => Show (Value' lab)
DefineArgs (Type, Type) (Typed Value -> Typed Value -> BB ())
DefineArgs as k => DefineArgs ((:>) Type as) (Typed Value -> k)
DefineArgs (Type, Type, Type) (Typed Value -> Typed Value -> Typed Value -> BB ())

type Value = Value' BlockLabel Source

data ValMd' lab Source

Constructors

ValMdString String
ValMdValue (Typed (Value' lab))
ValMdRef Int
ValMdNode [Maybe (ValMd' lab)]
ValMdLoc (DebugLoc' lab)

Instances

Functor ValMd'
HasLabel ValMd'
Show lab => Show (ValMd' lab)

type ValMd = ValMd' BlockLabel Source

data DebugLoc' lab Source

Constructors

DebugLoc
Fields dlLine :: Int32 dlCol :: Int32 dlScope :: ValMd' lab dlIA :: Maybe (ValMd' lab)

Instances

Functor DebugLoc'
HasLabel DebugLoc'
Show lab => Show (DebugLoc' lab)

type DebugLoc = DebugLoc' BlockLabel Source

isConst :: Value' lab -> Bool Source

ppValue :: Value -> Doc Source

ppValMd :: ValMd -> Doc Source

ppDebugLoc :: DebugLoc -> Doc Source

ppTypedValMd :: ValMd -> Doc Source

ppMetadata :: Doc -> Doc Source

ppMetadataNode :: [Maybe ValMd] -> Doc Source

ppBool :: Bool -> Doc Source

ppStringLiteral :: String -> Doc Source

ppAsm :: Bool -> Bool -> String -> String -> Doc Source

elimValSymbol :: MonadPlus m => Value' lab -> m Symbol Source

elimValInteger :: MonadPlus m => Value' lab -> m Integer Source

data Stmt' lab Source

Constructors

Result Ident (Instr' lab) [(String, ValMd' lab)]
Effect (Instr' lab) [(String, ValMd' lab)]

Instances

Functor Stmt'
HasLabel Stmt'
Show lab => Show (Stmt' lab)

type Stmt = Stmt' BlockLabel Source

stmtInstr :: Stmt' lab -> Instr' lab Source

stmtMetadata :: Stmt' lab -> [(String, ValMd' lab)] Source

extendMetadata :: (String, ValMd' lab) -> Stmt' lab -> Stmt' lab Source

ppStmt :: Stmt -> Doc Source

ppAttachedMetadata :: [(String, ValMd)] -> Doc Source

data ConstExpr' lab Source

Constructors

ConstGEP Bool [Typed (Value' lab)]
ConstConv ConvOp (Typed (Value' lab)) Type
ConstSelect (Typed (Value' lab)) (Typed (Value' lab)) (Typed (Value' lab))
ConstBlockAddr Symbol lab

Instances

Functor ConstExpr'
HasLabel ConstExpr'
Show lab => Show (ConstExpr' lab)

type ConstExpr = ConstExpr' BlockLabel Source

ppConstExpr :: ConstExpr -> Doc Source

data IndexResult Source

Constructors

Invalid	An invalid use of GEP
HasType Type	A resolved type
Resolve Ident (Type -> IndexResult)	Continue, after resolving an alias

isInvalid :: IndexResult -> Bool Source

resolveGep :: Type -> [Typed (Value' lab)] -> IndexResult Source

Resolve the type of a GEP instruction. Note that the type produced is the type of the result, not necessarily a pointer.

resolveGepBody :: Type -> [Typed (Value' lab)] -> IndexResult Source

Resolve the type of a GEP instruction. This assumes that the input has already been processed as a pointer.

isGepIndex :: Typed (Value' lab) -> Bool Source

isGepStructIndex :: Typed (Value' lab) -> Maybe Integer Source

resolveValueIndex :: Type -> [Int32] -> IndexResult Source