Use XOP vpcom intrinsics in patterns instead of a target specific SDNode type. Remove...
[oota-llvm.git] / lib / Target / X86 / X86ISelLowering.h
1 //===-- X86ISelLowering.h - X86 DAG Lowering Interface ----------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines the interfaces that X86 uses to lower LLVM code into a
11 // selection DAG.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef X86ISELLOWERING_H
16 #define X86ISELLOWERING_H
17
18 #include "X86Subtarget.h"
19 #include "X86RegisterInfo.h"
20 #include "X86MachineFunctionInfo.h"
21 #include "llvm/Target/TargetLowering.h"
22 #include "llvm/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       /// CALL - These operations represent an abstract X86 call
61       /// instruction, which includes a bunch of information.  In particular the
62       /// operands of these node are:
63       ///
64       ///     #0 - The incoming token chain
65       ///     #1 - The callee
66       ///     #2 - The number of arg bytes the caller pushes on the stack.
67       ///     #3 - The number of arg bytes the callee pops off the stack.
68       ///     #4 - The value to pass in AL/AX/EAX (optional)
69       ///     #5 - The value to pass in DL/DX/EDX (optional)
70       ///
71       /// The result values of these nodes are:
72       ///
73       ///     #0 - The outgoing token chain
74       ///     #1 - The first register result value (optional)
75       ///     #2 - The second register result value (optional)
76       ///
77       CALL,
78
79       /// RDTSC_DAG - This operation implements the lowering for
80       /// readcyclecounter
81       RDTSC_DAG,
82
83       /// X86 compare and logical compare instructions.
84       CMP, COMI, UCOMI,
85
86       /// X86 bit-test instructions.
87       BT,
88
89       /// X86 SetCC. Operand 0 is condition code, and operand 1 is the EFLAGS
90       /// operand, usually produced by a CMP instruction.
91       SETCC,
92
93       // Same as SETCC except it's materialized with a sbb and the value is all
94       // one's or all zero's.
95       SETCC_CARRY,  // R = carry_bit ? ~0 : 0
96
97       /// X86 FP SETCC, implemented with CMP{cc}SS/CMP{cc}SD.
98       /// Operands are two FP values to compare; result is a mask of
99       /// 0s or 1s.  Generally DTRT for C/C++ with NaNs.
100       FSETCCss, FSETCCsd,
101
102       /// X86 MOVMSK{pd|ps}, extracts sign bits of two or four FP values,
103       /// result in an integer GPR.  Needs masking for scalar result.
104       FGETSIGNx86,
105
106       /// X86 conditional moves. Operand 0 and operand 1 are the two values
107       /// to select from. Operand 2 is the condition code, and operand 3 is the
108       /// flag operand produced by a CMP or TEST instruction. It also writes a
109       /// flag result.
110       CMOV,
111
112       /// X86 conditional branches. Operand 0 is the chain operand, operand 1
113       /// is the block to branch if condition is true, operand 2 is the
114       /// condition code, and operand 3 is the flag operand produced by a CMP
115       /// or TEST instruction.
116       BRCOND,
117
118       /// Return with a flag operand. Operand 0 is the chain operand, operand
119       /// 1 is the number of bytes of stack to pop.
120       RET_FLAG,
121
122       /// REP_STOS - Repeat fill, corresponds to X86::REP_STOSx.
123       REP_STOS,
124
125       /// REP_MOVS - Repeat move, corresponds to X86::REP_MOVSx.
126       REP_MOVS,
127
128       /// GlobalBaseReg - On Darwin, this node represents the result of the popl
129       /// at function entry, used for PIC code.
130       GlobalBaseReg,
131
132       /// Wrapper - A wrapper node for TargetConstantPool,
133       /// TargetExternalSymbol, and TargetGlobalAddress.
134       Wrapper,
135
136       /// WrapperRIP - Special wrapper used under X86-64 PIC mode for RIP
137       /// relative displacements.
138       WrapperRIP,
139
140       /// MOVQ2DQ - Copies a 64-bit value from an MMX vector to the low word
141       /// of an XMM vector, with the high word zero filled.
142       MOVQ2DQ,
143
144       /// MOVDQ2Q - Copies a 64-bit value from the low word of an XMM vector
145       /// to an MMX vector.  If you think this is too close to the previous
146       /// mnemonic, so do I; blame Intel.
147       MOVDQ2Q,
148
149       /// PEXTRB - Extract an 8-bit value from a vector and zero extend it to
150       /// i32, corresponds to X86::PEXTRB.
151       PEXTRB,
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       /// INSERTPS - Insert any element of a 4 x float vector into any element
158       /// of a destination 4 x floatvector.
159       INSERTPS,
160
161       /// PINSRB - Insert the lower 8-bits of a 32-bit value to a vector,
162       /// corresponds to X86::PINSRB.
163       PINSRB,
164
165       /// PINSRW - Insert the lower 16-bits of a 32-bit value to a vector,
166       /// corresponds to X86::PINSRW.
167       PINSRW, MMX_PINSRW,
168
169       /// PSHUFB - Shuffle 16 8-bit values within a vector.
170       PSHUFB,
171
172       /// ANDNP - Bitwise Logical AND NOT of Packed FP values.
173       ANDNP,
174
175       /// PSIGN - Copy integer sign.
176       PSIGN,
177
178       /// BLENDV - Blend where the selector is an XMM.
179       BLENDV,
180
181       /// BLENDxx - Blend where the selector is an immediate.
182       BLENDPW,
183       BLENDPS,
184       BLENDPD,
185
186       /// HADD - Integer horizontal add.
187       HADD,
188
189       /// HSUB - Integer horizontal sub.
190       HSUB,
191
192       /// FHADD - Floating point horizontal add.
193       FHADD,
194
195       /// FHSUB - Floating point horizontal sub.
196       FHSUB,
197
198       /// FMAX, FMIN - Floating point max and min.
199       ///
200       FMAX, FMIN,
201
202       /// FRSQRT, FRCP - Floating point reciprocal-sqrt and reciprocal
203       /// approximation.  Note that these typically require refinement
204       /// in order to obtain suitable precision.
205       FRSQRT, FRCP,
206
207       // TLSADDR - Thread Local Storage.
208       TLSADDR,
209
210       // TLSBASEADDR - Thread Local Storage. A call to get the start address
211       // of the TLS block for the current module.
212       TLSBASEADDR,
213
214       // TLSCALL - Thread Local Storage.  When calling to an OS provided
215       // thunk at the address from an earlier relocation.
216       TLSCALL,
217
218       // EH_RETURN - Exception Handling helpers.
219       EH_RETURN,
220
221       /// TC_RETURN - Tail call return.
222       ///   operand #0 chain
223       ///   operand #1 callee (register or absolute)
224       ///   operand #2 stack adjustment
225       ///   operand #3 optional in flag
226       TC_RETURN,
227
228       // VZEXT_MOVL - Vector move low and zero extend.
229       VZEXT_MOVL,
230
231       // VSEXT_MOVL - Vector move low and sign extend.
232       VSEXT_MOVL,
233
234       // VSHL, VSRL - 128-bit vector logical left / right shift
235       VSHLDQ, VSRLDQ,
236
237       // VSHL, VSRL, VSRA - Vector shift elements
238       VSHL, VSRL, VSRA,
239
240       // VSHLI, VSRLI, VSRAI - Vector shift elements by immediate
241       VSHLI, VSRLI, VSRAI,
242
243       // CMPP - Vector packed double/float comparison.
244       CMPP,
245
246       // PCMP* - Vector integer comparisons.
247       PCMPEQ, PCMPGT,
248
249       // ADD, SUB, SMUL, etc. - Arithmetic operations with FLAGS results.
250       ADD, SUB, ADC, SBB, SMUL,
251       INC, DEC, OR, XOR, AND,
252
253       ANDN, // ANDN - Bitwise AND NOT with FLAGS results.
254
255       BLSI,   // BLSI - Extract lowest set isolated bit
256       BLSMSK, // BLSMSK - Get mask up to lowest set bit
257       BLSR,   // BLSR - Reset lowest set bit
258
259       UMUL, // LOW, HI, FLAGS = umul LHS, RHS
260
261       // MUL_IMM - X86 specific multiply by immediate.
262       MUL_IMM,
263
264       // PTEST - Vector bitwise comparisons
265       PTEST,
266
267       // TESTP - Vector packed fp sign bitwise comparisons
268       TESTP,
269
270       // Several flavors of instructions with vector shuffle behaviors.
271       PALIGN,
272       PSHUFD,
273       PSHUFHW,
274       PSHUFLW,
275       SHUFP,
276       MOVDDUP,
277       MOVSHDUP,
278       MOVSLDUP,
279       MOVLHPS,
280       MOVLHPD,
281       MOVHLPS,
282       MOVLPS,
283       MOVLPD,
284       MOVSD,
285       MOVSS,
286       UNPCKL,
287       UNPCKH,
288       VPERMILP,
289       VPERMV,
290       VPERMI,
291       VPERM2X128,
292       VBROADCAST,
293
294       // PMULUDQ - Vector multiply packed unsigned doubleword integers
295       PMULUDQ,
296
297       // VASTART_SAVE_XMM_REGS - Save xmm argument registers to the stack,
298       // according to %al. An operator is needed so that this can be expanded
299       // with control flow.
300       VASTART_SAVE_XMM_REGS,
301
302       // WIN_ALLOCA - Windows's _chkstk call to do stack probing.
303       WIN_ALLOCA,
304
305       // SEG_ALLOCA - For allocating variable amounts of stack space when using
306       // segmented stacks. Check if the current stacklet has enough space, and
307       // falls back to heap allocation if not.
308       SEG_ALLOCA,
309
310       // WIN_FTOL - Windows's _ftol2 runtime routine to do fptoui.
311       WIN_FTOL,
312
313       // Memory barrier
314       MEMBARRIER,
315       MFENCE,
316       SFENCE,
317       LFENCE,
318
319       // FNSTSW16r - Store FP status word into i16 register.
320       FNSTSW16r,
321
322       // SAHF - Store contents of %ah into %eflags.
323       SAHF,
324
325       // ATOMADD64_DAG, ATOMSUB64_DAG, ATOMOR64_DAG, ATOMAND64_DAG,
326       // ATOMXOR64_DAG, ATOMNAND64_DAG, ATOMSWAP64_DAG -
327       // Atomic 64-bit binary operations.
328       ATOMADD64_DAG = ISD::FIRST_TARGET_MEMORY_OPCODE,
329       ATOMSUB64_DAG,
330       ATOMOR64_DAG,
331       ATOMXOR64_DAG,
332       ATOMAND64_DAG,
333       ATOMNAND64_DAG,
334       ATOMSWAP64_DAG,
335
336       // LCMPXCHG_DAG, LCMPXCHG8_DAG, LCMPXCHG16_DAG - Compare and swap.
337       LCMPXCHG_DAG,
338       LCMPXCHG8_DAG,
339       LCMPXCHG16_DAG,
340
341       // VZEXT_LOAD - Load, scalar_to_vector, and zero extend.
342       VZEXT_LOAD,
343
344       // FNSTCW16m - Store FP control world into i16 memory.
345       FNSTCW16m,
346
347       /// FP_TO_INT*_IN_MEM - This instruction implements FP_TO_SINT with the
348       /// integer destination in memory and a FP reg source.  This corresponds
349       /// to the X86::FIST*m instructions and the rounding mode change stuff. It
350       /// has two inputs (token chain and address) and two outputs (int value
351       /// and token chain).
352       FP_TO_INT16_IN_MEM,
353       FP_TO_INT32_IN_MEM,
354       FP_TO_INT64_IN_MEM,
355
356       /// FILD, FILD_FLAG - This instruction implements SINT_TO_FP with the
357       /// integer source in memory and FP reg result.  This corresponds to the
358       /// X86::FILD*m instructions. It has three inputs (token chain, address,
359       /// and source type) and two outputs (FP value and token chain). FILD_FLAG
360       /// also produces a flag).
361       FILD,
362       FILD_FLAG,
363
364       /// FLD - This instruction implements an extending load to FP stack slots.
365       /// This corresponds to the X86::FLD32m / X86::FLD64m. It takes a chain
366       /// operand, ptr to load from, and a ValueType node indicating the type
367       /// to load to.
368       FLD,
369
370       /// FST - This instruction implements a truncating store to FP stack
371       /// slots. This corresponds to the X86::FST32m / X86::FST64m. It takes a
372       /// chain operand, value to store, address, and a ValueType to store it
373       /// as.
374       FST,
375
376       /// VAARG_64 - This instruction grabs the address of the next argument
377       /// from a va_list. (reads and modifies the va_list in memory)
378       VAARG_64
379
380       // WARNING: Do not add anything in the end unless you want the node to
381       // have memop! In fact, starting from ATOMADD64_DAG all opcodes will be
382       // thought as target memory ops!
383     };
384   }
385
386   /// Define some predicates that are used for node matching.
387   namespace X86 {
388     /// isVEXTRACTF128Index - Return true if the specified
389     /// EXTRACT_SUBVECTOR operand specifies a vector extract that is
390     /// suitable for input to VEXTRACTF128.
391     bool isVEXTRACTF128Index(SDNode *N);
392
393     /// isVINSERTF128Index - Return true if the specified
394     /// INSERT_SUBVECTOR operand specifies a subvector insert that is
395     /// suitable for input to VINSERTF128.
396     bool isVINSERTF128Index(SDNode *N);
397
398     /// getExtractVEXTRACTF128Immediate - Return the appropriate
399     /// immediate to extract the specified EXTRACT_SUBVECTOR index
400     /// with VEXTRACTF128 instructions.
401     unsigned getExtractVEXTRACTF128Immediate(SDNode *N);
402
403     /// getInsertVINSERTF128Immediate - Return the appropriate
404     /// immediate to insert at the specified INSERT_SUBVECTOR index
405     /// with VINSERTF128 instructions.
406     unsigned getInsertVINSERTF128Immediate(SDNode *N);
407
408     /// isZeroNode - Returns true if Elt is a constant zero or a floating point
409     /// constant +0.0.
410     bool isZeroNode(SDValue Elt);
411
412     /// isOffsetSuitableForCodeModel - Returns true of the given offset can be
413     /// fit into displacement field of the instruction.
414     bool isOffsetSuitableForCodeModel(int64_t Offset, CodeModel::Model M,
415                                       bool hasSymbolicDisplacement = true);
416
417
418     /// isCalleePop - Determines whether the callee is required to pop its
419     /// own arguments. Callee pop is necessary to support tail calls.
420     bool isCalleePop(CallingConv::ID CallingConv,
421                      bool is64Bit, bool IsVarArg, bool TailCallOpt);
422   }
423
424   //===--------------------------------------------------------------------===//
425   //  X86TargetLowering - X86 Implementation of the TargetLowering interface
426   class X86TargetLowering : public TargetLowering {
427   public:
428     explicit X86TargetLowering(X86TargetMachine &TM);
429
430     virtual unsigned getJumpTableEncoding() const;
431
432     virtual MVT getShiftAmountTy(EVT LHSTy) const { return MVT::i8; }
433
434     virtual const MCExpr *
435     LowerCustomJumpTableEntry(const MachineJumpTableInfo *MJTI,
436                               const MachineBasicBlock *MBB, unsigned uid,
437                               MCContext &Ctx) const;
438
439     /// getPICJumpTableRelocaBase - Returns relocation base for the given PIC
440     /// jumptable.
441     virtual SDValue getPICJumpTableRelocBase(SDValue Table,
442                                              SelectionDAG &DAG) const;
443     virtual const MCExpr *
444     getPICJumpTableRelocBaseExpr(const MachineFunction *MF,
445                                  unsigned JTI, MCContext &Ctx) const;
446
447     /// getStackPtrReg - Return the stack pointer register we are using: either
448     /// ESP or RSP.
449     unsigned getStackPtrReg() const { return X86StackPtr; }
450
451     /// getByValTypeAlignment - Return the desired alignment for ByVal aggregate
452     /// function arguments in the caller parameter area. For X86, aggregates
453     /// that contains are placed at 16-byte boundaries while the rest are at
454     /// 4-byte boundaries.
455     virtual unsigned getByValTypeAlignment(Type *Ty) const;
456
457     /// getOptimalMemOpType - Returns the target specific optimal type for load
458     /// and store operations as a result of memset, memcpy, and memmove
459     /// lowering. If DstAlign is zero that means it's safe to destination
460     /// alignment can satisfy any constraint. Similarly if SrcAlign is zero it
461     /// means there isn't a need to check it against alignment requirement,
462     /// probably because the source does not need to be loaded. If
463     /// 'IsZeroVal' is true, that means it's safe to return a
464     /// non-scalar-integer type, e.g. empty string source, constant, or loaded
465     /// from memory. 'MemcpyStrSrc' indicates whether the memcpy source is
466     /// constant so it does not need to be loaded.
467     /// It returns EVT::Other if the type should be determined using generic
468     /// target-independent logic.
469     virtual EVT
470     getOptimalMemOpType(uint64_t Size, unsigned DstAlign, unsigned SrcAlign,
471                         bool IsZeroVal, bool MemcpyStrSrc,
472                         MachineFunction &MF) const;
473
474     /// allowsUnalignedMemoryAccesses - Returns true if the target allows
475     /// unaligned memory accesses. of the specified type.
476     virtual bool allowsUnalignedMemoryAccesses(EVT VT) const {
477       return true;
478     }
479
480     /// LowerOperation - Provide custom lowering hooks for some operations.
481     ///
482     virtual SDValue LowerOperation(SDValue Op, SelectionDAG &DAG) const;
483
484     /// ReplaceNodeResults - Replace the results of node with an illegal result
485     /// type with new values built out of custom code.
486     ///
487     virtual void ReplaceNodeResults(SDNode *N, SmallVectorImpl<SDValue>&Results,
488                                     SelectionDAG &DAG) const;
489
490
491     virtual SDValue PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const;
492
493     /// isTypeDesirableForOp - Return true if the target has native support for
494     /// the specified value type and it is 'desirable' to use the type for the
495     /// given node type. e.g. On x86 i16 is legal, but undesirable since i16
496     /// instruction encodings are longer and some i16 instructions are slow.
497     virtual bool isTypeDesirableForOp(unsigned Opc, EVT VT) const;
498
499     /// isTypeDesirable - Return true if the target has native support for the
500     /// specified value type and it is 'desirable' to use the type. e.g. On x86
501     /// i16 is legal, but undesirable since i16 instruction encodings are longer
502     /// and some i16 instructions are slow.
503     virtual bool IsDesirableToPromoteOp(SDValue Op, EVT &PVT) const;
504
505     virtual MachineBasicBlock *
506       EmitInstrWithCustomInserter(MachineInstr *MI,
507                                   MachineBasicBlock *MBB) const;
508
509
510     /// getTargetNodeName - This method returns the name of a target specific
511     /// DAG node.
512     virtual const char *getTargetNodeName(unsigned Opcode) const;
513
514     /// getSetCCResultType - Return the value type to use for ISD::SETCC.
515     virtual EVT getSetCCResultType(EVT VT) const;
516
517     /// computeMaskedBitsForTargetNode - Determine which of the bits specified
518     /// in Mask are known to be either zero or one and return them in the
519     /// KnownZero/KnownOne bitsets.
520     virtual void computeMaskedBitsForTargetNode(const SDValue Op,
521                                                 APInt &KnownZero,
522                                                 APInt &KnownOne,
523                                                 const SelectionDAG &DAG,
524                                                 unsigned Depth = 0) const;
525
526     // ComputeNumSignBitsForTargetNode - Determine the number of bits in the
527     // operation that are sign bits.
528     virtual unsigned ComputeNumSignBitsForTargetNode(SDValue Op,
529                                                      unsigned Depth) const;
530
531     virtual bool
532     isGAPlusOffset(SDNode *N, const GlobalValue* &GA, int64_t &Offset) const;
533
534     SDValue getReturnAddressFrameIndex(SelectionDAG &DAG) const;
535
536     virtual bool ExpandInlineAsm(CallInst *CI) const;
537
538     ConstraintType getConstraintType(const std::string &Constraint) const;
539
540     /// Examine constraint string and operand type and determine a weight value.
541     /// The operand object must already have been set up with the operand type.
542     virtual ConstraintWeight getSingleConstraintMatchWeight(
543       AsmOperandInfo &info, const char *constraint) const;
544
545     virtual const char *LowerXConstraint(EVT ConstraintVT) const;
546
547     /// LowerAsmOperandForConstraint - Lower the specified operand into the Ops
548     /// vector.  If it is invalid, don't add anything to Ops. If hasMemory is
549     /// true it means one of the asm constraint of the inline asm instruction
550     /// being processed is 'm'.
551     virtual void LowerAsmOperandForConstraint(SDValue Op,
552                                               std::string &Constraint,
553                                               std::vector<SDValue> &Ops,
554                                               SelectionDAG &DAG) const;
555
556     /// getRegForInlineAsmConstraint - Given a physical register constraint
557     /// (e.g. {edx}), return the register number and the register class for the
558     /// register.  This should only be used for C_Register constraints.  On
559     /// error, this returns a register number of 0.
560     std::pair<unsigned, const TargetRegisterClass*>
561       getRegForInlineAsmConstraint(const std::string &Constraint,
562                                    EVT VT) const;
563
564     /// isLegalAddressingMode - Return true if the addressing mode represented
565     /// by AM is legal for this target, for a load/store of the specified type.
566     virtual bool isLegalAddressingMode(const AddrMode &AM, Type *Ty)const;
567
568     /// isTruncateFree - Return true if it's free to truncate a value of
569     /// type Ty1 to type Ty2. e.g. On x86 it's free to truncate a i32 value in
570     /// register EAX to i16 by referencing its sub-register AX.
571     virtual bool isTruncateFree(Type *Ty1, Type *Ty2) const;
572     virtual bool isTruncateFree(EVT VT1, EVT VT2) const;
573
574     /// isZExtFree - Return true if any actual instruction that defines a
575     /// value of type Ty1 implicit zero-extends the value to Ty2 in the result
576     /// register. This does not necessarily include registers defined in
577     /// unknown ways, such as incoming arguments, or copies from unknown
578     /// virtual registers. Also, if isTruncateFree(Ty2, Ty1) is true, this
579     /// does not necessarily apply to truncate instructions. e.g. on x86-64,
580     /// all instructions that define 32-bit values implicit zero-extend the
581     /// result out to 64 bits.
582     virtual bool isZExtFree(Type *Ty1, Type *Ty2) const;
583     virtual bool isZExtFree(EVT VT1, EVT VT2) const;
584
585     /// isNarrowingProfitable - Return true if it's profitable to narrow
586     /// operations of type VT1 to VT2. e.g. on x86, it's profitable to narrow
587     /// from i32 to i8 but not from i32 to i16.
588     virtual bool isNarrowingProfitable(EVT VT1, EVT VT2) const;
589
590     /// isFPImmLegal - Returns true if the target can instruction select the
591     /// specified FP immediate natively. If false, the legalizer will
592     /// materialize the FP immediate as a load from a constant pool.
593     virtual bool isFPImmLegal(const APFloat &Imm, EVT VT) const;
594
595     /// isShuffleMaskLegal - Targets can use this to indicate that they only
596     /// support *some* VECTOR_SHUFFLE operations, those with specific masks.
597     /// By default, if a target supports the VECTOR_SHUFFLE node, all mask
598     /// values are assumed to be legal.
599     virtual bool isShuffleMaskLegal(const SmallVectorImpl<int> &Mask,
600                                     EVT VT) const;
601
602     /// isVectorClearMaskLegal - Similar to isShuffleMaskLegal. This is
603     /// used by Targets can use this to indicate if there is a suitable
604     /// VECTOR_SHUFFLE that can be used to replace a VAND with a constant
605     /// pool entry.
606     virtual bool isVectorClearMaskLegal(const SmallVectorImpl<int> &Mask,
607                                         EVT VT) const;
608
609     /// ShouldShrinkFPConstant - If true, then instruction selection should
610     /// seek to shrink the FP constant of the specified type to a smaller type
611     /// in order to save space and / or reduce runtime.
612     virtual bool ShouldShrinkFPConstant(EVT VT) const {
613       // Don't shrink FP constpool if SSE2 is available since cvtss2sd is more
614       // expensive than a straight movsd. On the other hand, it's important to
615       // shrink long double fp constant since fldt is very slow.
616       return !X86ScalarSSEf64 || VT == MVT::f80;
617     }
618
619     const X86Subtarget* getSubtarget() const {
620       return Subtarget;
621     }
622
623     /// isScalarFPTypeInSSEReg - Return true if the specified scalar FP type is
624     /// computed in an SSE register, not on the X87 floating point stack.
625     bool isScalarFPTypeInSSEReg(EVT VT) const {
626       return (VT == MVT::f64 && X86ScalarSSEf64) || // f64 is when SSE2
627       (VT == MVT::f32 && X86ScalarSSEf32);   // f32 is when SSE1
628     }
629
630     /// isTargetFTOL - Return true if the target uses the MSVC _ftol2 routine
631     /// for fptoui.
632     bool isTargetFTOL() const {
633       return Subtarget->isTargetWindows() && !Subtarget->is64Bit();
634     }
635
636     /// isIntegerTypeFTOL - Return true if the MSVC _ftol2 routine should be
637     /// used for fptoui to the given type.
638     bool isIntegerTypeFTOL(EVT VT) const {
639       return isTargetFTOL() && VT == MVT::i64;
640     }
641
642     /// createFastISel - This method returns a target specific FastISel object,
643     /// or null if the target does not support "fast" ISel.
644     virtual FastISel *createFastISel(FunctionLoweringInfo &funcInfo) const;
645
646     /// getStackCookieLocation - Return true if the target stores stack
647     /// protector cookies at a fixed offset in some non-standard address
648     /// space, and populates the address space and offset as
649     /// appropriate.
650     virtual bool getStackCookieLocation(unsigned &AddressSpace, unsigned &Offset) const;
651
652     SDValue BuildFILD(SDValue Op, EVT SrcVT, SDValue Chain, SDValue StackSlot,
653                       SelectionDAG &DAG) const;
654
655   protected:
656     std::pair<const TargetRegisterClass*, uint8_t>
657     findRepresentativeClass(EVT VT) const;
658
659   private:
660     /// Subtarget - Keep a pointer to the X86Subtarget around so that we can
661     /// make the right decision when generating code for different targets.
662     const X86Subtarget *Subtarget;
663     const X86RegisterInfo *RegInfo;
664     const TargetData *TD;
665
666     /// X86StackPtr - X86 physical register used as stack ptr.
667     unsigned X86StackPtr;
668
669     /// X86ScalarSSEf32, X86ScalarSSEf64 - Select between SSE or x87
670     /// floating point ops.
671     /// When SSE is available, use it for f32 operations.
672     /// When SSE2 is available, use it for f64 operations.
673     bool X86ScalarSSEf32;
674     bool X86ScalarSSEf64;
675
676     /// LegalFPImmediates - A list of legal fp immediates.
677     std::vector<APFloat> LegalFPImmediates;
678
679     /// addLegalFPImmediate - Indicate that this x86 target can instruction
680     /// select the specified FP immediate natively.
681     void addLegalFPImmediate(const APFloat& Imm) {
682       LegalFPImmediates.push_back(Imm);
683     }
684
685     SDValue LowerCallResult(SDValue Chain, SDValue InFlag,
686                             CallingConv::ID CallConv, bool isVarArg,
687                             const SmallVectorImpl<ISD::InputArg> &Ins,
688                             DebugLoc dl, SelectionDAG &DAG,
689                             SmallVectorImpl<SDValue> &InVals) const;
690     SDValue LowerMemArgument(SDValue Chain,
691                              CallingConv::ID CallConv,
692                              const SmallVectorImpl<ISD::InputArg> &ArgInfo,
693                              DebugLoc dl, SelectionDAG &DAG,
694                              const CCValAssign &VA,  MachineFrameInfo *MFI,
695                               unsigned i) const;
696     SDValue LowerMemOpCallTo(SDValue Chain, SDValue StackPtr, SDValue Arg,
697                              DebugLoc dl, SelectionDAG &DAG,
698                              const CCValAssign &VA,
699                              ISD::ArgFlagsTy Flags) const;
700
701     // Call lowering helpers.
702
703     /// IsEligibleForTailCallOptimization - Check whether the call is eligible
704     /// for tail call optimization. Targets which want to do tail call
705     /// optimization should implement this function.
706     bool IsEligibleForTailCallOptimization(SDValue Callee,
707                                            CallingConv::ID CalleeCC,
708                                            bool isVarArg,
709                                            bool isCalleeStructRet,
710                                            bool isCallerStructRet,
711                                     const SmallVectorImpl<ISD::OutputArg> &Outs,
712                                     const SmallVectorImpl<SDValue> &OutVals,
713                                     const SmallVectorImpl<ISD::InputArg> &Ins,
714                                            SelectionDAG& DAG) const;
715     bool IsCalleePop(bool isVarArg, CallingConv::ID CallConv) const;
716     SDValue EmitTailCallLoadRetAddr(SelectionDAG &DAG, SDValue &OutRetAddr,
717                                 SDValue Chain, bool IsTailCall, bool Is64Bit,
718                                 int FPDiff, DebugLoc dl) const;
719
720     unsigned GetAlignedArgumentStackSize(unsigned StackSize,
721                                          SelectionDAG &DAG) const;
722
723     std::pair<SDValue,SDValue> FP_TO_INTHelper(SDValue Op, SelectionDAG &DAG,
724                                                bool isSigned,
725                                                bool isReplace) const;
726
727     SDValue LowerAsSplatVectorLoad(SDValue SrcOp, EVT VT, DebugLoc dl,
728                                    SelectionDAG &DAG) const;
729     SDValue LowerBUILD_VECTOR(SDValue Op, SelectionDAG &DAG) const;
730     SDValue LowerCONCAT_VECTORS(SDValue Op, SelectionDAG &DAG) const;
731     SDValue LowerVECTOR_SHUFFLE(SDValue Op, SelectionDAG &DAG) const;
732     SDValue LowerEXTRACT_VECTOR_ELT(SDValue Op, SelectionDAG &DAG) const;
733     SDValue LowerEXTRACT_VECTOR_ELT_SSE4(SDValue Op, SelectionDAG &DAG) const;
734     SDValue LowerINSERT_VECTOR_ELT(SDValue Op, SelectionDAG &DAG) const;
735     SDValue LowerINSERT_VECTOR_ELT_SSE4(SDValue Op, SelectionDAG &DAG) const;
736     SDValue LowerSCALAR_TO_VECTOR(SDValue Op, SelectionDAG &DAG) const;
737     SDValue LowerEXTRACT_SUBVECTOR(SDValue Op, SelectionDAG &DAG) const;
738     SDValue LowerINSERT_SUBVECTOR(SDValue Op, SelectionDAG &DAG) const;
739     SDValue LowerConstantPool(SDValue Op, SelectionDAG &DAG) const;
740     SDValue LowerBlockAddress(SDValue Op, SelectionDAG &DAG) const;
741     SDValue LowerGlobalAddress(const GlobalValue *GV, DebugLoc dl,
742                                int64_t Offset, SelectionDAG &DAG) const;
743     SDValue LowerGlobalAddress(SDValue Op, SelectionDAG &DAG) const;
744     SDValue LowerGlobalTLSAddress(SDValue Op, SelectionDAG &DAG) const;
745     SDValue LowerExternalSymbol(SDValue Op, SelectionDAG &DAG) const;
746     SDValue LowerShiftParts(SDValue Op, SelectionDAG &DAG) const;
747     SDValue LowerBITCAST(SDValue op, SelectionDAG &DAG) const;
748     SDValue LowerSINT_TO_FP(SDValue Op, SelectionDAG &DAG) const;
749     SDValue LowerUINT_TO_FP(SDValue Op, SelectionDAG &DAG) const;
750     SDValue LowerUINT_TO_FP_i64(SDValue Op, SelectionDAG &DAG) const;
751     SDValue LowerUINT_TO_FP_i32(SDValue Op, SelectionDAG &DAG) const;
752     SDValue LowerFP_TO_SINT(SDValue Op, SelectionDAG &DAG) const;
753     SDValue LowerFP_TO_UINT(SDValue Op, SelectionDAG &DAG) const;
754     SDValue LowerFABS(SDValue Op, SelectionDAG &DAG) const;
755     SDValue LowerFNEG(SDValue Op, SelectionDAG &DAG) const;
756     SDValue LowerFCOPYSIGN(SDValue Op, SelectionDAG &DAG) const;
757     SDValue LowerFGETSIGN(SDValue Op, SelectionDAG &DAG) const;
758     SDValue LowerToBT(SDValue And, ISD::CondCode CC,
759                       DebugLoc dl, SelectionDAG &DAG) const;
760     SDValue LowerSETCC(SDValue Op, SelectionDAG &DAG) const;
761     SDValue LowerVSETCC(SDValue Op, SelectionDAG &DAG) const;
762     SDValue LowerSELECT(SDValue Op, SelectionDAG &DAG) const;
763     SDValue LowerBRCOND(SDValue Op, SelectionDAG &DAG) const;
764     SDValue LowerMEMSET(SDValue Op, SelectionDAG &DAG) const;
765     SDValue LowerJumpTable(SDValue Op, SelectionDAG &DAG) const;
766     SDValue LowerDYNAMIC_STACKALLOC(SDValue Op, SelectionDAG &DAG) const;
767     SDValue LowerVASTART(SDValue Op, SelectionDAG &DAG) const;
768     SDValue LowerVAARG(SDValue Op, SelectionDAG &DAG) const;
769     SDValue LowerVACOPY(SDValue Op, SelectionDAG &DAG) const;
770     SDValue LowerINTRINSIC_WO_CHAIN(SDValue Op, SelectionDAG &DAG) const;
771     SDValue LowerRETURNADDR(SDValue Op, SelectionDAG &DAG) const;
772     SDValue LowerFRAMEADDR(SDValue Op, SelectionDAG &DAG) const;
773     SDValue LowerFRAME_TO_ARGS_OFFSET(SDValue Op, SelectionDAG &DAG) const;
774     SDValue LowerEH_RETURN(SDValue Op, SelectionDAG &DAG) const;
775     SDValue LowerINIT_TRAMPOLINE(SDValue Op, SelectionDAG &DAG) const;
776     SDValue LowerADJUST_TRAMPOLINE(SDValue Op, SelectionDAG &DAG) const;
777     SDValue LowerFLT_ROUNDS_(SDValue Op, SelectionDAG &DAG) const;
778     SDValue LowerCTLZ(SDValue Op, SelectionDAG &DAG) const;
779     SDValue LowerCTLZ_ZERO_UNDEF(SDValue Op, SelectionDAG &DAG) const;
780     SDValue LowerCTTZ(SDValue Op, SelectionDAG &DAG) const;
781     SDValue LowerADD(SDValue Op, SelectionDAG &DAG) const;
782     SDValue LowerSUB(SDValue Op, SelectionDAG &DAG) const;
783     SDValue LowerMUL(SDValue Op, SelectionDAG &DAG) const;
784     SDValue LowerShift(SDValue Op, SelectionDAG &DAG) const;
785     SDValue LowerXALUO(SDValue Op, SelectionDAG &DAG) const;
786
787     SDValue LowerCMP_SWAP(SDValue Op, SelectionDAG &DAG) const;
788     SDValue LowerLOAD_SUB(SDValue Op, SelectionDAG &DAG) const;
789     SDValue LowerREADCYCLECOUNTER(SDValue Op, SelectionDAG &DAG) const;
790     SDValue LowerMEMBARRIER(SDValue Op, SelectionDAG &DAG) const;
791     SDValue LowerATOMIC_FENCE(SDValue Op, SelectionDAG &DAG) const;
792     SDValue LowerSIGN_EXTEND_INREG(SDValue Op, SelectionDAG &DAG) const;
793     SDValue PerformTruncateCombine(SDNode* N, SelectionDAG &DAG, DAGCombinerInfo &DCI) const;
794
795     // Utility functions to help LowerVECTOR_SHUFFLE
796     SDValue LowerVECTOR_SHUFFLEv8i16(SDValue Op, SelectionDAG &DAG) const;
797     SDValue LowerVectorBroadcast(SDValue &Op, SelectionDAG &DAG) const;
798     SDValue NormalizeVectorShuffle(SDValue Op, SelectionDAG &DAG) const;
799
800     virtual SDValue
801       LowerFormalArguments(SDValue Chain,
802                            CallingConv::ID CallConv, bool isVarArg,
803                            const SmallVectorImpl<ISD::InputArg> &Ins,
804                            DebugLoc dl, SelectionDAG &DAG,
805                            SmallVectorImpl<SDValue> &InVals) const;
806     virtual SDValue
807       LowerCall(CallLoweringInfo &CLI,
808                 SmallVectorImpl<SDValue> &InVals) const;
809
810     virtual SDValue
811       LowerReturn(SDValue Chain,
812                   CallingConv::ID CallConv, bool isVarArg,
813                   const SmallVectorImpl<ISD::OutputArg> &Outs,
814                   const SmallVectorImpl<SDValue> &OutVals,
815                   DebugLoc dl, SelectionDAG &DAG) const;
816
817     virtual bool isUsedByReturnOnly(SDNode *N, SDValue &Chain) const;
818
819     virtual bool mayBeEmittedAsTailCall(CallInst *CI) const;
820
821     virtual EVT
822     getTypeForExtArgOrReturn(LLVMContext &Context, EVT VT,
823                              ISD::NodeType ExtendKind) const;
824
825     virtual bool
826     CanLowerReturn(CallingConv::ID CallConv, MachineFunction &MF,
827                    bool isVarArg,
828                    const SmallVectorImpl<ISD::OutputArg> &Outs,
829                    LLVMContext &Context) const;
830
831     void ReplaceATOMIC_BINARY_64(SDNode *N, SmallVectorImpl<SDValue> &Results,
832                                  SelectionDAG &DAG, unsigned NewOp) const;
833
834     /// Utility function to emit string processing sse4.2 instructions
835     /// that return in xmm0.
836     /// This takes the instruction to expand, the associated machine basic
837     /// block, the number of args, and whether or not the second arg is
838     /// in memory or not.
839     MachineBasicBlock *EmitPCMP(MachineInstr *BInstr, MachineBasicBlock *BB,
840                                 unsigned argNum, bool inMem) const;
841
842     /// Utility functions to emit monitor and mwait instructions. These
843     /// need to make sure that the arguments to the intrinsic are in the
844     /// correct registers.
845     MachineBasicBlock *EmitMonitor(MachineInstr *MI,
846                                    MachineBasicBlock *BB) const;
847     MachineBasicBlock *EmitMwait(MachineInstr *MI, MachineBasicBlock *BB) const;
848
849     /// Utility function to emit atomic bitwise operations (and, or, xor).
850     /// It takes the bitwise instruction to expand, the associated machine basic
851     /// block, and the associated X86 opcodes for reg/reg and reg/imm.
852     MachineBasicBlock *EmitAtomicBitwiseWithCustomInserter(
853                                                     MachineInstr *BInstr,
854                                                     MachineBasicBlock *BB,
855                                                     unsigned regOpc,
856                                                     unsigned immOpc,
857                                                     unsigned loadOpc,
858                                                     unsigned cxchgOpc,
859                                                     unsigned notOpc,
860                                                     unsigned EAXreg,
861                                               const TargetRegisterClass *RC,
862                                                     bool Invert = false) const;
863
864     MachineBasicBlock *EmitAtomicBit6432WithCustomInserter(
865                                                     MachineInstr *BInstr,
866                                                     MachineBasicBlock *BB,
867                                                     unsigned regOpcL,
868                                                     unsigned regOpcH,
869                                                     unsigned immOpcL,
870                                                     unsigned immOpcH,
871                                                     bool Invert = false) const;
872
873     /// Utility function to emit atomic min and max.  It takes the min/max
874     /// instruction to expand, the associated basic block, and the associated
875     /// cmov opcode for moving the min or max value.
876     MachineBasicBlock *EmitAtomicMinMaxWithCustomInserter(MachineInstr *BInstr,
877                                                           MachineBasicBlock *BB,
878                                                         unsigned cmovOpc) const;
879
880     // Utility function to emit the low-level va_arg code for X86-64.
881     MachineBasicBlock *EmitVAARG64WithCustomInserter(
882                        MachineInstr *MI,
883                        MachineBasicBlock *MBB) const;
884
885     /// Utility function to emit the xmm reg save portion of va_start.
886     MachineBasicBlock *EmitVAStartSaveXMMRegsWithCustomInserter(
887                                                    MachineInstr *BInstr,
888                                                    MachineBasicBlock *BB) const;
889
890     MachineBasicBlock *EmitLoweredSelect(MachineInstr *I,
891                                          MachineBasicBlock *BB) const;
892
893     MachineBasicBlock *EmitLoweredWinAlloca(MachineInstr *MI,
894                                               MachineBasicBlock *BB) const;
895
896     MachineBasicBlock *EmitLoweredSegAlloca(MachineInstr *MI,
897                                             MachineBasicBlock *BB,
898                                             bool Is64Bit) const;
899
900     MachineBasicBlock *EmitLoweredTLSCall(MachineInstr *MI,
901                                           MachineBasicBlock *BB) const;
902
903     MachineBasicBlock *emitLoweredTLSAddr(MachineInstr *MI,
904                                           MachineBasicBlock *BB) const;
905
906     /// Emit nodes that will be selected as "test Op0,Op0", or something
907     /// equivalent, for use with the given x86 condition code.
908     SDValue EmitTest(SDValue Op0, unsigned X86CC, SelectionDAG &DAG) const;
909
910     /// Emit nodes that will be selected as "cmp Op0,Op1", or something
911     /// equivalent, for use with the given x86 condition code.
912     SDValue EmitCmp(SDValue Op0, SDValue Op1, unsigned X86CC,
913                     SelectionDAG &DAG) const;
914
915     /// Convert a comparison if required by the subtarget.
916     SDValue ConvertCmpIfNecessary(SDValue Cmp, SelectionDAG &DAG) const;
917   };
918
919   namespace X86 {
920     FastISel *createFastISel(FunctionLoweringInfo &funcInfo);
921   }
922 }
923
924 #endif    // X86ISELLOWERING_H