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. *)
20 type llbasicblock (* These are actually values, but
21 benefit from type checking. *)
48 | External_weak_linkage
54 | Protected_visibility
59 let x86_stdcallcc = 64
60 let x86_fastcallcc = 65
93 (*===-- Modules -----------------------------------------------------------===*)
95 (* Creates a module with the supplied module ID. Modules are not garbage
96 collected; it is mandatory to call dispose_module to free memory. *)
97 external create_module : string -> llmodule = "llvm_create_module"
99 (* Disposes a module. All references to subordinate objects are invalidated;
100 referencing them will invoke undefined behavior. *)
101 external dispose_module : llmodule -> unit = "llvm_dispose_module"
103 (* Adds a named type to the module's symbol table. Returns true if successful.
104 If such a name already exists, then no entry is added and returns false. *)
105 external define_type_name : string -> lltype -> llmodule -> bool
106 = "llvm_add_type_name"
108 external delete_type_name : string -> llmodule -> unit
109 = "llvm_delete_type_name"
112 (*===-- Types -------------------------------------------------------------===*)
114 external classify_type : lltype -> type_kind = "llvm_classify_type"
115 external refine_abstract_type : lltype -> lltype -> unit
116 = "llvm_refine_abstract_type"
118 (*--... Operations on integer types ........................................--*)
119 external _i1_type : unit -> lltype = "llvm_i1_type"
120 external _i8_type : unit -> lltype = "llvm_i8_type"
121 external _i16_type : unit -> lltype = "llvm_i16_type"
122 external _i32_type : unit -> lltype = "llvm_i32_type"
123 external _i64_type : unit -> lltype = "llvm_i64_type"
125 let i1_type = _i1_type ()
126 let i8_type = _i8_type ()
127 let i16_type = _i16_type ()
128 let i32_type = _i32_type ()
129 let i64_type = _i64_type ()
131 external integer_type : int -> lltype = "llvm_integer_type"
132 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
134 (*--... Operations on real types ...........................................--*)
135 external _float_type : unit -> lltype = "llvm_float_type"
136 external _double_type : unit -> lltype = "llvm_double_type"
137 external _x86fp80_type : unit -> lltype = "llvm_x86fp80_type"
138 external _fp128_type : unit -> lltype = "llvm_fp128_type"
139 external _ppc_fp128_type : unit -> lltype = "llvm_ppc_fp128_type"
141 let float_type = _float_type ()
142 let double_type = _double_type ()
143 let x86fp80_type = _x86fp80_type ()
144 let fp128_type = _fp128_type ()
145 let ppc_fp128_type = _ppc_fp128_type ()
147 (*--... Operations on function types .......................................--*)
148 (* FIXME: handle parameter attributes *)
149 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
150 external var_arg_function_type : lltype -> lltype array -> lltype
151 = "llvm_var_arg_function_type"
152 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
153 external return_type : lltype -> lltype = "LLVMGetReturnType"
154 external param_types : lltype -> lltype array = "llvm_param_types"
156 (*--... Operations on struct types .........................................--*)
157 external struct_type : lltype array -> lltype = "llvm_struct_type"
158 external packed_struct_type : lltype array -> lltype = "llvm_packed_struct_type"
159 external element_types : lltype -> lltype array = "llvm_element_types"
160 external is_packed : lltype -> bool = "llvm_is_packed"
162 (*--... Operations on pointer, vector, and array types .....................--*)
163 external array_type : lltype -> int -> lltype = "llvm_array_type"
164 external pointer_type : lltype -> lltype = "LLVMPointerType"
165 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
167 external element_type : lltype -> lltype = "LLVMGetElementType"
168 external array_length : lltype -> int = "llvm_array_length"
169 external vector_size : lltype -> int = "llvm_vector_size"
171 (*--... Operations on other types ..........................................--*)
172 external opaque_type : unit -> lltype = "llvm_opaque_type"
173 external _void_type : unit -> lltype = "llvm_void_type"
174 external _label_type : unit -> lltype = "llvm_label_type"
176 let void_type = _void_type ()
177 let label_type = _label_type ()
180 (*===-- Values ------------------------------------------------------------===*)
182 external type_of : llvalue -> lltype = "llvm_type_of"
183 external value_name : llvalue -> string = "llvm_value_name"
184 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
185 external dump_value : llvalue -> unit = "llvm_dump_value"
187 (*--... Operations on constants of (mostly) any type .......................--*)
188 external is_constant : llvalue -> bool = "llvm_is_constant"
189 external const_null : lltype -> llvalue = "LLVMConstNull"
190 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
191 external undef : lltype -> llvalue = "LLVMGetUndef"
192 external is_null : llvalue -> bool = "llvm_is_null"
193 external is_undef : llvalue -> bool = "llvm_is_undef"
195 (*--... Operations on scalar constants .....................................--*)
196 external const_int : lltype -> int -> llvalue = "llvm_const_int"
197 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
198 = "llvm_const_of_int64"
199 external const_float : lltype -> float -> llvalue = "llvm_const_float"
201 (*--... Operations on composite constants ..................................--*)
202 external const_string : string -> llvalue = "llvm_const_string"
203 external const_stringz : string -> llvalue = "llvm_const_stringz"
204 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
205 external const_struct : llvalue array -> llvalue = "llvm_const_struct"
206 external const_packed_struct : llvalue array -> llvalue
207 = "llvm_const_packed_struct"
208 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
210 (*--... Constant expressions ...............................................--*)
211 external size_of : lltype -> llvalue = "LLVMSizeOf"
212 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
213 external const_not : llvalue -> llvalue = "LLVMConstNot"
214 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
215 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
216 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
217 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
218 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
219 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
220 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
221 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
222 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
223 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
224 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
225 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
226 external const_icmp : int_predicate -> llvalue -> llvalue -> llvalue
228 external const_fcmp : real_predicate -> llvalue -> llvalue -> llvalue
230 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
231 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
232 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
233 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
234 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
235 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
236 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
237 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
238 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
239 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
240 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
241 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
242 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
243 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
244 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
245 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
246 external const_select : llvalue -> llvalue -> llvalue -> llvalue
248 external const_extractelement : llvalue -> llvalue -> llvalue
249 = "LLVMConstExtractElement"
250 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
251 = "LLVMConstInsertElement"
252 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
253 = "LLVMConstShuffleVector"
255 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
256 external is_declaration : llvalue -> bool = "llvm_is_declaration"
257 external linkage : llvalue -> linkage = "llvm_linkage"
258 external set_linkage : linkage -> llvalue -> unit = "llvm_set_linkage"
259 external section : llvalue -> string = "llvm_section"
260 external set_section : string -> llvalue -> unit = "llvm_set_section"
261 external visibility : llvalue -> visibility = "llvm_visibility"
262 external set_visibility : visibility -> llvalue -> unit = "llvm_set_visibility"
263 external alignment : llvalue -> int = "llvm_alignment"
264 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
266 (*--... Operations on global variables .....................................--*)
267 external declare_global : lltype -> string -> llmodule -> llvalue
268 = "llvm_declare_global"
269 external define_global : string -> llvalue -> llmodule -> llvalue
270 = "llvm_define_global"
271 external delete_global : llvalue -> unit = "llvm_delete_global"
272 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
273 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
274 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
275 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
276 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
278 (*--... Operations on functions ............................................--*)
279 external declare_function : string -> lltype -> llmodule -> llvalue
280 = "llvm_declare_function"
281 external define_function : string -> lltype -> llmodule -> llvalue
282 = "llvm_define_function"
283 external delete_function : llvalue -> unit = "llvm_delete_function"
284 external params : llvalue -> llvalue array = "llvm_params"
285 external param : llvalue -> int -> llvalue = "llvm_param"
286 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
287 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
288 external set_function_call_conv : int -> llvalue -> unit
289 = "llvm_set_function_call_conv"
291 (* TODO: param attrs *)
293 (*--... Operations on basic blocks .........................................--*)
294 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
295 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
296 external delete_block : llbasicblock -> unit = "llvm_delete_block"
297 external append_block : string -> llvalue -> llbasicblock = "llvm_append_block"
298 external insert_block : string -> llbasicblock -> llbasicblock
299 = "llvm_insert_block"
300 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
301 external value_is_block : llvalue -> bool = "llvm_value_is_block"
302 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
305 (*===-- Instruction builders ----------------------------------------------===*)
306 external builder_before : llvalue -> llbuilder = "llvm_builder_before"
307 external builder_at_end : llbasicblock -> llbuilder = "llvm_builder_at_end"
308 external position_before : llvalue -> llbuilder -> unit = "llvm_position_before"
309 external position_at_end : llbasicblock -> llbuilder -> unit
310 = "llvm_position_at_end"
312 (*--... Terminators ........................................................--*)
313 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
314 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
315 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
316 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
317 llvalue = "llvm_build_cond_br"
318 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
319 = "llvm_build_switch"
320 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
321 llbasicblock -> string -> llbuilder -> llvalue
322 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
323 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
324 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
326 (*--... Arithmetic .........................................................--*)
327 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
329 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
331 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
333 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
335 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
337 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
339 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
341 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
343 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
345 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
347 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
349 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
351 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
353 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
355 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
357 external build_neg : llvalue -> string -> llbuilder -> llvalue
359 external build_not : llvalue -> string -> llbuilder -> llvalue
362 (*--... Memory .............................................................--*)
363 external build_malloc : lltype -> string -> llbuilder -> llvalue
364 = "llvm_build_malloc"
365 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
366 llvalue = "llvm_build_array_malloc"
367 external build_alloca : lltype -> string -> llbuilder -> llvalue
368 = "llvm_build_alloca"
369 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
370 llvalue = "llvm_build_array_alloca"
371 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
372 external build_load : llvalue -> string -> llbuilder -> llvalue
374 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
376 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
379 (*--... Casts ..............................................................--*)
380 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
382 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
384 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
386 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
387 = "llvm_build_fptoui"
388 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
389 = "llvm_build_fptosi"
390 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
391 = "llvm_build_uitofp"
392 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
393 = "llvm_build_sitofp"
394 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
395 = "llvm_build_fptrunc"
396 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
398 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
399 = "llvm_build_prttoint"
400 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
401 = "llvm_build_inttoptr"
402 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
403 = "llvm_build_bitcast"
405 (*--... Comparisons ........................................................--*)
406 external build_icmp : int_predicate -> llvalue -> llvalue -> string ->
407 llbuilder -> llvalue = "llvm_build_icmp"
408 external build_fcmp : real_predicate -> llvalue -> llvalue -> string ->
409 llbuilder -> llvalue = "llvm_build_fcmp"
411 (*--... Miscellaneous instructions .........................................--*)
412 external build_phi : lltype -> string -> llbuilder -> llvalue = "llvm_build_phi"
413 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
415 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
416 llvalue = "llvm_build_select"
417 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
418 = "llvm_build_va_arg"
419 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
420 llvalue = "llvm_build_extractelement"
421 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
422 llbuilder -> llvalue = "llvm_build_insertelement"
423 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
424 llbuilder -> llvalue = "llvm_build_shufflevector"
427 (*===-- Non-Externs -------------------------------------------------------===*)
428 (* These functions are built using the externals, so must be declared late. *)
430 let concat2 sep arr =
432 if 0 < Array.length arr then begin
434 for i = 1 to (Array.length arr) - 1 do
435 s := !s ^ sep ^ arr.(i)
440 let rec string_of_lltype ty =
441 match classify_type ty with
442 Integer_type -> "i" ^ string_of_int (integer_bitwidth ty)
443 | Pointer_type -> (string_of_lltype (element_type ty)) ^ "*"
445 let s = "{ " ^ (concat2 ", " (
446 Array.map string_of_lltype (element_types ty)
451 | Array_type -> "[" ^ (string_of_int (array_length ty)) ^
452 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
453 | Vector_type -> "<" ^ (string_of_int (vector_size ty)) ^
454 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
455 | Opaque_type -> "opaque"
456 | Function_type -> string_of_lltype (return_type ty) ^
457 " (" ^ (concat2 ", " (
458 Array.map string_of_lltype (param_types ty)
460 | Label_type -> "label"
461 | Ppc_fp128_type -> "ppc_fp128"
462 | Fp128_type -> "fp128"
463 | X86fp80_type -> "x86_fp80"
464 | Double_type -> "double"
465 | Float_type -> "float"
466 | Void_type -> "void"