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