1 //===- Intrinsics.td - Defines all LLVM intrinsics ---------*- tablegen -*-===//
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 //===----------------------------------------------------------------------===//
10 // This file defines properties of all LLVM intrinsics.
12 //===----------------------------------------------------------------------===//
14 include "llvm/CodeGen/ValueTypes.td"
16 //===----------------------------------------------------------------------===//
17 // Properties we keep track of for intrinsics.
18 //===----------------------------------------------------------------------===//
20 class IntrinsicProperty;
22 // Intr*Mem - Memory properties. An intrinsic is allowed to have exactly one of
23 // these properties set. They are listed from the most aggressive (best to use
24 // if correct) to the least aggressive. If no property is set, the worst case
25 // is assumed (IntrWriteMem).
27 // IntrNoMem - The intrinsic does not access memory or have any other side
28 // effects. It may be CSE'd deleted if dead, etc.
29 def IntrNoMem : IntrinsicProperty;
31 // IntrReadArgMem - This intrinsic reads only from memory that one of its
32 // arguments points to, but may read an unspecified amount.
33 def IntrReadArgMem : IntrinsicProperty;
35 // IntrReadMem - This intrinsic reads from unspecified memory, so it cannot be
36 // moved across stores. However, it can be reordered otherwise and can be
38 def IntrReadMem : IntrinsicProperty;
40 // IntrWriteArgMem - This intrinsic reads and writes only from memory that one
41 // of its arguments points to, but may access an unspecified amount. The reads
42 // and writes may be volatile, but except for this it has no other side effects.
43 def IntrWriteArgMem : IntrinsicProperty;
45 // IntrWriteMem - This intrinsic may read or modify unspecified memory or has
46 // other side effects. It cannot be modified by the optimizer. This is the
47 // default if the intrinsic has no other Intr*Mem property.
48 def IntrWriteMem : IntrinsicProperty;
50 // Commutative - This intrinsic is commutative: X op Y == Y op X.
51 def Commutative : IntrinsicProperty;
53 // NoCapture - The specified argument pointer is not captured by the intrinsic.
54 class NoCapture<int argNo> : IntrinsicProperty {
58 //===----------------------------------------------------------------------===//
59 // Types used by intrinsics.
60 //===----------------------------------------------------------------------===//
62 class LLVMType<ValueType vt> {
66 class LLVMPointerType<LLVMType elty>
71 class LLVMAnyPointerType<LLVMType elty>
76 // Match the type of another intrinsic parameter. Number is an index into the
77 // list of overloaded types for the intrinsic, excluding all the fixed types.
78 // The Number value must refer to a previously listed type. For example:
79 // Intrinsic<[llvm_i32_ty], [llvm_i32_ty, llvm_anyfloat_ty, LLVMMatchType<0>]>
80 // has two overloaded types, the 2nd and 3rd arguments. LLVMMatchType<0>
81 // refers to the first overloaded type, which is the 2nd argument.
82 class LLVMMatchType<int num>
87 // Match the type of another intrinsic parameter that is expected to be
88 // an integral vector type, but change the element size to be twice as wide
89 // or half as wide as the other type. This is only useful when the intrinsic
90 // is overloaded, so the matched type should be declared as iAny.
91 class LLVMExtendedElementVectorType<int num> : LLVMMatchType<num>;
92 class LLVMTruncatedElementVectorType<int num> : LLVMMatchType<num>;
94 def llvm_void_ty : LLVMType<isVoid>;
95 def llvm_anyint_ty : LLVMType<iAny>;
96 def llvm_anyfloat_ty : LLVMType<fAny>;
97 def llvm_i1_ty : LLVMType<i1>;
98 def llvm_i8_ty : LLVMType<i8>;
99 def llvm_i16_ty : LLVMType<i16>;
100 def llvm_i32_ty : LLVMType<i32>;
101 def llvm_i64_ty : LLVMType<i64>;
102 def llvm_float_ty : LLVMType<f32>;
103 def llvm_double_ty : LLVMType<f64>;
104 def llvm_f80_ty : LLVMType<f80>;
105 def llvm_f128_ty : LLVMType<f128>;
106 def llvm_ppcf128_ty : LLVMType<ppcf128>;
107 def llvm_ptr_ty : LLVMPointerType<llvm_i8_ty>; // i8*
108 def llvm_ptrptr_ty : LLVMPointerType<llvm_ptr_ty>; // i8**
109 def llvm_anyptr_ty : LLVMAnyPointerType<llvm_i8_ty>; // (space)i8*
110 def llvm_empty_ty : LLVMType<OtherVT>; // { }
111 def llvm_descriptor_ty : LLVMPointerType<llvm_empty_ty>; // { }*
113 def llvm_v2i8_ty : LLVMType<v2i8>; // 2 x i8
114 def llvm_v4i8_ty : LLVMType<v4i8>; // 4 x i8
115 def llvm_v8i8_ty : LLVMType<v8i8>; // 8 x i8
116 def llvm_v16i8_ty : LLVMType<v16i8>; // 16 x i8
117 def llvm_v32i8_ty : LLVMType<v32i8>; // 32 x i8
118 def llvm_v2i16_ty : LLVMType<v2i16>; // 4 x i16
119 def llvm_v4i16_ty : LLVMType<v4i16>; // 4 x i16
120 def llvm_v8i16_ty : LLVMType<v8i16>; // 8 x i16
121 def llvm_v16i16_ty : LLVMType<v16i16>; // 16 x i16
122 def llvm_v2i32_ty : LLVMType<v2i32>; // 2 x i32
123 def llvm_v4i32_ty : LLVMType<v4i32>; // 4 x i32
124 def llvm_v8i32_ty : LLVMType<v8i32>; // 8 x i32
125 def llvm_v1i64_ty : LLVMType<v1i64>; // 1 x i64
126 def llvm_v2i64_ty : LLVMType<v2i64>; // 2 x i64
127 def llvm_v4i64_ty : LLVMType<v4i64>; // 4 x i64
129 def llvm_v2f32_ty : LLVMType<v2f32>; // 2 x float
130 def llvm_v3f32_ty : LLVMType<v3f32>; // 3 x float
131 def llvm_v4f32_ty : LLVMType<v4f32>; // 4 x float
132 def llvm_v8f32_ty : LLVMType<v8f32>; // 8 x float
133 def llvm_v2f64_ty : LLVMType<v2f64>; // 2 x double
134 def llvm_v4f64_ty : LLVMType<v4f64>; // 4 x double
136 def llvm_vararg_ty : LLVMType<isVoid>; // this means vararg here
139 //===----------------------------------------------------------------------===//
140 // Intrinsic Definitions.
141 //===----------------------------------------------------------------------===//
143 // Intrinsic class - This is used to define one LLVM intrinsic. The name of the
144 // intrinsic definition should start with "int_", then match the LLVM intrinsic
145 // name with the "llvm." prefix removed, and all "."s turned into "_"s. For
146 // example, llvm.bswap.i16 -> int_bswap_i16.
148 // * RetTypes is a list containing the return types expected for the
150 // * ParamTypes is a list containing the parameter types expected for the
152 // * Properties can be set to describe the behavior of the intrinsic.
154 class Intrinsic<list<LLVMType> ret_types,
155 list<LLVMType> param_types = [],
156 list<IntrinsicProperty> properties = [],
158 string LLVMName = name;
159 string TargetPrefix = ""; // Set to a prefix for target-specific intrinsics.
160 list<LLVMType> RetTypes = ret_types;
161 list<LLVMType> ParamTypes = param_types;
162 list<IntrinsicProperty> Properties = properties;
167 /// GCCBuiltin - If this intrinsic exactly corresponds to a GCC builtin, this
168 /// specifies the name of the builtin. This provides automatic CBE and CFE
170 class GCCBuiltin<string name> {
171 string GCCBuiltinName = name;
175 //===--------------- Variable Argument Handling Intrinsics ----------------===//
178 def int_vastart : Intrinsic<[llvm_void_ty], [llvm_ptr_ty], [], "llvm.va_start">;
179 def int_vacopy : Intrinsic<[llvm_void_ty], [llvm_ptr_ty, llvm_ptr_ty], [],
181 def int_vaend : Intrinsic<[llvm_void_ty], [llvm_ptr_ty], [], "llvm.va_end">;
183 //===------------------- Garbage Collection Intrinsics --------------------===//
185 def int_gcroot : Intrinsic<[llvm_void_ty],
186 [llvm_ptrptr_ty, llvm_ptr_ty]>;
187 def int_gcread : Intrinsic<[llvm_ptr_ty],
188 [llvm_ptr_ty, llvm_ptrptr_ty],
190 def int_gcwrite : Intrinsic<[llvm_void_ty],
191 [llvm_ptr_ty, llvm_ptr_ty, llvm_ptrptr_ty],
192 [IntrWriteArgMem, NoCapture<1>, NoCapture<2>]>;
194 //===--------------------- Code Generator Intrinsics ----------------------===//
196 def int_returnaddress : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty], [IntrNoMem]>;
197 def int_frameaddress : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty], [IntrNoMem]>;
199 // Note: we treat stacksave/stackrestore as writemem because we don't otherwise
200 // model their dependencies on allocas.
201 def int_stacksave : Intrinsic<[llvm_ptr_ty]>,
202 GCCBuiltin<"__builtin_stack_save">;
203 def int_stackrestore : Intrinsic<[llvm_void_ty], [llvm_ptr_ty]>,
204 GCCBuiltin<"__builtin_stack_restore">;
206 // IntrWriteArgMem is more pessimistic than strictly necessary for prefetch,
207 // however it does conveniently prevent the prefetch from being reordered
208 // with respect to nearby accesses to the same memory.
209 def int_prefetch : Intrinsic<[llvm_void_ty],
210 [llvm_ptr_ty, llvm_i32_ty, llvm_i32_ty],
211 [IntrWriteArgMem, NoCapture<0>]>;
212 def int_pcmarker : Intrinsic<[llvm_void_ty], [llvm_i32_ty]>;
214 def int_readcyclecounter : Intrinsic<[llvm_i64_ty]>;
216 // Stack Protector Intrinsic - The stackprotector intrinsic writes the stack
217 // guard to the correct place on the stack frame.
218 def int_stackprotector : Intrinsic<[llvm_void_ty],
219 [llvm_ptr_ty, llvm_ptrptr_ty],
222 //===------------------- Standard C Library Intrinsics --------------------===//
225 def int_memcpy : Intrinsic<[llvm_void_ty],
226 [llvm_ptr_ty, llvm_ptr_ty, llvm_anyint_ty,
228 [IntrWriteArgMem, NoCapture<0>, NoCapture<1>]>;
229 def int_memmove : Intrinsic<[llvm_void_ty],
230 [llvm_ptr_ty, llvm_ptr_ty, llvm_anyint_ty,
232 [IntrWriteArgMem, NoCapture<0>, NoCapture<1>]>;
233 def int_memset : Intrinsic<[llvm_void_ty],
234 [llvm_ptr_ty, llvm_i8_ty, llvm_anyint_ty,
236 [IntrWriteArgMem, NoCapture<0>]>;
238 // These functions do not actually read memory, but they are sensitive to the
239 // rounding mode. This needs to be modelled separately; in the meantime
240 // declaring them as reading memory is conservatively correct.
241 let Properties = [IntrReadMem] in {
242 def int_sqrt : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
243 def int_powi : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>, llvm_i32_ty]>;
244 def int_sin : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
245 def int_cos : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
246 def int_pow : Intrinsic<[llvm_anyfloat_ty],
247 [LLVMMatchType<0>, LLVMMatchType<0>]>;
248 def int_log : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
249 def int_log10: Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
250 def int_log2 : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
251 def int_exp : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
252 def int_exp2 : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
255 // NOTE: these are internal interfaces.
256 def int_setjmp : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty]>;
257 def int_longjmp : Intrinsic<[llvm_void_ty], [llvm_ptr_ty, llvm_i32_ty]>;
258 def int_sigsetjmp : Intrinsic<[llvm_i32_ty] , [llvm_ptr_ty, llvm_i32_ty]>;
259 def int_siglongjmp : Intrinsic<[llvm_void_ty], [llvm_ptr_ty, llvm_i32_ty]>;
261 //===-------------------- Bit Manipulation Intrinsics ---------------------===//
264 // None of these intrinsics accesses memory at all.
265 let Properties = [IntrNoMem] in {
266 def int_bswap: Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
267 def int_ctpop: Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
268 def int_ctlz : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
269 def int_cttz : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
272 //===------------------------ Debugger Intrinsics -------------------------===//
275 // None of these intrinsics accesses memory at all...but that doesn't mean the
276 // optimizers can change them aggressively. Special handling needed in a few
278 let Properties = [IntrNoMem] in {
279 def int_dbg_stoppoint : Intrinsic<[llvm_void_ty],
280 [llvm_i32_ty, llvm_i32_ty,
281 llvm_descriptor_ty]>;
282 def int_dbg_region_start : Intrinsic<[llvm_void_ty], [llvm_descriptor_ty]>;
283 def int_dbg_region_end : Intrinsic<[llvm_void_ty], [llvm_descriptor_ty]>;
284 def int_dbg_func_start : Intrinsic<[llvm_void_ty], [llvm_descriptor_ty]>;
285 def int_dbg_declare : Intrinsic<[llvm_void_ty],
286 [llvm_descriptor_ty, llvm_descriptor_ty]>;
289 //===------------------ Exception Handling Intrinsics----------------------===//
291 def int_eh_exception : Intrinsic<[llvm_ptr_ty]>;
292 def int_eh_selector_i32 : Intrinsic<[llvm_i32_ty],
293 [llvm_ptr_ty, llvm_ptr_ty, llvm_vararg_ty]>;
294 def int_eh_selector_i64 : Intrinsic<[llvm_i64_ty],
295 [llvm_ptr_ty, llvm_ptr_ty, llvm_vararg_ty]>;
297 def int_eh_typeid_for_i32 : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty]>;
298 def int_eh_typeid_for_i64 : Intrinsic<[llvm_i64_ty], [llvm_ptr_ty]>;
300 def int_eh_return_i32 : Intrinsic<[llvm_void_ty], [llvm_i32_ty, llvm_ptr_ty]>;
301 def int_eh_return_i64 : Intrinsic<[llvm_void_ty], [llvm_i64_ty, llvm_ptr_ty]>;
303 def int_eh_unwind_init: Intrinsic<[llvm_void_ty]>,
304 GCCBuiltin<"__builtin_unwind_init">;
306 def int_eh_dwarf_cfa : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty]>;
308 let Properties = [IntrNoMem] in {
309 def int_eh_sjlj_setjmp : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty]>;
310 def int_eh_sjlj_longjmp : Intrinsic<[llvm_void_ty], [llvm_ptr_ty, llvm_i32_ty]>;
313 //===---------------- Generic Variable Attribute Intrinsics----------------===//
315 def int_var_annotation : Intrinsic<[llvm_void_ty],
316 [llvm_ptr_ty, llvm_ptr_ty,
317 llvm_ptr_ty, llvm_i32_ty],
318 [], "llvm.var.annotation">;
319 def int_ptr_annotation : Intrinsic<[LLVMAnyPointerType<llvm_anyint_ty>],
320 [LLVMMatchType<0>, llvm_ptr_ty, llvm_ptr_ty,
322 [], "llvm.ptr.annotation">;
323 def int_annotation : Intrinsic<[llvm_anyint_ty],
324 [LLVMMatchType<0>, llvm_ptr_ty,
325 llvm_ptr_ty, llvm_i32_ty],
326 [], "llvm.annotation">;
328 //===------------------------ Trampoline Intrinsics -----------------------===//
330 def int_init_trampoline : Intrinsic<[llvm_ptr_ty],
331 [llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty],
333 GCCBuiltin<"__builtin_init_trampoline">;
335 //===------------------------ Overflow Intrinsics -------------------------===//
338 // Expose the carry flag from add operations on two integrals.
339 def int_sadd_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
340 [LLVMMatchType<0>, LLVMMatchType<0>]>;
341 def int_uadd_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
342 [LLVMMatchType<0>, LLVMMatchType<0>]>;
344 def int_ssub_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
345 [LLVMMatchType<0>, LLVMMatchType<0>]>;
346 def int_usub_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
347 [LLVMMatchType<0>, LLVMMatchType<0>]>;
349 def int_smul_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
350 [LLVMMatchType<0>, LLVMMatchType<0>]>;
351 def int_umul_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
352 [LLVMMatchType<0>, LLVMMatchType<0>]>;
354 //===------------------------- Atomic Intrinsics --------------------------===//
356 def int_memory_barrier : Intrinsic<[llvm_void_ty],
357 [llvm_i1_ty, llvm_i1_ty,
358 llvm_i1_ty, llvm_i1_ty, llvm_i1_ty], []>,
359 GCCBuiltin<"__builtin_llvm_memory_barrier">;
361 def int_atomic_cmp_swap : Intrinsic<[llvm_anyint_ty],
362 [LLVMAnyPointerType<LLVMMatchType<0>>,
363 LLVMMatchType<0>, LLVMMatchType<0>],
364 [IntrWriteArgMem, NoCapture<0>]>,
365 GCCBuiltin<"__sync_val_compare_and_swap">;
366 def int_atomic_load_add : Intrinsic<[llvm_anyint_ty],
367 [LLVMAnyPointerType<LLVMMatchType<0>>,
369 [IntrWriteArgMem, NoCapture<0>]>,
370 GCCBuiltin<"__sync_fetch_and_add">;
371 def int_atomic_swap : Intrinsic<[llvm_anyint_ty],
372 [LLVMAnyPointerType<LLVMMatchType<0>>,
374 [IntrWriteArgMem, NoCapture<0>]>,
375 GCCBuiltin<"__sync_lock_test_and_set">;
376 def int_atomic_load_sub : Intrinsic<[llvm_anyint_ty],
377 [LLVMAnyPointerType<LLVMMatchType<0>>,
379 [IntrWriteArgMem, NoCapture<0>]>,
380 GCCBuiltin<"__sync_fetch_and_sub">;
381 def int_atomic_load_and : Intrinsic<[llvm_anyint_ty],
382 [LLVMAnyPointerType<LLVMMatchType<0>>,
384 [IntrWriteArgMem, NoCapture<0>]>,
385 GCCBuiltin<"__sync_fetch_and_and">;
386 def int_atomic_load_or : Intrinsic<[llvm_anyint_ty],
387 [LLVMAnyPointerType<LLVMMatchType<0>>,
389 [IntrWriteArgMem, NoCapture<0>]>,
390 GCCBuiltin<"__sync_fetch_and_or">;
391 def int_atomic_load_xor : Intrinsic<[llvm_anyint_ty],
392 [LLVMAnyPointerType<LLVMMatchType<0>>,
394 [IntrWriteArgMem, NoCapture<0>]>,
395 GCCBuiltin<"__sync_fetch_and_xor">;
396 def int_atomic_load_nand : Intrinsic<[llvm_anyint_ty],
397 [LLVMAnyPointerType<LLVMMatchType<0>>,
399 [IntrWriteArgMem, NoCapture<0>]>,
400 GCCBuiltin<"__sync_fetch_and_nand">;
401 def int_atomic_load_min : Intrinsic<[llvm_anyint_ty],
402 [LLVMAnyPointerType<LLVMMatchType<0>>,
404 [IntrWriteArgMem, NoCapture<0>]>,
405 GCCBuiltin<"__sync_fetch_and_min">;
406 def int_atomic_load_max : Intrinsic<[llvm_anyint_ty],
407 [LLVMAnyPointerType<LLVMMatchType<0>>,
409 [IntrWriteArgMem, NoCapture<0>]>,
410 GCCBuiltin<"__sync_fetch_and_max">;
411 def int_atomic_load_umin : Intrinsic<[llvm_anyint_ty],
412 [LLVMAnyPointerType<LLVMMatchType<0>>,
414 [IntrWriteArgMem, NoCapture<0>]>,
415 GCCBuiltin<"__sync_fetch_and_umin">;
416 def int_atomic_load_umax : Intrinsic<[llvm_anyint_ty],
417 [LLVMAnyPointerType<LLVMMatchType<0>>,
419 [IntrWriteArgMem, NoCapture<0>]>,
420 GCCBuiltin<"__sync_fetch_and_umax">;
422 //===-------------------------- Other Intrinsics --------------------------===//
424 def int_flt_rounds : Intrinsic<[llvm_i32_ty]>,
425 GCCBuiltin<"__builtin_flt_rounds">;
426 def int_trap : Intrinsic<[llvm_void_ty]>,
427 GCCBuiltin<"__builtin_trap">;
429 // These convert intrinsics are to support various conversions between
430 // various types with rounding and saturation. NOTE: avoid using these
431 // intrinsics as they might be removed sometime in the future and
432 // most targets don't support them.
433 def int_convertff : Intrinsic<[llvm_anyfloat_ty],
434 [llvm_anyfloat_ty, llvm_i32_ty, llvm_i32_ty]>;
435 def int_convertfsi : Intrinsic<[llvm_anyfloat_ty],
436 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
437 def int_convertfui : Intrinsic<[llvm_anyfloat_ty],
438 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
439 def int_convertsif : Intrinsic<[llvm_anyint_ty],
440 [llvm_anyfloat_ty, llvm_i32_ty, llvm_i32_ty]>;
441 def int_convertuif : Intrinsic<[llvm_anyint_ty],
442 [llvm_anyfloat_ty, llvm_i32_ty, llvm_i32_ty]>;
443 def int_convertss : Intrinsic<[llvm_anyint_ty],
444 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
445 def int_convertsu : Intrinsic<[llvm_anyint_ty],
446 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
447 def int_convertus : Intrinsic<[llvm_anyint_ty],
448 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
449 def int_convertuu : Intrinsic<[llvm_anyint_ty],
450 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
452 //===----------------------------------------------------------------------===//
453 // Target-specific intrinsics
454 //===----------------------------------------------------------------------===//
456 include "llvm/IntrinsicsPowerPC.td"
457 include "llvm/IntrinsicsX86.td"
458 include "llvm/IntrinsicsARM.td"
459 include "llvm/IntrinsicsCellSPU.td"
460 include "llvm/IntrinsicsAlpha.td"
461 include "llvm/IntrinsicsXCore.td"