Rather than having a different custom legalization
[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+PPC::INSTRUCTION_LIST_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       /// OPRC, CHAIN = DYNALLOC(CHAIN, NEGSIZE, FRAME_INDEX)
64       /// This instruction is lowered in PPCRegisterInfo::eliminateFrameIndex to
65       /// compute an allocation on the stack.
66       DYNALLOC,
67       
68       /// GlobalBaseReg - On Darwin, this node represents the result of the mflr
69       /// at function entry, used for PIC code.
70       GlobalBaseReg,
71       
72       /// These nodes represent the 32-bit PPC shifts that operate on 6-bit
73       /// shift amounts.  These nodes are generated by the multi-precision shift
74       /// code.
75       SRL, SRA, SHL,
76       
77       /// EXTSW_32 - This is the EXTSW instruction for use with "32-bit"
78       /// registers.
79       EXTSW_32,
80
81       /// STD_32 - This is the STD instruction for use with "32-bit" registers.
82       STD_32,
83       
84       /// CALL - A direct function call.
85       CALL_Macho, CALL_ELF,
86       
87       /// CHAIN,FLAG = MTCTR(VAL, CHAIN[, INFLAG]) - Directly corresponds to a
88       /// MTCTR instruction.
89       MTCTR,
90       
91       /// CHAIN,FLAG = BCTRL(CHAIN, INFLAG) - Directly corresponds to a
92       /// BCTRL instruction.
93       BCTRL_Macho, BCTRL_ELF,
94       
95       /// Return with a flag operand, matched by 'blr'
96       RET_FLAG,
97       
98       /// R32 = MFCR(CRREG, INFLAG) - Represents the MFCR/MFOCRF instructions.
99       /// This copies the bits corresponding to the specified CRREG into the
100       /// resultant GPR.  Bits corresponding to other CR regs are undefined.
101       MFCR,
102
103       /// RESVEC = VCMP(LHS, RHS, OPC) - Represents one of the altivec VCMP*
104       /// instructions.  For lack of better number, we use the opcode number
105       /// encoding for the OPC field to identify the compare.  For example, 838
106       /// is VCMPGTSH.
107       VCMP,
108       
109       /// RESVEC, OUTFLAG = VCMPo(LHS, RHS, OPC) - Represents one of the
110       /// altivec VCMP*o instructions.  For lack of better number, we use the 
111       /// opcode number encoding for the OPC field to identify the compare.  For
112       /// example, 838 is VCMPGTSH.
113       VCMPo,
114       
115       /// CHAIN = COND_BRANCH CHAIN, CRRC, OPC, DESTBB [, INFLAG] - This
116       /// corresponds to the COND_BRANCH pseudo instruction.  CRRC is the
117       /// condition register to branch on, OPC is the branch opcode to use (e.g.
118       /// PPC::BLE), DESTBB is the destination block to branch to, and INFLAG is
119       /// an optional input flag argument.
120       COND_BRANCH,
121       
122       /// CHAIN = STBRX CHAIN, GPRC, Ptr, SRCVALUE, Type - This is a 
123       /// byte-swapping store instruction.  It byte-swaps the low "Type" bits of
124       /// the GPRC input, then stores it through Ptr.  Type can be either i16 or
125       /// i32.
126       STBRX, 
127       
128       /// GPRC, CHAIN = LBRX CHAIN, Ptr, SRCVALUE, Type - This is a 
129       /// byte-swapping load instruction.  It loads "Type" bits, byte swaps it,
130       /// then puts it in the bottom bits of the GPRC.  TYPE can be either i16
131       /// or i32.
132       LBRX,
133
134       // The following 5 instructions are used only as part of the
135       // long double-to-int conversion sequence.
136
137       /// OUTFLAG = MFFS F8RC - This moves the FPSCR (not modelled) into the
138       /// register.
139       MFFS,
140
141       /// OUTFLAG = MTFSB0 INFLAG - This clears a bit in the FPSCR.
142       MTFSB0,
143
144       /// OUTFLAG = MTFSB1 INFLAG - This sets a bit in the FPSCR.
145       MTFSB1,
146
147       /// F8RC, OUTFLAG = FADDRTZ F8RC, F8RC, INFLAG - This is an FADD done with
148       /// rounding towards zero.  It has flags added so it won't move past the 
149       /// FPSCR-setting instructions.
150       FADDRTZ,
151
152       /// MTFSF = F8RC, INFLAG - This moves the register into the FPSCR.
153       MTFSF,
154
155       /// LARX = This corresponds to PPC l{w|d}arx instrcution: load and
156       /// reserve indexed. This is used to implement atomic operations.
157       LARX,
158
159       /// STCX = This corresponds to PPC stcx. instrcution: store conditional
160       /// indexed. This is used to implement atomic operations.
161       STCX,
162
163       /// CMP_UNRESERVE = Test for equality and "unreserve" if not true. This
164       /// is used to implement atomic operations.
165       CMP_UNRESERVE,
166
167       /// TAILCALL - Indicates a tail call should be taken.
168       TAILCALL,
169       /// TC_RETURN - A tail call return.
170       ///   operand #0 chain
171       ///   operand #1 callee (register or absolute)
172       ///   operand #2 stack adjustment
173       ///   operand #3 optional in flag
174       TC_RETURN
175     };
176   }
177
178   /// Define some predicates that are used for node matching.
179   namespace PPC {
180     /// isVPKUHUMShuffleMask - Return true if this is the shuffle mask for a
181     /// VPKUHUM instruction.
182     bool isVPKUHUMShuffleMask(SDNode *N, bool isUnary);
183     
184     /// isVPKUWUMShuffleMask - Return true if this is the shuffle mask for a
185     /// VPKUWUM instruction.
186     bool isVPKUWUMShuffleMask(SDNode *N, bool isUnary);
187
188     /// isVMRGLShuffleMask - Return true if this is a shuffle mask suitable for
189     /// a VRGL* instruction with the specified unit size (1,2 or 4 bytes).
190     bool isVMRGLShuffleMask(SDNode *N, unsigned UnitSize, 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(SDNode *N, unsigned UnitSize, bool isUnary);
195     
196     /// isVSLDOIShuffleMask - If this is a vsldoi shuffle mask, return the shift
197     /// amount, otherwise return -1.
198     int isVSLDOIShuffleMask(SDNode *N, bool isUnary);
199     
200     /// isSplatShuffleMask - Return true if the specified VECTOR_SHUFFLE operand
201     /// specifies a splat of a single element that is suitable for input to
202     /// VSPLTB/VSPLTH/VSPLTW.
203     bool isSplatShuffleMask(SDNode *N, unsigned EltSize);
204     
205     /// isAllNegativeZeroVector - Returns true if all elements of build_vector
206     /// are -0.0.
207     bool isAllNegativeZeroVector(SDNode *N);
208
209     /// getVSPLTImmediate - Return the appropriate VSPLT* immediate to splat the
210     /// specified isSplatShuffleMask VECTOR_SHUFFLE mask.
211     unsigned getVSPLTImmediate(SDNode *N, unsigned EltSize);
212     
213     /// get_VSPLTI_elt - If this is a build_vector of constants which can be
214     /// formed by using a vspltis[bhw] instruction of the specified element
215     /// size, return the constant being splatted.  The ByteSize field indicates
216     /// the number of bytes of each element [124] -> [bhw].
217     SDOperand get_VSPLTI_elt(SDNode *N, unsigned ByteSize, SelectionDAG &DAG);
218   }
219   
220   class PPCTargetLowering : public TargetLowering {
221     int VarArgsFrameIndex;            // FrameIndex for start of varargs area.
222     int VarArgsStackOffset;           // StackOffset for start of stack
223                                       // arguments.
224     unsigned VarArgsNumGPR;           // Index of the first unused integer
225                                       // register for parameter passing.
226     unsigned VarArgsNumFPR;           // Index of the first unused double
227                                       // register for parameter passing.
228     int ReturnAddrIndex;              // FrameIndex for return slot.
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 getSetCCResultType(const SDOperand &) 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, SDOperand &Base,
244                                            SDOperand &Offset,
245                                            ISD::MemIndexedMode &AM,
246                                            SelectionDAG &DAG);
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(SDOperand N, SDOperand &Base, SDOperand &Index,
252                              SelectionDAG &DAG);
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(SDOperand N, SDOperand &Disp, SDOperand &Base,
258                              SelectionDAG &DAG);
259     
260     /// SelectAddressRegRegOnly - Given the specified addressed, force it to be
261     /// represented as an indexed [r+r] operation.
262     bool SelectAddressRegRegOnly(SDOperand N, SDOperand &Base, SDOperand &Index,
263                                  SelectionDAG &DAG);
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(SDOperand N, SDOperand &Disp, SDOperand &Base,
269                                   SelectionDAG &DAG);
270
271     
272     /// LowerOperation - Provide custom lowering hooks for some operations.
273     ///
274     virtual SDOperand LowerOperation(SDOperand Op, SelectionDAG &DAG);
275
276     virtual SDNode *ReplaceNodeResults(SDNode *N, SelectionDAG &DAG);
277     
278     virtual SDOperand PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const;
279     
280     virtual void computeMaskedBitsForTargetNode(const SDOperand Op,
281                                                 const APInt &Mask,
282                                                 APInt &KnownZero, 
283                                                 APInt &KnownOne,
284                                                 const SelectionDAG &DAG,
285                                                 unsigned Depth = 0) const;
286
287     virtual MachineBasicBlock *EmitInstrWithCustomInserter(MachineInstr *MI,
288                                                         MachineBasicBlock *MBB);
289     
290     ConstraintType getConstraintType(const std::string &Constraint) const;
291     std::pair<unsigned, const TargetRegisterClass*> 
292       getRegForInlineAsmConstraint(const std::string &Constraint,
293                                    MVT VT) const;
294
295     /// getByValTypeAlignment - Return the desired alignment for ByVal aggregate
296     /// function arguments in the caller parameter area.  This is the actual
297     /// alignment, not its logarithm.
298     unsigned getByValTypeAlignment(const Type *Ty) const;
299
300     /// LowerAsmOperandForConstraint - Lower the specified operand into the Ops
301     /// vector.  If it is invalid, don't add anything to Ops.
302     virtual void LowerAsmOperandForConstraint(SDOperand Op,
303                                               char ConstraintLetter,
304                                               std::vector<SDOperand> &Ops,
305                                               SelectionDAG &DAG) const;
306     
307     /// isLegalAddressingMode - Return true if the addressing mode represented
308     /// by AM is legal for this target, for a load/store of the specified type.
309     virtual bool isLegalAddressingMode(const AddrMode &AM, const Type *Ty)const;
310     
311     /// isLegalAddressImmediate - Return true if the integer value can be used
312     /// as the offset of the target addressing mode for load / store of the
313     /// given type.
314     virtual bool isLegalAddressImmediate(int64_t V, const Type *Ty) const;
315
316     /// isLegalAddressImmediate - Return true if the GlobalValue can be used as
317     /// the offset of the target addressing mode.
318     virtual bool isLegalAddressImmediate(GlobalValue *GV) const;
319
320      /// IsEligibleForTailCallOptimization - Check whether the call is eligible
321     /// for tail call optimization. Target which want to do tail call
322     /// optimization should implement this function.
323     virtual bool IsEligibleForTailCallOptimization(SDOperand Call,
324                                                    SDOperand Ret,
325                                                    SelectionDAG &DAG) const;
326
327   private:
328     /// PPCAtomicLabelIndex - Keep track the number of PPC atomic labels.
329     ///
330     unsigned PPCAtomicLabelIndex;
331
332     SDOperand getFramePointerFrameIndex(SelectionDAG & DAG) const;
333     SDOperand getReturnAddrFrameIndex(SelectionDAG & DAG) const;
334
335     SDOperand EmitTailCallLoadFPAndRetAddr(SelectionDAG & DAG,
336                                            int SPDiff,
337                                            SDOperand Chain,
338                                            SDOperand &LROpOut,
339                                            SDOperand &FPOpOut);
340
341     SDOperand LowerRETURNADDR(SDOperand Op, SelectionDAG &DAG);
342     SDOperand LowerFRAMEADDR(SDOperand Op, SelectionDAG &DAG);
343     SDOperand LowerConstantPool(SDOperand Op, SelectionDAG &DAG);
344     SDOperand LowerGlobalAddress(SDOperand Op, SelectionDAG &DAG);
345     SDOperand LowerGlobalTLSAddress(SDOperand Op, SelectionDAG &DAG);
346     SDOperand LowerJumpTable(SDOperand Op, SelectionDAG &DAG);
347     SDOperand LowerSETCC(SDOperand Op, SelectionDAG &DAG);
348     SDOperand LowerVASTART(SDOperand Op, SelectionDAG &DAG,
349                            int VarArgsFrameIndex, int VarArgsStackOffset,
350                            unsigned VarArgsNumGPR, unsigned VarArgsNumFPR,
351                            const PPCSubtarget &Subtarget);
352     SDOperand LowerVAARG(SDOperand Op, SelectionDAG &DAG, int VarArgsFrameIndex,
353                          int VarArgsStackOffset, unsigned VarArgsNumGPR,
354                          unsigned VarArgsNumFPR, const PPCSubtarget &Subtarget);
355     SDOperand LowerFORMAL_ARGUMENTS(SDOperand Op, SelectionDAG &DAG,
356                                     int &VarArgsFrameIndex, 
357                                     int &VarArgsStackOffset,
358                                     unsigned &VarArgsNumGPR,
359                                     unsigned &VarArgsNumFPR,
360                                     const PPCSubtarget &Subtarget);
361     SDOperand LowerCALL(SDOperand Op, SelectionDAG &DAG,
362                         const PPCSubtarget &Subtarget, TargetMachine &TM);
363     SDOperand LowerRET(SDOperand Op, SelectionDAG &DAG, TargetMachine &TM);
364     SDOperand LowerSTACKRESTORE(SDOperand Op, SelectionDAG &DAG,
365                                 const PPCSubtarget &Subtarget);
366     SDOperand LowerDYNAMIC_STACKALLOC(SDOperand Op, SelectionDAG &DAG,
367                                       const PPCSubtarget &Subtarget);
368     SDOperand LowerSELECT_CC(SDOperand Op, SelectionDAG &DAG);
369     SDOperand LowerAtomicLOAD_ADD(SDOperand Op, SelectionDAG &DAG);
370     SDOperand LowerAtomicCMP_SWAP(SDOperand Op, SelectionDAG &DAG);
371     SDOperand LowerAtomicSWAP(SDOperand Op, SelectionDAG &DAG);
372     SDOperand LowerFP_TO_SINT(SDOperand Op, SelectionDAG &DAG);
373     SDOperand LowerSINT_TO_FP(SDOperand Op, SelectionDAG &DAG);
374     SDOperand LowerFP_ROUND_INREG(SDOperand Op, SelectionDAG &DAG);
375     SDOperand LowerFLT_ROUNDS_(SDOperand Op, SelectionDAG &DAG);
376     SDOperand LowerSHL_PARTS(SDOperand Op, SelectionDAG &DAG);
377     SDOperand LowerSRL_PARTS(SDOperand Op, SelectionDAG &DAG);
378     SDOperand LowerSRA_PARTS(SDOperand Op, SelectionDAG &DAG);
379     SDOperand LowerBUILD_VECTOR(SDOperand Op, SelectionDAG &DAG);
380     SDOperand LowerVECTOR_SHUFFLE(SDOperand Op, SelectionDAG &DAG);
381     SDOperand LowerINTRINSIC_WO_CHAIN(SDOperand Op, SelectionDAG &DAG);
382     SDOperand LowerSCALAR_TO_VECTOR(SDOperand Op, SelectionDAG &DAG);
383     SDOperand LowerMUL(SDOperand Op, SelectionDAG &DAG);
384   };
385 }
386
387 #endif   // LLVM_TARGET_POWERPC_PPC32ISELLOWERING_H