* Cleaned up addressing mode matching code.
[oota-llvm.git] / lib / Target / X86 / X86ISelLowering.h
1 //===-- X86ISelLowering.h - X86 DAG Lowering Interface ----------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by Chris Lattner and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines the interfaces that X86 uses to lower LLVM code into a
11 // selection DAG.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef X86ISELLOWERING_H
16 #define X86ISELLOWERING_H
17
18 #include "X86Subtarget.h"
19 #include "llvm/Target/TargetLowering.h"
20 #include "llvm/CodeGen/SelectionDAG.h"
21
22 namespace llvm {
23   namespace X86ISD {
24     // X86 Specific DAG Nodes
25     enum NodeType {
26       // Start the numbering where the builtin ops leave off.
27       FIRST_NUMBER = ISD::BUILTIN_OP_END+X86::INSTRUCTION_LIST_END,
28
29       /// SHLD, SHRD - Double shift instructions. These correspond to
30       /// X86::SHLDxx and X86::SHRDxx instructions.
31       SHLD,
32       SHRD,
33
34       /// FAND - Bitwise logical AND of floating point values. This corresponds
35       /// to X86::ANDPS or X86::ANDPD.
36       FAND,
37
38       /// FXOR - Bitwise logical XOR of floating point values. This corresponds
39       /// to X86::XORPS or X86::XORPD.
40       FXOR,
41
42       /// FILD, FILD_FLAG - This instruction implements SINT_TO_FP with the
43       /// integer source in memory and FP reg result.  This corresponds to the
44       /// X86::FILD*m instructions. It has three inputs (token chain, address,
45       /// and source type) and two outputs (FP value and token chain). FILD_FLAG
46       /// also produces a flag).
47       FILD,
48       FILD_FLAG,
49
50       /// FP_TO_INT*_IN_MEM - This instruction implements FP_TO_SINT with the
51       /// integer destination in memory and a FP reg source.  This corresponds
52       /// to the X86::FIST*m instructions and the rounding mode change stuff. It
53       /// has two inputs (token chain and address) and two outputs (int value and
54       /// token chain).
55       FP_TO_INT16_IN_MEM,
56       FP_TO_INT32_IN_MEM,
57       FP_TO_INT64_IN_MEM,
58
59       /// FLD - This instruction implements an extending load to FP stack slots.
60       /// This corresponds to the X86::FLD32m / X86::FLD64m. It takes a chain
61       /// operand, ptr to load from, and a ValueType node indicating the type
62       /// to load to.
63       FLD,
64
65       /// FST - This instruction implements a truncating store to FP stack
66       /// slots. This corresponds to the X86::FST32m / X86::FST64m. It takes a
67       /// chain operand, value to store, address, and a ValueType to store it
68       /// as.
69       FST,
70
71       /// FP_SET_RESULT - This corresponds to FpGETRESULT pseudo instrcuction
72       /// which copies from ST(0) to the destination. It takes a chain and writes
73       /// a RFP result and a chain.
74       FP_GET_RESULT,
75
76       /// FP_SET_RESULT - This corresponds to FpSETRESULT pseudo instrcuction
77       /// which copies the source operand to ST(0). It takes a chain and writes
78       /// a chain and a flag.
79       FP_SET_RESULT,
80
81       /// CALL/TAILCALL - These operations represent an abstract X86 call
82       /// instruction, which includes a bunch of information.  In particular the
83       /// operands of these node are:
84       ///
85       ///     #0 - The incoming token chain
86       ///     #1 - The callee
87       ///     #2 - The number of arg bytes the caller pushes on the stack.
88       ///     #3 - The number of arg bytes the callee pops off the stack.
89       ///     #4 - The value to pass in AL/AX/EAX (optional)
90       ///     #5 - The value to pass in DL/DX/EDX (optional)
91       ///
92       /// The result values of these nodes are:
93       ///
94       ///     #0 - The outgoing token chain
95       ///     #1 - The first register result value (optional)
96       ///     #2 - The second register result value (optional)
97       ///
98       /// The CALL vs TAILCALL distinction boils down to whether the callee is
99       /// known not to modify the caller's stack frame, as is standard with
100       /// LLVM.
101       CALL,
102       TAILCALL,
103       
104       /// RDTSC_DAG - This operation implements the lowering for 
105       /// readcyclecounter
106       RDTSC_DAG,
107
108       /// X86 compare and logical compare instructions.
109       CMP, TEST,
110
111       /// X86 SetCC. Operand 1 is condition code, and operand 2 is the flag
112       /// operand produced by a CMP instruction.
113       SETCC,
114
115       /// X86 conditional moves. Operand 1 and operand 2 are the two values
116       /// to select from (operand 1 is a R/W operand). Operand 3 is the condition
117       /// code, and operand 4 is the flag operand produced by a CMP or TEST
118       /// instruction. It also writes a flag result.
119       CMOV,
120
121       /// X86 conditional branches. Operand 1 is the chain operand, operand 2
122       /// is the block to branch if condition is true, operand 3 is the
123       /// condition code, and operand 4 is the flag operand produced by a CMP
124       /// or TEST instruction.
125       BRCOND,
126
127       /// Return with a flag operand. Operand 1 is the chain operand, operand
128       /// 2 is the number of bytes of stack to pop.
129       RET_FLAG,
130
131       /// REP_STOS - Repeat fill, corresponds to X86::REP_STOSx.
132       REP_STOS,
133
134       /// REP_MOVS - Repeat move, corresponds to X86::REP_MOVSx.
135       REP_MOVS,
136
137       /// LOAD_PACK Load a 128-bit packed float / double value. It has the same
138       /// operands as a normal load.
139       LOAD_PACK,
140
141       /// GlobalBaseReg - On Darwin, this node represents the result of the popl
142       /// at function entry, used for PIC code.
143       GlobalBaseReg,
144
145       /// TCPWrapper - A wrapper node for TargetConstantPool,
146       /// TargetExternalSymbol, and TargetGlobalAddress.
147       Wrapper,
148     };
149
150     // X86 specific condition code. These correspond to X86_*_COND in
151     // X86InstrInfo.td. They must be kept in synch.
152     enum CondCode {
153       COND_A  = 0,
154       COND_AE = 1,
155       COND_B  = 2,
156       COND_BE = 3,
157       COND_E  = 4,
158       COND_G  = 5,
159       COND_GE = 6,
160       COND_L  = 7,
161       COND_LE = 8,
162       COND_NE = 9,
163       COND_NO = 10,
164       COND_NP = 11,
165       COND_NS = 12,
166       COND_O  = 13,
167       COND_P  = 14,
168       COND_S  = 15,
169       COND_INVALID
170     };
171   }
172
173   //===----------------------------------------------------------------------===//
174   //  X86TargetLowering - X86 Implementation of the TargetLowering interface
175   class X86TargetLowering : public TargetLowering {
176     int VarArgsFrameIndex;            // FrameIndex for start of varargs area.
177     int ReturnAddrIndex;              // FrameIndex for return slot.
178     int BytesToPopOnReturn;           // Number of arg bytes ret should pop.
179     int BytesCallerReserves;          // Number of arg bytes caller makes.
180   public:
181     X86TargetLowering(TargetMachine &TM);
182
183     // Return the number of bytes that a function should pop when it returns (in
184     // addition to the space used by the return address).
185     //
186     unsigned getBytesToPopOnReturn() const { return BytesToPopOnReturn; }
187
188     // Return the number of bytes that the caller reserves for arguments passed
189     // to this function.
190     unsigned getBytesCallerReserves() const { return BytesCallerReserves; }
191  
192     /// LowerOperation - Provide custom lowering hooks for some operations.
193     ///
194     virtual SDOperand LowerOperation(SDOperand Op, SelectionDAG &DAG);
195
196     /// LowerArguments - This hook must be implemented to indicate how we should
197     /// lower the arguments for the specified function, into the specified DAG.
198     virtual std::vector<SDOperand>
199     LowerArguments(Function &F, SelectionDAG &DAG);
200
201     /// LowerCallTo - This hook lowers an abstract call to a function into an
202     /// actual call.
203     virtual std::pair<SDOperand, SDOperand>
204     LowerCallTo(SDOperand Chain, const Type *RetTy, bool isVarArg, unsigned CC,
205                 bool isTailCall, SDOperand Callee, ArgListTy &Args,
206                 SelectionDAG &DAG);
207
208     virtual std::pair<SDOperand, SDOperand>
209     LowerFrameReturnAddress(bool isFrameAddr, SDOperand Chain, unsigned Depth,
210                             SelectionDAG &DAG);
211
212     virtual MachineBasicBlock *InsertAtEndOfBasicBlock(MachineInstr *MI,
213                                                        MachineBasicBlock *MBB);
214
215     /// getTargetNodeName - This method returns the name of a target specific
216     /// DAG node.
217     virtual const char *getTargetNodeName(unsigned Opcode) const;
218
219     /// computeMaskedBitsForTargetNode - Determine which of the bits specified 
220     /// in Mask are known to be either zero or one and return them in the 
221     /// KnownZero/KnownOne bitsets.
222     virtual void computeMaskedBitsForTargetNode(const SDOperand Op,
223                                                 uint64_t Mask,
224                                                 uint64_t &KnownZero, 
225                                                 uint64_t &KnownOne,
226                                                 unsigned Depth = 0) const;
227     
228     SDOperand getReturnAddressFrameIndex(SelectionDAG &DAG);
229
230     std::vector<unsigned> 
231       getRegClassForInlineAsmConstraint(const std::string &Constraint,
232                                         MVT::ValueType VT) const;
233   private:
234     // C Calling Convention implementation.
235     std::vector<SDOperand> LowerCCCArguments(Function &F, SelectionDAG &DAG);
236     std::pair<SDOperand, SDOperand>
237     LowerCCCCallTo(SDOperand Chain, const Type *RetTy, bool isVarArg,
238                    bool isTailCall,
239                    SDOperand Callee, ArgListTy &Args, SelectionDAG &DAG);
240
241     // Fast Calling Convention implementation.
242     std::vector<SDOperand> LowerFastCCArguments(Function &F, SelectionDAG &DAG);
243     std::pair<SDOperand, SDOperand>
244     LowerFastCCCallTo(SDOperand Chain, const Type *RetTy, bool isTailCall,
245                       SDOperand Callee, ArgListTy &Args, SelectionDAG &DAG);
246
247     /// Subtarget - Keep a pointer to the X86Subtarget around so that we can
248     /// make the right decision when generating code for different targets.
249     const X86Subtarget *Subtarget;
250
251     /// X86ScalarSSE - Select between SSE2 or x87 floating point ops.
252     bool X86ScalarSSE;
253   };
254 }
255
256 #endif    // X86ISELLOWERING_H