[X86][AVX512] Multiply Packed Unsigned Integers with Round and Scale
[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 LLVM_LIB_TARGET_X86_X86ISELLOWERING_H
16 #define LLVM_LIB_TARGET_X86_X86ISELLOWERING_H
17
18 #include "llvm/CodeGen/CallingConvLower.h"
19 #include "llvm/CodeGen/SelectionDAG.h"
20 #include "llvm/Target/TargetLowering.h"
21 #include "llvm/Target/TargetOptions.h"
22
23 namespace llvm {
24   class X86Subtarget;
25   class X86TargetMachine;
26
27   namespace X86ISD {
28     // X86 Specific DAG Nodes
29     enum NodeType : unsigned {
30       // Start the numbering where the builtin ops leave off.
31       FIRST_NUMBER = ISD::BUILTIN_OP_END,
32
33       /// Bit scan forward.
34       BSF,
35       /// Bit scan reverse.
36       BSR,
37
38       /// Double shift instructions. These correspond to
39       /// X86::SHLDxx and X86::SHRDxx instructions.
40       SHLD,
41       SHRD,
42
43       /// Bitwise logical AND of floating point values. This corresponds
44       /// to X86::ANDPS or X86::ANDPD.
45       FAND,
46
47       /// Bitwise logical OR of floating point values. This corresponds
48       /// to X86::ORPS or X86::ORPD.
49       FOR,
50
51       /// Bitwise logical XOR of floating point values. This corresponds
52       /// to X86::XORPS or X86::XORPD.
53       FXOR,
54
55       ///  Bitwise logical ANDNOT of floating point values. This
56       /// corresponds to X86::ANDNPS or X86::ANDNPD.
57       FANDN,
58
59       /// These operations represent an abstract X86 call
60       /// instruction, which includes a bunch of information.  In particular the
61       /// operands of these node are:
62       ///
63       ///     #0 - The incoming token chain
64       ///     #1 - The callee
65       ///     #2 - The number of arg bytes the caller pushes on the stack.
66       ///     #3 - The number of arg bytes the callee pops off the stack.
67       ///     #4 - The value to pass in AL/AX/EAX (optional)
68       ///     #5 - The value to pass in DL/DX/EDX (optional)
69       ///
70       /// The result values of these nodes are:
71       ///
72       ///     #0 - The outgoing token chain
73       ///     #1 - The first register result value (optional)
74       ///     #2 - The second register result value (optional)
75       ///
76       CALL,
77
78       /// This operation implements the lowering for readcyclecounter
79       RDTSC_DAG,
80
81       /// X86 Read Time-Stamp Counter and Processor ID.
82       RDTSCP_DAG,
83
84       /// X86 Read Performance Monitoring Counters.
85       RDPMC_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       /// X86 Select
98       SELECT,
99
100       // Same as SETCC except it's materialized with a sbb and the value is all
101       // one's or all zero's.
102       SETCC_CARRY,  // R = carry_bit ? ~0 : 0
103
104       /// X86 FP SETCC, implemented with CMP{cc}SS/CMP{cc}SD.
105       /// Operands are two FP values to compare; result is a mask of
106       /// 0s or 1s.  Generally DTRT for C/C++ with NaNs.
107       FSETCC,
108
109       /// X86 MOVMSK{pd|ps}, extracts sign bits of two or four FP values,
110       /// result in an integer GPR.  Needs masking for scalar result.
111       FGETSIGNx86,
112
113       /// X86 conditional moves. Operand 0 and operand 1 are the two values
114       /// to select from. Operand 2 is the condition code, and operand 3 is the
115       /// flag operand produced by a CMP or TEST instruction. It also writes a
116       /// flag result.
117       CMOV,
118
119       /// X86 conditional branches. Operand 0 is the chain operand, operand 1
120       /// is the block to branch if condition is true, operand 2 is the
121       /// condition code, and operand 3 is the flag operand produced by a CMP
122       /// or TEST instruction.
123       BRCOND,
124
125       /// Return with a flag operand. Operand 0 is the chain operand, operand
126       /// 1 is the number of bytes of stack to pop.
127       RET_FLAG,
128
129       /// Repeat fill, corresponds to X86::REP_STOSx.
130       REP_STOS,
131
132       /// Repeat move, corresponds to X86::REP_MOVSx.
133       REP_MOVS,
134
135       /// On Darwin, this node represents the result of the popl
136       /// at function entry, used for PIC code.
137       GlobalBaseReg,
138
139       /// A wrapper node for TargetConstantPool,
140       /// TargetExternalSymbol, and TargetGlobalAddress.
141       Wrapper,
142
143       /// Special wrapper used under X86-64 PIC mode for RIP
144       /// relative displacements.
145       WrapperRIP,
146
147       /// Copies a 64-bit value from the low word of an XMM vector
148       /// to an MMX vector.  If you think this is too close to the previous
149       /// mnemonic, so do I; blame Intel.
150       MOVDQ2Q,
151
152       /// Copies a 32-bit value from the low word of a MMX
153       /// vector to a GPR.
154       MMX_MOVD2W,
155
156       /// Copies a GPR into the low 32-bit word of a MMX vector
157       /// and zero out the high word.
158       MMX_MOVW2D,
159
160       /// Extract an 8-bit value from a vector and zero extend it to
161       /// i32, corresponds to X86::PEXTRB.
162       PEXTRB,
163
164       /// Extract a 16-bit value from a vector and zero extend it to
165       /// i32, corresponds to X86::PEXTRW.
166       PEXTRW,
167
168       /// Insert any element of a 4 x float vector into any element
169       /// of a destination 4 x floatvector.
170       INSERTPS,
171
172       /// Insert the lower 8-bits of a 32-bit value to a vector,
173       /// corresponds to X86::PINSRB.
174       PINSRB,
175
176       /// Insert the lower 16-bits of a 32-bit value to a vector,
177       /// corresponds to X86::PINSRW.
178       PINSRW, MMX_PINSRW,
179
180       /// Shuffle 16 8-bit values within a vector.
181       PSHUFB,
182
183       /// Compute Sum of Absolute Differences.
184       PSADBW,
185
186       /// Bitwise Logical AND NOT of Packed FP values.
187       ANDNP,
188
189       /// Copy integer sign.
190       PSIGN,
191
192       /// Blend where the selector is an immediate.
193       BLENDI,
194
195       /// Blend where the condition has been shrunk.
196       /// This is used to emphasize that the condition mask is
197       /// no more valid for generic VSELECT optimizations.
198       SHRUNKBLEND,
199
200       /// Combined add and sub on an FP vector.
201       ADDSUB,
202
203       //  FP vector ops with rounding mode.
204       FADD_RND,
205       FSUB_RND,
206       FMUL_RND,
207       FDIV_RND,
208       FMAX_RND,
209       FMIN_RND,
210       FSQRT_RND,
211
212       // FP vector get exponent 
213       FGETEXP_RND,
214       // FP Scale
215       SCALEF,
216       // Integer add/sub with unsigned saturation.
217       ADDUS,
218       SUBUS,
219       // Integer add/sub with signed saturation.
220       ADDS,
221       SUBS,
222       // Unsigned Integer average 
223       AVG,
224       /// Integer horizontal add.
225       HADD,
226
227       /// Integer horizontal sub.
228       HSUB,
229
230       /// Floating point horizontal add.
231       FHADD,
232
233       /// Floating point horizontal sub.
234       FHSUB,
235
236       /// Unsigned integer max and min.
237       UMAX, UMIN,
238
239       /// Signed integer max and min.
240       SMAX, SMIN,
241
242       // Integer absolute value
243       ABS,
244
245       /// Floating point max and min.
246       FMAX, FMIN,
247
248       /// Commutative FMIN and FMAX.
249       FMAXC, FMINC,
250
251       /// Floating point reciprocal-sqrt and reciprocal approximation.
252       /// Note that these typically require refinement
253       /// in order to obtain suitable precision.
254       FRSQRT, FRCP,
255
256       // Thread Local Storage.
257       TLSADDR,
258
259       // Thread Local Storage. A call to get the start address
260       // of the TLS block for the current module.
261       TLSBASEADDR,
262
263       // Thread Local Storage.  When calling to an OS provided
264       // thunk at the address from an earlier relocation.
265       TLSCALL,
266
267       // Exception Handling helpers.
268       EH_RETURN,
269
270       // SjLj exception handling setjmp.
271       EH_SJLJ_SETJMP,
272
273       // SjLj exception handling longjmp.
274       EH_SJLJ_LONGJMP,
275
276       /// Tail call return. See X86TargetLowering::LowerCall for
277       /// the list of operands.
278       TC_RETURN,
279
280       // Vector move to low scalar and zero higher vector elements.
281       VZEXT_MOVL,
282
283       // Vector integer zero-extend.
284       VZEXT,
285
286       // Vector integer signed-extend.
287       VSEXT,
288
289       // Vector integer truncate.
290       VTRUNC,
291
292       // Vector integer truncate with mask.
293       VTRUNCM,
294
295       // Vector FP extend.
296       VFPEXT,
297
298       // Vector FP round.
299       VFPROUND,
300
301       // Vector signed integer to double.
302       CVTDQ2PD,
303
304       // 128-bit vector logical left / right shift
305       VSHLDQ, VSRLDQ,
306
307       // Vector shift elements
308       VSHL, VSRL, VSRA,
309
310       // Vector shift elements by immediate
311       VSHLI, VSRLI, VSRAI,
312
313       // Vector packed double/float comparison.
314       CMPP,
315
316       // Vector integer comparisons.
317       PCMPEQ, PCMPGT,
318       // Vector integer comparisons, the result is in a mask vector.
319       PCMPEQM, PCMPGTM,
320
321       /// Vector comparison generating mask bits for fp and
322       /// integer signed and unsigned data types.
323       CMPM,
324       CMPMU,
325       // Vector comparison with rounding mode for FP values
326       CMPM_RND,
327
328       // Arithmetic operations with FLAGS results.
329       ADD, SUB, ADC, SBB, SMUL,
330       INC, DEC, OR, XOR, AND,
331
332       BEXTR,  // Bit field extract
333
334       UMUL, // LOW, HI, FLAGS = umul LHS, RHS
335
336       // 8-bit SMUL/UMUL - AX, FLAGS = smul8/umul8 AL, RHS
337       SMUL8, UMUL8,
338
339       // 8-bit divrem that zero-extend the high result (AH).
340       UDIVREM8_ZEXT_HREG,
341       SDIVREM8_SEXT_HREG,
342
343       // X86-specific multiply by immediate.
344       MUL_IMM,
345
346       // Vector bitwise comparisons.
347       PTEST,
348
349       // Vector packed fp sign bitwise comparisons.
350       TESTP,
351
352       // Vector "test" in AVX-512, the result is in a mask vector.
353       TESTM,
354       TESTNM,
355
356       // OR/AND test for masks
357       KORTEST,
358
359       // Several flavors of instructions with vector shuffle behaviors.
360       PACKSS,
361       PACKUS,
362       // Intra-lane alignr
363       PALIGNR,
364       // AVX512 inter-lane alignr
365       VALIGN,
366       PSHUFD,
367       PSHUFHW,
368       PSHUFLW,
369       SHUFP,
370       //Shuffle Packed Values at 128-bit granularity
371       SHUF128,
372       MOVDDUP,
373       MOVSHDUP,
374       MOVSLDUP,
375       MOVLHPS,
376       MOVLHPD,
377       MOVHLPS,
378       MOVLPS,
379       MOVLPD,
380       MOVSD,
381       MOVSS,
382       UNPCKL,
383       UNPCKH,
384       VPERMILPV,
385       VPERMILPI,
386       VPERMV,
387       VPERMV3,
388       VPERMIV3,
389       VPERMI,
390       VPERM2X128,
391       //Fix Up Special Packed Float32/64 values
392       VFIXUPIMM,
393       //Range Restriction Calculation For Packed Pairs of Float32/64 values
394       VRANGE,
395       // Broadcast scalar to vector
396       VBROADCAST,
397       // Broadcast subvector to vector
398       SUBV_BROADCAST,
399       // Insert/Extract vector element
400       VINSERT,
401       VEXTRACT,
402
403       // Vector multiply packed unsigned doubleword integers
404       PMULUDQ,
405       // Vector multiply packed signed doubleword integers
406       PMULDQ,
407       // Vector Multiply Packed UnsignedIntegers with Round and Scale
408       MULHRS,
409
410       // FMA nodes
411       FMADD,
412       FNMADD,
413       FMSUB,
414       FNMSUB,
415       FMADDSUB,
416       FMSUBADD,
417       // FMA with rounding mode
418       FMADD_RND,
419       FNMADD_RND,
420       FMSUB_RND,
421       FNMSUB_RND,
422       FMADDSUB_RND,
423       FMSUBADD_RND,
424       RNDSCALE,
425
426       // Compress and expand
427       COMPRESS,
428       EXPAND,
429
430       //Convert Unsigned/Integer to Scalar Floating-Point Value
431       //with rounding mode
432       SINT_TO_FP_RND,
433       UINT_TO_FP_RND,
434       // Save xmm argument registers to the stack, according to %al. An operator
435       // is needed so that this can be expanded with control flow.
436       VASTART_SAVE_XMM_REGS,
437
438       // Windows's _chkstk call to do stack probing.
439       WIN_ALLOCA,
440
441       // For allocating variable amounts of stack space when using
442       // segmented stacks. Check if the current stacklet has enough space, and
443       // falls back to heap allocation if not.
444       SEG_ALLOCA,
445
446       // Windows's _ftol2 runtime routine to do fptoui.
447       WIN_FTOL,
448
449       // Memory barrier
450       MEMBARRIER,
451       MFENCE,
452       SFENCE,
453       LFENCE,
454
455       // Store FP status word into i16 register.
456       FNSTSW16r,
457
458       // Store contents of %ah into %eflags.
459       SAHF,
460
461       // Get a random integer and indicate whether it is valid in CF.
462       RDRAND,
463
464       // Get a NIST SP800-90B & C compliant random integer and
465       // indicate whether it is valid in CF.
466       RDSEED,
467
468       PCMPISTRI,
469       PCMPESTRI,
470
471       // Test if in transactional execution.
472       XTEST,
473
474       // ERI instructions
475       RSQRT28, RCP28, EXP2,
476
477       // Compare and swap.
478       LCMPXCHG_DAG = ISD::FIRST_TARGET_MEMORY_OPCODE,
479       LCMPXCHG8_DAG,
480       LCMPXCHG16_DAG,
481
482       // Load, scalar_to_vector, and zero extend.
483       VZEXT_LOAD,
484
485       // Store FP control world into i16 memory.
486       FNSTCW16m,
487
488       /// This instruction implements FP_TO_SINT with the
489       /// integer destination in memory and a FP reg source.  This corresponds
490       /// to the X86::FIST*m instructions and the rounding mode change stuff. It
491       /// has two inputs (token chain and address) and two outputs (int value
492       /// and token chain).
493       FP_TO_INT16_IN_MEM,
494       FP_TO_INT32_IN_MEM,
495       FP_TO_INT64_IN_MEM,
496
497       /// This instruction implements SINT_TO_FP with the
498       /// integer source in memory and FP reg result.  This corresponds to the
499       /// X86::FILD*m instructions. It has three inputs (token chain, address,
500       /// and source type) and two outputs (FP value and token chain). FILD_FLAG
501       /// also produces a flag).
502       FILD,
503       FILD_FLAG,
504
505       /// This instruction implements an extending load to FP stack slots.
506       /// This corresponds to the X86::FLD32m / X86::FLD64m. It takes a chain
507       /// operand, ptr to load from, and a ValueType node indicating the type
508       /// to load to.
509       FLD,
510
511       /// This instruction implements a truncating store to FP stack
512       /// slots. This corresponds to the X86::FST32m / X86::FST64m. It takes a
513       /// chain operand, value to store, address, and a ValueType to store it
514       /// as.
515       FST,
516
517       /// This instruction grabs the address of the next argument
518       /// from a va_list. (reads and modifies the va_list in memory)
519       VAARG_64
520
521       // WARNING: Do not add anything in the end unless you want the node to
522       // have memop! In fact, starting from ATOMADD64_DAG all opcodes will be
523       // thought as target memory ops!
524     };
525   }
526
527   /// Define some predicates that are used for node matching.
528   namespace X86 {
529     /// Return true if the specified
530     /// EXTRACT_SUBVECTOR operand specifies a vector extract that is
531     /// suitable for input to VEXTRACTF128, VEXTRACTI128 instructions.
532     bool isVEXTRACT128Index(SDNode *N);
533
534     /// Return true if the specified
535     /// INSERT_SUBVECTOR operand specifies a subvector insert that is
536     /// suitable for input to VINSERTF128, VINSERTI128 instructions.
537     bool isVINSERT128Index(SDNode *N);
538
539     /// Return true if the specified
540     /// EXTRACT_SUBVECTOR operand specifies a vector extract that is
541     /// suitable for input to VEXTRACTF64X4, VEXTRACTI64X4 instructions.
542     bool isVEXTRACT256Index(SDNode *N);
543
544     /// Return true if the specified
545     /// INSERT_SUBVECTOR operand specifies a subvector insert that is
546     /// suitable for input to VINSERTF64X4, VINSERTI64X4 instructions.
547     bool isVINSERT256Index(SDNode *N);
548
549     /// Return the appropriate
550     /// immediate to extract the specified EXTRACT_SUBVECTOR index
551     /// with VEXTRACTF128, VEXTRACTI128 instructions.
552     unsigned getExtractVEXTRACT128Immediate(SDNode *N);
553
554     /// Return the appropriate
555     /// immediate to insert at the specified INSERT_SUBVECTOR index
556     /// with VINSERTF128, VINSERT128 instructions.
557     unsigned getInsertVINSERT128Immediate(SDNode *N);
558
559     /// Return the appropriate
560     /// immediate to extract the specified EXTRACT_SUBVECTOR index
561     /// with VEXTRACTF64X4, VEXTRACTI64x4 instructions.
562     unsigned getExtractVEXTRACT256Immediate(SDNode *N);
563
564     /// Return the appropriate
565     /// immediate to insert at the specified INSERT_SUBVECTOR index
566     /// with VINSERTF64x4, VINSERTI64x4 instructions.
567     unsigned getInsertVINSERT256Immediate(SDNode *N);
568
569     /// Returns true if Elt is a constant zero or floating point constant +0.0.
570     bool isZeroNode(SDValue Elt);
571
572     /// Returns true of the given offset can be
573     /// fit into displacement field of the instruction.
574     bool isOffsetSuitableForCodeModel(int64_t Offset, CodeModel::Model M,
575                                       bool hasSymbolicDisplacement = true);
576
577
578     /// Determines whether the callee is required to pop its
579     /// own arguments. Callee pop is necessary to support tail calls.
580     bool isCalleePop(CallingConv::ID CallingConv,
581                      bool is64Bit, bool IsVarArg, bool TailCallOpt);
582
583     /// AVX512 static rounding constants.  These need to match the values in
584     /// avx512fintrin.h.
585     enum STATIC_ROUNDING {
586       TO_NEAREST_INT = 0,
587       TO_NEG_INF = 1,
588       TO_POS_INF = 2,
589       TO_ZERO = 3,
590       CUR_DIRECTION = 4
591     };
592   }
593
594   //===--------------------------------------------------------------------===//
595   //  X86 Implementation of the TargetLowering interface
596   class X86TargetLowering final : public TargetLowering {
597   public:
598     explicit X86TargetLowering(const X86TargetMachine &TM,
599                                const X86Subtarget &STI);
600
601     unsigned getJumpTableEncoding() const override;
602     bool useSoftFloat() const override;
603
604     MVT getScalarShiftAmountTy(EVT LHSTy) const override { return MVT::i8; }
605
606     const MCExpr *
607     LowerCustomJumpTableEntry(const MachineJumpTableInfo *MJTI,
608                               const MachineBasicBlock *MBB, unsigned uid,
609                               MCContext &Ctx) const override;
610
611     /// Returns relocation base for the given PIC jumptable.
612     SDValue getPICJumpTableRelocBase(SDValue Table,
613                                      SelectionDAG &DAG) const override;
614     const MCExpr *
615     getPICJumpTableRelocBaseExpr(const MachineFunction *MF,
616                                  unsigned JTI, MCContext &Ctx) const override;
617
618     /// Return the desired alignment for ByVal aggregate
619     /// function arguments in the caller parameter area. For X86, aggregates
620     /// that contains are placed at 16-byte boundaries while the rest are at
621     /// 4-byte boundaries.
622     unsigned getByValTypeAlignment(Type *Ty) const override;
623
624     /// Returns the target specific optimal type for load
625     /// and store operations as a result of memset, memcpy, and memmove
626     /// lowering. If DstAlign is zero that means it's safe to destination
627     /// alignment can satisfy any constraint. Similarly if SrcAlign is zero it
628     /// means there isn't a need to check it against alignment requirement,
629     /// probably because the source does not need to be loaded. If 'IsMemset' is
630     /// true, that means it's expanding a memset. If 'ZeroMemset' is true, that
631     /// means it's a memset of zero. 'MemcpyStrSrc' indicates whether the memcpy
632     /// source is constant so it does not need to be loaded.
633     /// It returns EVT::Other if the type should be determined using generic
634     /// target-independent logic.
635     EVT getOptimalMemOpType(uint64_t Size, unsigned DstAlign, unsigned SrcAlign,
636                             bool IsMemset, bool ZeroMemset, bool MemcpyStrSrc,
637                             MachineFunction &MF) const override;
638
639     /// Returns true if it's safe to use load / store of the
640     /// specified type to expand memcpy / memset inline. This is mostly true
641     /// for all types except for some special cases. For example, on X86
642     /// targets without SSE2 f64 load / store are done with fldl / fstpl which
643     /// also does type conversion. Note the specified type doesn't have to be
644     /// legal as the hook is used before type legalization.
645     bool isSafeMemOpType(MVT VT) const override;
646
647     /// Returns true if the target allows unaligned memory accesses of the
648     /// specified type. Returns whether it is "fast" in the last argument.
649     bool allowsMisalignedMemoryAccesses(EVT VT, unsigned AS, unsigned Align,
650                                        bool *Fast) const override;
651
652     /// Provide custom lowering hooks for some operations.
653     ///
654     SDValue LowerOperation(SDValue Op, SelectionDAG &DAG) const override;
655
656     /// Replace the results of node with an illegal result
657     /// type with new values built out of custom code.
658     ///
659     void ReplaceNodeResults(SDNode *N, SmallVectorImpl<SDValue>&Results,
660                             SelectionDAG &DAG) const override;
661
662
663     SDValue PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const override;
664
665     /// Return true if the target has native support for
666     /// the specified value type and it is 'desirable' to use the type for the
667     /// given node type. e.g. On x86 i16 is legal, but undesirable since i16
668     /// instruction encodings are longer and some i16 instructions are slow.
669     bool isTypeDesirableForOp(unsigned Opc, EVT VT) const override;
670
671     /// Return true if the target has native support for the
672     /// specified value type and it is 'desirable' to use the type. e.g. On x86
673     /// i16 is legal, but undesirable since i16 instruction encodings are longer
674     /// and some i16 instructions are slow.
675     bool IsDesirableToPromoteOp(SDValue Op, EVT &PVT) const override;
676
677     MachineBasicBlock *
678       EmitInstrWithCustomInserter(MachineInstr *MI,
679                                   MachineBasicBlock *MBB) const override;
680
681
682     /// This method returns the name of a target specific DAG node.
683     const char *getTargetNodeName(unsigned Opcode) const override;
684
685     bool isCheapToSpeculateCttz() const override;
686
687     bool isCheapToSpeculateCtlz() const override;
688
689     /// Return the value type to use for ISD::SETCC.
690     EVT getSetCCResultType(LLVMContext &Context, EVT VT) const override;
691
692     /// Determine which of the bits specified in Mask are known to be either
693     /// zero or one and return them in the KnownZero/KnownOne bitsets.
694     void computeKnownBitsForTargetNode(const SDValue Op,
695                                        APInt &KnownZero,
696                                        APInt &KnownOne,
697                                        const SelectionDAG &DAG,
698                                        unsigned Depth = 0) const override;
699
700     /// Determine the number of bits in the operation that are sign bits.
701     unsigned ComputeNumSignBitsForTargetNode(SDValue Op,
702                                              const SelectionDAG &DAG,
703                                              unsigned Depth) const override;
704
705     bool isGAPlusOffset(SDNode *N, const GlobalValue* &GA,
706                         int64_t &Offset) const override;
707
708     SDValue getReturnAddressFrameIndex(SelectionDAG &DAG) const;
709
710     bool ExpandInlineAsm(CallInst *CI) const override;
711
712     ConstraintType getConstraintType(StringRef Constraint) const override;
713
714     /// Examine constraint string and operand type and determine a weight value.
715     /// The operand object must already have been set up with the operand type.
716     ConstraintWeight
717       getSingleConstraintMatchWeight(AsmOperandInfo &info,
718                                      const char *constraint) const override;
719
720     const char *LowerXConstraint(EVT ConstraintVT) const override;
721
722     /// Lower the specified operand into the Ops vector. If it is invalid, don't
723     /// add anything to Ops. If hasMemory is true it means one of the asm
724     /// constraint of the inline asm instruction being processed is 'm'.
725     void LowerAsmOperandForConstraint(SDValue Op,
726                                       std::string &Constraint,
727                                       std::vector<SDValue> &Ops,
728                                       SelectionDAG &DAG) const override;
729
730     unsigned
731     getInlineAsmMemConstraint(StringRef ConstraintCode) const override {
732       if (ConstraintCode == "i")
733         return InlineAsm::Constraint_i;
734       else if (ConstraintCode == "o")
735         return InlineAsm::Constraint_o;
736       else if (ConstraintCode == "v")
737         return InlineAsm::Constraint_v;
738       else if (ConstraintCode == "X")
739         return InlineAsm::Constraint_X;
740       return TargetLowering::getInlineAsmMemConstraint(ConstraintCode);
741     }
742
743     /// Given a physical register constraint
744     /// (e.g. {edx}), return the register number and the register class for the
745     /// register.  This should only be used for C_Register constraints.  On
746     /// error, this returns a register number of 0.
747     std::pair<unsigned, const TargetRegisterClass *>
748     getRegForInlineAsmConstraint(const TargetRegisterInfo *TRI,
749                                  StringRef Constraint, MVT VT) const override;
750
751     /// Return true if the addressing mode represented
752     /// by AM is legal for this target, for a load/store of the specified type.
753     bool isLegalAddressingMode(const AddrMode &AM, Type *Ty,
754                                unsigned AS) const override;
755
756     /// Return true if the specified immediate is legal
757     /// icmp immediate, that is the target has icmp instructions which can
758     /// compare a register against the immediate without having to materialize
759     /// the immediate into a register.
760     bool isLegalICmpImmediate(int64_t Imm) const override;
761
762     /// Return true if the specified immediate is legal
763     /// add immediate, that is the target has add instructions which can
764     /// add a register and the immediate without having to materialize
765     /// the immediate into a register.
766     bool isLegalAddImmediate(int64_t Imm) const override;
767
768     /// \brief Return the cost of the scaling factor used in the addressing
769     /// mode represented by AM for this target, for a load/store
770     /// of the specified type.
771     /// If the AM is supported, the return value must be >= 0.
772     /// If the AM is not supported, it returns a negative value.
773     int getScalingFactorCost(const AddrMode &AM, Type *Ty,
774                              unsigned AS) const override;
775
776     bool isVectorShiftByScalarCheap(Type *Ty) const override;
777
778     /// Return true if it's free to truncate a value of
779     /// type Ty1 to type Ty2. e.g. On x86 it's free to truncate a i32 value in
780     /// register EAX to i16 by referencing its sub-register AX.
781     bool isTruncateFree(Type *Ty1, Type *Ty2) const override;
782     bool isTruncateFree(EVT VT1, EVT VT2) const override;
783
784     bool allowTruncateForTailCall(Type *Ty1, Type *Ty2) const override;
785
786     /// Return true if any actual instruction that defines a
787     /// value of type Ty1 implicit zero-extends the value to Ty2 in the result
788     /// register. This does not necessarily include registers defined in
789     /// unknown ways, such as incoming arguments, or copies from unknown
790     /// virtual registers. Also, if isTruncateFree(Ty2, Ty1) is true, this
791     /// does not necessarily apply to truncate instructions. e.g. on x86-64,
792     /// all instructions that define 32-bit values implicit zero-extend the
793     /// result out to 64 bits.
794     bool isZExtFree(Type *Ty1, Type *Ty2) const override;
795     bool isZExtFree(EVT VT1, EVT VT2) const override;
796     bool isZExtFree(SDValue Val, EVT VT2) const override;
797
798     /// Return true if folding a vector load into ExtVal (a sign, zero, or any
799     /// extend node) is profitable.
800     bool isVectorLoadExtDesirable(SDValue) const override;
801
802     /// Return true if an FMA operation is faster than a pair of fmul and fadd
803     /// instructions. fmuladd intrinsics will be expanded to FMAs when this
804     /// method returns true, otherwise fmuladd is expanded to fmul + fadd.
805     bool isFMAFasterThanFMulAndFAdd(EVT VT) const override;
806
807     /// Return true if it's profitable to narrow
808     /// operations of type VT1 to VT2. e.g. on x86, it's profitable to narrow
809     /// from i32 to i8 but not from i32 to i16.
810     bool isNarrowingProfitable(EVT VT1, EVT VT2) const override;
811
812     /// Returns true if the target can instruction select the
813     /// specified FP immediate natively. If false, the legalizer will
814     /// materialize the FP immediate as a load from a constant pool.
815     bool isFPImmLegal(const APFloat &Imm, EVT VT) const override;
816
817     /// Targets can use this to indicate that they only support *some*
818     /// VECTOR_SHUFFLE operations, those with specific masks. By default, if a
819     /// target supports the VECTOR_SHUFFLE node, all mask values are assumed to
820     /// be legal.
821     bool isShuffleMaskLegal(const SmallVectorImpl<int> &Mask,
822                             EVT VT) const override;
823
824     /// Similar to isShuffleMaskLegal. This is used by Targets can use this to
825     /// indicate if there is a suitable VECTOR_SHUFFLE that can be used to
826     /// replace a VAND with a constant pool entry.
827     bool isVectorClearMaskLegal(const SmallVectorImpl<int> &Mask,
828                                 EVT VT) const override;
829
830     /// If true, then instruction selection should
831     /// seek to shrink the FP constant of the specified type to a smaller type
832     /// in order to save space and / or reduce runtime.
833     bool ShouldShrinkFPConstant(EVT VT) const override {
834       // Don't shrink FP constpool if SSE2 is available since cvtss2sd is more
835       // expensive than a straight movsd. On the other hand, it's important to
836       // shrink long double fp constant since fldt is very slow.
837       return !X86ScalarSSEf64 || VT == MVT::f80;
838     }
839
840     /// Return true if we believe it is correct and profitable to reduce the
841     /// load node to a smaller type.
842     bool shouldReduceLoadWidth(SDNode *Load, ISD::LoadExtType ExtTy,
843                                EVT NewVT) const override;
844
845     /// Return true if the specified scalar FP type is computed in an SSE
846     /// register, not on the X87 floating point stack.
847     bool isScalarFPTypeInSSEReg(EVT VT) const {
848       return (VT == MVT::f64 && X86ScalarSSEf64) || // f64 is when SSE2
849       (VT == MVT::f32 && X86ScalarSSEf32);   // f32 is when SSE1
850     }
851
852     /// Return true if the target uses the MSVC _ftol2 routine for fptoui.
853     bool isTargetFTOL() const;
854
855     /// Return true if the MSVC _ftol2 routine should be used for fptoui to the
856     /// given type.
857     bool isIntegerTypeFTOL(EVT VT) const {
858       return isTargetFTOL() && VT == MVT::i64;
859     }
860
861     /// \brief Returns true if it is beneficial to convert a load of a constant
862     /// to just the constant itself.
863     bool shouldConvertConstantLoadToIntImm(const APInt &Imm,
864                                            Type *Ty) const override;
865
866     /// Return true if EXTRACT_SUBVECTOR is cheap for this result type
867     /// with this index.
868     bool isExtractSubvectorCheap(EVT ResVT, unsigned Index) const override;
869
870     /// Intel processors have a unified instruction and data cache
871     const char * getClearCacheBuiltinName() const override {
872       return nullptr; // nothing to do, move along.
873     }
874
875     unsigned getRegisterByName(const char* RegName, EVT VT) const override;
876
877     /// This method returns a target specific FastISel object,
878     /// or null if the target does not support "fast" ISel.
879     FastISel *createFastISel(FunctionLoweringInfo &funcInfo,
880                              const TargetLibraryInfo *libInfo) const override;
881
882     /// Return true if the target stores stack protector cookies at a fixed
883     /// offset in some non-standard address space, and populates the address
884     /// space and offset as appropriate.
885     bool getStackCookieLocation(unsigned &AddressSpace,
886                                 unsigned &Offset) const override;
887
888     SDValue BuildFILD(SDValue Op, EVT SrcVT, SDValue Chain, SDValue StackSlot,
889                       SelectionDAG &DAG) const;
890
891     bool isNoopAddrSpaceCast(unsigned SrcAS, unsigned DestAS) const override;
892
893     bool useLoadStackGuardNode() const override;
894     /// \brief Customize the preferred legalization strategy for certain types.
895     LegalizeTypeAction getPreferredVectorAction(EVT VT) const override;
896
897   protected:
898     std::pair<const TargetRegisterClass *, uint8_t>
899     findRepresentativeClass(const TargetRegisterInfo *TRI,
900                             MVT VT) const override;
901
902   private:
903     /// Keep a pointer to the X86Subtarget around so that we can
904     /// make the right decision when generating code for different targets.
905     const X86Subtarget *Subtarget;
906     const DataLayout *TD;
907
908     /// Select between SSE or x87 floating point ops.
909     /// When SSE is available, use it for f32 operations.
910     /// When SSE2 is available, use it for f64 operations.
911     bool X86ScalarSSEf32;
912     bool X86ScalarSSEf64;
913
914     /// A list of legal FP immediates.
915     std::vector<APFloat> LegalFPImmediates;
916
917     /// Indicate that this x86 target can instruction
918     /// select the specified FP immediate natively.
919     void addLegalFPImmediate(const APFloat& Imm) {
920       LegalFPImmediates.push_back(Imm);
921     }
922
923     SDValue LowerCallResult(SDValue Chain, SDValue InFlag,
924                             CallingConv::ID CallConv, bool isVarArg,
925                             const SmallVectorImpl<ISD::InputArg> &Ins,
926                             SDLoc dl, SelectionDAG &DAG,
927                             SmallVectorImpl<SDValue> &InVals) const;
928     SDValue LowerMemArgument(SDValue Chain,
929                              CallingConv::ID CallConv,
930                              const SmallVectorImpl<ISD::InputArg> &ArgInfo,
931                              SDLoc dl, SelectionDAG &DAG,
932                              const CCValAssign &VA,  MachineFrameInfo *MFI,
933                               unsigned i) const;
934     SDValue LowerMemOpCallTo(SDValue Chain, SDValue StackPtr, SDValue Arg,
935                              SDLoc dl, SelectionDAG &DAG,
936                              const CCValAssign &VA,
937                              ISD::ArgFlagsTy Flags) const;
938
939     // Call lowering helpers.
940
941     /// Check whether the call is eligible for tail call optimization. Targets
942     /// that want to do tail call optimization should implement this function.
943     bool IsEligibleForTailCallOptimization(SDValue Callee,
944                                            CallingConv::ID CalleeCC,
945                                            bool isVarArg,
946                                            bool isCalleeStructRet,
947                                            bool isCallerStructRet,
948                                            Type *RetTy,
949                                     const SmallVectorImpl<ISD::OutputArg> &Outs,
950                                     const SmallVectorImpl<SDValue> &OutVals,
951                                     const SmallVectorImpl<ISD::InputArg> &Ins,
952                                            SelectionDAG& DAG) const;
953     bool IsCalleePop(bool isVarArg, CallingConv::ID CallConv) const;
954     SDValue EmitTailCallLoadRetAddr(SelectionDAG &DAG, SDValue &OutRetAddr,
955                                 SDValue Chain, bool IsTailCall, bool Is64Bit,
956                                 int FPDiff, SDLoc dl) const;
957
958     unsigned GetAlignedArgumentStackSize(unsigned StackSize,
959                                          SelectionDAG &DAG) const;
960
961     std::pair<SDValue,SDValue> FP_TO_INTHelper(SDValue Op, SelectionDAG &DAG,
962                                                bool isSigned,
963                                                bool isReplace) const;
964
965     SDValue LowerBUILD_VECTOR(SDValue Op, SelectionDAG &DAG) const;
966     SDValue LowerBUILD_VECTORvXi1(SDValue Op, SelectionDAG &DAG) const;
967     SDValue LowerVECTOR_SHUFFLE(SDValue Op, SelectionDAG &DAG) const;
968     SDValue LowerVSELECT(SDValue Op, SelectionDAG &DAG) const;
969     SDValue LowerEXTRACT_VECTOR_ELT(SDValue Op, SelectionDAG &DAG) const;
970     SDValue ExtractBitFromMaskVector(SDValue Op, SelectionDAG &DAG) const;
971     SDValue InsertBitToMaskVector(SDValue Op, SelectionDAG &DAG) const;
972
973     SDValue LowerINSERT_VECTOR_ELT(SDValue Op, SelectionDAG &DAG) const;
974     SDValue LowerConstantPool(SDValue Op, SelectionDAG &DAG) const;
975     SDValue LowerBlockAddress(SDValue Op, SelectionDAG &DAG) const;
976     SDValue LowerGlobalAddress(const GlobalValue *GV, SDLoc dl,
977                                int64_t Offset, SelectionDAG &DAG) const;
978     SDValue LowerGlobalAddress(SDValue Op, SelectionDAG &DAG) const;
979     SDValue LowerGlobalTLSAddress(SDValue Op, SelectionDAG &DAG) const;
980     SDValue LowerExternalSymbol(SDValue Op, SelectionDAG &DAG) const;
981     SDValue LowerSINT_TO_FP(SDValue Op, SelectionDAG &DAG) const;
982     SDValue LowerUINT_TO_FP(SDValue Op, SelectionDAG &DAG) const;
983     SDValue LowerUINT_TO_FP_i64(SDValue Op, SelectionDAG &DAG) const;
984     SDValue LowerUINT_TO_FP_i32(SDValue Op, SelectionDAG &DAG) const;
985     SDValue lowerUINT_TO_FP_vec(SDValue Op, SelectionDAG &DAG) const;
986     SDValue LowerTRUNCATE(SDValue Op, SelectionDAG &DAG) const;
987     SDValue LowerFP_TO_SINT(SDValue Op, SelectionDAG &DAG) const;
988     SDValue LowerFP_TO_UINT(SDValue Op, SelectionDAG &DAG) const;
989     SDValue LowerToBT(SDValue And, ISD::CondCode CC,
990                       SDLoc dl, SelectionDAG &DAG) const;
991     SDValue LowerSETCC(SDValue Op, SelectionDAG &DAG) const;
992     SDValue LowerSELECT(SDValue Op, SelectionDAG &DAG) const;
993     SDValue LowerBRCOND(SDValue Op, SelectionDAG &DAG) const;
994     SDValue LowerMEMSET(SDValue Op, SelectionDAG &DAG) const;
995     SDValue LowerJumpTable(SDValue Op, SelectionDAG &DAG) const;
996     SDValue LowerDYNAMIC_STACKALLOC(SDValue Op, SelectionDAG &DAG) const;
997     SDValue LowerVASTART(SDValue Op, SelectionDAG &DAG) const;
998     SDValue LowerVAARG(SDValue Op, SelectionDAG &DAG) const;
999     SDValue LowerRETURNADDR(SDValue Op, SelectionDAG &DAG) const;
1000     SDValue LowerFRAMEADDR(SDValue Op, SelectionDAG &DAG) const;
1001     SDValue LowerFRAME_TO_ARGS_OFFSET(SDValue Op, SelectionDAG &DAG) const;
1002     SDValue LowerEH_RETURN(SDValue Op, SelectionDAG &DAG) const;
1003     SDValue lowerEH_SJLJ_SETJMP(SDValue Op, SelectionDAG &DAG) const;
1004     SDValue lowerEH_SJLJ_LONGJMP(SDValue Op, SelectionDAG &DAG) const;
1005     SDValue LowerINIT_TRAMPOLINE(SDValue Op, SelectionDAG &DAG) const;
1006     SDValue LowerFLT_ROUNDS_(SDValue Op, SelectionDAG &DAG) const;
1007     SDValue LowerWin64_i128OP(SDValue Op, SelectionDAG &DAG) const;
1008     SDValue LowerGC_TRANSITION_START(SDValue Op, SelectionDAG &DAG) const;
1009     SDValue LowerGC_TRANSITION_END(SDValue Op, SelectionDAG &DAG) const;
1010
1011     SDValue
1012       LowerFormalArguments(SDValue Chain,
1013                            CallingConv::ID CallConv, bool isVarArg,
1014                            const SmallVectorImpl<ISD::InputArg> &Ins,
1015                            SDLoc dl, SelectionDAG &DAG,
1016                            SmallVectorImpl<SDValue> &InVals) const override;
1017     SDValue LowerCall(CallLoweringInfo &CLI,
1018                       SmallVectorImpl<SDValue> &InVals) const override;
1019
1020     SDValue LowerReturn(SDValue Chain,
1021                         CallingConv::ID CallConv, bool isVarArg,
1022                         const SmallVectorImpl<ISD::OutputArg> &Outs,
1023                         const SmallVectorImpl<SDValue> &OutVals,
1024                         SDLoc dl, SelectionDAG &DAG) const override;
1025
1026     bool isUsedByReturnOnly(SDNode *N, SDValue &Chain) const override;
1027
1028     bool mayBeEmittedAsTailCall(CallInst *CI) const override;
1029
1030     EVT getTypeForExtArgOrReturn(LLVMContext &Context, EVT VT,
1031                                  ISD::NodeType ExtendKind) const override;
1032
1033     bool CanLowerReturn(CallingConv::ID CallConv, MachineFunction &MF,
1034                         bool isVarArg,
1035                         const SmallVectorImpl<ISD::OutputArg> &Outs,
1036                         LLVMContext &Context) const override;
1037
1038     const MCPhysReg *getScratchRegisters(CallingConv::ID CC) const override;
1039
1040     bool shouldExpandAtomicLoadInIR(LoadInst *SI) const override;
1041     bool shouldExpandAtomicStoreInIR(StoreInst *SI) const override;
1042     TargetLoweringBase::AtomicRMWExpansionKind
1043     shouldExpandAtomicRMWInIR(AtomicRMWInst *AI) const override;
1044
1045     LoadInst *
1046     lowerIdempotentRMWIntoFencedLoad(AtomicRMWInst *AI) const override;
1047
1048     bool needsCmpXchgNb(const Type *MemType) const;
1049
1050     /// Utility function to emit atomic-load-arith operations (and, or, xor,
1051     /// nand, max, min, umax, umin). It takes the corresponding instruction to
1052     /// expand, the associated machine basic block, and the associated X86
1053     /// opcodes for reg/reg.
1054     MachineBasicBlock *EmitAtomicLoadArith(MachineInstr *MI,
1055                                            MachineBasicBlock *MBB) const;
1056
1057     /// Utility function to emit atomic-load-arith operations (and, or, xor,
1058     /// nand, add, sub, swap) for 64-bit operands on 32-bit target.
1059     MachineBasicBlock *EmitAtomicLoadArith6432(MachineInstr *MI,
1060                                                MachineBasicBlock *MBB) const;
1061
1062     // Utility function to emit the low-level va_arg code for X86-64.
1063     MachineBasicBlock *EmitVAARG64WithCustomInserter(
1064                        MachineInstr *MI,
1065                        MachineBasicBlock *MBB) const;
1066
1067     /// Utility function to emit the xmm reg save portion of va_start.
1068     MachineBasicBlock *EmitVAStartSaveXMMRegsWithCustomInserter(
1069                                                    MachineInstr *BInstr,
1070                                                    MachineBasicBlock *BB) const;
1071
1072     MachineBasicBlock *EmitLoweredSelect(MachineInstr *I,
1073                                          MachineBasicBlock *BB) const;
1074
1075     MachineBasicBlock *EmitLoweredWinAlloca(MachineInstr *MI,
1076                                               MachineBasicBlock *BB) const;
1077
1078     MachineBasicBlock *EmitLoweredSegAlloca(MachineInstr *MI,
1079                                             MachineBasicBlock *BB) const;
1080
1081     MachineBasicBlock *EmitLoweredTLSCall(MachineInstr *MI,
1082                                           MachineBasicBlock *BB) const;
1083
1084     MachineBasicBlock *emitLoweredTLSAddr(MachineInstr *MI,
1085                                           MachineBasicBlock *BB) const;
1086
1087     MachineBasicBlock *emitEHSjLjSetJmp(MachineInstr *MI,
1088                                         MachineBasicBlock *MBB) const;
1089
1090     MachineBasicBlock *emitEHSjLjLongJmp(MachineInstr *MI,
1091                                          MachineBasicBlock *MBB) const;
1092
1093     MachineBasicBlock *emitFMA3Instr(MachineInstr *MI,
1094                                      MachineBasicBlock *MBB) const;
1095
1096     /// Emit nodes that will be selected as "test Op0,Op0", or something
1097     /// equivalent, for use with the given x86 condition code.
1098     SDValue EmitTest(SDValue Op0, unsigned X86CC, SDLoc dl,
1099                      SelectionDAG &DAG) const;
1100
1101     /// Emit nodes that will be selected as "cmp Op0,Op1", or something
1102     /// equivalent, for use with the given x86 condition code.
1103     SDValue EmitCmp(SDValue Op0, SDValue Op1, unsigned X86CC, SDLoc dl,
1104                     SelectionDAG &DAG) const;
1105
1106     /// Convert a comparison if required by the subtarget.
1107     SDValue ConvertCmpIfNecessary(SDValue Cmp, SelectionDAG &DAG) const;
1108
1109     /// Use rsqrt* to speed up sqrt calculations.
1110     SDValue getRsqrtEstimate(SDValue Operand, DAGCombinerInfo &DCI,
1111                              unsigned &RefinementSteps,
1112                              bool &UseOneConstNR) const override;
1113
1114     /// Use rcp* to speed up fdiv calculations.
1115     SDValue getRecipEstimate(SDValue Operand, DAGCombinerInfo &DCI,
1116                              unsigned &RefinementSteps) const override;
1117
1118     /// Reassociate floating point divisions into multiply by reciprocal.
1119     bool combineRepeatedFPDivisors(unsigned NumUsers) const override;
1120   };
1121
1122   namespace X86 {
1123     FastISel *createFastISel(FunctionLoweringInfo &funcInfo,
1124                              const TargetLibraryInfo *libInfo);
1125   }
1126 }
1127
1128 #endif    // X86ISELLOWERING_H