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. It has no
42 // other side effects. This may only be used if the intrinsic doesn't "capture"
43 // the argument pointer (e.g. storing it someplace).
44 def IntrWriteArgMem : IntrinsicProperty;
46 // IntrWriteMem - This intrinsic may read or modify unspecified memory or has
47 // other side effects. It cannot be modified by the optimizer. This is the
48 // default if the intrinsic has no other Intr*Mem property.
49 def IntrWriteMem : IntrinsicProperty;
51 // Commutative - This intrinsic is commutative: X op Y == Y op X.
52 def Commutative : IntrinsicProperty;
54 //===----------------------------------------------------------------------===//
55 // Types used by intrinsics.
56 //===----------------------------------------------------------------------===//
58 class LLVMType<ValueType vt> {
62 class LLVMPointerType<LLVMType elty>
67 class LLVMAnyPointerType<LLVMType elty>
72 class LLVMMatchType<int num>
77 def llvm_void_ty : LLVMType<isVoid>;
78 def llvm_anyint_ty : LLVMType<iAny>;
79 def llvm_anyfloat_ty : LLVMType<fAny>;
80 def llvm_i1_ty : LLVMType<i1>;
81 def llvm_i8_ty : LLVMType<i8>;
82 def llvm_i16_ty : LLVMType<i16>;
83 def llvm_i32_ty : LLVMType<i32>;
84 def llvm_i64_ty : LLVMType<i64>;
85 def llvm_float_ty : LLVMType<f32>;
86 def llvm_double_ty : LLVMType<f64>;
87 def llvm_f80_ty : LLVMType<f80>;
88 def llvm_f128_ty : LLVMType<f128>;
89 def llvm_ppcf128_ty : LLVMType<ppcf128>;
90 def llvm_ptr_ty : LLVMPointerType<llvm_i8_ty>; // i8*
91 def llvm_ptrptr_ty : LLVMPointerType<llvm_ptr_ty>; // i8**
92 def llvm_anyptr_ty : LLVMAnyPointerType<llvm_i8_ty>; // (space)i8*
93 def llvm_empty_ty : LLVMType<OtherVT>; // { }
94 def llvm_descriptor_ty : LLVMPointerType<llvm_empty_ty>; // { }*
96 def llvm_v16i8_ty : LLVMType<v16i8>; // 16 x i8
97 def llvm_v8i16_ty : LLVMType<v8i16>; // 8 x i16
98 def llvm_v2i64_ty : LLVMType<v2i64>; // 2 x i64
99 def llvm_v2i32_ty : LLVMType<v2i32>; // 2 x i32
100 def llvm_v1i64_ty : LLVMType<v1i64>; // 1 x i64
101 def llvm_v4i32_ty : LLVMType<v4i32>; // 4 x i32
102 def llvm_v4f32_ty : LLVMType<v4f32>; // 4 x float
103 def llvm_v2f64_ty : LLVMType<v2f64>; // 2 x double
106 def llvm_v8i8_ty : LLVMType<v8i8>; // 8 x i8
107 def llvm_v4i16_ty : LLVMType<v4i16>; // 4 x i16
109 def llvm_vararg_ty : LLVMType<isVoid>; // this means vararg here
111 //===----------------------------------------------------------------------===//
112 // Intrinsic Definitions.
113 //===----------------------------------------------------------------------===//
115 // Intrinsic class - This is used to define one LLVM intrinsic. The name of the
116 // intrinsic definition should start with "int_", then match the LLVM intrinsic
117 // name with the "llvm." prefix removed, and all "."s turned into "_"s. For
118 // example, llvm.bswap.i16 -> int_bswap_i16.
120 // * Types is a list containing the return type and the argument types
121 // expected for the intrinsic.
122 // * Properties can be set to describe the behavior of the intrinsic.
124 class Intrinsic<list<LLVMType> types,
125 list<IntrinsicProperty> properties = [],
127 string LLVMName = name;
128 string TargetPrefix = ""; // Set to a prefix for target-specific intrinsics.
129 list<LLVMType> Types = types;
130 list<IntrinsicProperty> Properties = properties;
133 /// GCCBuiltin - If this intrinsic exactly corresponds to a GCC builtin, this
134 /// specifies the name of the builtin. This provides automatic CBE and CFE
136 class GCCBuiltin<string name> {
137 string GCCBuiltinName = name;
141 //===--------------- Variable Argument Handling Intrinsics ----------------===//
144 def int_vastart : Intrinsic<[llvm_void_ty, llvm_ptr_ty], [], "llvm.va_start">;
145 def int_vacopy : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty], [],
147 def int_vaend : Intrinsic<[llvm_void_ty, llvm_ptr_ty], [], "llvm.va_end">;
149 //===------------------- Garbage Collection Intrinsics --------------------===//
151 def int_gcroot : Intrinsic<[llvm_void_ty, llvm_ptrptr_ty, llvm_ptr_ty]>;
152 def int_gcread : Intrinsic<[llvm_ptr_ty, llvm_ptr_ty, llvm_ptrptr_ty],
154 def int_gcwrite : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
155 llvm_ptrptr_ty], [IntrWriteArgMem]>;
157 //===--------------------- Code Generator Intrinsics ----------------------===//
159 def int_returnaddress : Intrinsic<[llvm_ptr_ty, llvm_i32_ty], [IntrNoMem]>;
160 def int_frameaddress : Intrinsic<[llvm_ptr_ty, llvm_i32_ty], [IntrNoMem]>;
162 // Note: we treat stacksave/stackrestore as writemem because we don't otherwise
163 // model their dependencies on allocas.
164 def int_stacksave : Intrinsic<[llvm_ptr_ty]>,
165 GCCBuiltin<"__builtin_stack_save">;
166 def int_stackrestore : Intrinsic<[llvm_void_ty, llvm_ptr_ty]>,
167 GCCBuiltin<"__builtin_stack_restore">;
169 // IntrWriteArgMem is more pessimistic than strictly necessary for prefetch,
170 // however it does conveniently prevent the prefetch from being reordered
171 // with respect to nearby accesses to the same memory.
172 def int_prefetch : Intrinsic<[llvm_void_ty, llvm_ptr_ty,
173 llvm_i32_ty, llvm_i32_ty],
175 def int_pcmarker : Intrinsic<[llvm_void_ty, llvm_i32_ty]>;
177 def int_readcyclecounter : Intrinsic<[llvm_i64_ty]>;
179 // Stack Protector Intrinsics - The stackprotector_create writes the stack guard
180 // to the correct place on the stack frame. The stackprotector_check reads back
181 // the stack guard that the stackprotector_create stored.
182 def int_stackprotector_create : Intrinsic<[llvm_void_ty, llvm_ptr_ty,
183 llvm_ptrptr_ty], [IntrWriteMem]>;
184 def int_stackprotector_check : Intrinsic<[llvm_ptr_ty, llvm_ptrptr_ty],
187 //===------------------- Standard C Library Intrinsics --------------------===//
190 let Properties = [IntrWriteArgMem] in {
191 def int_memcpy_i32 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
192 llvm_i32_ty, llvm_i32_ty]>;
193 def int_memcpy_i64 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
194 llvm_i64_ty, llvm_i32_ty]>;
195 def int_memmove_i32 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
196 llvm_i32_ty, llvm_i32_ty]>;
197 def int_memmove_i64 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
198 llvm_i64_ty, llvm_i32_ty]>;
199 def int_memset_i32 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_i8_ty,
200 llvm_i32_ty, llvm_i32_ty]>;
201 def int_memset_i64 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_i8_ty,
202 llvm_i64_ty, llvm_i32_ty]>;
205 // These functions do not actually read memory, but they are sensitive to the
206 // rounding mode. This needs to be modelled separately; in the meantime
207 // declaring them as reading memory is conservatively correct.
208 let Properties = [IntrReadMem] in {
209 def int_sqrt : Intrinsic<[llvm_anyfloat_ty, LLVMMatchType<0>]>;
210 def int_powi : Intrinsic<[llvm_anyfloat_ty, LLVMMatchType<0>, llvm_i32_ty]>;
211 def int_sin : Intrinsic<[llvm_anyfloat_ty, LLVMMatchType<0>]>;
212 def int_cos : Intrinsic<[llvm_anyfloat_ty, LLVMMatchType<0>]>;
213 def int_pow : Intrinsic<[llvm_anyfloat_ty,
214 LLVMMatchType<0>, LLVMMatchType<0>]>;
215 def int_log : Intrinsic<[llvm_anyfloat_ty, LLVMMatchType<0>]>;
216 def int_log10: Intrinsic<[llvm_anyfloat_ty, LLVMMatchType<0>]>;
217 def int_log2 : Intrinsic<[llvm_anyfloat_ty, LLVMMatchType<0>]>;
218 def int_exp : Intrinsic<[llvm_anyfloat_ty, LLVMMatchType<0>]>;
219 def int_exp2 : Intrinsic<[llvm_anyfloat_ty, LLVMMatchType<0>]>;
222 // NOTE: these are internal interfaces.
223 def int_setjmp : Intrinsic<[llvm_i32_ty , llvm_ptr_ty]>;
224 def int_longjmp : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_i32_ty]>;
225 def int_sigsetjmp : Intrinsic<[llvm_i32_ty , llvm_ptr_ty, llvm_i32_ty]>;
226 def int_siglongjmp : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_i32_ty]>;
228 //===-------------------- Bit Manipulation Intrinsics ---------------------===//
231 // None of these intrinsics accesses memory at all.
232 let Properties = [IntrNoMem] in {
233 def int_bswap: Intrinsic<[llvm_anyint_ty, LLVMMatchType<0>]>;
234 def int_ctpop: Intrinsic<[llvm_anyint_ty, LLVMMatchType<0>]>;
235 def int_ctlz : Intrinsic<[llvm_anyint_ty, LLVMMatchType<0>]>;
236 def int_cttz : Intrinsic<[llvm_anyint_ty, LLVMMatchType<0>]>;
237 def int_part_select :
238 Intrinsic<[llvm_anyint_ty, LLVMMatchType<0>, llvm_i32_ty, llvm_i32_ty]>;
240 Intrinsic<[llvm_anyint_ty, LLVMMatchType<0>, llvm_anyint_ty, llvm_i32_ty,
244 //===------------------------ Debugger Intrinsics -------------------------===//
247 def int_dbg_stoppoint : Intrinsic<[llvm_void_ty,
248 llvm_i32_ty, llvm_i32_ty,
249 llvm_descriptor_ty]>;
250 def int_dbg_region_start : Intrinsic<[llvm_void_ty, llvm_descriptor_ty]>;
251 def int_dbg_region_end : Intrinsic<[llvm_void_ty, llvm_descriptor_ty]>;
252 def int_dbg_func_start : Intrinsic<[llvm_void_ty, llvm_descriptor_ty]>;
253 def int_dbg_declare : Intrinsic<[llvm_void_ty, llvm_descriptor_ty,
254 llvm_descriptor_ty]>;
256 //===------------------ Exception Handling Intrinsics----------------------===//
258 def int_eh_exception : Intrinsic<[llvm_ptr_ty]>;
259 def int_eh_selector_i32 : Intrinsic<[llvm_i32_ty, llvm_ptr_ty, llvm_ptr_ty,
261 def int_eh_selector_i64 : Intrinsic<[llvm_i64_ty, llvm_ptr_ty, llvm_ptr_ty,
264 def int_eh_typeid_for_i32 : Intrinsic<[llvm_i32_ty, llvm_ptr_ty]>;
265 def int_eh_typeid_for_i64 : Intrinsic<[llvm_i64_ty, llvm_ptr_ty]>;
267 def int_eh_return_i32 : Intrinsic<[llvm_void_ty, llvm_i32_ty, llvm_ptr_ty]>;
268 def int_eh_return_i64 : Intrinsic<[llvm_void_ty, llvm_i64_ty, llvm_ptr_ty]>;
270 def int_eh_unwind_init: Intrinsic<[llvm_void_ty]>,
271 GCCBuiltin<"__builtin_unwind_init">;
273 def int_eh_dwarf_cfa : Intrinsic<[llvm_ptr_ty, llvm_i32_ty]>;
275 //===---------------- Generic Variable Attribute Intrinsics----------------===//
277 def int_var_annotation : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
278 llvm_ptr_ty, llvm_i32_ty],
279 [], "llvm.var.annotation">;
280 def int_ptr_annotation : Intrinsic<[LLVMAnyPointerType<llvm_anyint_ty>,
282 llvm_ptr_ty, llvm_ptr_ty, llvm_i32_ty],
283 [], "llvm.ptr.annotation">;
284 def int_annotation : Intrinsic<[llvm_anyint_ty, LLVMMatchType<0>, llvm_ptr_ty,
285 llvm_ptr_ty, llvm_i32_ty],
286 [], "llvm.annotation">;
288 //===------------------------ Trampoline Intrinsics -----------------------===//
290 def int_init_trampoline : Intrinsic<[llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty,
292 GCCBuiltin<"__builtin_init_trampoline">;
294 //===------------------------- Atomic Intrinsics --------------------------===//
296 def int_memory_barrier : Intrinsic<[llvm_void_ty, llvm_i1_ty, llvm_i1_ty,
297 llvm_i1_ty, llvm_i1_ty, llvm_i1_ty], []>,
298 GCCBuiltin<"__builtin_llvm_memory_barrier">;
300 def int_atomic_cmp_swap : Intrinsic<[llvm_anyint_ty,
301 LLVMAnyPointerType<LLVMMatchType<0>>,
302 LLVMMatchType<0>, LLVMMatchType<0>],
304 GCCBuiltin<"__sync_val_compare_and_swap">;
305 def int_atomic_load_add : Intrinsic<[llvm_anyint_ty,
306 LLVMAnyPointerType<LLVMMatchType<0>>,
309 GCCBuiltin<"__sync_fetch_and_add">;
310 def int_atomic_swap : Intrinsic<[llvm_anyint_ty,
311 LLVMAnyPointerType<LLVMMatchType<0>>,
314 GCCBuiltin<"__sync_lock_test_and_set">;
315 def int_atomic_load_sub : Intrinsic<[llvm_anyint_ty,
316 LLVMAnyPointerType<LLVMMatchType<0>>,
319 GCCBuiltin<"__sync_fetch_and_sub">;
320 def int_atomic_load_and : Intrinsic<[llvm_anyint_ty,
321 LLVMAnyPointerType<LLVMMatchType<0>>,
324 GCCBuiltin<"__sync_fetch_and_and">;
325 def int_atomic_load_or : Intrinsic<[llvm_anyint_ty,
326 LLVMAnyPointerType<LLVMMatchType<0>>,
329 GCCBuiltin<"__sync_fetch_and_or">;
330 def int_atomic_load_xor : Intrinsic<[llvm_anyint_ty,
331 LLVMAnyPointerType<LLVMMatchType<0>>,
334 GCCBuiltin<"__sync_fetch_and_xor">;
335 def int_atomic_load_nand : Intrinsic<[llvm_anyint_ty,
336 LLVMAnyPointerType<LLVMMatchType<0>>,
339 GCCBuiltin<"__sync_fetch_and_nand">;
340 def int_atomic_load_min : Intrinsic<[llvm_anyint_ty,
341 LLVMAnyPointerType<LLVMMatchType<0>>,
344 GCCBuiltin<"__sync_fetch_and_min">;
345 def int_atomic_load_max : Intrinsic<[llvm_anyint_ty,
346 LLVMAnyPointerType<LLVMMatchType<0>>,
349 GCCBuiltin<"__sync_fetch_and_max">;
350 def int_atomic_load_umin : Intrinsic<[llvm_anyint_ty,
351 LLVMAnyPointerType<LLVMMatchType<0>>,
354 GCCBuiltin<"__sync_fetch_and_umin">;
355 def int_atomic_load_umax : Intrinsic<[llvm_anyint_ty,
356 LLVMAnyPointerType<LLVMMatchType<0>>,
359 GCCBuiltin<"__sync_fetch_and_umax">;
361 //===-------------------------- Other Intrinsics --------------------------===//
363 def int_flt_rounds : Intrinsic<[llvm_i32_ty]>,
364 GCCBuiltin<"__builtin_flt_rounds">;
365 def int_trap : Intrinsic<[llvm_void_ty]>,
366 GCCBuiltin<"__builtin_trap">;
368 // These convert intrinsics are to support various conversions between
369 // various types with rounding and saturation. NOTE: avoid using these
370 // intrinsics as they might be removed sometime in the future and
371 // most targets don't support them.
372 def int_convertff : Intrinsic<[llvm_anyfloat_ty, llvm_anyfloat_ty,
373 llvm_i32_ty, llvm_i32_ty]>;
374 def int_convertfsi : Intrinsic<[llvm_anyfloat_ty, llvm_anyint_ty,
375 llvm_i32_ty, llvm_i32_ty]>;
376 def int_convertfui : Intrinsic<[llvm_anyfloat_ty, llvm_anyint_ty,
377 llvm_i32_ty, llvm_i32_ty]>;
378 def int_convertsif : Intrinsic<[llvm_anyint_ty, llvm_anyfloat_ty,
379 llvm_i32_ty, llvm_i32_ty]>;
380 def int_convertuif : Intrinsic<[llvm_anyint_ty, llvm_anyfloat_ty,
381 llvm_i32_ty, llvm_i32_ty]>;
382 def int_convertss : Intrinsic<[llvm_anyint_ty, llvm_anyint_ty,
383 llvm_i32_ty, llvm_i32_ty]>;
384 def int_convertsu : Intrinsic<[llvm_anyint_ty, llvm_anyint_ty,
385 llvm_i32_ty, llvm_i32_ty]>;
386 def int_convertus : Intrinsic<[llvm_anyint_ty, llvm_anyint_ty,
387 llvm_i32_ty, llvm_i32_ty]>;
388 def int_convertuu : Intrinsic<[llvm_anyint_ty, llvm_anyint_ty,
389 llvm_i32_ty, llvm_i32_ty]>;
391 //===----------------------------------------------------------------------===//
392 // Target-specific intrinsics
393 //===----------------------------------------------------------------------===//
395 include "llvm/IntrinsicsPowerPC.td"
396 include "llvm/IntrinsicsX86.td"
397 include "llvm/IntrinsicsARM.td"
398 include "llvm/IntrinsicsCellSPU.td"
399 include "llvm/IntrinsicsAlpha.td"