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 let x86_stdcallcc = 64
61 let x86_fastcallcc = 65
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 -------------------------------------------------------------===*)
115 external classify_type : lltype -> type_kind = "llvm_classify_type"
116 external refine_abstract_type : lltype -> lltype -> unit
117 = "llvm_refine_abstract_type"
119 (*--... Operations on integer types ........................................--*)
120 external _i1_type : unit -> lltype = "llvm_i1_type"
121 external _i8_type : unit -> lltype = "llvm_i8_type"
122 external _i16_type : unit -> lltype = "llvm_i16_type"
123 external _i32_type : unit -> lltype = "llvm_i32_type"
124 external _i64_type : unit -> lltype = "llvm_i64_type"
126 let i1_type = _i1_type ()
127 let i8_type = _i8_type ()
128 let i16_type = _i16_type ()
129 let i32_type = _i32_type ()
130 let i64_type = _i64_type ()
132 external integer_type : int -> lltype = "llvm_integer_type"
133 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
135 (*--... Operations on real types ...........................................--*)
136 external _float_type : unit -> lltype = "llvm_float_type"
137 external _double_type : unit -> lltype = "llvm_double_type"
138 external _x86fp80_type : unit -> lltype = "llvm_x86fp80_type"
139 external _fp128_type : unit -> lltype = "llvm_fp128_type"
140 external _ppc_fp128_type : unit -> lltype = "llvm_ppc_fp128_type"
142 let float_type = _float_type ()
143 let double_type = _double_type ()
144 let x86fp80_type = _x86fp80_type ()
145 let fp128_type = _fp128_type ()
146 let ppc_fp128_type = _ppc_fp128_type ()
148 (*--... Operations on function types .......................................--*)
149 (* FIXME: handle parameter attributes *)
150 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
151 external var_arg_function_type : lltype -> lltype array -> lltype
152 = "llvm_var_arg_function_type"
153 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
154 external return_type : lltype -> lltype = "LLVMGetReturnType"
155 external param_types : lltype -> lltype array = "llvm_param_types"
157 (*--... Operations on struct types .........................................--*)
158 external struct_type : lltype array -> lltype = "llvm_struct_type"
159 external packed_struct_type : lltype array -> lltype = "llvm_packed_struct_type"
160 external element_types : lltype -> lltype array = "llvm_element_types"
161 external is_packed : lltype -> bool = "llvm_is_packed"
163 (*--... Operations on pointer, vector, and array types .....................--*)
164 external array_type : lltype -> int -> lltype = "llvm_array_type"
165 external pointer_type : lltype -> lltype = "LLVMPointerType"
166 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
168 external element_type : lltype -> lltype = "LLVMGetElementType"
169 external array_length : lltype -> int = "llvm_array_length"
170 external vector_size : lltype -> int = "llvm_vector_size"
172 (*--... Operations on other types ..........................................--*)
173 external opaque_type : unit -> lltype = "llvm_opaque_type"
174 external _void_type : unit -> lltype = "llvm_void_type"
175 external _label_type : unit -> lltype = "llvm_label_type"
177 let void_type = _void_type ()
178 let label_type = _label_type ()
180 (*--... Operations on type handles .........................................--*)
181 external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type"
182 external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle"
183 external refine_type : lltype -> lltype -> unit = "llvm_refine_type"
186 (*===-- Values ------------------------------------------------------------===*)
188 external type_of : llvalue -> lltype = "llvm_type_of"
189 external value_name : llvalue -> string = "llvm_value_name"
190 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
191 external dump_value : llvalue -> unit = "llvm_dump_value"
193 (*--... Operations on constants of (mostly) any type .......................--*)
194 external is_constant : llvalue -> bool = "llvm_is_constant"
195 external const_null : lltype -> llvalue = "LLVMConstNull"
196 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
197 external undef : lltype -> llvalue = "LLVMGetUndef"
198 external is_null : llvalue -> bool = "llvm_is_null"
199 external is_undef : llvalue -> bool = "llvm_is_undef"
201 (*--... Operations on scalar constants .....................................--*)
202 external const_int : lltype -> int -> llvalue = "llvm_const_int"
203 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
204 = "llvm_const_of_int64"
205 external const_float : lltype -> float -> llvalue = "llvm_const_float"
207 (*--... Operations on composite constants ..................................--*)
208 external const_string : string -> llvalue = "llvm_const_string"
209 external const_stringz : string -> llvalue = "llvm_const_stringz"
210 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
211 external const_struct : llvalue array -> llvalue = "llvm_const_struct"
212 external const_packed_struct : llvalue array -> llvalue
213 = "llvm_const_packed_struct"
214 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
216 (*--... Constant expressions ...............................................--*)
217 external size_of : lltype -> llvalue = "LLVMSizeOf"
218 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
219 external const_not : llvalue -> llvalue = "LLVMConstNot"
220 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
221 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
222 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
223 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
224 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
225 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
226 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
227 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
228 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
229 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
230 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
231 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
232 external const_icmp : int_predicate -> llvalue -> llvalue -> llvalue
234 external const_fcmp : real_predicate -> llvalue -> llvalue -> llvalue
236 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
237 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
238 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
239 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
240 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
241 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
242 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
243 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
244 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
245 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
246 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
247 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
248 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
249 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
250 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
251 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
252 external const_select : llvalue -> llvalue -> llvalue -> llvalue
254 external const_extractelement : llvalue -> llvalue -> llvalue
255 = "LLVMConstExtractElement"
256 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
257 = "LLVMConstInsertElement"
258 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
259 = "LLVMConstShuffleVector"
261 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
262 external is_declaration : llvalue -> bool = "llvm_is_declaration"
263 external linkage : llvalue -> linkage = "llvm_linkage"
264 external set_linkage : linkage -> llvalue -> unit = "llvm_set_linkage"
265 external section : llvalue -> string = "llvm_section"
266 external set_section : string -> llvalue -> unit = "llvm_set_section"
267 external visibility : llvalue -> visibility = "llvm_visibility"
268 external set_visibility : visibility -> llvalue -> unit = "llvm_set_visibility"
269 external alignment : llvalue -> int = "llvm_alignment"
270 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
271 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
272 external set_global_constant : bool -> llvalue -> unit
273 = "llvm_set_global_constant"
275 (*--... Operations on global variables .....................................--*)
276 external declare_global : lltype -> string -> llmodule -> llvalue
277 = "llvm_declare_global"
278 external define_global : string -> llvalue -> llmodule -> llvalue
279 = "llvm_define_global"
280 external lookup_global : string -> llmodule -> llvalue option
281 = "llvm_lookup_global"
282 external delete_global : llvalue -> unit = "llvm_delete_global"
283 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
284 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
285 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
286 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
287 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
289 (*--... Operations on functions ............................................--*)
290 external declare_function : string -> lltype -> llmodule -> llvalue
291 = "llvm_declare_function"
292 external define_function : string -> lltype -> llmodule -> llvalue
293 = "llvm_define_function"
294 external lookup_function : string -> llmodule -> llvalue option
295 = "llvm_lookup_function"
296 external delete_function : llvalue -> unit = "llvm_delete_function"
297 external params : llvalue -> llvalue array = "llvm_params"
298 external param : llvalue -> int -> llvalue = "llvm_param"
299 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
300 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
301 external set_function_call_conv : int -> llvalue -> unit
302 = "llvm_set_function_call_conv"
304 (* TODO: param attrs *)
306 (*--... Operations on basic blocks .........................................--*)
307 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
308 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
309 external delete_block : llbasicblock -> unit = "llvm_delete_block"
310 external append_block : string -> llvalue -> llbasicblock = "llvm_append_block"
311 external insert_block : string -> llbasicblock -> llbasicblock
312 = "llvm_insert_block"
313 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
314 external value_is_block : llvalue -> bool = "llvm_value_is_block"
315 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
318 (*===-- Instruction builders ----------------------------------------------===*)
319 external builder_before : llvalue -> llbuilder = "llvm_builder_before"
320 external builder_at_end : llbasicblock -> llbuilder = "llvm_builder_at_end"
321 external position_before : llvalue -> llbuilder -> unit = "llvm_position_before"
322 external position_at_end : llbasicblock -> llbuilder -> unit
323 = "llvm_position_at_end"
325 (*--... Terminators ........................................................--*)
326 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
327 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
328 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
329 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
330 llvalue = "llvm_build_cond_br"
331 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
332 = "llvm_build_switch"
333 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
334 llbasicblock -> string -> llbuilder -> llvalue
335 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
336 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
337 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
339 (*--... Arithmetic .........................................................--*)
340 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
342 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
344 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
346 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
348 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
350 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
352 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
354 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
356 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
358 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
360 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
362 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
364 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
366 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
368 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
370 external build_neg : llvalue -> string -> llbuilder -> llvalue
372 external build_not : llvalue -> string -> llbuilder -> llvalue
375 (*--... Memory .............................................................--*)
376 external build_malloc : lltype -> string -> llbuilder -> llvalue
377 = "llvm_build_malloc"
378 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
379 llvalue = "llvm_build_array_malloc"
380 external build_alloca : lltype -> string -> llbuilder -> llvalue
381 = "llvm_build_alloca"
382 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
383 llvalue = "llvm_build_array_alloca"
384 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
385 external build_load : llvalue -> string -> llbuilder -> llvalue
387 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
389 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
392 (*--... Casts ..............................................................--*)
393 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
395 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
397 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
399 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
400 = "llvm_build_fptoui"
401 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
402 = "llvm_build_fptosi"
403 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
404 = "llvm_build_uitofp"
405 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
406 = "llvm_build_sitofp"
407 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
408 = "llvm_build_fptrunc"
409 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
411 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
412 = "llvm_build_prttoint"
413 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
414 = "llvm_build_inttoptr"
415 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
416 = "llvm_build_bitcast"
418 (*--... Comparisons ........................................................--*)
419 external build_icmp : int_predicate -> llvalue -> llvalue -> string ->
420 llbuilder -> llvalue = "llvm_build_icmp"
421 external build_fcmp : real_predicate -> llvalue -> llvalue -> string ->
422 llbuilder -> llvalue = "llvm_build_fcmp"
424 (*--... Miscellaneous instructions .........................................--*)
425 external build_phi : lltype -> string -> llbuilder -> llvalue = "llvm_build_phi"
426 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
428 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
429 llvalue = "llvm_build_select"
430 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
431 = "llvm_build_va_arg"
432 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
433 llvalue = "llvm_build_extractelement"
434 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
435 llbuilder -> llvalue = "llvm_build_insertelement"
436 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
437 llbuilder -> llvalue = "llvm_build_shufflevector"
440 (*===-- Non-Externs -------------------------------------------------------===*)
441 (* These functions are built using the externals, so must be declared late. *)
443 let concat2 sep arr =
445 if 0 < Array.length arr then begin
447 for i = 1 to (Array.length arr) - 1 do
448 s := !s ^ sep ^ arr.(i)
453 let rec string_of_lltype ty =
454 match classify_type ty with
455 Integer_type -> "i" ^ string_of_int (integer_bitwidth ty)
456 | Pointer_type -> (string_of_lltype (element_type ty)) ^ "*"
458 let s = "{ " ^ (concat2 ", " (
459 Array.map string_of_lltype (element_types ty)
464 | Array_type -> "[" ^ (string_of_int (array_length ty)) ^
465 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
466 | Vector_type -> "<" ^ (string_of_int (vector_size ty)) ^
467 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
468 | Opaque_type -> "opaque"
469 | Function_type -> string_of_lltype (return_type ty) ^
470 " (" ^ (concat2 ", " (
471 Array.map string_of_lltype (param_types ty)
473 | Label_type -> "label"
474 | Ppc_fp128_type -> "ppc_fp128"
475 | Fp128_type -> "fp128"
476 | X86fp80_type -> "x86_fp80"
477 | Double_type -> "double"
478 | Float_type -> "float"
479 | Void_type -> "void"