Enhance EmitInstrWithCustomInserter() so target can specify CFG changes that sdisel...
[oota-llvm.git] / lib / Target / PowerPC / PPCISelLowering.h
1 //===-- PPCISelLowering.h - PPC32 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 PPC uses to lower LLVM code into a
11 // selection DAG.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef LLVM_TARGET_POWERPC_PPC32ISELLOWERING_H
16 #define LLVM_TARGET_POWERPC_PPC32ISELLOWERING_H
17
18 #include "llvm/Target/TargetLowering.h"
19 #include "llvm/CodeGen/SelectionDAG.h"
20 #include "PPC.h"
21 #include "PPCSubtarget.h"
22
23 namespace llvm {
24   namespace PPCISD {
25     enum NodeType {
26       // Start the numbering where the builtin ops and target ops leave off.
27       FIRST_NUMBER = ISD::BUILTIN_OP_END,
28
29       /// FSEL - Traditional three-operand fsel node.
30       ///
31       FSEL,
32       
33       /// FCFID - The FCFID instruction, taking an f64 operand and producing
34       /// and f64 value containing the FP representation of the integer that
35       /// was temporarily in the f64 operand.
36       FCFID,
37       
38       /// FCTI[D,W]Z - The FCTIDZ and FCTIWZ instructions, taking an f32 or f64 
39       /// operand, producing an f64 value containing the integer representation
40       /// of that FP value.
41       FCTIDZ, FCTIWZ,
42       
43       /// STFIWX - The STFIWX instruction.  The first operand is an input token
44       /// chain, then an f64 value to store, then an address to store it to,
45       /// then a SRCVALUE for the address.
46       STFIWX,
47       
48       // VMADDFP, VNMSUBFP - The VMADDFP and VNMSUBFP instructions, taking
49       // three v4f32 operands and producing a v4f32 result.
50       VMADDFP, VNMSUBFP,
51       
52       /// VPERM - The PPC VPERM Instruction.
53       ///
54       VPERM,
55       
56       /// Hi/Lo - These represent the high and low 16-bit parts of a global
57       /// address respectively.  These nodes have two operands, the first of
58       /// which must be a TargetGlobalAddress, and the second of which must be a
59       /// Constant.  Selected naively, these turn into 'lis G+C' and 'li G+C',
60       /// though these are usually folded into other nodes.
61       Hi, Lo,
62       
63       TOC_ENTRY,
64
65       /// OPRC, CHAIN = DYNALLOC(CHAIN, NEGSIZE, FRAME_INDEX)
66       /// This instruction is lowered in PPCRegisterInfo::eliminateFrameIndex to
67       /// compute an allocation on the stack.
68       DYNALLOC,
69       
70       /// GlobalBaseReg - On Darwin, this node represents the result of the mflr
71       /// at function entry, used for PIC code.
72       GlobalBaseReg,
73       
74       /// These nodes represent the 32-bit PPC shifts that operate on 6-bit
75       /// shift amounts.  These nodes are generated by the multi-precision shift
76       /// code.
77       SRL, SRA, SHL,
78       
79       /// EXTSW_32 - This is the EXTSW instruction for use with "32-bit"
80       /// registers.
81       EXTSW_32,
82
83       /// STD_32 - This is the STD instruction for use with "32-bit" registers.
84       STD_32,
85       
86       /// CALL - A direct function call.
87       CALL_Darwin, CALL_SVR4,
88       
89       /// NOP - Special NOP which follows 64-bit SVR4 calls.
90       NOP,
91
92       /// CHAIN,FLAG = MTCTR(VAL, CHAIN[, INFLAG]) - Directly corresponds to a
93       /// MTCTR instruction.
94       MTCTR,
95       
96       /// CHAIN,FLAG = BCTRL(CHAIN, INFLAG) - Directly corresponds to a
97       /// BCTRL instruction.
98       BCTRL_Darwin, BCTRL_SVR4,
99       
100       /// Return with a flag operand, matched by 'blr'
101       RET_FLAG,
102       
103       /// R32 = MFCR(CRREG, INFLAG) - Represents the MFCR/MFOCRF instructions.
104       /// This copies the bits corresponding to the specified CRREG into the
105       /// resultant GPR.  Bits corresponding to other CR regs are undefined.
106       MFCR,
107
108       /// RESVEC = VCMP(LHS, RHS, OPC) - Represents one of the altivec VCMP*
109       /// instructions.  For lack of better number, we use the opcode number
110       /// encoding for the OPC field to identify the compare.  For example, 838
111       /// is VCMPGTSH.
112       VCMP,
113       
114       /// RESVEC, OUTFLAG = VCMPo(LHS, RHS, OPC) - Represents one of the
115       /// altivec VCMP*o instructions.  For lack of better number, we use the 
116       /// opcode number encoding for the OPC field to identify the compare.  For
117       /// example, 838 is VCMPGTSH.
118       VCMPo,
119       
120       /// CHAIN = COND_BRANCH CHAIN, CRRC, OPC, DESTBB [, INFLAG] - This
121       /// corresponds to the COND_BRANCH pseudo instruction.  CRRC is the
122       /// condition register to branch on, OPC is the branch opcode to use (e.g.
123       /// PPC::BLE), DESTBB is the destination block to branch to, and INFLAG is
124       /// an optional input flag argument.
125       COND_BRANCH,
126       
127       /// CHAIN = STBRX CHAIN, GPRC, Ptr, SRCVALUE, Type - This is a 
128       /// byte-swapping store instruction.  It byte-swaps the low "Type" bits of
129       /// the GPRC input, then stores it through Ptr.  Type can be either i16 or
130       /// i32.
131       STBRX, 
132       
133       /// GPRC, CHAIN = LBRX CHAIN, Ptr, SRCVALUE, Type - This is a 
134       /// byte-swapping load instruction.  It loads "Type" bits, byte swaps it,
135       /// then puts it in the bottom bits of the GPRC.  TYPE can be either i16
136       /// or i32.
137       LBRX,
138
139       // The following 5 instructions are used only as part of the
140       // long double-to-int conversion sequence.
141
142       /// OUTFLAG = MFFS F8RC - This moves the FPSCR (not modelled) into the
143       /// register.
144       MFFS,
145
146       /// OUTFLAG = MTFSB0 INFLAG - This clears a bit in the FPSCR.
147       MTFSB0,
148
149       /// OUTFLAG = MTFSB1 INFLAG - This sets a bit in the FPSCR.
150       MTFSB1,
151
152       /// F8RC, OUTFLAG = FADDRTZ F8RC, F8RC, INFLAG - This is an FADD done with
153       /// rounding towards zero.  It has flags added so it won't move past the 
154       /// FPSCR-setting instructions.
155       FADDRTZ,
156
157       /// MTFSF = F8RC, INFLAG - This moves the register into the FPSCR.
158       MTFSF,
159
160       /// LARX = This corresponds to PPC l{w|d}arx instrcution: load and
161       /// reserve indexed. This is used to implement atomic operations.
162       LARX,
163
164       /// STCX = This corresponds to PPC stcx. instrcution: store conditional
165       /// indexed. This is used to implement atomic operations.
166       STCX,
167
168       /// TC_RETURN - A tail call return.
169       ///   operand #0 chain
170       ///   operand #1 callee (register or absolute)
171       ///   operand #2 stack adjustment
172       ///   operand #3 optional in flag
173       TC_RETURN
174     };
175   }
176
177   /// Define some predicates that are used for node matching.
178   namespace PPC {
179     /// isVPKUHUMShuffleMask - Return true if this is the shuffle mask for a
180     /// VPKUHUM instruction.
181     bool isVPKUHUMShuffleMask(ShuffleVectorSDNode *N, bool isUnary);
182     
183     /// isVPKUWUMShuffleMask - Return true if this is the shuffle mask for a
184     /// VPKUWUM instruction.
185     bool isVPKUWUMShuffleMask(ShuffleVectorSDNode *N, bool isUnary);
186
187     /// isVMRGLShuffleMask - Return true if this is a shuffle mask suitable for
188     /// a VRGL* instruction with the specified unit size (1,2 or 4 bytes).
189     bool isVMRGLShuffleMask(ShuffleVectorSDNode *N, unsigned UnitSize,
190                             bool isUnary);
191
192     /// isVMRGHShuffleMask - Return true if this is a shuffle mask suitable for
193     /// a VRGH* instruction with the specified unit size (1,2 or 4 bytes).
194     bool isVMRGHShuffleMask(ShuffleVectorSDNode *N, unsigned UnitSize,
195                             bool isUnary);
196     
197     /// isVSLDOIShuffleMask - If this is a vsldoi shuffle mask, return the shift
198     /// amount, otherwise return -1.
199     int isVSLDOIShuffleMask(SDNode *N, bool isUnary);
200     
201     /// isSplatShuffleMask - Return true if the specified VECTOR_SHUFFLE operand
202     /// specifies a splat of a single element that is suitable for input to
203     /// VSPLTB/VSPLTH/VSPLTW.
204     bool isSplatShuffleMask(ShuffleVectorSDNode *N, unsigned EltSize);
205     
206     /// isAllNegativeZeroVector - Returns true if all elements of build_vector
207     /// are -0.0.
208     bool isAllNegativeZeroVector(SDNode *N);
209
210     /// getVSPLTImmediate - Return the appropriate VSPLT* immediate to splat the
211     /// specified isSplatShuffleMask VECTOR_SHUFFLE mask.
212     unsigned getVSPLTImmediate(SDNode *N, unsigned EltSize);
213     
214     /// get_VSPLTI_elt - If this is a build_vector of constants which can be
215     /// formed by using a vspltis[bhw] instruction of the specified element
216     /// size, return the constant being splatted.  The ByteSize field indicates
217     /// the number of bytes of each element [124] -> [bhw].
218     SDValue get_VSPLTI_elt(SDNode *N, unsigned ByteSize, SelectionDAG &DAG);
219   }
220   
221   class PPCTargetLowering : public TargetLowering {
222     int VarArgsFrameIndex;            // FrameIndex for start of varargs area.
223     int VarArgsStackOffset;           // StackOffset for start of stack
224                                       // arguments.
225     unsigned VarArgsNumGPR;           // Index of the first unused integer
226                                       // register for parameter passing.
227     unsigned VarArgsNumFPR;           // Index of the first unused double
228                                       // register for parameter passing.
229     const PPCSubtarget &PPCSubTarget;
230   public:
231     explicit PPCTargetLowering(PPCTargetMachine &TM);
232     
233     /// getTargetNodeName() - This method returns the name of a target specific
234     /// DAG node.
235     virtual const char *getTargetNodeName(unsigned Opcode) const;
236
237     /// getSetCCResultType - Return the ISD::SETCC ValueType
238     virtual MVT::SimpleValueType getSetCCResultType(EVT VT) const;
239
240     /// getPreIndexedAddressParts - returns true by value, base pointer and
241     /// offset pointer and addressing mode by reference if the node's address
242     /// can be legally represented as pre-indexed load / store address.
243     virtual bool getPreIndexedAddressParts(SDNode *N, SDValue &Base,
244                                            SDValue &Offset,
245                                            ISD::MemIndexedMode &AM,
246                                            SelectionDAG &DAG) const;
247     
248     /// SelectAddressRegReg - Given the specified addressed, check to see if it
249     /// can be represented as an indexed [r+r] operation.  Returns false if it
250     /// can be more efficiently represented with [r+imm].
251     bool SelectAddressRegReg(SDValue N, SDValue &Base, SDValue &Index,
252                              SelectionDAG &DAG) const;
253     
254     /// SelectAddressRegImm - Returns true if the address N can be represented
255     /// by a base register plus a signed 16-bit displacement [r+imm], and if it
256     /// is not better represented as reg+reg.
257     bool SelectAddressRegImm(SDValue N, SDValue &Disp, SDValue &Base,
258                              SelectionDAG &DAG) const;
259     
260     /// SelectAddressRegRegOnly - Given the specified addressed, force it to be
261     /// represented as an indexed [r+r] operation.
262     bool SelectAddressRegRegOnly(SDValue N, SDValue &Base, SDValue &Index,
263                                  SelectionDAG &DAG) const;
264
265     /// SelectAddressRegImmShift - Returns true if the address N can be
266     /// represented by a base register plus a signed 14-bit displacement
267     /// [r+imm*4].  Suitable for use by STD and friends.
268     bool SelectAddressRegImmShift(SDValue N, SDValue &Disp, SDValue &Base,
269                                   SelectionDAG &DAG) const;
270
271     
272     /// LowerOperation - Provide custom lowering hooks for some operations.
273     ///
274     virtual SDValue LowerOperation(SDValue Op, SelectionDAG &DAG);
275
276     /// ReplaceNodeResults - Replace the results of node with an illegal result
277     /// type with new values built out of custom code.
278     ///
279     virtual void ReplaceNodeResults(SDNode *N, SmallVectorImpl<SDValue>&Results,
280                                     SelectionDAG &DAG);
281
282     virtual SDValue PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const;
283     
284     virtual void computeMaskedBitsForTargetNode(const SDValue Op,
285                                                 const APInt &Mask,
286                                                 APInt &KnownZero, 
287                                                 APInt &KnownOne,
288                                                 const SelectionDAG &DAG,
289                                                 unsigned Depth = 0) const;
290
291     virtual MachineBasicBlock *EmitInstrWithCustomInserter(MachineInstr *MI,
292                                                          MachineBasicBlock *MBB,
293                     DenseMap<MachineBasicBlock*, MachineBasicBlock*> *EM) const;
294     MachineBasicBlock *EmitAtomicBinary(MachineInstr *MI, 
295                                         MachineBasicBlock *MBB, bool is64Bit,
296                                         unsigned BinOpcode) const;
297     MachineBasicBlock *EmitPartwordAtomicBinary(MachineInstr *MI, 
298                                                 MachineBasicBlock *MBB, 
299                                             bool is8bit, unsigned Opcode) const;
300     
301     ConstraintType getConstraintType(const std::string &Constraint) const;
302     std::pair<unsigned, const TargetRegisterClass*> 
303       getRegForInlineAsmConstraint(const std::string &Constraint,
304                                    EVT VT) const;
305
306     /// getByValTypeAlignment - Return the desired alignment for ByVal aggregate
307     /// function arguments in the caller parameter area.  This is the actual
308     /// alignment, not its logarithm.
309     unsigned getByValTypeAlignment(const Type *Ty) const;
310
311     /// LowerAsmOperandForConstraint - Lower the specified operand into the Ops
312     /// vector.  If it is invalid, don't add anything to Ops. If hasMemory is
313     /// true it means one of the asm constraint of the inline asm instruction
314     /// being processed is 'm'.
315     virtual void LowerAsmOperandForConstraint(SDValue Op,
316                                               char ConstraintLetter,
317                                               bool hasMemory,
318                                               std::vector<SDValue> &Ops,
319                                               SelectionDAG &DAG) const;
320     
321     /// isLegalAddressingMode - Return true if the addressing mode represented
322     /// by AM is legal for this target, for a load/store of the specified type.
323     virtual bool isLegalAddressingMode(const AddrMode &AM, const Type *Ty)const;
324     
325     /// isLegalAddressImmediate - Return true if the integer value can be used
326     /// as the offset of the target addressing mode for load / store of the
327     /// given type.
328     virtual bool isLegalAddressImmediate(int64_t V, const Type *Ty) const;
329
330     /// isLegalAddressImmediate - Return true if the GlobalValue can be used as
331     /// the offset of the target addressing mode.
332     virtual bool isLegalAddressImmediate(GlobalValue *GV) const;
333
334     virtual bool
335     IsEligibleForTailCallOptimization(SDValue Callee,
336                                       CallingConv::ID CalleeCC,
337                                       bool isVarArg,
338                                       const SmallVectorImpl<ISD::InputArg> &Ins,
339                                       SelectionDAG& DAG) const;
340
341     virtual bool isOffsetFoldingLegal(const GlobalAddressSDNode *GA) const;
342     
343     virtual EVT getOptimalMemOpType(uint64_t Size, unsigned Align,
344                                     bool isSrcConst, bool isSrcStr,
345                                     SelectionDAG &DAG) const;
346
347     /// getFunctionAlignment - Return the Log2 alignment of this function.
348     virtual unsigned getFunctionAlignment(const Function *F) const;
349
350   private:
351     SDValue getFramePointerFrameIndex(SelectionDAG & DAG) const;
352     SDValue getReturnAddrFrameIndex(SelectionDAG & DAG) const;
353
354     SDValue EmitTailCallLoadFPAndRetAddr(SelectionDAG & DAG,
355                                          int SPDiff,
356                                          SDValue Chain,
357                                          SDValue &LROpOut,
358                                          SDValue &FPOpOut,
359                                          bool isDarwinABI,
360                                          DebugLoc dl);
361
362     SDValue LowerRETURNADDR(SDValue Op, SelectionDAG &DAG);
363     SDValue LowerFRAMEADDR(SDValue Op, SelectionDAG &DAG);
364     SDValue LowerConstantPool(SDValue Op, SelectionDAG &DAG);
365     SDValue LowerGlobalAddress(SDValue Op, SelectionDAG &DAG);
366     SDValue LowerGlobalTLSAddress(SDValue Op, SelectionDAG &DAG);
367     SDValue LowerJumpTable(SDValue Op, SelectionDAG &DAG);
368     SDValue LowerSETCC(SDValue Op, SelectionDAG &DAG);
369     SDValue LowerTRAMPOLINE(SDValue Op, SelectionDAG &DAG);
370     SDValue LowerVASTART(SDValue Op, SelectionDAG &DAG,
371                            int VarArgsFrameIndex, int VarArgsStackOffset,
372                            unsigned VarArgsNumGPR, unsigned VarArgsNumFPR,
373                            const PPCSubtarget &Subtarget);
374     SDValue LowerVAARG(SDValue Op, SelectionDAG &DAG, int VarArgsFrameIndex,
375                          int VarArgsStackOffset, unsigned VarArgsNumGPR,
376                          unsigned VarArgsNumFPR, const PPCSubtarget &Subtarget);
377     SDValue LowerSTACKRESTORE(SDValue Op, SelectionDAG &DAG,
378                                 const PPCSubtarget &Subtarget);
379     SDValue LowerDYNAMIC_STACKALLOC(SDValue Op, SelectionDAG &DAG,
380                                       const PPCSubtarget &Subtarget);
381     SDValue LowerSELECT_CC(SDValue Op, SelectionDAG &DAG);
382     SDValue LowerFP_TO_INT(SDValue Op, SelectionDAG &DAG, DebugLoc dl);
383     SDValue LowerSINT_TO_FP(SDValue Op, SelectionDAG &DAG);
384     SDValue LowerFLT_ROUNDS_(SDValue Op, SelectionDAG &DAG);
385     SDValue LowerSHL_PARTS(SDValue Op, SelectionDAG &DAG);
386     SDValue LowerSRL_PARTS(SDValue Op, SelectionDAG &DAG);
387     SDValue LowerSRA_PARTS(SDValue Op, SelectionDAG &DAG);
388     SDValue LowerBUILD_VECTOR(SDValue Op, SelectionDAG &DAG);
389     SDValue LowerVECTOR_SHUFFLE(SDValue Op, SelectionDAG &DAG);
390     SDValue LowerINTRINSIC_WO_CHAIN(SDValue Op, SelectionDAG &DAG);
391     SDValue LowerSCALAR_TO_VECTOR(SDValue Op, SelectionDAG &DAG);
392     SDValue LowerMUL(SDValue Op, SelectionDAG &DAG);
393
394     SDValue LowerCallResult(SDValue Chain, SDValue InFlag,
395                             CallingConv::ID CallConv, bool isVarArg,
396                             const SmallVectorImpl<ISD::InputArg> &Ins,
397                             DebugLoc dl, SelectionDAG &DAG,
398                             SmallVectorImpl<SDValue> &InVals);
399     SDValue FinishCall(CallingConv::ID CallConv, DebugLoc dl, bool isTailCall,
400                        bool isVarArg,
401                        SelectionDAG &DAG,
402                        SmallVector<std::pair<unsigned, SDValue>, 8>
403                          &RegsToPass,
404                        SDValue InFlag, SDValue Chain,
405                        SDValue &Callee,
406                        int SPDiff, unsigned NumBytes,
407                        const SmallVectorImpl<ISD::InputArg> &Ins,
408                        SmallVectorImpl<SDValue> &InVals);
409
410     virtual SDValue
411       LowerFormalArguments(SDValue Chain,
412                            CallingConv::ID CallConv, bool isVarArg,
413                            const SmallVectorImpl<ISD::InputArg> &Ins,
414                            DebugLoc dl, SelectionDAG &DAG,
415                            SmallVectorImpl<SDValue> &InVals);
416
417     virtual SDValue
418       LowerCall(SDValue Chain, SDValue Callee,
419                 CallingConv::ID CallConv, bool isVarArg, bool isTailCall,
420                 const SmallVectorImpl<ISD::OutputArg> &Outs,
421                 const SmallVectorImpl<ISD::InputArg> &Ins,
422                 DebugLoc dl, SelectionDAG &DAG,
423                 SmallVectorImpl<SDValue> &InVals);
424
425     virtual SDValue
426       LowerReturn(SDValue Chain,
427                   CallingConv::ID CallConv, bool isVarArg,
428                   const SmallVectorImpl<ISD::OutputArg> &Outs,
429                   DebugLoc dl, SelectionDAG &DAG);
430
431     SDValue
432       LowerFormalArguments_Darwin(SDValue Chain,
433                                   CallingConv::ID CallConv, bool isVarArg,
434                                   const SmallVectorImpl<ISD::InputArg> &Ins,
435                                   DebugLoc dl, SelectionDAG &DAG,
436                                   SmallVectorImpl<SDValue> &InVals);
437     SDValue
438       LowerFormalArguments_SVR4(SDValue Chain,
439                                 CallingConv::ID CallConv, bool isVarArg,
440                                 const SmallVectorImpl<ISD::InputArg> &Ins,
441                                 DebugLoc dl, SelectionDAG &DAG,
442                                 SmallVectorImpl<SDValue> &InVals);
443
444     SDValue
445       LowerCall_Darwin(SDValue Chain, SDValue Callee,
446                        CallingConv::ID CallConv, bool isVarArg, bool isTailCall,
447                        const SmallVectorImpl<ISD::OutputArg> &Outs,
448                        const SmallVectorImpl<ISD::InputArg> &Ins,
449                        DebugLoc dl, SelectionDAG &DAG,
450                        SmallVectorImpl<SDValue> &InVals);
451     SDValue
452       LowerCall_SVR4(SDValue Chain, SDValue Callee,
453                      CallingConv::ID CallConv, bool isVarArg, bool isTailCall,
454                      const SmallVectorImpl<ISD::OutputArg> &Outs,
455                      const SmallVectorImpl<ISD::InputArg> &Ins,
456                      DebugLoc dl, SelectionDAG &DAG,
457                      SmallVectorImpl<SDValue> &InVals);
458   };
459 }
460
461 #endif   // LLVM_TARGET_POWERPC_PPC32ISELLOWERING_H