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
41 | Available_externally
57 module Visibility = struct
64 module CallConv = struct
72 module Attribute = struct
96 | Stackalignment of int
133 exception IoError of string
135 external register_exns : exn -> unit = "llvm_register_core_exns"
136 let _ = register_exns (IoError "")
138 type ('a, 'b) llpos =
142 type ('a, 'b) llrev_pos =
146 (*===-- Contexts ----------------------------------------------------------===*)
147 external create_context : unit -> llcontext = "llvm_create_context"
148 external dispose_context : llcontext -> unit = "llvm_dispose_context"
149 external global_context : unit -> llcontext = "llvm_global_context"
150 external mdkind_id : llcontext -> string -> int = "llvm_mdkind_id"
152 (*===-- Modules -----------------------------------------------------------===*)
153 external create_module : llcontext -> string -> llmodule = "llvm_create_module"
154 external dispose_module : llmodule -> unit = "llvm_dispose_module"
155 external target_triple: llmodule -> string
156 = "llvm_target_triple"
157 external set_target_triple: string -> llmodule -> unit
158 = "llvm_set_target_triple"
159 external data_layout: llmodule -> string
161 external set_data_layout: string -> llmodule -> unit
162 = "llvm_set_data_layout"
163 external dump_module : llmodule -> unit = "llvm_dump_module"
164 external set_module_inline_asm : llmodule -> string -> unit
165 = "llvm_set_module_inline_asm"
167 (*===-- Types -------------------------------------------------------------===*)
168 external classify_type : lltype -> TypeKind.t = "llvm_classify_type"
169 external type_context : lltype -> llcontext = "llvm_type_context"
170 external type_is_sized : lltype -> bool = "llvm_type_is_sized"
172 (*--... Operations on integer types ........................................--*)
173 external i1_type : llcontext -> lltype = "llvm_i1_type"
174 external i8_type : llcontext -> lltype = "llvm_i8_type"
175 external i16_type : llcontext -> lltype = "llvm_i16_type"
176 external i32_type : llcontext -> lltype = "llvm_i32_type"
177 external i64_type : llcontext -> lltype = "llvm_i64_type"
179 external integer_type : llcontext -> int -> lltype = "llvm_integer_type"
180 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
182 (*--... Operations on real types ...........................................--*)
183 external float_type : llcontext -> lltype = "llvm_float_type"
184 external double_type : llcontext -> lltype = "llvm_double_type"
185 external x86fp80_type : llcontext -> lltype = "llvm_x86fp80_type"
186 external fp128_type : llcontext -> lltype = "llvm_fp128_type"
187 external ppc_fp128_type : llcontext -> lltype = "llvm_ppc_fp128_type"
189 (*--... Operations on function types .......................................--*)
190 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
191 external var_arg_function_type : lltype -> lltype array -> lltype
192 = "llvm_var_arg_function_type"
193 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
194 external return_type : lltype -> lltype = "LLVMGetReturnType"
195 external param_types : lltype -> lltype array = "llvm_param_types"
197 (*--... Operations on struct types .........................................--*)
198 external struct_type : llcontext -> lltype array -> lltype = "llvm_struct_type"
199 external packed_struct_type : llcontext -> lltype array -> lltype
200 = "llvm_packed_struct_type"
201 external struct_name : lltype -> string option = "llvm_struct_name"
202 external struct_element_types : lltype -> lltype array
203 = "llvm_struct_element_types"
204 external is_packed : lltype -> bool = "llvm_is_packed"
206 (*--... Operations on pointer, vector, and array types .....................--*)
207 external array_type : lltype -> int -> lltype = "llvm_array_type"
208 external pointer_type : lltype -> lltype = "llvm_pointer_type"
209 external qualified_pointer_type : lltype -> int -> lltype
210 = "llvm_qualified_pointer_type"
211 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
213 external element_type : lltype -> lltype = "LLVMGetElementType"
214 external array_length : lltype -> int = "llvm_array_length"
215 external address_space : lltype -> int = "llvm_address_space"
216 external vector_size : lltype -> int = "llvm_vector_size"
218 (*--... Operations on other types ..........................................--*)
219 external void_type : llcontext -> lltype = "llvm_void_type"
220 external label_type : llcontext -> lltype = "llvm_label_type"
222 (*===-- Values ------------------------------------------------------------===*)
223 external type_of : llvalue -> lltype = "llvm_type_of"
224 external value_name : llvalue -> string = "llvm_value_name"
225 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
226 external dump_value : llvalue -> unit = "llvm_dump_value"
227 external replace_all_uses_with : llvalue -> llvalue -> unit
228 = "LLVMReplaceAllUsesWith"
230 (*--... Operations on uses .................................................--*)
231 external use_begin : llvalue -> lluse option = "llvm_use_begin"
232 external use_succ : lluse -> lluse option = "llvm_use_succ"
233 external user : lluse -> llvalue = "llvm_user"
234 external used_value : lluse -> llvalue = "llvm_used_value"
237 let rec aux = function
245 let fold_left_uses f init v =
249 | Some u -> aux (f init u) (use_succ u)
251 aux init (use_begin v)
253 let fold_right_uses f v init =
257 | Some u -> f u (aux (use_succ u) init)
259 aux (use_begin v) init
262 (*--... Operations on users ................................................--*)
263 external operand : llvalue -> int -> llvalue = "llvm_operand"
264 external set_operand : llvalue -> int -> llvalue -> unit = "llvm_set_operand"
265 external num_operands : llvalue -> int = "llvm_num_operands"
267 (*--... Operations on constants of (mostly) any type .......................--*)
268 external is_constant : llvalue -> bool = "llvm_is_constant"
269 external const_null : lltype -> llvalue = "LLVMConstNull"
270 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
271 external const_pointer_null : lltype -> llvalue = "LLVMConstPointerNull"
272 external undef : lltype -> llvalue = "LLVMGetUndef"
273 external is_null : llvalue -> bool = "llvm_is_null"
274 external is_undef : llvalue -> bool = "llvm_is_undef"
276 (*--... Operations on instructions .........................................--*)
277 external has_metadata : llvalue -> bool = "llvm_has_metadata"
278 external metadata : llvalue -> int -> llvalue option = "llvm_metadata"
279 external set_metadata : llvalue -> int -> llvalue -> unit = "llvm_set_metadata"
280 external clear_metadata : llvalue -> int -> unit = "llvm_clear_metadata"
282 (*--... Operations on metadata .......,.....................................--*)
283 external mdstring : llcontext -> string -> llvalue = "llvm_mdstring"
284 external mdnode : llcontext -> llvalue array -> llvalue = "llvm_mdnode"
285 external get_mdstring : llvalue -> string option = "llvm_get_mdstring"
286 external get_named_metadata : llmodule -> string -> llvalue array = "llvm_get_namedmd"
288 (*--... Operations on scalar constants .....................................--*)
289 external const_int : lltype -> int -> llvalue = "llvm_const_int"
290 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
291 = "llvm_const_of_int64"
292 external const_int_of_string : lltype -> string -> int -> llvalue
293 = "llvm_const_int_of_string"
294 external const_float : lltype -> float -> llvalue = "llvm_const_float"
295 external const_float_of_string : lltype -> string -> llvalue
296 = "llvm_const_float_of_string"
298 (*--... Operations on composite constants ..................................--*)
299 external const_string : llcontext -> string -> llvalue = "llvm_const_string"
300 external const_stringz : llcontext -> string -> llvalue = "llvm_const_stringz"
301 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
302 external const_struct : llcontext -> llvalue array -> llvalue
303 = "llvm_const_struct"
304 external const_packed_struct : llcontext -> llvalue array -> llvalue
305 = "llvm_const_packed_struct"
306 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
308 (*--... Constant expressions ...............................................--*)
309 external align_of : lltype -> llvalue = "LLVMAlignOf"
310 external size_of : lltype -> llvalue = "LLVMSizeOf"
311 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
312 external const_nsw_neg : llvalue -> llvalue = "LLVMConstNSWNeg"
313 external const_nuw_neg : llvalue -> llvalue = "LLVMConstNUWNeg"
314 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
315 external const_not : llvalue -> llvalue = "LLVMConstNot"
316 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
317 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
318 external const_nuw_add : llvalue -> llvalue -> llvalue = "LLVMConstNUWAdd"
319 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
320 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
321 external const_nsw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNSWSub"
322 external const_nuw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNUWSub"
323 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
324 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
325 external const_nsw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNSWMul"
326 external const_nuw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNUWMul"
327 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
328 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
329 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
330 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
331 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
332 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
333 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
334 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
335 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
336 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
337 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
338 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
340 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
342 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
343 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
344 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
345 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
346 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
347 = "llvm_const_in_bounds_gep"
348 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
349 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
350 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
351 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
352 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
353 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
354 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
355 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
356 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
357 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
358 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
359 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
360 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
361 = "LLVMConstZExtOrBitCast"
362 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
363 = "LLVMConstSExtOrBitCast"
364 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
365 = "LLVMConstTruncOrBitCast"
366 external const_pointercast : llvalue -> lltype -> llvalue
367 = "LLVMConstPointerCast"
368 external const_intcast : llvalue -> lltype -> llvalue = "LLVMConstIntCast"
369 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
370 external const_select : llvalue -> llvalue -> llvalue -> llvalue
372 external const_extractelement : llvalue -> llvalue -> llvalue
373 = "LLVMConstExtractElement"
374 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
375 = "LLVMConstInsertElement"
376 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
377 = "LLVMConstShuffleVector"
378 external const_extractvalue : llvalue -> int array -> llvalue
379 = "llvm_const_extractvalue"
380 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
381 = "llvm_const_insertvalue"
382 external const_inline_asm : lltype -> string -> string -> bool -> bool ->
384 = "llvm_const_inline_asm"
385 external block_address : llvalue -> llbasicblock -> llvalue = "LLVMBlockAddress"
387 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
388 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
389 external is_declaration : llvalue -> bool = "llvm_is_declaration"
390 external linkage : llvalue -> Linkage.t = "llvm_linkage"
391 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
392 external section : llvalue -> string = "llvm_section"
393 external set_section : string -> llvalue -> unit = "llvm_set_section"
394 external visibility : llvalue -> Visibility.t = "llvm_visibility"
395 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
396 external alignment : llvalue -> int = "llvm_alignment"
397 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
398 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
399 external set_global_constant : bool -> llvalue -> unit
400 = "llvm_set_global_constant"
402 (*--... Operations on global variables .....................................--*)
403 external declare_global : lltype -> string -> llmodule -> llvalue
404 = "llvm_declare_global"
405 external declare_qualified_global : lltype -> string -> int -> llmodule ->
407 = "llvm_declare_qualified_global"
408 external define_global : string -> llvalue -> llmodule -> llvalue
409 = "llvm_define_global"
410 external define_qualified_global : string -> llvalue -> int -> llmodule ->
412 = "llvm_define_qualified_global"
413 external lookup_global : string -> llmodule -> llvalue option
414 = "llvm_lookup_global"
415 external delete_global : llvalue -> unit = "llvm_delete_global"
416 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
417 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
418 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
419 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
420 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
421 external global_begin : llmodule -> (llmodule, llvalue) llpos
422 = "llvm_global_begin"
423 external global_succ : llvalue -> (llmodule, llvalue) llpos
425 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
427 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
430 let rec iter_global_range f i e =
431 if i = e then () else
433 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
436 iter_global_range f (global_succ bb) e
438 let iter_globals f m =
439 iter_global_range f (global_begin m) (At_end m)
441 let rec fold_left_global_range f init i e =
442 if i = e then init else
444 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
445 | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
447 let fold_left_globals f init m =
448 fold_left_global_range f init (global_begin m) (At_end m)
450 let rec rev_iter_global_range f i e =
451 if i = e then () else
453 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
456 rev_iter_global_range f (global_pred bb) e
458 let rev_iter_globals f m =
459 rev_iter_global_range f (global_end m) (At_start m)
461 let rec fold_right_global_range f i e init =
462 if i = e then init else
464 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
465 | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
467 let fold_right_globals f m init =
468 fold_right_global_range f (global_end m) (At_start m) init
470 (*--... Operations on aliases ..............................................--*)
471 external add_alias : llmodule -> lltype -> llvalue -> string -> llvalue
474 (*--... Operations on functions ............................................--*)
475 external declare_function : string -> lltype -> llmodule -> llvalue
476 = "llvm_declare_function"
477 external define_function : string -> lltype -> llmodule -> llvalue
478 = "llvm_define_function"
479 external lookup_function : string -> llmodule -> llvalue option
480 = "llvm_lookup_function"
481 external delete_function : llvalue -> unit = "llvm_delete_function"
482 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
483 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
484 external set_function_call_conv : int -> llvalue -> unit
485 = "llvm_set_function_call_conv"
486 external gc : llvalue -> string option = "llvm_gc"
487 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
488 external function_begin : llmodule -> (llmodule, llvalue) llpos
489 = "llvm_function_begin"
490 external function_succ : llvalue -> (llmodule, llvalue) llpos
491 = "llvm_function_succ"
492 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
493 = "llvm_function_end"
494 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
495 = "llvm_function_pred"
497 let rec iter_function_range f i e =
498 if i = e then () else
500 | At_end _ -> raise (Invalid_argument "Invalid function range.")
503 iter_function_range f (function_succ fn) e
505 let iter_functions f m =
506 iter_function_range f (function_begin m) (At_end m)
508 let rec fold_left_function_range f init i e =
509 if i = e then init else
511 | At_end _ -> raise (Invalid_argument "Invalid function range.")
512 | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
514 let fold_left_functions f init m =
515 fold_left_function_range f init (function_begin m) (At_end m)
517 let rec rev_iter_function_range f i e =
518 if i = e then () else
520 | At_start _ -> raise (Invalid_argument "Invalid function range.")
523 rev_iter_function_range f (function_pred fn) e
525 let rev_iter_functions f m =
526 rev_iter_function_range f (function_end m) (At_start m)
528 let rec fold_right_function_range f i e init =
529 if i = e then init else
531 | At_start _ -> raise (Invalid_argument "Invalid function range.")
532 | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
534 let fold_right_functions f m init =
535 fold_right_function_range f (function_end m) (At_start m) init
537 external llvm_add_function_attr : llvalue -> int -> unit
538 = "llvm_add_function_attr"
539 external llvm_remove_function_attr : llvalue -> int -> unit
540 = "llvm_remove_function_attr"
542 let pack_attr (attr:Attribute.t) : int =
544 Attribute.Zext -> 1 lsl 0
545 | Attribute.Sext -> 1 lsl 1
546 | Attribute.Noreturn -> 1 lsl 2
547 | Attribute.Inreg -> 1 lsl 3
548 | Attribute.Structret -> 1 lsl 4
549 | Attribute.Nounwind -> 1 lsl 5
550 | Attribute.Noalias -> 1 lsl 6
551 | Attribute.Byval -> 1 lsl 7
552 | Attribute.Nest -> 1 lsl 8
553 | Attribute.Readnone -> 1 lsl 9
554 | Attribute.Readonly -> 1 lsl 10
555 | Attribute.Noinline -> 1 lsl 11
556 | Attribute.Alwaysinline -> 1 lsl 12
557 | Attribute.Optsize -> 1 lsl 13
558 | Attribute.Ssp -> 1 lsl 14
559 | Attribute.Sspreq -> 1 lsl 15
560 | Attribute.Alignment n -> n lsl 16
561 | Attribute.Nocapture -> 1 lsl 21
562 | Attribute.Noredzone -> 1 lsl 22
563 | Attribute.Noimplicitfloat -> 1 lsl 23
564 | Attribute.Naked -> 1 lsl 24
565 | Attribute.Inlinehint -> 1 lsl 25
566 | Attribute.Stackalignment n -> n lsl 26
568 let add_function_attr llval attr =
569 llvm_add_function_attr llval (pack_attr attr)
571 let remove_function_attr llval attr =
572 llvm_remove_function_attr llval (pack_attr attr)
574 (*--... Operations on params ...............................................--*)
575 external params : llvalue -> llvalue array = "llvm_params"
576 external param : llvalue -> int -> llvalue = "llvm_param"
577 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
578 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
579 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
580 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
581 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
583 let rec iter_param_range f i e =
584 if i = e then () else
586 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
589 iter_param_range f (param_succ p) e
591 let iter_params f fn =
592 iter_param_range f (param_begin fn) (At_end fn)
594 let rec fold_left_param_range f init i e =
595 if i = e then init else
597 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
598 | Before p -> fold_left_param_range f (f init p) (param_succ p) e
600 let fold_left_params f init fn =
601 fold_left_param_range f init (param_begin fn) (At_end fn)
603 let rec rev_iter_param_range f i e =
604 if i = e then () else
606 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
609 rev_iter_param_range f (param_pred p) e
611 let rev_iter_params f fn =
612 rev_iter_param_range f (param_end fn) (At_start fn)
614 let rec fold_right_param_range f init i e =
615 if i = e then init else
617 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
618 | After p -> fold_right_param_range f (f p init) (param_pred p) e
620 let fold_right_params f fn init =
621 fold_right_param_range f init (param_end fn) (At_start fn)
623 external llvm_add_param_attr : llvalue -> int -> unit
624 = "llvm_add_param_attr"
625 external llvm_remove_param_attr : llvalue -> int -> unit
626 = "llvm_remove_param_attr"
628 let add_param_attr llval attr =
629 llvm_add_param_attr llval (pack_attr attr)
631 let remove_param_attr llval attr =
632 llvm_remove_param_attr llval (pack_attr attr)
634 external set_param_alignment : llvalue -> int -> unit
635 = "llvm_set_param_alignment"
637 (*--... Operations on basic blocks .........................................--*)
638 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
639 external value_is_block : llvalue -> bool = "llvm_value_is_block"
640 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
641 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
642 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
643 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
644 external delete_block : llbasicblock -> unit = "llvm_delete_block"
645 external append_block : llcontext -> string -> llvalue -> llbasicblock
646 = "llvm_append_block"
647 external insert_block : llcontext -> string -> llbasicblock -> llbasicblock
648 = "llvm_insert_block"
649 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
651 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
653 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
655 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
658 let rec iter_block_range f i e =
659 if i = e then () else
661 | At_end _ -> raise (Invalid_argument "Invalid block range.")
664 iter_block_range f (block_succ bb) e
666 let iter_blocks f fn =
667 iter_block_range f (block_begin fn) (At_end fn)
669 let rec fold_left_block_range f init i e =
670 if i = e then init else
672 | At_end _ -> raise (Invalid_argument "Invalid block range.")
673 | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
675 let fold_left_blocks f init fn =
676 fold_left_block_range f init (block_begin fn) (At_end fn)
678 let rec rev_iter_block_range f i e =
679 if i = e then () else
681 | At_start _ -> raise (Invalid_argument "Invalid block range.")
684 rev_iter_block_range f (block_pred bb) e
686 let rev_iter_blocks f fn =
687 rev_iter_block_range f (block_end fn) (At_start fn)
689 let rec fold_right_block_range f init i e =
690 if i = e then init else
692 | At_start _ -> raise (Invalid_argument "Invalid block range.")
693 | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
695 let fold_right_blocks f fn init =
696 fold_right_block_range f init (block_end fn) (At_start fn)
698 (*--... Operations on instructions .........................................--*)
699 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
700 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
702 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
704 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
706 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
709 external icmp_predicate : llvalue -> Icmp.t option = "llvm_instr_icmp_predicate"
711 let rec iter_instrs_range f i e =
712 if i = e then () else
714 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
717 iter_instrs_range f (instr_succ i) e
719 let iter_instrs f bb =
720 iter_instrs_range f (instr_begin bb) (At_end bb)
722 let rec fold_left_instrs_range f init i e =
723 if i = e then init else
725 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
726 | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
728 let fold_left_instrs f init bb =
729 fold_left_instrs_range f init (instr_begin bb) (At_end bb)
731 let rec rev_iter_instrs_range f i e =
732 if i = e then () else
734 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
737 rev_iter_instrs_range f (instr_pred i) e
739 let rev_iter_instrs f bb =
740 rev_iter_instrs_range f (instr_end bb) (At_start bb)
742 let rec fold_right_instr_range f i e init =
743 if i = e then init else
745 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
746 | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
748 let fold_right_instrs f bb init =
749 fold_right_instr_range f (instr_end bb) (At_start bb) init
752 (*--... Operations on call sites ...........................................--*)
753 external instruction_call_conv: llvalue -> int
754 = "llvm_instruction_call_conv"
755 external set_instruction_call_conv: int -> llvalue -> unit
756 = "llvm_set_instruction_call_conv"
758 external llvm_add_instruction_param_attr : llvalue -> int -> int -> unit
759 = "llvm_add_instruction_param_attr"
760 external llvm_remove_instruction_param_attr : llvalue -> int -> int -> unit
761 = "llvm_remove_instruction_param_attr"
763 let add_instruction_param_attr llval i attr =
764 llvm_add_instruction_param_attr llval i (pack_attr attr)
766 let remove_instruction_param_attr llval i attr =
767 llvm_remove_instruction_param_attr llval i (pack_attr attr)
769 (*--... Operations on call instructions (only) .............................--*)
770 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
771 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
773 (*--... Operations on phi nodes ............................................--*)
774 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
775 = "llvm_add_incoming"
776 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
779 (*===-- Instruction builders ----------------------------------------------===*)
780 external builder : llcontext -> llbuilder = "llvm_builder"
781 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
782 = "llvm_position_builder"
783 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
784 external insert_into_builder : llvalue -> string -> llbuilder -> unit
785 = "llvm_insert_into_builder"
787 let builder_at context ip =
788 let b = builder context in
789 position_builder ip b;
792 let builder_before context i = builder_at context (Before i)
793 let builder_at_end context bb = builder_at context (At_end bb)
795 let position_before i = position_builder (Before i)
796 let position_at_end bb = position_builder (At_end bb)
799 (*--... Metadata ...........................................................--*)
800 external set_current_debug_location : llbuilder -> llvalue -> unit
801 = "llvm_set_current_debug_location"
802 external clear_current_debug_location : llbuilder -> unit
803 = "llvm_clear_current_debug_location"
804 external current_debug_location : llbuilder -> llvalue option
805 = "llvm_current_debug_location"
806 external set_inst_debug_location : llbuilder -> llvalue -> unit
807 = "llvm_set_inst_debug_location"
810 (*--... Terminators ........................................................--*)
811 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
812 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
813 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
814 = "llvm_build_aggregate_ret"
815 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
816 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
817 llvalue = "llvm_build_cond_br"
818 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
819 = "llvm_build_switch"
820 external add_case : llvalue -> llvalue -> llbasicblock -> unit
822 external build_indirect_br : llvalue -> int -> llbuilder -> llvalue
823 = "llvm_build_indirect_br"
824 external add_destination : llvalue -> llbasicblock -> unit
825 = "llvm_add_destination"
826 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
827 llbasicblock -> string -> llbuilder -> llvalue
828 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
829 external build_landingpad : lltype -> llvalue -> int -> string -> llbuilder ->
830 llvalue = "llvm_build_landingpad"
831 external set_cleanup : llvalue -> bool -> unit = "llvm_set_cleanup"
832 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
834 (*--... Arithmetic .........................................................--*)
835 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
837 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
838 = "llvm_build_nsw_add"
839 external build_nuw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
840 = "llvm_build_nuw_add"
841 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
843 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
845 external build_nsw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
846 = "llvm_build_nsw_sub"
847 external build_nuw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
848 = "llvm_build_nuw_sub"
849 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
851 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
853 external build_nsw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
854 = "llvm_build_nsw_mul"
855 external build_nuw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
856 = "llvm_build_nuw_mul"
857 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
859 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
861 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
863 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
864 = "llvm_build_exact_sdiv"
865 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
867 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
869 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
871 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
873 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
875 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
877 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
879 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
881 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
883 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
885 external build_neg : llvalue -> string -> llbuilder -> llvalue
887 external build_nsw_neg : llvalue -> string -> llbuilder -> llvalue
888 = "llvm_build_nsw_neg"
889 external build_nuw_neg : llvalue -> string -> llbuilder -> llvalue
890 = "llvm_build_nuw_neg"
891 external build_fneg : llvalue -> string -> llbuilder -> llvalue
893 external build_not : llvalue -> string -> llbuilder -> llvalue
896 (*--... Memory .............................................................--*)
897 external build_alloca : lltype -> string -> llbuilder -> llvalue
898 = "llvm_build_alloca"
899 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
900 llvalue = "llvm_build_array_alloca"
901 external build_load : llvalue -> string -> llbuilder -> llvalue
903 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
905 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
907 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
908 llbuilder -> llvalue = "llvm_build_in_bounds_gep"
909 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
910 = "llvm_build_struct_gep"
912 external build_global_string : string -> string -> llbuilder -> llvalue
913 = "llvm_build_global_string"
914 external build_global_stringptr : string -> string -> llbuilder -> llvalue
915 = "llvm_build_global_stringptr"
917 (*--... Casts ..............................................................--*)
918 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
920 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
922 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
924 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
925 = "llvm_build_fptoui"
926 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
927 = "llvm_build_fptosi"
928 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
929 = "llvm_build_uitofp"
930 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
931 = "llvm_build_sitofp"
932 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
933 = "llvm_build_fptrunc"
934 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
936 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
937 = "llvm_build_prttoint"
938 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
939 = "llvm_build_inttoptr"
940 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
941 = "llvm_build_bitcast"
942 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
943 llvalue = "llvm_build_zext_or_bitcast"
944 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
945 llvalue = "llvm_build_sext_or_bitcast"
946 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
947 llvalue = "llvm_build_trunc_or_bitcast"
948 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
949 = "llvm_build_pointercast"
950 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
951 = "llvm_build_intcast"
952 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
953 = "llvm_build_fpcast"
955 (*--... Comparisons ........................................................--*)
956 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
957 llbuilder -> llvalue = "llvm_build_icmp"
958 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
959 llbuilder -> llvalue = "llvm_build_fcmp"
961 (*--... Miscellaneous instructions .........................................--*)
962 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
963 llvalue = "llvm_build_phi"
964 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
966 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
967 llvalue = "llvm_build_select"
968 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
969 = "llvm_build_va_arg"
970 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
971 llvalue = "llvm_build_extractelement"
972 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
973 llbuilder -> llvalue = "llvm_build_insertelement"
974 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
975 llbuilder -> llvalue = "llvm_build_shufflevector"
976 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
977 = "llvm_build_extractvalue"
978 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
979 llvalue = "llvm_build_insertvalue"
981 external build_is_null : llvalue -> string -> llbuilder -> llvalue
982 = "llvm_build_is_null"
983 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
984 = "llvm_build_is_not_null"
985 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
986 = "llvm_build_ptrdiff"
989 (*===-- Memory buffers ----------------------------------------------------===*)
991 module MemoryBuffer = struct
992 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
993 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
994 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
998 (*===-- Pass Manager ------------------------------------------------------===*)
1000 module PassManager = struct
1002 type any = [ `Module | `Function ]
1003 external create : unit -> [ `Module ] t = "llvm_passmanager_create"
1004 external create_function : llmodule -> [ `Function ] t
1005 = "LLVMCreateFunctionPassManager"
1006 external run_module : llmodule -> [ `Module ] t -> bool
1007 = "llvm_passmanager_run_module"
1008 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
1009 external run_function : llvalue -> [ `Function ] t -> bool
1010 = "llvm_passmanager_run_function"
1011 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
1012 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
1016 (*===-- Non-Externs -------------------------------------------------------===*)
1017 (* These functions are built using the externals, so must be declared late. *)
1019 let concat2 sep arr =
1021 if 0 < Array.length arr then begin
1023 for i = 1 to (Array.length arr) - 1 do
1024 s := !s ^ sep ^ arr.(i)
1029 let rec string_of_lltype ty =
1030 (* FIXME: stop infinite recursion! :) *)
1031 match classify_type ty with
1032 TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
1033 | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
1034 | TypeKind.Struct ->
1035 let s = "{ " ^ (concat2 ", " (
1036 Array.map string_of_lltype (struct_element_types ty)
1041 | TypeKind.Array -> "[" ^ (string_of_int (array_length ty)) ^
1042 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
1043 | TypeKind.Vector -> "<" ^ (string_of_int (vector_size ty)) ^
1044 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
1045 | TypeKind.Function -> string_of_lltype (return_type ty) ^
1046 " (" ^ (concat2 ", " (
1047 Array.map string_of_lltype (param_types ty)
1049 | TypeKind.Label -> "label"
1050 | TypeKind.Ppc_fp128 -> "ppc_fp128"
1051 | TypeKind.Fp128 -> "fp128"
1052 | TypeKind.X86fp80 -> "x86_fp80"
1053 | TypeKind.Double -> "double"
1054 | TypeKind.Float -> "float"
1055 | TypeKind.Void -> "void"
1056 | TypeKind.Metadata -> "metadata"