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. If no property is set, the worst case
23 // is assumed (it may read and write any memory it can get access to and it may
24 // have other side effects).
26 // IntrNoMem - The intrinsic does not access memory or have any other side
27 // effects. It may be CSE'd deleted if dead, etc.
28 def IntrNoMem : IntrinsicProperty;
30 // IntrReadMem - This intrinsic only reads from memory. It does not write to
31 // memory and has no other side effects. Therefore, it cannot be moved across
32 // potentially aliasing stores. However, it can be reordered otherwise and can
33 // be deleted if dead.
34 def IntrReadMem : IntrinsicProperty;
36 // IntrWriteMem - This intrinsic only writes to memory, but does not read from
37 // memory, and has no other side effects. This means dead stores before calls
38 // to this intrinsics may be removed.
39 def IntrWriteMem : IntrinsicProperty;
41 // IntrArgMemOnly - This intrinsic only accesses memory that its pointer-typed
42 // argument(s) points to, but may access an unspecified amount. Other than
43 // reads from and (possibly volatile) writes to memory, it has no side effects.
44 def IntrArgMemOnly : IntrinsicProperty;
46 // IntrInaccessibleMemOnly -- This intrinsic only accesses memory that is not
47 // accessible by the module being compiled. This is a weaker form of IntrNoMem.
48 def IntrInaccessibleMemOnly : IntrinsicProperty;
50 // IntrInaccessibleMemOrArgMemOnly -- This intrinsic only accesses memory that
51 // its pointer-typed arguments point to or memory that is not accessible
52 // by the module being compiled. This is a weaker form of IntrArgMemOnly.
53 def IntrInaccessibleMemOrArgMemOnly : IntrinsicProperty;
55 // Commutative - This intrinsic is commutative: X op Y == Y op X.
56 def Commutative : IntrinsicProperty;
58 // Throws - This intrinsic can throw.
59 def Throws : IntrinsicProperty;
61 // NoCapture - The specified argument pointer is not captured by the intrinsic.
62 class NoCapture<int argNo> : IntrinsicProperty {
66 // Returned - The specified argument is always the return value of the
68 class Returned<int argNo> : IntrinsicProperty {
72 // ReadOnly - The specified argument pointer is not written to through the
73 // pointer by the intrinsic.
74 class ReadOnly<int argNo> : IntrinsicProperty {
78 // WriteOnly - The intrinsic does not read memory through the specified
80 class WriteOnly<int argNo> : IntrinsicProperty {
84 // ReadNone - The specified argument pointer is not dereferenced by the
86 class ReadNone<int argNo> : IntrinsicProperty {
90 def IntrNoReturn : IntrinsicProperty;
92 // IntrNoduplicate - Calls to this intrinsic cannot be duplicated.
93 // Parallels the noduplicate attribute on LLVM IR functions.
94 def IntrNoDuplicate : IntrinsicProperty;
96 // IntrConvergent - Calls to this intrinsic are convergent and may not be made
97 // control-dependent on any additional values.
98 // Parallels the convergent attribute on LLVM IR functions.
99 def IntrConvergent : IntrinsicProperty;
101 // This property indicates that the intrinsic is safe to speculate.
102 def IntrSpeculatable : IntrinsicProperty;
104 // This property can be used to override the 'has no other side effects'
105 // language of the IntrNoMem, IntrReadMem, IntrWriteMem, and IntrArgMemOnly
106 // intrinsic properties. By default, intrinsics are assumed to have side
107 // effects, so this property is only necessary if you have defined one of
108 // the memory properties listed above.
109 // For this property, 'side effects' has the same meaning as 'side effects'
110 // defined by the hasSideEffects property of the TableGen Instruction class.
111 def IntrHasSideEffects : IntrinsicProperty;
113 //===----------------------------------------------------------------------===//
114 // Types used by intrinsics.
115 //===----------------------------------------------------------------------===//
117 class LLVMType<ValueType vt> {
121 class LLVMQualPointerType<LLVMType elty, int addrspace>
123 LLVMType ElTy = elty;
124 int AddrSpace = addrspace;
127 class LLVMPointerType<LLVMType elty>
128 : LLVMQualPointerType<elty, 0>;
130 class LLVMAnyPointerType<LLVMType elty>
132 LLVMType ElTy = elty;
135 // Match the type of another intrinsic parameter. Number is an index into the
136 // list of overloaded types for the intrinsic, excluding all the fixed types.
137 // The Number value must refer to a previously listed type. For example:
138 // Intrinsic<[llvm_i32_ty], [llvm_i32_ty, llvm_anyfloat_ty, LLVMMatchType<0>]>
139 // has two overloaded types, the 2nd and 3rd arguments. LLVMMatchType<0>
140 // refers to the first overloaded type, which is the 2nd argument.
141 class LLVMMatchType<int num>
146 // Match the type of another intrinsic parameter that is expected to be based on
147 // an integral type (i.e. either iN or <N x iM>), but change the scalar size to
148 // be twice as wide or half as wide as the other type. This is only useful when
149 // the intrinsic is overloaded, so the matched type should be declared as iAny.
150 class LLVMExtendedType<int num> : LLVMMatchType<num>;
151 class LLVMTruncatedType<int num> : LLVMMatchType<num>;
152 class LLVMVectorSameWidth<int num, LLVMType elty>
153 : LLVMMatchType<num> {
154 ValueType ElTy = elty.VT;
156 class LLVMPointerTo<int num> : LLVMMatchType<num>;
157 class LLVMPointerToElt<int num> : LLVMMatchType<num>;
158 class LLVMVectorOfAnyPointersToElt<int num> : LLVMMatchType<num>;
160 // Match the type of another intrinsic parameter that is expected to be a
161 // vector type, but change the element count to be half as many
162 class LLVMHalfElementsVectorType<int num> : LLVMMatchType<num>;
164 def llvm_void_ty : LLVMType<isVoid>;
165 def llvm_any_ty : LLVMType<Any>;
166 def llvm_anyint_ty : LLVMType<iAny>;
167 def llvm_anyfloat_ty : LLVMType<fAny>;
168 def llvm_anyvector_ty : LLVMType<vAny>;
169 def llvm_i1_ty : LLVMType<i1>;
170 def llvm_i8_ty : LLVMType<i8>;
171 def llvm_i16_ty : LLVMType<i16>;
172 def llvm_i32_ty : LLVMType<i32>;
173 def llvm_i64_ty : LLVMType<i64>;
174 def llvm_half_ty : LLVMType<f16>;
175 def llvm_float_ty : LLVMType<f32>;
176 def llvm_double_ty : LLVMType<f64>;
177 def llvm_f80_ty : LLVMType<f80>;
178 def llvm_f128_ty : LLVMType<f128>;
179 def llvm_ppcf128_ty : LLVMType<ppcf128>;
180 def llvm_ptr_ty : LLVMPointerType<llvm_i8_ty>; // i8*
181 def llvm_ptrptr_ty : LLVMPointerType<llvm_ptr_ty>; // i8**
182 def llvm_anyptr_ty : LLVMAnyPointerType<llvm_i8_ty>; // (space)i8*
183 def llvm_empty_ty : LLVMType<OtherVT>; // { }
184 def llvm_descriptor_ty : LLVMPointerType<llvm_empty_ty>; // { }*
185 def llvm_metadata_ty : LLVMType<MetadataVT>; // !{...}
186 def llvm_token_ty : LLVMType<token>; // token
188 def llvm_x86mmx_ty : LLVMType<x86mmx>;
189 def llvm_ptrx86mmx_ty : LLVMPointerType<llvm_x86mmx_ty>; // <1 x i64>*
191 def llvm_v2i1_ty : LLVMType<v2i1>; // 2 x i1
192 def llvm_v4i1_ty : LLVMType<v4i1>; // 4 x i1
193 def llvm_v8i1_ty : LLVMType<v8i1>; // 8 x i1
194 def llvm_v16i1_ty : LLVMType<v16i1>; // 16 x i1
195 def llvm_v32i1_ty : LLVMType<v32i1>; // 32 x i1
196 def llvm_v64i1_ty : LLVMType<v64i1>; // 64 x i1
197 def llvm_v512i1_ty : LLVMType<v512i1>; // 512 x i1
198 def llvm_v1024i1_ty : LLVMType<v1024i1>; //1024 x i1
200 def llvm_v1i8_ty : LLVMType<v1i8>; // 1 x i8
201 def llvm_v2i8_ty : LLVMType<v2i8>; // 2 x i8
202 def llvm_v4i8_ty : LLVMType<v4i8>; // 4 x i8
203 def llvm_v8i8_ty : LLVMType<v8i8>; // 8 x i8
204 def llvm_v16i8_ty : LLVMType<v16i8>; // 16 x i8
205 def llvm_v32i8_ty : LLVMType<v32i8>; // 32 x i8
206 def llvm_v64i8_ty : LLVMType<v64i8>; // 64 x i8
207 def llvm_v128i8_ty : LLVMType<v128i8>; //128 x i8
208 def llvm_v256i8_ty : LLVMType<v256i8>; //256 x i8
210 def llvm_v1i16_ty : LLVMType<v1i16>; // 1 x i16
211 def llvm_v2i16_ty : LLVMType<v2i16>; // 2 x i16
212 def llvm_v4i16_ty : LLVMType<v4i16>; // 4 x i16
213 def llvm_v8i16_ty : LLVMType<v8i16>; // 8 x i16
214 def llvm_v16i16_ty : LLVMType<v16i16>; // 16 x i16
215 def llvm_v32i16_ty : LLVMType<v32i16>; // 32 x i16
216 def llvm_v64i16_ty : LLVMType<v64i16>; // 64 x i16
217 def llvm_v128i16_ty : LLVMType<v128i16>; //128 x i16
219 def llvm_v1i32_ty : LLVMType<v1i32>; // 1 x i32
220 def llvm_v2i32_ty : LLVMType<v2i32>; // 2 x i32
221 def llvm_v4i32_ty : LLVMType<v4i32>; // 4 x i32
222 def llvm_v8i32_ty : LLVMType<v8i32>; // 8 x i32
223 def llvm_v16i32_ty : LLVMType<v16i32>; // 16 x i32
224 def llvm_v32i32_ty : LLVMType<v32i32>; // 32 x i32
225 def llvm_v64i32_ty : LLVMType<v64i32>; // 64 x i32
227 def llvm_v1i64_ty : LLVMType<v1i64>; // 1 x i64
228 def llvm_v2i64_ty : LLVMType<v2i64>; // 2 x i64
229 def llvm_v4i64_ty : LLVMType<v4i64>; // 4 x i64
230 def llvm_v8i64_ty : LLVMType<v8i64>; // 8 x i64
231 def llvm_v16i64_ty : LLVMType<v16i64>; // 16 x i64
232 def llvm_v32i64_ty : LLVMType<v32i64>; // 32 x i64
234 def llvm_v1i128_ty : LLVMType<v1i128>; // 1 x i128
236 def llvm_v2f16_ty : LLVMType<v2f16>; // 2 x half (__fp16)
237 def llvm_v4f16_ty : LLVMType<v4f16>; // 4 x half (__fp16)
238 def llvm_v8f16_ty : LLVMType<v8f16>; // 8 x half (__fp16)
239 def llvm_v1f32_ty : LLVMType<v1f32>; // 1 x float
240 def llvm_v2f32_ty : LLVMType<v2f32>; // 2 x float
241 def llvm_v4f32_ty : LLVMType<v4f32>; // 4 x float
242 def llvm_v8f32_ty : LLVMType<v8f32>; // 8 x float
243 def llvm_v16f32_ty : LLVMType<v16f32>; // 16 x float
244 def llvm_v1f64_ty : LLVMType<v1f64>; // 1 x double
245 def llvm_v2f64_ty : LLVMType<v2f64>; // 2 x double
246 def llvm_v4f64_ty : LLVMType<v4f64>; // 4 x double
247 def llvm_v8f64_ty : LLVMType<v8f64>; // 8 x double
249 def llvm_vararg_ty : LLVMType<isVoid>; // this means vararg here
252 //===----------------------------------------------------------------------===//
253 // Intrinsic Definitions.
254 //===----------------------------------------------------------------------===//
256 // Intrinsic class - This is used to define one LLVM intrinsic. The name of the
257 // intrinsic definition should start with "int_", then match the LLVM intrinsic
258 // name with the "llvm." prefix removed, and all "."s turned into "_"s. For
259 // example, llvm.bswap.i16 -> int_bswap_i16.
261 // * RetTypes is a list containing the return types expected for the
263 // * ParamTypes is a list containing the parameter types expected for the
265 // * Properties can be set to describe the behavior of the intrinsic.
267 class SDPatternOperator;
268 class Intrinsic<list<LLVMType> ret_types,
269 list<LLVMType> param_types = [],
270 list<IntrinsicProperty> properties = [],
271 string name = ""> : SDPatternOperator {
272 string LLVMName = name;
273 string TargetPrefix = ""; // Set to a prefix for target-specific intrinsics.
274 list<LLVMType> RetTypes = ret_types;
275 list<LLVMType> ParamTypes = param_types;
276 list<IntrinsicProperty> IntrProperties = properties;
281 /// GCCBuiltin - If this intrinsic exactly corresponds to a GCC builtin, this
282 /// specifies the name of the builtin. This provides automatic CBE and CFE
284 class GCCBuiltin<string name> {
285 string GCCBuiltinName = name;
288 class MSBuiltin<string name> {
289 string MSBuiltinName = name;
293 //===--------------- Variable Argument Handling Intrinsics ----------------===//
296 def int_vastart : Intrinsic<[], [llvm_ptr_ty], [], "llvm.va_start">;
297 def int_vacopy : Intrinsic<[], [llvm_ptr_ty, llvm_ptr_ty], [],
299 def int_vaend : Intrinsic<[], [llvm_ptr_ty], [], "llvm.va_end">;
301 //===------------------- Garbage Collection Intrinsics --------------------===//
303 def int_gcroot : Intrinsic<[],
304 [llvm_ptrptr_ty, llvm_ptr_ty]>;
305 def int_gcread : Intrinsic<[llvm_ptr_ty],
306 [llvm_ptr_ty, llvm_ptrptr_ty],
307 [IntrReadMem, IntrArgMemOnly]>;
308 def int_gcwrite : Intrinsic<[],
309 [llvm_ptr_ty, llvm_ptr_ty, llvm_ptrptr_ty],
310 [IntrArgMemOnly, NoCapture<1>, NoCapture<2>]>;
312 //===--------------------- Code Generator Intrinsics ----------------------===//
314 def int_returnaddress : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty], [IntrNoMem]>;
315 def int_addressofreturnaddress : Intrinsic<[llvm_ptr_ty], [], [IntrNoMem]>;
316 def int_frameaddress : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty], [IntrNoMem]>;
317 def int_read_register : Intrinsic<[llvm_anyint_ty], [llvm_metadata_ty],
318 [IntrReadMem], "llvm.read_register">;
319 def int_write_register : Intrinsic<[], [llvm_metadata_ty, llvm_anyint_ty],
320 [], "llvm.write_register">;
322 // Gets the address of the local variable area. This is typically a copy of the
323 // stack, frame, or base pointer depending on the type of prologue.
324 def int_localaddress : Intrinsic<[llvm_ptr_ty], [], [IntrNoMem]>;
326 // Escapes local variables to allow access from other functions.
327 def int_localescape : Intrinsic<[], [llvm_vararg_ty]>;
329 // Given a function and the localaddress of a parent frame, returns a pointer
330 // to an escaped allocation indicated by the index.
331 def int_localrecover : Intrinsic<[llvm_ptr_ty],
332 [llvm_ptr_ty, llvm_ptr_ty, llvm_i32_ty],
334 // Note: we treat stacksave/stackrestore as writemem because we don't otherwise
335 // model their dependencies on allocas.
336 def int_stacksave : Intrinsic<[llvm_ptr_ty]>,
337 GCCBuiltin<"__builtin_stack_save">;
338 def int_stackrestore : Intrinsic<[], [llvm_ptr_ty]>,
339 GCCBuiltin<"__builtin_stack_restore">;
341 def int_get_dynamic_area_offset : Intrinsic<[llvm_anyint_ty]>;
343 def int_thread_pointer : Intrinsic<[llvm_ptr_ty], [], [IntrNoMem]>,
344 GCCBuiltin<"__builtin_thread_pointer">;
346 // IntrInaccessibleMemOrArgMemOnly is a little more pessimistic than strictly
347 // necessary for prefetch, however it does conveniently prevent the prefetch
348 // from being reordered overly much with respect to nearby access to the same
349 // memory while not impeding optimization.
351 : Intrinsic<[], [ llvm_ptr_ty, llvm_i32_ty, llvm_i32_ty, llvm_i32_ty ],
352 [ IntrInaccessibleMemOrArgMemOnly, ReadOnly<0>, NoCapture<0> ]>;
353 def int_pcmarker : Intrinsic<[], [llvm_i32_ty]>;
355 def int_readcyclecounter : Intrinsic<[llvm_i64_ty]>;
357 // The assume intrinsic is marked as arbitrarily writing so that proper
358 // control dependencies will be maintained.
359 def int_assume : Intrinsic<[], [llvm_i1_ty], []>;
361 // Stack Protector Intrinsic - The stackprotector intrinsic writes the stack
362 // guard to the correct place on the stack frame.
363 def int_stackprotector : Intrinsic<[], [llvm_ptr_ty, llvm_ptrptr_ty], []>;
364 def int_stackguard : Intrinsic<[llvm_ptr_ty], [], []>;
366 // A counter increment for instrumentation based profiling.
367 def int_instrprof_increment : Intrinsic<[],
368 [llvm_ptr_ty, llvm_i64_ty,
369 llvm_i32_ty, llvm_i32_ty],
372 // A counter increment with step for instrumentation based profiling.
373 def int_instrprof_increment_step : Intrinsic<[],
374 [llvm_ptr_ty, llvm_i64_ty,
375 llvm_i32_ty, llvm_i32_ty, llvm_i64_ty],
378 // A call to profile runtime for value profiling of target expressions
379 // through instrumentation based profiling.
380 def int_instrprof_value_profile : Intrinsic<[],
381 [llvm_ptr_ty, llvm_i64_ty,
382 llvm_i64_ty, llvm_i32_ty,
386 //===------------------- Standard C Library Intrinsics --------------------===//
389 def int_memcpy : Intrinsic<[],
390 [llvm_anyptr_ty, llvm_anyptr_ty, llvm_anyint_ty,
391 llvm_i32_ty, llvm_i1_ty],
392 [IntrArgMemOnly, NoCapture<0>, NoCapture<1>,
393 WriteOnly<0>, ReadOnly<1>]>;
394 def int_memmove : Intrinsic<[],
395 [llvm_anyptr_ty, llvm_anyptr_ty, llvm_anyint_ty,
396 llvm_i32_ty, llvm_i1_ty],
397 [IntrArgMemOnly, NoCapture<0>, NoCapture<1>,
399 def int_memset : Intrinsic<[],
400 [llvm_anyptr_ty, llvm_i8_ty, llvm_anyint_ty,
401 llvm_i32_ty, llvm_i1_ty],
402 [IntrArgMemOnly, NoCapture<0>, WriteOnly<0>]>;
404 // FIXME: Add version of these floating point intrinsics which allow non-default
405 // rounding modes and FP exception handling.
407 let IntrProperties = [IntrNoMem, IntrSpeculatable] in {
408 def int_fma : Intrinsic<[llvm_anyfloat_ty],
409 [LLVMMatchType<0>, LLVMMatchType<0>,
411 def int_fmuladd : Intrinsic<[llvm_anyfloat_ty],
412 [LLVMMatchType<0>, LLVMMatchType<0>,
415 // These functions do not read memory, but are sensitive to the
416 // rounding mode. LLVM purposely does not model changes to the FP
417 // environment so they can be treated as readnone.
418 def int_sqrt : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
419 def int_powi : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>, llvm_i32_ty]>;
420 def int_sin : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
421 def int_cos : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
422 def int_pow : Intrinsic<[llvm_anyfloat_ty],
423 [LLVMMatchType<0>, LLVMMatchType<0>]>;
424 def int_log : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
425 def int_log10: Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
426 def int_log2 : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
427 def int_exp : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
428 def int_exp2 : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
429 def int_fabs : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
430 def int_copysign : Intrinsic<[llvm_anyfloat_ty],
431 [LLVMMatchType<0>, LLVMMatchType<0>]>;
432 def int_floor : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
433 def int_ceil : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
434 def int_trunc : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
435 def int_rint : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
436 def int_nearbyint : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
437 def int_round : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
438 def int_canonicalize : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>],
442 def int_minnum : Intrinsic<[llvm_anyfloat_ty],
443 [LLVMMatchType<0>, LLVMMatchType<0>],
444 [IntrNoMem, IntrSpeculatable, Commutative]
446 def int_maxnum : Intrinsic<[llvm_anyfloat_ty],
447 [LLVMMatchType<0>, LLVMMatchType<0>],
448 [IntrNoMem, IntrSpeculatable, Commutative]
451 // NOTE: these are internal interfaces.
452 def int_setjmp : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty]>;
453 def int_longjmp : Intrinsic<[], [llvm_ptr_ty, llvm_i32_ty], [IntrNoReturn]>;
454 def int_sigsetjmp : Intrinsic<[llvm_i32_ty] , [llvm_ptr_ty, llvm_i32_ty]>;
455 def int_siglongjmp : Intrinsic<[], [llvm_ptr_ty, llvm_i32_ty], [IntrNoReturn]>;
457 // Internal interface for object size checking
458 def int_objectsize : Intrinsic<[llvm_anyint_ty],
459 [llvm_anyptr_ty, llvm_i1_ty, llvm_i1_ty],
460 [IntrNoMem, IntrSpeculatable]>,
461 GCCBuiltin<"__builtin_object_size">;
463 //===--------------- Constrained Floating Point Intrinsics ----------------===//
466 let IntrProperties = [IntrInaccessibleMemOnly] in {
467 def int_experimental_constrained_fadd : Intrinsic<[ llvm_anyfloat_ty ],
472 def int_experimental_constrained_fsub : Intrinsic<[ llvm_anyfloat_ty ],
477 def int_experimental_constrained_fmul : Intrinsic<[ llvm_anyfloat_ty ],
482 def int_experimental_constrained_fdiv : Intrinsic<[ llvm_anyfloat_ty ],
487 def int_experimental_constrained_frem : Intrinsic<[ llvm_anyfloat_ty ],
493 def int_experimental_constrained_fma : Intrinsic<[ llvm_anyfloat_ty ],
500 // These intrinsics are sensitive to the rounding mode so we need constrained
501 // versions of each of them. When strict rounding and exception control are
502 // not required the non-constrained versions of these intrinsics should be
504 def int_experimental_constrained_sqrt : Intrinsic<[ llvm_anyfloat_ty ],
508 def int_experimental_constrained_powi : Intrinsic<[ llvm_anyfloat_ty ],
513 def int_experimental_constrained_sin : Intrinsic<[ llvm_anyfloat_ty ],
517 def int_experimental_constrained_cos : Intrinsic<[ llvm_anyfloat_ty ],
521 def int_experimental_constrained_pow : Intrinsic<[ llvm_anyfloat_ty ],
526 def int_experimental_constrained_log : Intrinsic<[ llvm_anyfloat_ty ],
530 def int_experimental_constrained_log10: Intrinsic<[ llvm_anyfloat_ty ],
534 def int_experimental_constrained_log2 : Intrinsic<[ llvm_anyfloat_ty ],
538 def int_experimental_constrained_exp : Intrinsic<[ llvm_anyfloat_ty ],
542 def int_experimental_constrained_exp2 : Intrinsic<[ llvm_anyfloat_ty ],
546 def int_experimental_constrained_rint : Intrinsic<[ llvm_anyfloat_ty ],
550 def int_experimental_constrained_nearbyint : Intrinsic<[ llvm_anyfloat_ty ],
555 // FIXME: Add intrinsics for fcmp, fptrunc, fpext, fptoui and fptosi.
556 // FIXME: Add intrinsics for fabs, copysign, floor, ceil, trunc and round?
559 //===------------------------- Expect Intrinsics --------------------------===//
561 def int_expect : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>,
562 LLVMMatchType<0>], [IntrNoMem]>;
564 //===-------------------- Bit Manipulation Intrinsics ---------------------===//
567 // None of these intrinsics accesses memory at all.
568 let IntrProperties = [IntrNoMem, IntrSpeculatable] in {
569 def int_bswap: Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
570 def int_ctpop: Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
571 def int_ctlz : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>, llvm_i1_ty]>;
572 def int_cttz : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>, llvm_i1_ty]>;
573 def int_bitreverse : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
576 //===------------------------ Debugger Intrinsics -------------------------===//
579 // None of these intrinsics accesses memory at all...but that doesn't
580 // mean the optimizers can change them aggressively. Special handling
581 // needed in a few places. These synthetic intrinsics have no
582 // side-effects and just mark information about their operands.
583 let IntrProperties = [IntrNoMem, IntrSpeculatable] in {
584 def int_dbg_declare : Intrinsic<[],
588 def int_dbg_value : Intrinsic<[],
592 def int_dbg_addr : Intrinsic<[],
598 //===------------------ Exception Handling Intrinsics----------------------===//
601 // The result of eh.typeid.for depends on the enclosing function, but inside a
602 // given function it is 'const' and may be CSE'd etc.
603 def int_eh_typeid_for : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty], [IntrNoMem]>;
605 def int_eh_return_i32 : Intrinsic<[], [llvm_i32_ty, llvm_ptr_ty]>;
606 def int_eh_return_i64 : Intrinsic<[], [llvm_i64_ty, llvm_ptr_ty]>;
608 // eh.exceptionpointer returns the pointer to the exception caught by
609 // the given `catchpad`.
610 def int_eh_exceptionpointer : Intrinsic<[llvm_anyptr_ty], [llvm_token_ty],
613 // Gets the exception code from a catchpad token. Only used on some platforms.
614 def int_eh_exceptioncode : Intrinsic<[llvm_i32_ty], [llvm_token_ty], [IntrNoMem]>;
616 // __builtin_unwind_init is an undocumented GCC intrinsic that causes all
617 // callee-saved registers to be saved and restored (regardless of whether they
618 // are used) in the calling function. It is used by libgcc_eh.
619 def int_eh_unwind_init: Intrinsic<[]>,
620 GCCBuiltin<"__builtin_unwind_init">;
622 def int_eh_dwarf_cfa : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty]>;
624 let IntrProperties = [IntrNoMem] in {
625 def int_eh_sjlj_lsda : Intrinsic<[llvm_ptr_ty]>;
626 def int_eh_sjlj_callsite : Intrinsic<[], [llvm_i32_ty]>;
628 def int_eh_sjlj_functioncontext : Intrinsic<[], [llvm_ptr_ty]>;
629 def int_eh_sjlj_setjmp : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty]>;
630 def int_eh_sjlj_longjmp : Intrinsic<[], [llvm_ptr_ty], [IntrNoReturn]>;
631 def int_eh_sjlj_setup_dispatch : Intrinsic<[], []>;
633 //===---------------- Generic Variable Attribute Intrinsics----------------===//
635 def int_var_annotation : Intrinsic<[],
636 [llvm_ptr_ty, llvm_ptr_ty,
637 llvm_ptr_ty, llvm_i32_ty],
638 [], "llvm.var.annotation">;
639 def int_ptr_annotation : Intrinsic<[LLVMAnyPointerType<llvm_anyint_ty>],
640 [LLVMMatchType<0>, llvm_ptr_ty, llvm_ptr_ty,
642 [], "llvm.ptr.annotation">;
643 def int_annotation : Intrinsic<[llvm_anyint_ty],
644 [LLVMMatchType<0>, llvm_ptr_ty,
645 llvm_ptr_ty, llvm_i32_ty],
646 [], "llvm.annotation">;
648 // Annotates the current program point with metadata strings which are emitted
649 // as CodeView debug info records. This is expensive, as it disables inlining
650 // and is modelled as having side effects.
651 def int_codeview_annotation : Intrinsic<[], [llvm_metadata_ty],
652 [IntrInaccessibleMemOnly, IntrNoDuplicate],
653 "llvm.codeview.annotation">;
655 //===------------------------ Trampoline Intrinsics -----------------------===//
657 def int_init_trampoline : Intrinsic<[],
658 [llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty],
659 [IntrArgMemOnly, NoCapture<0>]>,
660 GCCBuiltin<"__builtin_init_trampoline">;
662 def int_adjust_trampoline : Intrinsic<[llvm_ptr_ty], [llvm_ptr_ty],
663 [IntrReadMem, IntrArgMemOnly]>,
664 GCCBuiltin<"__builtin_adjust_trampoline">;
666 //===------------------------ Overflow Intrinsics -------------------------===//
669 // Expose the carry flag from add operations on two integrals.
670 def int_sadd_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
671 [LLVMMatchType<0>, LLVMMatchType<0>],
672 [IntrNoMem, IntrSpeculatable]>;
673 def int_uadd_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
674 [LLVMMatchType<0>, LLVMMatchType<0>],
675 [IntrNoMem, IntrSpeculatable]>;
677 def int_ssub_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
678 [LLVMMatchType<0>, LLVMMatchType<0>],
679 [IntrNoMem, IntrSpeculatable]>;
680 def int_usub_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
681 [LLVMMatchType<0>, LLVMMatchType<0>],
682 [IntrNoMem, IntrSpeculatable]>;
684 def int_smul_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
685 [LLVMMatchType<0>, LLVMMatchType<0>],
686 [IntrNoMem, IntrSpeculatable]>;
687 def int_umul_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
688 [LLVMMatchType<0>, LLVMMatchType<0>],
689 [IntrNoMem, IntrSpeculatable]>;
691 //===------------------------- Memory Use Markers -------------------------===//
693 def int_lifetime_start : Intrinsic<[],
694 [llvm_i64_ty, llvm_anyptr_ty],
695 [IntrArgMemOnly, NoCapture<1>]>;
696 def int_lifetime_end : Intrinsic<[],
697 [llvm_i64_ty, llvm_anyptr_ty],
698 [IntrArgMemOnly, NoCapture<1>]>;
699 def int_invariant_start : Intrinsic<[llvm_descriptor_ty],
700 [llvm_i64_ty, llvm_anyptr_ty],
701 [IntrArgMemOnly, NoCapture<1>]>;
702 def int_invariant_end : Intrinsic<[],
703 [llvm_descriptor_ty, llvm_i64_ty,
705 [IntrArgMemOnly, NoCapture<2>]>;
707 // invariant.group.barrier can't be marked with 'readnone' (IntrNoMem),
708 // because it would cause CSE of two barriers with the same argument.
709 // Readonly and argmemonly says that barrier only reads its argument and
710 // it can be CSE only if memory didn't change between 2 barriers call,
712 // The argument also can't be marked with 'returned' attribute, because
713 // it would remove barrier.
714 def int_invariant_group_barrier : Intrinsic<[llvm_anyptr_ty],
716 [IntrReadMem, IntrArgMemOnly]>;
718 //===------------------------ Stackmap Intrinsics -------------------------===//
720 def int_experimental_stackmap : Intrinsic<[],
721 [llvm_i64_ty, llvm_i32_ty, llvm_vararg_ty],
723 def int_experimental_patchpoint_void : Intrinsic<[],
724 [llvm_i64_ty, llvm_i32_ty,
725 llvm_ptr_ty, llvm_i32_ty,
728 def int_experimental_patchpoint_i64 : Intrinsic<[llvm_i64_ty],
729 [llvm_i64_ty, llvm_i32_ty,
730 llvm_ptr_ty, llvm_i32_ty,
735 //===------------------------ Garbage Collection Intrinsics ---------------===//
736 // These are documented in docs/Statepoint.rst
738 def int_experimental_gc_statepoint : Intrinsic<[llvm_token_ty],
739 [llvm_i64_ty, llvm_i32_ty,
740 llvm_anyptr_ty, llvm_i32_ty,
741 llvm_i32_ty, llvm_vararg_ty],
744 def int_experimental_gc_result : Intrinsic<[llvm_any_ty], [llvm_token_ty],
746 def int_experimental_gc_relocate : Intrinsic<[llvm_any_ty],
747 [llvm_token_ty, llvm_i32_ty, llvm_i32_ty],
750 //===------------------------ Coroutine Intrinsics ---------------===//
751 // These are documented in docs/Coroutines.rst
753 // Coroutine Structure Intrinsics.
755 def int_coro_id : Intrinsic<[llvm_token_ty], [llvm_i32_ty, llvm_ptr_ty,
756 llvm_ptr_ty, llvm_ptr_ty],
757 [IntrArgMemOnly, IntrReadMem,
758 ReadNone<1>, ReadOnly<2>, NoCapture<2>]>;
759 def int_coro_alloc : Intrinsic<[llvm_i1_ty], [llvm_token_ty], []>;
760 def int_coro_begin : Intrinsic<[llvm_ptr_ty], [llvm_token_ty, llvm_ptr_ty],
763 def int_coro_free : Intrinsic<[llvm_ptr_ty], [llvm_token_ty, llvm_ptr_ty],
764 [IntrReadMem, IntrArgMemOnly, ReadOnly<1>,
766 def int_coro_end : Intrinsic<[llvm_i1_ty], [llvm_ptr_ty, llvm_i1_ty], []>;
768 def int_coro_frame : Intrinsic<[llvm_ptr_ty], [], [IntrNoMem]>;
769 def int_coro_size : Intrinsic<[llvm_anyint_ty], [], [IntrNoMem]>;
771 def int_coro_save : Intrinsic<[llvm_token_ty], [llvm_ptr_ty], []>;
772 def int_coro_suspend : Intrinsic<[llvm_i8_ty], [llvm_token_ty, llvm_i1_ty], []>;
774 def int_coro_param : Intrinsic<[llvm_i1_ty], [llvm_ptr_ty, llvm_ptr_ty],
775 [IntrNoMem, ReadNone<0>, ReadNone<1>]>;
777 // Coroutine Manipulation Intrinsics.
779 def int_coro_resume : Intrinsic<[], [llvm_ptr_ty], [Throws]>;
780 def int_coro_destroy : Intrinsic<[], [llvm_ptr_ty], [Throws]>;
781 def int_coro_done : Intrinsic<[llvm_i1_ty], [llvm_ptr_ty],
782 [IntrArgMemOnly, ReadOnly<0>, NoCapture<0>]>;
783 def int_coro_promise : Intrinsic<[llvm_ptr_ty],
784 [llvm_ptr_ty, llvm_i32_ty, llvm_i1_ty],
785 [IntrNoMem, NoCapture<0>]>;
787 // Coroutine Lowering Intrinsics. Used internally by coroutine passes.
789 def int_coro_subfn_addr : Intrinsic<[llvm_ptr_ty], [llvm_ptr_ty, llvm_i8_ty],
790 [IntrReadMem, IntrArgMemOnly, ReadOnly<0>,
793 ///===-------------------------- Other Intrinsics --------------------------===//
795 def int_flt_rounds : Intrinsic<[llvm_i32_ty]>,
796 GCCBuiltin<"__builtin_flt_rounds">;
797 def int_trap : Intrinsic<[], [], [IntrNoReturn]>,
798 GCCBuiltin<"__builtin_trap">;
799 def int_debugtrap : Intrinsic<[]>,
800 GCCBuiltin<"__builtin_debugtrap">;
802 // Support for dynamic deoptimization (or de-specialization)
803 def int_experimental_deoptimize : Intrinsic<[llvm_any_ty], [llvm_vararg_ty],
806 // Support for speculative runtime guards
807 def int_experimental_guard : Intrinsic<[], [llvm_i1_ty, llvm_vararg_ty],
810 // NOP: calls/invokes to this intrinsic are removed by codegen
811 def int_donothing : Intrinsic<[], [], [IntrNoMem]>;
813 // This instruction has no actual effect, though it is treated by the optimizer
814 // has having opaque side effects. This may be inserted into loops to ensure
815 // that they are not removed even if they turn out to be empty, for languages
816 // which specify that infinite loops must be preserved.
817 def int_sideeffect : Intrinsic<[], [], [IntrInaccessibleMemOnly]>;
819 // Intrisics to support half precision floating point format
820 let IntrProperties = [IntrNoMem] in {
821 def int_convert_to_fp16 : Intrinsic<[llvm_i16_ty], [llvm_anyfloat_ty]>;
822 def int_convert_from_fp16 : Intrinsic<[llvm_anyfloat_ty], [llvm_i16_ty]>;
825 // Clear cache intrinsic, default to ignore (ie. emit nothing)
826 // maps to void __clear_cache() on supporting platforms
827 def int_clear_cache : Intrinsic<[], [llvm_ptr_ty, llvm_ptr_ty],
828 [], "llvm.clear_cache">;
830 //===-------------------------- Masked Intrinsics -------------------------===//
832 def int_masked_store : Intrinsic<[], [llvm_anyvector_ty,
833 LLVMAnyPointerType<LLVMMatchType<0>>,
835 LLVMVectorSameWidth<0, llvm_i1_ty>],
838 def int_masked_load : Intrinsic<[llvm_anyvector_ty],
839 [LLVMAnyPointerType<LLVMMatchType<0>>, llvm_i32_ty,
840 LLVMVectorSameWidth<0, llvm_i1_ty>, LLVMMatchType<0>],
841 [IntrReadMem, IntrArgMemOnly]>;
843 def int_masked_gather: Intrinsic<[llvm_anyvector_ty],
844 [LLVMVectorOfAnyPointersToElt<0>, llvm_i32_ty,
845 LLVMVectorSameWidth<0, llvm_i1_ty>,
849 def int_masked_scatter: Intrinsic<[],
851 LLVMVectorOfAnyPointersToElt<0>, llvm_i32_ty,
852 LLVMVectorSameWidth<0, llvm_i1_ty>]>;
854 def int_masked_expandload: Intrinsic<[llvm_anyvector_ty],
855 [LLVMPointerToElt<0>,
856 LLVMVectorSameWidth<0, llvm_i1_ty>,
860 def int_masked_compressstore: Intrinsic<[],
863 LLVMVectorSameWidth<0, llvm_i1_ty>],
866 // Test whether a pointer is associated with a type metadata identifier.
867 def int_type_test : Intrinsic<[llvm_i1_ty], [llvm_ptr_ty, llvm_metadata_ty],
870 // Safely loads a function pointer from a virtual table pointer using type metadata.
871 def int_type_checked_load : Intrinsic<[llvm_ptr_ty, llvm_i1_ty],
872 [llvm_ptr_ty, llvm_i32_ty, llvm_metadata_ty],
875 def int_load_relative: Intrinsic<[llvm_ptr_ty], [llvm_ptr_ty, llvm_anyint_ty],
876 [IntrReadMem, IntrArgMemOnly]>;
879 //===----------------------------------------------------------------------===//
880 // Custom event logging for x-ray.
881 // Takes a pointer to a string and the length of the string.
882 def int_xray_customevent : Intrinsic<[], [llvm_ptr_ty, llvm_i32_ty],
883 [NoCapture<0>, ReadOnly<0>, IntrWriteMem]>;
884 //===----------------------------------------------------------------------===//
886 //===------ Memory intrinsics with element-wise atomicity guarantees ------===//
889 // @llvm.memcpy.element.unordered.atomic.*(dest, src, length, elementsize)
890 def int_memcpy_element_unordered_atomic
893 llvm_anyptr_ty, llvm_anyptr_ty, llvm_anyint_ty, llvm_i32_ty
896 IntrArgMemOnly, NoCapture<0>, NoCapture<1>, WriteOnly<0>,
900 // @llvm.memmove.element.unordered.atomic.*(dest, src, length, elementsize)
901 def int_memmove_element_unordered_atomic
904 llvm_anyptr_ty, llvm_anyptr_ty, llvm_anyint_ty, llvm_i32_ty
907 IntrArgMemOnly, NoCapture<0>, NoCapture<1>, WriteOnly<0>,
911 // @llvm.memset.element.unordered.atomic.*(dest, value, length, elementsize)
912 def int_memset_element_unordered_atomic
913 : Intrinsic<[], [ llvm_anyptr_ty, llvm_i8_ty, llvm_anyint_ty, llvm_i32_ty ],
914 [ IntrArgMemOnly, NoCapture<0>, WriteOnly<0> ]>;
916 //===------------------------ Reduction Intrinsics ------------------------===//
918 def int_experimental_vector_reduce_fadd : Intrinsic<[llvm_anyfloat_ty],
922 def int_experimental_vector_reduce_fmul : Intrinsic<[llvm_anyfloat_ty],
926 def int_experimental_vector_reduce_add : Intrinsic<[llvm_anyint_ty],
929 def int_experimental_vector_reduce_mul : Intrinsic<[llvm_anyint_ty],
932 def int_experimental_vector_reduce_and : Intrinsic<[llvm_anyint_ty],
935 def int_experimental_vector_reduce_or : Intrinsic<[llvm_anyint_ty],
938 def int_experimental_vector_reduce_xor : Intrinsic<[llvm_anyint_ty],
941 def int_experimental_vector_reduce_smax : Intrinsic<[llvm_anyint_ty],
944 def int_experimental_vector_reduce_smin : Intrinsic<[llvm_anyint_ty],
947 def int_experimental_vector_reduce_umax : Intrinsic<[llvm_anyint_ty],
950 def int_experimental_vector_reduce_umin : Intrinsic<[llvm_anyint_ty],
953 def int_experimental_vector_reduce_fmax : Intrinsic<[llvm_anyfloat_ty],
956 def int_experimental_vector_reduce_fmin : Intrinsic<[llvm_anyfloat_ty],
960 //===----- Intrinsics that are used to provide predicate information -----===//
962 def int_ssa_copy : Intrinsic<[llvm_any_ty], [LLVMMatchType<0>],
963 [IntrNoMem, Returned<0>]>;
964 //===----------------------------------------------------------------------===//
965 // Target-specific intrinsics
966 //===----------------------------------------------------------------------===//
968 include "llvm/IR/IntrinsicsPowerPC.td"
969 include "llvm/IR/IntrinsicsX86.td"
970 include "llvm/IR/IntrinsicsARM.td"
971 include "llvm/IR/IntrinsicsAArch64.td"
972 include "llvm/IR/IntrinsicsXCore.td"
973 include "llvm/IR/IntrinsicsHexagon.td"
974 include "llvm/IR/IntrinsicsNVVM.td"
975 include "llvm/IR/IntrinsicsMips.td"
976 include "llvm/IR/IntrinsicsAMDGPU.td"
977 include "llvm/IR/IntrinsicsBPF.td"
978 include "llvm/IR/IntrinsicsSystemZ.td"
979 include "llvm/IR/IntrinsicsWebAssembly.td"