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 def IntrNoReturn : IntrinsicProperty;
60 //===----------------------------------------------------------------------===//
61 // Types used by intrinsics.
62 //===----------------------------------------------------------------------===//
64 class LLVMType<ValueType vt> {
68 class LLVMQualPointerType<LLVMType elty, int addrspace>
71 int AddrSpace = addrspace;
74 class LLVMPointerType<LLVMType elty>
75 : LLVMQualPointerType<elty, 0>;
77 class LLVMAnyPointerType<LLVMType elty>
82 // Match the type of another intrinsic parameter. Number is an index into the
83 // list of overloaded types for the intrinsic, excluding all the fixed types.
84 // The Number value must refer to a previously listed type. For example:
85 // Intrinsic<[llvm_i32_ty], [llvm_i32_ty, llvm_anyfloat_ty, LLVMMatchType<0>]>
86 // has two overloaded types, the 2nd and 3rd arguments. LLVMMatchType<0>
87 // refers to the first overloaded type, which is the 2nd argument.
88 class LLVMMatchType<int num>
93 // Match the type of another intrinsic parameter that is expected to be
94 // an integral vector type, but change the element size to be twice as wide
95 // or half as wide as the other type. This is only useful when the intrinsic
96 // is overloaded, so the matched type should be declared as iAny.
97 class LLVMExtendedElementVectorType<int num> : LLVMMatchType<num>;
98 class LLVMTruncatedElementVectorType<int num> : LLVMMatchType<num>;
100 def llvm_void_ty : LLVMType<isVoid>;
101 def llvm_anyint_ty : LLVMType<iAny>;
102 def llvm_anyfloat_ty : LLVMType<fAny>;
103 def llvm_anyvector_ty : LLVMType<vAny>;
104 def llvm_i1_ty : LLVMType<i1>;
105 def llvm_i8_ty : LLVMType<i8>;
106 def llvm_i16_ty : LLVMType<i16>;
107 def llvm_i32_ty : LLVMType<i32>;
108 def llvm_i64_ty : LLVMType<i64>;
109 def llvm_float_ty : LLVMType<f32>;
110 def llvm_double_ty : LLVMType<f64>;
111 def llvm_f80_ty : LLVMType<f80>;
112 def llvm_f128_ty : LLVMType<f128>;
113 def llvm_ppcf128_ty : LLVMType<ppcf128>;
114 def llvm_ptr_ty : LLVMPointerType<llvm_i8_ty>; // i8*
115 def llvm_ptrptr_ty : LLVMPointerType<llvm_ptr_ty>; // i8**
116 def llvm_anyptr_ty : LLVMAnyPointerType<llvm_i8_ty>; // (space)i8*
117 def llvm_empty_ty : LLVMType<OtherVT>; // { }
118 def llvm_descriptor_ty : LLVMPointerType<llvm_empty_ty>; // { }*
119 def llvm_metadata_ty : LLVMType<MetadataVT>; // !{...}
121 def llvm_x86mmx_ty : LLVMType<x86mmx>;
122 def llvm_ptrx86mmx_ty : LLVMPointerType<llvm_x86mmx_ty>; // <1 x i64>*
124 def llvm_v2i8_ty : LLVMType<v2i8>; // 2 x i8
125 def llvm_v4i8_ty : LLVMType<v4i8>; // 4 x i8
126 def llvm_v8i8_ty : LLVMType<v8i8>; // 8 x i8
127 def llvm_v16i8_ty : LLVMType<v16i8>; // 16 x i8
128 def llvm_v32i8_ty : LLVMType<v32i8>; // 32 x i8
129 def llvm_v2i16_ty : LLVMType<v2i16>; // 2 x i16
130 def llvm_v4i16_ty : LLVMType<v4i16>; // 4 x i16
131 def llvm_v8i16_ty : LLVMType<v8i16>; // 8 x i16
132 def llvm_v16i16_ty : LLVMType<v16i16>; // 16 x i16
133 def llvm_v2i32_ty : LLVMType<v2i32>; // 2 x i32
134 def llvm_v4i32_ty : LLVMType<v4i32>; // 4 x i32
135 def llvm_v8i32_ty : LLVMType<v8i32>; // 8 x i32
136 def llvm_v1i64_ty : LLVMType<v1i64>; // 1 x i64
137 def llvm_v2i64_ty : LLVMType<v2i64>; // 2 x i64
138 def llvm_v4i64_ty : LLVMType<v4i64>; // 4 x i64
140 def llvm_v2f32_ty : LLVMType<v2f32>; // 2 x float
141 def llvm_v4f32_ty : LLVMType<v4f32>; // 4 x float
142 def llvm_v8f32_ty : LLVMType<v8f32>; // 8 x float
143 def llvm_v2f64_ty : LLVMType<v2f64>; // 2 x double
144 def llvm_v4f64_ty : LLVMType<v4f64>; // 4 x double
146 def llvm_vararg_ty : LLVMType<isVoid>; // this means vararg here
149 //===----------------------------------------------------------------------===//
150 // Intrinsic Definitions.
151 //===----------------------------------------------------------------------===//
153 // Intrinsic class - This is used to define one LLVM intrinsic. The name of the
154 // intrinsic definition should start with "int_", then match the LLVM intrinsic
155 // name with the "llvm." prefix removed, and all "."s turned into "_"s. For
156 // example, llvm.bswap.i16 -> int_bswap_i16.
158 // * RetTypes is a list containing the return types expected for the
160 // * ParamTypes is a list containing the parameter types expected for the
162 // * Properties can be set to describe the behavior of the intrinsic.
164 class Intrinsic<list<LLVMType> ret_types,
165 list<LLVMType> param_types = [],
166 list<IntrinsicProperty> properties = [],
168 string LLVMName = name;
169 string TargetPrefix = ""; // Set to a prefix for target-specific intrinsics.
170 list<LLVMType> RetTypes = ret_types;
171 list<LLVMType> ParamTypes = param_types;
172 list<IntrinsicProperty> Properties = properties;
177 /// GCCBuiltin - If this intrinsic exactly corresponds to a GCC builtin, this
178 /// specifies the name of the builtin. This provides automatic CBE and CFE
180 class GCCBuiltin<string name> {
181 string GCCBuiltinName = name;
185 //===--------------- Variable Argument Handling Intrinsics ----------------===//
188 def int_vastart : Intrinsic<[], [llvm_ptr_ty], [], "llvm.va_start">;
189 def int_vacopy : Intrinsic<[], [llvm_ptr_ty, llvm_ptr_ty], [],
191 def int_vaend : Intrinsic<[], [llvm_ptr_ty], [], "llvm.va_end">;
193 //===------------------- Garbage Collection Intrinsics --------------------===//
195 def int_gcroot : Intrinsic<[],
196 [llvm_ptrptr_ty, llvm_ptr_ty]>;
197 def int_gcread : Intrinsic<[llvm_ptr_ty],
198 [llvm_ptr_ty, llvm_ptrptr_ty],
200 def int_gcwrite : Intrinsic<[],
201 [llvm_ptr_ty, llvm_ptr_ty, llvm_ptrptr_ty],
202 [IntrReadWriteArgMem, NoCapture<1>, NoCapture<2>]>;
204 //===--------------------- Code Generator Intrinsics ----------------------===//
206 def int_returnaddress : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty], [IntrNoMem]>;
207 def int_frameaddress : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty], [IntrNoMem]>;
209 // Note: we treat stacksave/stackrestore as writemem because we don't otherwise
210 // model their dependencies on allocas.
211 def int_stacksave : Intrinsic<[llvm_ptr_ty]>,
212 GCCBuiltin<"__builtin_stack_save">;
213 def int_stackrestore : Intrinsic<[], [llvm_ptr_ty]>,
214 GCCBuiltin<"__builtin_stack_restore">;
216 // IntrReadWriteArgMem is more pessimistic than strictly necessary for prefetch,
217 // however it does conveniently prevent the prefetch from being reordered
218 // with respect to nearby accesses to the same memory.
219 def int_prefetch : Intrinsic<[],
220 [llvm_ptr_ty, llvm_i32_ty, llvm_i32_ty,
222 [IntrReadWriteArgMem, NoCapture<0>]>;
223 def int_pcmarker : Intrinsic<[], [llvm_i32_ty]>;
225 def int_readcyclecounter : Intrinsic<[llvm_i64_ty]>;
227 // Stack Protector Intrinsic - The stackprotector intrinsic writes the stack
228 // guard to the correct place on the stack frame.
229 def int_stackprotector : Intrinsic<[], [llvm_ptr_ty, llvm_ptrptr_ty], []>;
231 //===------------------- Standard C Library Intrinsics --------------------===//
234 def int_memcpy : Intrinsic<[],
235 [llvm_anyptr_ty, llvm_anyptr_ty, llvm_anyint_ty,
236 llvm_i32_ty, llvm_i1_ty],
237 [IntrReadWriteArgMem, NoCapture<0>, NoCapture<1>]>;
238 def int_memmove : Intrinsic<[],
239 [llvm_anyptr_ty, llvm_anyptr_ty, llvm_anyint_ty,
240 llvm_i32_ty, llvm_i1_ty],
241 [IntrReadWriteArgMem, NoCapture<0>, NoCapture<1>]>;
242 def int_memset : Intrinsic<[],
243 [llvm_anyptr_ty, llvm_i8_ty, llvm_anyint_ty,
244 llvm_i32_ty, llvm_i1_ty],
245 [IntrReadWriteArgMem, NoCapture<0>]>;
247 // These functions do not actually read memory, but they are sensitive to the
248 // rounding mode. This needs to be modelled separately; in the meantime
249 // declaring them as reading memory is conservatively correct.
250 let Properties = [IntrReadMem] in {
251 def int_sqrt : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
252 def int_powi : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>, llvm_i32_ty]>;
253 def int_sin : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
254 def int_cos : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
255 def int_pow : Intrinsic<[llvm_anyfloat_ty],
256 [LLVMMatchType<0>, LLVMMatchType<0>]>;
257 def int_log : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
258 def int_log10: Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
259 def int_log2 : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
260 def int_exp : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
261 def int_exp2 : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
264 let Properties = [IntrNoMem] in {
265 def int_fma : Intrinsic<[llvm_anyfloat_ty],
266 [LLVMMatchType<0>, LLVMMatchType<0>,
270 // NOTE: these are internal interfaces.
271 def int_setjmp : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty]>;
272 def int_longjmp : Intrinsic<[], [llvm_ptr_ty, llvm_i32_ty]>;
273 def int_sigsetjmp : Intrinsic<[llvm_i32_ty] , [llvm_ptr_ty, llvm_i32_ty]>;
274 def int_siglongjmp : Intrinsic<[], [llvm_ptr_ty, llvm_i32_ty]>;
276 // Internal interface for object size checking
277 def int_objectsize : Intrinsic<[llvm_anyint_ty], [llvm_ptr_ty, llvm_i1_ty],
279 GCCBuiltin<"__builtin_object_size">;
281 //===------------------------- Expect Intrinsics --------------------------===//
283 def int_expect : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>,
284 LLVMMatchType<0>], [IntrNoMem]>;
286 //===-------------------- Bit Manipulation Intrinsics ---------------------===//
289 // None of these intrinsics accesses memory at all.
290 let Properties = [IntrNoMem] in {
291 def int_bswap: Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
292 def int_ctpop: Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
293 def int_ctlz : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>, llvm_i1_ty]>;
294 def int_cttz : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>, llvm_i1_ty]>;
297 //===------------------------ Debugger Intrinsics -------------------------===//
300 // None of these intrinsics accesses memory at all...but that doesn't mean the
301 // optimizers can change them aggressively. Special handling needed in a few
303 let Properties = [IntrNoMem] in {
304 def int_dbg_declare : Intrinsic<[],
305 [llvm_metadata_ty, llvm_metadata_ty]>;
306 def int_dbg_value : Intrinsic<[],
307 [llvm_metadata_ty, llvm_i64_ty,
311 //===------------------ Exception Handling Intrinsics----------------------===//
314 // The result of eh.typeid.for depends on the enclosing function, but inside a
315 // given function it is 'const' and may be CSE'd etc.
316 def int_eh_typeid_for : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty], [IntrNoMem]>;
318 def int_eh_return_i32 : Intrinsic<[], [llvm_i32_ty, llvm_ptr_ty]>;
319 def int_eh_return_i64 : Intrinsic<[], [llvm_i64_ty, llvm_ptr_ty]>;
321 def int_eh_unwind_init: Intrinsic<[]>,
322 GCCBuiltin<"__builtin_unwind_init">;
324 def int_eh_dwarf_cfa : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty]>;
326 let Properties = [IntrNoMem] in {
327 def int_eh_sjlj_lsda : Intrinsic<[llvm_ptr_ty]>;
328 def int_eh_sjlj_callsite : Intrinsic<[], [llvm_i32_ty]>;
330 def int_eh_sjlj_functioncontext : Intrinsic<[], [llvm_ptr_ty]>;
331 def int_eh_sjlj_setjmp : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty]>;
332 def int_eh_sjlj_longjmp : Intrinsic<[], [llvm_ptr_ty]>;
334 //===---------------- Generic Variable Attribute Intrinsics----------------===//
336 def int_var_annotation : Intrinsic<[],
337 [llvm_ptr_ty, llvm_ptr_ty,
338 llvm_ptr_ty, llvm_i32_ty],
339 [], "llvm.var.annotation">;
340 def int_ptr_annotation : Intrinsic<[LLVMAnyPointerType<llvm_anyint_ty>],
341 [LLVMMatchType<0>, llvm_ptr_ty, llvm_ptr_ty,
343 [], "llvm.ptr.annotation">;
344 def int_annotation : Intrinsic<[llvm_anyint_ty],
345 [LLVMMatchType<0>, llvm_ptr_ty,
346 llvm_ptr_ty, llvm_i32_ty],
347 [], "llvm.annotation">;
349 //===------------------------ Trampoline Intrinsics -----------------------===//
351 def int_init_trampoline : Intrinsic<[],
352 [llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty],
353 [IntrReadWriteArgMem, NoCapture<0>]>,
354 GCCBuiltin<"__builtin_init_trampoline">;
356 def int_adjust_trampoline : Intrinsic<[llvm_ptr_ty], [llvm_ptr_ty],
358 GCCBuiltin<"__builtin_adjust_trampoline">;
360 //===------------------------ Overflow Intrinsics -------------------------===//
363 // Expose the carry flag from add operations on two integrals.
364 def int_sadd_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
365 [LLVMMatchType<0>, LLVMMatchType<0>],
367 def int_uadd_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
368 [LLVMMatchType<0>, LLVMMatchType<0>],
371 def int_ssub_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
372 [LLVMMatchType<0>, LLVMMatchType<0>],
374 def int_usub_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
375 [LLVMMatchType<0>, LLVMMatchType<0>],
378 def int_smul_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
379 [LLVMMatchType<0>, LLVMMatchType<0>],
381 def int_umul_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
382 [LLVMMatchType<0>, LLVMMatchType<0>],
385 //===------------------------- Memory Use Markers -------------------------===//
387 def int_lifetime_start : Intrinsic<[],
388 [llvm_i64_ty, llvm_ptr_ty],
389 [IntrReadWriteArgMem, NoCapture<1>]>;
390 def int_lifetime_end : Intrinsic<[],
391 [llvm_i64_ty, llvm_ptr_ty],
392 [IntrReadWriteArgMem, NoCapture<1>]>;
393 def int_invariant_start : Intrinsic<[llvm_descriptor_ty],
394 [llvm_i64_ty, llvm_ptr_ty],
395 [IntrReadWriteArgMem, NoCapture<1>]>;
396 def int_invariant_end : Intrinsic<[],
397 [llvm_descriptor_ty, llvm_i64_ty,
399 [IntrReadWriteArgMem, NoCapture<2>]>;
401 //===-------------------------- Other Intrinsics --------------------------===//
403 def int_flt_rounds : Intrinsic<[llvm_i32_ty]>,
404 GCCBuiltin<"__builtin_flt_rounds">;
405 def int_trap : Intrinsic<[], [], [IntrNoReturn]>,
406 GCCBuiltin<"__builtin_trap">;
407 def int_debugtrap : Intrinsic<[]>,
408 GCCBuiltin<"__builtin_debugtrap">;
410 // Intrisics to support half precision floating point format
411 let Properties = [IntrNoMem] in {
412 def int_convert_to_fp16 : Intrinsic<[llvm_i16_ty], [llvm_float_ty]>,
413 GCCBuiltin<"__gnu_f2h_ieee">;
414 def int_convert_from_fp16 : Intrinsic<[llvm_float_ty], [llvm_i16_ty]>,
415 GCCBuiltin<"__gnu_h2f_ieee">;
418 // These convert intrinsics are to support various conversions between
419 // various types with rounding and saturation. NOTE: avoid using these
420 // intrinsics as they might be removed sometime in the future and
421 // most targets don't support them.
422 def int_convertff : Intrinsic<[llvm_anyfloat_ty],
423 [llvm_anyfloat_ty, llvm_i32_ty, llvm_i32_ty]>;
424 def int_convertfsi : Intrinsic<[llvm_anyfloat_ty],
425 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
426 def int_convertfui : Intrinsic<[llvm_anyfloat_ty],
427 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
428 def int_convertsif : Intrinsic<[llvm_anyint_ty],
429 [llvm_anyfloat_ty, llvm_i32_ty, llvm_i32_ty]>;
430 def int_convertuif : Intrinsic<[llvm_anyint_ty],
431 [llvm_anyfloat_ty, llvm_i32_ty, llvm_i32_ty]>;
432 def int_convertss : Intrinsic<[llvm_anyint_ty],
433 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
434 def int_convertsu : Intrinsic<[llvm_anyint_ty],
435 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
436 def int_convertus : Intrinsic<[llvm_anyint_ty],
437 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
438 def int_convertuu : Intrinsic<[llvm_anyint_ty],
439 [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
441 //===----------------------------------------------------------------------===//
442 // Target-specific intrinsics
443 //===----------------------------------------------------------------------===//
445 include "llvm/IntrinsicsPowerPC.td"
446 include "llvm/IntrinsicsX86.td"
447 include "llvm/IntrinsicsARM.td"
448 include "llvm/IntrinsicsCellSPU.td"
449 include "llvm/IntrinsicsXCore.td"
450 include "llvm/IntrinsicsHexagon.td"
451 include "llvm/IntrinsicsNVVM.td"