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