For PR1839: add initial support for __builtin_trap. llvm-gcc part is missed
[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 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 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 "X86RegisterInfo.h"
20 #include "X86MachineFunctionInfo.h"
21 #include "llvm/Target/TargetLowering.h"
22 #include "llvm/CodeGen/SelectionDAG.h"
23 #include "llvm/CodeGen/CallingConvLower.h"
24
25 namespace llvm {
26   namespace X86ISD {
27     // X86 Specific DAG Nodes
28     enum NodeType {
29       // Start the numbering where the builtin ops leave off.
30       FIRST_NUMBER = ISD::BUILTIN_OP_END+X86::INSTRUCTION_LIST_END,
31
32       /// BSF - Bit scan forward.
33       /// BSR - Bit scan reverse.
34       BSF,
35       BSR,
36
37       /// SHLD, SHRD - Double shift instructions. These correspond to
38       /// X86::SHLDxx and X86::SHRDxx instructions.
39       SHLD,
40       SHRD,
41
42       /// FAND - Bitwise logical AND of floating point values. This corresponds
43       /// to X86::ANDPS or X86::ANDPD.
44       FAND,
45
46       /// FOR - Bitwise logical OR of floating point values. This corresponds
47       /// to X86::ORPS or X86::ORPD.
48       FOR,
49
50       /// FXOR - Bitwise logical XOR of floating point values. This corresponds
51       /// to X86::XORPS or X86::XORPD.
52       FXOR,
53
54       /// FSRL - Bitwise logical right shift of floating point values. These
55       /// corresponds to X86::PSRLDQ.
56       FSRL,
57
58       /// FILD, FILD_FLAG - This instruction implements SINT_TO_FP with the
59       /// integer source in memory and FP reg result.  This corresponds to the
60       /// X86::FILD*m instructions. It has three inputs (token chain, address,
61       /// and source type) and two outputs (FP value and token chain). FILD_FLAG
62       /// also produces a flag).
63       FILD,
64       FILD_FLAG,
65
66       /// FP_TO_INT*_IN_MEM - This instruction implements FP_TO_SINT with the
67       /// integer destination in memory and a FP reg source.  This corresponds
68       /// to the X86::FIST*m instructions and the rounding mode change stuff. It
69       /// has two inputs (token chain and address) and two outputs (int value
70       /// and token chain).
71       FP_TO_INT16_IN_MEM,
72       FP_TO_INT32_IN_MEM,
73       FP_TO_INT64_IN_MEM,
74
75       /// FLD - This instruction implements an extending load to FP stack slots.
76       /// This corresponds to the X86::FLD32m / X86::FLD64m. It takes a chain
77       /// operand, ptr to load from, and a ValueType node indicating the type
78       /// to load to.
79       FLD,
80
81       /// FST - This instruction implements a truncating store to FP stack
82       /// slots. This corresponds to the X86::FST32m / X86::FST64m. It takes a
83       /// chain operand, value to store, address, and a ValueType to store it
84       /// as.
85       FST,
86
87       /// FP_GET_RESULT - This corresponds to FpGETRESULT pseudo instruction
88       /// which copies from ST(0) to the destination. It takes a chain and
89       /// writes a RFP result and a chain.
90       FP_GET_RESULT,
91
92       /// FP_SET_RESULT - This corresponds to FpSETRESULT pseudo instruction
93       /// which copies the source operand to ST(0). It takes a chain+value and
94       /// returns a chain and a flag.
95       FP_SET_RESULT,
96
97       /// CALL/TAILCALL - These operations represent an abstract X86 call
98       /// instruction, which includes a bunch of information.  In particular the
99       /// operands of these node are:
100       ///
101       ///     #0 - The incoming token chain
102       ///     #1 - The callee
103       ///     #2 - The number of arg bytes the caller pushes on the stack.
104       ///     #3 - The number of arg bytes the callee pops off the stack.
105       ///     #4 - The value to pass in AL/AX/EAX (optional)
106       ///     #5 - The value to pass in DL/DX/EDX (optional)
107       ///
108       /// The result values of these nodes are:
109       ///
110       ///     #0 - The outgoing token chain
111       ///     #1 - The first register result value (optional)
112       ///     #2 - The second register result value (optional)
113       ///
114       /// The CALL vs TAILCALL distinction boils down to whether the callee is
115       /// known not to modify the caller's stack frame, as is standard with
116       /// LLVM.
117       CALL,
118       TAILCALL,
119       
120       /// RDTSC_DAG - This operation implements the lowering for 
121       /// readcyclecounter
122       RDTSC_DAG,
123
124       /// X86 compare and logical compare instructions.
125       CMP, COMI, UCOMI,
126
127       /// X86 SetCC. Operand 1 is condition code, and operand 2 is the flag
128       /// operand produced by a CMP instruction.
129       SETCC,
130
131       /// X86 conditional moves. Operand 1 and operand 2 are the two values
132       /// to select from (operand 1 is a R/W operand). Operand 3 is the
133       /// condition code, and operand 4 is the flag operand produced by a CMP
134       /// or TEST instruction. It also writes a flag result.
135       CMOV,
136
137       /// X86 conditional branches. Operand 1 is the chain operand, operand 2
138       /// is the block to branch if condition is true, operand 3 is the
139       /// condition code, and operand 4 is the flag operand produced by a CMP
140       /// or TEST instruction.
141       BRCOND,
142
143       /// Return with a flag operand. Operand 1 is the chain operand, operand
144       /// 2 is the number of bytes of stack to pop.
145       RET_FLAG,
146
147       /// REP_STOS - Repeat fill, corresponds to X86::REP_STOSx.
148       REP_STOS,
149
150       /// REP_MOVS - Repeat move, corresponds to X86::REP_MOVSx.
151       REP_MOVS,
152
153       /// GlobalBaseReg - On Darwin, this node represents the result of the popl
154       /// at function entry, used for PIC code.
155       GlobalBaseReg,
156
157       /// Wrapper - A wrapper node for TargetConstantPool,
158       /// TargetExternalSymbol, and TargetGlobalAddress.
159       Wrapper,
160
161       /// WrapperRIP - Special wrapper used under X86-64 PIC mode for RIP
162       /// relative displacements.
163       WrapperRIP,
164
165       /// S2VEC - X86 version of SCALAR_TO_VECTOR. The destination base does not
166       /// have to match the operand type.
167       S2VEC,
168
169       /// PEXTRW - Extract a 16-bit value from a vector and zero extend it to
170       /// i32, corresponds to X86::PEXTRW.
171       PEXTRW,
172
173       /// PINSRW - Insert the lower 16-bits of a 32-bit value to a vector,
174       /// corresponds to X86::PINSRW.
175       PINSRW,
176
177       /// FMAX, FMIN - Floating point max and min.
178       ///
179       FMAX, FMIN,
180
181       /// FRSQRT, FRCP - Floating point reciprocal-sqrt and reciprocal
182       /// approximation.  Note that these typically require refinement
183       /// in order to obtain suitable precision.
184       FRSQRT, FRCP,
185
186       // Thread Local Storage
187       TLSADDR, THREAD_POINTER,
188
189       // Exception Handling helpers
190       EH_RETURN,
191       
192       // tail call return 
193       //   oeprand #0 chain
194       //   operand #1 callee (register or absolute)
195       //   operand #2 stack adjustment
196       //   operand #3 optional in flag
197       TC_RETURN,
198
199       // Store FP control world into i16 memory
200       FNSTCW16m,
201
202       // Trapping instruction
203       TRAP
204     };
205   }
206
207  /// Define some predicates that are used for node matching.
208  namespace X86 {
209    /// isPSHUFDMask - Return true if the specified VECTOR_SHUFFLE operand
210    /// specifies a shuffle of elements that is suitable for input to PSHUFD.
211    bool isPSHUFDMask(SDNode *N);
212
213    /// isPSHUFHWMask - Return true if the specified VECTOR_SHUFFLE operand
214    /// specifies a shuffle of elements that is suitable for input to PSHUFD.
215    bool isPSHUFHWMask(SDNode *N);
216
217    /// isPSHUFLWMask - Return true if the specified VECTOR_SHUFFLE operand
218    /// specifies a shuffle of elements that is suitable for input to PSHUFD.
219    bool isPSHUFLWMask(SDNode *N);
220
221    /// isSHUFPMask - Return true if the specified VECTOR_SHUFFLE operand
222    /// specifies a shuffle of elements that is suitable for input to SHUFP*.
223    bool isSHUFPMask(SDNode *N);
224
225    /// isMOVHLPSMask - Return true if the specified VECTOR_SHUFFLE operand
226    /// specifies a shuffle of elements that is suitable for input to MOVHLPS.
227    bool isMOVHLPSMask(SDNode *N);
228
229    /// isMOVHLPS_v_undef_Mask - Special case of isMOVHLPSMask for canonical form
230    /// of vector_shuffle v, v, <2, 3, 2, 3>, i.e. vector_shuffle v, undef,
231    /// <2, 3, 2, 3>
232    bool isMOVHLPS_v_undef_Mask(SDNode *N);
233
234    /// isMOVLPMask - Return true if the specified VECTOR_SHUFFLE operand
235    /// specifies a shuffle of elements that is suitable for input to MOVLP{S|D}.
236    bool isMOVLPMask(SDNode *N);
237
238    /// isMOVHPMask - Return true if the specified VECTOR_SHUFFLE operand
239    /// specifies a shuffle of elements that is suitable for input to MOVHP{S|D}
240    /// as well as MOVLHPS.
241    bool isMOVHPMask(SDNode *N);
242
243    /// isUNPCKLMask - Return true if the specified VECTOR_SHUFFLE operand
244    /// specifies a shuffle of elements that is suitable for input to UNPCKL.
245    bool isUNPCKLMask(SDNode *N, bool V2IsSplat = false);
246
247    /// isUNPCKHMask - Return true if the specified VECTOR_SHUFFLE operand
248    /// specifies a shuffle of elements that is suitable for input to UNPCKH.
249    bool isUNPCKHMask(SDNode *N, bool V2IsSplat = false);
250
251    /// isUNPCKL_v_undef_Mask - Special case of isUNPCKLMask for canonical form
252    /// of vector_shuffle v, v, <0, 4, 1, 5>, i.e. vector_shuffle v, undef,
253    /// <0, 0, 1, 1>
254    bool isUNPCKL_v_undef_Mask(SDNode *N);
255
256    /// isUNPCKH_v_undef_Mask - Special case of isUNPCKHMask for canonical form
257    /// of vector_shuffle v, v, <2, 6, 3, 7>, i.e. vector_shuffle v, undef,
258    /// <2, 2, 3, 3>
259    bool isUNPCKH_v_undef_Mask(SDNode *N);
260
261    /// isMOVLMask - Return true if the specified VECTOR_SHUFFLE operand
262    /// specifies a shuffle of elements that is suitable for input to MOVSS,
263    /// MOVSD, and MOVD, i.e. setting the lowest element.
264    bool isMOVLMask(SDNode *N);
265
266    /// isMOVSHDUPMask - Return true if the specified VECTOR_SHUFFLE operand
267    /// specifies a shuffle of elements that is suitable for input to MOVSHDUP.
268    bool isMOVSHDUPMask(SDNode *N);
269
270    /// isMOVSLDUPMask - Return true if the specified VECTOR_SHUFFLE operand
271    /// specifies a shuffle of elements that is suitable for input to MOVSLDUP.
272    bool isMOVSLDUPMask(SDNode *N);
273
274    /// isSplatMask - Return true if the specified VECTOR_SHUFFLE operand
275    /// specifies a splat of a single element.
276    bool isSplatMask(SDNode *N);
277
278    /// isSplatLoMask - Return true if the specified VECTOR_SHUFFLE operand
279    /// specifies a splat of zero element.
280    bool isSplatLoMask(SDNode *N);
281
282    /// getShuffleSHUFImmediate - Return the appropriate immediate to shuffle
283    /// the specified isShuffleMask VECTOR_SHUFFLE mask with PSHUF* and SHUFP*
284    /// instructions.
285    unsigned getShuffleSHUFImmediate(SDNode *N);
286
287    /// getShufflePSHUFHWImmediate - Return the appropriate immediate to shuffle
288    /// the specified isShuffleMask VECTOR_SHUFFLE mask with PSHUFHW
289    /// instructions.
290    unsigned getShufflePSHUFHWImmediate(SDNode *N);
291
292    /// getShufflePSHUFKWImmediate - Return the appropriate immediate to shuffle
293    /// the specified isShuffleMask VECTOR_SHUFFLE mask with PSHUFLW
294    /// instructions.
295    unsigned getShufflePSHUFLWImmediate(SDNode *N);
296  }
297
298   //===--------------------------------------------------------------------===//
299   //  X86TargetLowering - X86 Implementation of the TargetLowering interface
300   class X86TargetLowering : public TargetLowering {
301     int VarArgsFrameIndex;            // FrameIndex for start of varargs area.
302     int RegSaveFrameIndex;            // X86-64 vararg func register save area.
303     unsigned VarArgsGPOffset;         // X86-64 vararg func int reg offset.
304     unsigned VarArgsFPOffset;         // X86-64 vararg func fp reg offset.
305     int BytesToPopOnReturn;           // Number of arg bytes ret should pop.
306     int BytesCallerReserves;          // Number of arg bytes caller makes.
307
308   public:
309     explicit X86TargetLowering(TargetMachine &TM);
310
311     /// getPICJumpTableRelocaBase - Returns relocation base for the given PIC
312     /// jumptable.
313     SDOperand getPICJumpTableRelocBase(SDOperand Table,
314                                        SelectionDAG &DAG) const;
315
316     // Return the number of bytes that a function should pop when it returns (in
317     // addition to the space used by the return address).
318     //
319     unsigned getBytesToPopOnReturn() const { return BytesToPopOnReturn; }
320
321     // Return the number of bytes that the caller reserves for arguments passed
322     // to this function.
323     unsigned getBytesCallerReserves() const { return BytesCallerReserves; }
324  
325     /// getStackPtrReg - Return the stack pointer register we are using: either
326     /// ESP or RSP.
327     unsigned getStackPtrReg() const { return X86StackPtr; }
328     
329     /// LowerOperation - Provide custom lowering hooks for some operations.
330     ///
331     virtual SDOperand LowerOperation(SDOperand Op, SelectionDAG &DAG);
332
333     /// ExpandOperation - Custom lower the specified operation, splitting the
334     /// value into two pieces.
335     ///
336     virtual SDNode *ExpandOperationResult(SDNode *N, SelectionDAG &DAG);
337
338     
339     virtual SDOperand PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const;
340
341     virtual MachineBasicBlock *InsertAtEndOfBasicBlock(MachineInstr *MI,
342                                                        MachineBasicBlock *MBB);
343
344     /// getTargetNodeName - This method returns the name of a target specific
345     /// DAG node.
346     virtual const char *getTargetNodeName(unsigned Opcode) const;
347
348     /// computeMaskedBitsForTargetNode - Determine which of the bits specified 
349     /// in Mask are known to be either zero or one and return them in the 
350     /// KnownZero/KnownOne bitsets.
351     virtual void computeMaskedBitsForTargetNode(const SDOperand Op,
352                                                 uint64_t Mask,
353                                                 uint64_t &KnownZero, 
354                                                 uint64_t &KnownOne,
355                                                 const SelectionDAG &DAG,
356                                                 unsigned Depth = 0) const;
357     
358     SDOperand getReturnAddressFrameIndex(SelectionDAG &DAG);
359
360     ConstraintType getConstraintType(const std::string &Constraint) const;
361      
362     std::vector<unsigned> 
363       getRegClassForInlineAsmConstraint(const std::string &Constraint,
364                                         MVT::ValueType VT) const;
365
366     /// LowerAsmOperandForConstraint - Lower the specified operand into the Ops
367     /// vector.  If it is invalid, don't add anything to Ops.
368     virtual void LowerAsmOperandForConstraint(SDOperand Op,
369                                               char ConstraintLetter,
370                                               std::vector<SDOperand> &Ops,
371                                               SelectionDAG &DAG);
372     
373     /// getRegForInlineAsmConstraint - Given a physical register constraint
374     /// (e.g. {edx}), return the register number and the register class for the
375     /// register.  This should only be used for C_Register constraints.  On
376     /// error, this returns a register number of 0.
377     std::pair<unsigned, const TargetRegisterClass*> 
378       getRegForInlineAsmConstraint(const std::string &Constraint,
379                                    MVT::ValueType VT) const;
380     
381     /// isLegalAddressingMode - Return true if the addressing mode represented
382     /// by AM is legal for this target, for a load/store of the specified type.
383     virtual bool isLegalAddressingMode(const AddrMode &AM, const Type *Ty)const;
384
385     /// isTruncateFree - Return true if it's free to truncate a value of
386     /// type Ty1 to type Ty2. e.g. On x86 it's free to truncate a i32 value in
387     /// register EAX to i16 by referencing its sub-register AX.
388     virtual bool isTruncateFree(const Type *Ty1, const Type *Ty2) const;
389     virtual bool isTruncateFree(MVT::ValueType VT1, MVT::ValueType VT2) const;
390   
391     /// isShuffleMaskLegal - Targets can use this to indicate that they only
392     /// support *some* VECTOR_SHUFFLE operations, those with specific masks.
393     /// By default, if a target supports the VECTOR_SHUFFLE node, all mask
394     /// values are assumed to be legal.
395     virtual bool isShuffleMaskLegal(SDOperand Mask, MVT::ValueType VT) const;
396
397     /// isVectorClearMaskLegal - Similar to isShuffleMaskLegal. This is
398     /// used by Targets can use this to indicate if there is a suitable
399     /// VECTOR_SHUFFLE that can be used to replace a VAND with a constant
400     /// pool entry.
401     virtual bool isVectorClearMaskLegal(std::vector<SDOperand> &BVOps,
402                                         MVT::ValueType EVT,
403                                         SelectionDAG &DAG) const;
404     
405     /// IsEligibleForTailCallOptimization - Check whether the call is eligible
406     /// for tail call optimization. Target which want to do tail call
407     /// optimization should implement this function.
408     virtual bool IsEligibleForTailCallOptimization(SDOperand Call, 
409                                                    SDOperand Ret, 
410                                                    SelectionDAG &DAG) const;
411
412     virtual const TargetSubtarget* getSubtarget() {
413       return static_cast<const TargetSubtarget*>(Subtarget);
414     }
415
416   private:
417     /// Subtarget - Keep a pointer to the X86Subtarget around so that we can
418     /// make the right decision when generating code for different targets.
419     const X86Subtarget *Subtarget;
420     const MRegisterInfo *RegInfo;
421
422     /// X86StackPtr - X86 physical register used as stack ptr.
423     unsigned X86StackPtr;
424    
425     /// X86ScalarSSEf32, X86ScalarSSEf64 - Select between SSE or x87 
426     /// floating point ops.
427     /// When SSE is available, use it for f32 operations.
428     /// When SSE2 is available, use it for f64 operations.
429     bool X86ScalarSSEf32;
430     bool X86ScalarSSEf64;
431
432     SDNode *LowerCallResult(SDOperand Chain, SDOperand InFlag, SDNode*TheCall,
433                             unsigned CallingConv, SelectionDAG &DAG);
434         
435
436     SDOperand LowerMemArgument(SDOperand Op, SelectionDAG &DAG,
437                                const CCValAssign &VA,  MachineFrameInfo *MFI,
438                                SDOperand Root, unsigned i);
439
440     SDOperand LowerMemOpCallTo(SDOperand Op, SelectionDAG &DAG,
441                                const SDOperand &StackPtr,
442                                const CCValAssign &VA, SDOperand Chain,
443                                SDOperand Arg);
444
445     // Call lowering helpers.
446     bool IsCalleePop(SDOperand Op);
447     CCAssignFn *CCAssignFnForNode(SDOperand Op) const;
448     NameDecorationStyle NameDecorationForFORMAL_ARGUMENTS(SDOperand Op);
449     unsigned GetAlignedArgumentStackSize(unsigned StackSize, SelectionDAG &DAG);
450
451     std::pair<SDOperand,SDOperand> FP_TO_SINTHelper(SDOperand Op, 
452                                                     SelectionDAG &DAG);
453     
454     SDOperand LowerBUILD_VECTOR(SDOperand Op, SelectionDAG &DAG);
455     SDOperand LowerVECTOR_SHUFFLE(SDOperand Op, SelectionDAG &DAG);
456     SDOperand LowerEXTRACT_VECTOR_ELT(SDOperand Op, SelectionDAG &DAG);
457     SDOperand LowerINSERT_VECTOR_ELT(SDOperand Op, SelectionDAG &DAG);
458     SDOperand LowerSCALAR_TO_VECTOR(SDOperand Op, SelectionDAG &DAG);
459     SDOperand LowerConstantPool(SDOperand Op, SelectionDAG &DAG);
460     SDOperand LowerGlobalAddress(SDOperand Op, SelectionDAG &DAG);
461     SDOperand LowerGlobalTLSAddress(SDOperand Op, SelectionDAG &DAG);
462     SDOperand LowerExternalSymbol(SDOperand Op, SelectionDAG &DAG);
463     SDOperand LowerShift(SDOperand Op, SelectionDAG &DAG);
464     SDOperand LowerSINT_TO_FP(SDOperand Op, SelectionDAG &DAG);
465     SDOperand LowerFP_TO_SINT(SDOperand Op, SelectionDAG &DAG);
466     SDOperand LowerFABS(SDOperand Op, SelectionDAG &DAG);
467     SDOperand LowerFNEG(SDOperand Op, SelectionDAG &DAG);
468     SDOperand LowerFCOPYSIGN(SDOperand Op, SelectionDAG &DAG);
469     SDOperand LowerSETCC(SDOperand Op, SelectionDAG &DAG);
470     SDOperand LowerSELECT(SDOperand Op, SelectionDAG &DAG);
471     SDOperand LowerBRCOND(SDOperand Op, SelectionDAG &DAG);
472     SDOperand LowerMEMSET(SDOperand Op, SelectionDAG &DAG);
473     SDOperand LowerMEMCPYInline(SDOperand Dest, SDOperand Source,
474                                 SDOperand Chain, unsigned Size, unsigned Align,
475                                 SelectionDAG &DAG);
476     SDOperand LowerJumpTable(SDOperand Op, SelectionDAG &DAG);
477     SDOperand LowerCALL(SDOperand Op, SelectionDAG &DAG);
478     SDOperand LowerRET(SDOperand Op, SelectionDAG &DAG);
479     SDOperand LowerDYNAMIC_STACKALLOC(SDOperand Op, SelectionDAG &DAG);
480     SDOperand LowerFORMAL_ARGUMENTS(SDOperand Op, SelectionDAG &DAG);
481     SDOperand LowerVASTART(SDOperand Op, SelectionDAG &DAG);
482     SDOperand LowerVACOPY(SDOperand Op, SelectionDAG &DAG);
483     SDOperand LowerINTRINSIC_WO_CHAIN(SDOperand Op, SelectionDAG &DAG);
484     SDOperand LowerRETURNADDR(SDOperand Op, SelectionDAG &DAG);
485     SDOperand LowerFRAMEADDR(SDOperand Op, SelectionDAG &DAG);
486     SDOperand LowerFRAME_TO_ARGS_OFFSET(SDOperand Op, SelectionDAG &DAG);
487     SDOperand LowerEH_RETURN(SDOperand Op, SelectionDAG &DAG);
488     SDOperand LowerTRAMPOLINE(SDOperand Op, SelectionDAG &DAG);
489     SDOperand LowerFLT_ROUNDS(SDOperand Op, SelectionDAG &DAG);
490     SDOperand LowerTRAP(SDOperand Op, SelectionDAG &DAG);
491     SDOperand LowerCTLZ(SDOperand Op, SelectionDAG &DAG);
492     SDOperand LowerCTTZ(SDOperand Op, SelectionDAG &DAG);
493     SDNode *ExpandFP_TO_SINT(SDNode *N, SelectionDAG &DAG);
494     SDNode *ExpandREADCYCLECOUNTER(SDNode *N, SelectionDAG &DAG);
495   };
496 }
497
498 #endif    // X86ISELLOWERING_H