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 at most 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 (it may read and write any memory it can get access to and it may
26 // have other side effects).
28 // IntrNoMem - The intrinsic does not access memory or have any other side
29 // effects. It may be CSE'd deleted if dead, etc.
30 def IntrNoMem : IntrinsicProperty;
32 // IntrReadArgMem - This intrinsic reads only from memory that one of its
33 // pointer-typed arguments points to, but may read an unspecified amount.
34 def IntrReadArgMem : IntrinsicProperty;
36 // IntrReadMem - This intrinsic reads from unspecified memory, so it cannot be
37 // moved across stores. However, it can be reordered otherwise and can be
39 def IntrReadMem : IntrinsicProperty;
41 // IntrReadWriteArgMem - This intrinsic reads and writes only from memory that
42 // one of its arguments points to, but may access an unspecified amount. The
43 // reads and writes may be volatile, but except for this it has no other side
45 def IntrReadWriteArgMem : IntrinsicProperty;
47 // Commutative - This intrinsic is commutative: X op Y == Y op X.
48 def Commutative : IntrinsicProperty;
50 // Throws - This intrinsic can throw.
51 def Throws : 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_anyvector_ty : LLVMType<vAny>;
98 def llvm_i1_ty : LLVMType<i1>;
99 def llvm_i8_ty : LLVMType<i8>;
100 def llvm_i16_ty : LLVMType<i16>;
101 def llvm_i32_ty : LLVMType<i32>;
102 def llvm_i64_ty : LLVMType<i64>;
103 def llvm_float_ty : LLVMType<f32>;
104 def llvm_double_ty : LLVMType<f64>;
105 def llvm_f80_ty : LLVMType<f80>;
106 def llvm_f128_ty : LLVMType<f128>;
107 def llvm_ppcf128_ty : LLVMType<ppcf128>;
108 def llvm_ptr_ty : LLVMPointerType<llvm_i8_ty>; // i8*
109 def llvm_ptrptr_ty : LLVMPointerType<llvm_ptr_ty>; // i8**
110 def llvm_anyptr_ty : LLVMAnyPointerType<llvm_i8_ty>; // (space)i8*
111 def llvm_empty_ty : LLVMType<OtherVT>; // { }
112 def llvm_descriptor_ty : LLVMPointerType<llvm_empty_ty>; // { }*
113 def llvm_metadata_ty : LLVMType<MetadataVT>; // !{...}
115 def llvm_x86mmx_ty : LLVMType<x86mmx>;
116 def llvm_ptrx86mmx_ty : LLVMPointerType<llvm_x86mmx_ty>; // <1 x i64>*
118 def llvm_v2i8_ty : LLVMType<v2i8>; // 2 x i8
119 def llvm_v4i8_ty : LLVMType<v4i8>; // 4 x i8
120 def llvm_v8i8_ty : LLVMType<v8i8>; // 8 x i8
121 def llvm_v16i8_ty : LLVMType<v16i8>; // 16 x i8
122 def llvm_v32i8_ty : LLVMType<v32i8>; // 32 x i8
123 def llvm_v2i16_ty : LLVMType<v2i16>; // 2 x i16
124 def llvm_v4i16_ty : LLVMType<v4i16>; // 4 x i16
125 def llvm_v8i16_ty : LLVMType<v8i16>; // 8 x i16
126 def llvm_v16i16_ty : LLVMType<v16i16>; // 16 x i16
127 def llvm_v2i32_ty : LLVMType<v2i32>; // 2 x i32
128 def llvm_v4i32_ty : LLVMType<v4i32>; // 4 x i32
129 def llvm_v8i32_ty : LLVMType<v8i32>; // 8 x i32
130 def llvm_v1i64_ty : LLVMType<v1i64>; // 1 x i64
131 def llvm_v2i64_ty : LLVMType<v2i64>; // 2 x i64
132 def llvm_v4i64_ty : LLVMType<v4i64>; // 4 x i64
134 def llvm_v2f32_ty : LLVMType<v2f32>; // 2 x float
135 def llvm_v4f32_ty : LLVMType<v4f32>; // 4 x float
136 def llvm_v8f32_ty : LLVMType<v8f32>; // 8 x float
137 def llvm_v2f64_ty : LLVMType<v2f64>; // 2 x double
138 def llvm_v4f64_ty : LLVMType<v4f64>; // 4 x double
140 def llvm_vararg_ty : LLVMType<isVoid>; // this means vararg here
143 //===----------------------------------------------------------------------===//
144 // Intrinsic Definitions.
145 //===----------------------------------------------------------------------===//
147 // Intrinsic class - This is used to define one LLVM intrinsic. The name of the
148 // intrinsic definition should start with "int_", then match the LLVM intrinsic
149 // name with the "llvm." prefix removed, and all "."s turned into "_"s. For
150 // example, llvm.bswap.i16 -> int_bswap_i16.
152 // * RetTypes is a list containing the return types expected for the
154 // * ParamTypes is a list containing the parameter types expected for the
156 // * Properties can be set to describe the behavior of the intrinsic.
158 class Intrinsic<list<LLVMType> ret_types,
159 list<LLVMType> param_types = [],
160 list<IntrinsicProperty> properties = [],
162 string LLVMName = name;
163 string TargetPrefix = ""; // Set to a prefix for target-specific intrinsics.
164 list<LLVMType> RetTypes = ret_types;
165 list<LLVMType> ParamTypes = param_types;
166 list<IntrinsicProperty> Properties = properties;
171 /// GCCBuiltin - If this intrinsic exactly corresponds to a GCC builtin, this
172 /// specifies the name of the builtin. This provides automatic CBE and CFE
174 class GCCBuiltin<string name> {
175 string GCCBuiltinName = name;
179 //===--------------- Variable Argument Handling Intrinsics ----------------===//
182 def int_vastart : Intrinsic<[], [llvm_ptr_ty], [], "llvm.va_start">;
183 def int_vacopy : Intrinsic<[], [llvm_ptr_ty, llvm_ptr_ty], [],
185 def int_vaend : Intrinsic<[], [llvm_ptr_ty], [], "llvm.va_end">;
187 //===------------------- Garbage Collection Intrinsics --------------------===//
189 def int_gcroot : Intrinsic<[],
190 [llvm_ptrptr_ty, llvm_ptr_ty]>;
191 def int_gcread : Intrinsic<[llvm_ptr_ty],
192 [llvm_ptr_ty, llvm_ptrptr_ty],
194 def int_gcwrite : Intrinsic<[],
195 [llvm_ptr_ty, llvm_ptr_ty, llvm_ptrptr_ty],
196 [IntrReadWriteArgMem, NoCapture<1>, NoCapture<2>]>;
198 //===--------------------- Code Generator Intrinsics ----------------------===//
200 def int_returnaddress : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty], [IntrNoMem]>;
201 def int_frameaddress : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty], [IntrNoMem]>;
203 // Note: we treat stacksave/stackrestore as writemem because we don't otherwise
204 // model their dependencies on allocas.
205 def int_stacksave : Intrinsic<[llvm_ptr_ty]>,
206 GCCBuiltin<"__builtin_stack_save">;
207 def int_stackrestore : Intrinsic<[], [llvm_ptr_ty]>,
208 GCCBuiltin<"__builtin_stack_restore">;
210 // IntrReadWriteArgMem is more pessimistic than strictly necessary for prefetch,
211 // however it does conveniently prevent the prefetch from being reordered
212 // with respect to nearby accesses to the same memory.
213 def int_prefetch : Intrinsic<[],
214 [llvm_ptr_ty, llvm_i32_ty, llvm_i32_ty,
216 [IntrReadWriteArgMem, NoCapture<0>]>;
217 def int_pcmarker : Intrinsic<[], [llvm_i32_ty]>;
219 def int_readcyclecounter : Intrinsic<[llvm_i64_ty]>;
221 // Stack Protector Intrinsic - The stackprotector intrinsic writes the stack
222 // guard to the correct place on the stack frame.
223 def int_stackprotector : Intrinsic<[], [llvm_ptr_ty, llvm_ptrptr_ty], []>;
225 //===------------------- Standard C Library Intrinsics --------------------===//
228 def int_memcpy : Intrinsic<[],
229 [llvm_anyptr_ty, llvm_anyptr_ty, llvm_anyint_ty,
230 llvm_i32_ty, llvm_i1_ty],
231 [IntrReadWriteArgMem, NoCapture<0>, NoCapture<1>]>;
232 def int_memmove : Intrinsic<[],
233 [llvm_anyptr_ty, llvm_anyptr_ty, llvm_anyint_ty,
234 llvm_i32_ty, llvm_i1_ty],
235 [IntrReadWriteArgMem, NoCapture<0>, NoCapture<1>]>;
236 def int_memset : Intrinsic<[],
237 [llvm_anyptr_ty, llvm_i8_ty, llvm_anyint_ty,
238 llvm_i32_ty, llvm_i1_ty],
239 [IntrReadWriteArgMem, NoCapture<0>]>;
241 // These functions do not actually read memory, but they are sensitive to the
242 // rounding mode. This needs to be modelled separately; in the meantime
243 // declaring them as reading memory is conservatively correct.
244 let Properties = [IntrReadMem] in {
245 def int_sqrt : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
246 def int_powi : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>, llvm_i32_ty]>;
247 def int_sin : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
248 def int_cos : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
249 def int_pow : Intrinsic<[llvm_anyfloat_ty],
250 [LLVMMatchType<0>, LLVMMatchType<0>]>;
251 def int_log : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
252 def int_log10: Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
253 def int_log2 : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
254 def int_exp : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
255 def int_exp2 : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
258 let Properties = [IntrNoMem] in {
259 def int_fma : Intrinsic<[llvm_anyfloat_ty],
260 [LLVMMatchType<0>, LLVMMatchType<0>,
264 // NOTE: these are internal interfaces.
265 def int_setjmp : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty]>;
266 def int_longjmp : Intrinsic<[], [llvm_ptr_ty, llvm_i32_ty]>;
267 def int_sigsetjmp : Intrinsic<[llvm_i32_ty] , [llvm_ptr_ty, llvm_i32_ty]>;
268 def int_siglongjmp : Intrinsic<[], [llvm_ptr_ty, llvm_i32_ty]>;
270 // Internal interface for object size checking
271 def int_objectsize : Intrinsic<[llvm_anyint_ty], [llvm_ptr_ty, llvm_i1_ty],
273 GCCBuiltin<"__builtin_object_size">;
275 //===------------------------- Expect Intrinsics --------------------------===//
277 def int_expect : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>,
278 LLVMMatchType<0>], [IntrNoMem]>;
280 //===-------------------- Bit Manipulation Intrinsics ---------------------===//
283 // None of these intrinsics accesses memory at all.
284 let Properties = [IntrNoMem] in {
285 def int_bswap: Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
286 def int_ctpop: Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
287 def int_ctlz : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>, llvm_i1_ty]>;
288 def int_cttz : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>, llvm_i1_ty]>;
291 //===------------------------ Debugger Intrinsics -------------------------===//
294 // None of these intrinsics accesses memory at all...but that doesn't mean the
295 // optimizers can change them aggressively. Special handling needed in a few
297 let Properties = [IntrNoMem] in {
298 def int_dbg_declare : Intrinsic<[],
299 [llvm_metadata_ty, llvm_metadata_ty]>;
300 def int_dbg_value : Intrinsic<[],
301 [llvm_metadata_ty, llvm_i64_ty,
305 //===------------------ Exception Handling Intrinsics----------------------===//
308 // The result of eh.typeid.for depends on the enclosing function, but inside a
309 // given function it is 'const' and may be CSE'd etc.
310 def int_eh_typeid_for : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty], [IntrNoMem]>;
312 def int_eh_return_i32 : Intrinsic<[], [llvm_i32_ty, llvm_ptr_ty]>;
313 def int_eh_return_i64 : Intrinsic<[], [llvm_i64_ty, llvm_ptr_ty]>;
315 def int_eh_unwind_init: Intrinsic<[]>,
316 GCCBuiltin<"__builtin_unwind_init">;
318 def int_eh_dwarf_cfa : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty]>;
320 let Properties = [IntrNoMem] in {
321 def int_eh_sjlj_lsda : Intrinsic<[llvm_ptr_ty]>;
322 def int_eh_sjlj_callsite : Intrinsic<[], [llvm_i32_ty]>;
324 def int_eh_sjlj_functioncontext : Intrinsic<[], [llvm_ptr_ty]>;
325 def int_eh_sjlj_setjmp : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty]>;
326 def int_eh_sjlj_longjmp : Intrinsic<[], [llvm_ptr_ty]>;
328 //===---------------- Generic Variable Attribute Intrinsics----------------===//
330 def int_var_annotation : Intrinsic<[],
331 [llvm_ptr_ty, llvm_ptr_ty,
332 llvm_ptr_ty, llvm_i32_ty],
333 [], "llvm.var.annotation">;
334 def int_ptr_annotation : Intrinsic<[LLVMAnyPointerType<llvm_anyint_ty>],
335 [LLVMMatchType<0>, llvm_ptr_ty, llvm_ptr_ty,
337 [], "llvm.ptr.annotation">;
338 def int_annotation : Intrinsic<[llvm_anyint_ty],
339 [LLVMMatchType<0>, llvm_ptr_ty,
340 llvm_ptr_ty, llvm_i32_ty],
341 [], "llvm.annotation">;
343 //===------------------------ Trampoline Intrinsics -----------------------===//
345 def int_init_trampoline : Intrinsic<[],
346 [llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty],
347 [IntrReadWriteArgMem, NoCapture<0>]>,
348 GCCBuiltin<"__builtin_init_trampoline">;
350 def int_adjust_trampoline : Intrinsic<[llvm_ptr_ty], [llvm_ptr_ty],
352 GCCBuiltin<"__builtin_adjust_trampoline">;
354 //===------------------------ Overflow Intrinsics -------------------------===//
357 // Expose the carry flag from add operations on two integrals.
358 def int_sadd_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
359 [LLVMMatchType<0>, LLVMMatchType<0>],
361 def int_uadd_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
362 [LLVMMatchType<0>, LLVMMatchType<0>],
365 def int_ssub_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
366 [LLVMMatchType<0>, LLVMMatchType<0>],
368 def int_usub_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
369 [LLVMMatchType<0>, LLVMMatchType<0>],
372 def int_smul_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
373 [LLVMMatchType<0>, LLVMMatchType<0>],
375 def int_umul_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
376 [LLVMMatchType<0>, LLVMMatchType<0>],
379 //===------------------------- Memory Use Markers -------------------------===//
381 def int_lifetime_start : Intrinsic<[],
382 [llvm_i64_ty, llvm_ptr_ty],
383 [IntrReadWriteArgMem, NoCapture<1>]>;
384 def int_lifetime_end : Intrinsic<[],
385 [llvm_i64_ty, llvm_ptr_ty],
386 [IntrReadWriteArgMem, NoCapture<1>]>;
387 def int_invariant_start : Intrinsic<[llvm_descriptor_ty],
388 [llvm_i64_ty, llvm_ptr_ty],
389 [IntrReadWriteArgMem, NoCapture<1>]>;
390 def int_invariant_end : Intrinsic<[],
391 [llvm_descriptor_ty, llvm_i64_ty,
393 [IntrReadWriteArgMem, NoCapture<2>]>;
395 //===-------------------------- Other Intrinsics --------------------------===//
397 def int_flt_rounds : Intrinsic<[llvm_i32_ty]>,
398 GCCBuiltin<"__builtin_flt_rounds">;
399 def int_trap : Intrinsic<[]>,
400 GCCBuiltin<"__builtin_trap">;
402 // Intrisics to support half precision floating point format
403 let Properties = [IntrNoMem] in {
404 def int_convert_to_fp16 : Intrinsic<[llvm_i16_ty], [llvm_float_ty]>,
405 GCCBuiltin<"__gnu_f2h_ieee">;
406 def int_convert_from_fp16 : Intrinsic<[llvm_float_ty], [llvm_i16_ty]>,
407 GCCBuiltin<"__gnu_h2f_ieee">;
410 // These convert intrinsics are to support various conversions between
411 // various types with rounding and saturation. NOTE: avoid using these
412 // intrinsics as they might be removed sometime in the future and
413 // most targets don't support them.
414 def int_convertff : Intrinsic<[llvm_anyfloat_ty],
415 [llvm_anyfloat_ty, llvm_i32_ty, llvm_i32_ty]>;
416 def int_convertfsi : Intrinsic<[llvm_anyfloat_ty],
417 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
418 def int_convertfui : Intrinsic<[llvm_anyfloat_ty],
419 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
420 def int_convertsif : Intrinsic<[llvm_anyint_ty],
421 [llvm_anyfloat_ty, llvm_i32_ty, llvm_i32_ty]>;
422 def int_convertuif : Intrinsic<[llvm_anyint_ty],
423 [llvm_anyfloat_ty, llvm_i32_ty, llvm_i32_ty]>;
424 def int_convertss : Intrinsic<[llvm_anyint_ty],
425 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
426 def int_convertsu : Intrinsic<[llvm_anyint_ty],
427 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
428 def int_convertus : Intrinsic<[llvm_anyint_ty],
429 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
430 def int_convertuu : Intrinsic<[llvm_anyint_ty],
431 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
433 //===----------------------------------------------------------------------===//
434 // Target-specific intrinsics
435 //===----------------------------------------------------------------------===//
437 include "llvm/IntrinsicsPowerPC.td"
438 include "llvm/IntrinsicsX86.td"
439 include "llvm/IntrinsicsARM.td"
440 include "llvm/IntrinsicsCellSPU.td"
441 include "llvm/IntrinsicsXCore.td"
442 include "llvm/IntrinsicsPTX.td"
443 include "llvm/IntrinsicsHexagon.td"