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