Safe Haskell	Safe-Inferred
Language	Haskell2010

Text.LLVM

Contents

LLVM Monad
Alias Introduction
Function Definition
Types
Values
Basic Blocks
Terminator Instructions
Binary Operations
Bitwise Binary Operations
Conversion Operations
Aggregate Operations
Memory Access and Addressing Operations
Other Operations
Re-exported

Synopsis

data LLVM a
runLLVM :: LLVM a -> (a, Module)
emitTypeDecl :: TypeDecl -> LLVM ()
emitGlobal :: Global -> LLVM (Typed Value)
emitDeclare :: Declare -> LLVM (Typed Value)
emitDefine :: Define -> LLVM (Typed Value)
alias :: Ident -> Type -> LLVM ()
freshSymbol :: LLVM Symbol
data a :> b = a :> b
define :: DefineArgs sig k => FunAttrs -> Type -> Symbol -> sig -> k -> LLVM (Typed Value)
defineFresh :: DefineArgs sig k => FunAttrs -> Type -> sig -> k -> LLVM (Typed Value)
class DefineArgs a k | a -> k
define' :: FunAttrs -> Type -> Symbol -> [Type] -> Bool -> ([Typed Value] -> BB ()) -> LLVM (Typed Value)
declare :: Type -> Symbol -> [Type] -> Bool -> LLVM (Typed Value)
global :: GlobalAttrs -> Symbol -> Type -> Maybe Value -> LLVM (Typed Value)
data FunAttrs = FunAttrs {
- funLinkage :: Maybe Linkage
- funVisibility :: Maybe Visibility
- funGC :: Maybe GC
}
emptyFunAttrs :: FunAttrs
iT :: Word32 -> Type
ptrT :: Type -> Type
voidT :: Type
arrayT :: Word64 -> Type -> Type
(=:) :: Type -> a -> Typed a
(-:) :: IsValue a => Type -> a -> Typed Value
class IsValue a where
- toValue :: a -> Value
int :: Int -> Value
integer :: Integer -> Value
struct :: Bool -> [Typed Value] -> Typed Value
array :: Type -> [Value] -> Typed Value
string :: Symbol -> String -> LLVM (Typed Value)
data BB a
freshLabel :: BB Ident
label :: Ident -> BB ()
comment :: String -> BB ()
assign :: IsValue a => Ident -> BB (Typed a) -> BB (Typed Value)
ret :: IsValue a => Typed a -> BB ()
retVoid :: BB ()
jump :: Ident -> BB ()
br :: IsValue a => Typed a -> Ident -> Ident -> BB ()
unreachable :: BB ()
unwind :: BB ()
add :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
fadd :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
sub :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
fsub :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
mul :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
fmul :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
udiv :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
sdiv :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
fdiv :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
urem :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
srem :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
frem :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
shl :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
lshr :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
ashr :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
band :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
bor :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
bxor :: (IsValue a, IsValue b) => Typed a -> b -> BB (Typed Value)
trunc :: IsValue a => Typed a -> Type -> BB (Typed Value)
zext :: IsValue a => Typed a -> Type -> BB (Typed Value)
sext :: IsValue a => Typed a -> Type -> BB (Typed Value)
fptrunc :: IsValue a => Typed a -> Type -> BB (Typed Value)
fpext :: IsValue a => Typed a -> Type -> BB (Typed Value)
fptoui :: IsValue a => Typed a -> Type -> BB (Typed Value)
fptosi :: IsValue a => Typed a -> Type -> BB (Typed Value)
uitofp :: IsValue a => Typed a -> Type -> BB (Typed Value)
sitofp :: IsValue a => Typed a -> Type -> BB (Typed Value)
ptrtoint :: IsValue a => Typed a -> Type -> BB (Typed Value)
inttoptr :: IsValue a => Typed a -> Type -> BB (Typed Value)
bitcast :: IsValue a => Typed a -> Type -> BB (Typed Value)
extractValue :: IsValue a => Typed a -> Int32 -> BB (Typed Value)
insertValue :: (IsValue a, IsValue b) => Typed a -> Typed b -> Int32 -> BB (Typed Value)
alloca :: Type -> Maybe (Typed Value) -> Maybe Int -> BB (Typed Value)
load :: IsValue a => Type -> Typed a -> Maybe Align -> BB (Typed Value)
store :: (IsValue a, IsValue b) => a -> Typed b -> Maybe Align -> BB ()
getelementptr :: IsValue a => Type -> Typed a -> [Typed Value] -> BB (Typed Value)
nullPtr :: Type -> Typed Value
icmp :: (IsValue a, IsValue b) => ICmpOp -> Typed a -> b -> BB (Typed Value)
fcmp :: (IsValue a, IsValue b) => FCmpOp -> Typed a -> b -> BB (Typed Value)
phi :: Type -> [PhiArg] -> BB (Typed Value)
data PhiArg
from :: IsValue a => a -> BlockLabel -> PhiArg
select :: (IsValue a, IsValue b, IsValue c) => Typed a -> Typed b -> Typed c -> BB (Typed Value)
call :: IsValue a => Typed a -> [Typed Value] -> BB (Typed Value)
call_ :: IsValue a => Typed a -> [Typed Value] -> BB ()
invoke :: IsValue a => Type -> a -> [Typed Value] -> Ident -> Ident -> BB (Typed Value)
switch :: IsValue a => Typed a -> Ident -> [(Integer, Ident)] -> BB ()
shuffleVector :: (IsValue a, IsValue b, IsValue c) => Typed a -> b -> c -> BB (Typed Value)
module Text.LLVM.AST

LLVM Monad

data LLVM a Source #

Instances

Instances details

MonadFix LLVM Source #
Instance details Defined in Text.LLVM Methods mfix :: (a -> LLVM a) -> LLVM a #
Applicative LLVM Source #
Instance details Defined in Text.LLVM Methods pure :: a -> LLVM a # (<>) :: LLVM (a -> b) -> LLVM a -> LLVM b # liftA2 :: (a -> b -> c) -> LLVM a -> LLVM b -> LLVM c # (>) :: LLVM a -> LLVM b -> LLVM b # (<*) :: LLVM a -> LLVM b -> LLVM a #
Functor LLVM Source #
Instance details Defined in Text.LLVM Methods fmap :: (a -> b) -> LLVM a -> LLVM b # (<$) :: a -> LLVM b -> LLVM a #
Monad LLVM Source #
Instance details Defined in Text.LLVM Methods (>>=) :: LLVM a -> (a -> LLVM b) -> LLVM b # (>>) :: LLVM a -> LLVM b -> LLVM b # return :: a -> LLVM a #

runLLVM :: LLVM a -> (a, Module) Source #

emitTypeDecl :: TypeDecl -> LLVM () Source #

emitGlobal :: Global -> LLVM (Typed Value) Source #

emitDeclare :: Declare -> LLVM (Typed Value) Source #

emitDefine :: Define -> LLVM (Typed Value) Source #

Alias Introduction

alias :: Ident -> Type -> LLVM () Source #

Function Definition

freshSymbol :: LLVM Symbol Source #

data a :> b infixr 0 Source #

Constructors

a :> b infixr 0

Instances

Instances details

(Show a, Show b) => Show (a :> b) Source #
Instance details Defined in Text.LLVM Methods showsPrec :: Int -> (a :> b) -> ShowS # show :: (a :> b) -> String # showList :: [a :> b] -> ShowS #
DefineArgs as k => DefineArgs (Type :> as) (Typed Value -> k) Source #
Instance details Defined in Text.LLVM Methods defineBody :: [Typed Ident] -> (Type :> as) -> (Typed Value -> k) -> LLVM ([Typed Ident], [BasicBlock])

define :: DefineArgs sig k => FunAttrs -> Type -> Symbol -> sig -> k -> LLVM (Typed Value) Source #

Define a function.

defineFresh :: DefineArgs sig k => FunAttrs -> Type -> sig -> k -> LLVM (Typed Value) Source #

A combination of define and freshSymbol.

class DefineArgs a k | a -> k Source #

Types that can be used to define the body of a function.

Minimal complete definition

defineBody

Instances

Instances details

DefineArgs () (BB ()) Source #
Instance details Defined in Text.LLVM Methods defineBody :: [Typed Ident] -> () -> BB () -> LLVM ([Typed Ident], [BasicBlock])
DefineArgs Type (Typed Value -> BB ()) Source #
Instance details Defined in Text.LLVM Methods defineBody :: [Typed Ident] -> Type -> (Typed Value -> BB ()) -> LLVM ([Typed Ident], [BasicBlock])
DefineArgs as k => DefineArgs (Type :> as) (Typed Value -> k) Source #
Instance details Defined in Text.LLVM Methods defineBody :: [Typed Ident] -> (Type :> as) -> (Typed Value -> k) -> LLVM ([Typed Ident], [BasicBlock])
DefineArgs (Type, Type) (Typed Value -> Typed Value -> BB ()) Source #
Instance details Defined in Text.LLVM Methods defineBody :: [Typed Ident] -> (Type, Type) -> (Typed Value -> Typed Value -> BB ()) -> LLVM ([Typed Ident], [BasicBlock])
DefineArgs (Type, Type, Type) (Typed Value -> Typed Value -> Typed Value -> BB ()) Source #
Instance details Defined in Text.LLVM Methods defineBody :: [Typed Ident] -> (Type, Type, Type) -> (Typed Value -> Typed Value -> Typed Value -> BB ()) -> LLVM ([Typed Ident], [BasicBlock])

define' :: FunAttrs -> Type -> Symbol -> [Type] -> Bool -> ([Typed Value] -> BB ()) -> LLVM (Typed Value) Source #

Function definition when the argument list isn't statically known. This is useful when generating code.

declare :: Type -> Symbol -> [Type] -> Bool -> LLVM (Typed Value) Source #

Emit a declaration.

global :: GlobalAttrs -> Symbol -> Type -> Maybe Value -> LLVM (Typed Value) Source #

Emit a global declaration.

data FunAttrs Source #

Constructors

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

Instances

Instances details

Show FunAttrs Source #
Instance details Defined in Text.LLVM Methods showsPrec :: Int -> FunAttrs -> ShowS # show :: FunAttrs -> String # showList :: [FunAttrs] -> ShowS #

emptyFunAttrs :: FunAttrs Source #

Types

iT :: Word32 -> Type Source #

ptrT :: Type -> Type Source #

voidT :: Type Source #

arrayT :: Word64 -> Type -> Type Source #

(=:) :: Type -> a -> Typed a Source #

(-:) :: IsValue a => Type -> a -> Typed Value Source #

Values

class IsValue a where Source #

Methods

toValue :: a -> Value Source #

Instances

Instances details

IsValue Int16 Source #
Instance details Defined in Text.LLVM Methods toValue :: Int16 -> Value Source #
IsValue Int32 Source #
Instance details Defined in Text.LLVM Methods toValue :: Int32 -> Value Source #
IsValue Int64 Source #
Instance details Defined in Text.LLVM Methods toValue :: Int64 -> Value Source #
IsValue Int8 Source #
Instance details Defined in Text.LLVM Methods toValue :: Int8 -> Value Source #
IsValue Ident Source #
Instance details Defined in Text.LLVM Methods toValue :: Ident -> Value Source #
IsValue Symbol Source #
Instance details Defined in Text.LLVM Methods toValue :: Symbol -> Value Source #
IsValue Value Source #
Instance details Defined in Text.LLVM Methods toValue :: Value -> Value Source #
IsValue Integer Source #
Instance details Defined in Text.LLVM Methods toValue :: Integer -> Value Source #
IsValue Bool Source #
Instance details Defined in Text.LLVM Methods toValue :: Bool -> Value Source #
IsValue Double Source #
Instance details Defined in Text.LLVM Methods toValue :: Double -> Value Source #
IsValue Float Source #
Instance details Defined in Text.LLVM Methods toValue :: Float -> Value Source #
IsValue Int Source #
Instance details Defined in Text.LLVM Methods toValue :: Int -> Value Source #
IsValue a => IsValue (Typed a) Source #
Instance details Defined in Text.LLVM Methods toValue :: Typed a -> Value Source #

int :: Int -> Value Source #

integer :: Integer -> Value Source #

struct :: Bool -> [Typed Value] -> Typed Value Source #

array :: Type -> [Value] -> Typed Value Source #

string :: Symbol -> String -> LLVM (Typed Value) Source #

Output a somewhat clunky representation for a string global, that deals well with escaping in the haskell-source string.

Basic Blocks

data BB a Source #

Instances

Instances details

MonadFix BB Source #
Instance details Defined in Text.LLVM Methods mfix :: (a -> BB a) -> BB a #
Applicative BB Source #
Instance details Defined in Text.LLVM Methods pure :: a -> BB a # (<>) :: BB (a -> b) -> BB a -> BB b # liftA2 :: (a -> b -> c) -> BB a -> BB b -> BB c # (>) :: BB a -> BB b -> BB b # (<*) :: BB a -> BB b -> BB a #
Functor BB Source #
Instance details Defined in Text.LLVM Methods fmap :: (a -> b) -> BB a -> BB b # (<$) :: a -> BB b -> BB a #
Monad BB Source #
Instance details Defined in Text.LLVM Methods (>>=) :: BB a -> (a -> BB b) -> BB b # (>>) :: BB a -> BB b -> BB b # return :: a -> BB a #
DefineArgs () (BB ()) Source #
Instance details Defined in Text.LLVM Methods defineBody :: [Typed Ident] -> () -> BB () -> LLVM ([Typed Ident], [BasicBlock])
DefineArgs Type (Typed Value -> BB ()) Source #
Instance details Defined in Text.LLVM Methods defineBody :: [Typed Ident] -> Type -> (Typed Value -> BB ()) -> LLVM ([Typed Ident], [BasicBlock])
IsString (BB a) Source #
Instance details Defined in Text.LLVM Methods fromString :: String -> BB a #
DefineArgs (Type, Type) (Typed Value -> Typed Value -> BB ()) Source #
Instance details Defined in Text.LLVM Methods defineBody :: [Typed Ident] -> (Type, Type) -> (Typed Value -> Typed Value -> BB ()) -> LLVM ([Typed Ident], [BasicBlock])
DefineArgs (Type, Type, Type) (Typed Value -> Typed Value -> Typed Value -> BB ()) Source #
Instance details Defined in Text.LLVM Methods defineBody :: [Typed Ident] -> (Type, Type, Type) -> (Typed Value -> Typed Value -> Typed Value -> BB ()) -> LLVM ([Typed Ident], [BasicBlock])

freshLabel :: BB Ident Source #

label :: Ident -> BB () Source #

Force termination of the current basic block, and start a new one with the given label. If the previous block had no instructions defined, it will just be thrown away.

comment :: String -> BB () Source #

assign :: IsValue a => Ident -> BB (Typed a) -> BB (Typed Value) Source #

Emit an assignment that uses the given identifier to name the result of the BB operation.

WARNING: this can throw errors.