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"
171 (*--... Operations on integer types ........................................--*)
172 external i1_type : llcontext -> lltype = "llvm_i1_type"
173 external i8_type : llcontext -> lltype = "llvm_i8_type"
174 external i16_type : llcontext -> lltype = "llvm_i16_type"
175 external i32_type : llcontext -> lltype = "llvm_i32_type"
176 external i64_type : llcontext -> lltype = "llvm_i64_type"
178 external integer_type : llcontext -> int -> lltype = "llvm_integer_type"
179 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
181 (*--... Operations on real types ...........................................--*)
182 external float_type : llcontext -> lltype = "llvm_float_type"
183 external double_type : llcontext -> lltype = "llvm_double_type"
184 external x86fp80_type : llcontext -> lltype = "llvm_x86fp80_type"
185 external fp128_type : llcontext -> lltype = "llvm_fp128_type"
186 external ppc_fp128_type : llcontext -> lltype = "llvm_ppc_fp128_type"
188 (*--... Operations on function types .......................................--*)
189 external function_type : lltype -> lltype array -> lltype = "llvm_function_type"
190 external var_arg_function_type : lltype -> lltype array -> lltype
191 = "llvm_var_arg_function_type"
192 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
193 external return_type : lltype -> lltype = "LLVMGetReturnType"
194 external param_types : lltype -> lltype array = "llvm_param_types"
196 (*--... Operations on struct types .........................................--*)
197 external struct_type : llcontext -> lltype array -> lltype = "llvm_struct_type"
198 external packed_struct_type : llcontext -> lltype array -> lltype
199 = "llvm_packed_struct_type"
200 external struct_name : lltype -> string option = "llvm_struct_name"
201 external struct_element_types : lltype -> lltype array
202 = "llvm_struct_element_types"
203 external is_packed : lltype -> bool = "llvm_is_packed"
205 (*--... Operations on pointer, vector, and array types .....................--*)
206 external array_type : lltype -> int -> lltype = "llvm_array_type"
207 external pointer_type : lltype -> lltype = "llvm_pointer_type"
208 external qualified_pointer_type : lltype -> int -> lltype
209 = "llvm_qualified_pointer_type"
210 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
212 external element_type : lltype -> lltype = "LLVMGetElementType"
213 external array_length : lltype -> int = "llvm_array_length"
214 external address_space : lltype -> int = "llvm_address_space"
215 external vector_size : lltype -> int = "llvm_vector_size"
217 (*--... Operations on other types ..........................................--*)
218 external void_type : llcontext -> lltype = "llvm_void_type"
219 external label_type : llcontext -> lltype = "llvm_label_type"
221 (*===-- Values ------------------------------------------------------------===*)
222 external type_of : llvalue -> lltype = "llvm_type_of"
223 external value_name : llvalue -> string = "llvm_value_name"
224 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
225 external dump_value : llvalue -> unit = "llvm_dump_value"
226 external replace_all_uses_with : llvalue -> llvalue -> unit
227 = "LLVMReplaceAllUsesWith"
229 (*--... Operations on uses .................................................--*)
230 external use_begin : llvalue -> lluse option = "llvm_use_begin"
231 external use_succ : lluse -> lluse option = "llvm_use_succ"
232 external user : lluse -> llvalue = "llvm_user"
233 external used_value : lluse -> llvalue = "llvm_used_value"
236 let rec aux = function
244 let fold_left_uses f init v =
248 | Some u -> aux (f init u) (use_succ u)
250 aux init (use_begin v)
252 let fold_right_uses f v init =
256 | Some u -> f u (aux (use_succ u) init)
258 aux (use_begin v) init
261 (*--... Operations on users ................................................--*)
262 external operand : llvalue -> int -> llvalue = "llvm_operand"
263 external set_operand : llvalue -> int -> llvalue -> unit = "llvm_set_operand"
264 external num_operands : llvalue -> int = "llvm_num_operands"
266 (*--... Operations on constants of (mostly) any type .......................--*)
267 external is_constant : llvalue -> bool = "llvm_is_constant"
268 external const_null : lltype -> llvalue = "LLVMConstNull"
269 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
270 external const_pointer_null : lltype -> llvalue = "LLVMConstPointerNull"
271 external undef : lltype -> llvalue = "LLVMGetUndef"
272 external is_null : llvalue -> bool = "llvm_is_null"
273 external is_undef : llvalue -> bool = "llvm_is_undef"
275 (*--... Operations on instructions .........................................--*)
276 external has_metadata : llvalue -> bool = "llvm_has_metadata"
277 external metadata : llvalue -> int -> llvalue option = "llvm_metadata"
278 external set_metadata : llvalue -> int -> llvalue -> unit = "llvm_set_metadata"
279 external clear_metadata : llvalue -> int -> unit = "llvm_clear_metadata"
281 (*--... Operations on metadata .......,.....................................--*)
282 external mdstring : llcontext -> string -> llvalue = "llvm_mdstring"
283 external mdnode : llcontext -> llvalue array -> llvalue = "llvm_mdnode"
284 external get_mdstring : llvalue -> string option = "llvm_get_mdstring"
285 external get_named_metadata : llmodule -> string -> llvalue array = "llvm_get_namedmd"
287 (*--... Operations on scalar constants .....................................--*)
288 external const_int : lltype -> int -> llvalue = "llvm_const_int"
289 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
290 = "llvm_const_of_int64"
291 external const_int_of_string : lltype -> string -> int -> llvalue
292 = "llvm_const_int_of_string"
293 external const_float : lltype -> float -> llvalue = "llvm_const_float"
294 external const_float_of_string : lltype -> string -> llvalue
295 = "llvm_const_float_of_string"
297 (*--... Operations on composite constants ..................................--*)
298 external const_string : llcontext -> string -> llvalue = "llvm_const_string"
299 external const_stringz : llcontext -> string -> llvalue = "llvm_const_stringz"
300 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
301 external const_struct : llcontext -> llvalue array -> llvalue
302 = "llvm_const_struct"
303 external const_packed_struct : llcontext -> llvalue array -> llvalue
304 = "llvm_const_packed_struct"
305 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
307 (*--... Constant expressions ...............................................--*)
308 external align_of : lltype -> llvalue = "LLVMAlignOf"
309 external size_of : lltype -> llvalue = "LLVMSizeOf"
310 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
311 external const_nsw_neg : llvalue -> llvalue = "LLVMConstNSWNeg"
312 external const_nuw_neg : llvalue -> llvalue = "LLVMConstNUWNeg"
313 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
314 external const_not : llvalue -> llvalue = "LLVMConstNot"
315 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
316 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
317 external const_nuw_add : llvalue -> llvalue -> llvalue = "LLVMConstNUWAdd"
318 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
319 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
320 external const_nsw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNSWSub"
321 external const_nuw_sub : llvalue -> llvalue -> llvalue = "LLVMConstNUWSub"
322 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
323 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
324 external const_nsw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNSWMul"
325 external const_nuw_mul : llvalue -> llvalue -> llvalue = "LLVMConstNUWMul"
326 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
327 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
328 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
329 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
330 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
331 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
332 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
333 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
334 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
335 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
336 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
337 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
339 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
341 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
342 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
343 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
344 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
345 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
346 = "llvm_const_in_bounds_gep"
347 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
348 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
349 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
350 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
351 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
352 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
353 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
354 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
355 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
356 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
357 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
358 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
359 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
360 = "LLVMConstZExtOrBitCast"
361 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
362 = "LLVMConstSExtOrBitCast"
363 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
364 = "LLVMConstTruncOrBitCast"
365 external const_pointercast : llvalue -> lltype -> llvalue
366 = "LLVMConstPointerCast"
367 external const_intcast : llvalue -> lltype -> llvalue = "LLVMConstIntCast"
368 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
369 external const_select : llvalue -> llvalue -> llvalue -> llvalue
371 external const_extractelement : llvalue -> llvalue -> llvalue
372 = "LLVMConstExtractElement"
373 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
374 = "LLVMConstInsertElement"
375 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
376 = "LLVMConstShuffleVector"
377 external const_extractvalue : llvalue -> int array -> llvalue
378 = "llvm_const_extractvalue"
379 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
380 = "llvm_const_insertvalue"
381 external const_inline_asm : lltype -> string -> string -> bool -> bool ->
383 = "llvm_const_inline_asm"
384 external block_address : llvalue -> llbasicblock -> llvalue = "LLVMBlockAddress"
386 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
387 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
388 external is_declaration : llvalue -> bool = "llvm_is_declaration"
389 external linkage : llvalue -> Linkage.t = "llvm_linkage"
390 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
391 external section : llvalue -> string = "llvm_section"
392 external set_section : string -> llvalue -> unit = "llvm_set_section"
393 external visibility : llvalue -> Visibility.t = "llvm_visibility"
394 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
395 external alignment : llvalue -> int = "llvm_alignment"
396 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
397 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
398 external set_global_constant : bool -> llvalue -> unit
399 = "llvm_set_global_constant"
401 (*--... Operations on global variables .....................................--*)
402 external declare_global : lltype -> string -> llmodule -> llvalue
403 = "llvm_declare_global"
404 external declare_qualified_global : lltype -> string -> int -> llmodule ->
406 = "llvm_declare_qualified_global"
407 external define_global : string -> llvalue -> llmodule -> llvalue
408 = "llvm_define_global"
409 external define_qualified_global : string -> llvalue -> int -> llmodule ->
411 = "llvm_define_qualified_global"
412 external lookup_global : string -> llmodule -> llvalue option
413 = "llvm_lookup_global"
414 external delete_global : llvalue -> unit = "llvm_delete_global"
415 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
416 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
417 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
418 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
419 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
420 external global_begin : llmodule -> (llmodule, llvalue) llpos
421 = "llvm_global_begin"
422 external global_succ : llvalue -> (llmodule, llvalue) llpos
424 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
426 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
429 let rec iter_global_range f i e =
430 if i = e then () else
432 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
435 iter_global_range f (global_succ bb) e
437 let iter_globals f m =
438 iter_global_range f (global_begin m) (At_end m)
440 let rec fold_left_global_range f init i e =
441 if i = e then init else
443 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
444 | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
446 let fold_left_globals f init m =
447 fold_left_global_range f init (global_begin m) (At_end m)
449 let rec rev_iter_global_range f i e =
450 if i = e then () else
452 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
455 rev_iter_global_range f (global_pred bb) e
457 let rev_iter_globals f m =
458 rev_iter_global_range f (global_end m) (At_start m)
460 let rec fold_right_global_range f i e init =
461 if i = e then init else
463 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
464 | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
466 let fold_right_globals f m init =
467 fold_right_global_range f (global_end m) (At_start m) init
469 (*--... Operations on aliases ..............................................--*)
470 external add_alias : llmodule -> lltype -> llvalue -> string -> llvalue
473 (*--... Operations on functions ............................................--*)
474 external declare_function : string -> lltype -> llmodule -> llvalue
475 = "llvm_declare_function"
476 external define_function : string -> lltype -> llmodule -> llvalue
477 = "llvm_define_function"
478 external lookup_function : string -> llmodule -> llvalue option
479 = "llvm_lookup_function"
480 external delete_function : llvalue -> unit = "llvm_delete_function"
481 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
482 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
483 external set_function_call_conv : int -> llvalue -> unit
484 = "llvm_set_function_call_conv"
485 external gc : llvalue -> string option = "llvm_gc"
486 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
487 external function_begin : llmodule -> (llmodule, llvalue) llpos
488 = "llvm_function_begin"
489 external function_succ : llvalue -> (llmodule, llvalue) llpos
490 = "llvm_function_succ"
491 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
492 = "llvm_function_end"
493 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
494 = "llvm_function_pred"
496 let rec iter_function_range f i e =
497 if i = e then () else
499 | At_end _ -> raise (Invalid_argument "Invalid function range.")
502 iter_function_range f (function_succ fn) e
504 let iter_functions f m =
505 iter_function_range f (function_begin m) (At_end m)
507 let rec fold_left_function_range f init i e =
508 if i = e then init else
510 | At_end _ -> raise (Invalid_argument "Invalid function range.")
511 | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
513 let fold_left_functions f init m =
514 fold_left_function_range f init (function_begin m) (At_end m)
516 let rec rev_iter_function_range f i e =
517 if i = e then () else
519 | At_start _ -> raise (Invalid_argument "Invalid function range.")
522 rev_iter_function_range f (function_pred fn) e
524 let rev_iter_functions f m =
525 rev_iter_function_range f (function_end m) (At_start m)
527 let rec fold_right_function_range f i e init =
528 if i = e then init else
530 | At_start _ -> raise (Invalid_argument "Invalid function range.")
531 | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
533 let fold_right_functions f m init =
534 fold_right_function_range f (function_end m) (At_start m) init
536 external llvm_add_function_attr : llvalue -> int -> unit
537 = "llvm_add_function_attr"
538 external llvm_remove_function_attr : llvalue -> int -> unit
539 = "llvm_remove_function_attr"
541 let pack_attr (attr:Attribute.t) : int =
543 Attribute.Zext -> 1 lsl 0
544 | Attribute.Sext -> 1 lsl 1
545 | Attribute.Noreturn -> 1 lsl 2
546 | Attribute.Inreg -> 1 lsl 3
547 | Attribute.Structret -> 1 lsl 4
548 | Attribute.Nounwind -> 1 lsl 5
549 | Attribute.Noalias -> 1 lsl 6
550 | Attribute.Byval -> 1 lsl 7
551 | Attribute.Nest -> 1 lsl 8
552 | Attribute.Readnone -> 1 lsl 9
553 | Attribute.Readonly -> 1 lsl 10
554 | Attribute.Noinline -> 1 lsl 11
555 | Attribute.Alwaysinline -> 1 lsl 12
556 | Attribute.Optsize -> 1 lsl 13
557 | Attribute.Ssp -> 1 lsl 14
558 | Attribute.Sspreq -> 1 lsl 15
559 | Attribute.Alignment n -> n lsl 16
560 | Attribute.Nocapture -> 1 lsl 21
561 | Attribute.Noredzone -> 1 lsl 22
562 | Attribute.Noimplicitfloat -> 1 lsl 23
563 | Attribute.Naked -> 1 lsl 24
564 | Attribute.Inlinehint -> 1 lsl 25
565 | Attribute.Stackalignment n -> n lsl 26
567 let add_function_attr llval attr =
568 llvm_add_function_attr llval (pack_attr attr)
570 let remove_function_attr llval attr =
571 llvm_remove_function_attr llval (pack_attr attr)
573 (*--... Operations on params ...............................................--*)
574 external params : llvalue -> llvalue array = "llvm_params"
575 external param : llvalue -> int -> llvalue = "llvm_param"
576 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
577 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
578 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
579 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
580 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
582 let rec iter_param_range f i e =
583 if i = e then () else
585 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
588 iter_param_range f (param_succ p) e
590 let iter_params f fn =
591 iter_param_range f (param_begin fn) (At_end fn)
593 let rec fold_left_param_range f init i e =
594 if i = e then init else
596 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
597 | Before p -> fold_left_param_range f (f init p) (param_succ p) e
599 let fold_left_params f init fn =
600 fold_left_param_range f init (param_begin fn) (At_end fn)
602 let rec rev_iter_param_range f i e =
603 if i = e then () else
605 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
608 rev_iter_param_range f (param_pred p) e
610 let rev_iter_params f fn =
611 rev_iter_param_range f (param_end fn) (At_start fn)
613 let rec fold_right_param_range f init i e =
614 if i = e then init else
616 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
617 | After p -> fold_right_param_range f (f p init) (param_pred p) e
619 let fold_right_params f fn init =
620 fold_right_param_range f init (param_end fn) (At_start fn)
622 external llvm_add_param_attr : llvalue -> int -> unit
623 = "llvm_add_param_attr"
624 external llvm_remove_param_attr : llvalue -> int -> unit
625 = "llvm_remove_param_attr"
627 let add_param_attr llval attr =
628 llvm_add_param_attr llval (pack_attr attr)
630 let remove_param_attr llval attr =
631 llvm_remove_param_attr llval (pack_attr attr)
633 external set_param_alignment : llvalue -> int -> unit
634 = "llvm_set_param_alignment"
636 (*--... Operations on basic blocks .........................................--*)
637 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
638 external value_is_block : llvalue -> bool = "llvm_value_is_block"
639 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
640 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
641 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
642 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
643 external delete_block : llbasicblock -> unit = "llvm_delete_block"
644 external append_block : llcontext -> string -> llvalue -> llbasicblock
645 = "llvm_append_block"
646 external insert_block : llcontext -> string -> llbasicblock -> llbasicblock
647 = "llvm_insert_block"
648 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
650 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
652 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
654 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
657 let rec iter_block_range f i e =
658 if i = e then () else
660 | At_end _ -> raise (Invalid_argument "Invalid block range.")
663 iter_block_range f (block_succ bb) e
665 let iter_blocks f fn =
666 iter_block_range f (block_begin fn) (At_end fn)
668 let rec fold_left_block_range f init i e =
669 if i = e then init else
671 | At_end _ -> raise (Invalid_argument "Invalid block range.")
672 | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
674 let fold_left_blocks f init fn =
675 fold_left_block_range f init (block_begin fn) (At_end fn)
677 let rec rev_iter_block_range f i e =
678 if i = e then () else
680 | At_start _ -> raise (Invalid_argument "Invalid block range.")
683 rev_iter_block_range f (block_pred bb) e
685 let rev_iter_blocks f fn =
686 rev_iter_block_range f (block_end fn) (At_start fn)
688 let rec fold_right_block_range f init i e =
689 if i = e then init else
691 | At_start _ -> raise (Invalid_argument "Invalid block range.")
692 | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
694 let fold_right_blocks f fn init =
695 fold_right_block_range f init (block_end fn) (At_start fn)
697 (*--... Operations on instructions .........................................--*)
698 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
699 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
701 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
703 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
705 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
708 let rec iter_instrs_range f i e =
709 if i = e then () else
711 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
714 iter_instrs_range f (instr_succ i) e
716 let iter_instrs f bb =
717 iter_instrs_range f (instr_begin bb) (At_end bb)
719 let rec fold_left_instrs_range f init i e =
720 if i = e then init else
722 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
723 | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
725 let fold_left_instrs f init bb =
726 fold_left_instrs_range f init (instr_begin bb) (At_end bb)
728 let rec rev_iter_instrs_range f i e =
729 if i = e then () else
731 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
734 rev_iter_instrs_range f (instr_pred i) e
736 let rev_iter_instrs f bb =
737 rev_iter_instrs_range f (instr_end bb) (At_start bb)
739 let rec fold_right_instr_range f i e init =
740 if i = e then init else
742 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
743 | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
745 let fold_right_instrs f bb init =
746 fold_right_instr_range f (instr_end bb) (At_start bb) init
749 (*--... Operations on call sites ...........................................--*)
750 external instruction_call_conv: llvalue -> int
751 = "llvm_instruction_call_conv"
752 external set_instruction_call_conv: int -> llvalue -> unit
753 = "llvm_set_instruction_call_conv"
755 external llvm_add_instruction_param_attr : llvalue -> int -> int -> unit
756 = "llvm_add_instruction_param_attr"
757 external llvm_remove_instruction_param_attr : llvalue -> int -> int -> unit
758 = "llvm_remove_instruction_param_attr"
760 let add_instruction_param_attr llval i attr =
761 llvm_add_instruction_param_attr llval i (pack_attr attr)
763 let remove_instruction_param_attr llval i attr =
764 llvm_remove_instruction_param_attr llval i (pack_attr attr)
766 (*--... Operations on call instructions (only) .............................--*)
767 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
768 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
770 (*--... Operations on phi nodes ............................................--*)
771 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
772 = "llvm_add_incoming"
773 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
776 (*===-- Instruction builders ----------------------------------------------===*)
777 external builder : llcontext -> llbuilder = "llvm_builder"
778 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
779 = "llvm_position_builder"
780 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
781 external insert_into_builder : llvalue -> string -> llbuilder -> unit
782 = "llvm_insert_into_builder"
784 let builder_at context ip =
785 let b = builder context in
786 position_builder ip b;
789 let builder_before context i = builder_at context (Before i)
790 let builder_at_end context bb = builder_at context (At_end bb)
792 let position_before i = position_builder (Before i)
793 let position_at_end bb = position_builder (At_end bb)
796 (*--... Metadata ...........................................................--*)
797 external set_current_debug_location : llbuilder -> llvalue -> unit
798 = "llvm_set_current_debug_location"
799 external clear_current_debug_location : llbuilder -> unit
800 = "llvm_clear_current_debug_location"
801 external current_debug_location : llbuilder -> llvalue option
802 = "llvm_current_debug_location"
803 external set_inst_debug_location : llbuilder -> llvalue -> unit
804 = "llvm_set_inst_debug_location"
807 (*--... Terminators ........................................................--*)
808 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
809 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
810 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
811 = "llvm_build_aggregate_ret"
812 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
813 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
814 llvalue = "llvm_build_cond_br"
815 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
816 = "llvm_build_switch"
817 external add_case : llvalue -> llvalue -> llbasicblock -> unit
819 external build_indirect_br : llvalue -> int -> llbuilder -> llvalue
820 = "llvm_build_indirect_br"
821 external add_destination : llvalue -> llbasicblock -> unit
822 = "llvm_add_destination"
823 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
824 llbasicblock -> string -> llbuilder -> llvalue
825 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
826 external build_landingpad : lltype -> llvalue -> int -> string -> llbuilder ->
827 llvalue = "llvm_build_landingpad"
828 external set_cleanup : llvalue -> bool -> unit = "llvm_set_cleanup"
829 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
831 (*--... Arithmetic .........................................................--*)
832 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
834 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
835 = "llvm_build_nsw_add"
836 external build_nuw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
837 = "llvm_build_nuw_add"
838 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
840 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
842 external build_nsw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
843 = "llvm_build_nsw_sub"
844 external build_nuw_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
845 = "llvm_build_nuw_sub"
846 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
848 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
850 external build_nsw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
851 = "llvm_build_nsw_mul"
852 external build_nuw_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
853 = "llvm_build_nuw_mul"
854 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
856 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
858 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
860 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
861 = "llvm_build_exact_sdiv"
862 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
864 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
866 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
868 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
870 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
872 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
874 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
876 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
878 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
880 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
882 external build_neg : llvalue -> string -> llbuilder -> llvalue
884 external build_nsw_neg : llvalue -> string -> llbuilder -> llvalue
885 = "llvm_build_nsw_neg"
886 external build_nuw_neg : llvalue -> string -> llbuilder -> llvalue
887 = "llvm_build_nuw_neg"
888 external build_fneg : llvalue -> string -> llbuilder -> llvalue
890 external build_not : llvalue -> string -> llbuilder -> llvalue
893 (*--... Memory .............................................................--*)
894 external build_alloca : lltype -> string -> llbuilder -> llvalue
895 = "llvm_build_alloca"
896 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
897 llvalue = "llvm_build_array_alloca"
898 external build_load : llvalue -> string -> llbuilder -> llvalue
900 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
902 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
904 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
905 llbuilder -> llvalue = "llvm_build_in_bounds_gep"
906 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
907 = "llvm_build_struct_gep"
909 external build_global_string : string -> string -> llbuilder -> llvalue
910 = "llvm_build_global_string"
911 external build_global_stringptr : string -> string -> llbuilder -> llvalue
912 = "llvm_build_global_stringptr"
914 (*--... Casts ..............................................................--*)
915 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
917 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
919 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
921 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
922 = "llvm_build_fptoui"
923 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
924 = "llvm_build_fptosi"
925 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
926 = "llvm_build_uitofp"
927 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
928 = "llvm_build_sitofp"
929 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
930 = "llvm_build_fptrunc"
931 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
933 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
934 = "llvm_build_prttoint"
935 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
936 = "llvm_build_inttoptr"
937 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
938 = "llvm_build_bitcast"
939 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
940 llvalue = "llvm_build_zext_or_bitcast"
941 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
942 llvalue = "llvm_build_sext_or_bitcast"
943 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
944 llvalue = "llvm_build_trunc_or_bitcast"
945 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
946 = "llvm_build_pointercast"
947 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
948 = "llvm_build_intcast"
949 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
950 = "llvm_build_fpcast"
952 (*--... Comparisons ........................................................--*)
953 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
954 llbuilder -> llvalue = "llvm_build_icmp"
955 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
956 llbuilder -> llvalue = "llvm_build_fcmp"
958 (*--... Miscellaneous instructions .........................................--*)
959 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
960 llvalue = "llvm_build_phi"
961 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
963 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
964 llvalue = "llvm_build_select"
965 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
966 = "llvm_build_va_arg"
967 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
968 llvalue = "llvm_build_extractelement"
969 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
970 llbuilder -> llvalue = "llvm_build_insertelement"
971 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
972 llbuilder -> llvalue = "llvm_build_shufflevector"
973 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
974 = "llvm_build_extractvalue"
975 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
976 llvalue = "llvm_build_insertvalue"
978 external build_is_null : llvalue -> string -> llbuilder -> llvalue
979 = "llvm_build_is_null"
980 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
981 = "llvm_build_is_not_null"
982 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
983 = "llvm_build_ptrdiff"
986 (*===-- Memory buffers ----------------------------------------------------===*)
988 module MemoryBuffer = struct
989 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
990 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
991 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
995 (*===-- Pass Manager ------------------------------------------------------===*)
997 module PassManager = struct
999 type any = [ `Module | `Function ]
1000 external create : unit -> [ `Module ] t = "llvm_passmanager_create"
1001 external create_function : llmodule -> [ `Function ] t
1002 = "LLVMCreateFunctionPassManager"
1003 external run_module : llmodule -> [ `Module ] t -> bool
1004 = "llvm_passmanager_run_module"
1005 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
1006 external run_function : llvalue -> [ `Function ] t -> bool
1007 = "llvm_passmanager_run_function"
1008 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
1009 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
1013 (*===-- Non-Externs -------------------------------------------------------===*)
1014 (* These functions are built using the externals, so must be declared late. *)
1016 let concat2 sep arr =
1018 if 0 < Array.length arr then begin
1020 for i = 1 to (Array.length arr) - 1 do
1021 s := !s ^ sep ^ arr.(i)
1026 let rec string_of_lltype ty =
1027 (* FIXME: stop infinite recursion! :) *)
1028 match classify_type ty with
1029 TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
1030 | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
1031 | TypeKind.Struct ->
1032 let s = "{ " ^ (concat2 ", " (
1033 Array.map string_of_lltype (struct_element_types ty)
1038 | TypeKind.Array -> "[" ^ (string_of_int (array_length ty)) ^
1039 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
1040 | TypeKind.Vector -> "<" ^ (string_of_int (vector_size ty)) ^
1041 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
1042 | TypeKind.Function -> string_of_lltype (return_type ty) ^
1043 " (" ^ (concat2 ", " (
1044 Array.map string_of_lltype (param_types ty)
1046 | TypeKind.Label -> "label"
1047 | TypeKind.Ppc_fp128 -> "ppc_fp128"
1048 | TypeKind.Fp128 -> "fp128"
1049 | TypeKind.X86fp80 -> "x86_fp80"
1050 | TypeKind.Double -> "double"
1051 | TypeKind.Float -> "float"
1052 | TypeKind.Void -> "void"
1053 | TypeKind.Metadata -> "metadata"