Add support for ARM's specialized vector-compare-against-zero instructions.
[oota-llvm.git] / lib / Target / ARM / ARMISelLowering.h
1 //===-- ARMISelLowering.h - ARM DAG Lowering Interface ----------*- C++ -*-===//
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 the interfaces that ARM uses to lower LLVM code into a
11 // selection DAG.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef ARMISELLOWERING_H
16 #define ARMISELLOWERING_H
17
18 #include "ARMSubtarget.h"
19 #include "llvm/Target/TargetLowering.h"
20 #include "llvm/Target/TargetRegisterInfo.h"
21 #include "llvm/CodeGen/FastISel.h"
22 #include "llvm/CodeGen/SelectionDAG.h"
23 #include "llvm/CodeGen/CallingConvLower.h"
24 #include <vector>
25
26 namespace llvm {
27   class ARMConstantPoolValue;
28
29   namespace ARMISD {
30     // ARM Specific DAG Nodes
31     enum NodeType {
32       // Start the numbering where the builtin ops and target ops leave off.
33       FIRST_NUMBER = ISD::BUILTIN_OP_END,
34
35       Wrapper,      // Wrapper - A wrapper node for TargetConstantPool,
36                     // TargetExternalSymbol, and TargetGlobalAddress.
37       WrapperJT,    // WrapperJT - A wrapper node for TargetJumpTable
38
39       CALL,         // Function call.
40       CALL_PRED,    // Function call that's predicable.
41       CALL_NOLINK,  // Function call with branch not branch-and-link.
42       tCALL,        // Thumb function call.
43       BRCOND,       // Conditional branch.
44       BR_JT,        // Jumptable branch.
45       BR2_JT,       // Jumptable branch (2 level - jumptable entry is a jump).
46       RET_FLAG,     // Return with a flag operand.
47
48       PIC_ADD,      // Add with a PC operand and a PIC label.
49
50       CMP,          // ARM compare instructions.
51       CMPZ,         // ARM compare that sets only Z flag.
52       CMPFP,        // ARM VFP compare instruction, sets FPSCR.
53       CMPFPw0,      // ARM VFP compare against zero instruction, sets FPSCR.
54       FMSTAT,       // ARM fmstat instruction.
55       CMOV,         // ARM conditional move instructions.
56       CNEG,         // ARM conditional negate instructions.
57
58       BCC_i64,
59
60       RBIT,         // ARM bitreverse instruction
61
62       FTOSI,        // FP to sint within a FP register.
63       FTOUI,        // FP to uint within a FP register.
64       SITOF,        // sint to FP within a FP register.
65       UITOF,        // uint to FP within a FP register.
66
67       SRL_FLAG,     // V,Flag = srl_flag X -> srl X, 1 + save carry out.
68       SRA_FLAG,     // V,Flag = sra_flag X -> sra X, 1 + save carry out.
69       RRX,          // V = RRX X, Flag     -> srl X, 1 + shift in carry flag.
70
71       VMOVRRD,      // double to two gprs.
72       VMOVDRR,      // Two gprs to double.
73
74       EH_SJLJ_SETJMP,         // SjLj exception handling setjmp.
75       EH_SJLJ_LONGJMP,        // SjLj exception handling longjmp.
76       EH_SJLJ_DISPATCHSETUP,  // SjLj exception handling dispatch setup.
77
78       TC_RETURN,    // Tail call return pseudo.
79
80       THREAD_POINTER,
81
82       DYN_ALLOC,    // Dynamic allocation on the stack.
83
84       MEMBARRIER,   // Memory barrier (DMB)
85       MEMBARRIER_MCR, // Memory barrier (MCR)
86
87       PRELOAD,      // Preload
88       
89       VCEQ,         // Vector compare equal.
90       VCEQZ,        // Vector compare equal to zero.
91       VCGE,         // Vector compare greater than or equal.
92       VCGEZ,        // Vector compare greater than or equal to zero.
93       VCLEZ,        // Vector compare less than or equal to zero.
94       VCGEU,        // Vector compare unsigned greater than or equal.
95       VCGT,         // Vector compare greater than.
96       VCGTZ,        // Vector compare greater than zero.
97       VCLTZ,        // Vector compare less than zero.
98       VCGTU,        // Vector compare unsigned greater than.
99       VTST,         // Vector test bits.
100
101       // Vector shift by immediate:
102       VSHL,         // ...left
103       VSHRs,        // ...right (signed)
104       VSHRu,        // ...right (unsigned)
105       VSHLLs,       // ...left long (signed)
106       VSHLLu,       // ...left long (unsigned)
107       VSHLLi,       // ...left long (with maximum shift count)
108       VSHRN,        // ...right narrow
109
110       // Vector rounding shift by immediate:
111       VRSHRs,       // ...right (signed)
112       VRSHRu,       // ...right (unsigned)
113       VRSHRN,       // ...right narrow
114
115       // Vector saturating shift by immediate:
116       VQSHLs,       // ...left (signed)
117       VQSHLu,       // ...left (unsigned)
118       VQSHLsu,      // ...left (signed to unsigned)
119       VQSHRNs,      // ...right narrow (signed)
120       VQSHRNu,      // ...right narrow (unsigned)
121       VQSHRNsu,     // ...right narrow (signed to unsigned)
122
123       // Vector saturating rounding shift by immediate:
124       VQRSHRNs,     // ...right narrow (signed)
125       VQRSHRNu,     // ...right narrow (unsigned)
126       VQRSHRNsu,    // ...right narrow (signed to unsigned)
127
128       // Vector shift and insert:
129       VSLI,         // ...left
130       VSRI,         // ...right
131
132       // Vector get lane (VMOV scalar to ARM core register)
133       // (These are used for 8- and 16-bit element types only.)
134       VGETLANEu,    // zero-extend vector extract element
135       VGETLANEs,    // sign-extend vector extract element
136
137       // Vector move immediate and move negated immediate:
138       VMOVIMM,
139       VMVNIMM,
140
141       // Vector duplicate:
142       VDUP,
143       VDUPLANE,
144
145       // Vector shuffles:
146       VEXT,         // extract
147       VREV64,       // reverse elements within 64-bit doublewords
148       VREV32,       // reverse elements within 32-bit words
149       VREV16,       // reverse elements within 16-bit halfwords
150       VZIP,         // zip (interleave)
151       VUZP,         // unzip (deinterleave)
152       VTRN,         // transpose
153
154       // Vector multiply long:
155       VMULLs,       // ...signed
156       VMULLu,       // ...unsigned
157
158       // Operands of the standard BUILD_VECTOR node are not legalized, which
159       // is fine if BUILD_VECTORs are always lowered to shuffles or other
160       // operations, but for ARM some BUILD_VECTORs are legal as-is and their
161       // operands need to be legalized.  Define an ARM-specific version of
162       // BUILD_VECTOR for this purpose.
163       BUILD_VECTOR,
164
165       // Floating-point max and min:
166       FMAX,
167       FMIN,
168
169       // Bit-field insert
170       BFI,
171       
172       // Vector OR with immediate
173       VORRIMM,
174       // Vector AND with NOT of immediate
175       VBICIMM
176     };
177   }
178
179   /// Define some predicates that are used for node matching.
180   namespace ARM {
181     /// getVFPf32Imm / getVFPf64Imm - If the given fp immediate can be
182     /// materialized with a VMOV.f32 / VMOV.f64 (i.e. fconsts / fconstd)
183     /// instruction, returns its 8-bit integer representation. Otherwise,
184     /// returns -1.
185     int getVFPf32Imm(const APFloat &FPImm);
186     int getVFPf64Imm(const APFloat &FPImm);
187     bool isBitFieldInvertedMask(unsigned v);
188   }
189
190   //===--------------------------------------------------------------------===//
191   //  ARMTargetLowering - ARM Implementation of the TargetLowering interface
192
193   class ARMTargetLowering : public TargetLowering {
194   public:
195     explicit ARMTargetLowering(TargetMachine &TM);
196
197     virtual unsigned getJumpTableEncoding(void) const;
198
199     virtual SDValue LowerOperation(SDValue Op, SelectionDAG &DAG) const;
200
201     /// ReplaceNodeResults - Replace the results of node with an illegal result
202     /// type with new values built out of custom code.
203     ///
204     virtual void ReplaceNodeResults(SDNode *N, SmallVectorImpl<SDValue>&Results,
205                                     SelectionDAG &DAG) const;
206
207     virtual SDValue PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const;
208
209     virtual const char *getTargetNodeName(unsigned Opcode) const;
210
211     virtual MachineBasicBlock *
212       EmitInstrWithCustomInserter(MachineInstr *MI,
213                                   MachineBasicBlock *MBB) const;
214
215     /// allowsUnalignedMemoryAccesses - Returns true if the target allows
216     /// unaligned memory accesses. of the specified type.
217     /// FIXME: Add getOptimalMemOpType to implement memcpy with NEON?
218     virtual bool allowsUnalignedMemoryAccesses(EVT VT) const;
219
220     /// isLegalAddressingMode - Return true if the addressing mode represented
221     /// by AM is legal for this target, for a load/store of the specified type.
222     virtual bool isLegalAddressingMode(const AddrMode &AM, const Type *Ty)const;
223     bool isLegalT2ScaledAddressingMode(const AddrMode &AM, EVT VT) const;
224
225     /// isLegalICmpImmediate - Return true if the specified immediate is legal
226     /// icmp immediate, that is the target has icmp instructions which can
227     /// compare a register against the immediate without having to materialize
228     /// the immediate into a register.
229     virtual bool isLegalICmpImmediate(int64_t Imm) const;
230
231     /// getPreIndexedAddressParts - returns true by value, base pointer and
232     /// offset pointer and addressing mode by reference if the node's address
233     /// can be legally represented as pre-indexed load / store address.
234     virtual bool getPreIndexedAddressParts(SDNode *N, SDValue &Base,
235                                            SDValue &Offset,
236                                            ISD::MemIndexedMode &AM,
237                                            SelectionDAG &DAG) const;
238
239     /// getPostIndexedAddressParts - returns true by value, base pointer and
240     /// offset pointer and addressing mode by reference if this node can be
241     /// combined with a load / store to form a post-indexed load / store.
242     virtual bool getPostIndexedAddressParts(SDNode *N, SDNode *Op,
243                                             SDValue &Base, SDValue &Offset,
244                                             ISD::MemIndexedMode &AM,
245                                             SelectionDAG &DAG) const;
246
247     virtual void computeMaskedBitsForTargetNode(const SDValue Op,
248                                                 const APInt &Mask,
249                                                 APInt &KnownZero,
250                                                 APInt &KnownOne,
251                                                 const SelectionDAG &DAG,
252                                                 unsigned Depth) const;
253
254
255     ConstraintType getConstraintType(const std::string &Constraint) const;
256
257     /// Examine constraint string and operand type and determine a weight value.
258     /// The operand object must already have been set up with the operand type.
259     ConstraintWeight getSingleConstraintMatchWeight(
260       AsmOperandInfo &info, const char *constraint) const;
261
262     std::pair<unsigned, const TargetRegisterClass*>
263       getRegForInlineAsmConstraint(const std::string &Constraint,
264                                    EVT VT) const;
265     std::vector<unsigned>
266     getRegClassForInlineAsmConstraint(const std::string &Constraint,
267                                       EVT VT) const;
268
269     /// LowerAsmOperandForConstraint - Lower the specified operand into the Ops
270     /// vector.  If it is invalid, don't add anything to Ops. If hasMemory is
271     /// true it means one of the asm constraint of the inline asm instruction
272     /// being processed is 'm'.
273     virtual void LowerAsmOperandForConstraint(SDValue Op,
274                                               char ConstraintLetter,
275                                               std::vector<SDValue> &Ops,
276                                               SelectionDAG &DAG) const;
277
278     const ARMSubtarget* getSubtarget() const {
279       return Subtarget;
280     }
281
282     /// getRegClassFor - Return the register class that should be used for the
283     /// specified value type.
284     virtual TargetRegisterClass *getRegClassFor(EVT VT) const;
285
286     /// getFunctionAlignment - Return the Log2 alignment of this function.
287     virtual unsigned getFunctionAlignment(const Function *F) const;
288
289     /// getMaximalGlobalOffset - Returns the maximal possible offset which can
290     /// be used for loads / stores from the global.
291     virtual unsigned getMaximalGlobalOffset() const;
292
293     /// createFastISel - This method returns a target specific FastISel object,
294     /// or null if the target does not support "fast" ISel.
295     virtual FastISel *createFastISel(FunctionLoweringInfo &funcInfo) const;
296
297     Sched::Preference getSchedulingPreference(SDNode *N) const;
298
299     unsigned getRegPressureLimit(const TargetRegisterClass *RC,
300                                  MachineFunction &MF) const;
301
302     bool isShuffleMaskLegal(const SmallVectorImpl<int> &M, EVT VT) const;
303     bool isOffsetFoldingLegal(const GlobalAddressSDNode *GA) const;
304
305     /// isFPImmLegal - Returns true if the target can instruction select the
306     /// specified FP immediate natively. If false, the legalizer will
307     /// materialize the FP immediate as a load from a constant pool.
308     virtual bool isFPImmLegal(const APFloat &Imm, EVT VT) const;
309
310     virtual bool getTgtMemIntrinsic(IntrinsicInfo &Info,
311                                     const CallInst &I,
312                                     unsigned Intrinsic) const;
313   protected:
314     std::pair<const TargetRegisterClass*, uint8_t>
315     findRepresentativeClass(EVT VT) const;
316
317   private:
318     /// Subtarget - Keep a pointer to the ARMSubtarget around so that we can
319     /// make the right decision when generating code for different targets.
320     const ARMSubtarget *Subtarget;
321
322     const TargetRegisterInfo *RegInfo;
323
324     const InstrItineraryData *Itins;
325
326     /// ARMPCLabelIndex - Keep track of the number of ARM PC labels created.
327     ///
328     unsigned ARMPCLabelIndex;
329
330     void addTypeForNEON(EVT VT, EVT PromotedLdStVT, EVT PromotedBitwiseVT);
331     void addDRTypeForNEON(EVT VT);
332     void addQRTypeForNEON(EVT VT);
333
334     typedef SmallVector<std::pair<unsigned, SDValue>, 8> RegsToPassVector;
335     void PassF64ArgInRegs(DebugLoc dl, SelectionDAG &DAG,
336                           SDValue Chain, SDValue &Arg,
337                           RegsToPassVector &RegsToPass,
338                           CCValAssign &VA, CCValAssign &NextVA,
339                           SDValue &StackPtr,
340                           SmallVector<SDValue, 8> &MemOpChains,
341                           ISD::ArgFlagsTy Flags) const;
342     SDValue GetF64FormalArgument(CCValAssign &VA, CCValAssign &NextVA,
343                                  SDValue &Root, SelectionDAG &DAG,
344                                  DebugLoc dl) const;
345
346     CCAssignFn *CCAssignFnForNode(CallingConv::ID CC, bool Return,
347                                   bool isVarArg) const;
348     SDValue LowerMemOpCallTo(SDValue Chain, SDValue StackPtr, SDValue Arg,
349                              DebugLoc dl, SelectionDAG &DAG,
350                              const CCValAssign &VA,
351                              ISD::ArgFlagsTy Flags) const;
352     SDValue LowerEH_SJLJ_SETJMP(SDValue Op, SelectionDAG &DAG) const;
353     SDValue LowerEH_SJLJ_LONGJMP(SDValue Op, SelectionDAG &DAG) const;
354     SDValue LowerEH_SJLJ_DISPATCHSETUP(SDValue Op, SelectionDAG &DAG) const;
355     SDValue LowerINTRINSIC_WO_CHAIN(SDValue Op, SelectionDAG &DAG,
356                                     const ARMSubtarget *Subtarget) const;
357     SDValue LowerBlockAddress(SDValue Op, SelectionDAG &DAG) const;
358     SDValue LowerGlobalAddressDarwin(SDValue Op, SelectionDAG &DAG) const;
359     SDValue LowerGlobalAddressELF(SDValue Op, SelectionDAG &DAG) const;
360     SDValue LowerGlobalTLSAddress(SDValue Op, SelectionDAG &DAG) const;
361     SDValue LowerToTLSGeneralDynamicModel(GlobalAddressSDNode *GA,
362                                             SelectionDAG &DAG) const;
363     SDValue LowerToTLSExecModels(GlobalAddressSDNode *GA,
364                                    SelectionDAG &DAG) const;
365     SDValue LowerGLOBAL_OFFSET_TABLE(SDValue Op, SelectionDAG &DAG) const;
366     SDValue LowerBR_JT(SDValue Op, SelectionDAG &DAG) const;
367     SDValue LowerSELECT(SDValue Op, SelectionDAG &DAG) const;
368     SDValue LowerSELECT_CC(SDValue Op, SelectionDAG &DAG) const;
369     SDValue LowerBR_CC(SDValue Op, SelectionDAG &DAG) const;
370     SDValue LowerFCOPYSIGN(SDValue Op, SelectionDAG &DAG) const;
371     SDValue LowerRETURNADDR(SDValue Op, SelectionDAG &DAG) const;
372     SDValue LowerFRAMEADDR(SDValue Op, SelectionDAG &DAG) const;
373     SDValue LowerShiftRightParts(SDValue Op, SelectionDAG &DAG) const;
374     SDValue LowerShiftLeftParts(SDValue Op, SelectionDAG &DAG) const;
375     SDValue LowerFLT_ROUNDS_(SDValue Op, SelectionDAG &DAG) const;
376
377     SDValue LowerCallResult(SDValue Chain, SDValue InFlag,
378                             CallingConv::ID CallConv, bool isVarArg,
379                             const SmallVectorImpl<ISD::InputArg> &Ins,
380                             DebugLoc dl, SelectionDAG &DAG,
381                             SmallVectorImpl<SDValue> &InVals) const;
382
383     virtual SDValue
384       LowerFormalArguments(SDValue Chain,
385                            CallingConv::ID CallConv, bool isVarArg,
386                            const SmallVectorImpl<ISD::InputArg> &Ins,
387                            DebugLoc dl, SelectionDAG &DAG,
388                            SmallVectorImpl<SDValue> &InVals) const;
389
390     virtual SDValue
391       LowerCall(SDValue Chain, SDValue Callee,
392                 CallingConv::ID CallConv, bool isVarArg,
393                 bool &isTailCall,
394                 const SmallVectorImpl<ISD::OutputArg> &Outs,
395                 const SmallVectorImpl<SDValue> &OutVals,
396                 const SmallVectorImpl<ISD::InputArg> &Ins,
397                 DebugLoc dl, SelectionDAG &DAG,
398                 SmallVectorImpl<SDValue> &InVals) const;
399
400     /// IsEligibleForTailCallOptimization - Check whether the call is eligible
401     /// for tail call optimization. Targets which want to do tail call
402     /// optimization should implement this function.
403     bool IsEligibleForTailCallOptimization(SDValue Callee,
404                                            CallingConv::ID CalleeCC,
405                                            bool isVarArg,
406                                            bool isCalleeStructRet,
407                                            bool isCallerStructRet,
408                                     const SmallVectorImpl<ISD::OutputArg> &Outs,
409                                     const SmallVectorImpl<SDValue> &OutVals,
410                                     const SmallVectorImpl<ISD::InputArg> &Ins,
411                                            SelectionDAG& DAG) const;
412     virtual SDValue
413       LowerReturn(SDValue Chain,
414                   CallingConv::ID CallConv, bool isVarArg,
415                   const SmallVectorImpl<ISD::OutputArg> &Outs,
416                   const SmallVectorImpl<SDValue> &OutVals,
417                   DebugLoc dl, SelectionDAG &DAG) const;
418
419     SDValue getARMCmp(SDValue LHS, SDValue RHS, ISD::CondCode CC,
420                       SDValue &ARMcc, SelectionDAG &DAG, DebugLoc dl) const;
421     SDValue getVFPCmp(SDValue LHS, SDValue RHS,
422                       SelectionDAG &DAG, DebugLoc dl) const;
423
424     SDValue OptimizeVFPBrcond(SDValue Op, SelectionDAG &DAG) const;
425
426     MachineBasicBlock *EmitAtomicCmpSwap(MachineInstr *MI,
427                                          MachineBasicBlock *BB,
428                                          unsigned Size) const;
429     MachineBasicBlock *EmitAtomicBinary(MachineInstr *MI,
430                                         MachineBasicBlock *BB,
431                                         unsigned Size,
432                                         unsigned BinOpcode) const;
433
434   };
435   
436   enum NEONModImmType {
437     VMOVModImm,
438     VMVNModImm,
439     OtherModImm
440   };
441   
442   
443   namespace ARM {
444     FastISel *createFastISel(FunctionLoweringInfo &funcInfo);
445   }
446 }
447
448 #endif  // ARMISELLOWERING_H