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 *===----------------------------------------------------------------------===*)
44 | External_weak_linkage
50 | Protected_visibility
55 let x86_stdcallcc = 64
56 let x86_fastcallcc = 65
88 exception IoError of string
90 external register_exns : exn -> unit = "llvm_register_core_exns"
91 let _ = register_exns (IoError "")
94 (*===-- Modules -----------------------------------------------------------===*)
96 external create_module : string -> llmodule = "llvm_create_module"
97 external dispose_module : llmodule -> unit = "llvm_dispose_module"
98 external define_type_name : string -> lltype -> llmodule -> bool
99 = "llvm_add_type_name"
100 external delete_type_name : string -> llmodule -> unit
101 = "llvm_delete_type_name"
104 (*===-- Types -------------------------------------------------------------===*)
106 external classify_type : lltype -> type_kind = "llvm_classify_type"
108 (*--... Operations on integer types ........................................--*)
109 external _i1_type : unit -> lltype = "llvm_i1_type"
110 external _i8_type : unit -> lltype = "llvm_i8_type"
111 external _i16_type : unit -> lltype = "llvm_i16_type"
112 external _i32_type : unit -> lltype = "llvm_i32_type"
113 external _i64_type : unit -> lltype = "llvm_i64_type"
115 let i1_type = _i1_type ()
116 let i8_type = _i8_type ()
117 let i16_type = _i16_type ()
118 let i32_type = _i32_type ()
119 let i64_type = _i64_type ()
121 external integer_type : int -> lltype = "llvm_integer_type"
122 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
124 (*--... Operations on real types ...........................................--*)
125 external _float_type : unit -> lltype = "llvm_float_type"
126 external _double_type : unit -> lltype = "llvm_double_type"
127 external _x86fp80_type : unit -> lltype = "llvm_x86fp80_type"
128 external _fp128_type : unit -> lltype = "llvm_fp128_type"
129 external _ppc_fp128_type : unit -> lltype = "llvm_ppc_fp128_type"
131 let float_type = _float_type ()
132 let double_type = _double_type ()
133 let x86fp80_type = _x86fp80_type ()
134 let fp128_type = _fp128_type ()
135 let ppc_fp128_type = _ppc_fp128_type ()
137 (*--... Operations on function types .......................................--*)
138 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
139 external var_arg_function_type : lltype -> lltype array -> lltype
140 = "llvm_var_arg_function_type"
141 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
142 external return_type : lltype -> lltype = "LLVMGetReturnType"
143 external param_types : lltype -> lltype array = "llvm_param_types"
145 (*--... Operations on struct types .........................................--*)
146 external struct_type : lltype array -> lltype = "llvm_struct_type"
147 external packed_struct_type : lltype array -> lltype = "llvm_packed_struct_type"
148 external element_types : lltype -> lltype array = "llvm_element_types"
149 external is_packed : lltype -> bool = "llvm_is_packed"
151 (*--... Operations on pointer, vector, and array types .....................--*)
152 external array_type : lltype -> int -> lltype = "llvm_array_type"
153 external pointer_type : lltype -> lltype = "llvm_pointer_type"
154 external qualified_pointer_type : lltype -> int -> lltype
155 = "llvm_qualified_pointer_type"
156 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
158 external element_type : lltype -> lltype = "LLVMGetElementType"
159 external array_length : lltype -> int = "llvm_array_length"
160 external address_space : lltype -> int = "llvm_address_space"
161 external vector_size : lltype -> int = "llvm_vector_size"
163 (*--... Operations on other types ..........................................--*)
164 external opaque_type : unit -> lltype = "llvm_opaque_type"
165 external _void_type : unit -> lltype = "llvm_void_type"
166 external _label_type : unit -> lltype = "llvm_label_type"
168 let void_type = _void_type ()
169 let label_type = _label_type ()
171 (*--... Operations on type handles .........................................--*)
172 external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type"
173 external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle"
174 external refine_type : lltype -> lltype -> unit = "llvm_refine_type"
177 (*===-- Values ------------------------------------------------------------===*)
179 external type_of : llvalue -> lltype = "llvm_type_of"
180 external value_name : llvalue -> string = "llvm_value_name"
181 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
182 external dump_value : llvalue -> unit = "llvm_dump_value"
184 (*--... Operations on constants of (mostly) any type .......................--*)
185 external is_constant : llvalue -> bool = "llvm_is_constant"
186 external const_null : lltype -> llvalue = "LLVMConstNull"
187 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
188 external undef : lltype -> llvalue = "LLVMGetUndef"
189 external is_null : llvalue -> bool = "llvm_is_null"
190 external is_undef : llvalue -> bool = "llvm_is_undef"
192 (*--... Operations on scalar constants .....................................--*)
193 external const_int : lltype -> int -> llvalue = "llvm_const_int"
194 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
195 = "llvm_const_of_int64"
196 external const_float : lltype -> float -> llvalue = "llvm_const_float"
198 (*--... Operations on composite constants ..................................--*)
199 external const_string : string -> llvalue = "llvm_const_string"
200 external const_stringz : string -> llvalue = "llvm_const_stringz"
201 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
202 external const_struct : llvalue array -> llvalue = "llvm_const_struct"
203 external const_packed_struct : llvalue array -> llvalue
204 = "llvm_const_packed_struct"
205 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
207 (*--... Constant expressions ...............................................--*)
208 external size_of : lltype -> llvalue = "LLVMSizeOf"
209 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
210 external const_not : llvalue -> llvalue = "LLVMConstNot"
211 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
212 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
213 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
214 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
215 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
216 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
217 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
218 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
219 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
220 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
221 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
222 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
223 external const_icmp : int_predicate -> llvalue -> llvalue -> llvalue
225 external const_fcmp : real_predicate -> llvalue -> llvalue -> llvalue
227 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
228 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
229 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
230 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
231 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
232 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
233 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
234 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
235 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
236 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
237 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
238 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
239 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
240 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
241 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
242 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
243 external const_select : llvalue -> llvalue -> llvalue -> llvalue
245 external const_extractelement : llvalue -> llvalue -> llvalue
246 = "LLVMConstExtractElement"
247 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
248 = "LLVMConstInsertElement"
249 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
250 = "LLVMConstShuffleVector"
252 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
253 external is_declaration : llvalue -> bool = "llvm_is_declaration"
254 external linkage : llvalue -> linkage = "llvm_linkage"
255 external set_linkage : linkage -> llvalue -> unit = "llvm_set_linkage"
256 external section : llvalue -> string = "llvm_section"
257 external set_section : string -> llvalue -> unit = "llvm_set_section"
258 external visibility : llvalue -> visibility = "llvm_visibility"
259 external set_visibility : visibility -> llvalue -> unit = "llvm_set_visibility"
260 external alignment : llvalue -> int = "llvm_alignment"
261 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
262 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
263 external set_global_constant : bool -> llvalue -> unit
264 = "llvm_set_global_constant"
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 lookup_global : string -> llmodule -> llvalue option
272 = "llvm_lookup_global"
273 external delete_global : llvalue -> unit = "llvm_delete_global"
274 external has_initializer : llvalue -> bool = "llvm_has_initializer"
275 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
276 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
277 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
278 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
279 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
281 (*--... Operations on functions ............................................--*)
282 external declare_function : string -> lltype -> llmodule -> llvalue
283 = "llvm_declare_function"
284 external define_function : string -> lltype -> llmodule -> llvalue
285 = "llvm_define_function"
286 external lookup_function : string -> llmodule -> llvalue option
287 = "llvm_lookup_function"
288 external delete_function : llvalue -> unit = "llvm_delete_function"
289 external params : llvalue -> llvalue array = "llvm_params"
290 external param : llvalue -> int -> llvalue = "llvm_param"
291 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
292 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
293 external set_function_call_conv : int -> llvalue -> unit
294 = "llvm_set_function_call_conv"
295 external collector : llvalue -> string option = "llvm_collector"
296 external set_collector : string option -> llvalue -> unit = "llvm_set_collector"
298 (* TODO: param attrs *)
300 (*--... Operations on basic blocks .........................................--*)
301 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
302 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
303 external delete_block : llbasicblock -> unit = "llvm_delete_block"
304 external append_block : string -> llvalue -> llbasicblock = "llvm_append_block"
305 external insert_block : string -> llbasicblock -> llbasicblock
306 = "llvm_insert_block"
307 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
308 external value_is_block : llvalue -> bool = "llvm_value_is_block"
309 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
311 (*--... Operations on phi nodes ............................................--*)
312 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
313 = "llvm_add_incoming"
314 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
317 (*===-- Instruction builders ----------------------------------------------===*)
318 external builder_before : llvalue -> llbuilder = "llvm_builder_before"
319 external builder_at_end : llbasicblock -> llbuilder = "llvm_builder_at_end"
320 external position_before : llvalue -> llbuilder -> unit = "llvm_position_before"
321 external position_at_end : llbasicblock -> llbuilder -> unit
322 = "llvm_position_at_end"
324 (*--... Terminators ........................................................--*)
325 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
326 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
327 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
328 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
329 llvalue = "llvm_build_cond_br"
330 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
331 = "llvm_build_switch"
332 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
333 llbasicblock -> string -> llbuilder -> llvalue
334 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
335 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
336 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
338 (*--... Arithmetic .........................................................--*)
339 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
341 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
343 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
345 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
347 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
349 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
351 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
353 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
355 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
357 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
359 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
361 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
363 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
365 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
367 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
369 external build_neg : llvalue -> string -> llbuilder -> llvalue
371 external build_not : llvalue -> string -> llbuilder -> llvalue
374 (*--... Memory .............................................................--*)
375 external build_malloc : lltype -> string -> llbuilder -> llvalue
376 = "llvm_build_malloc"
377 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
378 llvalue = "llvm_build_array_malloc"
379 external build_alloca : lltype -> string -> llbuilder -> llvalue
380 = "llvm_build_alloca"
381 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
382 llvalue = "llvm_build_array_alloca"
383 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
384 external build_load : llvalue -> string -> llbuilder -> llvalue
386 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
388 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
391 (*--... Casts ..............................................................--*)
392 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
394 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
396 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
398 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
399 = "llvm_build_fptoui"
400 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
401 = "llvm_build_fptosi"
402 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
403 = "llvm_build_uitofp"
404 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
405 = "llvm_build_sitofp"
406 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
407 = "llvm_build_fptrunc"
408 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
410 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
411 = "llvm_build_prttoint"
412 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
413 = "llvm_build_inttoptr"
414 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
415 = "llvm_build_bitcast"
417 (*--... Comparisons ........................................................--*)
418 external build_icmp : int_predicate -> llvalue -> llvalue -> string ->
419 llbuilder -> llvalue = "llvm_build_icmp"
420 external build_fcmp : real_predicate -> llvalue -> llvalue -> string ->
421 llbuilder -> llvalue = "llvm_build_fcmp"
423 (*--... Miscellaneous instructions .........................................--*)
424 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
425 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 (*===-- Module providers --------------------------------------------------===*)
442 module ModuleProvider = struct
443 external create : llmodule -> llmoduleprovider
444 = "LLVMCreateModuleProviderForExistingModule"
445 external dispose : llmoduleprovider -> unit = "llvm_dispose_module_provider"
449 (*===-- Memory buffers ----------------------------------------------------===*)
451 module MemoryBuffer = struct
452 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
453 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
454 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
458 (*===-- Non-Externs -------------------------------------------------------===*)
459 (* These functions are built using the externals, so must be declared late. *)
461 let concat2 sep arr =
463 if 0 < Array.length arr then begin
465 for i = 1 to (Array.length arr) - 1 do
466 s := !s ^ sep ^ arr.(i)
471 let rec string_of_lltype ty =
472 (* FIXME: stop infinite recursion! :) *)
473 match classify_type ty with
474 Integer_type -> "i" ^ string_of_int (integer_bitwidth ty)
475 | Pointer_type -> (string_of_lltype (element_type ty)) ^ "*"
477 let s = "{ " ^ (concat2 ", " (
478 Array.map string_of_lltype (element_types ty)
483 | Array_type -> "[" ^ (string_of_int (array_length ty)) ^
484 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
485 | Vector_type -> "<" ^ (string_of_int (vector_size ty)) ^
486 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
487 | Opaque_type -> "opaque"
488 | Function_type -> string_of_lltype (return_type ty) ^
489 " (" ^ (concat2 ", " (
490 Array.map string_of_lltype (param_types ty)
492 | Label_type -> "label"
493 | Ppc_fp128_type -> "ppc_fp128"
494 | Fp128_type -> "fp128"
495 | X86fp80_type -> "x86_fp80"
496 | Double_type -> "double"
497 | Float_type -> "float"
498 | Void_type -> "void"