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 val x86_stdcallcc : int
60 val x86_fastcallcc : int
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 -------------------------------------------------------------===*)
113 external classify_type : lltype -> type_kind = "llvm_classify_type"
114 external refine_abstract_type : lltype -> lltype -> unit
115 = "llvm_refine_abstract_type"
116 val string_of_lltype : lltype -> string
118 (*--... Operations on integer types ........................................--*)
121 val i16_type : lltype
122 val i32_type : lltype
123 val i64_type : lltype
124 external make_integer_type : int -> lltype = "llvm_make_integer_type"
125 external integer_bitwidth : lltype -> int = "llvm_integer_bitwidth"
127 (*--... Operations on real types ...........................................--*)
128 val float_type : lltype
129 val double_type : lltype
130 val x86fp80_type : lltype
131 val fp128_type : lltype
132 val ppc_fp128_type : lltype
134 (*--... Operations on function types .......................................--*)
135 (* FIXME: handle parameter attributes *)
136 external make_function_type : lltype -> lltype array -> bool -> lltype
137 = "llvm_make_function_type"
138 external is_var_arg : lltype -> bool = "llvm_is_var_arg"
139 external return_type : lltype -> lltype = "llvm_return_type"
140 external param_types : lltype -> lltype array = "llvm_param_types"
142 (*--... Operations on struct types .........................................--*)
143 external make_struct_type : lltype array -> bool -> lltype
144 = "llvm_make_struct_type"
145 external element_types : lltype -> lltype array = "llvm_element_types"
146 external is_packed : lltype -> bool = "llvm_is_packed"
148 (*--... Operations on pointer, vector, and array types .....................--*)
149 external make_array_type : lltype -> int -> lltype = "llvm_make_array_type"
150 external make_pointer_type : lltype -> lltype = "llvm_make_pointer_type"
151 external make_vector_type : lltype -> int -> lltype = "llvm_make_vector_type"
153 external element_type : lltype -> lltype = "llvm_element_type"
154 external array_length : lltype -> int = "llvm_array_length"
155 external vector_size : lltype -> int = "llvm_vector_size"
157 (*--... Operations on other types ..........................................--*)
158 external make_opaque_type : unit -> lltype = "llvm_make_opaque_type"
159 val void_type : lltype
160 val label_type : lltype
163 (*===-- Values ------------------------------------------------------------===*)
164 external type_of : llvalue -> lltype = "llvm_type_of"
165 external value_name : llvalue -> string = "llvm_value_name"
166 external set_value_name : string -> llvalue -> unit = "llvm_set_value_name"
167 external dump_value : llvalue -> unit = "llvm_dump_value"
169 (*--... Operations on constants of (mostly) any type .......................--*)
170 external is_constant : llvalue -> bool = "llvm_is_constant"
171 external const_null : lltype -> llvalue = "LLVMConstNull"
172 external const_all_ones : (*int|vec*)lltype -> llvalue = "LLVMConstAllOnes"
173 external undef : lltype -> llvalue = "LLVMGetUndef"
174 external is_null : llvalue -> bool = "llvm_is_null"
175 external is_undef : llvalue -> bool = "llvm_is_undef"
177 (*--... Operations on scalar constants .....................................--*)
178 external const_int : lltype -> int -> llvalue = "llvm_const_int"
179 external const_of_int64 : lltype -> Int64.t -> bool -> llvalue
180 = "llvm_const_of_int64"
181 external const_float : lltype -> float -> llvalue = "llvm_const_float"
183 (*--... Operations on composite constants ..................................--*)
184 external const_string : string -> llvalue = "llvm_const_string"
185 external const_stringz : string -> llvalue = "llvm_const_stringz"
186 external const_array : lltype -> llvalue array -> llvalue = "llvm_const_array"
187 external const_struct : llvalue array -> llvalue = "llvm_const_struct"
188 external const_packed_struct : llvalue array -> llvalue
189 = "llvm_const_packed_struct"
190 external const_vector : llvalue array -> llvalue = "llvm_const_vector"
192 (*--... Constant expressions ...............................................--*)
193 external size_of : lltype -> llvalue = "LLVMSizeOf"
194 external const_neg : llvalue -> llvalue = "LLVMConstNeg"
195 external const_not : llvalue -> llvalue = "LLVMConstNot"
196 external const_add : llvalue -> llvalue -> llvalue = "LLVMConstAdd"
197 external const_sub : llvalue -> llvalue -> llvalue = "LLVMConstSub"
198 external const_mul : llvalue -> llvalue -> llvalue = "LLVMConstMul"
199 external const_udiv : llvalue -> llvalue -> llvalue = "LLVMConstUDiv"
200 external const_sdiv : llvalue -> llvalue -> llvalue = "LLVMConstSDiv"
201 external const_fdiv : llvalue -> llvalue -> llvalue = "LLVMConstFDiv"
202 external const_urem : llvalue -> llvalue -> llvalue = "LLVMConstURem"
203 external const_srem : llvalue -> llvalue -> llvalue = "LLVMConstSRem"
204 external const_frem : llvalue -> llvalue -> llvalue = "LLVMConstFRem"
205 external const_and : llvalue -> llvalue -> llvalue = "LLVMConstAnd"
206 external const_or : llvalue -> llvalue -> llvalue = "LLVMConstOr"
207 external const_xor : llvalue -> llvalue -> llvalue = "LLVMConstXor"
208 external const_icmp : int_predicate -> llvalue -> llvalue -> llvalue
210 external const_fcmp : real_predicate -> llvalue -> llvalue -> llvalue
212 external const_shl : llvalue -> llvalue -> llvalue = "LLVMConstShl"
213 external const_lshr : llvalue -> llvalue -> llvalue = "LLVMConstLShr"
214 external const_ashr : llvalue -> llvalue -> llvalue = "LLVMConstAShr"
215 external const_gep : llvalue -> llvalue array -> llvalue = "llvm_const_gep"
216 external const_trunc : llvalue -> lltype -> llvalue = "LLVMConstTrunc"
217 external const_sext : llvalue -> lltype -> llvalue = "LLVMConstSExt"
218 external const_zext : llvalue -> lltype -> llvalue = "LLVMConstZExt"
219 external const_fptrunc : llvalue -> lltype -> llvalue = "LLVMConstFPTrunc"
220 external const_fpext : llvalue -> lltype -> llvalue = "LLVMConstFPExt"
221 external const_uitofp : llvalue -> lltype -> llvalue = "LLVMConstUIToFP"
222 external const_sitofp : llvalue -> lltype -> llvalue = "LLVMConstSIToFP"
223 external const_fptoui : llvalue -> lltype -> llvalue = "LLVMConstFPToUI"
224 external const_fptosi : llvalue -> lltype -> llvalue = "LLVMConstFPToSI"
225 external const_ptrtoint : llvalue -> lltype -> llvalue = "LLVMConstPtrToInt"
226 external const_inttoptr : llvalue -> lltype -> llvalue = "LLVMConstIntToPtr"
227 external const_bitcast : llvalue -> lltype -> llvalue = "LLVMConstBitCast"
228 external const_select : llvalue -> llvalue -> llvalue -> llvalue
230 external const_extractelement : llvalue -> llvalue -> llvalue
231 = "LLVMConstExtractElement"
232 external const_insertelement : llvalue -> llvalue -> llvalue -> llvalue
233 = "LLVMConstInsertElement"
234 external const_shufflevector : llvalue -> llvalue -> llvalue -> llvalue
235 = "LLVMConstShuffleVector"
237 (*--... Operations on global variables, functions, and aliases (globals) ...--*)
238 external is_declaration : llvalue -> bool = "llvm_is_declaration"
239 external linkage : llvalue -> linkage = "llvm_linkage"
240 external set_linkage : linkage -> llvalue -> unit = "llvm_set_linkage"
241 external section : llvalue -> string = "llvm_section"
242 external set_section : string -> llvalue -> unit = "llvm_set_section"
243 external visibility : llvalue -> visibility = "llvm_visibility"
244 external set_visibility : visibility -> llvalue -> unit = "llvm_set_visibility"
245 external alignment : llvalue -> int = "llvm_alignment"
246 external set_alignment : int -> llvalue -> unit = "llvm_set_alignment"
248 (*--... Operations on global variables .....................................--*)
249 external declare_global : lltype -> string -> llmodule -> llvalue
250 = "llvm_declare_global"
251 external define_global : string -> llvalue -> llmodule -> llvalue
252 = "llvm_define_global"
253 external delete_global : llvalue -> unit = "llvm_delete_global"
254 external global_initializer : llvalue -> llvalue = "LLVMGetInitializer"
255 external set_initializer : llvalue -> llvalue -> unit = "llvm_set_initializer"
256 external remove_initializer : llvalue -> unit = "llvm_remove_initializer"
257 external is_thread_local : llvalue -> bool = "llvm_is_thread_local"
258 external set_thread_local : bool -> llvalue -> unit = "llvm_set_thread_local"
260 (*--... Operations on functions ............................................--*)
261 external declare_function : string -> lltype -> llmodule -> llvalue
262 = "llvm_declare_function"
263 external define_function : string -> lltype -> llmodule -> llvalue
264 = "llvm_define_function"
265 external delete_function : llvalue -> unit = "llvm_delete_function"
266 external params : llvalue -> llvalue array = "llvm_params"
267 external param : llvalue -> int -> llvalue = "llvm_param"
268 external is_intrinsic : llvalue -> bool = "llvm_is_intrinsic"
269 external function_call_conv : llvalue -> int = "llvm_function_call_conv"
270 external set_function_call_conv : int -> llvalue -> unit
271 = "llvm_set_function_call_conv"
273 (*--... Operations on basic blocks .........................................--*)
274 external basic_blocks : llvalue -> llbasicblock array = "llvm_basic_blocks"
275 external entry_block : llvalue -> llbasicblock = "LLVMGetEntryBasicBlock"
276 external delete_block : llbasicblock -> unit = "llvm_delete_block"
277 external append_block : string -> llvalue -> llbasicblock = "llvm_append_block"
278 external insert_block : string -> llbasicblock -> llbasicblock
279 = "llvm_insert_block"
280 external value_of_block : llbasicblock -> llvalue = "LLVMBasicBlockAsValue"
281 external value_is_block : llvalue -> bool = "llvm_value_is_block"
282 external block_of_value : llvalue -> llbasicblock = "LLVMValueAsBasicBlock"
285 (*===-- Instruction builders ----------------------------------------------===*)
286 external builder_before : llvalue -> llbuilder = "llvm_builder_before"
287 external builder_at_end : llbasicblock -> llbuilder = "llvm_builder_at_end"
288 external position_before : llvalue -> llbuilder -> unit = "llvm_position_before"
289 external position_at_end : llbasicblock -> llbuilder -> unit
290 = "llvm_position_at_end"
292 (*--... Terminators ........................................................--*)
293 external build_ret_void : llbuilder -> llvalue = "llvm_build_ret_void"
294 external build_ret : llvalue -> llbuilder -> llvalue = "llvm_build_ret"
295 external build_br : llbasicblock -> llbuilder -> llvalue = "llvm_build_br"
296 external build_cond_br : llvalue -> llbasicblock -> llbasicblock -> llbuilder ->
297 llvalue = "llvm_build_cond_br"
298 external build_switch : llvalue -> llbasicblock -> int -> llbuilder -> llvalue
299 = "llvm_build_switch"
300 external build_invoke : llvalue -> llvalue array -> llbasicblock ->
301 llbasicblock -> string -> llbuilder -> llvalue
302 = "llvm_build_invoke_bc" "llvm_build_invoke_nat"
303 external build_unwind : llbuilder -> llvalue = "llvm_build_unwind"
304 external build_unreachable : llbuilder -> llvalue = "llvm_build_unreachable"
306 (*--... Arithmetic .........................................................--*)
307 external build_add : llvalue -> llvalue -> string -> llbuilder -> llvalue
309 external build_sub : llvalue -> llvalue -> string -> llbuilder -> llvalue
311 external build_mul : llvalue -> llvalue -> string -> llbuilder -> llvalue
313 external build_udiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
315 external build_sdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
317 external build_fdiv : llvalue -> llvalue -> string -> llbuilder -> llvalue
319 external build_urem : llvalue -> llvalue -> string -> llbuilder -> llvalue
321 external build_srem : llvalue -> llvalue -> string -> llbuilder -> llvalue
323 external build_frem : llvalue -> llvalue -> string -> llbuilder -> llvalue
325 external build_shl : llvalue -> llvalue -> string -> llbuilder -> llvalue
327 external build_lshr : llvalue -> llvalue -> string -> llbuilder -> llvalue
329 external build_ashr : llvalue -> llvalue -> string -> llbuilder -> llvalue
331 external build_and : llvalue -> llvalue -> string -> llbuilder -> llvalue
333 external build_or : llvalue -> llvalue -> string -> llbuilder -> llvalue
335 external build_xor : llvalue -> llvalue -> string -> llbuilder -> llvalue
337 external build_neg : llvalue -> string -> llbuilder -> llvalue
339 external build_not : llvalue -> string -> llbuilder -> llvalue
342 (*--... Memory .............................................................--*)
343 external build_malloc : lltype -> string -> llbuilder -> llvalue
344 = "llvm_build_malloc"
345 external build_array_malloc : lltype -> llvalue -> string -> llbuilder ->
346 llvalue = "llvm_build_array_malloc"
347 external build_alloca : lltype -> string -> llbuilder -> llvalue
348 = "llvm_build_alloca"
349 external build_array_alloca : lltype -> llvalue -> string -> llbuilder ->
350 llvalue = "llvm_build_array_alloca"
351 external build_free : llvalue -> llbuilder -> llvalue = "llvm_build_free"
352 external build_load : llvalue -> string -> llbuilder -> llvalue
354 external build_store : llvalue -> llvalue -> llbuilder -> llvalue
356 external build_gep : llvalue -> llvalue array -> string -> llbuilder -> llvalue
359 (*--... Casts ..............................................................--*)
360 external build_trunc : llvalue -> lltype -> string -> llbuilder -> llvalue
362 external build_zext : llvalue -> lltype -> string -> llbuilder -> llvalue
364 external build_sext : llvalue -> lltype -> string -> llbuilder -> llvalue
366 external build_fptoui : llvalue -> lltype -> string -> llbuilder -> llvalue
367 = "llvm_build_fptoui"
368 external build_fptosi : llvalue -> lltype -> string -> llbuilder -> llvalue
369 = "llvm_build_fptosi"
370 external build_uitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
371 = "llvm_build_uitofp"
372 external build_sitofp : llvalue -> lltype -> string -> llbuilder -> llvalue
373 = "llvm_build_sitofp"
374 external build_fptrunc : llvalue -> lltype -> string -> llbuilder -> llvalue
375 = "llvm_build_fptrunc"
376 external build_fpext : llvalue -> lltype -> string -> llbuilder -> llvalue
378 external build_ptrtoint : llvalue -> lltype -> string -> llbuilder -> llvalue
379 = "llvm_build_prttoint"
380 external build_inttoptr : llvalue -> lltype -> string -> llbuilder -> llvalue
381 = "llvm_build_inttoptr"
382 external build_bitcast : llvalue -> lltype -> string -> llbuilder -> llvalue
383 = "llvm_build_bitcast"
385 (*--... Comparisons ........................................................--*)
386 external build_icmp : int_predicate -> llvalue -> llvalue -> string ->
387 llbuilder -> llvalue = "llvm_build_icmp"
388 external build_fcmp : real_predicate -> llvalue -> llvalue -> string ->
389 llbuilder -> llvalue = "llvm_build_fcmp"
391 (*--... Miscellaneous instructions .........................................--*)
392 external build_phi : lltype -> string -> llbuilder -> llvalue = "llvm_build_phi"
393 external build_call : llvalue -> llvalue array -> string -> llbuilder -> llvalue
395 external build_select : llvalue -> llvalue -> llvalue -> string -> llbuilder ->
396 llvalue = "llvm_build_select"
397 external build_va_arg : llvalue -> lltype -> string -> llbuilder -> llvalue
398 = "llvm_build_va_arg"
399 external build_extractelement : llvalue -> llvalue -> string -> llbuilder ->
400 llvalue = "llvm_build_extractelement"
401 external build_insertelement : llvalue -> llvalue -> llvalue -> string ->
402 llbuilder -> llvalue = "llvm_build_insertelement"
403 external build_shufflevector : llvalue -> llvalue -> llvalue -> string ->
404 llbuilder -> llvalue = "llvm_build_shufflevector"