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