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