Safe Haskell	None
Language	Haskell98

LLVM.Core

Contents

Initialize
Modules
Instructions
Types classification
Extra types
Values and constants
Code generation
Functions
Global variable creation
Globals
Basic blocks
Misc
Debugging

Description

The LLVM (Low Level Virtual Machine) is virtual machine at a machine code level. It supports both stand alone code generation and JITing. The Haskell llvm package is a (relatively) high level interface to the LLVM. The high level interface makes it easy to construct LLVM code. There is also an interface to the raw low level LLVM API as exposed by the LLVM C interface.

LLVM code is organized into modules (type Module). Each module contains a number of global variables and functions (type Function). Each functions has a number of basic blocks (type BasicBlock). Each basic block has a number instructions, where each instruction produces a value (type Value).

Unlike assembly code for a real processor the assembly code for LLVM is in SSA (Static Single Assignment) form. This means that each instruction generates a new bound variable which may not be assigned again. A consequence of this is that where control flow joins from several execution paths there has to be a phi pseudo instruction if you want different variables to be joined into one.

The definition of several of the LLVM entities (Module, Function, and BasicBlock) follow the same pattern. First the entity has to be created using newX (where X is one of Module, Function, or BasicBlock), then at some later point it has to given its definition using defineX. The reason for splitting the creation and definition is that you often need to be able to refer to an entity before giving it's body, e.g., in two mutually recursive functions. The the newX and defineX function can also be done at the same time by using createX. Furthermore, an explicit name can be given to an entity by the newNamedX function; the newX function just generates a fresh name.

Synopsis

initializeNativeTarget :: IO ()
data Module
newModule :: IO Module
newNamedModule :: String -> IO Module
defineModule :: Module -> CodeGenModule a -> IO a
destroyModule :: Module -> IO ()
createModule :: CodeGenModule a -> IO a
getModule :: CodeGenModule Module
setTarget :: String -> CodeGenModule ()
hostTriple :: String
setDataLayout :: String -> CodeGenModule ()
data PassManager
createPassManager :: IO PassManager
createFunctionPassManager :: Module -> IO PassManager
writeBitcodeToFile :: String -> Module -> IO ()
readBitcodeFromFile :: String -> IO Module
getModuleValues :: Module -> IO [(String, ModuleValue)]
getFunctions :: Module -> IO [(String, Value)]
getGlobalVariables :: Module -> IO [(String, Value)]
data ModuleValue
castModuleValue :: IsType a => ModuleValue -> Maybe (Value a)
data Value a
data ConstValue a
valueOf :: IsConst a => a -> Value a
constOf :: IsConst a => a -> ConstValue a
value :: ConstValue a -> Value a
zero :: IsType a => ConstValue a
allOnes :: IsInteger a => ConstValue a
undef :: IsType a => ConstValue a
class IsConst a
class IsConstFields a
createString :: String -> TGlobal (Array n Word8)
createStringNul :: String -> TGlobal (Array n Word8)
withString :: String -> (forall n. Natural n => Global (Array n Word8) -> CodeGenModule a) -> CodeGenModule a
withStringNul :: String -> (forall n. Natural n => Global (Array n Word8) -> CodeGenModule a) -> CodeGenModule a
constVector :: (Positive n, ToUnary n ~ u, Length (FixedList u) ~ u) => FixedList u (ConstValue a) -> ConstValue (Vector n a)
constArray :: (IsSized a, Natural n) => [ConstValue a] -> ConstValue (Array n a)
constCyclicVector :: Positive n => T [] (ConstValue a) -> ConstValue (Vector n a)
constCyclicArray :: (IsSized a, Natural n) => T [] (ConstValue a) -> ConstValue (Vector n a)
constStruct :: IsConstStruct c => c -> ConstValue (Struct (ConstStructOf c))
constPackedStruct :: IsConstStruct c => c -> ConstValue (PackedStruct (ConstStructOf c))
toVector :: MkVector n => Tuple n a -> Vector n a
fromVector :: MkVector n => Vector n a -> Tuple n a
vector :: Positive n => FixedList (ToUnary n) a -> Vector n a
cyclicVector :: Positive n => T [] a -> Vector n a
consVector :: (ConsVector f, ResultSize f ~ n, NumberOfArguments f ~ u, u ~ ToUnary n, FromUnary u ~ n, Natural n) => f
data CodeGenFunction r a
data CodeGenModule a
type Function a = Value (FunPtr a)
newFunction :: IsFunction a => Linkage -> CodeGenModule (Function a)
newNamedFunction :: IsFunction a => Linkage -> String -> CodeGenModule (Function a)
defineFunction :: FunctionArgs f => Function f -> FunctionCodeGen f -> CodeGenModule ()
createFunction :: FunctionArgs f => Linkage -> FunctionCodeGen f -> CodeGenModule (Function f)
createNamedFunction :: FunctionArgs f => Linkage -> String -> FunctionCodeGen f -> CodeGenModule (Function f)
setFuncCallConv :: Function a -> CallingConvention -> CodeGenModule ()
functionParameter :: Natural i => Function f -> Proxy i -> Value (FunctionParameter f i)
type TFunction a = CodeGenModule (Function a)
liftCodeGenModule :: CodeGenModule a -> CodeGenFunction r a
getParams :: Value -> IO [(String, Value)]
type Global a = Value (Ptr a)
newGlobal :: IsType a => Bool -> Linkage -> TGlobal a
newNamedGlobal :: IsType a => Bool -> Linkage -> String -> TGlobal a
defineGlobal :: Global a -> ConstValue a -> CodeGenModule ()
createGlobal :: IsType a => Bool -> Linkage -> ConstValue a -> TGlobal a
createNamedGlobal :: IsType a => Bool -> Linkage -> String -> ConstValue a -> TGlobal a
externFunction :: IsFunction a => String -> CodeGenFunction r (Function a)
staticFunction :: IsFunction f => FunPtr f -> CodeGenFunction r (Function f)
staticNamedFunction :: IsFunction f => String -> FunPtr f -> CodeGenFunction r (Function f)
externGlobal :: IsType a => Bool -> String -> CodeGenFunction r (Global a)
staticGlobal :: IsType a => Bool -> Ptr a -> CodeGenFunction r (Global a)
data GlobalMappings
getGlobalMappings :: CodeGenModule GlobalMappings
type TGlobal a = CodeGenModule (Global a)
data Linkage
- = ExternalLinkage
- | AvailableExternallyLinkage
- | LinkOnceAnyLinkage
- | LinkOnceODRLinkage
- | LinkOnceODRAutoHideLinkage
- | WeakAnyLinkage
- | WeakODRLinkage
- | AppendingLinkage
- | InternalLinkage
- | PrivateLinkage
- | DLLImportLinkage
- | DLLExportLinkage
- | ExternalWeakLinkage
- | GhostLinkage
- | CommonLinkage
- | LinkerPrivateLinkage
- | LinkerPrivateWeakLinkage
data BasicBlock
newBasicBlock :: CodeGenFunction r BasicBlock
newNamedBasicBlock :: String -> CodeGenFunction r BasicBlock
defineBasicBlock :: BasicBlock -> CodeGenFunction r ()
createBasicBlock :: CodeGenFunction r BasicBlock
getCurrentBasicBlock :: CodeGenFunction r BasicBlock
getBasicBlocks :: Value -> IO [(String, BasicBlock)]
fromLabel :: Value Label -> BasicBlock
toLabel :: BasicBlock -> Value Label
getInstructions :: BasicBlock -> IO [(String, Value)]
getOperands :: Value -> IO [(String, Value)]
hasUsers :: Value -> IO Bool
getUsers :: [Use] -> IO [(String, Value)]
getUses :: Value -> IO [Use]
getUser :: Use -> IO Value
isChildOf :: BasicBlock -> Value -> IO Bool
getDep :: Use -> IO (String, String)
addAttributes :: Value a -> AttributeIndex -> [Attribute] -> CodeGenFunction r ()
data Attribute
newtype AttributeIndex = AttributeIndex Word32
attributeReturnIndex :: AttributeIndex
attributeFunctionIndex :: AttributeIndex
castVarArgs :: CastVarArgs a b => Function a -> Function b
dumpValue :: Value a -> IO ()
dumpType :: Value a -> IO ()
getValueName :: Value a -> IO String
annotateValueList :: [Value] -> IO [(String, Value)]

Initialize

initializeNativeTarget :: IO () #

Initialize jitter to the native target. The operation is idempotent.

Modules

data Module #

Instances

Show Module
Instance details Defined in LLVM.Core.Util Methods showsPrec :: Int -> Module -> ShowS # show :: Module -> String # showList :: [Module] -> ShowS #

newModule :: IO Module #

newNamedModule :: String -> IO Module #

defineModule :: Module -> CodeGenModule a -> IO a #

destroyModule :: Module -> IO () #

createModule :: CodeGenModule a -> IO a #

getModule :: CodeGenModule Module #

setTarget :: String -> CodeGenModule () #

hostTriple :: String #

setDataLayout :: String -> CodeGenModule () #

data PassManager #

Instances

Show PassManager
Instance details Defined in LLVM.Core.Util Methods showsPrec :: Int -> PassManager -> ShowS # show :: PassManager -> String # showList :: [PassManager] -> ShowS #

createPassManager :: IO PassManager #

createFunctionPassManager :: Module -> IO PassManager #

writeBitcodeToFile :: String -> Module -> IO () #

readBitcodeFromFile :: String -> IO Module #

getModuleValues :: Module -> IO [(String, ModuleValue)] #

getFunctions :: Module -> IO [(String, Value)] #

getGlobalVariables :: Module -> IO [(String, Value)] #

data ModuleValue #

Instances

Show ModuleValue
Instance details Defined in LLVM.Core.CodeGen Methods showsPrec :: Int -> ModuleValue -> ShowS # show :: ModuleValue -> String # showList :: [ModuleValue] -> ShowS #

castModuleValue :: IsType a => ModuleValue -> Maybe (Value a) #

Instructions

Types classification

Extra types

Values and constants

data Value a #

Instances

ValueCons Value
Instance details Defined in LLVM.Core.Instructions.Private Methods switchValueCons :: f ConstValue -> f Value -> f Value
ValueCons2 ConstValue Value
Instance details Defined in LLVM.Core.Instructions Associated Types type BinOpValue ConstValue Value :: Type -> Type Methods binop :: FFIConstBinOp -> FFIBinOp -> ConstValue a -> Value a -> CodeGenFunction r (BinOpValue ConstValue Value b)
ValueCons2 Value ConstValue
Instance details Defined in LLVM.Core.Instructions Associated Types type BinOpValue Value ConstValue :: Type -> Type Methods binop :: FFIConstBinOp -> FFIBinOp -> Value a -> ConstValue a -> CodeGenFunction r (BinOpValue Value ConstValue b)
ValueCons2 Value Value
Instance details Defined in LLVM.Core.Instructions Associated Types type BinOpValue Value Value :: Type -> Type Methods binop :: FFIConstBinOp -> FFIBinOp -> Value a -> Value a -> CodeGenFunction r (BinOpValue Value Value b)
Show (Value a)
Instance details Defined in LLVM.Core.CodeGen Methods showsPrec :: Int -> Value a -> ShowS # show :: Value a -> String # showList :: [Value a] -> ShowS #
i ~ Word => AllocArg (Value i)
Instance details Defined in LLVM.Core.Instructions Methods getAllocArg :: Value i -> Value Word
Ret (Value a)
Instance details Defined in LLVM.Core.Instructions Associated Types type Result (Value a) :: Type Methods ret' :: Value a -> CodeGenFunction (Result (Value a)) Terminate
IsIndexType i => IsIndexArg (Value i)
Instance details Defined in LLVM.Core.Instructions.Private Methods getArg :: Value i -> ValueRef
IsFirstClass a => Phi (Value a) Source #
Instance details Defined in LLVM.Util.Loop Methods phis :: BasicBlock -> Value a -> CodeGenFunction r (Value a) Source # addPhis :: BasicBlock -> Value a -> Value a -> CodeGenFunction r () Source #
type BinOpValue ConstValue Value
Instance details Defined in LLVM.Core.Instructions type BinOpValue ConstValue Value = Value
type BinOpValue Value ConstValue
Instance details Defined in LLVM.Core.Instructions type BinOpValue Value ConstValue = Value
type BinOpValue Value Value
Instance details Defined in LLVM.Core.Instructions type BinOpValue Value Value = Value
type UnValue (Value a)
Instance details Defined in LLVM.Core.CodeGen type UnValue (Value a) = a
type Result (Value a)
Instance details Defined in LLVM.Core.Instructions type Result (Value a) = a

data ConstValue a #

Instances

ValueCons ConstValue
Instance details Defined in LLVM.Core.Instructions.Private Methods switchValueCons :: f ConstValue -> f Value -> f ConstValue
ValueCons2 ConstValue ConstValue
Instance details Defined in LLVM.Core.Instructions Associated Types type BinOpValue ConstValue ConstValue :: Type -> Type Methods binop :: FFIConstBinOp -> FFIBinOp -> ConstValue a -> ConstValue a -> CodeGenFunction r (BinOpValue ConstValue ConstValue b)
ValueCons2 ConstValue Value
Instance details Defined in LLVM.Core.Instructions Associated Types type BinOpValue ConstValue Value :: Type -> Type Methods binop :: FFIConstBinOp -> FFIBinOp -> ConstValue a -> Value a -> CodeGenFunction r (BinOpValue ConstValue Value b)
ValueCons2 Value ConstValue
Instance details Defined in LLVM.Core.Instructions Associated Types type BinOpValue Value ConstValue :: Type -> Type Methods binop :: FFIConstBinOp -> FFIBinOp -> Value a -> ConstValue a -> CodeGenFunction r (BinOpValue Value ConstValue b)
Show (ConstValue a)
Instance details Defined in LLVM.Core.CodeGen Methods showsPrec :: Int -> ConstValue a -> ShowS # show :: ConstValue a -> String # showList :: [ConstValue a] -> ShowS #
i ~ Word => AllocArg (ConstValue i)
Instance details Defined in LLVM.Core.Instructions Methods getAllocArg :: ConstValue i -> Value Word
IsIndexType i => IsIndexArg (ConstValue i)
Instance details Defined in LLVM.Core.Instructions.Private Methods getArg :: ConstValue i -> ValueRef
(IsConst a, IsConstStruct cs) => IsConstStruct (ConstValue a, cs)
Instance details Defined in LLVM.Core.CodeGen Associated Types type ConstStructOf (ConstValue a, cs) :: Type Methods constValueFieldsOf :: (ConstValue a, cs) -> [ValueRef]
type BinOpValue ConstValue ConstValue
Instance details Defined in LLVM.Core.Instructions type BinOpValue ConstValue ConstValue = ConstValue
type BinOpValue ConstValue Value
Instance details Defined in LLVM.Core.Instructions type BinOpValue ConstValue Value = Value
type BinOpValue Value ConstValue
Instance details Defined in LLVM.Core.Instructions type BinOpValue Value ConstValue = Value
type ConstStructOf (ConstValue a, cs)
Instance details Defined in LLVM.Core.CodeGen type ConstStructOf (ConstValue a, cs) = (a, ConstStructOf cs)

valueOf :: IsConst a => a -> Value a #

constOf :: IsConst a => a -> ConstValue a #

value :: ConstValue a -> Value a #

zero :: IsType a => ConstValue a #

allOnes :: IsInteger a => ConstValue a #

undef :: IsType a => ConstValue a #

class IsConst a #

Minimal complete definition

constOf

Instances

IsConst Bool
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Bool -> ConstValue Bool #
IsConst Double
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Double -> ConstValue Double #
IsConst Float
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Float -> ConstValue Float #
IsConst Int
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Int -> ConstValue Int #
IsConst Int8
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Int8 -> ConstValue Int8 #
IsConst Int16
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Int16 -> ConstValue Int16 #
IsConst Int32
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Int32 -> ConstValue Int32 #
IsConst Int64
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Int64 -> ConstValue Int64 #
IsConst Word
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Word -> ConstValue Word #
IsConst Word8
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Word8 -> ConstValue Word8 #
IsConst Word16
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Word16 -> ConstValue Word16 #
IsConst Word32
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Word32 -> ConstValue Word32 #
IsConst Word64
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Word64 -> ConstValue Word64 #
IsConst (StablePtr a)
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: StablePtr a -> ConstValue (StablePtr a) #
IsConst (Ptr a)
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Ptr a -> ConstValue (Ptr a) #
IsFunction a => IsConst (FunPtr a)
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: FunPtr a -> ConstValue (FunPtr a) #
Positive n => IsConst (IntN n)
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: IntN n -> ConstValue (IntN n) #
IsConstFields a => IsConst (PackedStruct a)
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: PackedStruct a -> ConstValue (PackedStruct a) #
IsType a => IsConst (Ptr a)
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Ptr a -> ConstValue (Ptr a) #
IsConstFields a => IsConst (Struct a)
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Struct a -> ConstValue (Struct a) #
Positive n => IsConst (WordN n)
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: WordN n -> ConstValue (WordN n) #
(IsConst a, IsSized a, Natural n) => IsConst (Array n a)
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Array n a -> ConstValue (Array n a) #
(IsPrimitive a, IsConst a, Positive n) => IsConst (Vector n a)
Instance details Defined in LLVM.Core.CodeGen Methods constOf :: Vector n a -> ConstValue (Vector n a) #

class IsConstFields a #

Minimal complete definition

constFieldsOf

Instances

IsConstFields ()
Instance details Defined in LLVM.Core.CodeGen Methods constFieldsOf :: () -> [ValueRef]
(IsConst a, IsConstFields as) => IsConstFields (a, as)
Instance details Defined in LLVM.Core.CodeGen Methods constFieldsOf :: (a, as) -> [ValueRef]

createString :: String -> TGlobal (Array n Word8) #

createStringNul :: String -> TGlobal (Array n Word8) #

withString :: String -> (forall n. Natural n => Global (Array n Word8) -> CodeGenModule a) -> CodeGenModule a #

withStringNul :: String -> (forall n. Natural n => Global (Array n Word8) -> CodeGenModule a) -> CodeGenModule a #

constVector :: (Positive n, ToUnary n ~ u, Length (FixedList u) ~ u) => FixedList u (ConstValue a) -> ConstValue (Vector n a) #

constArray :: (IsSized a, Natural n) => [ConstValue a] -> ConstValue (Array n a) #

constCyclicVector :: Positive n => T [] (ConstValue a) -> ConstValue (Vector n a) #

constCyclicArray :: (IsSized a, Natural n) => T [] (ConstValue a) -> ConstValue (Vector n a) #

constStruct :: IsConstStruct c => c -> ConstValue (Struct (ConstStructOf c)) #

constPackedStruct :: IsConstStruct c => c -> ConstValue (PackedStruct (ConstStructOf c)) #

toVector :: MkVector n => Tuple n a -> Vector n a #

fromVector :: MkVector n => Vector n a -> Tuple n a #

vector :: Positive n => FixedList (ToUnary n) a -> Vector n a #

cyclicVector :: Positive n => T [] a -> Vector n a #

consVector :: (ConsVector f, ResultSize f ~ n, NumberOfArguments f ~ u, u ~ ToUnary n, FromUnary u ~ n, Natural n) => f #

Code generation

data CodeGenFunction r a #

Instances

(IsFirstClass a, Value a ~ a', r ~ r') => CallArgs r (IO a) (CodeGenFunction r' a')
Instance details Defined in LLVM.Core.Instructions Associated Types type CalledFunction (CodeGenFunction r' a') :: Type type CallerFunction r (IO a) :: Type Methods doCall :: Call (IO a) -> CodeGenFunction r' a'
(Value a ~ b, IsFirstClass a) => ToArithFunction r (IO a) (CodeGenFunction r b) Source #
Instance details Defined in LLVM.Util.Arithmetic Associated Types type TFunA (CodeGenFunction r b) :: Type type TFunB r (IO a) :: Type Methods toArithFunction' :: CodeGenFunction r (Call (IO a)) -> CodeGenFunction r b
(r ~ ra, r ~ rb, a ~ b) => ArithFunction r (CodeGenFunction ra a) (CodeGenFunction rb b) Source #
Instance details Defined in LLVM.Util.Arithmetic Associated Types type FunA r (CodeGenFunction rb b) :: Type type FunB (CodeGenFunction ra a) :: Type Methods arithFunction' :: CodeGenFunction ra a -> CodeGenFunction rb b
(Ret z, Result z ~ r, r ~ ra, r ~ rb, z ~ a, unit ~ ()) => Return z (CodeGenFunction ra a) (CodeGenFunction rb unit) Source #
Instance details Defined in LLVM.Util.Arithmetic Associated Types type RetA z (CodeGenFunction rb unit) :: Type type RetB (CodeGenFunction ra a) :: Type Methods addRet :: CodeGenFunction ra a -> CodeGenFunction rb unit
Monad (CodeGenFunction r)
Instance details Defined in LLVM.Core.CodeGenMonad Methods (>>=) :: CodeGenFunction r a -> (a -> CodeGenFunction r b) -> CodeGenFunction r b # (>>) :: CodeGenFunction r a -> CodeGenFunction r b -> CodeGenFunction r b # return :: a -> CodeGenFunction r a # fail :: String -> CodeGenFunction r a #
Functor (CodeGenFunction r)
Instance details Defined in LLVM.Core.CodeGenMonad Methods fmap :: (a -> b) -> CodeGenFunction r a -> CodeGenFunction r b # (<$) :: a -> CodeGenFunction r b -> CodeGenFunction r a #
Applicative (CodeGenFunction r)
Instance details Defined in LLVM.Core.CodeGenMonad Methods pure :: a -> CodeGenFunction r a # (<>) :: CodeGenFunction r (a -> b) -> CodeGenFunction r a -> CodeGenFunction r b # liftA2 :: (a -> b -> c) -> CodeGenFunction r a -> CodeGenFunction r b -> CodeGenFunction r c # (>) :: CodeGenFunction r a -> CodeGenFunction r b -> CodeGenFunction r b # (<*) :: CodeGenFunction r a -> CodeGenFunction r b -> CodeGenFunction r a #
MonadIO (CodeGenFunction r)
Instance details Defined in LLVM.Core.CodeGenMonad Methods liftIO :: IO a -> CodeGenFunction r a #
(IsArithmetic a, CmpRet a, Num a, IsConst a, Value a ~ av) => Enum (CodeGenFunction r av) Source #
Instance details Defined in LLVM.Util.Arithmetic Methods succ :: CodeGenFunction r av -> CodeGenFunction r av # pred :: CodeGenFunction r av -> CodeGenFunction r av # toEnum :: Int -> CodeGenFunction r av # fromEnum :: CodeGenFunction r av -> Int # enumFrom :: CodeGenFunction r av -> [CodeGenFunction r av] # enumFromThen :: CodeGenFunction r av -> CodeGenFunction r av -> [CodeGenFunction r av] # enumFromTo :: CodeGenFunction r av -> CodeGenFunction r av -> [CodeGenFunction r av] # enumFromThenTo :: CodeGenFunction r av -> CodeGenFunction r av -> CodeGenFunction r av -> [CodeGenFunction r av] #
Eq (CodeGenFunction r av) Source #
Instance details Defined in LLVM.Util.Arithmetic Methods (==) :: CodeGenFunction r av -> CodeGenFunction r av -> Bool # (/=) :: CodeGenFunction r av -> CodeGenFunction r av -> Bool #
(CmpRet a, CallIntrinsic a, Floating a, IsConst a, IsFloating a, Value a ~ av) => Floating (CodeGenFunction r av) Source #
Instance details Defined in LLVM.Util.Arithmetic Methods pi :: CodeGenFunction r av # exp :: CodeGenFunction r av -> CodeGenFunction r av # log :: CodeGenFunction r av -> CodeGenFunction r av # sqrt :: CodeGenFunction r av -> CodeGenFunction r av # (**) :: CodeGenFunction r av -> CodeGenFunction r av -> CodeGenFunction r av # logBase :: CodeGenFunction r av -> CodeGenFunction r av -> CodeGenFunction r av # sin :: CodeGenFunction r av -> CodeGenFunction r av # cos :: CodeGenFunction r av -> CodeGenFunction r av # tan :: CodeGenFunction r av -> CodeGenFunction r av # asin :: CodeGenFunction r av -> CodeGenFunction r av # acos :: CodeGenFunction r av -> CodeGenFunction r av # atan :: CodeGenFunction r av -> CodeGenFunction r av # sinh :: CodeGenFunction r av -> CodeGenFunction r av # cosh :: CodeGenFunction r av -> CodeGenFunction r av # tanh :: CodeGenFunction r av -> CodeGenFunction r av # asinh :: CodeGenFunction r av -> CodeGenFunction r av # acosh :: CodeGenFunction r av -> CodeGenFunction r av # atanh :: CodeGenFunction r av -> CodeGenFunction r av # log1p :: CodeGenFunction r av -> CodeGenFunction r av # expm1 :: CodeGenFunction r av -> CodeGenFunction r av # log1pexp :: CodeGenFunction r av -> CodeGenFunction r av # log1mexp :: CodeGenFunction r av -> CodeGenFunction r av #
(CmpRet a, Fractional a, IsConst a, IsFloating a, Value a ~ av) => Fractional (CodeGenFunction r av) Source #
Instance details Defined in LLVM.Util.Arithmetic Methods (/) :: CodeGenFunction r av -> CodeGenFunction r av -> CodeGenFunction r av # recip :: CodeGenFunction r av -> CodeGenFunction r av # fromRational :: Rational -> CodeGenFunction r av #
(CmpRet a, Num a, IsConst a, IsInteger a, Value a ~ av) => Integral (CodeGenFunction r av) Source #
Instance details Defined in LLVM.Util.Arithmetic Methods quot :: CodeGenFunction r av -> CodeGenFunction r av -> CodeGenFunction r av # rem :: CodeGenFunction r av -> CodeGenFunction r av -> CodeGenFunction r av # div :: CodeGenFunction r av -> CodeGenFunction r av -> CodeGenFunction r av # mod :: CodeGenFunction r av -> CodeGenFunction r av -> CodeGenFunction r av # quotRem :: CodeGenFunction r av -> CodeGenFunction r av -> (CodeGenFunction r av, CodeGenFunction r av) # divMod :: CodeGenFunction r av -> CodeGenFunction r av -> (CodeGenFunction r av, CodeGenFunction r av) # toInteger :: CodeGenFunction r av -> Integer #
(IsArithmetic a, CmpRet a, Num a, IsConst a, Value a ~ av) => Num (CodeGenFunction r av) Source #
Instance details Defined in LLVM.Util.Arithmetic Methods (+) :: CodeGenFunction r av -> CodeGenFunction r av -> CodeGenFunction r av # (-) :: CodeGenFunction r av -> CodeGenFunction r av -> CodeGenFunction r av # (*) :: CodeGenFunction r av -> CodeGenFunction r av -> CodeGenFunction r av # negate :: CodeGenFunction r av -> CodeGenFunction r av # abs :: CodeGenFunction r av -> CodeGenFunction r av # signum :: CodeGenFunction r av -> CodeGenFunction r av # fromInteger :: Integer -> CodeGenFunction r av #
Ord (CodeGenFunction r av) Source #
Instance details Defined in LLVM.Util.Arithmetic Methods compare :: CodeGenFunction r av -> CodeGenFunction r av -> Ordering # (<) :: CodeGenFunction r av -> CodeGenFunction r av -> Bool # (<=) :: CodeGenFunction r av -> CodeGenFunction r av -> Bool # (>) :: CodeGenFunction r av -> CodeGenFunction r av -> Bool # (>=) :: CodeGenFunction r av -> CodeGenFunction r av -> Bool # max :: CodeGenFunction r av -> CodeGenFunction r av -> CodeGenFunction r av # min :: CodeGenFunction r av -> CodeGenFunction r av -> CodeGenFunction r av #
(IsArithmetic a, CmpRet a, Num a, IsConst a, Value a ~ av) => Real (CodeGenFunction r av) Source #
Instance details Defined in LLVM.Util.Arithmetic Methods toRational :: CodeGenFunction r av -> Rational #
(CmpRet a, CallIntrinsic a, RealFloat a, IsConst a, IsFloating a, Value a ~ av) => RealFloat (CodeGenFunction r av) Source #
Instance details Defined in LLVM.Util.Arithmetic Methods floatRadix :: CodeGenFunction r av -> Integer # floatDigits :: CodeGenFunction r av -> Int # floatRange :: CodeGenFunction r av -> (Int, Int) # decodeFloat :: CodeGenFunction r av -> (Integer, Int) # encodeFloat :: Integer -> Int -> CodeGenFunction r av # exponent :: CodeGenFunction r av -> Int # significand :: CodeGenFunction r av -> CodeGenFunction r av # scaleFloat :: Int -> CodeGenFunction r av -> CodeGenFunction r av # isNaN :: CodeGenFunction r av -> Bool # isInfinite :: CodeGenFunction r av -> Bool # isDenormalized :: CodeGenFunction r av -> Bool # isNegativeZero :: CodeGenFunction r av -> Bool # isIEEE :: CodeGenFunction r av -> Bool # atan2 :: CodeGenFunction r av -> CodeGenFunction r av -> CodeGenFunction r av #
(CmpRet a, Fractional a, IsConst a, IsFloating a, Value a ~ av) => RealFrac (CodeGenFunction r av) Source #
Instance details Defined in LLVM.Util.Arithmetic Methods properFraction :: Integral b => CodeGenFunction r av -> (b, CodeGenFunction r av) # truncate :: Integral b => CodeGenFunction r av -> b # round :: Integral b => CodeGenFunction r av -> b # ceiling :: Integral b => CodeGenFunction r av -> b # floor :: Integral b => CodeGenFunction r av -> b #
type CodeResult (CodeGenFunction r a)
Instance details Defined in LLVM.Core.CodeGen type CodeResult (CodeGenFunction r a) = r
type CodeValue (CodeGenFunction r a)
Instance details Defined in LLVM.Core.CodeGen type CodeValue (CodeGenFunction r a) = a
type CalledFunction (CodeGenFunction r' a')
Instance details Defined in LLVM.Core.Instructions type CalledFunction (CodeGenFunction r' a') = IO (UnValue a')

data CodeGenModule a #

Instances

Monad CodeGenModule
Instance details Defined in LLVM.Core.CodeGenMonad Methods (>>=) :: CodeGenModule a -> (a -> CodeGenModule b) -> CodeGenModule b # (>>) :: CodeGenModule a -> CodeGenModule b -> CodeGenModule b # return :: a -> CodeGenModule a # fail :: String -> CodeGenModule a #
Functor CodeGenModule
Instance details Defined in LLVM.Core.CodeGenMonad Methods fmap :: (a -> b) -> CodeGenModule a -> CodeGenModule b # (<$) :: a -> CodeGenModule b -> CodeGenModule a #
Applicative CodeGenModule
Instance details Defined in LLVM.Core.CodeGenMonad Methods pure :: a -> CodeGenModule a # (<>) :: CodeGenModule (a -> b) -> CodeGenModule a -> CodeGenModule b # liftA2 :: (a -> b -> c) -> CodeGenModule a -> CodeGenModule b -> CodeGenModule c # (>) :: CodeGenModule a -> CodeGenModule b -> CodeGenModule b # (<*) :: CodeGenModule a -> CodeGenModule b -> CodeGenModule a #
MonadIO CodeGenModule
Instance details Defined in LLVM.Core.CodeGenMonad Methods liftIO :: IO a -> CodeGenModule a #

Functions

type Function a = Value (FunPtr a) #

newFunction :: IsFunction a => Linkage -> CodeGenModule (Function a) #

newNamedFunction :: IsFunction a => Linkage -> String -> CodeGenModule (Function a) #

defineFunction :: FunctionArgs f => Function f -> FunctionCodeGen f -> CodeGenModule () #

createFunction :: FunctionArgs f => Linkage -> FunctionCodeGen f -> CodeGenModule (Function f) #

createNamedFunction :: FunctionArgs f => Linkage -> String -> FunctionCodeGen f -> CodeGenModule (Function f) #

setFuncCallConv :: Function a -> CallingConvention -> CodeGenModule () #

functionParameter :: Natural i => Function f -> Proxy i -> Value (FunctionParameter f i) #

type TFunction a = CodeGenModule (Function a) #

liftCodeGenModule :: CodeGenModule a -> CodeGenFunction r a #

getParams :: Value -> IO [(String, Value)] #

Global variable creation

type Global a = Value (Ptr a) #

newGlobal :: IsType a => Bool -> Linkage -> TGlobal a #

newNamedGlobal :: IsType a => Bool -> Linkage -> String -> TGlobal a #

defineGlobal :: Global a -> ConstValue a -> CodeGenModule () #

createGlobal :: IsType a => Bool -> Linkage -> ConstValue a -> TGlobal a #

createNamedGlobal :: IsType a => Bool -> Linkage -> String -> ConstValue a -> TGlobal a #

externFunction :: IsFunction a => String -> CodeGenFunction r (Function a) #

staticFunction :: IsFunction f => FunPtr f -> CodeGenFunction r (Function f) #

staticNamedFunction :: IsFunction f => String -> FunPtr f -> CodeGenFunction r (Function f) #

externGlobal :: IsType a => Bool -> String -> CodeGenFunction r (Global a) #

staticGlobal :: IsType a => Bool -> Ptr a -> CodeGenFunction r (Global a) #

data GlobalMappings #

Instances

Show GlobalMappings
Instance details Defined in LLVM.Core.CodeGenMonad Methods showsPrec :: Int -> GlobalMappings -> ShowS # show :: GlobalMappings -> String # showList :: [GlobalMappings] -> ShowS #
Semigroup GlobalMappings
Instance details Defined in LLVM.Core.CodeGenMonad Methods (<>) :: GlobalMappings -> GlobalMappings -> GlobalMappings # sconcat :: NonEmpty GlobalMappings -> GlobalMappings # stimes :: Integral b => b -> GlobalMappings -> GlobalMappings #
Monoid GlobalMappings
Instance details Defined in LLVM.Core.CodeGenMonad Methods mempty :: GlobalMappings # mappend :: GlobalMappings -> GlobalMappings -> GlobalMappings # mconcat :: [GlobalMappings] -> GlobalMappings #

getGlobalMappings :: CodeGenModule GlobalMappings #

type TGlobal a = CodeGenModule (Global a) #

Globals

data Linkage #

An enumeration for the kinds of linkage for global values.

Constructors

ExternalLinkage	Externally visible function
AvailableExternallyLinkage
LinkOnceAnyLinkage	Keep one copy of function when linking (inline)
LinkOnceODRLinkage	Same, but only replaced by something equivalent.
LinkOnceODRAutoHideLinkage	Like LinkOnceODR, but possibly hidden.
WeakAnyLinkage	Keep one copy of named function when linking (weak)
WeakODRLinkage	Same, but only replaced by something equivalent.
AppendingLinkage	Special purpose, only applies to global arrays
InternalLinkage	Rename collisions when linking (static functions)
PrivateLinkage	Like Internal, but omit from symbol table
DLLImportLinkage	Function to be imported from DLL
DLLExportLinkage	Function to be accessible from DLL
ExternalWeakLinkage	ExternalWeak linkage description
GhostLinkage	Stand-in functions for streaming fns from BC files
CommonLinkage	Tentative definitions
LinkerPrivateLinkage	Like Private, but linker removes.
LinkerPrivateWeakLinkage	Like LinkerPrivate, but is weak.

Instances

Enum Linkage
Instance details Defined in LLVM.FFI.Core Methods succ :: Linkage -> Linkage # pred :: Linkage -> Linkage # toEnum :: Int -> Linkage # fromEnum :: Linkage -> Int # enumFrom :: Linkage -> [Linkage] # enumFromThen :: Linkage -> Linkage -> [Linkage] # enumFromTo :: Linkage -> Linkage -> [Linkage] # enumFromThenTo :: Linkage -> Linkage -> Linkage -> [Linkage] #
Eq Linkage
Instance details Defined in LLVM.FFI.Core Methods (==) :: Linkage -> Linkage -> Bool # (/=) :: Linkage -> Linkage -> Bool #
Ord Linkage
Instance details Defined in LLVM.FFI.Core Methods compare :: Linkage -> Linkage -> Ordering # (<) :: Linkage -> Linkage -> Bool # (<=) :: Linkage -> Linkage -> Bool # (>) :: Linkage -> Linkage -> Bool # (>=) :: Linkage -> Linkage -> Bool # max :: Linkage -> Linkage -> Linkage # min :: Linkage -> Linkage -> Linkage #
Show Linkage
Instance details Defined in LLVM.FFI.Core Methods showsPrec :: Int -> Linkage -> ShowS # show :: Linkage -> String # showList :: [Linkage] -> ShowS #

Basic blocks

data BasicBlock #

Instances

Show BasicBlock
Instance details Defined in LLVM.Core.CodeGen Methods showsPrec :: Int -> BasicBlock -> ShowS # show :: BasicBlock -> String # showList :: [BasicBlock] -> ShowS #