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, COMI, UCOMI,
 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       /// S2VEC - X86 version of SCALAR_TO_VECTOR. The destination base does not
 150       /// have to match the operand type.
 151       S2VEC,
 152
 153       /// PEXTRW - Extract a 16-bit value from a vector and zero extend it to
 154       /// i32, corresponds to X86::PEXTRW.
 155       PEXTRW,
 156
 157       /// PINSRW - Insert the lower 16-bits of a 32-bit value to a vector,
 158       /// corresponds to X86::PINSRW.
 159       PINSRW,
 160     };
 161
 162     // X86 specific condition code. These correspond to X86_*_COND in
 163     // X86InstrInfo.td. They must be kept in synch.
 164     enum CondCode {
 165       COND_A  = 0,
 166       COND_AE = 1,
 167       COND_B  = 2,
 168       COND_BE = 3,
 169       COND_E  = 4,
 170       COND_G  = 5,
 171       COND_GE = 6,
 172       COND_L  = 7,
 173       COND_LE = 8,
 174       COND_NE = 9,
 175       COND_NO = 10,
 176       COND_NP = 11,
 177       COND_NS = 12,
 178       COND_O  = 13,
 179       COND_P  = 14,
 180       COND_S  = 15,
 181       COND_INVALID
 182     };
 183   }
 184
 185  /// Define some predicates that are used for node matching.
 186  namespace X86 {
 187    /// isPSHUFDMask - Return true if the specified VECTOR_SHUFFLE operand
 188    /// specifies a shuffle of elements that is suitable for input to PSHUFD.
 189    bool isPSHUFDMask(SDNode *N);
 190
 191    /// isPSHUFHWMask - Return true if the specified VECTOR_SHUFFLE operand
 192    /// specifies a shuffle of elements that is suitable for input to PSHUFD.
 193    bool isPSHUFHWMask(SDNode *N);
 194
 195    /// isPSHUFLWMask - Return true if the specified VECTOR_SHUFFLE operand
 196    /// specifies a shuffle of elements that is suitable for input to PSHUFD.
 197    bool isPSHUFLWMask(SDNode *N);
 198
 199    /// isSHUFPMask - Return true if the specified VECTOR_SHUFFLE operand
 200    /// specifies a shuffle of elements that is suitable for input to SHUFP*.
 201    bool isSHUFPMask(SDNode *N);
 202
 203    /// isMOVHLPSMask - Return true if the specified VECTOR_SHUFFLE operand
 204    /// specifies a shuffle of elements that is suitable for input to MOVHLPS.
 205    bool isMOVHLPSMask(SDNode *N);
 206
 207    /// isMOVLPMask - Return true if the specified VECTOR_SHUFFLE operand
 208    /// specifies a shuffle of elements that is suitable for input to MOVLP{S|D}.
 209    bool isMOVLPMask(SDNode *N);
 210
 211    /// isMOVHPMask - Return true if the specified VECTOR_SHUFFLE operand
 212    /// specifies a shuffle of elements that is suitable for input to MOVHP{S|D}
 213    /// as well as MOVLHPS.
 214    bool isMOVHPMask(SDNode *N);
 215
 216    /// isUNPCKLMask - Return true if the specified VECTOR_SHUFFLE operand
 217    /// specifies a shuffle of elements that is suitable for input to UNPCKL.
 218    bool isUNPCKLMask(SDNode *N, bool V2IsSplat = false);
 219
 220    /// isUNPCKHMask - Return true if the specified VECTOR_SHUFFLE operand
 221    /// specifies a shuffle of elements that is suitable for input to UNPCKH.
 222    bool isUNPCKHMask(SDNode *N, bool V2IsSplat = false);
 223
 224    /// isUNPCKL_v_undef_Mask - Special case of isUNPCKLMask for canonical form
 225    /// of vector_shuffle v, v, <0, 4, 1, 5>, i.e. vector_shuffle v, undef,
 226    /// <0, 0, 1, 1>
 227    bool isUNPCKL_v_undef_Mask(SDNode *N);
 228
 229    /// isMOVLMask - Return true if the specified VECTOR_SHUFFLE operand
 230    /// specifies a shuffle of elements that is suitable for input to MOVSS,
 231    /// MOVSD, and MOVD, i.e. setting the lowest element.
 232    bool isMOVLMask(SDNode *N);
 233
 234    /// isMOVSHDUPMask - Return true if the specified VECTOR_SHUFFLE operand
 235    /// specifies a shuffle of elements that is suitable for input to MOVSHDUP.
 236    bool isMOVSHDUPMask(SDNode *N);
 237
 238    /// isMOVSLDUPMask - Return true if the specified VECTOR_SHUFFLE operand
 239    /// specifies a shuffle of elements that is suitable for input to MOVSLDUP.
 240    bool isMOVSLDUPMask(SDNode *N);
 241
 242    /// isSplatMask - Return true if the specified VECTOR_SHUFFLE operand
 243    /// specifies a splat of a single element.
 244    bool isSplatMask(SDNode *N);
 245
 246    /// getShuffleSHUFImmediate - Return the appropriate immediate to shuffle
 247    /// the specified isShuffleMask VECTOR_SHUFFLE mask with PSHUF* and SHUFP*
 248    /// instructions.
 249    unsigned getShuffleSHUFImmediate(SDNode *N);
 250
 251    /// getShufflePSHUFHWImmediate - Return the appropriate immediate to shuffle
 252    /// the specified isShuffleMask VECTOR_SHUFFLE mask with PSHUFHW
 253    /// instructions.
 254    unsigned getShufflePSHUFHWImmediate(SDNode *N);
 255
 256    /// getShufflePSHUFKWImmediate - Return the appropriate immediate to shuffle
 257    /// the specified isShuffleMask VECTOR_SHUFFLE mask with PSHUFLW
 258    /// instructions.
 259    unsigned getShufflePSHUFLWImmediate(SDNode *N);
 260  }
 261
 262   //===----------------------------------------------------------------------===//
 263   //  X86TargetLowering - X86 Implementation of the TargetLowering interface
 264   class X86TargetLowering : public TargetLowering {
 265     int VarArgsFrameIndex;            // FrameIndex for start of varargs area.
 266     int ReturnAddrIndex;              // FrameIndex for return slot.
 267     int BytesToPopOnReturn;           // Number of arg bytes ret should pop.
 268     int BytesCallerReserves;          // Number of arg bytes caller makes.
 269   public:
 270     X86TargetLowering(TargetMachine &TM);
 271
 272     // Return the number of bytes that a function should pop when it returns (in
 273     // addition to the space used by the return address).
 274     //
 275     unsigned getBytesToPopOnReturn() const { return BytesToPopOnReturn; }
 276
 277     // Return the number of bytes that the caller reserves for arguments passed
 278     // to this function.
 279     unsigned getBytesCallerReserves() const { return BytesCallerReserves; }
 280
 281     /// LowerOperation - Provide custom lowering hooks for some operations.
 282     ///
 283     virtual SDOperand LowerOperation(SDOperand Op, SelectionDAG &DAG);
 284
 285     /// LowerArguments - This hook must be implemented to indicate how we should
 286     /// lower the arguments for the specified function, into the specified DAG.
 287     virtual std::vector<SDOperand>
 288     LowerArguments(Function &F, SelectionDAG &DAG);
 289
 290     /// LowerCallTo - This hook lowers an abstract call to a function into an
 291     /// actual call.
 292     virtual std::pair<SDOperand, SDOperand>
 293     LowerCallTo(SDOperand Chain, const Type *RetTy, bool isVarArg, unsigned CC,
 294                 bool isTailCall, SDOperand Callee, ArgListTy &Args,
 295                 SelectionDAG &DAG);
 296
 297     virtual std::pair<SDOperand, SDOperand>
 298     LowerFrameReturnAddress(bool isFrameAddr, SDOperand Chain, unsigned Depth,
 299                             SelectionDAG &DAG);
 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     std::vector<unsigned>
 320       getRegClassForInlineAsmConstraint(const std::string &Constraint,
 321                                         MVT::ValueType VT) const;
 322
 323     /// isLegalAddressImmediate - Return true if the integer value or
 324     /// GlobalValue can be used as the offset of the target addressing mode.
 325     virtual bool isLegalAddressImmediate(int64_t V) const;
 326     virtual bool isLegalAddressImmediate(GlobalValue *GV) const;
 327
 328     /// isShuffleMaskLegal - Targets can use this to indicate that they only
 329     /// support *some* VECTOR_SHUFFLE operations, those with specific masks.
 330     /// By default, if a target supports the VECTOR_SHUFFLE node, all mask values
 331     /// are assumed to be legal.
 332     virtual bool isShuffleMaskLegal(SDOperand Mask, MVT::ValueType VT) const;
 333
 334     /// isVectorClearMaskLegal - Similar to isShuffleMaskLegal. This is
 335     /// used by Targets can use this to indicate if there is a suitable
 336     /// VECTOR_SHUFFLE that can be used to replace a VAND with a constant
 337     /// pool entry.
 338     virtual bool isVectorClearMaskLegal(std::vector<SDOperand> &BVOps,
 339                                         MVT::ValueType EVT,
 340                                         SelectionDAG &DAG) const;
 341   private:
 342     /// Subtarget - Keep a pointer to the X86Subtarget around so that we can
 343     /// make the right decision when generating code for different targets.
 344     const X86Subtarget *Subtarget;
 345
 346     /// X86ScalarSSE - Select between SSE2 or x87 floating point ops.
 347     bool X86ScalarSSE;
 348
 349     /// Formal arguments lowered to load and CopyFromReg ops.
 350     std::vector<SDOperand> FormalArgs;
 351
 352     /// Formal arguments locations (frame indices and registers).
 353     struct FALocInfo {
 354       enum FALocKind {
 355         None,
 356         StackFrameLoc,
 357         LiveInRegLoc,
 358       } Kind;
 359
 360       int Loc;
 361       MVT::ValueType Typ;
 362
 363       FALocInfo() : Kind(None), Loc(0), Typ(MVT::isVoid) {};
 364       FALocInfo(enum FALocKind k, int fi) : Kind(k), Loc(fi), Typ(MVT::isVoid) {};
 365       FALocInfo(enum FALocKind k, int r, MVT::ValueType vt)
 366         : Kind(k), Loc(r), Typ(vt) {};
 367     };
 368
 369     std::vector<std::pair<FALocInfo, FALocInfo> > FormalArgLocs;
 370
 371     // C Calling Convention implementation.
 372     void PreprocessCCCArguments(std::vector<SDOperand>Args, Function &F,
 373                                 SelectionDAG &DAG);
 374     void LowerCCCArguments(SDOperand Op, SelectionDAG &DAG);
 375     std::pair<SDOperand, SDOperand>
 376     LowerCCCCallTo(SDOperand Chain, const Type *RetTy, bool isVarArg,
 377                    bool isTailCall,
 378                    SDOperand Callee, ArgListTy &Args, SelectionDAG &DAG);
 379
 380     // Fast Calling Convention implementation.
 381     void
 382     PreprocessFastCCArguments(std::vector<SDOperand>Args, Function &F,
 383                               SelectionDAG &DAG);
 384     void
 385     LowerFastCCArguments(SDOperand Op, SelectionDAG &DAG);
 386     std::pair<SDOperand, SDOperand>
 387     LowerFastCCCallTo(SDOperand Chain, const Type *RetTy, bool isTailCall,
 388                       SDOperand Callee, ArgListTy &Args, SelectionDAG &DAG);
 389
 390     SDOperand LowerBUILD_VECTOR(SDOperand Op, SelectionDAG &DAG);
 391     SDOperand LowerVECTOR_SHUFFLE(SDOperand Op, SelectionDAG &DAG);
 392     SDOperand LowerEXTRACT_VECTOR_ELT(SDOperand Op, SelectionDAG &DAG);
 393     SDOperand LowerINSERT_VECTOR_ELT(SDOperand Op, SelectionDAG &DAG);
 394     SDOperand LowerSCALAR_TO_VECTOR(SDOperand Op, SelectionDAG &DAG);
 395     SDOperand LowerConstantPool(SDOperand Op, SelectionDAG &DAG);
 396     SDOperand LowerGlobalAddress(SDOperand Op, SelectionDAG &DAG);
 397     SDOperand LowerExternalSymbol(SDOperand Op, SelectionDAG &DAG);
 398     SDOperand LowerShift(SDOperand Op, SelectionDAG &DAG);
 399     SDOperand LowerSINT_TO_FP(SDOperand Op, SelectionDAG &DAG);
 400     SDOperand LowerFP_TO_SINT(SDOperand Op, SelectionDAG &DAG);
 401     SDOperand LowerFABS(SDOperand Op, SelectionDAG &DAG);
 402     SDOperand LowerFNEG(SDOperand Op, SelectionDAG &DAG);
 403     SDOperand LowerSETCC(SDOperand Op, SelectionDAG &DAG);
 404     SDOperand LowerSELECT(SDOperand Op, SelectionDAG &DAG);
 405     SDOperand LowerBRCOND(SDOperand Op, SelectionDAG &DAG);
 406     SDOperand LowerMEMSET(SDOperand Op, SelectionDAG &DAG);
 407     SDOperand LowerMEMCPY(SDOperand Op, SelectionDAG &DAG);
 408     SDOperand LowerJumpTable(SDOperand Op, SelectionDAG &DAG);
 409     SDOperand LowerRET(SDOperand Op, SelectionDAG &DAG);
 410     SDOperand LowerFORMAL_ARGUMENTS(SDOperand Op, SelectionDAG &DAG);
 411     SDOperand LowerREADCYCLCECOUNTER(SDOperand Op, SelectionDAG &DAG);
 412     SDOperand LowerVASTART(SDOperand Op, SelectionDAG &DAG);
 413     SDOperand LowerINTRINSIC_WO_CHAIN(SDOperand Op, SelectionDAG &DAG);
 414   };
 415 }
 416
 417 #endif    // X86ISELLOWERING_H