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