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 LLVMMatchType<int num>
72 def llvm_void_ty : LLVMType<isVoid>;
73 def llvm_anyint_ty : LLVMType<iAny>;
74 def llvm_anyfloat_ty : LLVMType<fAny>;
75 def llvm_i1_ty : LLVMType<i1>;
76 def llvm_i8_ty : LLVMType<i8>;
77 def llvm_i16_ty : LLVMType<i16>;
78 def llvm_i32_ty : LLVMType<i32>;
79 def llvm_i64_ty : LLVMType<i64>;
80 def llvm_float_ty : LLVMType<f32>;
81 def llvm_double_ty : LLVMType<f64>;
82 def llvm_f80_ty : LLVMType<f80>;
83 def llvm_f128_ty : LLVMType<f128>;
84 def llvm_ppcf128_ty : LLVMType<ppcf128>;
85 def llvm_ptr_ty : LLVMPointerType<llvm_i8_ty>; // i8*
86 def llvm_ptrptr_ty : LLVMPointerType<llvm_ptr_ty>; // i8**
87 def llvm_empty_ty : LLVMType<OtherVT>; // { }
88 def llvm_descriptor_ty : LLVMPointerType<llvm_empty_ty>; // { }*
90 def llvm_v16i8_ty : LLVMType<v16i8>; // 16 x i8
91 def llvm_v8i16_ty : LLVMType<v8i16>; // 8 x i16
92 def llvm_v2i64_ty : LLVMType<v2i64>; // 2 x i64
93 def llvm_v2i32_ty : LLVMType<v2i32>; // 2 x i32
94 def llvm_v1i64_ty : LLVMType<v1i64>; // 1 x i64
95 def llvm_v4i32_ty : LLVMType<v4i32>; // 4 x i32
96 def llvm_v4f32_ty : LLVMType<v4f32>; // 4 x float
97 def llvm_v2f64_ty : LLVMType<v2f64>; // 2 x double
100 def llvm_v8i8_ty : LLVMType<v8i8>; // 8 x i8
101 def llvm_v4i16_ty : LLVMType<v4i16>; // 4 x i16
103 def llvm_vararg_ty : LLVMType<isVoid>; // this means vararg here
105 //===----------------------------------------------------------------------===//
106 // Intrinsic Definitions.
107 //===----------------------------------------------------------------------===//
109 // Intrinsic class - This is used to define one LLVM intrinsic. The name of the
110 // intrinsic definition should start with "int_", then match the LLVM intrinsic
111 // name with the "llvm." prefix removed, and all "."s turned into "_"s. For
112 // example, llvm.bswap.i16 -> int_bswap_i16.
114 // * Types is a list containing the return type and the argument types
115 // expected for the intrinsic.
116 // * Properties can be set to describe the behavior of the intrinsic.
118 class Intrinsic<list<LLVMType> types,
119 list<IntrinsicProperty> properties = [],
121 string LLVMName = name;
122 string TargetPrefix = ""; // Set to a prefix for target-specific intrinsics.
123 list<LLVMType> Types = types;
124 list<IntrinsicProperty> Properties = properties;
127 /// GCCBuiltin - If this intrinsic exactly corresponds to a GCC builtin, this
128 /// specifies the name of the builtin. This provides automatic CBE and CFE
130 class GCCBuiltin<string name> {
131 string GCCBuiltinName = name;
135 //===--------------- Variable Argument Handling Intrinsics ----------------===//
138 def int_vastart : Intrinsic<[llvm_void_ty, llvm_ptr_ty], [], "llvm.va_start">;
139 def int_vacopy : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty], [],
141 def int_vaend : Intrinsic<[llvm_void_ty, llvm_ptr_ty], [], "llvm.va_end">;
143 //===------------------- Garbage Collection Intrinsics --------------------===//
145 def int_gcroot : Intrinsic<[llvm_void_ty, llvm_ptrptr_ty, llvm_ptr_ty]>;
146 def int_gcread : Intrinsic<[llvm_ptr_ty, llvm_ptr_ty, llvm_ptrptr_ty],
148 def int_gcwrite : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
149 llvm_ptrptr_ty], [IntrWriteArgMem]>;
151 //===--------------------- Code Generator Intrinsics ----------------------===//
153 def int_returnaddress : Intrinsic<[llvm_ptr_ty, llvm_i32_ty], [IntrNoMem]>;
154 def int_frameaddress : Intrinsic<[llvm_ptr_ty, llvm_i32_ty], [IntrNoMem]>;
156 // Note: we treat stacksave/stackrestore as writemem because we don't otherwise
157 // model their dependencies on allocas.
158 def int_stacksave : Intrinsic<[llvm_ptr_ty]>,
159 GCCBuiltin<"__builtin_stack_save">;
160 def int_stackrestore : Intrinsic<[llvm_void_ty, llvm_ptr_ty]>,
161 GCCBuiltin<"__builtin_stack_restore">;
162 // IntrWriteArgMem is more pessimistic than strictly necessary for prefetch,
163 // however it does conveniently prevent the prefetch from being reordered
164 // with respect to nearby accesses to the same memory.
165 def int_prefetch : Intrinsic<[llvm_void_ty, llvm_ptr_ty,
166 llvm_i32_ty, llvm_i32_ty],
168 def int_pcmarker : Intrinsic<[llvm_void_ty, llvm_i32_ty]>;
170 def int_readcyclecounter : Intrinsic<[llvm_i64_ty]>;
172 //===------------------- Standard C Library Intrinsics --------------------===//
175 let Properties = [IntrWriteArgMem] in {
176 def int_memcpy_i32 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
177 llvm_i32_ty, llvm_i32_ty]>;
178 def int_memcpy_i64 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
179 llvm_i64_ty, llvm_i32_ty]>;
180 def int_memmove_i32 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
181 llvm_i32_ty, llvm_i32_ty]>;
182 def int_memmove_i64 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
183 llvm_i64_ty, llvm_i32_ty]>;
184 def int_memset_i32 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_i8_ty,
185 llvm_i32_ty, llvm_i32_ty]>;
186 def int_memset_i64 : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_i8_ty,
187 llvm_i64_ty, llvm_i32_ty]>;
190 let Properties = [IntrNoMem] in {
191 def int_sqrt : Intrinsic<[llvm_anyfloat_ty, LLVMMatchType<0>]>;
192 def int_powi : Intrinsic<[llvm_anyfloat_ty, LLVMMatchType<0>, llvm_i32_ty]>;
193 def int_sin : Intrinsic<[llvm_anyfloat_ty, LLVMMatchType<0>]>;
194 def int_cos : Intrinsic<[llvm_anyfloat_ty, LLVMMatchType<0>]>;
195 def int_pow : Intrinsic<[llvm_anyfloat_ty,
196 LLVMMatchType<0>, LLVMMatchType<0>]>;
199 // NOTE: these are internal interfaces.
200 def int_setjmp : Intrinsic<[llvm_i32_ty , llvm_ptr_ty]>;
201 def int_longjmp : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_i32_ty]>;
202 def int_sigsetjmp : Intrinsic<[llvm_i32_ty , llvm_ptr_ty, llvm_i32_ty]>;
203 def int_siglongjmp : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_i32_ty]>;
205 //===-------------------- Bit Manipulation Intrinsics ---------------------===//
208 // None of these intrinsics accesses memory at all.
209 let Properties = [IntrNoMem] in {
210 def int_bswap: Intrinsic<[llvm_anyint_ty, LLVMMatchType<0>]>;
211 def int_ctpop: Intrinsic<[llvm_anyint_ty, LLVMMatchType<0>]>;
212 def int_ctlz : Intrinsic<[llvm_anyint_ty, LLVMMatchType<0>]>;
213 def int_cttz : Intrinsic<[llvm_anyint_ty, LLVMMatchType<0>]>;
214 def int_part_select :
215 Intrinsic<[llvm_anyint_ty, LLVMMatchType<0>, llvm_i32_ty, llvm_i32_ty]>;
217 Intrinsic<[llvm_anyint_ty, LLVMMatchType<0>, llvm_anyint_ty, llvm_i32_ty,
221 //===------------------------ Debugger Intrinsics -------------------------===//
224 def int_dbg_stoppoint : Intrinsic<[llvm_void_ty,
225 llvm_i32_ty, llvm_i32_ty,
226 llvm_descriptor_ty]>;
227 def int_dbg_region_start : Intrinsic<[llvm_void_ty, llvm_descriptor_ty]>;
228 def int_dbg_region_end : Intrinsic<[llvm_void_ty, llvm_descriptor_ty]>;
229 def int_dbg_func_start : Intrinsic<[llvm_void_ty, llvm_descriptor_ty]>;
230 def int_dbg_declare : Intrinsic<[llvm_void_ty, llvm_descriptor_ty,
231 llvm_descriptor_ty]>;
233 //===------------------ Exception Handling Intrinsics----------------------===//
235 def int_eh_exception : Intrinsic<[llvm_ptr_ty]>;
236 def int_eh_selector_i32 : Intrinsic<[llvm_i32_ty, llvm_ptr_ty, llvm_ptr_ty,
238 def int_eh_selector_i64 : Intrinsic<[llvm_i64_ty, llvm_ptr_ty, llvm_ptr_ty,
241 def int_eh_typeid_for_i32 : Intrinsic<[llvm_i32_ty, llvm_ptr_ty]>;
242 def int_eh_typeid_for_i64 : Intrinsic<[llvm_i64_ty, llvm_ptr_ty]>;
244 def int_eh_return : Intrinsic<[llvm_void_ty, llvm_i32_ty, llvm_ptr_ty]>,
245 GCCBuiltin<"__builtin_eh_return">;
247 def int_eh_unwind_init: Intrinsic<[llvm_void_ty]>,
248 GCCBuiltin<"__builtin_unwind_init">;
250 def int_eh_dwarf_cfa : Intrinsic<[llvm_ptr_ty, llvm_i32_ty]>;
252 //===---------------- Generic Variable Attribute Intrinsics----------------===//
254 def int_var_annotation : Intrinsic<[llvm_void_ty, llvm_ptr_ty, llvm_ptr_ty,
255 llvm_ptr_ty, llvm_i32_ty],
256 [], "llvm.var.annotation">;
258 def int_annotation : Intrinsic<[llvm_anyint_ty, LLVMMatchType<0>, llvm_ptr_ty,
259 llvm_ptr_ty, llvm_i32_ty],
260 [], "llvm.annotation">;
262 //===------------------------ Trampoline Intrinsics -----------------------===//
264 def int_init_trampoline : Intrinsic<[llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty,
266 GCCBuiltin<"__builtin_init_trampoline">;
268 //===------------------------- Atomic Intrinsics --------------------------===//
270 def int_memory_barrier : Intrinsic<[llvm_void_ty, llvm_i1_ty, llvm_i1_ty,
271 llvm_i1_ty, llvm_i1_ty, llvm_i1_ty], []>;
273 def int_atomic_lcs : Intrinsic<[llvm_anyint_ty,
274 LLVMPointerType<LLVMMatchType<0>>,
275 LLVMMatchType<0>, LLVMMatchType<0>],
277 GCCBuiltin<"__sync_val_compare_and_swap">;
278 def int_atomic_las : Intrinsic<[llvm_anyint_ty,
279 LLVMPointerType<LLVMMatchType<0>>,
282 GCCBuiltin<"__sync_fetch_and_add">;
283 def int_atomic_swap : Intrinsic<[llvm_anyint_ty,
284 LLVMPointerType<LLVMMatchType<0>>,
287 GCCBuiltin<"__sync_lock_test_and_set">;
288 def int_atomic_lss : Intrinsic<[llvm_anyint_ty,
289 LLVMPointerType<LLVMMatchType<0>>,
292 GCCBuiltin<"__sync_fetch_and_sub">;
293 def int_atomic_load_and : Intrinsic<[llvm_anyint_ty,
294 LLVMPointerType<LLVMMatchType<0>>,
297 GCCBuiltin<"__sync_fetch_and_and">;
298 def int_atomic_load_or : Intrinsic<[llvm_anyint_ty,
299 LLVMPointerType<LLVMMatchType<0>>,
302 GCCBuiltin<"__sync_fetch_and_or">;
303 def int_atomic_load_xor : Intrinsic<[llvm_anyint_ty,
304 LLVMPointerType<LLVMMatchType<0>>,
307 GCCBuiltin<"__sync_fetch_and_xor">;
308 def int_atomic_load_nand : Intrinsic<[llvm_anyint_ty,
309 LLVMPointerType<LLVMMatchType<0>>,
312 GCCBuiltin<"__sync_fetch_and_nand">;
313 def int_atomic_load_min : Intrinsic<[llvm_anyint_ty,
314 LLVMPointerType<LLVMMatchType<0>>,
317 GCCBuiltin<"__sync_fetch_and_min">;
318 def int_atomic_load_max : Intrinsic<[llvm_anyint_ty,
319 LLVMPointerType<LLVMMatchType<0>>,
322 GCCBuiltin<"__sync_fetch_and_max">;
323 def int_atomic_load_umin : Intrinsic<[llvm_anyint_ty,
324 LLVMPointerType<LLVMMatchType<0>>,
327 GCCBuiltin<"__sync_fetch_and_umin">;
328 def int_atomic_load_umax : Intrinsic<[llvm_anyint_ty,
329 LLVMPointerType<LLVMMatchType<0>>,
332 GCCBuiltin<"__sync_fetch_and_umax">;
334 //===-------------------------- Other Intrinsics --------------------------===//
336 def int_flt_rounds : Intrinsic<[llvm_i32_ty]>,
337 GCCBuiltin<"__builtin_flt_rounds">;
338 def int_trap : Intrinsic<[llvm_void_ty]>,
339 GCCBuiltin<"__builtin_trap">;
341 //===----------------------------------------------------------------------===//
342 // Target-specific intrinsics
343 //===----------------------------------------------------------------------===//
345 include "llvm/IntrinsicsPowerPC.td"
346 include "llvm/IntrinsicsX86.td"
347 include "llvm/IntrinsicsARM.td"
348 include "llvm/IntrinsicsCellSPU.td"