1//===- Intrinsics.td - Defines all LLVM intrinsics ---------*- tablegen -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file defines properties of all LLVM intrinsics.
11//
12//===----------------------------------------------------------------------===//
13
14include "llvm/CodeGen/ValueTypes.td"
15
16//===----------------------------------------------------------------------===//
17//  Properties we keep track of for intrinsics.
18//===----------------------------------------------------------------------===//
19
20class IntrinsicProperty;
21
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).
27
28// IntrNoMem - The intrinsic does not access memory or have any other side
29// effects.  It may be CSE'd deleted if dead, etc.
30def IntrNoMem : IntrinsicProperty;
31
32// IntrReadArgMem - This intrinsic reads only from memory that one of its
33// pointer-typed arguments points to, but may read an unspecified amount.
34def IntrReadArgMem : IntrinsicProperty;
35
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
38// deleted if dead.
39def IntrReadMem : IntrinsicProperty;
40
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
44// effects.
45def IntrReadWriteArgMem : IntrinsicProperty;
46
47// Commutative - This intrinsic is commutative: X op Y == Y op X.
48def Commutative : IntrinsicProperty;
49
50// Throws - This intrinsic can throw.
51def Throws : IntrinsicProperty;
52
53// NoCapture - The specified argument pointer is not captured by the intrinsic.
54class NoCapture<int argNo> : IntrinsicProperty {
55  int ArgNo = argNo;
56}
57
58// ReadOnly - The specified argument pointer is not written to through the
59// pointer by the intrinsic.
60class ReadOnly<int argNo> : IntrinsicProperty {
61  int ArgNo = argNo;
62}
63
64// ReadNone - The specified argument pointer is not dereferenced by the
65// intrinsic.
66class ReadNone<int argNo> : IntrinsicProperty {
67  int ArgNo = argNo;
68}
69
70def IntrNoReturn : IntrinsicProperty;
71
72// IntrNoduplicate - Calls to this intrinsic cannot be duplicated.
73// Parallels the noduplicate attribute on LLVM IR functions.
74def IntrNoDuplicate : IntrinsicProperty;
75
76// IntrConvergent - Calls to this intrinsic are convergent and may not be made
77// control-dependent on any additional values.
78// Parallels the convergent attribute on LLVM IR functions.
79def IntrConvergent : IntrinsicProperty;
80
81//===----------------------------------------------------------------------===//
82// Types used by intrinsics.
83//===----------------------------------------------------------------------===//
84
85class LLVMType<ValueType vt> {
86  ValueType VT = vt;
87}
88
89class LLVMQualPointerType<LLVMType elty, int addrspace>
90  : LLVMType<iPTR>{
91  LLVMType ElTy = elty;
92  int AddrSpace = addrspace;
93}
94
95class LLVMPointerType<LLVMType elty>
96  : LLVMQualPointerType<elty, 0>;
97
98class LLVMAnyPointerType<LLVMType elty>
99  : LLVMType<iPTRAny>{
100  LLVMType ElTy = elty;
101}
102
103// Match the type of another intrinsic parameter.  Number is an index into the
104// list of overloaded types for the intrinsic, excluding all the fixed types.
105// The Number value must refer to a previously listed type.  For example:
106//   Intrinsic<[llvm_i32_ty], [llvm_i32_ty, llvm_anyfloat_ty, LLVMMatchType<0>]>
107// has two overloaded types, the 2nd and 3rd arguments.  LLVMMatchType<0>
108// refers to the first overloaded type, which is the 2nd argument.
109class LLVMMatchType<int num>
110  : LLVMType<OtherVT>{
111  int Number = num;
112}
113
114// Match the type of another intrinsic parameter that is expected to be based on
115// an integral type (i.e. either iN or <N x iM>), but change the scalar size to
116// be twice as wide or half as wide as the other type.  This is only useful when
117// the intrinsic is overloaded, so the matched type should be declared as iAny.
118class LLVMExtendedType<int num> : LLVMMatchType<num>;
119class LLVMTruncatedType<int num> : LLVMMatchType<num>;
120class LLVMVectorSameWidth<int num, LLVMType elty>
121  : LLVMMatchType<num> {
122  ValueType ElTy = elty.VT;
123}
124class LLVMPointerTo<int num> : LLVMMatchType<num>;
125class LLVMVectorOfPointersToElt<int num> : LLVMMatchType<num>;
126
127// Match the type of another intrinsic parameter that is expected to be a
128// vector type, but change the element count to be half as many
129class LLVMHalfElementsVectorType<int num> : LLVMMatchType<num>;
130
131def llvm_void_ty       : LLVMType<isVoid>;
132def llvm_any_ty        : LLVMType<Any>;
133def llvm_anyint_ty     : LLVMType<iAny>;
134def llvm_anyfloat_ty   : LLVMType<fAny>;
135def llvm_anyvector_ty  : LLVMType<vAny>;
136def llvm_i1_ty         : LLVMType<i1>;
137def llvm_i8_ty         : LLVMType<i8>;
138def llvm_i16_ty        : LLVMType<i16>;
139def llvm_i32_ty        : LLVMType<i32>;
140def llvm_i64_ty        : LLVMType<i64>;
141def llvm_half_ty       : LLVMType<f16>;
142def llvm_float_ty      : LLVMType<f32>;
143def llvm_double_ty     : LLVMType<f64>;
144def llvm_f80_ty        : LLVMType<f80>;
145def llvm_f128_ty       : LLVMType<f128>;
146def llvm_ppcf128_ty    : LLVMType<ppcf128>;
147def llvm_ptr_ty        : LLVMPointerType<llvm_i8_ty>;             // i8*
148def llvm_ptrptr_ty     : LLVMPointerType<llvm_ptr_ty>;            // i8**
149def llvm_anyptr_ty     : LLVMAnyPointerType<llvm_i8_ty>;          // (space)i8*
150def llvm_empty_ty      : LLVMType<OtherVT>;                       // { }
151def llvm_descriptor_ty : LLVMPointerType<llvm_empty_ty>;          // { }*
152def llvm_metadata_ty   : LLVMType<MetadataVT>;                    // !{...}
153def llvm_token_ty      : LLVMType<token>;                         // token
154
155def llvm_x86mmx_ty     : LLVMType<x86mmx>;
156def llvm_ptrx86mmx_ty  : LLVMPointerType<llvm_x86mmx_ty>;         // <1 x i64>*
157
158def llvm_v2i1_ty       : LLVMType<v2i1>;     //   2 x i1
159def llvm_v4i1_ty       : LLVMType<v4i1>;     //   4 x i1
160def llvm_v8i1_ty       : LLVMType<v8i1>;     //   8 x i1
161def llvm_v16i1_ty      : LLVMType<v16i1>;    //  16 x i1
162def llvm_v32i1_ty      : LLVMType<v32i1>;    //  32 x i1
163def llvm_v64i1_ty      : LLVMType<v64i1>;    //  64 x i1
164def llvm_v512i1_ty     : LLVMType<v512i1>;   // 512 x i1
165def llvm_v1024i1_ty    : LLVMType<v1024i1>;  //1024 x i1
166
167def llvm_v1i8_ty       : LLVMType<v1i8>;     //  1 x i8
168def llvm_v2i8_ty       : LLVMType<v2i8>;     //  2 x i8
169def llvm_v4i8_ty       : LLVMType<v4i8>;     //  4 x i8
170def llvm_v8i8_ty       : LLVMType<v8i8>;     //  8 x i8
171def llvm_v16i8_ty      : LLVMType<v16i8>;    // 16 x i8
172def llvm_v32i8_ty      : LLVMType<v32i8>;    // 32 x i8
173def llvm_v64i8_ty      : LLVMType<v64i8>;    // 64 x i8
174def llvm_v128i8_ty     : LLVMType<v128i8>;   //128 x i8
175def llvm_v256i8_ty     : LLVMType<v256i8>;   //256 x i8
176
177def llvm_v1i16_ty      : LLVMType<v1i16>;    //  1 x i16
178def llvm_v2i16_ty      : LLVMType<v2i16>;    //  2 x i16
179def llvm_v4i16_ty      : LLVMType<v4i16>;    //  4 x i16
180def llvm_v8i16_ty      : LLVMType<v8i16>;    //  8 x i16
181def llvm_v16i16_ty     : LLVMType<v16i16>;   // 16 x i16
182def llvm_v32i16_ty     : LLVMType<v32i16>;   // 32 x i16
183def llvm_v64i16_ty     : LLVMType<v64i16>;   // 64 x i16
184def llvm_v128i16_ty    : LLVMType<v128i16>;  //128 x i16
185
186def llvm_v1i32_ty      : LLVMType<v1i32>;    //  1 x i32
187def llvm_v2i32_ty      : LLVMType<v2i32>;    //  2 x i32
188def llvm_v4i32_ty      : LLVMType<v4i32>;    //  4 x i32
189def llvm_v8i32_ty      : LLVMType<v8i32>;    //  8 x i32
190def llvm_v16i32_ty     : LLVMType<v16i32>;   // 16 x i32
191def llvm_v32i32_ty     : LLVMType<v32i32>;   // 32 x i32
192def llvm_v64i32_ty     : LLVMType<v64i32>;   // 64 x i32
193
194def llvm_v1i64_ty      : LLVMType<v1i64>;    //  1 x i64
195def llvm_v2i64_ty      : LLVMType<v2i64>;    //  2 x i64
196def llvm_v4i64_ty      : LLVMType<v4i64>;    //  4 x i64
197def llvm_v8i64_ty      : LLVMType<v8i64>;    //  8 x i64
198def llvm_v16i64_ty     : LLVMType<v16i64>;   // 16 x i64
199def llvm_v32i64_ty     : LLVMType<v32i64>;   // 32 x i64
200
201def llvm_v1i128_ty     : LLVMType<v1i128>;   //  1 x i128
202
203def llvm_v2f16_ty      : LLVMType<v2f16>;    //  2 x half (__fp16)
204def llvm_v4f16_ty      : LLVMType<v4f16>;    //  4 x half (__fp16)
205def llvm_v8f16_ty      : LLVMType<v8f16>;    //  8 x half (__fp16)
206def llvm_v1f32_ty      : LLVMType<v1f32>;    //  1 x float
207def llvm_v2f32_ty      : LLVMType<v2f32>;    //  2 x float
208def llvm_v4f32_ty      : LLVMType<v4f32>;    //  4 x float
209def llvm_v8f32_ty      : LLVMType<v8f32>;    //  8 x float
210def llvm_v16f32_ty     : LLVMType<v16f32>;   // 16 x float
211def llvm_v1f64_ty      : LLVMType<v1f64>;    //  1 x double
212def llvm_v2f64_ty      : LLVMType<v2f64>;    //  2 x double
213def llvm_v4f64_ty      : LLVMType<v4f64>;    //  4 x double
214def llvm_v8f64_ty      : LLVMType<v8f64>;    //  8 x double
215
216def llvm_vararg_ty     : LLVMType<isVoid>;   // this means vararg here
217
218
219//===----------------------------------------------------------------------===//
220// Intrinsic Definitions.
221//===----------------------------------------------------------------------===//
222
223// Intrinsic class - This is used to define one LLVM intrinsic.  The name of the
224// intrinsic definition should start with "int_", then match the LLVM intrinsic
225// name with the "llvm." prefix removed, and all "."s turned into "_"s.  For
226// example, llvm.bswap.i16 -> int_bswap_i16.
227//
228//  * RetTypes is a list containing the return types expected for the
229//    intrinsic.
230//  * ParamTypes is a list containing the parameter types expected for the
231//    intrinsic.
232//  * Properties can be set to describe the behavior of the intrinsic.
233//
234class SDPatternOperator;
235class Intrinsic<list<LLVMType> ret_types,
236                list<LLVMType> param_types = [],
237                list<IntrinsicProperty> properties = [],
238                string name = ""> : SDPatternOperator {
239  string LLVMName = name;
240  string TargetPrefix = "";   // Set to a prefix for target-specific intrinsics.
241  list<LLVMType> RetTypes = ret_types;
242  list<LLVMType> ParamTypes = param_types;
243  list<IntrinsicProperty> Properties = properties;
244
245  bit isTarget = 0;
246}
247
248/// GCCBuiltin - If this intrinsic exactly corresponds to a GCC builtin, this
249/// specifies the name of the builtin.  This provides automatic CBE and CFE
250/// support.
251class GCCBuiltin<string name> {
252  string GCCBuiltinName = name;
253}
254
255class MSBuiltin<string name> {
256  string MSBuiltinName = name;
257}
258
259
260//===--------------- Variable Argument Handling Intrinsics ----------------===//
261//
262
263def int_vastart : Intrinsic<[], [llvm_ptr_ty], [], "llvm.va_start">;
264def int_vacopy  : Intrinsic<[], [llvm_ptr_ty, llvm_ptr_ty], [],
265                            "llvm.va_copy">;
266def int_vaend   : Intrinsic<[], [llvm_ptr_ty], [], "llvm.va_end">;
267
268//===------------------- Garbage Collection Intrinsics --------------------===//
269//
270def int_gcroot  : Intrinsic<[],
271                            [llvm_ptrptr_ty, llvm_ptr_ty]>;
272def int_gcread  : Intrinsic<[llvm_ptr_ty],
273                            [llvm_ptr_ty, llvm_ptrptr_ty],
274                            [IntrReadArgMem]>;
275def int_gcwrite : Intrinsic<[],
276                            [llvm_ptr_ty, llvm_ptr_ty, llvm_ptrptr_ty],
277                            [IntrReadWriteArgMem, NoCapture<1>, NoCapture<2>]>;
278
279//===--------------------- Code Generator Intrinsics ----------------------===//
280//
281def int_returnaddress : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty], [IntrNoMem]>;
282def int_frameaddress  : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty], [IntrNoMem]>;
283def int_read_register  : Intrinsic<[llvm_anyint_ty], [llvm_metadata_ty],
284                                   [IntrReadMem], "llvm.read_register">;
285def int_write_register : Intrinsic<[], [llvm_metadata_ty, llvm_anyint_ty],
286                                   [], "llvm.write_register">;
287
288// Gets the address of the local variable area. This is typically a copy of the
289// stack, frame, or base pointer depending on the type of prologue.
290def int_localaddress : Intrinsic<[llvm_ptr_ty], [], [IntrNoMem]>;
291
292// Escapes local variables to allow access from other functions.
293def int_localescape : Intrinsic<[], [llvm_vararg_ty]>;
294
295// Given a function and the localaddress of a parent frame, returns a pointer
296// to an escaped allocation indicated by the index.
297def int_localrecover : Intrinsic<[llvm_ptr_ty],
298                                 [llvm_ptr_ty, llvm_ptr_ty, llvm_i32_ty],
299                                 [IntrNoMem]>;
300// Note: we treat stacksave/stackrestore as writemem because we don't otherwise
301// model their dependencies on allocas.
302def int_stacksave     : Intrinsic<[llvm_ptr_ty]>,
303                        GCCBuiltin<"__builtin_stack_save">;
304def int_stackrestore  : Intrinsic<[], [llvm_ptr_ty]>,
305                        GCCBuiltin<"__builtin_stack_restore">;
306
307def int_get_dynamic_area_offset : Intrinsic<[llvm_anyint_ty]>;
308
309// IntrReadWriteArgMem is more pessimistic than strictly necessary for prefetch,
310// however it does conveniently prevent the prefetch from being reordered
311// with respect to nearby accesses to the same memory.
312def int_prefetch      : Intrinsic<[],
313                                  [llvm_ptr_ty, llvm_i32_ty, llvm_i32_ty,
314                                   llvm_i32_ty],
315                                  [IntrReadWriteArgMem, NoCapture<0>]>;
316def int_pcmarker      : Intrinsic<[], [llvm_i32_ty]>;
317
318def int_readcyclecounter : Intrinsic<[llvm_i64_ty]>;
319
320// The assume intrinsic is marked as arbitrarily writing so that proper
321// control dependencies will be maintained.
322def int_assume        : Intrinsic<[], [llvm_i1_ty], []>;
323
324// Stack Protector Intrinsic - The stackprotector intrinsic writes the stack
325// guard to the correct place on the stack frame.
326def int_stackprotector : Intrinsic<[], [llvm_ptr_ty, llvm_ptrptr_ty], []>;
327def int_stackprotectorcheck : Intrinsic<[], [llvm_ptrptr_ty],
328                                        [IntrReadWriteArgMem]>;
329
330// A counter increment for instrumentation based profiling.
331def int_instrprof_increment : Intrinsic<[],
332                                        [llvm_ptr_ty, llvm_i64_ty,
333                                         llvm_i32_ty, llvm_i32_ty],
334                                        []>;
335
336// A call to profile runtime for value profiling of target expressions
337// through instrumentation based profiling.
338def int_instrprof_value_profile : Intrinsic<[],
339                                            [llvm_ptr_ty, llvm_i64_ty,
340                                             llvm_i64_ty, llvm_i32_ty,
341                                             llvm_i32_ty],
342                                            []>;
343
344//===------------------- Standard C Library Intrinsics --------------------===//
345//
346
347def int_memcpy  : Intrinsic<[],
348                             [llvm_anyptr_ty, llvm_anyptr_ty, llvm_anyint_ty,
349                              llvm_i32_ty, llvm_i1_ty],
350                            [IntrReadWriteArgMem, NoCapture<0>, NoCapture<1>,
351                             ReadOnly<1>]>;
352def int_memmove : Intrinsic<[],
353                            [llvm_anyptr_ty, llvm_anyptr_ty, llvm_anyint_ty,
354                             llvm_i32_ty, llvm_i1_ty],
355                            [IntrReadWriteArgMem, NoCapture<0>, NoCapture<1>,
356                             ReadOnly<1>]>;
357def int_memset  : Intrinsic<[],
358                            [llvm_anyptr_ty, llvm_i8_ty, llvm_anyint_ty,
359                             llvm_i32_ty, llvm_i1_ty],
360                            [IntrReadWriteArgMem, NoCapture<0>]>;
361
362let Properties = [IntrNoMem] in {
363  def int_fma  : Intrinsic<[llvm_anyfloat_ty],
364                           [LLVMMatchType<0>, LLVMMatchType<0>,
365                            LLVMMatchType<0>]>;
366  def int_fmuladd : Intrinsic<[llvm_anyfloat_ty],
367                              [LLVMMatchType<0>, LLVMMatchType<0>,
368                               LLVMMatchType<0>]>;
369
370  // These functions do not read memory, but are sensitive to the
371  // rounding mode. LLVM purposely does not model changes to the FP
372  // environment so they can be treated as readnone.
373  def int_sqrt : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
374  def int_powi : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>, llvm_i32_ty]>;
375  def int_sin  : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
376  def int_cos  : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
377  def int_pow  : Intrinsic<[llvm_anyfloat_ty],
378                           [LLVMMatchType<0>, LLVMMatchType<0>]>;
379  def int_log  : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
380  def int_log10: Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
381  def int_log2 : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
382  def int_exp  : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
383  def int_exp2 : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
384  def int_fabs : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
385  def int_minnum : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>, LLVMMatchType<0>]>;
386  def int_maxnum : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>, LLVMMatchType<0>]>;
387  def int_copysign : Intrinsic<[llvm_anyfloat_ty],
388                               [LLVMMatchType<0>, LLVMMatchType<0>]>;
389  def int_floor : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
390  def int_ceil  : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
391  def int_trunc : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
392  def int_rint  : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
393  def int_nearbyint : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
394  def int_round : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
395  def int_canonicalize : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>],
396                                   [IntrNoMem]>;
397}
398
399// NOTE: these are internal interfaces.
400def int_setjmp     : Intrinsic<[llvm_i32_ty],  [llvm_ptr_ty]>;
401def int_longjmp    : Intrinsic<[], [llvm_ptr_ty, llvm_i32_ty], [IntrNoReturn]>;
402def int_sigsetjmp  : Intrinsic<[llvm_i32_ty] , [llvm_ptr_ty, llvm_i32_ty]>;
403def int_siglongjmp : Intrinsic<[], [llvm_ptr_ty, llvm_i32_ty], [IntrNoReturn]>;
404
405// Internal interface for object size checking
406def int_objectsize : Intrinsic<[llvm_anyint_ty], [llvm_anyptr_ty, llvm_i1_ty],
407                               [IntrNoMem]>,
408                               GCCBuiltin<"__builtin_object_size">;
409
410//===------------------------- Expect Intrinsics --------------------------===//
411//
412def int_expect : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>,
413                                              LLVMMatchType<0>], [IntrNoMem]>;
414
415//===-------------------- Bit Manipulation Intrinsics ---------------------===//
416//
417
418// None of these intrinsics accesses memory at all.
419let Properties = [IntrNoMem] in {
420  def int_bswap: Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
421  def int_ctpop: Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
422  def int_ctlz : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>, llvm_i1_ty]>;
423  def int_cttz : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>, llvm_i1_ty]>;
424  def int_bitreverse : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
425}
426
427//===------------------------ Debugger Intrinsics -------------------------===//
428//
429
430// None of these intrinsics accesses memory at all...but that doesn't mean the
431// optimizers can change them aggressively.  Special handling needed in a few
432// places.
433let Properties = [IntrNoMem] in {
434  def int_dbg_declare      : Intrinsic<[],
435                                       [llvm_metadata_ty,
436                                       llvm_metadata_ty,
437                                       llvm_metadata_ty]>;
438  def int_dbg_value        : Intrinsic<[],
439                                       [llvm_metadata_ty, llvm_i64_ty,
440                                        llvm_metadata_ty,
441                                        llvm_metadata_ty]>;
442}
443
444//===------------------ Exception Handling Intrinsics----------------------===//
445//
446
447// The result of eh.typeid.for depends on the enclosing function, but inside a
448// given function it is 'const' and may be CSE'd etc.
449def int_eh_typeid_for : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty], [IntrNoMem]>;
450
451def int_eh_return_i32 : Intrinsic<[], [llvm_i32_ty, llvm_ptr_ty]>;
452def int_eh_return_i64 : Intrinsic<[], [llvm_i64_ty, llvm_ptr_ty]>;
453
454// eh.exceptionpointer returns the pointer to the exception caught by
455// the given `catchpad`.
456def int_eh_exceptionpointer : Intrinsic<[llvm_anyptr_ty], [llvm_token_ty],
457                                        [IntrNoMem]>;
458
459// Gets the exception code from a catchpad token. Only used on some platforms.
460def int_eh_exceptioncode : Intrinsic<[llvm_i32_ty], [llvm_token_ty], [IntrNoMem]>;
461
462// __builtin_unwind_init is an undocumented GCC intrinsic that causes all
463// callee-saved registers to be saved and restored (regardless of whether they
464// are used) in the calling function. It is used by libgcc_eh.
465def int_eh_unwind_init: Intrinsic<[]>,
466                        GCCBuiltin<"__builtin_unwind_init">;
467
468def int_eh_dwarf_cfa  : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty]>;
469
470let Properties = [IntrNoMem] in {
471  def int_eh_sjlj_lsda             : Intrinsic<[llvm_ptr_ty]>;
472  def int_eh_sjlj_callsite         : Intrinsic<[], [llvm_i32_ty]>;
473}
474def int_eh_sjlj_functioncontext : Intrinsic<[], [llvm_ptr_ty]>;
475def int_eh_sjlj_setjmp          : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty]>;
476def int_eh_sjlj_longjmp         : Intrinsic<[], [llvm_ptr_ty], [IntrNoReturn]>;
477def int_eh_sjlj_setup_dispatch  : Intrinsic<[], []>;
478
479//===---------------- Generic Variable Attribute Intrinsics----------------===//
480//
481def int_var_annotation : Intrinsic<[],
482                                   [llvm_ptr_ty, llvm_ptr_ty,
483                                    llvm_ptr_ty, llvm_i32_ty],
484                                   [], "llvm.var.annotation">;
485def int_ptr_annotation : Intrinsic<[LLVMAnyPointerType<llvm_anyint_ty>],
486                                   [LLVMMatchType<0>, llvm_ptr_ty, llvm_ptr_ty,
487                                    llvm_i32_ty],
488                                   [], "llvm.ptr.annotation">;
489def int_annotation : Intrinsic<[llvm_anyint_ty],
490                               [LLVMMatchType<0>, llvm_ptr_ty,
491                                llvm_ptr_ty, llvm_i32_ty],
492                               [], "llvm.annotation">;
493
494//===------------------------ Trampoline Intrinsics -----------------------===//
495//
496def int_init_trampoline : Intrinsic<[],
497                                    [llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty],
498                                    [IntrReadWriteArgMem, NoCapture<0>]>,
499                                   GCCBuiltin<"__builtin_init_trampoline">;
500
501def int_adjust_trampoline : Intrinsic<[llvm_ptr_ty], [llvm_ptr_ty],
502                                      [IntrReadArgMem]>,
503                                     GCCBuiltin<"__builtin_adjust_trampoline">;
504
505//===------------------------ Overflow Intrinsics -------------------------===//
506//
507
508// Expose the carry flag from add operations on two integrals.
509def int_sadd_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
510                                       [LLVMMatchType<0>, LLVMMatchType<0>],
511                                       [IntrNoMem]>;
512def int_uadd_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
513                                       [LLVMMatchType<0>, LLVMMatchType<0>],
514                                       [IntrNoMem]>;
515
516def int_ssub_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
517                                       [LLVMMatchType<0>, LLVMMatchType<0>],
518                                       [IntrNoMem]>;
519def int_usub_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
520                                       [LLVMMatchType<0>, LLVMMatchType<0>],
521                                       [IntrNoMem]>;
522
523def int_smul_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
524                                       [LLVMMatchType<0>, LLVMMatchType<0>],
525                                       [IntrNoMem]>;
526def int_umul_with_overflow : Intrinsic<[llvm_anyint_ty, llvm_i1_ty],
527                                       [LLVMMatchType<0>, LLVMMatchType<0>],
528                                       [IntrNoMem]>;
529
530//===------------------------- Memory Use Markers -------------------------===//
531//
532def int_lifetime_start  : Intrinsic<[],
533                                    [llvm_i64_ty, llvm_ptr_ty],
534                                    [IntrReadWriteArgMem, NoCapture<1>]>;
535def int_lifetime_end    : Intrinsic<[],
536                                    [llvm_i64_ty, llvm_ptr_ty],
537                                    [IntrReadWriteArgMem, NoCapture<1>]>;
538def int_invariant_start : Intrinsic<[llvm_descriptor_ty],
539                                    [llvm_i64_ty, llvm_ptr_ty],
540                                    [IntrReadWriteArgMem, NoCapture<1>]>;
541def int_invariant_end   : Intrinsic<[],
542                                    [llvm_descriptor_ty, llvm_i64_ty,
543                                     llvm_ptr_ty],
544                                    [IntrReadWriteArgMem, NoCapture<2>]>;
545
546def int_invariant_group_barrier : Intrinsic<[llvm_ptr_ty],
547                                            [llvm_ptr_ty],
548                                            [IntrNoMem]>;
549
550//===------------------------ Stackmap Intrinsics -------------------------===//
551//
552def int_experimental_stackmap : Intrinsic<[],
553                                  [llvm_i64_ty, llvm_i32_ty, llvm_vararg_ty],
554                                  [Throws]>;
555def int_experimental_patchpoint_void : Intrinsic<[],
556                                                 [llvm_i64_ty, llvm_i32_ty,
557                                                  llvm_ptr_ty, llvm_i32_ty,
558                                                  llvm_vararg_ty],
559                                                  [Throws]>;
560def int_experimental_patchpoint_i64 : Intrinsic<[llvm_i64_ty],
561                                                [llvm_i64_ty, llvm_i32_ty,
562                                                 llvm_ptr_ty, llvm_i32_ty,
563                                                 llvm_vararg_ty],
564                                                 [Throws]>;
565
566
567//===------------------------ Garbage Collection Intrinsics ---------------===//
568// These are documented in docs/Statepoint.rst
569
570def int_experimental_gc_statepoint : Intrinsic<[llvm_i32_ty],
571                               [llvm_i64_ty, llvm_i32_ty,
572                                llvm_anyptr_ty, llvm_i32_ty,
573                                llvm_i32_ty, llvm_vararg_ty],
574                                [Throws]>;
575
576def int_experimental_gc_result   : Intrinsic<[llvm_any_ty], [llvm_i32_ty],
577                                             [IntrReadMem]>;
578def int_experimental_gc_relocate : Intrinsic<[llvm_anyptr_ty],
579                                [llvm_i32_ty, llvm_i32_ty, llvm_i32_ty],
580                                [IntrReadMem]>;
581
582// Deprecated: will be removed in a couple of weeks
583def int_experimental_gc_result_int : Intrinsic<[llvm_anyint_ty], [llvm_i32_ty]>;
584def int_experimental_gc_result_float : Intrinsic<[llvm_anyfloat_ty],
585                                                 [llvm_i32_ty]>;
586def int_experimental_gc_result_ptr : Intrinsic<[llvm_anyptr_ty], [llvm_i32_ty]>;
587
588//===-------------------------- Other Intrinsics --------------------------===//
589//
590def int_flt_rounds : Intrinsic<[llvm_i32_ty]>,
591                     GCCBuiltin<"__builtin_flt_rounds">;
592def int_trap : Intrinsic<[], [], [IntrNoReturn]>,
593               GCCBuiltin<"__builtin_trap">;
594def int_debugtrap : Intrinsic<[]>,
595                    GCCBuiltin<"__builtin_debugtrap">;
596
597// NOP: calls/invokes to this intrinsic are removed by codegen
598def int_donothing : Intrinsic<[], [], [IntrNoMem]>;
599
600// Intrisics to support half precision floating point format
601let Properties = [IntrNoMem] in {
602def int_convert_to_fp16   : Intrinsic<[llvm_i16_ty], [llvm_anyfloat_ty]>;
603def int_convert_from_fp16 : Intrinsic<[llvm_anyfloat_ty], [llvm_i16_ty]>;
604}
605
606// These convert intrinsics are to support various conversions between
607// various types with rounding and saturation. NOTE: avoid using these
608// intrinsics as they might be removed sometime in the future and
609// most targets don't support them.
610def int_convertff  : Intrinsic<[llvm_anyfloat_ty],
611                               [llvm_anyfloat_ty, llvm_i32_ty, llvm_i32_ty]>;
612def int_convertfsi : Intrinsic<[llvm_anyfloat_ty],
613                               [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
614def int_convertfui : Intrinsic<[llvm_anyfloat_ty],
615                               [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
616def int_convertsif : Intrinsic<[llvm_anyint_ty],
617                               [llvm_anyfloat_ty, llvm_i32_ty, llvm_i32_ty]>;
618def int_convertuif : Intrinsic<[llvm_anyint_ty],
619                               [llvm_anyfloat_ty, llvm_i32_ty, llvm_i32_ty]>;
620def int_convertss  : Intrinsic<[llvm_anyint_ty],
621                               [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
622def int_convertsu  : Intrinsic<[llvm_anyint_ty],
623                               [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
624def int_convertus  : Intrinsic<[llvm_anyint_ty],
625                               [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
626def int_convertuu  : Intrinsic<[llvm_anyint_ty],
627                               [llvm_anyint_ty, llvm_i32_ty, llvm_i32_ty]>;
628
629// Clear cache intrinsic, default to ignore (ie. emit nothing)
630// maps to void __clear_cache() on supporting platforms
631def int_clear_cache : Intrinsic<[], [llvm_ptr_ty, llvm_ptr_ty],
632                                [], "llvm.clear_cache">;
633
634//===-------------------------- Masked Intrinsics -------------------------===//
635//
636def int_masked_store : Intrinsic<[], [llvm_anyvector_ty, LLVMPointerTo<0>,
637                                      llvm_i32_ty,
638                                      LLVMVectorSameWidth<0, llvm_i1_ty>],
639                                 [IntrReadWriteArgMem]>;
640
641def int_masked_load  : Intrinsic<[llvm_anyvector_ty],
642                                 [LLVMPointerTo<0>, llvm_i32_ty,
643                                  LLVMVectorSameWidth<0, llvm_i1_ty>, LLVMMatchType<0>],
644                                 [IntrReadArgMem]>;
645
646def int_masked_gather: Intrinsic<[llvm_anyvector_ty],
647                                 [LLVMVectorOfPointersToElt<0>, llvm_i32_ty,
648                                  LLVMVectorSameWidth<0, llvm_i1_ty>,
649                                  LLVMMatchType<0>],
650                                 [IntrReadArgMem]>;
651
652def int_masked_scatter: Intrinsic<[],
653                                  [llvm_anyvector_ty,
654                                   LLVMVectorOfPointersToElt<0>, llvm_i32_ty,
655                                   LLVMVectorSameWidth<0, llvm_i1_ty>],
656                                  [IntrReadWriteArgMem]>;
657
658// Intrinsics to support bit sets.
659def int_bitset_test : Intrinsic<[llvm_i1_ty], [llvm_ptr_ty, llvm_metadata_ty],
660                                [IntrNoMem]>;
661
662//===----------------------------------------------------------------------===//
663// Target-specific intrinsics
664//===----------------------------------------------------------------------===//
665
666include "llvm/IR/IntrinsicsPowerPC.td"
667include "llvm/IR/IntrinsicsX86.td"
668include "llvm/IR/IntrinsicsARM.td"
669include "llvm/IR/IntrinsicsAArch64.td"
670include "llvm/IR/IntrinsicsXCore.td"
671include "llvm/IR/IntrinsicsHexagon.td"
672include "llvm/IR/IntrinsicsNVVM.td"
673include "llvm/IR/IntrinsicsMips.td"
674include "llvm/IR/IntrinsicsAMDGPU.td"
675include "llvm/IR/IntrinsicsBPF.td"
676include "llvm/IR/IntrinsicsSystemZ.td"
677include "llvm/IR/IntrinsicsWebAssembly.td"
678