1 (*===-- tools/ml/llvm.ml - LLVM Ocaml Interface ---------------------------===*
3 * The LLVM Compiler Infrastructure
5 * This file was developed by Gordon Henriksen and is distributed under the
6 * University of Illinois Open Source License. See LICENSE.TXT for details.
8 *===----------------------------------------------------------------------===
10 * This interface provides an ocaml API for the LLVM intermediate
11 * representation, the classes in the VMCore library.
13 *===----------------------------------------------------------------------===*)
16 (* These abstract types correlate directly to the LLVM VMCore classes. *)
20 type llbasicblock (* These are actually values, but
21 benefit from type checking. *)
48 | External_weak_linkage
54 | Protected_visibility
59 let x86_stdcallcc = 64
60 let x86_fastcallcc = 65
93 (*===-- Modules -----------------------------------------------------------===*)
95 (* Creates a module with the supplied module ID. Modules are not garbage
96 collected; it is mandatory to call dispose_module to free memory. *)
97 external create_module : string -> llmodule = "llvm_create_module"
99 (* Disposes a module. All references to subordinate objects are invalidated;
100 referencing them will invoke undefined behavior. *)
101 external dispose_module : llmodule -> unit = "llvm_dispose_module"
103 (* Adds a named type to the module's symbol table. Returns true if successful.
104 If such a name already exists, then no entry is added and returns false. *)
105 external define_type_name : string -> lltype -> llmodule -> bool
106 = "llvm_add_type_name"
108 external delete_type_name : string -> llmodule -> unit
109 = "llvm_delete_type_name"
112 (*===-- Types -------------------------------------------------------------===*)
114 external classify_type : lltype -> type_kind = "llvm_classify_type"
115 external refine_abstract_type : lltype -> lltype -> unit
116 = "llvm_refine_abstract_type"
118 (*--... Operations on integer types ........................................--*)
119 external _i1_type : unit -> lltype = "llvm_i1_type"
120 external _i8_type : unit -> lltype = "llvm_i8_type"
121 external _i16_type : unit -> lltype = "llvm_i16_type"
122 external _i32_type : unit -> lltype = "llvm_i32_type"
123 external _i64_type : unit -> lltype = "llvm_i64_type"
125 let i1_type = _i1_type ()
126 let i8_type = _i8_type ()
127 let i16_type = _i16_type ()
128 let i32_type = _i32_type ()
129 let i64_type = _i64_type ()
131 external make_integer_type : int -> lltype = "llvm_make_integer_type"
132 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
134 (*--... Operations on real types ...........................................--*)
135 external _float_type : unit -> lltype = "llvm_float_type"
136 external _double_type : unit -> lltype = "llvm_double_type"
137 external _x86fp80_type : unit -> lltype = "llvm_x86fp80_type"
138 external _fp128_type : unit -> lltype = "llvm_fp128_type"
139 external _ppc_fp128_type : unit -> lltype = "llvm_ppc_fp128_type"
141 let float_type = _float_type ()
142 let double_type = _double_type ()
143 let x86fp80_type = _x86fp80_type ()
144 let fp128_type = _fp128_type ()
145 let ppc_fp128_type = _ppc_fp128_type ()
147 (*--... Operations on function types .......................................--*)
148 (* FIXME: handle parameter attributes *)
149 external make_function_type : lltype -> lltype array -> bool -> lltype
150 = "llvm_make_function_type"
151 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
152 external return_type : lltype -> lltype = "llvm_return_type"
153 external param_types : lltype -> lltype array = "llvm_param_types"
155 (*--... Operations on struct types .........................................--*)
156 external make_struct_type : lltype array -> bool -> lltype
157 = "llvm_make_struct_type"
158 external element_types : lltype -> lltype array = "llvm_element_types"
159 external is_packed : lltype -> bool = "llvm_is_packed"
161 (*--... Operations on pointer, vector, and array types .....................--*)
162 external make_array_type : lltype -> int -> lltype = "llvm_make_array_type"
163 external make_pointer_type : lltype -> lltype = "llvm_make_pointer_type"
164 external make_vector_type : lltype -> int -> lltype = "llvm_make_vector_type"
166 external element_type : lltype -> lltype = "llvm_element_type"
167 external array_length : lltype -> int = "llvm_array_length"
168 external vector_size : lltype -> int = "llvm_vector_size"
170 (*--... Operations on other types ..........................................--*)
171 external make_opaque_type : unit -> lltype = "llvm_make_opaque_type"
172 external _void_type : unit -> lltype = "llvm_void_type"
173 external _label_type : unit -> lltype = "llvm_label_type"
175 let void_type = _void_type ()
176 let label_type = _label_type ()
179 (*===-- Values ------------------------------------------------------------===*)
181 external type_of : llvalue -> lltype = "llvm_type_of"
182 external value_name : llvalue -> string = "llvm_value_name"
183 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
184 external dump_value : llvalue -> unit = "llvm_dump_value"
186 (*--... Operations on constants of (mostly) any type .......................--*)
187 external is_constant : llvalue -> bool = "llvm_is_constant"
188 external make_null : lltype -> llvalue = "LLVMGetNull"
189 external make_all_ones : (*int|vec*)lltype -> llvalue = "LLVMGetAllOnes"
190 external make_undef : lltype -> llvalue = "LLVMGetUndef"
191 external is_null : llvalue -> bool = "llvm_is_null"
192 external is_undef : llvalue -> bool = "llvm_is_undef"
194 (*--... Operations on scalar constants .....................................--*)
195 external make_int_constant : lltype -> int -> bool -> llvalue
196 = "llvm_make_int_constant"
197 external make_int64_constant : lltype -> Int64.t -> bool -> llvalue
198 = "llvm_make_int64_constant"
199 external make_real_constant : lltype -> float -> llvalue
200 = "llvm_make_real_constant"
202 (*--... Operations on composite constants ..................................--*)
203 external make_string_constant : string -> bool -> llvalue
204 = "llvm_make_string_constant"
205 external make_array_constant : lltype -> llvalue array -> llvalue
206 = "llvm_make_array_constant"
207 external make_struct_constant : llvalue array -> bool -> llvalue
208 = "llvm_make_struct_constant"
209 external make_vector_constant : llvalue array -> llvalue
210 = "llvm_make_vector_constant"
212 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
213 external is_declaration : llvalue -> bool = "llvm_is_declaration"
214 external linkage : llvalue -> linkage = "llvm_linkage"
215 external set_linkage : linkage -> llvalue -> unit = "llvm_set_linkage"
216 external section : llvalue -> string = "llvm_section"
217 external set_section : string -> llvalue -> unit = "llvm_set_section"
218 external visibility : llvalue -> visibility = "llvm_visibility"
219 external set_visibility : visibility -> llvalue -> unit = "llvm_set_visibility"
220 external alignment : llvalue -> int = "llvm_alignment"
221 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
223 (*--... Operations on global variables .....................................--*)
224 external declare_global : lltype -> string -> llmodule -> llvalue
225 = "llvm_declare_global"
226 external define_global : string -> llvalue -> llmodule -> llvalue
227 = "llvm_define_global"
228 external delete_global : llvalue -> unit = "llvm_delete_global"
229 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
230 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
231 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
232 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
233 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
235 (*--... Operations on functions ............................................--*)
236 external declare_function : string -> lltype -> llmodule -> llvalue
237 = "llvm_declare_function"
238 external define_function : string -> lltype -> llmodule -> llvalue
239 = "llvm_define_function"
240 external delete_function : llvalue -> unit = "llvm_delete_function"
241 external params : llvalue -> llvalue array = "llvm_params"
242 external param : llvalue -> int -> llvalue = "llvm_param"
243 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
244 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
245 external set_function_call_conv : int -> llvalue -> unit
246 = "llvm_set_function_call_conv"
248 (* TODO: param attrs *)
250 (*--... Operations on basic blocks .........................................--*)
251 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
252 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
253 external delete_block : llbasicblock -> unit = "llvm_delete_block"
254 external append_block : string -> llvalue -> llbasicblock = "llvm_append_block"
255 external insert_block : string -> llbasicblock -> llbasicblock
256 = "llvm_insert_block"
257 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
258 external value_is_block : llvalue -> bool = "llvm_value_is_block"
259 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
262 (*===-- Instruction builders ----------------------------------------------===*)
263 external builder_before : llvalue -> llbuilder = "llvm_builder_before"
264 external builder_at_end : llbasicblock -> llbuilder = "llvm_builder_at_end"
265 external position_before : llvalue -> llbuilder -> unit = "llvm_position_before"
266 external position_at_end : llbasicblock -> llbuilder -> unit
267 = "llvm_position_at_end"
269 (*--... Terminators ........................................................--*)
270 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
271 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
272 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
273 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
274 llvalue = "llvm_build_cond_br"
275 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
276 = "llvm_build_switch"
277 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
278 llbasicblock -> string -> llbuilder -> llvalue
279 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
280 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
281 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
283 (*--... Arithmetic .........................................................--*)
284 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
286 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
288 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
290 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
292 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
294 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
296 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
298 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
300 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
302 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
304 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
306 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
308 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
310 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
312 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
314 external build_neg : llvalue -> string -> llbuilder -> llvalue
316 external build_not : llvalue -> string -> llbuilder -> llvalue
319 (*--... Memory .............................................................--*)
320 external build_malloc : lltype -> string -> llbuilder -> llvalue
321 = "llvm_build_malloc"
322 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
323 llvalue = "llvm_build_array_malloc"
324 external build_alloca : lltype -> string -> llbuilder -> llvalue
325 = "llvm_build_alloca"
326 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
327 llvalue = "llvm_build_array_alloca"
328 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
329 external build_load : llvalue -> string -> llbuilder -> llvalue
331 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
333 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
336 (*--... Casts ..............................................................--*)
337 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
339 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
341 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
343 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
344 = "llvm_build_fptoui"
345 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
346 = "llvm_build_fptosi"
347 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
348 = "llvm_build_uitofp"
349 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
350 = "llvm_build_sitofp"
351 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
352 = "llvm_build_fptrunc"
353 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
355 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
356 = "llvm_build_prttoint"
357 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
358 = "llvm_build_inttoptr"
359 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
360 = "llvm_build_bitcast"
362 (*--... Comparisons ........................................................--*)
363 external build_icmp : int_predicate -> llvalue -> llvalue -> string ->
364 llbuilder -> llvalue = "llvm_build_icmp"
365 external build_fcmp : real_predicate -> llvalue -> llvalue -> string ->
366 llbuilder -> llvalue = "llvm_build_fcmp"
368 (*--... Miscellaneous instructions .........................................--*)
369 external build_phi : lltype -> string -> llbuilder -> llvalue = "llvm_build_phi"
370 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
372 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
373 llvalue = "llvm_build_select"
374 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
375 = "llvm_build_va_arg"
376 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
377 llvalue = "llvm_build_extractelement"
378 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
379 llbuilder -> llvalue = "llvm_build_insertelement"
380 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
381 llbuilder -> llvalue = "llvm_build_shufflevector"
384 (*===-- Non-Externs -------------------------------------------------------===*)
385 (* These functions are built using the externals, so must be declared late. *)
387 let concat2 sep arr =
389 if 0 < Array.length arr then begin
391 for i = 1 to (Array.length arr) - 1 do
392 s := !s ^ sep ^ arr.(i)
397 let rec string_of_lltype ty =
398 match classify_type ty with
399 Integer_type -> "i" ^ string_of_int (integer_bitwidth ty)
400 | Pointer_type -> (string_of_lltype (element_type ty)) ^ "*"
402 let s = "{ " ^ (concat2 ", " (
403 Array.map string_of_lltype (element_types ty)
408 | Array_type -> "[" ^ (string_of_int (array_length ty)) ^
409 " x " ^ (string_of_lltype (element_type ty)) ^ "]"
410 | Vector_type -> "<" ^ (string_of_int (vector_size ty)) ^
411 " x " ^ (string_of_lltype (element_type ty)) ^ ">"
412 | Opaque_type -> "opaque"
413 | Function_type -> string_of_lltype (return_type ty) ^
414 " (" ^ (concat2 ", " (
415 Array.map string_of_lltype (param_types ty)
417 | Label_type -> "label"
418 | Ppc_fp128_type -> "ppc_fp128"
419 | Fp128_type -> "fp128"
420 | X86fp80_type -> "x86_fp80"
421 | Double_type -> "double"
422 | Float_type -> "float"
423 | Void_type -> "void"