llvm-hs-5.0.0: General purpose LLVM bindings

Safe HaskellNone
LanguageHaskell98

LLVM.Internal.Module

Description

This Haskell module is for/of functions for handling LLVM modules.

Synopsis

Documentation

deleteModule :: Module -> IO () Source #

Signal that a module does no longer exist and thus must not be disposed. It is the responsibility of the caller to ensure that the module has been disposed. If you use only the functions provided by llvm-hs you should never call this yourself.

newtype File Source #

A newtype to distinguish strings used for paths from other strings

Constructors

File FilePath 

linkModules Source #

Arguments

:: Module

The module into which to link

-> Module

The module to link into the other (this module is destroyed)

-> 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). The source module is destroyed. May throw a LinkException.

withModuleFromLLVMAssembly :: LLVMAssemblyInput s => Context -> s -> (Module -> IO a) -> IO a Source #

parse Module from LLVM assembly. May throw ParseFailureException.

moduleLLVMAssembly :: Module -> IO ByteString Source #

generate LLVM assembly from a Module

writeLLVMAssemblyToFile :: File -> Module -> IO () Source #

write LLVM assembly for a Module to a file

class BitcodeInput b where Source #

Minimal complete definition

bitcodeMemoryBuffer

Methods

bitcodeMemoryBuffer :: (MonadThrow m, MonadIO m, MonadAnyCont IO m) => b -> m (Ptr MemoryBuffer) Source #

withModuleFromBitcode :: BitcodeInput b => Context -> b -> (Module -> IO a) -> IO a Source #

parse Module from LLVM bitcode. May throw ParseFailureException.

moduleBitcode :: Module -> IO ByteString Source #

generate LLVM bitcode from a Module

writeBitcodeToFile :: File -> Module -> IO () Source #

write LLVM bitcode from a Module into a file

writeTargetAssemblyToFile :: TargetMachine -> File -> Module -> IO () Source #

write target-specific assembly directly into a file

moduleTargetAssembly :: TargetMachine -> Module -> IO ByteString Source #

produce target-specific assembly as a ByteString

moduleObject :: TargetMachine -> Module -> IO ByteString Source #

produce target-specific object code as a ByteString

writeObjectToFile :: TargetMachine -> File -> Module -> IO () Source #

write target-specific object code directly into a file

withModuleFromAST :: Context -> Module -> (Module -> IO a) -> IO a Source #

Execute a function after encoding the module in LLVM’s internal representation. May throw EncodeException.

moduleAST :: Module -> IO Module Source #

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