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 *===----------------------------------------------------------------------===*)
21 module TypeKind = struct
40 module Linkage = struct
43 | Available_externally
59 module Visibility = struct
66 module CallConv = struct
74 module Attribute = struct
132 exception IoError of string
134 external register_exns : exn -> unit = "llvm_register_core_exns"
135 let _ = register_exns (IoError "")
137 type ('a, 'b) llpos =
141 type ('a, 'b) llrev_pos =
145 (*===-- Contexts ----------------------------------------------------------===*)
146 external create_context : unit -> llcontext = "llvm_create_context"
147 external dispose_context : unit -> llcontext = "llvm_dispose_context"
148 external global_context : unit -> llcontext = "llvm_global_context"
150 (*===-- Modules -----------------------------------------------------------===*)
151 external create_module : llcontext -> string -> llmodule = "llvm_create_module"
152 external dispose_module : llmodule -> unit = "llvm_dispose_module"
153 external target_triple: llmodule -> string
154 = "llvm_target_triple"
155 external set_target_triple: string -> llmodule -> unit
156 = "llvm_set_target_triple"
157 external data_layout: llmodule -> string
159 external set_data_layout: string -> llmodule -> unit
160 = "llvm_set_data_layout"
161 external define_type_name : string -> lltype -> llmodule -> bool
162 = "llvm_add_type_name"
163 external delete_type_name : string -> llmodule -> unit
164 = "llvm_delete_type_name"
165 external dump_module : llmodule -> unit = "llvm_dump_module"
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 element_types : lltype -> lltype array = "llvm_element_types"
201 external is_packed : lltype -> bool = "llvm_is_packed"
203 (*--... Operations on pointer, vector, and array types .....................--*)
204 external array_type : lltype -> int -> lltype = "llvm_array_type"
205 external pointer_type : lltype -> lltype = "llvm_pointer_type"
206 external qualified_pointer_type : lltype -> int -> lltype
207 = "llvm_qualified_pointer_type"
208 external vector_type : lltype -> int -> lltype = "llvm_vector_type"
210 external element_type : lltype -> lltype = "LLVMGetElementType"
211 external array_length : lltype -> int = "llvm_array_length"
212 external address_space : lltype -> int = "llvm_address_space"
213 external vector_size : lltype -> int = "llvm_vector_size"
215 (*--... Operations on other types ..........................................--*)
216 external opaque_type : llcontext -> lltype = "llvm_opaque_type"
217 external void_type : llcontext -> lltype = "llvm_void_type"
218 external label_type : llcontext -> lltype = "llvm_label_type"
220 (*--... Operations on type handles .........................................--*)
221 external handle_to_type : lltype -> lltypehandle = "llvm_handle_to_type"
222 external type_of_handle : lltypehandle -> lltype = "llvm_type_of_handle"
223 external refine_type : lltype -> lltype -> unit = "llvm_refine_type"
226 (*===-- Values ------------------------------------------------------------===*)
227 external type_of : llvalue -> lltype = "llvm_type_of"
228 external value_name : llvalue -> string = "llvm_value_name"
229 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
230 external dump_value : llvalue -> unit = "llvm_dump_value"
232 (*--... Operations on constants of (mostly) any type .......................--*)
233 external is_constant : llvalue -> bool = "llvm_is_constant"
234 external const_null : lltype -> llvalue = "LLVMConstNull"
235 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
236 external undef : lltype -> llvalue = "LLVMGetUndef"
237 external is_null : llvalue -> bool = "llvm_is_null"
238 external is_undef : llvalue -> bool = "llvm_is_undef"
240 (*--... Operations on scalar constants .....................................--*)
241 external const_int : lltype -> int -> llvalue = "llvm_const_int"
242 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
243 = "llvm_const_of_int64"
244 external const_int_of_string : lltype -> string -> int -> llvalue
245 = "llvm_const_int_of_string"
246 external const_float : lltype -> float -> llvalue = "llvm_const_float"
247 external const_float_of_string : lltype -> string -> llvalue
248 = "llvm_const_float_of_string"
250 (*--... Operations on composite constants ..................................--*)
251 external const_string : llcontext -> string -> llvalue = "llvm_const_string"
252 external const_stringz : llcontext -> string -> llvalue = "llvm_const_stringz"
253 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
254 external const_struct : llcontext -> llvalue array -> llvalue
255 = "llvm_const_struct"
256 external const_packed_struct : llcontext -> llvalue array -> llvalue
257 = "llvm_const_packed_struct"
258 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
260 (*--... Constant expressions ...............................................--*)
261 external align_of : lltype -> llvalue = "LLVMAlignOf"
262 external size_of : lltype -> llvalue = "LLVMSizeOf"
263 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
264 external const_fneg : llvalue -> llvalue = "LLVMConstFNeg"
265 external const_not : llvalue -> llvalue = "LLVMConstNot"
266 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
267 external const_nsw_add : llvalue -> llvalue -> llvalue = "LLVMConstNSWAdd"
268 external const_fadd : llvalue -> llvalue -> llvalue = "LLVMConstFAdd"
269 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
270 external const_fsub : llvalue -> llvalue -> llvalue = "LLVMConstFSub"
271 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
272 external const_fmul : llvalue -> llvalue -> llvalue = "LLVMConstFMul"
273 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
274 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
275 external const_exact_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstExactSDiv"
276 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
277 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
278 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
279 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
280 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
281 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
282 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
283 external const_icmp : Icmp.t -> llvalue -> llvalue -> llvalue
285 external const_fcmp : Fcmp.t -> llvalue -> llvalue -> llvalue
287 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
288 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
289 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
290 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
291 external const_in_bounds_gep : llvalue -> llvalue array -> llvalue
292 = "llvm_const_in_bounds_gep"
293 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
294 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
295 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
296 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
297 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
298 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
299 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
300 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
301 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
302 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
303 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
304 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
305 external const_zext_or_bitcast : llvalue -> lltype -> llvalue
306 = "LLVMConstZExtOrBitCast"
307 external const_sext_or_bitcast : llvalue -> lltype -> llvalue
308 = "LLVMConstSExtOrBitCast"
309 external const_trunc_or_bitcast : llvalue -> lltype -> llvalue
310 = "LLVMConstTruncOrBitCast"
311 external const_pointercast : llvalue -> lltype -> llvalue
312 = "LLVMConstPointerCast"
313 external const_intcast : llvalue -> lltype -> llvalue = "LLVMConstIntCast"
314 external const_fpcast : llvalue -> lltype -> llvalue = "LLVMConstFPCast"
315 external const_select : llvalue -> llvalue -> llvalue -> llvalue
317 external const_extractelement : llvalue -> llvalue -> llvalue
318 = "LLVMConstExtractElement"
319 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
320 = "LLVMConstInsertElement"
321 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
322 = "LLVMConstShuffleVector"
323 external const_extractvalue : llvalue -> int array -> llvalue
324 = "llvm_const_extractvalue"
325 external const_insertvalue : llvalue -> llvalue -> int array -> llvalue
326 = "llvm_const_insertvalue"
328 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
329 external global_parent : llvalue -> llmodule = "LLVMGetGlobalParent"
330 external is_declaration : llvalue -> bool = "llvm_is_declaration"
331 external linkage : llvalue -> Linkage.t = "llvm_linkage"
332 external set_linkage : Linkage.t -> llvalue -> unit = "llvm_set_linkage"
333 external section : llvalue -> string = "llvm_section"
334 external set_section : string -> llvalue -> unit = "llvm_set_section"
335 external visibility : llvalue -> Visibility.t = "llvm_visibility"
336 external set_visibility : Visibility.t -> llvalue -> unit = "llvm_set_visibility"
337 external alignment : llvalue -> int = "llvm_alignment"
338 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
339 external is_global_constant : llvalue -> bool = "llvm_is_global_constant"
340 external set_global_constant : bool -> llvalue -> unit
341 = "llvm_set_global_constant"
343 (*--... Operations on global variables .....................................--*)
344 external declare_global : lltype -> string -> llmodule -> llvalue
345 = "llvm_declare_global"
346 external define_global : string -> llvalue -> llmodule -> llvalue
347 = "llvm_define_global"
348 external lookup_global : string -> llmodule -> llvalue option
349 = "llvm_lookup_global"
350 external delete_global : llvalue -> unit = "llvm_delete_global"
351 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
352 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
353 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
354 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
355 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
356 external global_begin : llmodule -> (llmodule, llvalue) llpos
357 = "llvm_global_begin"
358 external global_succ : llvalue -> (llmodule, llvalue) llpos
360 external global_end : llmodule -> (llmodule, llvalue) llrev_pos
362 external global_pred : llvalue -> (llmodule, llvalue) llrev_pos
365 let rec iter_global_range f i e =
366 if i = e then () else
368 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
371 iter_global_range f (global_succ bb) e
373 let iter_globals f m =
374 iter_global_range f (global_begin m) (At_end m)
376 let rec fold_left_global_range f init i e =
377 if i = e then init else
379 | At_end _ -> raise (Invalid_argument "Invalid global variable range.")
380 | Before bb -> fold_left_global_range f (f init bb) (global_succ bb) e
382 let fold_left_globals f init m =
383 fold_left_global_range f init (global_begin m) (At_end m)
385 let rec rev_iter_global_range f i e =
386 if i = e then () else
388 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
391 rev_iter_global_range f (global_pred bb) e
393 let rev_iter_globals f m =
394 rev_iter_global_range f (global_end m) (At_start m)
396 let rec fold_right_global_range f i e init =
397 if i = e then init else
399 | At_start _ -> raise (Invalid_argument "Invalid global variable range.")
400 | After bb -> fold_right_global_range f (global_pred bb) e (f bb init)
402 let fold_right_globals f m init =
403 fold_right_global_range f (global_end m) (At_start m) init
405 (*--... Operations on functions ............................................--*)
406 external declare_function : string -> lltype -> llmodule -> llvalue
407 = "llvm_declare_function"
408 external define_function : string -> lltype -> llmodule -> llvalue
409 = "llvm_define_function"
410 external lookup_function : string -> llmodule -> llvalue option
411 = "llvm_lookup_function"
412 external delete_function : llvalue -> unit = "llvm_delete_function"
413 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
414 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
415 external set_function_call_conv : int -> llvalue -> unit
416 = "llvm_set_function_call_conv"
417 external gc : llvalue -> string option = "llvm_gc"
418 external set_gc : string option -> llvalue -> unit = "llvm_set_gc"
419 external function_begin : llmodule -> (llmodule, llvalue) llpos
420 = "llvm_function_begin"
421 external function_succ : llvalue -> (llmodule, llvalue) llpos
422 = "llvm_function_succ"
423 external function_end : llmodule -> (llmodule, llvalue) llrev_pos
424 = "llvm_function_end"
425 external function_pred : llvalue -> (llmodule, llvalue) llrev_pos
426 = "llvm_function_pred"
428 let rec iter_function_range f i e =
429 if i = e then () else
431 | At_end _ -> raise (Invalid_argument "Invalid function range.")
434 iter_function_range f (function_succ fn) e
436 let iter_functions f m =
437 iter_function_range f (function_begin m) (At_end m)
439 let rec fold_left_function_range f init i e =
440 if i = e then init else
442 | At_end _ -> raise (Invalid_argument "Invalid function range.")
443 | Before fn -> fold_left_function_range f (f init fn) (function_succ fn) e
445 let fold_left_functions f init m =
446 fold_left_function_range f init (function_begin m) (At_end m)
448 let rec rev_iter_function_range f i e =
449 if i = e then () else
451 | At_start _ -> raise (Invalid_argument "Invalid function range.")
454 rev_iter_function_range f (function_pred fn) e
456 let rev_iter_functions f m =
457 rev_iter_function_range f (function_end m) (At_start m)
459 let rec fold_right_function_range f i e init =
460 if i = e then init else
462 | At_start _ -> raise (Invalid_argument "Invalid function range.")
463 | After fn -> fold_right_function_range f (function_pred fn) e (f fn init)
465 let fold_right_functions f m init =
466 fold_right_function_range f (function_end m) (At_start m) init
468 external add_function_attr : llvalue -> Attribute.t -> unit
469 = "llvm_add_function_attr"
470 external remove_function_attr : llvalue -> Attribute.t -> unit
471 = "llvm_remove_function_attr"
473 (*--... Operations on params ...............................................--*)
474 external params : llvalue -> llvalue array = "llvm_params"
475 external param : llvalue -> int -> llvalue = "llvm_param"
476 external param_parent : llvalue -> llvalue = "LLVMGetParamParent"
477 external param_begin : llvalue -> (llvalue, llvalue) llpos = "llvm_param_begin"
478 external param_succ : llvalue -> (llvalue, llvalue) llpos = "llvm_param_succ"
479 external param_end : llvalue -> (llvalue, llvalue) llrev_pos = "llvm_param_end"
480 external param_pred : llvalue -> (llvalue, llvalue) llrev_pos ="llvm_param_pred"
482 let rec iter_param_range f i e =
483 if i = e then () else
485 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
488 iter_param_range f (param_succ p) e
490 let iter_params f fn =
491 iter_param_range f (param_begin fn) (At_end fn)
493 let rec fold_left_param_range f init i e =
494 if i = e then init else
496 | At_end _ -> raise (Invalid_argument "Invalid parameter range.")
497 | Before p -> fold_left_param_range f (f init p) (param_succ p) e
499 let fold_left_params f init fn =
500 fold_left_param_range f init (param_begin fn) (At_end fn)
502 let rec rev_iter_param_range f i e =
503 if i = e then () else
505 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
508 rev_iter_param_range f (param_pred p) e
510 let rev_iter_params f fn =
511 rev_iter_param_range f (param_end fn) (At_start fn)
513 let rec fold_right_param_range f init i e =
514 if i = e then init else
516 | At_start _ -> raise (Invalid_argument "Invalid parameter range.")
517 | After p -> fold_right_param_range f (f p init) (param_pred p) e
519 let fold_right_params f fn init =
520 fold_right_param_range f init (param_end fn) (At_start fn)
522 external add_param_attr : llvalue -> Attribute.t -> unit
523 = "llvm_add_param_attr"
524 external remove_param_attr : llvalue -> Attribute.t -> unit
525 = "llvm_remove_param_attr"
526 external set_param_alignment : llvalue -> int -> unit
527 = "llvm_set_param_alignment"
529 (*--... Operations on basic blocks .........................................--*)
530 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
531 external value_is_block : llvalue -> bool = "llvm_value_is_block"
532 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
533 external block_parent : llbasicblock -> llvalue = "LLVMGetBasicBlockParent"
534 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
535 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
536 external delete_block : llbasicblock -> unit = "llvm_delete_block"
537 external append_block : llcontext -> string -> llvalue -> llbasicblock
538 = "llvm_append_block"
539 external insert_block : llcontext -> string -> llbasicblock -> llbasicblock
540 = "llvm_insert_block"
541 external block_begin : llvalue -> (llvalue, llbasicblock) llpos
543 external block_succ : llbasicblock -> (llvalue, llbasicblock) llpos
545 external block_end : llvalue -> (llvalue, llbasicblock) llrev_pos
547 external block_pred : llbasicblock -> (llvalue, llbasicblock) llrev_pos
550 let rec iter_block_range f i e =
551 if i = e then () else
553 | At_end _ -> raise (Invalid_argument "Invalid block range.")
556 iter_block_range f (block_succ bb) e
558 let iter_blocks f fn =
559 iter_block_range f (block_begin fn) (At_end fn)
561 let rec fold_left_block_range f init i e =
562 if i = e then init else
564 | At_end _ -> raise (Invalid_argument "Invalid block range.")
565 | Before bb -> fold_left_block_range f (f init bb) (block_succ bb) e
567 let fold_left_blocks f init fn =
568 fold_left_block_range f init (block_begin fn) (At_end fn)
570 let rec rev_iter_block_range f i e =
571 if i = e then () else
573 | At_start _ -> raise (Invalid_argument "Invalid block range.")
576 rev_iter_block_range f (block_pred bb) e
578 let rev_iter_blocks f fn =
579 rev_iter_block_range f (block_end fn) (At_start fn)
581 let rec fold_right_block_range f init i e =
582 if i = e then init else
584 | At_start _ -> raise (Invalid_argument "Invalid block range.")
585 | After bb -> fold_right_block_range f (f bb init) (block_pred bb) e
587 let fold_right_blocks f fn init =
588 fold_right_block_range f init (block_end fn) (At_start fn)
590 (*--... Operations on instructions .........................................--*)
591 external instr_parent : llvalue -> llbasicblock = "LLVMGetInstructionParent"
592 external instr_begin : llbasicblock -> (llbasicblock, llvalue) llpos
594 external instr_succ : llvalue -> (llbasicblock, llvalue) llpos
596 external instr_end : llbasicblock -> (llbasicblock, llvalue) llrev_pos
598 external instr_pred : llvalue -> (llbasicblock, llvalue) llrev_pos
601 let rec iter_instrs_range f i e =
602 if i = e then () else
604 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
607 iter_instrs_range f (instr_succ i) e
609 let iter_instrs f bb =
610 iter_instrs_range f (instr_begin bb) (At_end bb)
612 let rec fold_left_instrs_range f init i e =
613 if i = e then init else
615 | At_end _ -> raise (Invalid_argument "Invalid instruction range.")
616 | Before i -> fold_left_instrs_range f (f init i) (instr_succ i) e
618 let fold_left_instrs f init bb =
619 fold_left_instrs_range f init (instr_begin bb) (At_end bb)
621 let rec rev_iter_instrs_range f i e =
622 if i = e then () else
624 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
627 rev_iter_instrs_range f (instr_pred i) e
629 let rev_iter_instrs f bb =
630 rev_iter_instrs_range f (instr_end bb) (At_start bb)
632 let rec fold_right_instr_range f i e init =
633 if i = e then init else
635 | At_start _ -> raise (Invalid_argument "Invalid instruction range.")
636 | After i -> fold_right_instr_range f (instr_pred i) e (f i init)
638 let fold_right_instrs f bb init =
639 fold_right_instr_range f (instr_end bb) (At_start bb) init
642 (*--... Operations on call sites ...........................................--*)
643 external instruction_call_conv: llvalue -> int
644 = "llvm_instruction_call_conv"
645 external set_instruction_call_conv: int -> llvalue -> unit
646 = "llvm_set_instruction_call_conv"
647 external add_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
648 = "llvm_add_instruction_param_attr"
649 external remove_instruction_param_attr : llvalue -> int -> Attribute.t -> unit
650 = "llvm_remove_instruction_param_attr"
652 (*--... Operations on call instructions (only) .............................--*)
653 external is_tail_call : llvalue -> bool = "llvm_is_tail_call"
654 external set_tail_call : bool -> llvalue -> unit = "llvm_set_tail_call"
656 (*--... Operations on phi nodes ............................................--*)
657 external add_incoming : (llvalue * llbasicblock) -> llvalue -> unit
658 = "llvm_add_incoming"
659 external incoming : llvalue -> (llvalue * llbasicblock) list = "llvm_incoming"
662 (*===-- Instruction builders ----------------------------------------------===*)
663 external builder : llcontext -> llbuilder = "llvm_builder"
664 external position_builder : (llbasicblock, llvalue) llpos -> llbuilder -> unit
665 = "llvm_position_builder"
666 external insertion_block : llbuilder -> llbasicblock = "llvm_insertion_block"
667 external insert_into_builder : llvalue -> string -> llbuilder -> unit
668 = "llvm_insert_into_builder"
670 let builder_at context ip =
671 let b = builder context in
672 position_builder ip b;
675 let builder_before context i = builder_at context (Before i)
676 let builder_at_end context bb = builder_at context (At_end bb)
678 let position_before i = position_builder (Before i)
679 let position_at_end bb = position_builder (At_end bb)
682 (*--... Terminators ........................................................--*)
683 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
684 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
685 external build_aggregate_ret : llvalue array -> llbuilder -> llvalue
686 = "llvm_build_aggregate_ret"
687 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
688 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
689 llvalue = "llvm_build_cond_br"
690 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
691 = "llvm_build_switch"
692 external add_case : llvalue -> llvalue -> llbasicblock -> unit
694 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
695 llbasicblock -> string -> llbuilder -> llvalue
696 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
697 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
698 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
700 (*--... Arithmetic .........................................................--*)
701 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
703 external build_nsw_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
704 = "llvm_build_nsw_add"
705 external build_fadd : llvalue -> llvalue -> string -> llbuilder -> llvalue
707 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
709 external build_fsub : llvalue -> llvalue -> string -> llbuilder -> llvalue
711 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
713 external build_fmul : llvalue -> llvalue -> string -> llbuilder -> llvalue
715 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
717 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
719 external build_exact_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
720 = "llvm_build_exact_sdiv"
721 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
723 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
725 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
727 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
729 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
731 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
733 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
735 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
737 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
739 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
741 external build_neg : llvalue -> string -> llbuilder -> llvalue
743 external build_not : llvalue -> string -> llbuilder -> llvalue
746 (*--... Memory .............................................................--*)
747 external build_malloc : lltype -> string -> llbuilder -> llvalue
748 = "llvm_build_malloc"
749 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
750 llvalue = "llvm_build_array_malloc"
751 external build_alloca : lltype -> string -> llbuilder -> llvalue
752 = "llvm_build_alloca"
753 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
754 llvalue = "llvm_build_array_alloca"
755 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
756 external build_load : llvalue -> string -> llbuilder -> llvalue
758 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
760 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
762 external build_in_bounds_gep : llvalue -> llvalue array -> string ->
763 llbuilder -> llvalue = "llvm_build_in_bounds_gep"
764 external build_struct_gep : llvalue -> int -> string -> llbuilder -> llvalue
765 = "llvm_build_struct_gep"
767 external build_global_string : string -> string -> llbuilder -> llvalue
768 = "llvm_build_global_string"
769 external build_global_stringptr : string -> string -> llbuilder -> llvalue
770 = "llvm_build_global_stringptr"
772 (*--... Casts ..............................................................--*)
773 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
775 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
777 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
779 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
780 = "llvm_build_fptoui"
781 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
782 = "llvm_build_fptosi"
783 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
784 = "llvm_build_uitofp"
785 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
786 = "llvm_build_sitofp"
787 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
788 = "llvm_build_fptrunc"
789 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
791 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
792 = "llvm_build_prttoint"
793 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
794 = "llvm_build_inttoptr"
795 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
796 = "llvm_build_bitcast"
797 external build_zext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
798 llvalue = "llvm_build_zext_or_bitcast"
799 external build_sext_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
800 llvalue = "llvm_build_sext_or_bitcast"
801 external build_trunc_or_bitcast : llvalue -> lltype -> string -> llbuilder ->
802 llvalue = "llvm_build_trunc_or_bitcast"
803 external build_pointercast : llvalue -> lltype -> string -> llbuilder -> llvalue
804 = "llvm_build_pointercast"
805 external build_intcast : llvalue -> lltype -> string -> llbuilder -> llvalue
806 = "llvm_build_intcast"
807 external build_fpcast : llvalue -> lltype -> string -> llbuilder -> llvalue
808 = "llvm_build_fpcast"
810 (*--... Comparisons ........................................................--*)
811 external build_icmp : Icmp.t -> llvalue -> llvalue -> string ->
812 llbuilder -> llvalue = "llvm_build_icmp"
813 external build_fcmp : Fcmp.t -> llvalue -> llvalue -> string ->
814 llbuilder -> llvalue = "llvm_build_fcmp"
816 (*--... Miscellaneous instructions .........................................--*)
817 external build_phi : (llvalue * llbasicblock) list -> string -> llbuilder ->
818 llvalue = "llvm_build_phi"
819 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
821 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
822 llvalue = "llvm_build_select"
823 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
824 = "llvm_build_va_arg"
825 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
826 llvalue = "llvm_build_extractelement"
827 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
828 llbuilder -> llvalue = "llvm_build_insertelement"
829 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
830 llbuilder -> llvalue = "llvm_build_shufflevector"
831 external build_extractvalue : llvalue -> int -> string -> llbuilder -> llvalue
832 = "llvm_build_extractvalue"
833 external build_insertvalue : llvalue -> llvalue -> int -> string -> llbuilder ->
834 llvalue = "llvm_build_insertvalue"
836 external build_is_null : llvalue -> string -> llbuilder -> llvalue
837 = "llvm_build_is_null"
838 external build_is_not_null : llvalue -> string -> llbuilder -> llvalue
839 = "llvm_build_is_not_null"
840 external build_ptrdiff : llvalue -> llvalue -> string -> llbuilder -> llvalue
841 = "llvm_build_ptrdiff"
843 (*===-- Module providers --------------------------------------------------===*)
845 module ModuleProvider = struct
846 external create : llmodule -> llmoduleprovider
847 = "LLVMCreateModuleProviderForExistingModule"
848 external dispose : llmoduleprovider -> unit = "llvm_dispose_module_provider"
852 (*===-- Memory buffers ----------------------------------------------------===*)
854 module MemoryBuffer = struct
855 external of_file : string -> llmemorybuffer = "llvm_memorybuffer_of_file"
856 external of_stdin : unit -> llmemorybuffer = "llvm_memorybuffer_of_stdin"
857 external dispose : llmemorybuffer -> unit = "llvm_memorybuffer_dispose"
861 (*===-- Pass Manager ------------------------------------------------------===*)
863 module PassManager = struct
865 type any = [ `Module | `Function ]
866 external create : unit -> [ `Module ] t = "llvm_passmanager_create"
867 external create_function : llmoduleprovider -> [ `Function ] t
868 = "LLVMCreateFunctionPassManager"
869 external run_module : llmodule -> [ `Module ] t -> bool
870 = "llvm_passmanager_run_module"
871 external initialize : [ `Function ] t -> bool = "llvm_passmanager_initialize"
872 external run_function : llvalue -> [ `Function ] t -> bool
873 = "llvm_passmanager_run_function"
874 external finalize : [ `Function ] t -> bool = "llvm_passmanager_finalize"
875 external dispose : [< any ] t -> unit = "llvm_passmanager_dispose"
879 (*===-- Non-Externs -------------------------------------------------------===*)
880 (* These functions are built using the externals, so must be declared late. *)
882 let concat2 sep arr =
884 if 0 < Array.length arr then begin
886 for i = 1 to (Array.length arr) - 1 do
887 s := !s ^ sep ^ arr.(i)
892 let rec string_of_lltype ty =
893 (* FIXME: stop infinite recursion! :) *)
894 match classify_type ty with
895 TypeKind.Integer -> "i" ^ string_of_int (integer_bitwidth ty)
896 | TypeKind.Pointer -> (string_of_lltype (element_type ty)) ^ "*"
898 let s = "{ " ^ (concat2 ", " (
899 Array.map string_of_lltype (element_types ty)
904 | TypeKind.Array -> "[" ^ (string_of_int (array_length ty)) ^
905 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
906 | TypeKind.Vector -> "<" ^ (string_of_int (vector_size ty)) ^
907 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
908 | TypeKind.Opaque -> "opaque"
909 | TypeKind.Function -> string_of_lltype (return_type ty) ^
910 " (" ^ (concat2 ", " (
911 Array.map string_of_lltype (param_types ty)
913 | TypeKind.Label -> "label"
914 | TypeKind.Ppc_fp128 -> "ppc_fp128"
915 | TypeKind.Fp128 -> "fp128"
916 | TypeKind.X86fp80 -> "x86_fp80"
917 | TypeKind.Double -> "double"
918 | TypeKind.Float -> "float"
919 | TypeKind.Void -> "void"
920 | TypeKind.Metadata -> "metadata"