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 *===----------------------------------------------------------------------===*)
20 module TypeKind = struct
38 module Linkage = struct
51 module Visibility = struct
58 module CallConv = struct
100 exception IoError of string
102 external register_exns : exn -> unit = "llvm_register_core_exns"
103 let _ = register_exns (IoError "")
106 (*===-- Modules -----------------------------------------------------------===*)
108 external create_module : string -> llmodule = "llvm_create_module"
109 external dispose_module : llmodule -> unit = "llvm_dispose_module"
110 external define_type_name : string -> lltype -> llmodule -> bool
111 = "llvm_add_type_name"
112 external delete_type_name : string -> llmodule -> unit
113 = "llvm_delete_type_name"
116 (*===-- Types -------------------------------------------------------------===*)
118 external classify_type : lltype -> TypeKind.t = "llvm_classify_type"
120 (*--... Operations on integer types ........................................--*)
121 external _i1_type : unit -> lltype = "llvm_i1_type"
122 external _i8_type : unit -> lltype = "llvm_i8_type"
123 external _i16_type : unit -> lltype = "llvm_i16_type"
124 external _i32_type : unit -> lltype = "llvm_i32_type"
125 external _i64_type : unit -> lltype = "llvm_i64_type"
127 let i1_type = _i1_type ()
128 let i8_type = _i8_type ()
129 let i16_type = _i16_type ()
130 let i32_type = _i32_type ()
131 let i64_type = _i64_type ()
133 external integer_type : int -> lltype = "llvm_integer_type"
134 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
136 (*--... Operations on real types ...........................................--*)
137 external _float_type : unit -> lltype = "llvm_float_type"
138 external _double_type : unit -> lltype = "llvm_double_type"
139 external _x86fp80_type : unit -> lltype = "llvm_x86fp80_type"
140 external _fp128_type : unit -> lltype = "llvm_fp128_type"
141 external _ppc_fp128_type : unit -> lltype = "llvm_ppc_fp128_type"
143 let float_type = _float_type ()
144 let double_type = _double_type ()
145 let x86fp80_type = _x86fp80_type ()
146 let fp128_type = _fp128_type ()
147 let ppc_fp128_type = _ppc_fp128_type ()
149 (*--... Operations on function types .......................................--*)
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 = "llvm_pointer_type"
166 external qualified_pointer_type : lltype -> int -> lltype
167 = "llvm_qualified_pointer_type"
168 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
170 external element_type : lltype -> lltype = "LLVMGetElementType"
171 external array_length : lltype -> int = "llvm_array_length"
172 external address_space : lltype -> int = "llvm_address_space"
173 external vector_size : lltype -> int = "llvm_vector_size"
175 (*--... Operations on other types ..........................................--*)
176 external opaque_type : unit -> lltype = "llvm_opaque_type"
177 external _void_type : unit -> lltype = "llvm_void_type"
178 external _label_type : unit -> lltype = "llvm_label_type"
180 let void_type = _void_type ()
181 let label_type = _label_type ()
183 (*--... Operations on type handles .........................................--*)
184 external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type"
185 external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle"
186 external refine_type : lltype -> lltype -> unit = "llvm_refine_type"
189 (*===-- Values ------------------------------------------------------------===*)
191 external type_of : llvalue -> lltype = "llvm_type_of"
192 external value_name : llvalue -> string = "llvm_value_name"
193 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
194 external dump_value : llvalue -> unit = "llvm_dump_value"
196 (*--... Operations on constants of (mostly) any type .......................--*)
197 external is_constant : llvalue -> bool = "llvm_is_constant"
198 external const_null : lltype -> llvalue = "LLVMConstNull"
199 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
200 external undef : lltype -> llvalue = "LLVMGetUndef"
201 external is_null : llvalue -> bool = "llvm_is_null"
202 external is_undef : llvalue -> bool = "llvm_is_undef"
204 (*--... Operations on scalar constants .....................................--*)
205 external const_int : lltype -> int -> llvalue = "llvm_const_int"
206 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
207 = "llvm_const_of_int64"
208 external const_float : lltype -> float -> llvalue = "llvm_const_float"
210 (*--... Operations on composite constants ..................................--*)
211 external const_string : string -> llvalue = "llvm_const_string"
212 external const_stringz : string -> llvalue = "llvm_const_stringz"
213 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
214 external const_struct : llvalue array -> llvalue = "llvm_const_struct"
215 external const_packed_struct : llvalue array -> llvalue
216 = "llvm_const_packed_struct"
217 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
219 (*--... Constant expressions ...............................................--*)
220 external size_of : lltype -> llvalue = "LLVMSizeOf"
221 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
222 external const_not : llvalue -> llvalue = "LLVMConstNot"
223 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
224 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
225 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
226 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
227 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
228 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
229 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
230 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
231 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
232 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
233 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
234 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
235 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
237 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
239 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
240 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
241 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
242 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
243 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
244 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
245 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
246 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
247 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
248 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
249 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
250 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
251 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
252 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
253 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
254 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
255 external const_select : llvalue -> llvalue -> llvalue -> llvalue
257 external const_extractelement : llvalue -> llvalue -> llvalue
258 = "LLVMConstExtractElement"
259 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
260 = "LLVMConstInsertElement"
261 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
262 = "LLVMConstShuffleVector"
264 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
265 external is_declaration : llvalue -> bool = "llvm_is_declaration"
266 external linkage : llvalue -> Linkage.t = "llvm_linkage"
267 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
268 external section : llvalue -> string = "llvm_section"
269 external set_section : string -> llvalue -> unit = "llvm_set_section"
270 external visibility : llvalue -> Visibility.t = "llvm_visibility"
271 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
272 external alignment : llvalue -> int = "llvm_alignment"
273 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
274 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
275 external set_global_constant : bool -> llvalue -> unit
276 = "llvm_set_global_constant"
278 (*--... Operations on global variables .....................................--*)
279 external declare_global : lltype -> string -> llmodule -> llvalue
280 = "llvm_declare_global"
281 external define_global : string -> llvalue -> llmodule -> llvalue
282 = "llvm_define_global"
283 external lookup_global : string -> llmodule -> llvalue option
284 = "llvm_lookup_global"
285 external delete_global : llvalue -> unit = "llvm_delete_global"
286 external has_initializer : llvalue -> bool = "llvm_has_initializer"
287 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
288 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
289 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
290 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
291 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
293 (*--... Operations on functions ............................................--*)
294 external declare_function : string -> lltype -> llmodule -> llvalue
295 = "llvm_declare_function"
296 external define_function : string -> lltype -> llmodule -> llvalue
297 = "llvm_define_function"
298 external lookup_function : string -> llmodule -> llvalue option
299 = "llvm_lookup_function"
300 external delete_function : llvalue -> unit = "llvm_delete_function"
301 external params : llvalue -> llvalue array = "llvm_params"
302 external param : llvalue -> int -> llvalue = "llvm_param"
303 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
304 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
305 external set_function_call_conv : int -> llvalue -> unit
306 = "llvm_set_function_call_conv"
307 external collector : llvalue -> string option = "llvm_collector"
308 external set_collector : string option -> llvalue -> unit = "llvm_set_collector"
310 (* TODO: param attrs *)
312 (*--... Operations on basic blocks .........................................--*)
313 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
314 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
315 external delete_block : llbasicblock -> unit = "llvm_delete_block"
316 external append_block : string -> llvalue -> llbasicblock = "llvm_append_block"
317 external insert_block : string -> llbasicblock -> llbasicblock
318 = "llvm_insert_block"
319 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
320 external value_is_block : llvalue -> bool = "llvm_value_is_block"
321 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
323 (*--... Operations on phi nodes ............................................--*)
324 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
325 = "llvm_add_incoming"
326 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
329 (*===-- Instruction builders ----------------------------------------------===*)
330 external builder: unit-> llbuilder
332 external builder_before : llvalue -> llbuilder = "llvm_builder_before"
333 external builder_at_end : llbasicblock -> llbuilder = "llvm_builder_at_end"
334 external position_before : llvalue -> llbuilder -> unit = "llvm_position_before"
335 external position_at_end : llbasicblock -> llbuilder -> unit
336 = "llvm_position_at_end"
338 (*--... Terminators ........................................................--*)
339 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
340 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
341 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
342 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
343 llvalue = "llvm_build_cond_br"
344 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
345 = "llvm_build_switch"
346 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
347 llbasicblock -> string -> llbuilder -> llvalue
348 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
349 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
350 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
352 (*--... Arithmetic .........................................................--*)
353 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
355 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
357 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
359 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
361 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
363 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
365 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
367 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
369 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
371 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
373 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
375 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
377 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
379 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
381 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
383 external build_neg : llvalue -> string -> llbuilder -> llvalue
385 external build_not : llvalue -> string -> llbuilder -> llvalue
388 (*--... Memory .............................................................--*)
389 external build_malloc : lltype -> string -> llbuilder -> llvalue
390 = "llvm_build_malloc"
391 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
392 llvalue = "llvm_build_array_malloc"
393 external build_alloca : lltype -> string -> llbuilder -> llvalue
394 = "llvm_build_alloca"
395 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
396 llvalue = "llvm_build_array_alloca"
397 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
398 external build_load : llvalue -> string -> llbuilder -> llvalue
400 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
402 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
405 (*--... Casts ..............................................................--*)
406 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
408 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
410 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
412 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
413 = "llvm_build_fptoui"
414 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
415 = "llvm_build_fptosi"
416 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
417 = "llvm_build_uitofp"
418 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
419 = "llvm_build_sitofp"
420 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
421 = "llvm_build_fptrunc"
422 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
424 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
425 = "llvm_build_prttoint"
426 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
427 = "llvm_build_inttoptr"
428 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
429 = "llvm_build_bitcast"
431 (*--... Comparisons ........................................................--*)
432 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
433 llbuilder -> llvalue = "llvm_build_icmp"
434 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
435 llbuilder -> llvalue = "llvm_build_fcmp"
437 (*--... Miscellaneous instructions .........................................--*)
438 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
439 llvalue = "llvm_build_phi"
440 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
442 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
443 llvalue = "llvm_build_select"
444 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
445 = "llvm_build_va_arg"
446 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
447 llvalue = "llvm_build_extractelement"
448 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
449 llbuilder -> llvalue = "llvm_build_insertelement"
450 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
451 llbuilder -> llvalue = "llvm_build_shufflevector"
454 (*===-- Module providers --------------------------------------------------===*)
456 module ModuleProvider = struct
457 external create : llmodule -> llmoduleprovider
458 = "LLVMCreateModuleProviderForExistingModule"
459 external dispose : llmoduleprovider -> unit = "llvm_dispose_module_provider"
463 (*===-- Memory buffers ----------------------------------------------------===*)
465 module MemoryBuffer = struct
466 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
467 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
468 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
472 (*===-- Non-Externs -------------------------------------------------------===*)
473 (* These functions are built using the externals, so must be declared late. *)
475 let concat2 sep arr =
477 if 0 < Array.length arr then begin
479 for i = 1 to (Array.length arr) - 1 do
480 s := !s ^ sep ^ arr.(i)
485 let rec string_of_lltype ty =
486 (* FIXME: stop infinite recursion! :) *)
487 match classify_type ty with
488 TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
489 | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
491 let s = "{ " ^ (concat2 ", " (
492 Array.map string_of_lltype (element_types ty)
497 | TypeKind.Array -> "[" ^ (string_of_int (array_length ty)) ^
498 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
499 | TypeKind.Vector -> "<" ^ (string_of_int (vector_size ty)) ^
500 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
501 | TypeKind.Opaque -> "opaque"
502 | TypeKind.Function -> string_of_lltype (return_type ty) ^
503 " (" ^ (concat2 ", " (
504 Array.map string_of_lltype (param_types ty)
506 | TypeKind.Label -> "label"
507 | TypeKind.Ppc_fp128 -> "ppc_fp128"
508 | TypeKind.Fp128 -> "fp128"
509 | TypeKind.X86fp80 -> "x86_fp80"
510 | TypeKind.Double -> "double"
511 | TypeKind.Float -> "float"
512 | TypeKind.Void -> "void"