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/Target/TargetOptions.h"
  23 #include "llvm/CodeGen/FastISel.h"
  24 #include "llvm/CodeGen/SelectionDAG.h"
  25 #include "llvm/CodeGen/CallingConvLower.h"
  26
  27 namespace llvm {
  28   namespace X86ISD {
  29     // X86 Specific DAG Nodes
  30     enum NodeType {
  31       // Start the numbering where the builtin ops leave off.
  32       FIRST_NUMBER = ISD::BUILTIN_OP_END,
  33
  34       /// BSF - Bit scan forward.
  35       /// BSR - Bit scan reverse.
  36       BSF,
  37       BSR,
  38
  39       /// SHLD, SHRD - Double shift instructions. These correspond to
  40       /// X86::SHLDxx and X86::SHRDxx instructions.
  41       SHLD,
  42       SHRD,
  43
  44       /// FAND - Bitwise logical AND of floating point values. This corresponds
  45       /// to X86::ANDPS or X86::ANDPD.
  46       FAND,
  47
  48       /// FOR - Bitwise logical OR of floating point values. This corresponds
  49       /// to X86::ORPS or X86::ORPD.
  50       FOR,
  51
  52       /// FXOR - Bitwise logical XOR of floating point values. This corresponds
  53       /// to X86::XORPS or X86::XORPD.
  54       FXOR,
  55
  56       /// FSRL - Bitwise logical right shift of floating point values. These
  57       /// corresponds to X86::PSRLDQ.
  58       FSRL,
  59
  60       /// FILD, FILD_FLAG - This instruction implements SINT_TO_FP with the
  61       /// integer source in memory and FP reg result.  This corresponds to the
  62       /// X86::FILD*m instructions. It has three inputs (token chain, address,
  63       /// and source type) and two outputs (FP value and token chain). FILD_FLAG
  64       /// also produces a flag).
  65       FILD,
  66       FILD_FLAG,
  67
  68       /// FP_TO_INT*_IN_MEM - This instruction implements FP_TO_SINT with the
  69       /// integer destination in memory and a FP reg source.  This corresponds
  70       /// to the X86::FIST*m instructions and the rounding mode change stuff. It
  71       /// has two inputs (token chain and address) and two outputs (int value
  72       /// and token chain).
  73       FP_TO_INT16_IN_MEM,
  74       FP_TO_INT32_IN_MEM,
  75       FP_TO_INT64_IN_MEM,
  76
  77       /// FLD - This instruction implements an extending load to FP stack slots.
  78       /// This corresponds to the X86::FLD32m / X86::FLD64m. It takes a chain
  79       /// operand, ptr to load from, and a ValueType node indicating the type
  80       /// to load to.
  81       FLD,
  82
  83       /// FST - This instruction implements a truncating store to FP stack
  84       /// slots. This corresponds to the X86::FST32m / X86::FST64m. It takes a
  85       /// chain operand, value to store, address, and a ValueType to store it
  86       /// as.
  87       FST,
  88
  89       /// CALL - 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       CALL,
 107
 108       /// RDTSC_DAG - This operation implements the lowering for
 109       /// readcyclecounter
 110       RDTSC_DAG,
 111
 112       /// X86 compare and logical compare instructions.
 113       CMP, COMI, UCOMI,
 114
 115       /// X86 bit-test instructions.
 116       BT,
 117
 118       /// X86 SetCC. Operand 0 is condition code, and operand 1 is the flag
 119       /// operand produced by a CMP instruction.
 120       SETCC,
 121
 122       // Same as SETCC except it's materialized with a sbb and the value is all
 123       // one's or all zero's.
 124       SETCC_CARRY,
 125
 126       /// X86 conditional moves. Operand 0 and operand 1 are the two values
 127       /// to select from. Operand 2 is the condition code, and operand 3 is the
 128       /// flag operand produced by a CMP or TEST instruction. It also writes a
 129       /// flag result.
 130       CMOV,
 131
 132       /// X86 conditional branches. Operand 0 is the chain operand, operand 1
 133       /// is the block to branch if condition is true, operand 2 is the
 134       /// condition code, and operand 3 is the flag operand produced by a CMP
 135       /// or TEST instruction.
 136       BRCOND,
 137
 138       /// Return with a flag operand. Operand 0 is the chain operand, operand
 139       /// 1 is the number of bytes of stack to pop.
 140       RET_FLAG,
 141
 142       /// REP_STOS - Repeat fill, corresponds to X86::REP_STOSx.
 143       REP_STOS,
 144
 145       /// REP_MOVS - Repeat move, corresponds to X86::REP_MOVSx.
 146       REP_MOVS,
 147
 148       /// GlobalBaseReg - On Darwin, this node represents the result of the popl
 149       /// at function entry, used for PIC code.
 150       GlobalBaseReg,
 151
 152       /// Wrapper - A wrapper node for TargetConstantPool,
 153       /// TargetExternalSymbol, and TargetGlobalAddress.
 154       Wrapper,
 155
 156       /// WrapperRIP - Special wrapper used under X86-64 PIC mode for RIP
 157       /// relative displacements.
 158       WrapperRIP,
 159
 160       /// MOVQ2DQ - Copies a 64-bit value from a vector to another vector.
 161       /// Can be used to move a vector value from a MMX register to a XMM
 162       /// register.
 163       MOVQ2DQ,
 164
 165       /// PEXTRB - Extract an 8-bit value from a vector and zero extend it to
 166       /// i32, corresponds to X86::PEXTRB.
 167       PEXTRB,
 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       /// INSERTPS - Insert any element of a 4 x float vector into any element
 174       /// of a destination 4 x floatvector.
 175       INSERTPS,
 176
 177       /// PINSRB - Insert the lower 8-bits of a 32-bit value to a vector,
 178       /// corresponds to X86::PINSRB.
 179       PINSRB,
 180
 181       /// PINSRW - Insert the lower 16-bits of a 32-bit value to a vector,
 182       /// corresponds to X86::PINSRW.
 183       PINSRW, MMX_PINSRW,
 184
 185       /// PSHUFB - Shuffle 16 8-bit values within a vector.
 186       PSHUFB,
 187
 188       /// FMAX, FMIN - Floating point max and min.
 189       ///
 190       FMAX, FMIN,
 191
 192       /// FRSQRT, FRCP - Floating point reciprocal-sqrt and reciprocal
 193       /// approximation.  Note that these typically require refinement
 194       /// in order to obtain suitable precision.
 195       FRSQRT, FRCP,
 196
 197       // TLSADDR - Thread Local Storage.
 198       TLSADDR,
 199
 200       // SegmentBaseAddress - The address segment:0
 201       SegmentBaseAddress,
 202
 203       // EH_RETURN - Exception Handling helpers.
 204       EH_RETURN,
 205
 206       /// TC_RETURN - Tail call return.
 207       ///   operand #0 chain
 208       ///   operand #1 callee (register or absolute)
 209       ///   operand #2 stack adjustment
 210       ///   operand #3 optional in flag
 211       TC_RETURN,
 212
 213       // LCMPXCHG_DAG, LCMPXCHG8_DAG - Compare and swap.
 214       LCMPXCHG_DAG,
 215       LCMPXCHG8_DAG,
 216
 217       // FNSTCW16m - Store FP control world into i16 memory.
 218       FNSTCW16m,
 219
 220       // VZEXT_MOVL - Vector move low and zero extend.
 221       VZEXT_MOVL,
 222
 223       // VZEXT_LOAD - Load, scalar_to_vector, and zero extend.
 224       VZEXT_LOAD,
 225
 226       // VSHL, VSRL - Vector logical left / right shift.
 227       VSHL, VSRL,
 228
 229       // CMPPD, CMPPS - Vector double/float comparison.
 230       // CMPPD, CMPPS - Vector double/float comparison.
 231       CMPPD, CMPPS,
 232
 233       // PCMP* - Vector integer comparisons.
 234       PCMPEQB, PCMPEQW, PCMPEQD, PCMPEQQ,
 235       PCMPGTB, PCMPGTW, PCMPGTD, PCMPGTQ,
 236
 237       // ADD, SUB, SMUL, UMUL, etc. - Arithmetic operations with FLAGS results.
 238       ADD, SUB, SMUL, UMUL,
 239       INC, DEC, OR, XOR, AND,
 240
 241       // MUL_IMM - X86 specific multiply by immediate.
 242       MUL_IMM,
 243
 244       // PTEST - Vector bitwise comparisons
 245       PTEST,
 246
 247       // VASTART_SAVE_XMM_REGS - Save xmm argument registers to the stack,
 248       // according to %al. An operator is needed so that this can be expanded
 249       // with control flow.
 250       VASTART_SAVE_XMM_REGS,
 251
 252       // MINGW_ALLOCA - MingW's __alloca call to do stack probing.
 253       MINGW_ALLOCA,
 254
 255       // ATOMADD64_DAG, ATOMSUB64_DAG, ATOMOR64_DAG, ATOMAND64_DAG,
 256       // ATOMXOR64_DAG, ATOMNAND64_DAG, ATOMSWAP64_DAG -
 257       // Atomic 64-bit binary operations.
 258       ATOMADD64_DAG = ISD::FIRST_TARGET_MEMORY_OPCODE,
 259       ATOMSUB64_DAG,
 260       ATOMOR64_DAG,
 261       ATOMXOR64_DAG,
 262       ATOMAND64_DAG,
 263       ATOMNAND64_DAG,
 264       ATOMSWAP64_DAG
 265
 266       // WARNING: Do not add anything in the end unless you want the node to
 267       // have memop! In fact, starting from ATOMADD64_DAG all opcodes will be
 268       // thought as target memory ops!
 269     };
 270   }
 271
 272   /// Define some predicates that are used for node matching.
 273   namespace X86 {
 274     /// isPSHUFDMask - Return true if the specified VECTOR_SHUFFLE operand
 275     /// specifies a shuffle of elements that is suitable for input to PSHUFD.
 276     bool isPSHUFDMask(ShuffleVectorSDNode *N);
 277
 278     /// isPSHUFHWMask - Return true if the specified VECTOR_SHUFFLE operand
 279     /// specifies a shuffle of elements that is suitable for input to PSHUFD.
 280     bool isPSHUFHWMask(ShuffleVectorSDNode *N);
 281
 282     /// isPSHUFLWMask - Return true if the specified VECTOR_SHUFFLE operand
 283     /// specifies a shuffle of elements that is suitable for input to PSHUFD.
 284     bool isPSHUFLWMask(ShuffleVectorSDNode *N);
 285
 286     /// isSHUFPMask - Return true if the specified VECTOR_SHUFFLE operand
 287     /// specifies a shuffle of elements that is suitable for input to SHUFP*.
 288     bool isSHUFPMask(ShuffleVectorSDNode *N);
 289
 290     /// isMOVHLPSMask - Return true if the specified VECTOR_SHUFFLE operand
 291     /// specifies a shuffle of elements that is suitable for input to MOVHLPS.
 292     bool isMOVHLPSMask(ShuffleVectorSDNode *N);
 293
 294     /// isMOVHLPS_v_undef_Mask - Special case of isMOVHLPSMask for canonical form
 295     /// of vector_shuffle v, v, <2, 3, 2, 3>, i.e. vector_shuffle v, undef,
 296     /// <2, 3, 2, 3>
 297     bool isMOVHLPS_v_undef_Mask(ShuffleVectorSDNode *N);
 298
 299     /// isMOVLPMask - Return true if the specified VECTOR_SHUFFLE operand
 300     /// specifies a shuffle of elements that is suitable for MOVLP{S|D}.
 301     bool isMOVLPMask(ShuffleVectorSDNode *N);
 302
 303     /// isMOVHPMask - Return true if the specified VECTOR_SHUFFLE operand
 304     /// specifies a shuffle of elements that is suitable for MOVHP{S|D}.
 305     /// as well as MOVLHPS.
 306     bool isMOVLHPSMask(ShuffleVectorSDNode *N);
 307
 308     /// isUNPCKLMask - Return true if the specified VECTOR_SHUFFLE operand
 309     /// specifies a shuffle of elements that is suitable for input to UNPCKL.
 310     bool isUNPCKLMask(ShuffleVectorSDNode *N, bool V2IsSplat = false);
 311
 312     /// isUNPCKHMask - Return true if the specified VECTOR_SHUFFLE operand
 313     /// specifies a shuffle of elements that is suitable for input to UNPCKH.
 314     bool isUNPCKHMask(ShuffleVectorSDNode *N, bool V2IsSplat = false);
 315
 316     /// isUNPCKL_v_undef_Mask - Special case of isUNPCKLMask for canonical form
 317     /// of vector_shuffle v, v, <0, 4, 1, 5>, i.e. vector_shuffle v, undef,
 318     /// <0, 0, 1, 1>
 319     bool isUNPCKL_v_undef_Mask(ShuffleVectorSDNode *N);
 320
 321     /// isUNPCKH_v_undef_Mask - Special case of isUNPCKHMask for canonical form
 322     /// of vector_shuffle v, v, <2, 6, 3, 7>, i.e. vector_shuffle v, undef,
 323     /// <2, 2, 3, 3>
 324     bool isUNPCKH_v_undef_Mask(ShuffleVectorSDNode *N);
 325
 326     /// isMOVLMask - Return true if the specified VECTOR_SHUFFLE operand
 327     /// specifies a shuffle of elements that is suitable for input to MOVSS,
 328     /// MOVSD, and MOVD, i.e. setting the lowest element.
 329     bool isMOVLMask(ShuffleVectorSDNode *N);
 330
 331     /// isMOVSHDUPMask - Return true if the specified VECTOR_SHUFFLE operand
 332     /// specifies a shuffle of elements that is suitable for input to MOVSHDUP.
 333     bool isMOVSHDUPMask(ShuffleVectorSDNode *N);
 334
 335     /// isMOVSLDUPMask - Return true if the specified VECTOR_SHUFFLE operand
 336     /// specifies a shuffle of elements that is suitable for input to MOVSLDUP.
 337     bool isMOVSLDUPMask(ShuffleVectorSDNode *N);
 338
 339     /// isMOVDDUPMask - Return true if the specified VECTOR_SHUFFLE operand
 340     /// specifies a shuffle of elements that is suitable for input to MOVDDUP.
 341     bool isMOVDDUPMask(ShuffleVectorSDNode *N);
 342
 343     /// isPALIGNRMask - Return true if the specified VECTOR_SHUFFLE operand
 344     /// specifies a shuffle of elements that is suitable for input to PALIGNR.
 345     bool isPALIGNRMask(ShuffleVectorSDNode *N);
 346
 347     /// getShuffleSHUFImmediate - Return the appropriate immediate to shuffle
 348     /// the specified isShuffleMask VECTOR_SHUFFLE mask with PSHUF* and SHUFP*
 349     /// instructions.
 350     unsigned getShuffleSHUFImmediate(SDNode *N);
 351
 352     /// getShufflePSHUFHWImmediate - Return the appropriate immediate to shuffle
 353     /// the specified VECTOR_SHUFFLE mask with PSHUFHW instruction.
 354     unsigned getShufflePSHUFHWImmediate(SDNode *N);
 355
 356     /// getShufflePSHUFLWImmediate - Return the appropriate immediate to shuffle
 357     /// the specified VECTOR_SHUFFLE mask with PSHUFLW instruction.
 358     unsigned getShufflePSHUFLWImmediate(SDNode *N);
 359
 360     /// getShufflePALIGNRImmediate - Return the appropriate immediate to shuffle
 361     /// the specified VECTOR_SHUFFLE mask with the PALIGNR instruction.
 362     unsigned getShufflePALIGNRImmediate(SDNode *N);
 363
 364     /// isZeroNode - Returns true if Elt is a constant zero or a floating point
 365     /// constant +0.0.
 366     bool isZeroNode(SDValue Elt);
 367
 368     /// isOffsetSuitableForCodeModel - Returns true of the given offset can be
 369     /// fit into displacement field of the instruction.
 370     bool isOffsetSuitableForCodeModel(int64_t Offset, CodeModel::Model M,
 371                                       bool hasSymbolicDisplacement = true);
 372   }
 373
 374   //===--------------------------------------------------------------------===//
 375   //  X86TargetLowering - X86 Implementation of the TargetLowering interface
 376   class X86TargetLowering : public TargetLowering {
 377     int VarArgsFrameIndex;            // FrameIndex for start of varargs area.
 378     int RegSaveFrameIndex;            // X86-64 vararg func register save area.
 379     unsigned VarArgsGPOffset;         // X86-64 vararg func int reg offset.
 380     unsigned VarArgsFPOffset;         // X86-64 vararg func fp reg offset.
 381     int BytesToPopOnReturn;           // Number of arg bytes ret should pop.
 382
 383   public:
 384     explicit X86TargetLowering(X86TargetMachine &TM);
 385
 386     /// getPICBaseSymbol - Return the X86-32 PIC base.
 387     MCSymbol *getPICBaseSymbol(const MachineFunction *MF, MCContext &Ctx) const;
 388
 389     virtual unsigned getJumpTableEncoding() const;
 390
 391     virtual const MCExpr *
 392     LowerCustomJumpTableEntry(const MachineJumpTableInfo *MJTI,
 393                               const MachineBasicBlock *MBB, unsigned uid,
 394                               MCContext &Ctx) const;
 395
 396     /// getPICJumpTableRelocaBase - Returns relocation base for the given PIC
 397     /// jumptable.
 398     virtual SDValue getPICJumpTableRelocBase(SDValue Table,
 399                                              SelectionDAG &DAG) const;
 400     virtual const MCExpr *
 401     getPICJumpTableRelocBaseExpr(const MachineFunction *MF,
 402                                  unsigned JTI, MCContext &Ctx) const;
 403
 404     // Return the number of bytes that a function should pop when it returns (in
 405     // addition to the space used by the return address).
 406     //
 407     unsigned getBytesToPopOnReturn() const { return BytesToPopOnReturn; }
 408
 409     /// getStackPtrReg - Return the stack pointer register we are using: either
 410     /// ESP or RSP.
 411     unsigned getStackPtrReg() const { return X86StackPtr; }
 412
 413     /// getByValTypeAlignment - Return the desired alignment for ByVal aggregate
 414     /// function arguments in the caller parameter area. For X86, aggregates
 415     /// that contains are placed at 16-byte boundaries while the rest are at
 416     /// 4-byte boundaries.
 417     virtual unsigned getByValTypeAlignment(const Type *Ty) const;
 418
 419     /// getOptimalMemOpType - Returns the target specific optimal type for load
 420     /// and store operations as a result of memset, memcpy, and memmove
 421     /// lowering. If DstAlign is zero that means it's safe to destination
 422     /// alignment can satisfy any constraint. Similarly if SrcAlign is zero it
 423     /// means there isn't a need to check it against alignment requirement,
 424     /// probably because the source does not need to be loaded. If
 425     /// 'NonScalarIntSafe' is true, that means it's safe to return a
 426     /// non-scalar-integer type, e.g. empty string source, constant, or loaded
 427     /// from memory. 'MemcpyStrSrc' indicates whether the memcpy source is
 428     /// constant so it does not need to be loaded.
 429     /// It returns EVT::Other if SelectionDAG should be responsible for
 430     /// determining the type.
 431     virtual EVT
 432     getOptimalMemOpType(uint64_t Size, unsigned DstAlign, unsigned SrcAlign,
 433                         bool NonScalarIntSafe, bool MemcpyStrSrc,
 434                         SelectionDAG &DAG) const;
 435
 436     /// allowsUnalignedMemoryAccesses - Returns true if the target allows
 437     /// unaligned memory accesses. of the specified type.
 438     virtual bool allowsUnalignedMemoryAccesses(EVT VT) const {
 439       return true;
 440     }
 441
 442     /// LowerOperation - Provide custom lowering hooks for some operations.
 443     ///
 444     virtual SDValue LowerOperation(SDValue Op, SelectionDAG &DAG);
 445
 446     /// ReplaceNodeResults - Replace the results of node with an illegal result
 447     /// type with new values built out of custom code.
 448     ///
 449     virtual void ReplaceNodeResults(SDNode *N, SmallVectorImpl<SDValue>&Results,
 450                                     SelectionDAG &DAG);
 451
 452
 453     virtual SDValue PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const;
 454
 455     virtual MachineBasicBlock *EmitInstrWithCustomInserter(MachineInstr *MI,
 456                                                          MachineBasicBlock *MBB,
 457                     DenseMap<MachineBasicBlock*, MachineBasicBlock*> *EM) const;
 458
 459
 460     /// getTargetNodeName - This method returns the name of a target specific
 461     /// DAG node.
 462     virtual const char *getTargetNodeName(unsigned Opcode) const;
 463
 464     /// getSetCCResultType - Return the ISD::SETCC ValueType
 465     virtual MVT::SimpleValueType getSetCCResultType(EVT VT) const;
 466
 467     /// computeMaskedBitsForTargetNode - Determine which of the bits specified
 468     /// in Mask are known to be either zero or one and return them in the
 469     /// KnownZero/KnownOne bitsets.
 470     virtual void computeMaskedBitsForTargetNode(const SDValue Op,
 471                                                 const APInt &Mask,
 472                                                 APInt &KnownZero,
 473                                                 APInt &KnownOne,
 474                                                 const SelectionDAG &DAG,
 475                                                 unsigned Depth = 0) const;
 476
 477     virtual bool
 478     isGAPlusOffset(SDNode *N, const GlobalValue* &GA, int64_t &Offset) const;
 479
 480     SDValue getReturnAddressFrameIndex(SelectionDAG &DAG);
 481
 482     virtual bool ExpandInlineAsm(CallInst *CI) const;
 483
 484     ConstraintType getConstraintType(const std::string &Constraint) const;
 485
 486     std::vector<unsigned>
 487       getRegClassForInlineAsmConstraint(const std::string &Constraint,
 488                                         EVT VT) const;
 489
 490     virtual const char *LowerXConstraint(EVT ConstraintVT) const;
 491
 492     /// LowerAsmOperandForConstraint - Lower the specified operand into the Ops
 493     /// vector.  If it is invalid, don't add anything to Ops. If hasMemory is
 494     /// true it means one of the asm constraint of the inline asm instruction
 495     /// being processed is 'm'.
 496     virtual void LowerAsmOperandForConstraint(SDValue Op,
 497                                               char ConstraintLetter,
 498                                               bool hasMemory,
 499                                               std::vector<SDValue> &Ops,
 500                                               SelectionDAG &DAG) const;
 501
 502     /// getRegForInlineAsmConstraint - Given a physical register constraint
 503     /// (e.g. {edx}), return the register number and the register class for the
 504     /// register.  This should only be used for C_Register constraints.  On
 505     /// error, this returns a register number of 0.
 506     std::pair<unsigned, const TargetRegisterClass*>
 507       getRegForInlineAsmConstraint(const std::string &Constraint,
 508                                    EVT VT) const;
 509
 510     /// isLegalAddressingMode - Return true if the addressing mode represented
 511     /// by AM is legal for this target, for a load/store of the specified type.
 512     virtual bool isLegalAddressingMode(const AddrMode &AM, const Type *Ty)const;
 513
 514     /// isTruncateFree - Return true if it's free to truncate a value of
 515     /// type Ty1 to type Ty2. e.g. On x86 it's free to truncate a i32 value in
 516     /// register EAX to i16 by referencing its sub-register AX.
 517     virtual bool isTruncateFree(const Type *Ty1, const Type *Ty2) const;
 518     virtual bool isTruncateFree(EVT VT1, EVT VT2) const;
 519
 520     /// isZExtFree - Return true if any actual instruction that defines a
 521     /// value of type Ty1 implicit zero-extends the value to Ty2 in the result
 522     /// register. This does not necessarily include registers defined in
 523     /// unknown ways, such as incoming arguments, or copies from unknown
 524     /// virtual registers. Also, if isTruncateFree(Ty2, Ty1) is true, this
 525     /// does not necessarily apply to truncate instructions. e.g. on x86-64,
 526     /// all instructions that define 32-bit values implicit zero-extend the
 527     /// result out to 64 bits.
 528     virtual bool isZExtFree(const Type *Ty1, const Type *Ty2) const;
 529     virtual bool isZExtFree(EVT VT1, EVT VT2) const;
 530
 531     /// isNarrowingProfitable - Return true if it's profitable to narrow
 532     /// operations of type VT1 to VT2. e.g. on x86, it's profitable to narrow
 533     /// from i32 to i8 but not from i32 to i16.
 534     virtual bool isNarrowingProfitable(EVT VT1, EVT VT2) const;
 535
 536     /// isFPImmLegal - Returns true if the target can instruction select the
 537     /// specified FP immediate natively. If false, the legalizer will
 538     /// materialize the FP immediate as a load from a constant pool.
 539     virtual bool isFPImmLegal(const APFloat &Imm, EVT VT) const;
 540
 541     /// isShuffleMaskLegal - Targets can use this to indicate that they only
 542     /// support *some* VECTOR_SHUFFLE operations, those with specific masks.
 543     /// By default, if a target supports the VECTOR_SHUFFLE node, all mask
 544     /// values are assumed to be legal.
 545     virtual bool isShuffleMaskLegal(const SmallVectorImpl<int> &Mask,
 546                                     EVT VT) const;
 547
 548     /// isVectorClearMaskLegal - Similar to isShuffleMaskLegal. This is
 549     /// used by Targets can use this to indicate if there is a suitable
 550     /// VECTOR_SHUFFLE that can be used to replace a VAND with a constant
 551     /// pool entry.
 552     virtual bool isVectorClearMaskLegal(const SmallVectorImpl<int> &Mask,
 553                                         EVT VT) const;
 554
 555     /// ShouldShrinkFPConstant - If true, then instruction selection should
 556     /// seek to shrink the FP constant of the specified type to a smaller type
 557     /// in order to save space and / or reduce runtime.
 558     virtual bool ShouldShrinkFPConstant(EVT VT) const {
 559       // Don't shrink FP constpool if SSE2 is available since cvtss2sd is more
 560       // expensive than a straight movsd. On the other hand, it's important to
 561       // shrink long double fp constant since fldt is very slow.
 562       return !X86ScalarSSEf64 || VT == MVT::f80;
 563     }
 564
 565     virtual const X86Subtarget* getSubtarget() {
 566       return Subtarget;
 567     }
 568
 569     /// isScalarFPTypeInSSEReg - Return true if the specified scalar FP type is
 570     /// computed in an SSE register, not on the X87 floating point stack.
 571     bool isScalarFPTypeInSSEReg(EVT VT) const {
 572       return (VT == MVT::f64 && X86ScalarSSEf64) || // f64 is when SSE2
 573       (VT == MVT::f32 && X86ScalarSSEf32);   // f32 is when SSE1
 574     }
 575
 576     /// createFastISel - This method returns a target specific FastISel object,
 577     /// or null if the target does not support "fast" ISel.
 578     virtual FastISel *
 579     createFastISel(MachineFunction &mf,
 580                    DenseMap<const Value *, unsigned> &,
 581                    DenseMap<const BasicBlock *, MachineBasicBlock *> &,
 582                    DenseMap<const AllocaInst *, int> &
 583 #ifndef NDEBUG
 584                    , SmallSet<const Instruction *, 8> &
 585 #endif
 586                    );
 587
 588     /// getFunctionAlignment - Return the Log2 alignment of this function.
 589     virtual unsigned getFunctionAlignment(const Function *F) const;
 590
 591   private:
 592     /// Subtarget - Keep a pointer to the X86Subtarget around so that we can
 593     /// make the right decision when generating code for different targets.
 594     const X86Subtarget *Subtarget;
 595     const X86RegisterInfo *RegInfo;
 596     const TargetData *TD;
 597
 598     /// X86StackPtr - X86 physical register used as stack ptr.
 599     unsigned X86StackPtr;
 600
 601     /// X86ScalarSSEf32, X86ScalarSSEf64 - Select between SSE or x87
 602     /// floating point ops.
 603     /// When SSE is available, use it for f32 operations.
 604     /// When SSE2 is available, use it for f64 operations.
 605     bool X86ScalarSSEf32;
 606     bool X86ScalarSSEf64;
 607
 608     /// LegalFPImmediates - A list of legal fp immediates.
 609     std::vector<APFloat> LegalFPImmediates;
 610
 611     /// addLegalFPImmediate - Indicate that this x86 target can instruction
 612     /// select the specified FP immediate natively.
 613     void addLegalFPImmediate(const APFloat& Imm) {
 614       LegalFPImmediates.push_back(Imm);
 615     }
 616
 617     SDValue LowerCallResult(SDValue Chain, SDValue InFlag,
 618                             CallingConv::ID CallConv, bool isVarArg,
 619                             const SmallVectorImpl<ISD::InputArg> &Ins,
 620                             DebugLoc dl, SelectionDAG &DAG,
 621                             SmallVectorImpl<SDValue> &InVals);
 622     SDValue LowerMemArgument(SDValue Chain,
 623                              CallingConv::ID CallConv,
 624                              const SmallVectorImpl<ISD::InputArg> &ArgInfo,
 625                              DebugLoc dl, SelectionDAG &DAG,
 626                              const CCValAssign &VA,  MachineFrameInfo *MFI,
 627                               unsigned i);
 628     SDValue LowerMemOpCallTo(SDValue Chain, SDValue StackPtr, SDValue Arg,
 629                              DebugLoc dl, SelectionDAG &DAG,
 630                              const CCValAssign &VA,
 631                              ISD::ArgFlagsTy Flags);
 632
 633     // Call lowering helpers.
 634
 635     /// IsEligibleForTailCallOptimization - Check whether the call is eligible
 636     /// for tail call optimization. Targets which want to do tail call
 637     /// optimization should implement this function.
 638     bool IsEligibleForTailCallOptimization(SDValue Callee,
 639                                            CallingConv::ID CalleeCC,
 640                                            bool isVarArg,
 641                                            bool isCalleeStructRet,
 642                                            bool isCallerStructRet,
 643                                     const SmallVectorImpl<ISD::OutputArg> &Outs,
 644                                     const SmallVectorImpl<ISD::InputArg> &Ins,
 645                                            SelectionDAG& DAG) const;
 646     bool IsCalleePop(bool isVarArg, CallingConv::ID CallConv);
 647     SDValue EmitTailCallLoadRetAddr(SelectionDAG &DAG, SDValue &OutRetAddr,
 648                                 SDValue Chain, bool IsTailCall, bool Is64Bit,
 649                                 int FPDiff, DebugLoc dl);
 650
 651     CCAssignFn *CCAssignFnForNode(CallingConv::ID CallConv) const;
 652     unsigned GetAlignedArgumentStackSize(unsigned StackSize, SelectionDAG &DAG);
 653
 654     std::pair<SDValue,SDValue> FP_TO_INTHelper(SDValue Op, SelectionDAG &DAG,
 655                                                bool isSigned);
 656
 657     SDValue LowerAsSplatVectorLoad(SDValue SrcOp, EVT VT, DebugLoc dl,
 658                                    SelectionDAG &DAG);
 659     SDValue LowerBUILD_VECTOR(SDValue Op, SelectionDAG &DAG);
 660     SDValue LowerCONCAT_VECTORS(SDValue Op, SelectionDAG &DAG);
 661     SDValue LowerVECTOR_SHUFFLE(SDValue Op, SelectionDAG &DAG);
 662     SDValue LowerEXTRACT_VECTOR_ELT(SDValue Op, SelectionDAG &DAG);
 663     SDValue LowerEXTRACT_VECTOR_ELT_SSE4(SDValue Op, SelectionDAG &DAG);
 664     SDValue LowerINSERT_VECTOR_ELT(SDValue Op, SelectionDAG &DAG);
 665     SDValue LowerINSERT_VECTOR_ELT_SSE4(SDValue Op, SelectionDAG &DAG);
 666     SDValue LowerSCALAR_TO_VECTOR(SDValue Op, SelectionDAG &DAG);
 667     SDValue LowerConstantPool(SDValue Op, SelectionDAG &DAG);
 668     SDValue LowerBlockAddress(SDValue Op, SelectionDAG &DAG);
 669     SDValue LowerGlobalAddress(const GlobalValue *GV, DebugLoc dl,
 670                                int64_t Offset, SelectionDAG &DAG) const;
 671     SDValue LowerGlobalAddress(SDValue Op, SelectionDAG &DAG);
 672     SDValue LowerGlobalTLSAddress(SDValue Op, SelectionDAG &DAG);
 673     SDValue LowerExternalSymbol(SDValue Op, SelectionDAG &DAG);
 674     SDValue LowerShift(SDValue Op, SelectionDAG &DAG);
 675     SDValue BuildFILD(SDValue Op, EVT SrcVT, SDValue Chain, SDValue StackSlot,
 676                       SelectionDAG &DAG);
 677     SDValue LowerSINT_TO_FP(SDValue Op, SelectionDAG &DAG);
 678     SDValue LowerUINT_TO_FP(SDValue Op, SelectionDAG &DAG);
 679     SDValue LowerUINT_TO_FP_i64(SDValue Op, SelectionDAG &DAG);
 680     SDValue LowerUINT_TO_FP_i32(SDValue Op, SelectionDAG &DAG);
 681     SDValue LowerFP_TO_SINT(SDValue Op, SelectionDAG &DAG);
 682     SDValue LowerFP_TO_UINT(SDValue Op, SelectionDAG &DAG);
 683     SDValue LowerFABS(SDValue Op, SelectionDAG &DAG);
 684     SDValue LowerFNEG(SDValue Op, SelectionDAG &DAG);
 685     SDValue LowerFCOPYSIGN(SDValue Op, SelectionDAG &DAG);
 686     SDValue LowerSETCC(SDValue Op, SelectionDAG &DAG);
 687     SDValue LowerVSETCC(SDValue Op, SelectionDAG &DAG);
 688     SDValue LowerSELECT(SDValue Op, SelectionDAG &DAG);
 689     SDValue LowerBRCOND(SDValue Op, SelectionDAG &DAG);
 690     SDValue LowerMEMSET(SDValue Op, SelectionDAG &DAG);
 691     SDValue LowerJumpTable(SDValue Op, SelectionDAG &DAG);
 692     SDValue LowerDYNAMIC_STACKALLOC(SDValue Op, SelectionDAG &DAG);
 693     SDValue LowerVASTART(SDValue Op, SelectionDAG &DAG);
 694     SDValue LowerVAARG(SDValue Op, SelectionDAG &DAG);
 695     SDValue LowerVACOPY(SDValue Op, SelectionDAG &DAG);
 696     SDValue LowerINTRINSIC_WO_CHAIN(SDValue Op, SelectionDAG &DAG);
 697     SDValue LowerRETURNADDR(SDValue Op, SelectionDAG &DAG);
 698     SDValue LowerFRAMEADDR(SDValue Op, SelectionDAG &DAG);
 699     SDValue LowerFRAME_TO_ARGS_OFFSET(SDValue Op, SelectionDAG &DAG);
 700     SDValue LowerEH_RETURN(SDValue Op, SelectionDAG &DAG);
 701     SDValue LowerTRAMPOLINE(SDValue Op, SelectionDAG &DAG);
 702     SDValue LowerFLT_ROUNDS_(SDValue Op, SelectionDAG &DAG);
 703     SDValue LowerCTLZ(SDValue Op, SelectionDAG &DAG);
 704     SDValue LowerCTTZ(SDValue Op, SelectionDAG &DAG);
 705     SDValue LowerMUL_V2I64(SDValue Op, SelectionDAG &DAG);
 706     SDValue LowerXALUO(SDValue Op, SelectionDAG &DAG);
 707
 708     SDValue LowerCMP_SWAP(SDValue Op, SelectionDAG &DAG);
 709     SDValue LowerLOAD_SUB(SDValue Op, SelectionDAG &DAG);
 710     SDValue LowerREADCYCLECOUNTER(SDValue Op, SelectionDAG &DAG);
 711
 712     virtual SDValue
 713       LowerFormalArguments(SDValue Chain,
 714                            CallingConv::ID CallConv, bool isVarArg,
 715                            const SmallVectorImpl<ISD::InputArg> &Ins,
 716                            DebugLoc dl, SelectionDAG &DAG,
 717                            SmallVectorImpl<SDValue> &InVals);
 718     virtual SDValue
 719       LowerCall(SDValue Chain, SDValue Callee,
 720                 CallingConv::ID CallConv, bool isVarArg, bool &isTailCall,
 721                 const SmallVectorImpl<ISD::OutputArg> &Outs,
 722                 const SmallVectorImpl<ISD::InputArg> &Ins,
 723                 DebugLoc dl, SelectionDAG &DAG,
 724                 SmallVectorImpl<SDValue> &InVals);
 725
 726     virtual SDValue
 727       LowerReturn(SDValue Chain,
 728                   CallingConv::ID CallConv, bool isVarArg,
 729                   const SmallVectorImpl<ISD::OutputArg> &Outs,
 730                   DebugLoc dl, SelectionDAG &DAG);
 731
 732     virtual bool
 733       CanLowerReturn(CallingConv::ID CallConv, bool isVarArg,
 734                      const SmallVectorImpl<EVT> &OutTys,
 735                      const SmallVectorImpl<ISD::ArgFlagsTy> &ArgsFlags,
 736                      SelectionDAG &DAG);
 737
 738     void ReplaceATOMIC_BINARY_64(SDNode *N, SmallVectorImpl<SDValue> &Results,
 739                                  SelectionDAG &DAG, unsigned NewOp);
 740
 741     SDValue EmitTargetCodeForMemset(SelectionDAG &DAG, DebugLoc dl,
 742                                     SDValue Chain,
 743                                     SDValue Dst, SDValue Src,
 744                                     SDValue Size, unsigned Align,
 745                                     bool isVolatile,
 746                                     const Value *DstSV, uint64_t DstSVOff);
 747     SDValue EmitTargetCodeForMemcpy(SelectionDAG &DAG, DebugLoc dl,
 748                                     SDValue Chain,
 749                                     SDValue Dst, SDValue Src,
 750                                     SDValue Size, unsigned Align,
 751                                     bool isVolatile, bool AlwaysInline,
 752                                     const Value *DstSV, uint64_t DstSVOff,
 753                                     const Value *SrcSV, uint64_t SrcSVOff);
 754
 755     /// Utility function to emit string processing sse4.2 instructions
 756     /// that return in xmm0.
 757     /// This takes the instruction to expand, the associated machine basic
 758     /// block, the number of args, and whether or not the second arg is
 759     /// in memory or not.
 760     MachineBasicBlock *EmitPCMP(MachineInstr *BInstr, MachineBasicBlock *BB,
 761                                 unsigned argNum, bool inMem) const;
 762
 763     /// Utility function to emit atomic bitwise operations (and, or, xor).
 764     /// It takes the bitwise instruction to expand, the associated machine basic
 765     /// block, and the associated X86 opcodes for reg/reg and reg/imm.
 766     MachineBasicBlock *EmitAtomicBitwiseWithCustomInserter(
 767                                                     MachineInstr *BInstr,
 768                                                     MachineBasicBlock *BB,
 769                                                     unsigned regOpc,
 770                                                     unsigned immOpc,
 771                                                     unsigned loadOpc,
 772                                                     unsigned cxchgOpc,
 773                                                     unsigned copyOpc,
 774                                                     unsigned notOpc,
 775                                                     unsigned EAXreg,
 776                                                     TargetRegisterClass *RC,
 777                                                     bool invSrc = false) const;
 778
 779     MachineBasicBlock *EmitAtomicBit6432WithCustomInserter(
 780                                                     MachineInstr *BInstr,
 781                                                     MachineBasicBlock *BB,
 782                                                     unsigned regOpcL,
 783                                                     unsigned regOpcH,
 784                                                     unsigned immOpcL,
 785                                                     unsigned immOpcH,
 786                                                     bool invSrc = false) const;
 787
 788     /// Utility function to emit atomic min and max.  It takes the min/max
 789     /// instruction to expand, the associated basic block, and the associated
 790     /// cmov opcode for moving the min or max value.
 791     MachineBasicBlock *EmitAtomicMinMaxWithCustomInserter(MachineInstr *BInstr,
 792                                                           MachineBasicBlock *BB,
 793                                                         unsigned cmovOpc) const;
 794
 795     /// Utility function to emit the xmm reg save portion of va_start.
 796     MachineBasicBlock *EmitVAStartSaveXMMRegsWithCustomInserter(
 797                                                    MachineInstr *BInstr,
 798                                                    MachineBasicBlock *BB) const;
 799
 800     MachineBasicBlock *EmitLoweredSelect(MachineInstr *I,
 801                                          MachineBasicBlock *BB,
 802                     DenseMap<MachineBasicBlock*, MachineBasicBlock*> *EM) const;
 803
 804     MachineBasicBlock *EmitLoweredMingwAlloca(MachineInstr *MI,
 805                                               MachineBasicBlock *BB,
 806                     DenseMap<MachineBasicBlock*, MachineBasicBlock*> *EM) const;
 807
 808     /// Emit nodes that will be selected as "test Op0,Op0", or something
 809     /// equivalent, for use with the given x86 condition code.
 810     SDValue EmitTest(SDValue Op0, unsigned X86CC, SelectionDAG &DAG);
 811
 812     /// Emit nodes that will be selected as "cmp Op0,Op1", or something
 813     /// equivalent, for use with the given x86 condition code.
 814     SDValue EmitCmp(SDValue Op0, SDValue Op1, unsigned X86CC,
 815                     SelectionDAG &DAG);
 816   };
 817
 818   namespace X86 {
 819     FastISel *createFastISel(MachineFunction &mf,
 820                            DenseMap<const Value *, unsigned> &,
 821                            DenseMap<const BasicBlock *, MachineBasicBlock *> &,
 822                            DenseMap<const AllocaInst *, int> &
 823 #ifndef NDEBUG
 824                            , SmallSet<const Instruction*, 8> &
 825 #endif
 826                            );
 827   }
 828 }
 829
 830 #endif    // X86ISELLOWERING_H