1 (*===-- tools/ml/llvm.ml - LLVM Ocaml Interface ---------------------------===*
3 * The LLVM Compiler Infrastructure
5 * This file was developed by Gordon Henriksen and is distributed under the
6 * University of Illinois Open Source License. See LICENSE.TXT for details.
8 *===----------------------------------------------------------------------===
10 * This interface provides an ocaml API for the LLVM intermediate
11 * representation, the classes in the VMCore library.
13 *===----------------------------------------------------------------------===*)
16 (* These abstract types correlate directly to the LLVM VMCore classes. *)
21 type llbasicblock (* These are actually values, but
22 benefit from type checking. *)
49 | External_weak_linkage
55 | Protected_visibility
60 val x86_stdcallcc : int
61 val x86_fastcallcc : int
94 (*===-- Modules -----------------------------------------------------------===*)
96 (* Creates a module with the supplied module ID. Modules are not garbage
97 collected; it is mandatory to call dispose_module to free memory. *)
98 external create_module : string -> llmodule = "llvm_create_module"
100 (* Disposes a module. All references to subordinate objects are invalidated;
101 referencing them will invoke undefined behavior. *)
102 external dispose_module : llmodule -> unit = "llvm_dispose_module"
104 (* Adds a named type to the module's symbol table. Returns true if successful.
105 If such a name already exists, then no entry is added and returns false. *)
106 external define_type_name : string -> lltype -> llmodule -> bool
107 = "llvm_add_type_name"
109 external delete_type_name : string -> llmodule -> unit
110 = "llvm_delete_type_name"
113 (*===-- Types -------------------------------------------------------------===*)
114 external classify_type : lltype -> type_kind = "llvm_classify_type"
115 external refine_abstract_type : lltype -> lltype -> unit
116 = "llvm_refine_abstract_type"
117 val string_of_lltype : lltype -> string
119 (*--... Operations on integer types ........................................--*)
122 val i16_type : lltype
123 val i32_type : lltype
124 val i64_type : lltype
125 external integer_type : int -> lltype = "llvm_integer_type"
126 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
128 (*--... Operations on real types ...........................................--*)
129 val float_type : lltype
130 val double_type : lltype
131 val x86fp80_type : lltype
132 val fp128_type : lltype
133 val ppc_fp128_type : lltype
135 (*--... Operations on function types .......................................--*)
136 (* FIXME: handle parameter attributes *)
137 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
138 external var_arg_function_type : lltype -> lltype array -> lltype
139 = "llvm_var_arg_function_type"
140 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
141 external return_type : lltype -> lltype = "LLVMGetReturnType"
142 external param_types : lltype -> lltype array = "llvm_param_types"
144 (*--... Operations on struct types .........................................--*)
145 external struct_type : lltype array -> lltype = "llvm_struct_type"
146 external packed_struct_type : lltype array -> lltype = "llvm_packed_struct_type"
147 external element_types : lltype -> lltype array = "llvm_element_types"
148 external is_packed : lltype -> bool = "llvm_is_packed"
150 (*--... Operations on pointer, vector, and array types .....................--*)
151 external array_type : lltype -> int -> lltype = "llvm_array_type"
152 external pointer_type : lltype -> lltype = "LLVMPointerType"
153 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
155 external element_type : lltype -> lltype = "LLVMGetElementType"
156 external array_length : lltype -> int = "llvm_array_length"
157 external vector_size : lltype -> int = "llvm_vector_size"
159 (*--... Operations on other types ..........................................--*)
160 external opaque_type : unit -> lltype = "llvm_opaque_type"
161 val void_type : lltype
162 val label_type : lltype
164 (*--... Operations on type handles .........................................--*)
165 external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type"
166 external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle"
167 external refine_type : lltype -> lltype -> unit = "llvm_refine_type"
170 (*===-- Values ------------------------------------------------------------===*)
171 external type_of : llvalue -> lltype = "llvm_type_of"
172 external value_name : llvalue -> string = "llvm_value_name"
173 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
174 external dump_value : llvalue -> unit = "llvm_dump_value"
176 (*--... Operations on constants of (mostly) any type .......................--*)
177 external is_constant : llvalue -> bool = "llvm_is_constant"
178 external const_null : lltype -> llvalue = "LLVMConstNull"
179 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
180 external undef : lltype -> llvalue = "LLVMGetUndef"
181 external is_null : llvalue -> bool = "llvm_is_null"
182 external is_undef : llvalue -> bool = "llvm_is_undef"
184 (*--... Operations on scalar constants .....................................--*)
185 external const_int : lltype -> int -> llvalue = "llvm_const_int"
186 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
187 = "llvm_const_of_int64"
188 external const_float : lltype -> float -> llvalue = "llvm_const_float"
190 (*--... Operations on composite constants ..................................--*)
191 external const_string : string -> llvalue = "llvm_const_string"
192 external const_stringz : string -> llvalue = "llvm_const_stringz"
193 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
194 external const_struct : llvalue array -> llvalue = "llvm_const_struct"
195 external const_packed_struct : llvalue array -> llvalue
196 = "llvm_const_packed_struct"
197 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
199 (*--... Constant expressions ...............................................--*)
200 external size_of : lltype -> llvalue = "LLVMSizeOf"
201 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
202 external const_not : llvalue -> llvalue = "LLVMConstNot"
203 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
204 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
205 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
206 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
207 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
208 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
209 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
210 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
211 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
212 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
213 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
214 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
215 external const_icmp : int_predicate -> llvalue -> llvalue -> llvalue
217 external const_fcmp : real_predicate -> llvalue -> llvalue -> llvalue
219 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
220 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
221 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
222 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
223 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
224 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
225 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
226 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
227 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
228 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
229 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
230 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
231 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
232 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
233 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
234 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
235 external const_select : llvalue -> llvalue -> llvalue -> llvalue
237 external const_extractelement : llvalue -> llvalue -> llvalue
238 = "LLVMConstExtractElement"
239 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
240 = "LLVMConstInsertElement"
241 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
242 = "LLVMConstShuffleVector"
244 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
245 external is_declaration : llvalue -> bool = "llvm_is_declaration"
246 external linkage : llvalue -> linkage = "llvm_linkage"
247 external set_linkage : linkage -> llvalue -> unit = "llvm_set_linkage"
248 external section : llvalue -> string = "llvm_section"
249 external set_section : string -> llvalue -> unit = "llvm_set_section"
250 external visibility : llvalue -> visibility = "llvm_visibility"
251 external set_visibility : visibility -> llvalue -> unit = "llvm_set_visibility"
252 external alignment : llvalue -> int = "llvm_alignment"
253 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
254 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
255 external set_global_constant : bool -> llvalue -> unit
256 = "llvm_set_global_constant"
258 (*--... Operations on global variables .....................................--*)
259 external declare_global : lltype -> string -> llmodule -> llvalue
260 = "llvm_declare_global"
261 external define_global : string -> llvalue -> llmodule -> llvalue
262 = "llvm_define_global"
263 external lookup_global : string -> llmodule -> llvalue option
264 = "llvm_lookup_global"
265 external delete_global : llvalue -> unit = "llvm_delete_global"
266 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
267 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
268 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
269 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
270 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
272 (*--... Operations on functions ............................................--*)
273 external declare_function : string -> lltype -> llmodule -> llvalue
274 = "llvm_declare_function"
275 external define_function : string -> lltype -> llmodule -> llvalue
276 = "llvm_define_function"
277 external lookup_function : string -> llmodule -> llvalue option
278 = "llvm_lookup_function"
279 external delete_function : llvalue -> unit = "llvm_delete_function"
280 external params : llvalue -> llvalue array = "llvm_params"
281 external param : llvalue -> int -> llvalue = "llvm_param"
282 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
283 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
284 external set_function_call_conv : int -> llvalue -> unit
285 = "llvm_set_function_call_conv"
287 (*--... Operations on basic blocks .........................................--*)
288 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
289 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
290 external delete_block : llbasicblock -> unit = "llvm_delete_block"
291 external append_block : string -> llvalue -> llbasicblock = "llvm_append_block"
292 external insert_block : string -> llbasicblock -> llbasicblock
293 = "llvm_insert_block"
294 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
295 external value_is_block : llvalue -> bool = "llvm_value_is_block"
296 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
299 (*===-- Instruction builders ----------------------------------------------===*)
300 external builder_before : llvalue -> llbuilder = "llvm_builder_before"
301 external builder_at_end : llbasicblock -> llbuilder = "llvm_builder_at_end"
302 external position_before : llvalue -> llbuilder -> unit = "llvm_position_before"
303 external position_at_end : llbasicblock -> llbuilder -> unit
304 = "llvm_position_at_end"
306 (*--... Terminators ........................................................--*)
307 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
308 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
309 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
310 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
311 llvalue = "llvm_build_cond_br"
312 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
313 = "llvm_build_switch"
314 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
315 llbasicblock -> string -> llbuilder -> llvalue
316 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
317 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
318 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
320 (*--... Arithmetic .........................................................--*)
321 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
323 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
325 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
327 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
329 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
331 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
333 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
335 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
337 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
339 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
341 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
343 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
345 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
347 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
349 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
351 external build_neg : llvalue -> string -> llbuilder -> llvalue
353 external build_not : llvalue -> string -> llbuilder -> llvalue
356 (*--... Memory .............................................................--*)
357 external build_malloc : lltype -> string -> llbuilder -> llvalue
358 = "llvm_build_malloc"
359 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
360 llvalue = "llvm_build_array_malloc"
361 external build_alloca : lltype -> string -> llbuilder -> llvalue
362 = "llvm_build_alloca"
363 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
364 llvalue = "llvm_build_array_alloca"
365 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
366 external build_load : llvalue -> string -> llbuilder -> llvalue
368 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
370 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
373 (*--... Casts ..............................................................--*)
374 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
376 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
378 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
380 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
381 = "llvm_build_fptoui"
382 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
383 = "llvm_build_fptosi"
384 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
385 = "llvm_build_uitofp"
386 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
387 = "llvm_build_sitofp"
388 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
389 = "llvm_build_fptrunc"
390 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
392 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
393 = "llvm_build_prttoint"
394 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
395 = "llvm_build_inttoptr"
396 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
397 = "llvm_build_bitcast"
399 (*--... Comparisons ........................................................--*)
400 external build_icmp : int_predicate -> llvalue -> llvalue -> string ->
401 llbuilder -> llvalue = "llvm_build_icmp"
402 external build_fcmp : real_predicate -> llvalue -> llvalue -> string ->
403 llbuilder -> llvalue = "llvm_build_fcmp"
405 (*--... Miscellaneous instructions .........................................--*)
406 external build_phi : lltype -> string -> llbuilder -> llvalue = "llvm_build_phi"
407 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
409 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
410 llvalue = "llvm_build_select"
411 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
412 = "llvm_build_va_arg"
413 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
414 llvalue = "llvm_build_extractelement"
415 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
416 llbuilder -> llvalue = "llvm_build_insertelement"
417 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
418 llbuilder -> llvalue = "llvm_build_shufflevector"