1 (*===-- llvm/llvm.ml - LLVM Ocaml Interface --------------------------------===*
3 * The LLVM Compiler Infrastructure
5 * This file is distributed under the University of Illinois Open Source
6 * 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 target_triple: llmodule -> string
111 = "llvm_target_triple"
112 external set_target_triple: string -> llmodule -> unit
113 = "llvm_set_target_triple"
114 external data_layout: llmodule -> string
116 external set_data_layout: string -> llmodule -> unit
117 = "llvm_set_data_layout"
118 external define_type_name : string -> lltype -> llmodule -> bool
119 = "llvm_add_type_name"
120 external delete_type_name : string -> llmodule -> unit
121 = "llvm_delete_type_name"
123 (*===-- Types -------------------------------------------------------------===*)
125 external classify_type : lltype -> TypeKind.t = "llvm_classify_type"
127 (*--... Operations on integer types ........................................--*)
128 external _i1_type : unit -> lltype = "llvm_i1_type"
129 external _i8_type : unit -> lltype = "llvm_i8_type"
130 external _i16_type : unit -> lltype = "llvm_i16_type"
131 external _i32_type : unit -> lltype = "llvm_i32_type"
132 external _i64_type : unit -> lltype = "llvm_i64_type"
134 let i1_type = _i1_type ()
135 let i8_type = _i8_type ()
136 let i16_type = _i16_type ()
137 let i32_type = _i32_type ()
138 let i64_type = _i64_type ()
140 external integer_type : int -> lltype = "llvm_integer_type"
141 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
143 (*--... Operations on real types ...........................................--*)
144 external _float_type : unit -> lltype = "llvm_float_type"
145 external _double_type : unit -> lltype = "llvm_double_type"
146 external _x86fp80_type : unit -> lltype = "llvm_x86fp80_type"
147 external _fp128_type : unit -> lltype = "llvm_fp128_type"
148 external _ppc_fp128_type : unit -> lltype = "llvm_ppc_fp128_type"
150 let float_type = _float_type ()
151 let double_type = _double_type ()
152 let x86fp80_type = _x86fp80_type ()
153 let fp128_type = _fp128_type ()
154 let ppc_fp128_type = _ppc_fp128_type ()
156 (*--... Operations on function types .......................................--*)
157 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
158 external var_arg_function_type : lltype -> lltype array -> lltype
159 = "llvm_var_arg_function_type"
160 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
161 external return_type : lltype -> lltype = "LLVMGetReturnType"
162 external param_types : lltype -> lltype array = "llvm_param_types"
164 (*--... Operations on struct types .........................................--*)
165 external struct_type : lltype array -> lltype = "llvm_struct_type"
166 external packed_struct_type : lltype array -> lltype = "llvm_packed_struct_type"
167 external element_types : lltype -> lltype array = "llvm_element_types"
168 external is_packed : lltype -> bool = "llvm_is_packed"
170 (*--... Operations on pointer, vector, and array types .....................--*)
171 external array_type : lltype -> int -> lltype = "llvm_array_type"
172 external pointer_type : lltype -> lltype = "llvm_pointer_type"
173 external qualified_pointer_type : lltype -> int -> lltype
174 = "llvm_qualified_pointer_type"
175 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
177 external element_type : lltype -> lltype = "LLVMGetElementType"
178 external array_length : lltype -> int = "llvm_array_length"
179 external address_space : lltype -> int = "llvm_address_space"
180 external vector_size : lltype -> int = "llvm_vector_size"
182 (*--... Operations on other types ..........................................--*)
183 external opaque_type : unit -> lltype = "llvm_opaque_type"
184 external _void_type : unit -> lltype = "llvm_void_type"
185 external _label_type : unit -> lltype = "llvm_label_type"
187 let void_type = _void_type ()
188 let label_type = _label_type ()
190 (*--... Operations on type handles .........................................--*)
191 external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type"
192 external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle"
193 external refine_type : lltype -> lltype -> unit = "llvm_refine_type"
196 (*===-- Values ------------------------------------------------------------===*)
198 external type_of : llvalue -> lltype = "llvm_type_of"
199 external value_name : llvalue -> string = "llvm_value_name"
200 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
201 external dump_value : llvalue -> unit = "llvm_dump_value"
203 (*--... Operations on constants of (mostly) any type .......................--*)
204 external is_constant : llvalue -> bool = "llvm_is_constant"
205 external const_null : lltype -> llvalue = "LLVMConstNull"
206 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
207 external undef : lltype -> llvalue = "LLVMGetUndef"
208 external is_null : llvalue -> bool = "llvm_is_null"
209 external is_undef : llvalue -> bool = "llvm_is_undef"
211 (*--... Operations on scalar constants .....................................--*)
212 external const_int : lltype -> int -> llvalue = "llvm_const_int"
213 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
214 = "llvm_const_of_int64"
215 external const_float : lltype -> float -> llvalue = "llvm_const_float"
217 (*--... Operations on composite constants ..................................--*)
218 external const_string : string -> llvalue = "llvm_const_string"
219 external const_stringz : string -> llvalue = "llvm_const_stringz"
220 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
221 external const_struct : llvalue array -> llvalue = "llvm_const_struct"
222 external const_packed_struct : llvalue array -> llvalue
223 = "llvm_const_packed_struct"
224 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
226 (*--... Constant expressions ...............................................--*)
227 external size_of : lltype -> llvalue = "LLVMSizeOf"
228 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
229 external const_not : llvalue -> llvalue = "LLVMConstNot"
230 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
231 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
232 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
233 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
234 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
235 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
236 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
237 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
238 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
239 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
240 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
241 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
242 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
244 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
246 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
247 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
248 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
249 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
250 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
251 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
252 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
253 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
254 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
255 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
256 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
257 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
258 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
259 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
260 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
261 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
262 external const_select : llvalue -> llvalue -> llvalue -> llvalue
264 external const_extractelement : llvalue -> llvalue -> llvalue
265 = "LLVMConstExtractElement"
266 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
267 = "LLVMConstInsertElement"
268 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
269 = "LLVMConstShuffleVector"
271 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
272 external is_declaration : llvalue -> bool = "llvm_is_declaration"
273 external linkage : llvalue -> Linkage.t = "llvm_linkage"
274 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
275 external section : llvalue -> string = "llvm_section"
276 external set_section : string -> llvalue -> unit = "llvm_set_section"
277 external visibility : llvalue -> Visibility.t = "llvm_visibility"
278 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
279 external alignment : llvalue -> int = "llvm_alignment"
280 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
281 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
282 external set_global_constant : bool -> llvalue -> unit
283 = "llvm_set_global_constant"
285 (*--... Operations on global variables .....................................--*)
286 external declare_global : lltype -> string -> llmodule -> llvalue
287 = "llvm_declare_global"
288 external define_global : string -> llvalue -> llmodule -> llvalue
289 = "llvm_define_global"
290 external lookup_global : string -> llmodule -> llvalue option
291 = "llvm_lookup_global"
292 external delete_global : llvalue -> unit = "llvm_delete_global"
293 external has_initializer : llvalue -> bool = "llvm_has_initializer"
294 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
295 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
296 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
297 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
298 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
300 (*--... Operations on functions ............................................--*)
301 external declare_function : string -> lltype -> llmodule -> llvalue
302 = "llvm_declare_function"
303 external define_function : string -> lltype -> llmodule -> llvalue
304 = "llvm_define_function"
305 external lookup_function : string -> llmodule -> llvalue option
306 = "llvm_lookup_function"
307 external delete_function : llvalue -> unit = "llvm_delete_function"
308 external params : llvalue -> llvalue array = "llvm_params"
309 external param : llvalue -> int -> llvalue = "llvm_param"
310 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
311 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
312 external set_function_call_conv : int -> llvalue -> unit
313 = "llvm_set_function_call_conv"
314 external collector : llvalue -> string option = "llvm_collector"
315 external set_collector : string option -> llvalue -> unit = "llvm_set_collector"
317 (* TODO: param attrs *)
319 (*--... Operations on basic blocks .........................................--*)
320 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
321 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
322 external delete_block : llbasicblock -> unit = "llvm_delete_block"
323 external append_block : string -> llvalue -> llbasicblock = "llvm_append_block"
324 external insert_block : string -> llbasicblock -> llbasicblock
325 = "llvm_insert_block"
326 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
327 external value_is_block : llvalue -> bool = "llvm_value_is_block"
328 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
330 (*--... Operations on call sites ...........................................--*)
331 external instruction_call_conv: llvalue -> int
332 = "llvm_instruction_call_conv"
333 external set_instruction_call_conv: int -> llvalue -> unit
334 = "llvm_set_instruction_call_conv"
336 (*--... Operations on phi nodes ............................................--*)
337 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
338 = "llvm_add_incoming"
339 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
342 (*===-- Instruction builders ----------------------------------------------===*)
343 external builder: unit-> llbuilder
345 external builder_before : llvalue -> llbuilder = "llvm_builder_before"
346 external builder_at_end : llbasicblock -> llbuilder = "llvm_builder_at_end"
347 external position_before : llvalue -> llbuilder -> unit = "llvm_position_before"
348 external position_at_end : llbasicblock -> llbuilder -> unit
349 = "llvm_position_at_end"
351 (*--... Terminators ........................................................--*)
352 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
353 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
354 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
355 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
356 llvalue = "llvm_build_cond_br"
357 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
358 = "llvm_build_switch"
359 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
360 llbasicblock -> string -> llbuilder -> llvalue
361 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
362 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
363 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
365 (*--... Arithmetic .........................................................--*)
366 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
368 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
370 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
372 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
374 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
376 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
378 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
380 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
382 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
384 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
386 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
388 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
390 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
392 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
394 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
396 external build_neg : llvalue -> string -> llbuilder -> llvalue
398 external build_not : llvalue -> string -> llbuilder -> llvalue
401 (*--... Memory .............................................................--*)
402 external build_malloc : lltype -> string -> llbuilder -> llvalue
403 = "llvm_build_malloc"
404 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
405 llvalue = "llvm_build_array_malloc"
406 external build_alloca : lltype -> string -> llbuilder -> llvalue
407 = "llvm_build_alloca"
408 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
409 llvalue = "llvm_build_array_alloca"
410 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
411 external build_load : llvalue -> string -> llbuilder -> llvalue
413 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
415 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
418 (*--... Casts ..............................................................--*)
419 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
421 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
423 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
425 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
426 = "llvm_build_fptoui"
427 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
428 = "llvm_build_fptosi"
429 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
430 = "llvm_build_uitofp"
431 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
432 = "llvm_build_sitofp"
433 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
434 = "llvm_build_fptrunc"
435 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
437 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
438 = "llvm_build_prttoint"
439 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
440 = "llvm_build_inttoptr"
441 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
442 = "llvm_build_bitcast"
444 (*--... Comparisons ........................................................--*)
445 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
446 llbuilder -> llvalue = "llvm_build_icmp"
447 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
448 llbuilder -> llvalue = "llvm_build_fcmp"
450 (*--... Miscellaneous instructions .........................................--*)
451 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
452 llvalue = "llvm_build_phi"
453 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
455 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
456 llvalue = "llvm_build_select"
457 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
458 = "llvm_build_va_arg"
459 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
460 llvalue = "llvm_build_extractelement"
461 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
462 llbuilder -> llvalue = "llvm_build_insertelement"
463 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
464 llbuilder -> llvalue = "llvm_build_shufflevector"
467 (*===-- Module providers --------------------------------------------------===*)
469 module ModuleProvider = struct
470 external create : llmodule -> llmoduleprovider
471 = "LLVMCreateModuleProviderForExistingModule"
472 external dispose : llmoduleprovider -> unit = "llvm_dispose_module_provider"
476 (*===-- Memory buffers ----------------------------------------------------===*)
478 module MemoryBuffer = struct
479 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
480 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
481 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
485 (*===-- Non-Externs -------------------------------------------------------===*)
486 (* These functions are built using the externals, so must be declared late. *)
488 let concat2 sep arr =
490 if 0 < Array.length arr then begin
492 for i = 1 to (Array.length arr) - 1 do
493 s := !s ^ sep ^ arr.(i)
498 let rec string_of_lltype ty =
499 (* FIXME: stop infinite recursion! :) *)
500 match classify_type ty with
501 TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
502 | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
504 let s = "{ " ^ (concat2 ", " (
505 Array.map string_of_lltype (element_types ty)
510 | TypeKind.Array -> "[" ^ (string_of_int (array_length ty)) ^
511 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
512 | TypeKind.Vector -> "<" ^ (string_of_int (vector_size ty)) ^
513 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
514 | TypeKind.Opaque -> "opaque"
515 | TypeKind.Function -> string_of_lltype (return_type ty) ^
516 " (" ^ (concat2 ", " (
517 Array.map string_of_lltype (param_types ty)
519 | TypeKind.Label -> "label"
520 | TypeKind.Ppc_fp128 -> "ppc_fp128"
521 | TypeKind.Fp128 -> "fp128"
522 | TypeKind.X86fp80 -> "x86_fp80"
523 | TypeKind.Double -> "double"
524 | TypeKind.Float -> "float"
525 | TypeKind.Void -> "void"