Make nomips16 mask not repeat if it ends with a '.'.
[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       // FP-to-int truncation node.
64       TruncIntFP,
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       // DSP shift nodes.
147       SHLL_DSP,
148       SHRA_DSP,
149       SHRL_DSP,
150
151       // DSP setcc and select_cc nodes.
152       SETCC_DSP,
153       SELECT_CC_DSP,
154
155       // Vector comparisons.
156       VALL_ZERO,
157       VANY_ZERO,
158       VALL_NONZERO,
159       VANY_NONZERO,
160
161       // Special case of BUILD_VECTOR where all elements are the same.
162       VSPLAT,
163       // Special case of VSPLAT where the result is v2i64, the operand is
164       // constant, and the operand fits in a signed 10-bits value.
165       VSPLATD,
166
167       // Combined (XOR (OR $a, $b), -1)
168       VNOR,
169
170       // Extended vector element extraction
171       VEXTRACT_SEXT_ELT,
172       VEXTRACT_ZEXT_ELT,
173
174       // Load/Store Left/Right nodes.
175       LWL = ISD::FIRST_TARGET_MEMORY_OPCODE,
176       LWR,
177       SWL,
178       SWR,
179       LDL,
180       LDR,
181       SDL,
182       SDR
183     };
184   }
185
186   //===--------------------------------------------------------------------===//
187   // TargetLowering Implementation
188   //===--------------------------------------------------------------------===//
189   class MipsFunctionInfo;
190
191   class MipsTargetLowering : public TargetLowering  {
192   public:
193     explicit MipsTargetLowering(MipsTargetMachine &TM);
194
195     static const MipsTargetLowering *create(MipsTargetMachine &TM);
196
197     virtual MVT getScalarShiftAmountTy(EVT LHSTy) const { return MVT::i32; }
198
199     virtual void LowerOperationWrapper(SDNode *N,
200                                        SmallVectorImpl<SDValue> &Results,
201                                        SelectionDAG &DAG) const;
202
203     /// LowerOperation - Provide custom lowering hooks for some operations.
204     virtual SDValue LowerOperation(SDValue Op, SelectionDAG &DAG) const;
205
206     /// ReplaceNodeResults - Replace the results of node with an illegal result
207     /// type with new values built out of custom code.
208     ///
209     virtual void ReplaceNodeResults(SDNode *N, SmallVectorImpl<SDValue>&Results,
210                                     SelectionDAG &DAG) const;
211
212     /// getTargetNodeName - This method returns the name of a target specific
213     //  DAG node.
214     virtual const char *getTargetNodeName(unsigned Opcode) const;
215
216     /// getSetCCResultType - get the ISD::SETCC result ValueType
217     EVT getSetCCResultType(LLVMContext &Context, EVT VT) const;
218
219     virtual SDValue PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const;
220
221     virtual MachineBasicBlock *
222     EmitInstrWithCustomInserter(MachineInstr *MI, MachineBasicBlock *MBB) const;
223
224     struct LTStr {
225       bool operator()(const char *S1, const char *S2) const {
226         return strcmp(S1, S2) < 0;
227       }
228     };
229
230   protected:
231     SDValue getGlobalReg(SelectionDAG &DAG, EVT Ty) const;
232
233     SDValue getAddrLocal(SDValue Op, SelectionDAG &DAG, bool HasMips64) const;
234
235     SDValue getAddrGlobal(SDValue Op, SelectionDAG &DAG, unsigned Flag) const;
236
237     SDValue getAddrGlobalLargeGOT(SDValue Op, SelectionDAG &DAG,
238                                   unsigned HiFlag, unsigned LoFlag) const;
239
240     /// This function fills Ops, which is the list of operands that will later
241     /// be used when a function call node is created. It also generates
242     /// copyToReg nodes to set up argument registers.
243     virtual void
244     getOpndList(SmallVectorImpl<SDValue> &Ops,
245                 std::deque< std::pair<unsigned, SDValue> > &RegsToPass,
246                 bool IsPICCall, bool GlobalOrExternal, bool InternalLinkage,
247                 CallLoweringInfo &CLI, SDValue Callee, SDValue Chain) const;
248
249     /// ByValArgInfo - Byval argument information.
250     struct ByValArgInfo {
251       unsigned FirstIdx; // Index of the first register used.
252       unsigned NumRegs;  // Number of registers used for this argument.
253       unsigned Address;  // Offset of the stack area used to pass this argument.
254
255       ByValArgInfo() : FirstIdx(0), NumRegs(0), Address(0) {}
256     };
257
258     /// MipsCC - This class provides methods used to analyze formal and call
259     /// arguments and inquire about calling convention information.
260     class MipsCC {
261     public:
262       enum SpecialCallingConvType {
263         Mips16RetHelperConv, NoSpecialCallingConv
264       };
265
266       MipsCC(CallingConv::ID CallConv, bool IsO32, bool IsFP64, CCState &Info,
267              SpecialCallingConvType SpecialCallingConv = NoSpecialCallingConv);
268
269
270       void analyzeCallOperands(const SmallVectorImpl<ISD::OutputArg> &Outs,
271                                bool IsVarArg, bool IsSoftFloat,
272                                const SDNode *CallNode,
273                                std::vector<ArgListEntry> &FuncArgs);
274       void analyzeFormalArguments(const SmallVectorImpl<ISD::InputArg> &Ins,
275                                   bool IsSoftFloat,
276                                   Function::const_arg_iterator FuncArg);
277
278       void analyzeCallResult(const SmallVectorImpl<ISD::InputArg> &Ins,
279                              bool IsSoftFloat, const SDNode *CallNode,
280                              const Type *RetTy) const;
281
282       void analyzeReturn(const SmallVectorImpl<ISD::OutputArg> &Outs,
283                          bool IsSoftFloat, const Type *RetTy) const;
284
285       const CCState &getCCInfo() const { return CCInfo; }
286
287       /// hasByValArg - Returns true if function has byval arguments.
288       bool hasByValArg() const { return !ByValArgs.empty(); }
289
290       /// regSize - Size (in number of bits) of integer registers.
291       unsigned regSize() const { return IsO32 ? 4 : 8; }
292
293       /// numIntArgRegs - Number of integer registers available for calls.
294       unsigned numIntArgRegs() const;
295
296       /// reservedArgArea - The size of the area the caller reserves for
297       /// register arguments. This is 16-byte if ABI is O32.
298       unsigned reservedArgArea() const;
299
300       /// Return pointer to array of integer argument registers.
301       const uint16_t *intArgRegs() const;
302
303       typedef SmallVectorImpl<ByValArgInfo>::const_iterator byval_iterator;
304       byval_iterator byval_begin() const { return ByValArgs.begin(); }
305       byval_iterator byval_end() const { return ByValArgs.end(); }
306
307     private:
308       void handleByValArg(unsigned ValNo, MVT ValVT, MVT LocVT,
309                           CCValAssign::LocInfo LocInfo,
310                           ISD::ArgFlagsTy ArgFlags);
311
312       /// useRegsForByval - Returns true if the calling convention allows the
313       /// use of registers to pass byval arguments.
314       bool useRegsForByval() const { return CallConv != CallingConv::Fast; }
315
316       /// Return the function that analyzes fixed argument list functions.
317       llvm::CCAssignFn *fixedArgFn() const;
318
319       /// Return the function that analyzes variable argument list functions.
320       llvm::CCAssignFn *varArgFn() const;
321
322       const uint16_t *shadowRegs() const;
323
324       void allocateRegs(ByValArgInfo &ByVal, unsigned ByValSize,
325                         unsigned Align);
326
327       /// Return the type of the register which is used to pass an argument or
328       /// return a value. This function returns f64 if the argument is an i64
329       /// value which has been generated as a result of softening an f128 value.
330       /// Otherwise, it just returns VT.
331       MVT getRegVT(MVT VT, const Type *OrigTy, const SDNode *CallNode,
332                    bool IsSoftFloat) const;
333
334       template<typename Ty>
335       void analyzeReturn(const SmallVectorImpl<Ty> &RetVals, bool IsSoftFloat,
336                          const SDNode *CallNode, const Type *RetTy) const;
337
338       CCState &CCInfo;
339       CallingConv::ID CallConv;
340       bool IsO32, IsFP64;
341       SpecialCallingConvType SpecialCallingConv;
342       SmallVector<ByValArgInfo, 2> ByValArgs;
343     };
344   protected:
345     SDValue lowerLOAD(SDValue Op, SelectionDAG &DAG) const;
346     SDValue lowerSTORE(SDValue Op, SelectionDAG &DAG) const;
347
348     // Subtarget Info
349     const MipsSubtarget *Subtarget;
350
351     bool HasMips64, IsN64, IsO32;
352
353   private:
354
355     MipsCC::SpecialCallingConvType getSpecialCallingConv(SDValue Callee) const;
356     // Lower Operand helpers
357     SDValue LowerCallResult(SDValue Chain, SDValue InFlag,
358                             CallingConv::ID CallConv, bool isVarArg,
359                             const SmallVectorImpl<ISD::InputArg> &Ins,
360                             SDLoc dl, SelectionDAG &DAG,
361                             SmallVectorImpl<SDValue> &InVals,
362                             const SDNode *CallNode, const Type *RetTy) const;
363
364     // Lower Operand specifics
365     SDValue lowerBR_JT(SDValue Op, SelectionDAG &DAG) const;
366     SDValue lowerBRCOND(SDValue Op, SelectionDAG &DAG) const;
367     SDValue lowerConstantPool(SDValue Op, SelectionDAG &DAG) const;
368     SDValue lowerGlobalAddress(SDValue Op, SelectionDAG &DAG) const;
369     SDValue lowerBlockAddress(SDValue Op, SelectionDAG &DAG) const;
370     SDValue lowerGlobalTLSAddress(SDValue Op, SelectionDAG &DAG) const;
371     SDValue lowerJumpTable(SDValue Op, SelectionDAG &DAG) const;
372     SDValue lowerSELECT(SDValue Op, SelectionDAG &DAG) const;
373     SDValue lowerSELECT_CC(SDValue Op, SelectionDAG &DAG) const;
374     SDValue lowerSETCC(SDValue Op, SelectionDAG &DAG) const;
375     SDValue lowerVASTART(SDValue Op, SelectionDAG &DAG) const;
376     SDValue lowerFCOPYSIGN(SDValue Op, SelectionDAG &DAG) const;
377     SDValue lowerFABS(SDValue Op, SelectionDAG &DAG) const;
378     SDValue lowerFRAMEADDR(SDValue Op, SelectionDAG &DAG) const;
379     SDValue lowerRETURNADDR(SDValue Op, SelectionDAG &DAG) const;
380     SDValue lowerEH_RETURN(SDValue Op, SelectionDAG &DAG) const;
381     SDValue lowerATOMIC_FENCE(SDValue Op, SelectionDAG& DAG) const;
382     SDValue lowerShiftLeftParts(SDValue Op, SelectionDAG& DAG) const;
383     SDValue lowerShiftRightParts(SDValue Op, SelectionDAG& DAG,
384                                  bool IsSRA) const;
385     SDValue lowerADD(SDValue Op, SelectionDAG &DAG) const;
386     SDValue lowerFP_TO_SINT(SDValue Op, SelectionDAG &DAG) const;
387
388     /// isEligibleForTailCallOptimization - Check whether the call is eligible
389     /// for tail call optimization.
390     virtual bool
391     isEligibleForTailCallOptimization(const MipsCC &MipsCCInfo,
392                                       unsigned NextStackOffset,
393                                       const MipsFunctionInfo& FI) const = 0;
394
395     /// copyByValArg - Copy argument registers which were used to pass a byval
396     /// argument to the stack. Create a stack frame object for the byval
397     /// argument.
398     void copyByValRegs(SDValue Chain, SDLoc DL,
399                        std::vector<SDValue> &OutChains, SelectionDAG &DAG,
400                        const ISD::ArgFlagsTy &Flags,
401                        SmallVectorImpl<SDValue> &InVals,
402                        const Argument *FuncArg,
403                        const MipsCC &CC, const ByValArgInfo &ByVal) const;
404
405     /// passByValArg - Pass a byval argument in registers or on stack.
406     void passByValArg(SDValue Chain, SDLoc DL,
407                       std::deque< std::pair<unsigned, SDValue> > &RegsToPass,
408                       SmallVectorImpl<SDValue> &MemOpChains, SDValue StackPtr,
409                       MachineFrameInfo *MFI, SelectionDAG &DAG, SDValue Arg,
410                       const MipsCC &CC, const ByValArgInfo &ByVal,
411                       const ISD::ArgFlagsTy &Flags, bool isLittle) const;
412
413     /// writeVarArgRegs - Write variable function arguments passed in registers
414     /// to the stack. Also create a stack frame object for the first variable
415     /// argument.
416     void writeVarArgRegs(std::vector<SDValue> &OutChains, const MipsCC &CC,
417                          SDValue Chain, SDLoc DL, SelectionDAG &DAG) const;
418
419     virtual SDValue
420       LowerFormalArguments(SDValue Chain,
421                            CallingConv::ID CallConv, bool isVarArg,
422                            const SmallVectorImpl<ISD::InputArg> &Ins,
423                            SDLoc dl, SelectionDAG &DAG,
424                            SmallVectorImpl<SDValue> &InVals) const;
425
426     SDValue passArgOnStack(SDValue StackPtr, unsigned Offset, SDValue Chain,
427                            SDValue Arg, SDLoc DL, bool IsTailCall,
428                            SelectionDAG &DAG) const;
429
430     virtual SDValue
431       LowerCall(TargetLowering::CallLoweringInfo &CLI,
432                 SmallVectorImpl<SDValue> &InVals) const;
433
434     virtual bool
435       CanLowerReturn(CallingConv::ID CallConv, MachineFunction &MF,
436                      bool isVarArg,
437                      const SmallVectorImpl<ISD::OutputArg> &Outs,
438                      LLVMContext &Context) const;
439
440     virtual SDValue
441       LowerReturn(SDValue Chain,
442                   CallingConv::ID CallConv, bool isVarArg,
443                   const SmallVectorImpl<ISD::OutputArg> &Outs,
444                   const SmallVectorImpl<SDValue> &OutVals,
445                   SDLoc dl, SelectionDAG &DAG) const;
446
447     // Inline asm support
448     ConstraintType getConstraintType(const std::string &Constraint) const;
449
450     /// Examine constraint string and operand type and determine a weight value.
451     /// The operand object must already have been set up with the operand type.
452     ConstraintWeight getSingleConstraintMatchWeight(
453       AsmOperandInfo &info, const char *constraint) const;
454
455     /// This function parses registers that appear in inline-asm constraints.
456     /// It returns pair (0, 0) on failure.
457     std::pair<unsigned, const TargetRegisterClass *>
458     parseRegForInlineAsmConstraint(const StringRef &C, MVT VT) const;
459
460     std::pair<unsigned, const TargetRegisterClass*>
461               getRegForInlineAsmConstraint(const std::string &Constraint,
462                                            MVT VT) const;
463
464     /// LowerAsmOperandForConstraint - Lower the specified operand into the Ops
465     /// vector.  If it is invalid, don't add anything to Ops. If hasMemory is
466     /// true it means one of the asm constraint of the inline asm instruction
467     /// being processed is 'm'.
468     virtual void LowerAsmOperandForConstraint(SDValue Op,
469                                               std::string &Constraint,
470                                               std::vector<SDValue> &Ops,
471                                               SelectionDAG &DAG) const;
472
473     virtual bool isLegalAddressingMode(const AddrMode &AM, Type *Ty) const;
474
475     virtual bool isOffsetFoldingLegal(const GlobalAddressSDNode *GA) const;
476
477     virtual EVT getOptimalMemOpType(uint64_t Size, unsigned DstAlign,
478                                     unsigned SrcAlign,
479                                     bool IsMemset, bool ZeroMemset,
480                                     bool MemcpyStrSrc,
481                                     MachineFunction &MF) const;
482
483     /// isFPImmLegal - Returns true if the target can instruction select the
484     /// specified FP immediate natively. If false, the legalizer will
485     /// materialize the FP immediate as a load from a constant pool.
486     virtual bool isFPImmLegal(const APFloat &Imm, EVT VT) const;
487
488     virtual unsigned getJumpTableEncoding() const;
489
490     MachineBasicBlock *emitAtomicBinary(MachineInstr *MI, MachineBasicBlock *BB,
491                     unsigned Size, unsigned BinOpcode, bool Nand = false) const;
492     MachineBasicBlock *emitAtomicBinaryPartword(MachineInstr *MI,
493                     MachineBasicBlock *BB, unsigned Size, unsigned BinOpcode,
494                     bool Nand = false) const;
495     MachineBasicBlock *emitAtomicCmpSwap(MachineInstr *MI,
496                                   MachineBasicBlock *BB, unsigned Size) const;
497     MachineBasicBlock *emitAtomicCmpSwapPartword(MachineInstr *MI,
498                                   MachineBasicBlock *BB, unsigned Size) const;
499   };
500
501   /// Create MipsTargetLowering objects.
502   const MipsTargetLowering *createMips16TargetLowering(MipsTargetMachine &TM);
503   const MipsTargetLowering *createMipsSETargetLowering(MipsTargetMachine &TM);
504 }
505
506 #endif // MipsISELLOWERING_H