LLVM.General.Module

A Module holds a C++ LLVM IR module. Modules may be converted to or from strings or Haskell ASTs, or added to an ExecutionEngine and so JIT compiled to get function pointers.

Documentation

data Module

http://llvm.org/doxygen/classllvm_1_1Module.html

newtype File

A newtype to distinguish strings used for paths from other strings

Constructors

File FilePath

Instances

Eq File

Ord File

Read File

Show File

withModuleFromAST :: Context -> Module -> (Module -> IO a) -> ExceptT String IO a

Build an LLVM.General.Module from a LLVM.General.AST.Module - i.e. lower an AST from Haskell into C++ objects.

moduleAST :: Module -> IO Module

Get an LLVM.General.AST.Module from a LLVM.General.Module - i.e. raise C++ objects into an Haskell AST.

withModuleFromLLVMAssembly :: LLVMAssemblyInput s => Context -> s -> (Module -> IO a) -> ExceptT (Either String Diagnostic) IO a

parse Module from LLVM assembly

moduleLLVMAssembly :: Module -> IO String

generate LLVM assembly from a Module

writeLLVMAssemblyToFile :: File -> Module -> ExceptT String IO ()

write LLVM assembly for a Module to a file

withModuleFromBitcode :: BitcodeInput b => Context -> b -> (Module -> IO a) -> ExceptT String IO a

parse Module from LLVM bitcode

moduleBitcode :: Module -> IO ByteString

generate LLVM bitcode from a Module

writeBitcodeToFile :: File -> Module -> ExceptT String IO ()

write LLVM bitcode from a Module into a file

moduleTargetAssembly :: TargetMachine -> Module -> ExceptT String IO String

produce target-specific assembly as a String

writeTargetAssemblyToFile :: TargetMachine -> File -> Module -> ExceptT String IO ()

write target-specific assembly directly into a file

moduleObject :: TargetMachine -> Module -> ExceptT String IO ByteString

produce target-specific object code as a ByteString

writeObjectToFile :: TargetMachine -> File -> Module -> ExceptT String IO ()

write target-specific object code directly into a file

linkModules

Arguments

:: Bool

True to leave the right module unmodified, False to cannibalize it (for efficiency's sake).

-> Module

The module into which to link

-> Module

The module to link into the other (and cannibalize or not)

-> ExceptT String IO ()

link LLVM modules - move or copy parts of a source module into a destination module. Note that this operation is not commutative - not only concretely (e.g. the destination module is modified, becoming the result) but abstractly (e.g. unused private globals in the source module do not appear in the result, but similar globals in the destination remain).