package llvm

You can search for identifiers within the package.

in-package search v0.2.0

llvm.all_backends.shared
- Llvm_all_backends
llvm.all_backends.static
- Llvm_all_backends
llvm.analysis.shared
- Llvm_analysis
llvm.analysis.static
- Llvm_analysis
llvm.bitreader.shared
- Llvm_bitreader
llvm.bitreader.static
- Llvm_bitreader
llvm.bitwriter.shared
- Llvm_bitwriter
llvm.bitwriter.static
- Llvm_bitwriter
llvm.debuginfo.shared
- Llvm_debuginfo
llvm.debuginfo.static
- Llvm_debuginfo
llvm.executionengine.shared
- Llvm_executionengine
llvm.executionengine.static
- Llvm_executionengine
llvm.ipo.shared
- Llvm_ipo
llvm.ipo.static
- Llvm_ipo
llvm.irreader.shared
- Llvm_irreader
llvm.irreader.static
- Llvm_irreader
llvm.linker.shared
- Llvm_linker
llvm.linker.static
- Llvm_linker
llvm.passmgr_builder.shared
- Llvm_passmgr_builder
llvm.passmgr_builder.static
- Llvm_passmgr_builder
llvm.scalar_opts.shared
- Llvm_scalar_opts
llvm.scalar_opts.static
- Llvm_scalar_opts
llvm.shared
- Llvm
llvm.static
- Llvm
llvm.target.shared
- Llvm_target
llvm.target.static
- Llvm_target
llvm.transform_utils.shared
- Llvm_transform_utils
llvm.transform_utils.static
- Llvm_transform_utils
llvm.vectorize.shared
- Llvm_vectorize
llvm.vectorize.static
- Llvm_vectorize
llvm_AArch64.shared
- Llvm_AArch64
llvm_AArch64.static
- Llvm_AArch64
llvm_AMDGPU.shared
- Llvm_AMDGPU
llvm_AMDGPU.static
- Llvm_AMDGPU
llvm_ARM.shared
- Llvm_ARM
llvm_ARM.static
- Llvm_ARM
llvm_AVR.shared
- Llvm_AVR
llvm_AVR.static
- Llvm_AVR
llvm_BPF.shared
- Llvm_BPF
llvm_BPF.static
- Llvm_BPF
llvm_Hexagon.shared
- Llvm_Hexagon
llvm_Hexagon.static
- Llvm_Hexagon
llvm_Lanai.shared
- Llvm_Lanai
llvm_Lanai.static
- Llvm_Lanai
llvm_LoongArch.shared
- Llvm_LoongArch
llvm_LoongArch.static
- Llvm_LoongArch
llvm_M68k.shared
- Llvm_M68k
llvm_M68k.static
- Llvm_M68k
llvm_MSP430.shared
- Llvm_MSP430
llvm_MSP430.static
- Llvm_MSP430
llvm_Mips.shared
- Llvm_Mips
llvm_Mips.static
- Llvm_Mips
llvm_NVPTX.shared
- Llvm_NVPTX
llvm_NVPTX.static
- Llvm_NVPTX
llvm_PowerPC.shared
- Llvm_PowerPC
llvm_PowerPC.static
- Llvm_PowerPC
llvm_RISCV.shared
- Llvm_RISCV
llvm_RISCV.static
- Llvm_RISCV
llvm_Sparc.shared
- Llvm_Sparc
llvm_Sparc.static
- Llvm_Sparc
llvm_SystemZ.shared
- Llvm_SystemZ
llvm_SystemZ.static
- Llvm_SystemZ
llvm_VE.shared
- Llvm_VE
llvm_VE.static
- Llvm_VE
llvm_WebAssembly.shared
- Llvm_WebAssembly
llvm_WebAssembly.static
- Llvm_WebAssembly
llvm_X86.shared
- Llvm_X86
llvm_X86.static
- Llvm_X86
llvm_XCore.shared
- Llvm_XCore
llvm_XCore.static
- Llvm_XCore
llvm_Xtensa.shared
- Llvm_Xtensa
llvm_Xtensa.static
- Llvm_Xtensa

Legend:
Library
Module
Module type
Parameter
Class
Class type

JIT Interpreter.

This interface provides an OCaml API for LLVM execution engine (JIT/ interpreter), the classes in the ExecutionEngine library.

exception Error of string

val initialize : unit -> bool

initialize () initializes the backend corresponding to the host. Returns true if initialization is successful; false indicates that there is no such backend or it is unable to emit object code via MCJIT.

type llexecutionengine

An execution engine is either a JIT compiler or an interpreter, capable of directly loading an LLVM module and executing its functions without first invoking a static compiler and generating a native executable.

type llcompileroptions = {

opt_level : int;
code_model : Llvm_target.CodeModel.t;
no_framepointer_elim : bool;
enable_fast_isel : bool;

}

MCJIT compiler options. See llvm::TargetOptions.

val default_compiler_options : llcompileroptions

Default MCJIT compiler options: { opt_level = 0; code_model = CodeModel.JIT_default; no_framepointer_elim = false; enable_fast_isel = false }

val create : ?options:llcompileroptions -> Llvm.llmodule -> llexecutionengine

create m optlevel creates a new MCJIT just-in-time compiler, taking ownership of the module m if successful with the desired optimization level optlevel. Raises Error msg if an error occurrs. The execution engine is not garbage collected and must be destroyed with dispose ee.

Run initialize before using this function.

See the function llvm::EngineBuilder::create.

val dispose : llexecutionengine -> unit

dispose ee releases the memory used by the execution engine and must be invoked to avoid memory leaks.

val add_module : Llvm.llmodule -> llexecutionengine -> unit

add_module m ee adds the module m to the execution engine ee.

val remove_module : Llvm.llmodule -> llexecutionengine -> unit

remove_module m ee removes the module m from the execution engine ee. Raises Error msg if an error occurs.

val run_static_ctors : llexecutionengine -> unit

run_static_ctors ee executes the static constructors of each module in the execution engine ee.

val run_static_dtors : llexecutionengine -> unit

run_static_dtors ee executes the static destructors of each module in the execution engine ee.

val data_layout : llexecutionengine -> Llvm_target.DataLayout.t

data_layout ee is the data layout of the execution engine ee.

val add_global_mapping : 
  Llvm.llvalue ->
  'a Ctypes.ptr ->
  llexecutionengine ->
  unit

add_global_mapping gv ptr ee tells the execution engine ee that the global gv is at the specified location ptr, which must outlive gv and ee. All uses of gv in the compiled code will refer to ptr.

val get_global_value_address : 
  string ->
  'a Ctypes.typ ->
  llexecutionengine ->
  'a

get_global_value_address id typ ee returns a pointer to the identifier id as type typ, which will be a pointer type for a value, and which will be live as long as id and ee are. Caution: this function finalizes, i.e. forces code generation, all loaded modules. Further modifications to the modules will not have any effect.

val get_function_address : string -> 'a Ctypes.typ -> llexecutionengine -> 'a

get_function_address fn typ ee returns a pointer to the function fn as type typ, which will be a pointer type for a function (e.g. (int -> int) typ), and which will be live as long as fn and ee are. Caution: this function finalizes, i.e. forces code generation, all loaded modules. Further modifications to the modules will not have any effect.