Add builtins for ssat/usat, similar to RealView's __ssat and __usat intrinsics.
[oota-llvm.git] / include / llvm / IntrinsicsARM.td
1 //===- IntrinsicsARM.td - Defines ARM 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 all of the ARM-specific intrinsics.
11 //
12 //===----------------------------------------------------------------------===//
13
14
15 //===----------------------------------------------------------------------===//
16 // TLS
17
18 let TargetPrefix = "arm" in {  // All intrinsics start with "llvm.arm.".
19   def int_arm_thread_pointer : GCCBuiltin<"__builtin_thread_pointer">,
20               Intrinsic<[llvm_ptr_ty], [], [IntrNoMem]>;
21 }
22
23 //===----------------------------------------------------------------------===//
24 // Saturating Arithmentic
25
26 let TargetPrefix = "arm" in {  // All intrinsics start with "llvm.arm.".
27   def int_arm_qadd : GCCBuiltin<"__builtin_arm_qadd">,
28               Intrinsic<[llvm_i32_ty], [llvm_i32_ty, llvm_i32_ty],
29                         [IntrNoMem, Commutative]>;
30   def int_arm_qsub : GCCBuiltin<"__builtin_arm_qsub">,
31               Intrinsic<[llvm_i32_ty], [llvm_i32_ty, llvm_i32_ty], [IntrNoMem]>;
32   def int_arm_ssat : GCCBuiltin<"__builtin_arm_ssat">,
33               Intrinsic<[llvm_i32_ty], [llvm_i32_ty, llvm_i32_ty], [IntrNoMem]>;
34   def int_arm_usat : GCCBuiltin<"__builtin_arm_usat">,
35               Intrinsic<[llvm_i32_ty], [llvm_i32_ty, llvm_i32_ty], [IntrNoMem]>;
36 }
37
38 //===----------------------------------------------------------------------===//
39 // Advanced SIMD (NEON)
40
41 let TargetPrefix = "arm" in {  // All intrinsics start with "llvm.arm.".
42
43   // The following classes do not correspond directly to GCC builtins.
44   class Neon_1Arg_Intrinsic
45     : Intrinsic<[llvm_anyvector_ty], [LLVMMatchType<0>], [IntrNoMem]>;
46   class Neon_1Arg_Narrow_Intrinsic
47     : Intrinsic<[llvm_anyvector_ty],
48                 [LLVMExtendedElementVectorType<0>], [IntrNoMem]>;
49   class Neon_1Arg_Long_Intrinsic
50     : Intrinsic<[llvm_anyvector_ty],
51                 [LLVMTruncatedElementVectorType<0>], [IntrNoMem]>;
52   class Neon_2Arg_Intrinsic
53     : Intrinsic<[llvm_anyvector_ty], [LLVMMatchType<0>, LLVMMatchType<0>],
54                 [IntrNoMem]>;
55   class Neon_2Arg_Narrow_Intrinsic
56     : Intrinsic<[llvm_anyvector_ty],
57                 [LLVMExtendedElementVectorType<0>,
58                  LLVMExtendedElementVectorType<0>],
59                 [IntrNoMem]>;
60   class Neon_2Arg_Long_Intrinsic
61     : Intrinsic<[llvm_anyvector_ty],
62                 [LLVMTruncatedElementVectorType<0>,
63                  LLVMTruncatedElementVectorType<0>],
64                 [IntrNoMem]>;
65   class Neon_2Arg_Wide_Intrinsic
66     : Intrinsic<[llvm_anyvector_ty],
67                 [LLVMMatchType<0>, LLVMTruncatedElementVectorType<0>],
68                 [IntrNoMem]>;
69   class Neon_3Arg_Intrinsic
70     : Intrinsic<[llvm_anyvector_ty],
71                 [LLVMMatchType<0>, LLVMMatchType<0>, LLVMMatchType<0>],
72                 [IntrNoMem]>;
73   class Neon_3Arg_Long_Intrinsic
74     : Intrinsic<[llvm_anyvector_ty],
75                 [LLVMMatchType<0>,
76                  LLVMTruncatedElementVectorType<0>,
77                  LLVMTruncatedElementVectorType<0>],
78                 [IntrNoMem]>;
79   class Neon_CvtFxToFP_Intrinsic
80     : Intrinsic<[llvm_anyfloat_ty], [llvm_anyint_ty, llvm_i32_ty], [IntrNoMem]>;
81   class Neon_CvtFPToFx_Intrinsic
82     : Intrinsic<[llvm_anyint_ty], [llvm_anyfloat_ty, llvm_i32_ty], [IntrNoMem]>;
83
84   // The table operands for VTBL and VTBX consist of 1 to 4 v8i8 vectors.
85   // Besides the table, VTBL has one other v8i8 argument and VTBX has two.
86   // Overall, the classes range from 2 to 6 v8i8 arguments.
87   class Neon_Tbl2Arg_Intrinsic
88     : Intrinsic<[llvm_v8i8_ty],
89                 [llvm_v8i8_ty, llvm_v8i8_ty], [IntrNoMem]>;
90   class Neon_Tbl3Arg_Intrinsic
91     : Intrinsic<[llvm_v8i8_ty],
92                 [llvm_v8i8_ty, llvm_v8i8_ty, llvm_v8i8_ty], [IntrNoMem]>;
93   class Neon_Tbl4Arg_Intrinsic
94     : Intrinsic<[llvm_v8i8_ty],
95                 [llvm_v8i8_ty, llvm_v8i8_ty, llvm_v8i8_ty, llvm_v8i8_ty],
96                 [IntrNoMem]>;
97   class Neon_Tbl5Arg_Intrinsic
98     : Intrinsic<[llvm_v8i8_ty],
99                 [llvm_v8i8_ty, llvm_v8i8_ty, llvm_v8i8_ty, llvm_v8i8_ty,
100                  llvm_v8i8_ty], [IntrNoMem]>;
101   class Neon_Tbl6Arg_Intrinsic
102     : Intrinsic<[llvm_v8i8_ty],
103                 [llvm_v8i8_ty, llvm_v8i8_ty, llvm_v8i8_ty, llvm_v8i8_ty,
104                  llvm_v8i8_ty, llvm_v8i8_ty], [IntrNoMem]>;
105 }
106
107 // Arithmetic ops
108
109 let Properties = [IntrNoMem, Commutative] in {
110
111   // Vector Add.
112   def int_arm_neon_vhadds : Neon_2Arg_Intrinsic;
113   def int_arm_neon_vhaddu : Neon_2Arg_Intrinsic;
114   def int_arm_neon_vrhadds : Neon_2Arg_Intrinsic;
115   def int_arm_neon_vrhaddu : Neon_2Arg_Intrinsic;
116   def int_arm_neon_vqadds : Neon_2Arg_Intrinsic;
117   def int_arm_neon_vqaddu : Neon_2Arg_Intrinsic;
118   def int_arm_neon_vaddhn : Neon_2Arg_Narrow_Intrinsic;
119   def int_arm_neon_vraddhn : Neon_2Arg_Narrow_Intrinsic;
120   def int_arm_neon_vaddls : Neon_2Arg_Long_Intrinsic;
121   def int_arm_neon_vaddlu : Neon_2Arg_Long_Intrinsic;
122   def int_arm_neon_vaddws : Neon_2Arg_Wide_Intrinsic;
123   def int_arm_neon_vaddwu : Neon_2Arg_Wide_Intrinsic;
124
125   // Vector Multiply.
126   def int_arm_neon_vmulp : Neon_2Arg_Intrinsic;
127   def int_arm_neon_vqdmulh : Neon_2Arg_Intrinsic;
128   def int_arm_neon_vqrdmulh : Neon_2Arg_Intrinsic;
129   def int_arm_neon_vmulls : Neon_2Arg_Long_Intrinsic;
130   def int_arm_neon_vmullu : Neon_2Arg_Long_Intrinsic;
131   def int_arm_neon_vmullp : Neon_2Arg_Long_Intrinsic;
132   def int_arm_neon_vqdmull : Neon_2Arg_Long_Intrinsic;
133
134   // Vector Multiply and Accumulate/Subtract.
135   def int_arm_neon_vmlals : Neon_3Arg_Long_Intrinsic;
136   def int_arm_neon_vmlalu : Neon_3Arg_Long_Intrinsic;
137   def int_arm_neon_vmlsls : Neon_3Arg_Long_Intrinsic;
138   def int_arm_neon_vmlslu : Neon_3Arg_Long_Intrinsic;
139   def int_arm_neon_vqdmlal : Neon_3Arg_Long_Intrinsic;
140   def int_arm_neon_vqdmlsl : Neon_3Arg_Long_Intrinsic;
141
142   // Vector Maximum.
143   def int_arm_neon_vmaxs : Neon_2Arg_Intrinsic;
144   def int_arm_neon_vmaxu : Neon_2Arg_Intrinsic;
145
146   // Vector Minimum.
147   def int_arm_neon_vmins : Neon_2Arg_Intrinsic;
148   def int_arm_neon_vminu : Neon_2Arg_Intrinsic;
149
150   // Vector Reciprocal Step.
151   def int_arm_neon_vrecps : Neon_2Arg_Intrinsic;
152
153   // Vector Reciprocal Square Root Step.
154   def int_arm_neon_vrsqrts : Neon_2Arg_Intrinsic;
155 }
156
157 // Vector Subtract.
158 def int_arm_neon_vhsubs : Neon_2Arg_Intrinsic;
159 def int_arm_neon_vhsubu : Neon_2Arg_Intrinsic;
160 def int_arm_neon_vqsubs : Neon_2Arg_Intrinsic;
161 def int_arm_neon_vqsubu : Neon_2Arg_Intrinsic;
162 def int_arm_neon_vsubhn : Neon_2Arg_Narrow_Intrinsic;
163 def int_arm_neon_vrsubhn : Neon_2Arg_Narrow_Intrinsic;
164 def int_arm_neon_vsubls : Neon_2Arg_Long_Intrinsic;
165 def int_arm_neon_vsublu : Neon_2Arg_Long_Intrinsic;
166 def int_arm_neon_vsubws : Neon_2Arg_Wide_Intrinsic;
167 def int_arm_neon_vsubwu : Neon_2Arg_Wide_Intrinsic;
168
169 // Vector Absolute Compare.
170 let TargetPrefix = "arm" in {
171   def int_arm_neon_vacged : Intrinsic<[llvm_v2i32_ty],
172                                       [llvm_v2f32_ty, llvm_v2f32_ty],
173                                       [IntrNoMem]>;
174   def int_arm_neon_vacgeq : Intrinsic<[llvm_v4i32_ty],
175                                       [llvm_v4f32_ty, llvm_v4f32_ty],
176                                       [IntrNoMem]>;
177   def int_arm_neon_vacgtd : Intrinsic<[llvm_v2i32_ty],
178                                       [llvm_v2f32_ty, llvm_v2f32_ty],
179                                       [IntrNoMem]>;
180   def int_arm_neon_vacgtq : Intrinsic<[llvm_v4i32_ty],
181                                       [llvm_v4f32_ty, llvm_v4f32_ty],
182                                       [IntrNoMem]>;
183 }
184
185 // Vector Absolute Differences.
186 def int_arm_neon_vabds : Neon_2Arg_Intrinsic;
187 def int_arm_neon_vabdu : Neon_2Arg_Intrinsic;
188 def int_arm_neon_vabdls : Neon_2Arg_Long_Intrinsic;
189 def int_arm_neon_vabdlu : Neon_2Arg_Long_Intrinsic;
190
191 // Vector Absolute Difference and Accumulate.
192 def int_arm_neon_vabas : Neon_3Arg_Intrinsic;
193 def int_arm_neon_vabau : Neon_3Arg_Intrinsic;
194 def int_arm_neon_vabals : Neon_3Arg_Long_Intrinsic;
195 def int_arm_neon_vabalu : Neon_3Arg_Long_Intrinsic;
196
197 // Vector Pairwise Add.
198 def int_arm_neon_vpadd : Neon_2Arg_Intrinsic;
199
200 // Vector Pairwise Add Long.
201 // Note: This is different than the other "long" NEON intrinsics because
202 // the result vector has half as many elements as the source vector.
203 // The source and destination vector types must be specified separately.
204 let TargetPrefix = "arm" in {
205   def int_arm_neon_vpaddls : Intrinsic<[llvm_anyvector_ty], [llvm_anyvector_ty],
206                                        [IntrNoMem]>;
207   def int_arm_neon_vpaddlu : Intrinsic<[llvm_anyvector_ty], [llvm_anyvector_ty],
208                                        [IntrNoMem]>;
209 }
210
211 // Vector Pairwise Add and Accumulate Long.
212 // Note: This is similar to vpaddl but the destination vector also appears
213 // as the first argument.
214 let TargetPrefix = "arm" in {
215   def int_arm_neon_vpadals : Intrinsic<[llvm_anyvector_ty],
216                                        [LLVMMatchType<0>, llvm_anyvector_ty],
217                                        [IntrNoMem]>;
218   def int_arm_neon_vpadalu : Intrinsic<[llvm_anyvector_ty],
219                                        [LLVMMatchType<0>, llvm_anyvector_ty],
220                                        [IntrNoMem]>;
221 }
222
223 // Vector Pairwise Maximum and Minimum.
224 def int_arm_neon_vpmaxs : Neon_2Arg_Intrinsic;
225 def int_arm_neon_vpmaxu : Neon_2Arg_Intrinsic;
226 def int_arm_neon_vpmins : Neon_2Arg_Intrinsic;
227 def int_arm_neon_vpminu : Neon_2Arg_Intrinsic;
228
229 // Vector Shifts:
230 //
231 // The various saturating and rounding vector shift operations need to be
232 // represented by intrinsics in LLVM, and even the basic VSHL variable shift
233 // operation cannot be safely translated to LLVM's shift operators.  VSHL can
234 // be used for both left and right shifts, or even combinations of the two,
235 // depending on the signs of the shift amounts.  It also has well-defined
236 // behavior for shift amounts that LLVM leaves undefined.  Only basic shifts
237 // by constants can be represented with LLVM's shift operators.
238 //
239 // The shift counts for these intrinsics are always vectors, even for constant
240 // shifts, where the constant is replicated.  For consistency with VSHL (and
241 // other variable shift instructions), left shifts have positive shift counts
242 // and right shifts have negative shift counts.  This convention is also used
243 // for constant right shift intrinsics, and to help preserve sanity, the
244 // intrinsic names use "shift" instead of either "shl" or "shr".  Where
245 // applicable, signed and unsigned versions of the intrinsics are
246 // distinguished with "s" and "u" suffixes.  A few NEON shift instructions,
247 // such as VQSHLU, take signed operands but produce unsigned results; these
248 // use a "su" suffix.
249
250 // Vector Shift.
251 def int_arm_neon_vshifts : Neon_2Arg_Intrinsic;
252 def int_arm_neon_vshiftu : Neon_2Arg_Intrinsic;
253 def int_arm_neon_vshiftls : Neon_2Arg_Long_Intrinsic;
254 def int_arm_neon_vshiftlu : Neon_2Arg_Long_Intrinsic;
255 def int_arm_neon_vshiftn : Neon_2Arg_Narrow_Intrinsic;
256
257 // Vector Rounding Shift.
258 def int_arm_neon_vrshifts : Neon_2Arg_Intrinsic;
259 def int_arm_neon_vrshiftu : Neon_2Arg_Intrinsic;
260 def int_arm_neon_vrshiftn : Neon_2Arg_Narrow_Intrinsic;
261
262 // Vector Saturating Shift.
263 def int_arm_neon_vqshifts : Neon_2Arg_Intrinsic;
264 def int_arm_neon_vqshiftu : Neon_2Arg_Intrinsic;
265 def int_arm_neon_vqshiftsu : Neon_2Arg_Intrinsic;
266 def int_arm_neon_vqshiftns : Neon_2Arg_Narrow_Intrinsic;
267 def int_arm_neon_vqshiftnu : Neon_2Arg_Narrow_Intrinsic;
268 def int_arm_neon_vqshiftnsu : Neon_2Arg_Narrow_Intrinsic;
269
270 // Vector Saturating Rounding Shift.
271 def int_arm_neon_vqrshifts : Neon_2Arg_Intrinsic;
272 def int_arm_neon_vqrshiftu : Neon_2Arg_Intrinsic;
273 def int_arm_neon_vqrshiftns : Neon_2Arg_Narrow_Intrinsic;
274 def int_arm_neon_vqrshiftnu : Neon_2Arg_Narrow_Intrinsic;
275 def int_arm_neon_vqrshiftnsu : Neon_2Arg_Narrow_Intrinsic;
276
277 // Vector Shift and Insert.
278 def int_arm_neon_vshiftins : Neon_3Arg_Intrinsic;
279
280 // Vector Absolute Value and Saturating Absolute Value.
281 def int_arm_neon_vabs : Neon_1Arg_Intrinsic;
282 def int_arm_neon_vqabs : Neon_1Arg_Intrinsic;
283
284 // Vector Saturating Negate.
285 def int_arm_neon_vqneg : Neon_1Arg_Intrinsic;
286
287 // Vector Count Leading Sign/Zero Bits.
288 def int_arm_neon_vcls : Neon_1Arg_Intrinsic;
289 def int_arm_neon_vclz : Neon_1Arg_Intrinsic;
290
291 // Vector Count One Bits.
292 def int_arm_neon_vcnt : Neon_1Arg_Intrinsic;
293
294 // Vector Reciprocal Estimate.
295 def int_arm_neon_vrecpe : Neon_1Arg_Intrinsic;
296
297 // Vector Reciprocal Square Root Estimate.
298 def int_arm_neon_vrsqrte : Neon_1Arg_Intrinsic;
299
300 // Vector Conversions Between Floating-point and Fixed-point.
301 def int_arm_neon_vcvtfp2fxs : Neon_CvtFPToFx_Intrinsic;
302 def int_arm_neon_vcvtfp2fxu : Neon_CvtFPToFx_Intrinsic;
303 def int_arm_neon_vcvtfxs2fp : Neon_CvtFxToFP_Intrinsic;
304 def int_arm_neon_vcvtfxu2fp : Neon_CvtFxToFP_Intrinsic;
305
306 // Narrowing and Lengthening Vector Moves.
307 def int_arm_neon_vmovn : Neon_1Arg_Narrow_Intrinsic;
308 def int_arm_neon_vqmovns : Neon_1Arg_Narrow_Intrinsic;
309 def int_arm_neon_vqmovnu : Neon_1Arg_Narrow_Intrinsic;
310 def int_arm_neon_vqmovnsu : Neon_1Arg_Narrow_Intrinsic;
311 def int_arm_neon_vmovls : Neon_1Arg_Long_Intrinsic;
312 def int_arm_neon_vmovlu : Neon_1Arg_Long_Intrinsic;
313
314 // Vector Table Lookup.
315 // The first 1-4 arguments are the table.
316 def int_arm_neon_vtbl1 : Neon_Tbl2Arg_Intrinsic;
317 def int_arm_neon_vtbl2 : Neon_Tbl3Arg_Intrinsic;
318 def int_arm_neon_vtbl3 : Neon_Tbl4Arg_Intrinsic;
319 def int_arm_neon_vtbl4 : Neon_Tbl5Arg_Intrinsic;
320
321 // Vector Table Extension.
322 // Some elements of the destination vector may not be updated, so the original
323 // value of that vector is passed as the first argument.  The next 1-4
324 // arguments after that are the table.
325 def int_arm_neon_vtbx1 : Neon_Tbl3Arg_Intrinsic;
326 def int_arm_neon_vtbx2 : Neon_Tbl4Arg_Intrinsic;
327 def int_arm_neon_vtbx3 : Neon_Tbl5Arg_Intrinsic;
328 def int_arm_neon_vtbx4 : Neon_Tbl6Arg_Intrinsic;
329
330 let TargetPrefix = "arm" in {
331
332   // De-interleaving vector loads from N-element structures.
333   def int_arm_neon_vld1 : Intrinsic<[llvm_anyvector_ty],
334                                     [llvm_ptr_ty], [IntrReadArgMem]>;
335   def int_arm_neon_vld2 : Intrinsic<[llvm_anyvector_ty, LLVMMatchType<0>],
336                                     [llvm_ptr_ty], [IntrReadArgMem]>;
337   def int_arm_neon_vld3 : Intrinsic<[llvm_anyvector_ty, LLVMMatchType<0>,
338                                      LLVMMatchType<0>],
339                                     [llvm_ptr_ty], [IntrReadArgMem]>;
340   def int_arm_neon_vld4 : Intrinsic<[llvm_anyvector_ty, LLVMMatchType<0>,
341                                      LLVMMatchType<0>, LLVMMatchType<0>],
342                                     [llvm_ptr_ty], [IntrReadArgMem]>;
343
344   // Vector load N-element structure to one lane.
345   def int_arm_neon_vld2lane : Intrinsic<[llvm_anyvector_ty, LLVMMatchType<0>],
346                                         [llvm_ptr_ty, LLVMMatchType<0>,
347                                          LLVMMatchType<0>, llvm_i32_ty],
348                                         [IntrReadArgMem]>;
349   def int_arm_neon_vld3lane : Intrinsic<[llvm_anyvector_ty, LLVMMatchType<0>,
350                                          LLVMMatchType<0>],
351                                         [llvm_ptr_ty, LLVMMatchType<0>,
352                                          LLVMMatchType<0>, LLVMMatchType<0>,
353                                          llvm_i32_ty], [IntrReadArgMem]>;
354   def int_arm_neon_vld4lane : Intrinsic<[llvm_anyvector_ty, LLVMMatchType<0>,
355                                          LLVMMatchType<0>, LLVMMatchType<0>],
356                                         [llvm_ptr_ty, LLVMMatchType<0>,
357                                          LLVMMatchType<0>, LLVMMatchType<0>,
358                                          LLVMMatchType<0>, llvm_i32_ty],
359                                         [IntrReadArgMem]>;
360
361   // Interleaving vector stores from N-element structures.
362   def int_arm_neon_vst1 : Intrinsic<[],
363                                     [llvm_ptr_ty, llvm_anyvector_ty],
364                                     [IntrWriteArgMem]>;
365   def int_arm_neon_vst2 : Intrinsic<[],
366                                     [llvm_ptr_ty, llvm_anyvector_ty,
367                                      LLVMMatchType<0>], [IntrWriteArgMem]>;
368   def int_arm_neon_vst3 : Intrinsic<[],
369                                     [llvm_ptr_ty, llvm_anyvector_ty,
370                                      LLVMMatchType<0>, LLVMMatchType<0>],
371                                      [IntrWriteArgMem]>;
372   def int_arm_neon_vst4 : Intrinsic<[],
373                                     [llvm_ptr_ty, llvm_anyvector_ty,
374                                      LLVMMatchType<0>, LLVMMatchType<0>,
375                                      LLVMMatchType<0>], [IntrWriteArgMem]>;
376
377   // Vector store N-element structure from one lane.
378   def int_arm_neon_vst2lane : Intrinsic<[],
379                                         [llvm_ptr_ty, llvm_anyvector_ty,
380                                          LLVMMatchType<0>, llvm_i32_ty],
381                                         [IntrWriteArgMem]>;
382   def int_arm_neon_vst3lane : Intrinsic<[],
383                                         [llvm_ptr_ty, llvm_anyvector_ty,
384                                          LLVMMatchType<0>, LLVMMatchType<0>,
385                                          llvm_i32_ty], [IntrWriteArgMem]>;
386   def int_arm_neon_vst4lane : Intrinsic<[],
387                                         [llvm_ptr_ty, llvm_anyvector_ty,
388                                          LLVMMatchType<0>, LLVMMatchType<0>,
389                                          LLVMMatchType<0>, llvm_i32_ty],
390                                         [IntrWriteArgMem]>;
391 }