Intrinsics.td 70.9 KB
Newer Older
1
//===- Intrinsics.td - Defines all LLVM intrinsics ---------*- tablegen -*-===//
Eric Christopher's avatar
Eric Christopher committed
2
//
3
4
5
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Eric Christopher's avatar
Eric Christopher committed
6
//
7
8
9
10
11
12
//===----------------------------------------------------------------------===//
//
// This file defines properties of all LLVM intrinsics.
//
//===----------------------------------------------------------------------===//

13
include "llvm/CodeGen/ValueTypes.td"
14
include "llvm/CodeGen/SDNodeProperties.td"
15

16
17
18
19
20
21
//===----------------------------------------------------------------------===//
//  Properties we keep track of for intrinsics.
//===----------------------------------------------------------------------===//

class IntrinsicProperty;

22
// Intr*Mem - Memory properties.  If no property is set, the worst case
23
24
// is assumed (it may read and write any memory it can get access to and it may
// have other side effects).
25

Chris Lattner's avatar
Chris Lattner committed
26
// IntrNoMem - The intrinsic does not access memory or have any other side
27
// effects.  It may be CSE'd deleted if dead, etc.
Chris Lattner's avatar
Chris Lattner committed
28
def IntrNoMem : IntrinsicProperty;
29

30
31
32
33
// IntrReadMem - This intrinsic only reads from memory. It does not write to
// memory and has no other side effects. Therefore, it cannot be moved across
// potentially aliasing stores. However, it can be reordered otherwise and can
// be deleted if dead.
34
35
def IntrReadMem : IntrinsicProperty;

36
37
38
// IntrWriteMem - This intrinsic only writes to memory, but does not read from
// memory, and has no other side effects. This means dead stores before calls
// to this intrinsics may be removed.
39
40
def IntrWriteMem : IntrinsicProperty;

41
42
43
44
// IntrArgMemOnly - This intrinsic only accesses memory that its pointer-typed
// argument(s) points to, but may access an unspecified amount. Other than
// reads from and (possibly volatile) writes to memory, it has no side effects.
def IntrArgMemOnly : IntrinsicProperty;
45

46
47
48
49
50
51
52
53
54
// IntrInaccessibleMemOnly -- This intrinsic only accesses memory that is not
// accessible by the module being compiled. This is a weaker form of IntrNoMem.
def IntrInaccessibleMemOnly : IntrinsicProperty;

// IntrInaccessibleMemOrArgMemOnly -- This intrinsic only accesses memory that
// its pointer-typed arguments point to or memory that is not accessible
// by the module being compiled. This is a weaker form of IntrArgMemOnly.
def IntrInaccessibleMemOrArgMemOnly : IntrinsicProperty;

55
56
57
// Commutative - This intrinsic is commutative: X op Y == Y op X.
def Commutative : IntrinsicProperty;

58
59
60
// Throws - This intrinsic can throw.
def Throws : IntrinsicProperty;

61
62
63
64
65
// NoCapture - The specified argument pointer is not captured by the intrinsic.
class NoCapture<int argNo> : IntrinsicProperty {
  int ArgNo = argNo;
}

66
67
68
69
70
71
// NoAlias - The specified argument pointer is not aliasing other "noalias" pointer
// arguments of the intrinsic wrt. the intrinsic scope.
class NoAlias<int argNo> : IntrinsicProperty {
  int ArgNo = argNo;
}

72
73
74
75
76
77
// Returned - The specified argument is always the return value of the
// intrinsic.
class Returned<int argNo> : IntrinsicProperty {
  int ArgNo = argNo;
}

Matt Arsenault's avatar
Matt Arsenault committed
78
79
80
81
82
// ImmArg - The specified argument must be an immediate.
class ImmArg<int argNo> : IntrinsicProperty {
  int ArgNo = argNo;
}

83
84
85
86
87
88
// ReadOnly - The specified argument pointer is not written to through the
// pointer by the intrinsic.
class ReadOnly<int argNo> : IntrinsicProperty {
  int ArgNo = argNo;
}

Nicolai Haehnle's avatar
Nicolai Haehnle committed
89
90
91
92
93
94
// WriteOnly - The intrinsic does not read memory through the specified
// argument pointer.
class WriteOnly<int argNo> : IntrinsicProperty {
  int ArgNo = argNo;
}

95
96
97
98
99
100
// ReadNone - The specified argument pointer is not dereferenced by the
// intrinsic.
class ReadNone<int argNo> : IntrinsicProperty {
  int ArgNo = argNo;
}

101
102
def IntrNoReturn : IntrinsicProperty;

103
104
def IntrWillReturn : IntrinsicProperty;

Vedant Kumar's avatar
Vedant Kumar committed
105
106
107
108
// IntrCold - Calls to this intrinsic are cold.
// Parallels the cold attribute on LLVM IR functions.
def IntrCold : IntrinsicProperty;

109
110
111
112
// IntrNoduplicate - Calls to this intrinsic cannot be duplicated.
// Parallels the noduplicate attribute on LLVM IR functions.
def IntrNoDuplicate : IntrinsicProperty;

113
114
// IntrConvergent - Calls to this intrinsic are convergent and may not be made
// control-dependent on any additional values.
115
116
117
// Parallels the convergent attribute on LLVM IR functions.
def IntrConvergent : IntrinsicProperty;

118
119
120
// This property indicates that the intrinsic is safe to speculate.
def IntrSpeculatable : IntrinsicProperty;

121
122
123
124
125
126
127
128
129
// This property can be used to override the 'has no other side effects'
// language of the IntrNoMem, IntrReadMem, IntrWriteMem, and IntrArgMemOnly
// intrinsic properties.  By default, intrinsics are assumed to have side
// effects, so this property is only necessary if you have defined one of
// the memory properties listed above.
// For this property, 'side effects' has the same meaning as 'side effects'
// defined by the hasSideEffects property of the TableGen Instruction class.
def IntrHasSideEffects : IntrinsicProperty;

130
131
132
133
//===----------------------------------------------------------------------===//
// Types used by intrinsics.
//===----------------------------------------------------------------------===//

134
class LLVMType<ValueType vt> {
135
  ValueType VT = vt;
136
  int isAny = 0;
137
138
}

139
class LLVMQualPointerType<LLVMType elty, int addrspace>
140
  : LLVMType<iPTR>{
141
  LLVMType ElTy = elty;
142
  int AddrSpace = addrspace;
Eric Christopher's avatar
Eric Christopher committed
143
}
144

145
146
147
class LLVMPointerType<LLVMType elty>
  : LLVMQualPointerType<elty, 0>;

148
149
150
class LLVMAnyPointerType<LLVMType elty>
  : LLVMType<iPTRAny>{
  LLVMType ElTy = elty;
151
152

  let isAny = 1;
Eric Christopher's avatar
Eric Christopher committed
153
}
154

155
156
157
158
159
160
// Match the type of another intrinsic parameter.  Number is an index into the
// list of overloaded types for the intrinsic, excluding all the fixed types.
// The Number value must refer to a previously listed type.  For example:
//   Intrinsic<[llvm_i32_ty], [llvm_i32_ty, llvm_anyfloat_ty, LLVMMatchType<0>]>
// has two overloaded types, the 2nd and 3rd arguments.  LLVMMatchType<0>
// refers to the first overloaded type, which is the 2nd argument.
161
162
163
class LLVMMatchType<int num>
  : LLVMType<OtherVT>{
  int Number = num;
164
}
165

166
167
168
169
170
171
// Match the type of another intrinsic parameter that is expected to be based on
// an integral type (i.e. either iN or <N x iM>), but change the scalar size to
// be twice as wide or half as wide as the other type.  This is only useful when
// the intrinsic is overloaded, so the matched type should be declared as iAny.
class LLVMExtendedType<int num> : LLVMMatchType<num>;
class LLVMTruncatedType<int num> : LLVMMatchType<num>;
172
173
174
175
176
177

// Match the scalar/vector of another intrinsic parameter but with a different
// element type. Either both are scalars or both are vectors with the same
// number of elements.
class LLVMScalarOrSameVectorWidth<int idx, LLVMType elty>
  : LLVMMatchType<idx> {
178
179
  ValueType ElTy = elty.VT;
}
180

181
class LLVMPointerTo<int num> : LLVMMatchType<num>;
182
class LLVMPointerToElt<int num> : LLVMMatchType<num>;
183
class LLVMVectorOfAnyPointersToElt<int num> : LLVMMatchType<num>;
184
class LLVMVectorElementType<int num> : LLVMMatchType<num>;
185

186
187
188
189
// Match the type of another intrinsic parameter that is expected to be a
// vector type, but change the element count to be half as many
class LLVMHalfElementsVectorType<int num> : LLVMMatchType<num>;

190
191
192
193
194
195
// Match the type of another intrinsic parameter that is expected to be a
// vector type (i.e. <N x iM>) but with each element subdivided to
// form a vector with more elements that are smaller than the original.
class LLVMSubdivide2VectorType<int num> : LLVMMatchType<num>;
class LLVMSubdivide4VectorType<int num> : LLVMMatchType<num>;

196
197
198
199
// Match the element count and bit width of another intrinsic parameter, but
// change the element type to an integer.
class LLVMVectorOfBitcastsToInt<int num> : LLVMMatchType<num>;

200
def llvm_void_ty       : LLVMType<isVoid>;
201
202
203
204
205
206
let isAny = 1 in {
  def llvm_any_ty        : LLVMType<Any>;
  def llvm_anyint_ty     : LLVMType<iAny>;
  def llvm_anyfloat_ty   : LLVMType<fAny>;
  def llvm_anyvector_ty  : LLVMType<vAny>;
}
207
208
209
210
211
def llvm_i1_ty         : LLVMType<i1>;
def llvm_i8_ty         : LLVMType<i8>;
def llvm_i16_ty        : LLVMType<i16>;
def llvm_i32_ty        : LLVMType<i32>;
def llvm_i64_ty        : LLVMType<i64>;
212
def llvm_half_ty       : LLVMType<f16>;
213
214
def llvm_float_ty      : LLVMType<f32>;
def llvm_double_ty     : LLVMType<f64>;
215
216
217
def llvm_f80_ty        : LLVMType<f80>;
def llvm_f128_ty       : LLVMType<f128>;
def llvm_ppcf128_ty    : LLVMType<ppcf128>;
218
219
def llvm_ptr_ty        : LLVMPointerType<llvm_i8_ty>;             // i8*
def llvm_ptrptr_ty     : LLVMPointerType<llvm_ptr_ty>;            // i8**
220
def llvm_anyptr_ty     : LLVMAnyPointerType<llvm_i8_ty>;          // (space)i8*
221
def llvm_empty_ty      : LLVMType<OtherVT>;                       // { }
222
def llvm_descriptor_ty : LLVMPointerType<llvm_empty_ty>;          // { }*
Devang Patel's avatar
Devang Patel committed
223
def llvm_metadata_ty   : LLVMType<MetadataVT>;                    // !{...}
224
def llvm_token_ty      : LLVMType<token>;                         // token
225

226
def llvm_x86mmx_ty     : LLVMType<x86mmx>;
227
def llvm_ptrx86mmx_ty  : LLVMPointerType<llvm_x86mmx_ty>;         // <1 x i64>*
228

229
230
231
232
233
234
235
236
237
def llvm_v2i1_ty       : LLVMType<v2i1>;     //   2 x i1
def llvm_v4i1_ty       : LLVMType<v4i1>;     //   4 x i1
def llvm_v8i1_ty       : LLVMType<v8i1>;     //   8 x i1
def llvm_v16i1_ty      : LLVMType<v16i1>;    //  16 x i1
def llvm_v32i1_ty      : LLVMType<v32i1>;    //  32 x i1
def llvm_v64i1_ty      : LLVMType<v64i1>;    //  64 x i1
def llvm_v512i1_ty     : LLVMType<v512i1>;   // 512 x i1
def llvm_v1024i1_ty    : LLVMType<v1024i1>;  //1024 x i1

238
def llvm_v1i8_ty       : LLVMType<v1i8>;     //  1 x i8
David Greene's avatar
   
David Greene committed
239
240
241
def llvm_v2i8_ty       : LLVMType<v2i8>;     //  2 x i8
def llvm_v4i8_ty       : LLVMType<v4i8>;     //  4 x i8
def llvm_v8i8_ty       : LLVMType<v8i8>;     //  8 x i8
242
def llvm_v16i8_ty      : LLVMType<v16i8>;    // 16 x i8
David Greene's avatar
   
David Greene committed
243
def llvm_v32i8_ty      : LLVMType<v32i8>;    // 32 x i8
244
def llvm_v64i8_ty      : LLVMType<v64i8>;    // 64 x i8
245
246
def llvm_v128i8_ty     : LLVMType<v128i8>;   //128 x i8
def llvm_v256i8_ty     : LLVMType<v256i8>;   //256 x i8
247

248
def llvm_v1i16_ty      : LLVMType<v1i16>;    //  1 x i16
Dale Johannesen's avatar
Dale Johannesen committed
249
def llvm_v2i16_ty      : LLVMType<v2i16>;    //  2 x i16
David Greene's avatar
   
David Greene committed
250
def llvm_v4i16_ty      : LLVMType<v4i16>;    //  4 x i16
251
def llvm_v8i16_ty      : LLVMType<v8i16>;    //  8 x i16
David Greene's avatar
   
David Greene committed
252
def llvm_v16i16_ty     : LLVMType<v16i16>;   // 16 x i16
253
def llvm_v32i16_ty     : LLVMType<v32i16>;   // 32 x i16
254
255
def llvm_v64i16_ty     : LLVMType<v64i16>;   // 64 x i16
def llvm_v128i16_ty    : LLVMType<v128i16>;  //128 x i16
256

257
def llvm_v1i32_ty      : LLVMType<v1i32>;    //  1 x i32
258
259
def llvm_v2i32_ty      : LLVMType<v2i32>;    //  2 x i32
def llvm_v4i32_ty      : LLVMType<v4i32>;    //  4 x i32
David Greene's avatar
   
David Greene committed
260
def llvm_v8i32_ty      : LLVMType<v8i32>;    //  8 x i32
261
def llvm_v16i32_ty     : LLVMType<v16i32>;   // 16 x i32
262
263
264
def llvm_v32i32_ty     : LLVMType<v32i32>;   // 32 x i32
def llvm_v64i32_ty     : LLVMType<v64i32>;   // 64 x i32

David Greene's avatar
   
David Greene committed
265
266
267
def llvm_v1i64_ty      : LLVMType<v1i64>;    //  1 x i64
def llvm_v2i64_ty      : LLVMType<v2i64>;    //  2 x i64
def llvm_v4i64_ty      : LLVMType<v4i64>;    //  4 x i64
268
269
def llvm_v8i64_ty      : LLVMType<v8i64>;    //  8 x i64
def llvm_v16i64_ty     : LLVMType<v16i64>;   // 16 x i64
270
def llvm_v32i64_ty     : LLVMType<v32i64>;   // 32 x i64
David Greene's avatar
   
David Greene committed
271

272
273
def llvm_v1i128_ty     : LLVMType<v1i128>;   //  1 x i128

274
275
def llvm_v2f16_ty      : LLVMType<v2f16>;    //  2 x half (__fp16)
def llvm_v4f16_ty      : LLVMType<v4f16>;    //  4 x half (__fp16)
276
def llvm_v8f16_ty      : LLVMType<v8f16>;    //  8 x half (__fp16)
277
def llvm_v1f32_ty      : LLVMType<v1f32>;    //  1 x float
278
def llvm_v2f32_ty      : LLVMType<v2f32>;    //  2 x float
279
def llvm_v4f32_ty      : LLVMType<v4f32>;    //  4 x float
David Greene's avatar
   
David Greene committed
280
def llvm_v8f32_ty      : LLVMType<v8f32>;    //  8 x float
281
def llvm_v16f32_ty     : LLVMType<v16f32>;   // 16 x float
282
def llvm_v32f32_ty     : LLVMType<v32f32>;   // 32 x float
283
def llvm_v1f64_ty      : LLVMType<v1f64>;    //  1 x double
284
def llvm_v2f64_ty      : LLVMType<v2f64>;    //  2 x double
David Greene's avatar
   
David Greene committed
285
def llvm_v4f64_ty      : LLVMType<v4f64>;    //  4 x double
286
def llvm_v8f64_ty      : LLVMType<v8f64>;    //  8 x double
287

288
def llvm_vararg_ty     : LLVMType<isVoid>;   // this means vararg here
Jim Laskey's avatar
Jim Laskey committed
289

290
291
292
293
294
295
296
297
298
//===----------------------------------------------------------------------===//
// Intrinsic Definitions.
//===----------------------------------------------------------------------===//

// Intrinsic class - This is used to define one LLVM intrinsic.  The name of the
// intrinsic definition should start with "int_", then match the LLVM intrinsic
// name with the "llvm." prefix removed, and all "."s turned into "_"s.  For
// example, llvm.bswap.i16 -> int_bswap_i16.
//
299
300
301
302
//  * RetTypes is a list containing the return types expected for the
//    intrinsic.
//  * ParamTypes is a list containing the parameter types expected for the
//    intrinsic.
303
304
//  * Properties can be set to describe the behavior of the intrinsic.
//
305
306
class Intrinsic<list<LLVMType> ret_types,
                list<LLVMType> param_types = [],
307
308
309
                list<IntrinsicProperty> intr_properties = [],
                string name = "",
                list<SDNodeProperty> sd_properties = []> : SDPatternOperator {
310
  string LLVMName = name;
311
  string TargetPrefix = "";   // Set to a prefix for target-specific intrinsics.
312
313
  list<LLVMType> RetTypes = ret_types;
  list<LLVMType> ParamTypes = param_types;
314
315
  list<IntrinsicProperty> IntrProperties = intr_properties;
  let Properties = sd_properties;
316
317

  bit isTarget = 0;
318
319
}

320
321
322
323
324
325
326
/// GCCBuiltin - If this intrinsic exactly corresponds to a GCC builtin, this
/// specifies the name of the builtin.  This provides automatic CBE and CFE
/// support.
class GCCBuiltin<string name> {
  string GCCBuiltinName = name;
}

327
328
329
330
class MSBuiltin<string name> {
  string MSBuiltinName = name;
}

331
332

//===--------------- Variable Argument Handling Intrinsics ----------------===//
Eric Christopher's avatar
Eric Christopher committed
333
//
334

335
336
def int_vastart : Intrinsic<[], [llvm_ptr_ty], [], "llvm.va_start">;
def int_vacopy  : Intrinsic<[], [llvm_ptr_ty, llvm_ptr_ty], [],
337
                            "llvm.va_copy">;
338
def int_vaend   : Intrinsic<[], [llvm_ptr_ty], [], "llvm.va_end">;
339
340

//===------------------- Garbage Collection Intrinsics --------------------===//
Eric Christopher's avatar
Eric Christopher committed
341
//
342
def int_gcroot  : Intrinsic<[],
343
344
345
                            [llvm_ptrptr_ty, llvm_ptr_ty]>;
def int_gcread  : Intrinsic<[llvm_ptr_ty],
                            [llvm_ptr_ty, llvm_ptrptr_ty],
346
                            [IntrReadMem, IntrArgMemOnly]>;
347
def int_gcwrite : Intrinsic<[],
348
                            [llvm_ptr_ty, llvm_ptr_ty, llvm_ptrptr_ty],
349
                            [IntrArgMemOnly, NoCapture<1>, NoCapture<2>]>;
350

351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
//===------------------- ObjC ARC runtime Intrinsics --------------------===//
//
// Note these are to support the Objective-C ARC optimizer which wants to
// eliminate retain and releases where possible.

def int_objc_autorelease                    : Intrinsic<[llvm_ptr_ty],
                                                        [llvm_ptr_ty]>;
def int_objc_autoreleasePoolPop             : Intrinsic<[], [llvm_ptr_ty]>;
def int_objc_autoreleasePoolPush            : Intrinsic<[llvm_ptr_ty], []>;
def int_objc_autoreleaseReturnValue         : Intrinsic<[llvm_ptr_ty],
                                                        [llvm_ptr_ty]>;
def int_objc_copyWeak                       : Intrinsic<[],
                                                        [llvm_ptrptr_ty,
                                                         llvm_ptrptr_ty]>;
def int_objc_destroyWeak                    : Intrinsic<[], [llvm_ptrptr_ty]>;
def int_objc_initWeak                       : Intrinsic<[llvm_ptr_ty],
                                                        [llvm_ptrptr_ty,
                                                         llvm_ptr_ty]>;
def int_objc_loadWeak                       : Intrinsic<[llvm_ptr_ty],
                                                        [llvm_ptrptr_ty]>;
def int_objc_loadWeakRetained               : Intrinsic<[llvm_ptr_ty],
                                                        [llvm_ptrptr_ty]>;
def int_objc_moveWeak                       : Intrinsic<[],
                                                        [llvm_ptrptr_ty,
                                                         llvm_ptrptr_ty]>;
def int_objc_release                        : Intrinsic<[], [llvm_ptr_ty]>;
def int_objc_retain                         : Intrinsic<[llvm_ptr_ty],
                                                        [llvm_ptr_ty]>;
def int_objc_retainAutorelease              : Intrinsic<[llvm_ptr_ty],
                                                        [llvm_ptr_ty]>;
def int_objc_retainAutoreleaseReturnValue   : Intrinsic<[llvm_ptr_ty],
                                                        [llvm_ptr_ty]>;
def int_objc_retainAutoreleasedReturnValue  : Intrinsic<[llvm_ptr_ty],
                                                        [llvm_ptr_ty]>;
def int_objc_retainBlock                    : Intrinsic<[llvm_ptr_ty],
                                                        [llvm_ptr_ty]>;
def int_objc_storeStrong                    : Intrinsic<[],
                                                        [llvm_ptrptr_ty,
                                                         llvm_ptr_ty]>;
def int_objc_storeWeak                      : Intrinsic<[llvm_ptr_ty],
                                                        [llvm_ptrptr_ty,
                                                         llvm_ptr_ty]>;
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
def int_objc_clang_arc_use                  : Intrinsic<[],
                                                        [llvm_vararg_ty]>;
def int_objc_unsafeClaimAutoreleasedReturnValue : Intrinsic<[llvm_ptr_ty],
                                                            [llvm_ptr_ty]>;
def int_objc_retainedObject                 : Intrinsic<[llvm_ptr_ty],
                                                        [llvm_ptr_ty]>;
def int_objc_unretainedObject               : Intrinsic<[llvm_ptr_ty],
                                                        [llvm_ptr_ty]>;
def int_objc_unretainedPointer              : Intrinsic<[llvm_ptr_ty],
                                                        [llvm_ptr_ty]>;
def int_objc_retain_autorelease             : Intrinsic<[llvm_ptr_ty],
                                                        [llvm_ptr_ty]>;
def int_objc_sync_enter                     : Intrinsic<[llvm_i32_ty],
                                                        [llvm_ptr_ty]>;
def int_objc_sync_exit                      : Intrinsic<[llvm_i32_ty],
                                                        [llvm_ptr_ty]>;
def int_objc_arc_annotation_topdown_bbstart : Intrinsic<[],
                                                        [llvm_ptrptr_ty,
                                                         llvm_ptrptr_ty]>;
def int_objc_arc_annotation_topdown_bbend   : Intrinsic<[],
                                                        [llvm_ptrptr_ty,
                                                         llvm_ptrptr_ty]>;
def int_objc_arc_annotation_bottomup_bbstart  : Intrinsic<[],
                                                          [llvm_ptrptr_ty,
                                                           llvm_ptrptr_ty]>;
def int_objc_arc_annotation_bottomup_bbend  : Intrinsic<[],
                                                        [llvm_ptrptr_ty,
                                                         llvm_ptrptr_ty]>;
421
422


423
//===--------------------- Code Generator Intrinsics ----------------------===//
Eric Christopher's avatar
Eric Christopher committed
424
//
Matt Arsenault's avatar
Matt Arsenault committed
425
def int_returnaddress : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty], [IntrNoMem, ImmArg<0>]>;
426
427
428
def int_addressofreturnaddress : Intrinsic<[llvm_anyptr_ty], [], [IntrNoMem]>;
def int_frameaddress : Intrinsic<[llvm_anyptr_ty], [llvm_i32_ty], [IntrNoMem, ImmArg<0>]>;
def int_sponentry  : Intrinsic<[llvm_anyptr_ty], [], [IntrNoMem]>;
429
def int_read_register  : Intrinsic<[llvm_anyint_ty], [llvm_metadata_ty],
430
                                   [IntrReadMem], "llvm.read_register">;
431
def int_write_register : Intrinsic<[], [llvm_metadata_ty, llvm_anyint_ty],
Renato Golin's avatar
Renato Golin committed
432
                                   [], "llvm.write_register">;
433

434
435
436
437
438
439
440
441
442
443
444
// Gets the address of the local variable area. This is typically a copy of the
// stack, frame, or base pointer depending on the type of prologue.
def int_localaddress : Intrinsic<[llvm_ptr_ty], [], [IntrNoMem]>;

// Escapes local variables to allow access from other functions.
def int_localescape : Intrinsic<[], [llvm_vararg_ty]>;

// Given a function and the localaddress of a parent frame, returns a pointer
// to an escaped allocation indicated by the index.
def int_localrecover : Intrinsic<[llvm_ptr_ty],
                                 [llvm_ptr_ty, llvm_ptr_ty, llvm_i32_ty],
Matt Arsenault's avatar
Matt Arsenault committed
445
                                 [IntrNoMem, ImmArg<2>]>;
446
447
448
449
450
451
452

// Given the frame pointer passed into an SEH filter function, returns a
// pointer to the local variable area suitable for use with llvm.localrecover.
def int_eh_recoverfp : Intrinsic<[llvm_ptr_ty],
                                 [llvm_ptr_ty, llvm_ptr_ty],
                                 [IntrNoMem]>;

453
454
// Note: we treat stacksave/stackrestore as writemem because we don't otherwise
// model their dependencies on allocas.
455
def int_stacksave     : Intrinsic<[llvm_ptr_ty]>,
Reid Spencer's avatar
Reid Spencer committed
456
                        GCCBuiltin<"__builtin_stack_save">;
457
def int_stackrestore  : Intrinsic<[], [llvm_ptr_ty]>,
Reid Spencer's avatar
Reid Spencer committed
458
                        GCCBuiltin<"__builtin_stack_restore">;
459

460
461
def int_get_dynamic_area_offset : Intrinsic<[llvm_anyint_ty]>;

462
463
464
def int_thread_pointer : Intrinsic<[llvm_ptr_ty], [], [IntrNoMem]>,
                         GCCBuiltin<"__builtin_thread_pointer">;

465
466
467
468
469
// IntrInaccessibleMemOrArgMemOnly is a little more pessimistic than strictly
// necessary for prefetch, however it does conveniently prevent the prefetch
// from being reordered overly much with respect to nearby access to the same
// memory while not impeding optimization.
def int_prefetch
470
    : Intrinsic<[], [ llvm_anyptr_ty, llvm_i32_ty, llvm_i32_ty, llvm_i32_ty ],
471
                [ IntrInaccessibleMemOrArgMemOnly, IntrWillReturn, ReadOnly<0>, NoCapture<0>,
Matt Arsenault's avatar
Matt Arsenault committed
472
                  ImmArg<1>, ImmArg<2>]>;
473
def int_pcmarker      : Intrinsic<[], [llvm_i32_ty]>;
474

475
def int_readcyclecounter : Intrinsic<[llvm_i64_ty]>;
476

477
478
// The assume intrinsic is marked as arbitrarily writing so that proper
// control dependencies will be maintained.
479
def int_assume        : Intrinsic<[], [llvm_i1_ty], [IntrWillReturn]>;
480

481
482
// Stack Protector Intrinsic - The stackprotector intrinsic writes the stack
// guard to the correct place on the stack frame.
483
def int_stackprotector : Intrinsic<[], [llvm_ptr_ty, llvm_ptrptr_ty], []>;
484
def int_stackguard : Intrinsic<[llvm_ptr_ty], [], []>;
485

486
487
488
489
490
// A counter increment for instrumentation based profiling.
def int_instrprof_increment : Intrinsic<[],
                                        [llvm_ptr_ty, llvm_i64_ty,
                                         llvm_i32_ty, llvm_i32_ty],
                                        []>;
491

492
493
494
495
496
497
// A counter increment with step for instrumentation based profiling.
def int_instrprof_increment_step : Intrinsic<[],
                                        [llvm_ptr_ty, llvm_i64_ty,
                                         llvm_i32_ty, llvm_i32_ty, llvm_i64_ty],
                                        []>;

498
499
500
501
502
503
504
505
// A call to profile runtime for value profiling of target expressions
// through instrumentation based profiling.
def int_instrprof_value_profile : Intrinsic<[],
                                            [llvm_ptr_ty, llvm_i64_ty,
                                             llvm_i64_ty, llvm_i32_ty,
                                             llvm_i32_ty],
                                            []>;

506
507
508
//===------------------- Standard C Library Intrinsics --------------------===//
//

509
def int_memcpy  : Intrinsic<[],
510
                             [llvm_anyptr_ty, llvm_anyptr_ty, llvm_anyint_ty,
511
                              llvm_i1_ty],
512
                            [IntrArgMemOnly, IntrWillReturn, NoCapture<0>, NoCapture<1>,
513
                             NoAlias<0>, NoAlias<1>, WriteOnly<0>, ReadOnly<1>, ImmArg<3>]>;
514
515
516
517
518
519
520
521
522
523
524
525
526
527

// Memcpy semantic that is guaranteed to be inlined.
// In particular this means that the generated code is not allowed to call any
// external function.
// The third argument (specifying the size) must be a constant.
def int_memcpy_inline
    : Intrinsic<[],
      [ llvm_anyptr_ty, llvm_anyptr_ty, llvm_anyint_ty, llvm_i1_ty ],
      [ IntrArgMemOnly, IntrWillReturn,
      NoCapture<0>, NoCapture<1>,
      NoAlias<0>, NoAlias<1>,
      WriteOnly<0>, ReadOnly<1>,
      ImmArg<2>, ImmArg<3> ]>;

528
def int_memmove : Intrinsic<[],
529
                            [llvm_anyptr_ty, llvm_anyptr_ty, llvm_anyint_ty,
530
                             llvm_i1_ty],
531
                            [IntrArgMemOnly, IntrWillReturn, NoCapture<0>, NoCapture<1>,
Matt Arsenault's avatar
Matt Arsenault committed
532
                             ReadOnly<1>, ImmArg<3>]>;
533
def int_memset  : Intrinsic<[],
534
                            [llvm_anyptr_ty, llvm_i8_ty, llvm_anyint_ty,
535
                             llvm_i1_ty],
536
537
                            [IntrWriteMem, IntrArgMemOnly, IntrWillReturn, NoCapture<0>,
                             WriteOnly<0>, ImmArg<3>]>;
538

539
540
541
// FIXME: Add version of these floating point intrinsics which allow non-default
// rounding modes and FP exception handling.

542
let IntrProperties = [IntrNoMem, IntrSpeculatable, IntrWillReturn] in {
543
544
545
546
547
548
549
550
551
552
  def int_fma  : Intrinsic<[llvm_anyfloat_ty],
                           [LLVMMatchType<0>, LLVMMatchType<0>,
                            LLVMMatchType<0>]>;
  def int_fmuladd : Intrinsic<[llvm_anyfloat_ty],
                              [LLVMMatchType<0>, LLVMMatchType<0>,
                               LLVMMatchType<0>]>;

  // These functions do not read memory, but are sensitive to the
  // rounding mode. LLVM purposely does not model changes to the FP
  // environment so they can be treated as readnone.
553
554
555
  def int_sqrt : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
  def int_powi : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>, llvm_i32_ty]>;
  def int_sin  : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
Eric Christopher's avatar
Eric Christopher committed
556
  def int_cos  : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
557
558
559
560
561
562
563
  def int_pow  : Intrinsic<[llvm_anyfloat_ty],
                           [LLVMMatchType<0>, LLVMMatchType<0>]>;
  def int_log  : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
  def int_log10: Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
  def int_log2 : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
  def int_exp  : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
  def int_exp2 : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
Peter Collingbourne's avatar
Peter Collingbourne committed
564
  def int_fabs : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
Finkel, Hal's avatar
Finkel, Hal committed
565
566
  def int_copysign : Intrinsic<[llvm_anyfloat_ty],
                               [LLVMMatchType<0>, LLVMMatchType<0>]>;
Dan Gohman's avatar
Dan Gohman committed
567
  def int_floor : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
568
569
570
571
  def int_ceil  : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
  def int_trunc : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
  def int_rint  : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
  def int_nearbyint : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
Finkel, Hal's avatar
Finkel, Hal committed
572
  def int_round : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>]>;
573
574
  def int_canonicalize : Intrinsic<[llvm_anyfloat_ty], [LLVMMatchType<0>],
                                   [IntrNoMem]>;
575

576
577
  def int_lround : Intrinsic<[llvm_anyint_ty], [llvm_anyfloat_ty]>;
  def int_llround : Intrinsic<[llvm_anyint_ty], [llvm_anyfloat_ty]>;
578
579
  def int_lrint : Intrinsic<[llvm_anyint_ty], [llvm_anyfloat_ty]>;
  def int_llrint : Intrinsic<[llvm_anyint_ty], [llvm_anyfloat_ty]>;
580
581
}

582
def int_minnum : Intrinsic<[llvm_anyfloat_ty],
583
  [LLVMMatchType<0>, LLVMMatchType<0>],
584
  [IntrNoMem, IntrSpeculatable, IntrWillReturn, Commutative]
585
586
>;
def int_maxnum : Intrinsic<[llvm_anyfloat_ty],
587
  [LLVMMatchType<0>, LLVMMatchType<0>],
588
  [IntrNoMem, IntrSpeculatable, IntrWillReturn, Commutative]
589
>;
590
591
def int_minimum : Intrinsic<[llvm_anyfloat_ty],
  [LLVMMatchType<0>, LLVMMatchType<0>],
592
  [IntrNoMem, IntrSpeculatable, IntrWillReturn, Commutative]
593
594
595
>;
def int_maximum : Intrinsic<[llvm_anyfloat_ty],
  [LLVMMatchType<0>, LLVMMatchType<0>],
596
  [IntrNoMem, IntrSpeculatable, IntrWillReturn, Commutative]
597
>;
598

599
// Internal interface for object size checking
600
def int_objectsize : Intrinsic<[llvm_anyint_ty],
601
602
                               [llvm_anyptr_ty, llvm_i1_ty,
                                llvm_i1_ty, llvm_i1_ty],
603
                               [IntrNoMem, IntrSpeculatable, IntrWillReturn, ImmArg<1>, ImmArg<2>, ImmArg<3>]>,
604
605
                               GCCBuiltin<"__builtin_object_size">;

606
607
608
//===--------------- Constrained Floating Point Intrinsics ----------------===//
//

609
let IntrProperties = [IntrInaccessibleMemOnly, IntrWillReturn] in {
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
  def int_experimental_constrained_fadd : Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      LLVMMatchType<0>,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
  def int_experimental_constrained_fsub : Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      LLVMMatchType<0>,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
  def int_experimental_constrained_fmul : Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      LLVMMatchType<0>,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
  def int_experimental_constrained_fdiv : Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      LLVMMatchType<0>,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
  def int_experimental_constrained_frem : Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      LLVMMatchType<0>,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
635
636
637
638
639
640
641

  def int_experimental_constrained_fma : Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      LLVMMatchType<0>,
                                                      LLVMMatchType<0>,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
642
643
644
645
646
647
648

  def int_experimental_constrained_fmuladd : Intrinsic<[ llvm_anyfloat_ty ],
                                                       [ LLVMMatchType<0>,
                                                         LLVMMatchType<0>,
                                                         LLVMMatchType<0>,
                                                         llvm_metadata_ty,
                                                         llvm_metadata_ty ]>;
649

650
651
652
653
654
655
656
657
  def int_experimental_constrained_fptosi : Intrinsic<[ llvm_anyint_ty ],
                                                    [ llvm_anyfloat_ty,
                                                      llvm_metadata_ty ]>;

  def int_experimental_constrained_fptoui : Intrinsic<[ llvm_anyint_ty ],
                                                    [ llvm_anyfloat_ty,
                                                      llvm_metadata_ty ]>;

658
659
660
661
662
663
664
665
666
667
  def int_experimental_constrained_sitofp : Intrinsic<[ llvm_anyfloat_ty ],
                                                       [ llvm_anyint_ty,
                                                         llvm_metadata_ty,
                                                         llvm_metadata_ty ]>;

  def int_experimental_constrained_uitofp : Intrinsic<[ llvm_anyfloat_ty ],
                                                       [ llvm_anyint_ty,
                                                         llvm_metadata_ty,
                                                         llvm_metadata_ty ]>;

668
669
670
671
672
673
674
675
676
  def int_experimental_constrained_fptrunc : Intrinsic<[ llvm_anyfloat_ty ],
                                                       [ llvm_anyfloat_ty,
                                                         llvm_metadata_ty,
                                                         llvm_metadata_ty ]>;

  def int_experimental_constrained_fpext : Intrinsic<[ llvm_anyfloat_ty ],
                                                     [ llvm_anyfloat_ty,
                                                       llvm_metadata_ty ]>;

677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
  // These intrinsics are sensitive to the rounding mode so we need constrained
  // versions of each of them.  When strict rounding and exception control are
  // not required the non-constrained versions of these intrinsics should be
  // used.
  def int_experimental_constrained_sqrt : Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
  def int_experimental_constrained_powi : Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      llvm_i32_ty,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
  def int_experimental_constrained_sin  : Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
  def int_experimental_constrained_cos  : Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
  def int_experimental_constrained_pow  : Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      LLVMMatchType<0>,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
  def int_experimental_constrained_log  : Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
  def int_experimental_constrained_log10: Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
  def int_experimental_constrained_log2 : Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
Fangrui Song's avatar
Fangrui Song committed
715
  def int_experimental_constrained_exp  : Intrinsic<[ llvm_anyfloat_ty ],
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
                                                    [ LLVMMatchType<0>,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
  def int_experimental_constrained_exp2 : Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      llvm_metadata_ty,
                                                      llvm_metadata_ty ]>;
  def int_experimental_constrained_rint  : Intrinsic<[ llvm_anyfloat_ty ],
                                                     [ LLVMMatchType<0>,
                                                       llvm_metadata_ty,
                                                       llvm_metadata_ty ]>;
  def int_experimental_constrained_nearbyint : Intrinsic<[ llvm_anyfloat_ty ],
                                                         [ LLVMMatchType<0>,
                                                           llvm_metadata_ty,
                                                           llvm_metadata_ty ]>;
731
732
733
734
735
736
737
738
  def int_experimental_constrained_lrint : Intrinsic<[ llvm_anyint_ty ],
                                                     [ llvm_anyfloat_ty,
                                                       llvm_metadata_ty,
                                                       llvm_metadata_ty ]>;
  def int_experimental_constrained_llrint : Intrinsic<[ llvm_anyint_ty ],
                                                      [ llvm_anyfloat_ty,
                                                        llvm_metadata_ty,
                                                        llvm_metadata_ty ]>;
739
740
741
742
743
744
745
746
  def int_experimental_constrained_maxnum : Intrinsic<[ llvm_anyfloat_ty ],
                                                      [ LLVMMatchType<0>,
                                                        LLVMMatchType<0>,
                                                        llvm_metadata_ty ]>;
  def int_experimental_constrained_minnum : Intrinsic<[ llvm_anyfloat_ty ],
                                                      [ LLVMMatchType<0>,
                                                        LLVMMatchType<0>,
                                                        llvm_metadata_ty ]>;
747
748
749
750
751
752
753
754
  def int_experimental_constrained_maximum : Intrinsic<[ llvm_anyfloat_ty ],
                                                       [ LLVMMatchType<0>,
                                                         LLVMMatchType<0>,
                                                         llvm_metadata_ty ]>;
  def int_experimental_constrained_minimum : Intrinsic<[ llvm_anyfloat_ty ],
                                                       [ LLVMMatchType<0>,
                                                         LLVMMatchType<0>,
                                                         llvm_metadata_ty ]>;
755
756
757
758
759
760
  def int_experimental_constrained_ceil : Intrinsic<[ llvm_anyfloat_ty ],
                                                    [ LLVMMatchType<0>,
                                                      llvm_metadata_ty ]>;
  def int_experimental_constrained_floor : Intrinsic<[ llvm_anyfloat_ty ],
                                                     [ LLVMMatchType<0>,
                                                       llvm_metadata_ty ]>;
761
762
763
764
765
766
  def int_experimental_constrained_lround : Intrinsic<[ llvm_anyint_ty ],
                                                      [ llvm_anyfloat_ty,
                                                        llvm_metadata_ty ]>;
  def int_experimental_constrained_llround : Intrinsic<[ llvm_anyint_ty ],
                                                       [ llvm_anyfloat_ty,
                                                         llvm_metadata_ty ]>;
767
768
769
770
771
772
  def int_experimental_constrained_round : Intrinsic<[ llvm_anyfloat_ty ],
                                                     [ LLVMMatchType<0>,
                                                      llvm_metadata_ty ]>;
  def int_experimental_constrained_trunc : Intrinsic<[ llvm_anyfloat_ty ],
                                                     [ LLVMMatchType<0>,
                                                       llvm_metadata_ty ]>;
773
774
775
776
777
778
779
780
781
782
783

  // Constrained floating-point comparison (quiet and signaling variants).
  // Third operand is the predicate represented as a metadata string.
  def int_experimental_constrained_fcmp
      : Intrinsic<[ LLVMScalarOrSameVectorWidth<0, llvm_i1_ty> ],
                  [ llvm_anyfloat_ty, LLVMMatchType<0>,
                    llvm_metadata_ty, llvm_metadata_ty ]>;
  def int_experimental_constrained_fcmps
      : Intrinsic<[ LLVMScalarOrSameVectorWidth<0, llvm_i1_ty> ],
                  [ llvm_anyfloat_ty, LLVMMatchType<0>,
                    llvm_metadata_ty, llvm_metadata_ty ]>;
784
}
785
// FIXME: Consider maybe adding intrinsics for sitofp, uitofp.
786

787
788
//===------------------------- Expect Intrinsics --------------------------===//
//
Matt Arsenault's avatar
Matt Arsenault committed
789
def int_expect : Intrinsic<[llvm_anyint_ty],
790
  [LLVMMatchType<0>, LLVMMatchType<0>], [IntrNoMem, IntrWillReturn]>;
791

792
793
794
795
//===-------------------- Bit Manipulation Intrinsics ---------------------===//
//

// None of these intrinsics accesses memory at all.
796
let IntrProperties = [IntrNoMem, IntrSpeculatable, IntrWillReturn] in {
797
798
  def int_bswap: Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
  def int_ctpop: Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
799
  def int_bitreverse : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>]>;
800
801
802
803
  def int_fshl : Intrinsic<[llvm_anyint_ty],
      [LLVMMatchType<0>, LLVMMatchType<0>, LLVMMatchType<0>]>;
  def int_fshr : Intrinsic<[llvm_anyint_ty],
      [LLVMMatchType<0>, LLVMMatchType<0>, LLVMMatchType<0>]>;
804
}
805

806
let IntrProperties = [IntrNoMem, IntrSpeculatable, IntrWillReturn, ImmArg<1>] in {
Matt Arsenault's avatar
Matt Arsenault committed
807
808
809
810
  def int_ctlz : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>, llvm_i1_ty]>;
  def int_cttz : Intrinsic<[llvm_anyint_ty], [LLVMMatchType<0>, llvm_i1_ty]>;
}

811
812
813
//===------------------------ Debugger Intrinsics -------------------------===//
//

814
815
816
817
// None of these intrinsics accesses memory at all...but that doesn't
// mean the optimizers can change them aggressively.  Special handling
// needed in a few places. These synthetic intrinsics have no
// side-effects and just mark information about their operands.
818
let IntrProperties = [IntrNoMem, IntrSpeculatable, IntrWillReturn] in {
819
  def int_dbg_declare      : Intrinsic<[],
820
                                       [llvm_metadata_ty,
821
822
                                        llvm_metadata_ty,
                                        llvm_metadata_ty]>;
Bill Wendling's avatar
Bill Wendling committed
823
  def int_dbg_value        : Intrinsic<[],
824
                                       [llvm_metadata_ty,
825
                                        llvm_metadata_ty,
826
                                        llvm_metadata_ty]>;
827
828
829
830
  def int_dbg_addr         : Intrinsic<[],
                                       [llvm_metadata_ty,
                                        llvm_metadata_ty,
                                        llvm_metadata_ty]>;
831
832
  def int_dbg_label        : Intrinsic<[],
                                       [llvm_metadata_ty]>;
833
}
834

Jim Laskey's avatar
Jim Laskey committed
835
836
//===------------------ Exception Handling Intrinsics----------------------===//
//
837

838
839
840
// The result of eh.typeid.for depends on the enclosing function, but inside a
// given function it is 'const' and may be CSE'd etc.
def int_eh_typeid_for : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty], [IntrNoMem]>;
Jim Laskey's avatar
Jim Laskey committed
841

842
843
def int_eh_return_i32 : Intrinsic<[], [llvm_i32_ty, llvm_ptr_ty]>;
def int_eh_return_i64 : Intrinsic<[], [llvm_i64_ty, llvm_ptr_ty]>;
844

845
846
847
848
849
// eh.exceptionpointer returns the pointer to the exception caught by
// the given `catchpad`.
def int_eh_exceptionpointer : Intrinsic<[llvm_anyptr_ty], [llvm_token_ty],
                                        [IntrNoMem]>;

850
851
852
// Gets the exception code from a catchpad token. Only used on some platforms.
def int_eh_exceptioncode : Intrinsic<[llvm_i32_ty], [llvm_token_ty], [IntrNoMem]>;

853
854
855
// __builtin_unwind_init is an undocumented GCC intrinsic that causes all
// callee-saved registers to be saved and restored (regardless of whether they
// are used) in the calling function. It is used by libgcc_eh.
856
def int_eh_unwind_init: Intrinsic<[]>,
857
858
                        GCCBuiltin<"__builtin_unwind_init">;

859
def int_eh_dwarf_cfa  : Intrinsic<[llvm_ptr_ty], [llvm_i32_ty]>;
860

861
let IntrProperties = [IntrNoMem] in {
862
863
  def int_eh_sjlj_lsda             : Intrinsic<[llvm_ptr_ty]>;
  def int_eh_sjlj_callsite         : Intrinsic<[], [llvm_i32_ty]>;
864
}
865
866
def int_eh_sjlj_functioncontext : Intrinsic<[], [llvm_ptr_ty]>;
def int_eh_sjlj_setjmp          : Intrinsic<[llvm_i32_ty], [llvm_ptr_ty]>;
867
def int_eh_sjlj_longjmp         : Intrinsic<[], [llvm_ptr_ty], [IntrNoReturn]>;
868
def int_eh_sjlj_setup_dispatch  : Intrinsic<[], []>;
869

870
871
//===---------------- Generic Variable Attribute Intrinsics----------------===//
//
872
def int_var_annotation : Intrinsic<[],
873
                                   [llvm_ptr_ty, llvm_ptr_ty,
Eric Christopher's avatar
Eric Christopher committed
874
                                    llvm_ptr_ty, llvm_i32_ty],
875
                                   [IntrWillReturn], "llvm.var.annotation">;
876
877
def int_ptr_annotation : Intrinsic<[LLVMAnyPointerType<llvm_anyint_ty>],
                                   [LLVMMatchType<0>, llvm_ptr_ty, llvm_ptr_ty,
Eric Christopher's avatar
Eric Christopher committed
878
                                    llvm_i32_ty],
879
                                   [IntrWillReturn], "llvm.ptr.annotation">;
880
881
882
def int_annotation : Intrinsic<[llvm_anyint_ty],
                               [LLVMMatchType<0>, llvm_ptr_ty,
                                llvm_ptr_ty, llvm_i32_ty],
883
                               [IntrWillReturn], "llvm.annotation">;
884
885
886
887
888

// Annotates the current program point with metadata strings which are emitted
// as CodeView debug info records. This is expensive, as it disables inlining
// and is modelled as having side effects.
def int_codeview_annotation : Intrinsic<[], [llvm_metadata_ty],
889
                                        [IntrInaccessibleMemOnly, IntrNoDuplicate, IntrWillReturn],
890
                                        "llvm.codeview.annotation">;
891

892
893
//===------------------------ Trampoline Intrinsics -----------------------===//
//
894
def int_init_trampoline : Intrinsic<[],
895
                                    [llvm_ptr_ty, llvm_ptr_ty, llvm_ptr_ty],
896
                                    [IntrArgMemOnly, NoCapture<0>]>,
897
898
899
                                   GCCBuiltin<"__builtin_init_trampoline">;

def int_adjust_trampoline : Intrinsic<[llvm_ptr_ty], [llvm_ptr_ty],
900
                                      [IntrReadMem, IntrArgMemOnly]>,
901
                                     GCCBuiltin<"__builtin_adjust_trampoline">;
902

903
904
905
906
//===------------------------ Overflow Intrinsics -------------------------===//
//

// Expose the carry flag from add operations on two integrals.
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
let IntrProperties = [IntrNoMem, IntrSpeculatable, IntrWillReturn] in {
  def int_sadd_with_overflow : Intrinsic<[llvm_anyint_ty,
                                          LLVMScalarOrSameVectorWidth<0, llvm_i1_ty>],
                                         [LLVMMatchType<0>, LLVMMatchType<0>]>;
  def int_uadd_with_overflow : Intrinsic<[llvm_anyint_ty,
                                          LLVMScalarOrSameVectorWidth<0, llvm_i1_ty>],
                                         [LLVMMatchType<0>, LLVMMatchType<0>]>;

  def int_ssub_with_overflow : Intrinsic<[llvm_anyint_ty,
                                          LLVMScalarOrSameVectorWidth<0, llvm_i1_ty>],
                                         [LLVMMatchType<0>, LLVMMatchType<0>]>;
  def int_usub_with_overflow : Intrinsic<[llvm_anyint_ty,
                                          LLVMScalarOrSameVectorWidth<0, llvm_i1_ty>],
                                         [LLVMMatchType<0>, LLVMMatchType<0>]>;

  def int_smul_with_overflow : Intrinsic<[llvm_anyint_ty,
                                          LLVMScalarOrSameVectorWidth<0, llvm_i1_ty>],
                                         [LLVMMatchType<0>, LLVMMatchType<0>]>;
  def int_umul_with_overflow : Intrinsic<[llvm_anyint_ty,
                                          LLVMScalarOrSameVectorWidth<0, llvm_i1_ty>],
                                         [LLVMMatchType<0>, LLVMMatchType<0>]>;
}
929
//===------------------------- Saturation Arithmetic Intrinsics ---------------------===//
930
931
932
//
def int_sadd_sat : Intrinsic<[llvm_anyint_ty],
                             [LLVMMatchType<0>, LLVMMatchType<0>],
933
                             [IntrNoMem, IntrSpeculatable, IntrWillReturn, Commutative]>;
934
935
def int_uadd_sat : Intrinsic<[llvm_anyint_ty],
                             [LLVMMatchType<0>, LLVMMatchType<0>],
936
                             [IntrNoMem, IntrSpeculatable, IntrWillReturn, Commutative]>;
937
938
def int_ssub_sat : Intrinsic<[llvm_anyint_ty],
                             [LLVMMatchType<0>, LLVMMatchType<0>],
939
                             [IntrNoMem, IntrSpeculatable, IntrWillReturn]>;
940
941
def int_usub_sat : Intrinsic<[llvm_anyint_ty],
                             [LLVMMatchType<0>, LLVMMatchType<0>],
942
                             [IntrNoMem, IntrSpeculatable, IntrWillReturn]>;
943

944
945
946
947
//===------------------------- Fixed Point Arithmetic Intrinsics ---------------------===//
//
def int_smul_fix : Intrinsic<[llvm_anyint_ty],
                             [LLVMMatchType<0>, LLVMMatchType<0>, llvm_i32_ty],
948
                             [IntrNoMem, IntrSpeculatable, IntrWillReturn, Commutative, ImmArg<2>]>;
949
950
951

def int_umul_fix : Intrinsic<[llvm_anyint_ty],
                             [LLVMMatchType<0>, LLVMMatchType<0>, llvm_i32_ty],
952
                             [IntrNoMem, IntrSpeculatable, IntrWillReturn, Commutative, ImmArg<2>]>;
953

954
955
956
957
958
959
960
961
def int_sdiv_fix : Intrinsic<[llvm_anyint_ty],
                             [LLVMMatchType<0>, LLVMMatchType<0>, llvm_i32_ty],
                             [IntrNoMem, ImmArg<2>]>;

def int_udiv_fix : Intrinsic<[llvm_anyint_ty],
                             [LLVMMatchType<0>, LLVMMatchType<0>, llvm_i32_ty],
                             [IntrNoMem, ImmArg<2>]>;

962
963
964
965
//===------------------- Fixed Point Saturation Arithmetic Intrinsics ----------------===//
//
def int_smul_fix_sat : Intrinsic<[llvm_anyint_ty],
                                 [LLVMMatchType<0>, LLVMMatchType<0>, llvm_i32_ty],
966
                                 [IntrNoMem, IntrSpeculatable, IntrWillReturn, Commutative, ImmArg<2>]>;
967
968
969
def int_umul_fix_sat : Intrinsic<[llvm_anyint_ty],
                                 [LLVMMatchType<0>, LLVMMatchType<0>, llvm_i32_ty],
                                 [IntrNoMem, IntrSpeculatable, IntrWillReturn, Commutative, ImmArg<2>]>;
970

971
972
//===------------------------- Memory Use Markers -------------------------===//
//
973
def int_lifetime_start  : Intrinsic<[],
974
                                    [llvm_i64_ty, llvm_anyptr_ty],
975
                                    [IntrArgMemOnly, IntrWillReturn, NoCapture<1>, ImmArg<0>]>;
976
def int_lifetime_end    : Intrinsic<[],
977
                                    [llvm_i64_ty, llvm_anyptr_ty],
978
                                    [IntrArgMemOnly, IntrWillReturn, NoCapture<1>, ImmArg<0>]>;
979
def int_invariant_start : Intrinsic<[llvm_descriptor_ty],
980
                                    [llvm_i64_ty, llvm_anyptr_ty],
981
                                    [IntrArgMemOnly, IntrWillReturn, NoCapture<1>, ImmArg<0>]>;
982
def int_invariant_end   : Intrinsic<[],
983
                                    [llvm_descriptor_ty, llvm_i64_ty,
984
                                     llvm_anyptr_ty],
985
                                    [IntrArgMemOnly, IntrWillReturn, NoCapture<2>, ImmArg<1>]>;
986

987
// launder.invariant.group can't be marked with 'readnone' (IntrNoMem),
988
// because it would cause CSE of two barriers with the same argument.
989
990
991
992
993
994
// Inaccessiblememonly says that the barrier doesn't read the argument,
// but it changes state not accessible to this module. This way
// we can DSE through the barrier because it doesn't read the value
// after store. Although the barrier doesn't modify any memory it
// can't be marked as readonly, because it would be possible to
// CSE 2 barriers with store in between.
995
// The argument also can't be marked with 'returned' attribute, because
996
// it would remove barrier.
997
998
// Note that it is still experimental, which means that its semantics
// might change in the future.
999
def int_launder_invariant_group : Intrinsic<[llvm_anyptr_ty],
1000
                                            [LLVMMatchType<0>],
For faster browsing, not all history is shown. View entire blame