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 class LLVMMatchType<int num>
81 // Match the type of another intrinsic parameter that is expected to be
82 // an integral vector type, but change the element size to be twice as wide
83 // or half as wide as the other type. This is only useful when the intrinsic
84 // is overloaded, so the matched type should be declared as iAny.
85 class LLVMExtendedElementVectorType<int num> : LLVMMatchType<num>;
86 class LLVMTruncatedElementVectorType<int num> : LLVMMatchType<num>;
88 def llvm_void_ty : LLVMType<isVoid>;
89 def llvm_anyint_ty : LLVMType<iAny>;
90 def llvm_anyfloat_ty : LLVMType<fAny>;
91 def llvm_i1_ty : LLVMType<i1>;
92 def llvm_i8_ty : LLVMType<i8>;
93 def llvm_i16_ty : LLVMType<i16>;
94 def llvm_i32_ty : LLVMType<i32>;
95 def llvm_i64_ty : LLVMType<i64>;
96 def llvm_float_ty : LLVMType<f32>;
97 def llvm_double_ty : LLVMType<f64>;
98 def llvm_f80_ty : LLVMType<f80>;
99 def llvm_f128_ty : LLVMType<f128>;
100 def llvm_ppcf128_ty : LLVMType<ppcf128>;
101 def llvm_ptr_ty : LLVMPointerType<llvm_i8_ty>; // i8*
102 def llvm_ptrptr_ty : LLVMPointerType<llvm_ptr_ty>; // i8**
103 def llvm_anyptr_ty : LLVMAnyPointerType<llvm_i8_ty>; // (space)i8*
104 def llvm_empty_ty : LLVMType<OtherVT>; // { }
105 def llvm_descriptor_ty : LLVMPointerType<llvm_empty_ty>; // { }*
107 def llvm_v16i8_ty : LLVMType<v16i8>; // 16 x i8
108 def llvm_v8i16_ty : LLVMType<v8i16>; // 8 x i16
109 def llvm_v2i64_ty : LLVMType<v2i64>; // 2 x i64
110 def llvm_v2i32_ty : LLVMType<v2i32>; // 2 x i32
111 def llvm_v1i64_ty : LLVMType<v1i64>; // 1 x i64
112 def llvm_v4i32_ty : LLVMType<v4i32>; // 4 x i32
113 def llvm_v4f32_ty : LLVMType<v4f32>; // 4 x float
114 def llvm_v2f64_ty : LLVMType<v2f64>; // 2 x double
117 def llvm_v8i8_ty : LLVMType<v8i8>; // 8 x i8
118 def llvm_v4i16_ty : LLVMType<v4i16>; // 4 x i16
120 def llvm_vararg_ty : LLVMType<isVoid>; // this means vararg here
122 //===----------------------------------------------------------------------===//
123 // Intrinsic Definitions.
124 //===----------------------------------------------------------------------===//
126 // Intrinsic class - This is used to define one LLVM intrinsic. The name of the
127 // intrinsic definition should start with "int_", then match the LLVM intrinsic
128 // name with the "llvm." prefix removed, and all "."s turned into "_"s. For
129 // example, llvm.bswap.i16 -> int_bswap_i16.
131 // * RetTypes is a list containing the return types expected for the
133 // * ParamTypes is a list containing the parameter types expected for the
135 // * Properties can be set to describe the behavior of the intrinsic.
137 class Intrinsic<list<LLVMType> ret_types,
138 list<LLVMType> param_types = [],
139 list<IntrinsicProperty> properties = [],
141 string LLVMName = name;
142 string TargetPrefix = ""; // Set to a prefix for target-specific intrinsics.
143 list<LLVMType> RetTypes = ret_types;
144 list<LLVMType> ParamTypes = param_types;
145 list<IntrinsicProperty> Properties = properties;
150 /// GCCBuiltin - If this intrinsic exactly corresponds to a GCC builtin, this
151 /// specifies the name of the builtin. This provides automatic CBE and CFE
153 class GCCBuiltin<string name> {
154 string GCCBuiltinName = name;
158 //===--------------- Variable Argument Handling Intrinsics ----------------===//
161 def int_vastart : Intrinsic<[llvm_void_ty], [llvm_ptr_ty], [], "llvm.va_start">;
162 def int_vacopy : Intrinsic<[llvm_void_ty], [llvm_ptr_ty, llvm_ptr_ty], [],
164 def int_vaend : Intrinsic<[llvm_void_ty], [llvm_ptr_ty], [], "llvm.va_end">;
166 //===------------------- Garbage Collection Intrinsics --------------------===//
168 def int_gcroot : Intrinsic<[llvm_void_ty],
169 [llvm_ptrptr_ty, llvm_ptr_ty]>;
170 def int_gcread : Intrinsic<[llvm_ptr_ty],
171 [llvm_ptr_ty, llvm_ptrptr_ty],
173 def int_gcwrite : Intrinsic<[llvm_void_ty],
174 [llvm_ptr_ty, llvm_ptr_ty, llvm_ptrptr_ty],
175 [IntrWriteArgMem, NoCapture<1>, NoCapture<2>]>;
177 //===--------------------- Code Generator Intrinsics ----------------------===//
179 def int_returnaddress : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty], [IntrNoMem]>;
180 def int_frameaddress : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty], [IntrNoMem]>;
182 // Note: we treat stacksave/stackrestore as writemem because we don't otherwise
183 // model their dependencies on allocas.
184 def int_stacksave : Intrinsic<[llvm_ptr_ty]>,
185 GCCBuiltin<"__builtin_stack_save">;
186 def int_stackrestore : Intrinsic<[llvm_void_ty], [llvm_ptr_ty]>,
187 GCCBuiltin<"__builtin_stack_restore">;
189 // IntrWriteArgMem is more pessimistic than strictly necessary for prefetch,
190 // however it does conveniently prevent the prefetch from being reordered
191 // with respect to nearby accesses to the same memory.
192 def int_prefetch : Intrinsic<[llvm_void_ty],
193 [llvm_ptr_ty, llvm_i32_ty, llvm_i32_ty],
194 [IntrWriteArgMem, NoCapture<0>]>;
195 def int_pcmarker : Intrinsic<[llvm_void_ty], [llvm_i32_ty]>;
197 def int_readcyclecounter : Intrinsic<[llvm_i64_ty]>;
199 // Stack Protector Intrinsic - The stackprotector intrinsic writes the stack
200 // guard to the correct place on the stack frame.
201 def int_stackprotector : Intrinsic<[llvm_void_ty],
202 [llvm_ptr_ty, llvm_ptrptr_ty],
205 //===------------------- Standard C Library Intrinsics --------------------===//
208 def int_memcpy : Intrinsic<[llvm_void_ty],
209 [llvm_ptr_ty, llvm_ptr_ty, llvm_anyint_ty,
211 [IntrWriteArgMem, NoCapture<0>, NoCapture<1>]>;
212 def int_memmove : Intrinsic<[llvm_void_ty],
213 [llvm_ptr_ty, llvm_ptr_ty, llvm_anyint_ty,
215 [IntrWriteArgMem, NoCapture<0>, NoCapture<1>]>;
216 def int_memset : Intrinsic<[llvm_void_ty],
217 [llvm_ptr_ty, llvm_i8_ty, llvm_anyint_ty,
219 [IntrWriteArgMem, NoCapture<0>]>;
221 // These functions do not actually read memory, but they are sensitive to the
222 // rounding mode. This needs to be modelled separately; in the meantime
223 // declaring them as reading memory is conservatively correct.
224 let Properties = [IntrReadMem] in {
225 def int_sqrt : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
226 def int_powi : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>, llvm_i32_ty]>;
227 def int_sin : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
228 def int_cos : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
229 def int_pow : Intrinsic<[llvm_anyfloat_ty],
230 [LLVMMatchType<0>, LLVMMatchType<0>]>;
231 def int_log : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
232 def int_log10: Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
233 def int_log2 : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
234 def int_exp : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
235 def int_exp2 : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
238 // NOTE: these are internal interfaces.
239 def int_setjmp : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty]>;
240 def int_longjmp : Intrinsic<[llvm_void_ty], [llvm_ptr_ty, llvm_i32_ty]>;
241 def int_sigsetjmp : Intrinsic<[llvm_i32_ty] , [llvm_ptr_ty, llvm_i32_ty]>;
242 def int_siglongjmp : Intrinsic<[llvm_void_ty], [llvm_ptr_ty, llvm_i32_ty]>;
244 //===-------------------- Bit Manipulation Intrinsics ---------------------===//
247 // None of these intrinsics accesses memory at all.
248 let Properties = [IntrNoMem] in {
249 def int_bswap: Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
250 def int_ctpop: Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
251 def int_ctlz : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
252 def int_cttz : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
253 def int_part_select : Intrinsic<[llvm_anyint_ty],
254 [LLVMMatchType<0>, llvm_i32_ty, llvm_i32_ty]>;
255 def int_part_set : Intrinsic<[llvm_anyint_ty],
256 [LLVMMatchType<0>, llvm_anyint_ty,
257 llvm_i32_ty, llvm_i32_ty]>;
260 //===------------------------ Debugger Intrinsics -------------------------===//
263 // None of these intrinsics accesses memory at all...but that doesn't mean the
264 // optimizers can change them aggressively. Special handling needed in a few
266 let Properties = [IntrNoMem] in {
267 def int_dbg_stoppoint : Intrinsic<[llvm_void_ty],
268 [llvm_i32_ty, llvm_i32_ty,
269 llvm_descriptor_ty]>;
270 def int_dbg_region_start : Intrinsic<[llvm_void_ty], [llvm_descriptor_ty]>;
271 def int_dbg_region_end : Intrinsic<[llvm_void_ty], [llvm_descriptor_ty]>;
272 def int_dbg_func_start : Intrinsic<[llvm_void_ty], [llvm_descriptor_ty]>;
273 def int_dbg_declare : Intrinsic<[llvm_void_ty],
274 [llvm_descriptor_ty, llvm_descriptor_ty]>;
277 //===------------------ Exception Handling Intrinsics----------------------===//
279 def int_eh_exception : Intrinsic<[llvm_ptr_ty]>;
280 def int_eh_selector_i32 : Intrinsic<[llvm_i32_ty],
281 [llvm_ptr_ty, llvm_ptr_ty, llvm_vararg_ty]>;
282 def int_eh_selector_i64 : Intrinsic<[llvm_i64_ty],
283 [llvm_ptr_ty, llvm_ptr_ty, llvm_vararg_ty]>;
285 def int_eh_typeid_for_i32 : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty]>;
286 def int_eh_typeid_for_i64 : Intrinsic<[llvm_i64_ty], [llvm_ptr_ty]>;
288 def int_eh_return_i32 : Intrinsic<[llvm_void_ty], [llvm_i32_ty, llvm_ptr_ty]>;
289 def int_eh_return_i64 : Intrinsic<[llvm_void_ty], [llvm_i64_ty, llvm_ptr_ty]>;
291 def int_eh_unwind_init: Intrinsic<[llvm_void_ty]>,
292 GCCBuiltin<"__builtin_unwind_init">;
294 def int_eh_dwarf_cfa : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty]>;
296 //===---------------- Generic Variable Attribute Intrinsics----------------===//
298 def int_var_annotation : Intrinsic<[llvm_void_ty],
299 [llvm_ptr_ty, llvm_ptr_ty,
300 llvm_ptr_ty, llvm_i32_ty],
301 [], "llvm.var.annotation">;
302 def int_ptr_annotation : Intrinsic<[LLVMAnyPointerType<llvm_anyint_ty>],
303 [LLVMMatchType<0>, llvm_ptr_ty, llvm_ptr_ty,
305 [], "llvm.ptr.annotation">;
306 def int_annotation : Intrinsic<[llvm_anyint_ty],
307 [LLVMMatchType<0>, llvm_ptr_ty,
308 llvm_ptr_ty, llvm_i32_ty],
309 [], "llvm.annotation">;
311 //===------------------------ Trampoline Intrinsics -----------------------===//
313 def int_init_trampoline : Intrinsic<[llvm_ptr_ty],
314 [llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty],
316 GCCBuiltin<"__builtin_init_trampoline">;
318 //===------------------------ Overflow Intrinsics -------------------------===//
321 // Expose the carry flag from add operations on two integrals.
322 def int_sadd_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
323 [LLVMMatchType<0>, LLVMMatchType<0>]>;
324 def int_uadd_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
325 [LLVMMatchType<0>, LLVMMatchType<0>]>;
327 def int_ssub_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
328 [LLVMMatchType<0>, LLVMMatchType<0>]>;
329 def int_usub_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
330 [LLVMMatchType<0>, LLVMMatchType<0>]>;
332 def int_smul_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
333 [LLVMMatchType<0>, LLVMMatchType<0>]>;
334 def int_umul_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
335 [LLVMMatchType<0>, LLVMMatchType<0>]>;
337 //===------------------------- Atomic Intrinsics --------------------------===//
339 def int_memory_barrier : Intrinsic<[llvm_void_ty],
340 [llvm_i1_ty, llvm_i1_ty,
341 llvm_i1_ty, llvm_i1_ty, llvm_i1_ty], []>,
342 GCCBuiltin<"__builtin_llvm_memory_barrier">;
344 def int_atomic_cmp_swap : Intrinsic<[llvm_anyint_ty],
345 [LLVMAnyPointerType<LLVMMatchType<0>>,
346 LLVMMatchType<0>, LLVMMatchType<0>],
347 [IntrWriteArgMem, NoCapture<0>]>,
348 GCCBuiltin<"__sync_val_compare_and_swap">;
349 def int_atomic_load_add : Intrinsic<[llvm_anyint_ty],
350 [LLVMAnyPointerType<LLVMMatchType<0>>,
352 [IntrWriteArgMem, NoCapture<0>]>,
353 GCCBuiltin<"__sync_fetch_and_add">;
354 def int_atomic_swap : Intrinsic<[llvm_anyint_ty],
355 [LLVMAnyPointerType<LLVMMatchType<0>>,
357 [IntrWriteArgMem, NoCapture<0>]>,
358 GCCBuiltin<"__sync_lock_test_and_set">;
359 def int_atomic_load_sub : Intrinsic<[llvm_anyint_ty],
360 [LLVMAnyPointerType<LLVMMatchType<0>>,
362 [IntrWriteArgMem, NoCapture<0>]>,
363 GCCBuiltin<"__sync_fetch_and_sub">;
364 def int_atomic_load_and : Intrinsic<[llvm_anyint_ty],
365 [LLVMAnyPointerType<LLVMMatchType<0>>,
367 [IntrWriteArgMem, NoCapture<0>]>,
368 GCCBuiltin<"__sync_fetch_and_and">;
369 def int_atomic_load_or : Intrinsic<[llvm_anyint_ty],
370 [LLVMAnyPointerType<LLVMMatchType<0>>,
372 [IntrWriteArgMem, NoCapture<0>]>,
373 GCCBuiltin<"__sync_fetch_and_or">;
374 def int_atomic_load_xor : Intrinsic<[llvm_anyint_ty],
375 [LLVMAnyPointerType<LLVMMatchType<0>>,
377 [IntrWriteArgMem, NoCapture<0>]>,
378 GCCBuiltin<"__sync_fetch_and_xor">;
379 def int_atomic_load_nand : Intrinsic<[llvm_anyint_ty],
380 [LLVMAnyPointerType<LLVMMatchType<0>>,
382 [IntrWriteArgMem, NoCapture<0>]>,
383 GCCBuiltin<"__sync_fetch_and_nand">;
384 def int_atomic_load_min : Intrinsic<[llvm_anyint_ty],
385 [LLVMAnyPointerType<LLVMMatchType<0>>,
387 [IntrWriteArgMem, NoCapture<0>]>,
388 GCCBuiltin<"__sync_fetch_and_min">;
389 def int_atomic_load_max : Intrinsic<[llvm_anyint_ty],
390 [LLVMAnyPointerType<LLVMMatchType<0>>,
392 [IntrWriteArgMem, NoCapture<0>]>,
393 GCCBuiltin<"__sync_fetch_and_max">;
394 def int_atomic_load_umin : Intrinsic<[llvm_anyint_ty],
395 [LLVMAnyPointerType<LLVMMatchType<0>>,
397 [IntrWriteArgMem, NoCapture<0>]>,
398 GCCBuiltin<"__sync_fetch_and_umin">;
399 def int_atomic_load_umax : Intrinsic<[llvm_anyint_ty],
400 [LLVMAnyPointerType<LLVMMatchType<0>>,
402 [IntrWriteArgMem, NoCapture<0>]>,
403 GCCBuiltin<"__sync_fetch_and_umax">;
405 //===-------------------------- Other Intrinsics --------------------------===//
407 def int_flt_rounds : Intrinsic<[llvm_i32_ty]>,
408 GCCBuiltin<"__builtin_flt_rounds">;
409 def int_trap : Intrinsic<[llvm_void_ty]>,
410 GCCBuiltin<"__builtin_trap">;
412 // These convert intrinsics are to support various conversions between
413 // various types with rounding and saturation. NOTE: avoid using these
414 // intrinsics as they might be removed sometime in the future and
415 // most targets don't support them.
416 def int_convertff : Intrinsic<[llvm_anyfloat_ty],
417 [llvm_anyfloat_ty, llvm_i32_ty, llvm_i32_ty]>;
418 def int_convertfsi : Intrinsic<[llvm_anyfloat_ty],
419 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
420 def int_convertfui : Intrinsic<[llvm_anyfloat_ty],
421 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
422 def int_convertsif : Intrinsic<[llvm_anyint_ty],
423 [llvm_anyfloat_ty, llvm_i32_ty, llvm_i32_ty]>;
424 def int_convertuif : Intrinsic<[llvm_anyint_ty],
425 [llvm_anyfloat_ty, llvm_i32_ty, llvm_i32_ty]>;
426 def int_convertss : Intrinsic<[llvm_anyint_ty],
427 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
428 def int_convertsu : Intrinsic<[llvm_anyint_ty],
429 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
430 def int_convertus : Intrinsic<[llvm_anyint_ty],
431 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
432 def int_convertuu : Intrinsic<[llvm_anyint_ty],
433 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
435 //===----------------------------------------------------------------------===//
436 // Target-specific intrinsics
437 //===----------------------------------------------------------------------===//
439 include "llvm/IntrinsicsPowerPC.td"
440 include "llvm/IntrinsicsX86.td"
441 include "llvm/IntrinsicsARM.td"
442 include "llvm/IntrinsicsCellSPU.td"
443 include "llvm/IntrinsicsAlpha.td"
444 include "llvm/IntrinsicsXCore.td"