[mips] Move MipsTargetLowering::lowerINTRINSIC_W_CHAIN and
[oota-llvm.git] / lib / Target / Mips / MipsISelLowering.h
1 //===-- MipsISelLowering.h - Mips 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 Mips uses to lower LLVM code into a
11 // selection DAG.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef MipsISELLOWERING_H
16 #define MipsISELLOWERING_H
17
18 #include "Mips.h"
19 #include "MipsSubtarget.h"
20 #include "llvm/CodeGen/CallingConvLower.h"
21 #include "llvm/CodeGen/SelectionDAG.h"
22 #include "llvm/IR/Function.h"
23 #include "llvm/Target/TargetLowering.h"
24 #include <deque>
25 #include <string>
26
27 namespace llvm {
28   namespace MipsISD {
29     enum NodeType {
30       // Start the numbering from where ISD NodeType finishes.
31       FIRST_NUMBER = ISD::BUILTIN_OP_END,
32
33       // Jump and link (call)
34       JmpLink,
35
36       // Tail call
37       TailCall,
38
39       // Get the Higher 16 bits from a 32-bit immediate
40       // No relation with Mips Hi register
41       Hi,
42
43       // Get the Lower 16 bits from a 32-bit immediate
44       // No relation with Mips Lo register
45       Lo,
46
47       // Handle gp_rel (small data/bss sections) relocation.
48       GPRel,
49
50       // Thread Pointer
51       ThreadPointer,
52
53       // Floating Point Branch Conditional
54       FPBrcond,
55
56       // Floating Point Compare
57       FPCmp,
58
59       // Floating Point Conditional Moves
60       CMovFP_T,
61       CMovFP_F,
62
63       // Floating Point Rounding
64       FPRound,
65
66       // Return
67       Ret,
68
69       EH_RETURN,
70
71       // Node used to extract integer from accumulator.
72       ExtractLOHI,
73
74       // Node used to insert integers to accumulator.
75       InsertLOHI,
76
77       // Mult nodes.
78       Mult,
79       Multu,
80
81       // MAdd/Sub nodes
82       MAdd,
83       MAddu,
84       MSub,
85       MSubu,
86
87       // DivRem(u)
88       DivRem,
89       DivRemU,
90       DivRem16,
91       DivRemU16,
92
93       BuildPairF64,
94       ExtractElementF64,
95
96       Wrapper,
97
98       DynAlloc,
99
100       Sync,
101
102       Ext,
103       Ins,
104
105       // EXTR.W instrinsic nodes.
106       EXTP,
107       EXTPDP,
108       EXTR_S_H,
109       EXTR_W,
110       EXTR_R_W,
111       EXTR_RS_W,
112       SHILO,
113       MTHLIP,
114
115       // DPA.W intrinsic nodes.
116       MULSAQ_S_W_PH,
117       MAQ_S_W_PHL,
118       MAQ_S_W_PHR,
119       MAQ_SA_W_PHL,
120       MAQ_SA_W_PHR,
121       DPAU_H_QBL,
122       DPAU_H_QBR,
123       DPSU_H_QBL,
124       DPSU_H_QBR,
125       DPAQ_S_W_PH,
126       DPSQ_S_W_PH,
127       DPAQ_SA_L_W,
128       DPSQ_SA_L_W,
129       DPA_W_PH,
130       DPS_W_PH,
131       DPAQX_S_W_PH,
132       DPAQX_SA_W_PH,
133       DPAX_W_PH,
134       DPSX_W_PH,
135       DPSQX_S_W_PH,
136       DPSQX_SA_W_PH,
137       MULSA_W_PH,
138
139       MULT,
140       MULTU,
141       MADD_DSP,
142       MADDU_DSP,
143       MSUB_DSP,
144       MSUBU_DSP,
145
146       // Load/Store Left/Right nodes.
147       LWL = ISD::FIRST_TARGET_MEMORY_OPCODE,
148       LWR,
149       SWL,
150       SWR,
151       LDL,
152       LDR,
153       SDL,
154       SDR
155     };
156   }
157
158   //===--------------------------------------------------------------------===//
159   // TargetLowering Implementation
160   //===--------------------------------------------------------------------===//
161   class MipsFunctionInfo;
162
163   class MipsTargetLowering : public TargetLowering  {
164   public:
165     explicit MipsTargetLowering(MipsTargetMachine &TM);
166
167     static const MipsTargetLowering *create(MipsTargetMachine &TM);
168
169     virtual MVT getScalarShiftAmountTy(EVT LHSTy) const { return MVT::i32; }
170
171     virtual void LowerOperationWrapper(SDNode *N,
172                                        SmallVectorImpl<SDValue> &Results,
173                                        SelectionDAG &DAG) const;
174
175     /// LowerOperation - Provide custom lowering hooks for some operations.
176     virtual SDValue LowerOperation(SDValue Op, SelectionDAG &DAG) const;
177
178     /// ReplaceNodeResults - Replace the results of node with an illegal result
179     /// type with new values built out of custom code.
180     ///
181     virtual void ReplaceNodeResults(SDNode *N, SmallVectorImpl<SDValue>&Results,
182                                     SelectionDAG &DAG) const;
183
184     /// getTargetNodeName - This method returns the name of a target specific
185     //  DAG node.
186     virtual const char *getTargetNodeName(unsigned Opcode) const;
187
188     /// getSetCCResultType - get the ISD::SETCC result ValueType
189     EVT getSetCCResultType(EVT VT) const;
190
191     virtual SDValue PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const;
192
193     virtual MachineBasicBlock *
194     EmitInstrWithCustomInserter(MachineInstr *MI, MachineBasicBlock *MBB) const;
195
196     struct LTStr {
197       bool operator()(const char *S1, const char *S2) const {
198         return strcmp(S1, S2) < 0;
199       }
200     };
201
202   protected:
203     SDValue getGlobalReg(SelectionDAG &DAG, EVT Ty) const;
204
205     SDValue getAddrLocal(SDValue Op, SelectionDAG &DAG, bool HasMips64) const;
206
207     SDValue getAddrGlobal(SDValue Op, SelectionDAG &DAG, unsigned Flag) const;
208
209     SDValue getAddrGlobalLargeGOT(SDValue Op, SelectionDAG &DAG,
210                                   unsigned HiFlag, unsigned LoFlag) const;
211
212     /// This function fills Ops, which is the list of operands that will later
213     /// be used when a function call node is created. It also generates
214     /// copyToReg nodes to set up argument registers.
215     virtual void
216     getOpndList(SmallVectorImpl<SDValue> &Ops,
217                 std::deque< std::pair<unsigned, SDValue> > &RegsToPass,
218                 bool IsPICCall, bool GlobalOrExternal, bool InternalLinkage,
219                 CallLoweringInfo &CLI, SDValue Callee, SDValue Chain) const;
220
221     /// ByValArgInfo - Byval argument information.
222     struct ByValArgInfo {
223       unsigned FirstIdx; // Index of the first register used.
224       unsigned NumRegs;  // Number of registers used for this argument.
225       unsigned Address;  // Offset of the stack area used to pass this argument.
226
227       ByValArgInfo() : FirstIdx(0), NumRegs(0), Address(0) {}
228     };
229
230     /// MipsCC - This class provides methods used to analyze formal and call
231     /// arguments and inquire about calling convention information.
232     class MipsCC {
233     public:
234       MipsCC(CallingConv::ID CallConv, bool IsO32, CCState &Info);
235
236       void analyzeCallOperands(const SmallVectorImpl<ISD::OutputArg> &Outs,
237                                bool IsVarArg, bool IsSoftFloat,
238                                const SDNode *CallNode,
239                                std::vector<ArgListEntry> &FuncArgs);
240       void analyzeFormalArguments(const SmallVectorImpl<ISD::InputArg> &Ins,
241                                   bool IsSoftFloat,
242                                   Function::const_arg_iterator FuncArg);
243
244       void analyzeCallResult(const SmallVectorImpl<ISD::InputArg> &Ins,
245                              bool IsSoftFloat, const SDNode *CallNode,
246                              const Type *RetTy) const;
247
248       void analyzeReturn(const SmallVectorImpl<ISD::OutputArg> &Outs,
249                          bool IsSoftFloat, const Type *RetTy) const;
250
251       const CCState &getCCInfo() const { return CCInfo; }
252
253       /// hasByValArg - Returns true if function has byval arguments.
254       bool hasByValArg() const { return !ByValArgs.empty(); }
255
256       /// regSize - Size (in number of bits) of integer registers.
257       unsigned regSize() const { return IsO32 ? 4 : 8; }
258
259       /// numIntArgRegs - Number of integer registers available for calls.
260       unsigned numIntArgRegs() const;
261
262       /// reservedArgArea - The size of the area the caller reserves for
263       /// register arguments. This is 16-byte if ABI is O32.
264       unsigned reservedArgArea() const;
265
266       /// Return pointer to array of integer argument registers.
267       const uint16_t *intArgRegs() const;
268
269       typedef SmallVector<ByValArgInfo, 2>::const_iterator byval_iterator;
270       byval_iterator byval_begin() const { return ByValArgs.begin(); }
271       byval_iterator byval_end() const { return ByValArgs.end(); }
272
273     private:
274       void handleByValArg(unsigned ValNo, MVT ValVT, MVT LocVT,
275                           CCValAssign::LocInfo LocInfo,
276                           ISD::ArgFlagsTy ArgFlags);
277
278       /// useRegsForByval - Returns true if the calling convention allows the
279       /// use of registers to pass byval arguments.
280       bool useRegsForByval() const { return CallConv != CallingConv::Fast; }
281
282       /// Return the function that analyzes fixed argument list functions.
283       llvm::CCAssignFn *fixedArgFn() const;
284
285       /// Return the function that analyzes variable argument list functions.
286       llvm::CCAssignFn *varArgFn() const;
287
288       const uint16_t *shadowRegs() const;
289
290       void allocateRegs(ByValArgInfo &ByVal, unsigned ByValSize,
291                         unsigned Align);
292
293       /// Return the type of the register which is used to pass an argument or
294       /// return a value. This function returns f64 if the argument is an i64
295       /// value which has been generated as a result of softening an f128 value.
296       /// Otherwise, it just returns VT.
297       MVT getRegVT(MVT VT, const Type *OrigTy, const SDNode *CallNode,
298                    bool IsSoftFloat) const;
299
300       template<typename Ty>
301       void analyzeReturn(const SmallVectorImpl<Ty> &RetVals, bool IsSoftFloat,
302                          const SDNode *CallNode, const Type *RetTy) const;
303
304       CCState &CCInfo;
305       CallingConv::ID CallConv;
306       bool IsO32;
307       SmallVector<ByValArgInfo, 2> ByValArgs;
308     };
309
310     // Subtarget Info
311     const MipsSubtarget *Subtarget;
312
313     bool HasMips64, IsN64, IsO32;
314
315   private:
316     // Lower Operand helpers
317     SDValue LowerCallResult(SDValue Chain, SDValue InFlag,
318                             CallingConv::ID CallConv, bool isVarArg,
319                             const SmallVectorImpl<ISD::InputArg> &Ins,
320                             DebugLoc dl, SelectionDAG &DAG,
321                             SmallVectorImpl<SDValue> &InVals,
322                             const SDNode *CallNode, const Type *RetTy) const;
323
324     // Lower Operand specifics
325     SDValue lowerBR_JT(SDValue Op, SelectionDAG &DAG) const;
326     SDValue lowerBRCOND(SDValue Op, SelectionDAG &DAG) const;
327     SDValue lowerConstantPool(SDValue Op, SelectionDAG &DAG) const;
328     SDValue lowerGlobalAddress(SDValue Op, SelectionDAG &DAG) const;
329     SDValue lowerBlockAddress(SDValue Op, SelectionDAG &DAG) const;
330     SDValue lowerGlobalTLSAddress(SDValue Op, SelectionDAG &DAG) const;
331     SDValue lowerJumpTable(SDValue Op, SelectionDAG &DAG) const;
332     SDValue lowerSELECT(SDValue Op, SelectionDAG &DAG) const;
333     SDValue lowerSELECT_CC(SDValue Op, SelectionDAG &DAG) const;
334     SDValue lowerSETCC(SDValue Op, SelectionDAG &DAG) const;
335     SDValue lowerVASTART(SDValue Op, SelectionDAG &DAG) const;
336     SDValue lowerFCOPYSIGN(SDValue Op, SelectionDAG &DAG) const;
337     SDValue lowerFABS(SDValue Op, SelectionDAG &DAG) const;
338     SDValue lowerFRAMEADDR(SDValue Op, SelectionDAG &DAG) const;
339     SDValue lowerRETURNADDR(SDValue Op, SelectionDAG &DAG) const;
340     SDValue lowerEH_RETURN(SDValue Op, SelectionDAG &DAG) const;
341     SDValue lowerMEMBARRIER(SDValue Op, SelectionDAG& DAG) const;
342     SDValue lowerATOMIC_FENCE(SDValue Op, SelectionDAG& DAG) const;
343     SDValue lowerShiftLeftParts(SDValue Op, SelectionDAG& DAG) const;
344     SDValue lowerShiftRightParts(SDValue Op, SelectionDAG& DAG,
345                                  bool IsSRA) const;
346     SDValue lowerLOAD(SDValue Op, SelectionDAG &DAG) const;
347     SDValue lowerSTORE(SDValue Op, SelectionDAG &DAG) const;
348     SDValue lowerADD(SDValue Op, SelectionDAG &DAG) const;
349
350     /// isEligibleForTailCallOptimization - Check whether the call is eligible
351     /// for tail call optimization.
352     virtual bool
353     isEligibleForTailCallOptimization(const MipsCC &MipsCCInfo,
354                                       unsigned NextStackOffset,
355                                       const MipsFunctionInfo& FI) const = 0;
356
357     /// copyByValArg - Copy argument registers which were used to pass a byval
358     /// argument to the stack. Create a stack frame object for the byval
359     /// argument.
360     void copyByValRegs(SDValue Chain, DebugLoc DL,
361                        std::vector<SDValue> &OutChains, SelectionDAG &DAG,
362                        const ISD::ArgFlagsTy &Flags,
363                        SmallVectorImpl<SDValue> &InVals,
364                        const Argument *FuncArg,
365                        const MipsCC &CC, const ByValArgInfo &ByVal) const;
366
367     /// passByValArg - Pass a byval argument in registers or on stack.
368     void passByValArg(SDValue Chain, DebugLoc DL,
369                       std::deque< std::pair<unsigned, SDValue> > &RegsToPass,
370                       SmallVector<SDValue, 8> &MemOpChains, SDValue StackPtr,
371                       MachineFrameInfo *MFI, SelectionDAG &DAG, SDValue Arg,
372                       const MipsCC &CC, const ByValArgInfo &ByVal,
373                       const ISD::ArgFlagsTy &Flags, bool isLittle) const;
374
375     /// writeVarArgRegs - Write variable function arguments passed in registers
376     /// to the stack. Also create a stack frame object for the first variable
377     /// argument.
378     void writeVarArgRegs(std::vector<SDValue> &OutChains, const MipsCC &CC,
379                          SDValue Chain, DebugLoc DL, SelectionDAG &DAG) const;
380
381     virtual SDValue
382       LowerFormalArguments(SDValue Chain,
383                            CallingConv::ID CallConv, bool isVarArg,
384                            const SmallVectorImpl<ISD::InputArg> &Ins,
385                            DebugLoc dl, SelectionDAG &DAG,
386                            SmallVectorImpl<SDValue> &InVals) const;
387
388     SDValue passArgOnStack(SDValue StackPtr, unsigned Offset, SDValue Chain,
389                            SDValue Arg, DebugLoc DL, bool IsTailCall,
390                            SelectionDAG &DAG) const;
391
392     virtual SDValue
393       LowerCall(TargetLowering::CallLoweringInfo &CLI,
394                 SmallVectorImpl<SDValue> &InVals) const;
395
396     virtual bool
397       CanLowerReturn(CallingConv::ID CallConv, MachineFunction &MF,
398                      bool isVarArg,
399                      const SmallVectorImpl<ISD::OutputArg> &Outs,
400                      LLVMContext &Context) const;
401
402     virtual SDValue
403       LowerReturn(SDValue Chain,
404                   CallingConv::ID CallConv, bool isVarArg,
405                   const SmallVectorImpl<ISD::OutputArg> &Outs,
406                   const SmallVectorImpl<SDValue> &OutVals,
407                   DebugLoc dl, SelectionDAG &DAG) const;
408
409     // Inline asm support
410     ConstraintType getConstraintType(const std::string &Constraint) const;
411
412     /// Examine constraint string and operand type and determine a weight value.
413     /// The operand object must already have been set up with the operand type.
414     ConstraintWeight getSingleConstraintMatchWeight(
415       AsmOperandInfo &info, const char *constraint) const;
416
417     std::pair<unsigned, const TargetRegisterClass*>
418               getRegForInlineAsmConstraint(const std::string &Constraint,
419               EVT VT) const;
420
421     /// LowerAsmOperandForConstraint - Lower the specified operand into the Ops
422     /// vector.  If it is invalid, don't add anything to Ops. If hasMemory is
423     /// true it means one of the asm constraint of the inline asm instruction
424     /// being processed is 'm'.
425     virtual void LowerAsmOperandForConstraint(SDValue Op,
426                                               std::string &Constraint,
427                                               std::vector<SDValue> &Ops,
428                                               SelectionDAG &DAG) const;
429
430     virtual bool isLegalAddressingMode(const AddrMode &AM, Type *Ty) const;
431
432     virtual bool isOffsetFoldingLegal(const GlobalAddressSDNode *GA) const;
433
434     virtual EVT getOptimalMemOpType(uint64_t Size, unsigned DstAlign,
435                                     unsigned SrcAlign,
436                                     bool IsMemset, bool ZeroMemset,
437                                     bool MemcpyStrSrc,
438                                     MachineFunction &MF) const;
439
440     /// isFPImmLegal - Returns true if the target can instruction select the
441     /// specified FP immediate natively. If false, the legalizer will
442     /// materialize the FP immediate as a load from a constant pool.
443     virtual bool isFPImmLegal(const APFloat &Imm, EVT VT) const;
444
445     virtual unsigned getJumpTableEncoding() const;
446
447     MachineBasicBlock *emitAtomicBinary(MachineInstr *MI, MachineBasicBlock *BB,
448                     unsigned Size, unsigned BinOpcode, bool Nand = false) const;
449     MachineBasicBlock *emitAtomicBinaryPartword(MachineInstr *MI,
450                     MachineBasicBlock *BB, unsigned Size, unsigned BinOpcode,
451                     bool Nand = false) const;
452     MachineBasicBlock *emitAtomicCmpSwap(MachineInstr *MI,
453                                   MachineBasicBlock *BB, unsigned Size) const;
454     MachineBasicBlock *emitAtomicCmpSwapPartword(MachineInstr *MI,
455                                   MachineBasicBlock *BB, unsigned Size) const;
456   };
457
458   /// Create MipsTargetLowering objects.
459   const MipsTargetLowering *createMips16TargetLowering(MipsTargetMachine &TM);
460   const MipsTargetLowering *createMipsSETargetLowering(MipsTargetMachine &TM);
461 }
462
463 #endif // MipsISELLOWERING_H