e99c9f758f8ea662d0ae554aa60572bdd923b6f5
[oota-llvm.git] / include / llvm / Target / TargetLowering.h
1 //===-- llvm/Target/TargetLowering.h - Target Lowering Info -----*- 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 /// \file
11 /// This file describes how to lower LLVM code to machine code.  This has two
12 /// main components:
13 ///
14 ///  1. Which ValueTypes are natively supported by the target.
15 ///  2. Which operations are supported for supported ValueTypes.
16 ///  3. Cost thresholds for alternative implementations of certain operations.
17 ///
18 /// In addition it has a few other components, like information about FP
19 /// immediates.
20 ///
21 //===----------------------------------------------------------------------===//
22
23 #ifndef LLVM_TARGET_TARGETLOWERING_H
24 #define LLVM_TARGET_TARGETLOWERING_H
25
26 #include "llvm/ADT/DenseMap.h"
27 #include "llvm/CodeGen/DAGCombine.h"
28 #include "llvm/CodeGen/RuntimeLibcalls.h"
29 #include "llvm/CodeGen/SelectionDAGNodes.h"
30 #include "llvm/IR/Attributes.h"
31 #include "llvm/IR/CallSite.h"
32 #include "llvm/IR/CallingConv.h"
33 #include "llvm/IR/IRBuilder.h"
34 #include "llvm/IR/InlineAsm.h"
35 #include "llvm/IR/Instructions.h"
36 #include "llvm/MC/MCRegisterInfo.h"
37 #include "llvm/Target/TargetCallingConv.h"
38 #include "llvm/Target/TargetMachine.h"
39 #include <climits>
40 #include <map>
41 #include <vector>
42
43 namespace llvm {
44   class CallInst;
45   class CCState;
46   class FastISel;
47   class FunctionLoweringInfo;
48   class ImmutableCallSite;
49   class IntrinsicInst;
50   class MachineBasicBlock;
51   class MachineFunction;
52   class MachineInstr;
53   class MachineJumpTableInfo;
54   class MachineLoop;
55   class Mangler;
56   class MCContext;
57   class MCExpr;
58   class MCSymbol;
59   template<typename T> class SmallVectorImpl;
60   class DataLayout;
61   class TargetRegisterClass;
62   class TargetLibraryInfo;
63   class TargetLoweringObjectFile;
64   class Value;
65
66   namespace Sched {
67     enum Preference {
68       None,             // No preference
69       Source,           // Follow source order.
70       RegPressure,      // Scheduling for lowest register pressure.
71       Hybrid,           // Scheduling for both latency and register pressure.
72       ILP,              // Scheduling for ILP in low register pressure mode.
73       VLIW              // Scheduling for VLIW targets.
74     };
75   }
76
77 /// This base class for TargetLowering contains the SelectionDAG-independent
78 /// parts that can be used from the rest of CodeGen.
79 class TargetLoweringBase {
80   TargetLoweringBase(const TargetLoweringBase&) = delete;
81   void operator=(const TargetLoweringBase&) = delete;
82
83 public:
84   /// This enum indicates whether operations are valid for a target, and if not,
85   /// what action should be used to make them valid.
86   enum LegalizeAction {
87     Legal,      // The target natively supports this operation.
88     Promote,    // This operation should be executed in a larger type.
89     Expand,     // Try to expand this to other ops, otherwise use a libcall.
90     LibCall,    // Don't try to expand this to other ops, always use a libcall.
91     Custom      // Use the LowerOperation hook to implement custom lowering.
92   };
93
94   /// This enum indicates whether a types are legal for a target, and if not,
95   /// what action should be used to make them valid.
96   enum LegalizeTypeAction {
97     TypeLegal,           // The target natively supports this type.
98     TypePromoteInteger,  // Replace this integer with a larger one.
99     TypeExpandInteger,   // Split this integer into two of half the size.
100     TypeSoftenFloat,     // Convert this float to a same size integer type,
101                          // if an operation is not supported in target HW.
102     TypeExpandFloat,     // Split this float into two of half the size.
103     TypeScalarizeVector, // Replace this one-element vector with its element.
104     TypeSplitVector,     // Split this vector into two of half the size.
105     TypeWidenVector,     // This vector should be widened into a larger vector.
106     TypePromoteFloat     // Replace this float with a larger one.
107   };
108
109   /// LegalizeKind holds the legalization kind that needs to happen to EVT
110   /// in order to type-legalize it.
111   typedef std::pair<LegalizeTypeAction, EVT> LegalizeKind;
112
113   /// Enum that describes how the target represents true/false values.
114   enum BooleanContent {
115     UndefinedBooleanContent,    // Only bit 0 counts, the rest can hold garbage.
116     ZeroOrOneBooleanContent,        // All bits zero except for bit 0.
117     ZeroOrNegativeOneBooleanContent // All bits equal to bit 0.
118   };
119
120   /// Enum that describes what type of support for selects the target has.
121   enum SelectSupportKind {
122     ScalarValSelect,      // The target supports scalar selects (ex: cmov).
123     ScalarCondVectorVal,  // The target supports selects with a scalar condition
124                           // and vector values (ex: cmov).
125     VectorMaskSelect      // The target supports vector selects with a vector
126                           // mask (ex: x86 blends).
127   };
128
129   /// Enum that specifies what an atomic load/AtomicRMWInst is expanded
130   /// to, if at all. Exists because different targets have different levels of
131   /// support for these atomic instructions, and also have different options
132   /// w.r.t. what they should expand to.
133   enum class AtomicExpansionKind {
134     None,    // Don't expand the instruction.
135     LLSC,    // Expand the instruction into loadlinked/storeconditional; used
136              // by ARM/AArch64.
137     LLOnly,  // Expand the (load) instruction into just a load-linked, which has
138              // greater atomic guarantees than a normal load.
139     CmpXChg, // Expand the instruction into cmpxchg; used by at least X86.
140   };
141
142   static ISD::NodeType getExtendForContent(BooleanContent Content) {
143     switch (Content) {
144     case UndefinedBooleanContent:
145       // Extend by adding rubbish bits.
146       return ISD::ANY_EXTEND;
147     case ZeroOrOneBooleanContent:
148       // Extend by adding zero bits.
149       return ISD::ZERO_EXTEND;
150     case ZeroOrNegativeOneBooleanContent:
151       // Extend by copying the sign bit.
152       return ISD::SIGN_EXTEND;
153     }
154     llvm_unreachable("Invalid content kind");
155   }
156
157   /// NOTE: The TargetMachine owns TLOF.
158   explicit TargetLoweringBase(const TargetMachine &TM);
159   virtual ~TargetLoweringBase() {}
160
161 protected:
162   /// \brief Initialize all of the actions to default values.
163   void initActions();
164
165 public:
166   const TargetMachine &getTargetMachine() const { return TM; }
167
168   virtual bool useSoftFloat() const { return false; }
169
170   /// Return the pointer type for the given address space, defaults to
171   /// the pointer type from the data layout.
172   /// FIXME: The default needs to be removed once all the code is updated.
173   MVT getPointerTy(const DataLayout &DL, uint32_t AS = 0) const {
174     return MVT::getIntegerVT(DL.getPointerSizeInBits(AS));
175   }
176
177   /// EVT is not used in-tree, but is used by out-of-tree target.
178   /// A documentation for this function would be nice...
179   virtual MVT getScalarShiftAmountTy(const DataLayout &, EVT) const;
180
181   EVT getShiftAmountTy(EVT LHSTy, const DataLayout &DL) const;
182
183   /// Returns the type to be used for the index operand of:
184   /// ISD::INSERT_VECTOR_ELT, ISD::EXTRACT_VECTOR_ELT,
185   /// ISD::INSERT_SUBVECTOR, and ISD::EXTRACT_SUBVECTOR
186   virtual MVT getVectorIdxTy(const DataLayout &DL) const {
187     return getPointerTy(DL);
188   }
189
190   /// Return true if the select operation is expensive for this target.
191   bool isSelectExpensive() const { return SelectIsExpensive; }
192
193   virtual bool isSelectSupported(SelectSupportKind /*kind*/) const {
194     return true;
195   }
196
197   /// Return true if multiple condition registers are available.
198   bool hasMultipleConditionRegisters() const {
199     return HasMultipleConditionRegisters;
200   }
201
202   /// Return true if the target has BitExtract instructions.
203   bool hasExtractBitsInsn() const { return HasExtractBitsInsn; }
204
205   /// Return the preferred vector type legalization action.
206   virtual TargetLoweringBase::LegalizeTypeAction
207   getPreferredVectorAction(EVT VT) const {
208     // The default action for one element vectors is to scalarize
209     if (VT.getVectorNumElements() == 1)
210       return TypeScalarizeVector;
211     // The default action for other vectors is to promote
212     return TypePromoteInteger;
213   }
214
215   // There are two general methods for expanding a BUILD_VECTOR node:
216   //  1. Use SCALAR_TO_VECTOR on the defined scalar values and then shuffle
217   //     them together.
218   //  2. Build the vector on the stack and then load it.
219   // If this function returns true, then method (1) will be used, subject to
220   // the constraint that all of the necessary shuffles are legal (as determined
221   // by isShuffleMaskLegal). If this function returns false, then method (2) is
222   // always used. The vector type, and the number of defined values, are
223   // provided.
224   virtual bool
225   shouldExpandBuildVectorWithShuffles(EVT /* VT */,
226                                       unsigned DefinedValues) const {
227     return DefinedValues < 3;
228   }
229
230   /// Return true if integer divide is usually cheaper than a sequence of
231   /// several shifts, adds, and multiplies for this target.
232   /// The definition of "cheaper" may depend on whether we're optimizing
233   /// for speed or for size.
234   virtual bool isIntDivCheap(EVT VT, AttributeSet Attr) const {
235     return false;
236   }
237
238   /// Return true if sqrt(x) is as cheap or cheaper than 1 / rsqrt(x)
239   bool isFsqrtCheap() const {
240     return FsqrtIsCheap;
241   }
242
243   /// Returns true if target has indicated at least one type should be bypassed.
244   bool isSlowDivBypassed() const { return !BypassSlowDivWidths.empty(); }
245
246   /// Returns map of slow types for division or remainder with corresponding
247   /// fast types
248   const DenseMap<unsigned int, unsigned int> &getBypassSlowDivWidths() const {
249     return BypassSlowDivWidths;
250   }
251
252   /// Return true if Flow Control is an expensive operation that should be
253   /// avoided.
254   bool isJumpExpensive() const { return JumpIsExpensive; }
255
256   /// Return true if selects are only cheaper than branches if the branch is
257   /// unlikely to be predicted right.
258   bool isPredictableSelectExpensive() const {
259     return PredictableSelectIsExpensive;
260   }
261
262   /// isLoadBitCastBeneficial() - Return true if the following transform
263   /// is beneficial.
264   /// fold (conv (load x)) -> (load (conv*)x)
265   /// On architectures that don't natively support some vector loads
266   /// efficiently, casting the load to a smaller vector of larger types and
267   /// loading is more efficient, however, this can be undone by optimizations in
268   /// dag combiner.
269   virtual bool isLoadBitCastBeneficial(EVT /* Load */,
270                                        EVT /* Bitcast */) const {
271     return true;
272   }
273
274   /// Return true if it is expected to be cheaper to do a store of a non-zero
275   /// vector constant with the given size and type for the address space than to
276   /// store the individual scalar element constants.
277   virtual bool storeOfVectorConstantIsCheap(EVT MemVT,
278                                             unsigned NumElem,
279                                             unsigned AddrSpace) const {
280     return false;
281   }
282
283   /// \brief Return true if it is cheap to speculate a call to intrinsic cttz.
284   virtual bool isCheapToSpeculateCttz() const {
285     return false;
286   }
287
288   /// \brief Return true if it is cheap to speculate a call to intrinsic ctlz.
289   virtual bool isCheapToSpeculateCtlz() const {
290     return false;
291   }
292
293   /// \brief Return if the target supports combining a
294   /// chain like:
295   /// \code
296   ///   %andResult = and %val1, #imm-with-one-bit-set;
297   ///   %icmpResult = icmp %andResult, 0
298   ///   br i1 %icmpResult, label %dest1, label %dest2
299   /// \endcode
300   /// into a single machine instruction of a form like:
301   /// \code
302   ///   brOnBitSet %register, #bitNumber, dest
303   /// \endcode
304   bool isMaskAndBranchFoldingLegal() const {
305     return MaskAndBranchFoldingIsLegal;
306   }
307
308   /// \brief Return true if the target wants to use the optimization that
309   /// turns ext(promotableInst1(...(promotableInstN(load)))) into
310   /// promotedInst1(...(promotedInstN(ext(load)))).
311   bool enableExtLdPromotion() const { return EnableExtLdPromotion; }
312
313   /// Return true if the target can combine store(extractelement VectorTy,
314   /// Idx).
315   /// \p Cost[out] gives the cost of that transformation when this is true.
316   virtual bool canCombineStoreAndExtract(Type *VectorTy, Value *Idx,
317                                          unsigned &Cost) const {
318     return false;
319   }
320
321   /// Return true if target supports floating point exceptions.
322   bool hasFloatingPointExceptions() const {
323     return HasFloatingPointExceptions;
324   }
325
326   /// Return true if target always beneficiates from combining into FMA for a
327   /// given value type. This must typically return false on targets where FMA
328   /// takes more cycles to execute than FADD.
329   virtual bool enableAggressiveFMAFusion(EVT VT) const {
330     return false;
331   }
332
333   /// Return the ValueType of the result of SETCC operations.
334   virtual EVT getSetCCResultType(const DataLayout &DL, LLVMContext &Context,
335                                  EVT VT) const;
336
337   /// Return the ValueType for comparison libcalls. Comparions libcalls include
338   /// floating point comparion calls, and Ordered/Unordered check calls on
339   /// floating point numbers.
340   virtual
341   MVT::SimpleValueType getCmpLibcallReturnType() const;
342
343   /// For targets without i1 registers, this gives the nature of the high-bits
344   /// of boolean values held in types wider than i1.
345   ///
346   /// "Boolean values" are special true/false values produced by nodes like
347   /// SETCC and consumed (as the condition) by nodes like SELECT and BRCOND.
348   /// Not to be confused with general values promoted from i1.  Some cpus
349   /// distinguish between vectors of boolean and scalars; the isVec parameter
350   /// selects between the two kinds.  For example on X86 a scalar boolean should
351   /// be zero extended from i1, while the elements of a vector of booleans
352   /// should be sign extended from i1.
353   ///
354   /// Some cpus also treat floating point types the same way as they treat
355   /// vectors instead of the way they treat scalars.
356   BooleanContent getBooleanContents(bool isVec, bool isFloat) const {
357     if (isVec)
358       return BooleanVectorContents;
359     return isFloat ? BooleanFloatContents : BooleanContents;
360   }
361
362   BooleanContent getBooleanContents(EVT Type) const {
363     return getBooleanContents(Type.isVector(), Type.isFloatingPoint());
364   }
365
366   /// Return target scheduling preference.
367   Sched::Preference getSchedulingPreference() const {
368     return SchedPreferenceInfo;
369   }
370
371   /// Some scheduler, e.g. hybrid, can switch to different scheduling heuristics
372   /// for different nodes. This function returns the preference (or none) for
373   /// the given node.
374   virtual Sched::Preference getSchedulingPreference(SDNode *) const {
375     return Sched::None;
376   }
377
378   /// Return the register class that should be used for the specified value
379   /// type.
380   virtual const TargetRegisterClass *getRegClassFor(MVT VT) const {
381     const TargetRegisterClass *RC = RegClassForVT[VT.SimpleTy];
382     assert(RC && "This value type is not natively supported!");
383     return RC;
384   }
385
386   /// Return the 'representative' register class for the specified value
387   /// type.
388   ///
389   /// The 'representative' register class is the largest legal super-reg
390   /// register class for the register class of the value type.  For example, on
391   /// i386 the rep register class for i8, i16, and i32 are GR32; while the rep
392   /// register class is GR64 on x86_64.
393   virtual const TargetRegisterClass *getRepRegClassFor(MVT VT) const {
394     const TargetRegisterClass *RC = RepRegClassForVT[VT.SimpleTy];
395     return RC;
396   }
397
398   /// Return the cost of the 'representative' register class for the specified
399   /// value type.
400   virtual uint8_t getRepRegClassCostFor(MVT VT) const {
401     return RepRegClassCostForVT[VT.SimpleTy];
402   }
403
404   /// Return true if the target has native support for the specified value type.
405   /// This means that it has a register that directly holds it without
406   /// promotions or expansions.
407   bool isTypeLegal(EVT VT) const {
408     assert(!VT.isSimple() ||
409            (unsigned)VT.getSimpleVT().SimpleTy < array_lengthof(RegClassForVT));
410     return VT.isSimple() && RegClassForVT[VT.getSimpleVT().SimpleTy] != nullptr;
411   }
412
413   class ValueTypeActionImpl {
414     /// ValueTypeActions - For each value type, keep a LegalizeTypeAction enum
415     /// that indicates how instruction selection should deal with the type.
416     uint8_t ValueTypeActions[MVT::LAST_VALUETYPE];
417
418   public:
419     ValueTypeActionImpl() {
420       std::fill(std::begin(ValueTypeActions), std::end(ValueTypeActions), 0);
421     }
422
423     LegalizeTypeAction getTypeAction(MVT VT) const {
424       return (LegalizeTypeAction)ValueTypeActions[VT.SimpleTy];
425     }
426
427     void setTypeAction(MVT VT, LegalizeTypeAction Action) {
428       unsigned I = VT.SimpleTy;
429       ValueTypeActions[I] = Action;
430     }
431   };
432
433   const ValueTypeActionImpl &getValueTypeActions() const {
434     return ValueTypeActions;
435   }
436
437   /// Return how we should legalize values of this type, either it is already
438   /// legal (return 'Legal') or we need to promote it to a larger type (return
439   /// 'Promote'), or we need to expand it into multiple registers of smaller
440   /// integer type (return 'Expand').  'Custom' is not an option.
441   LegalizeTypeAction getTypeAction(LLVMContext &Context, EVT VT) const {
442     return getTypeConversion(Context, VT).first;
443   }
444   LegalizeTypeAction getTypeAction(MVT VT) const {
445     return ValueTypeActions.getTypeAction(VT);
446   }
447
448   /// For types supported by the target, this is an identity function.  For
449   /// types that must be promoted to larger types, this returns the larger type
450   /// to promote to.  For integer types that are larger than the largest integer
451   /// register, this contains one step in the expansion to get to the smaller
452   /// register. For illegal floating point types, this returns the integer type
453   /// to transform to.
454   EVT getTypeToTransformTo(LLVMContext &Context, EVT VT) const {
455     return getTypeConversion(Context, VT).second;
456   }
457
458   /// For types supported by the target, this is an identity function.  For
459   /// types that must be expanded (i.e. integer types that are larger than the
460   /// largest integer register or illegal floating point types), this returns
461   /// the largest legal type it will be expanded to.
462   EVT getTypeToExpandTo(LLVMContext &Context, EVT VT) const {
463     assert(!VT.isVector());
464     while (true) {
465       switch (getTypeAction(Context, VT)) {
466       case TypeLegal:
467         return VT;
468       case TypeExpandInteger:
469         VT = getTypeToTransformTo(Context, VT);
470         break;
471       default:
472         llvm_unreachable("Type is not legal nor is it to be expanded!");
473       }
474     }
475   }
476
477   /// Vector types are broken down into some number of legal first class types.
478   /// For example, EVT::v8f32 maps to 2 EVT::v4f32 with Altivec or SSE1, or 8
479   /// promoted EVT::f64 values with the X86 FP stack.  Similarly, EVT::v2i64
480   /// turns into 4 EVT::i32 values with both PPC and X86.
481   ///
482   /// This method returns the number of registers needed, and the VT for each
483   /// register.  It also returns the VT and quantity of the intermediate values
484   /// before they are promoted/expanded.
485   unsigned getVectorTypeBreakdown(LLVMContext &Context, EVT VT,
486                                   EVT &IntermediateVT,
487                                   unsigned &NumIntermediates,
488                                   MVT &RegisterVT) const;
489
490   struct IntrinsicInfo {
491     unsigned     opc;         // target opcode
492     EVT          memVT;       // memory VT
493     const Value* ptrVal;      // value representing memory location
494     int          offset;      // offset off of ptrVal
495     unsigned     size;        // the size of the memory location
496                               // (taken from memVT if zero)
497     unsigned     align;       // alignment
498     bool         vol;         // is volatile?
499     bool         readMem;     // reads memory?
500     bool         writeMem;    // writes memory?
501
502     IntrinsicInfo() : opc(0), ptrVal(nullptr), offset(0), size(0), align(1),
503                       vol(false), readMem(false), writeMem(false) {}
504   };
505
506   /// Given an intrinsic, checks if on the target the intrinsic will need to map
507   /// to a MemIntrinsicNode (touches memory). If this is the case, it returns
508   /// true and store the intrinsic information into the IntrinsicInfo that was
509   /// passed to the function.
510   virtual bool getTgtMemIntrinsic(IntrinsicInfo &, const CallInst &,
511                                   unsigned /*Intrinsic*/) const {
512     return false;
513   }
514
515   /// Returns true if the target can instruction select the specified FP
516   /// immediate natively. If false, the legalizer will materialize the FP
517   /// immediate as a load from a constant pool.
518   virtual bool isFPImmLegal(const APFloat &/*Imm*/, EVT /*VT*/) const {
519     return false;
520   }
521
522   /// Targets can use this to indicate that they only support *some*
523   /// VECTOR_SHUFFLE operations, those with specific masks.  By default, if a
524   /// target supports the VECTOR_SHUFFLE node, all mask values are assumed to be
525   /// legal.
526   virtual bool isShuffleMaskLegal(const SmallVectorImpl<int> &/*Mask*/,
527                                   EVT /*VT*/) const {
528     return true;
529   }
530
531   /// Returns true if the operation can trap for the value type.
532   ///
533   /// VT must be a legal type. By default, we optimistically assume most
534   /// operations don't trap except for divide and remainder.
535   virtual bool canOpTrap(unsigned Op, EVT VT) const;
536
537   /// Similar to isShuffleMaskLegal. This is used by Targets can use this to
538   /// indicate if there is a suitable VECTOR_SHUFFLE that can be used to replace
539   /// a VAND with a constant pool entry.
540   virtual bool isVectorClearMaskLegal(const SmallVectorImpl<int> &/*Mask*/,
541                                       EVT /*VT*/) const {
542     return false;
543   }
544
545   /// Return how this operation should be treated: either it is legal, needs to
546   /// be promoted to a larger size, needs to be expanded to some other code
547   /// sequence, or the target has a custom expander for it.
548   LegalizeAction getOperationAction(unsigned Op, EVT VT) const {
549     if (VT.isExtended()) return Expand;
550     // If a target-specific SDNode requires legalization, require the target
551     // to provide custom legalization for it.
552     if (Op > array_lengthof(OpActions[0])) return Custom;
553     unsigned I = (unsigned) VT.getSimpleVT().SimpleTy;
554     return (LegalizeAction)OpActions[I][Op];
555   }
556
557   /// Return true if the specified operation is legal on this target or can be
558   /// made legal with custom lowering. This is used to help guide high-level
559   /// lowering decisions.
560   bool isOperationLegalOrCustom(unsigned Op, EVT VT) const {
561     return (VT == MVT::Other || isTypeLegal(VT)) &&
562       (getOperationAction(Op, VT) == Legal ||
563        getOperationAction(Op, VT) == Custom);
564   }
565
566   /// Return true if the specified operation is legal on this target or can be
567   /// made legal using promotion. This is used to help guide high-level lowering
568   /// decisions.
569   bool isOperationLegalOrPromote(unsigned Op, EVT VT) const {
570     return (VT == MVT::Other || isTypeLegal(VT)) &&
571       (getOperationAction(Op, VT) == Legal ||
572        getOperationAction(Op, VT) == Promote);
573   }
574
575   /// Return true if the specified operation is illegal on this target or
576   /// unlikely to be made legal with custom lowering. This is used to help guide
577   /// high-level lowering decisions.
578   bool isOperationExpand(unsigned Op, EVT VT) const {
579     return (!isTypeLegal(VT) || getOperationAction(Op, VT) == Expand);
580   }
581
582   /// Return true if the specified operation is legal on this target.
583   bool isOperationLegal(unsigned Op, EVT VT) const {
584     return (VT == MVT::Other || isTypeLegal(VT)) &&
585            getOperationAction(Op, VT) == Legal;
586   }
587
588   /// Return how this load with extension should be treated: either it is legal,
589   /// needs to be promoted to a larger size, needs to be expanded to some other
590   /// code sequence, or the target has a custom expander for it.
591   LegalizeAction getLoadExtAction(unsigned ExtType, EVT ValVT,
592                                   EVT MemVT) const {
593     if (ValVT.isExtended() || MemVT.isExtended()) return Expand;
594     unsigned ValI = (unsigned) ValVT.getSimpleVT().SimpleTy;
595     unsigned MemI = (unsigned) MemVT.getSimpleVT().SimpleTy;
596     assert(ExtType < ISD::LAST_LOADEXT_TYPE && ValI < MVT::LAST_VALUETYPE &&
597            MemI < MVT::LAST_VALUETYPE && "Table isn't big enough!");
598     return (LegalizeAction)LoadExtActions[ValI][MemI][ExtType];
599   }
600
601   /// Return true if the specified load with extension is legal on this target.
602   bool isLoadExtLegal(unsigned ExtType, EVT ValVT, EVT MemVT) const {
603     return ValVT.isSimple() && MemVT.isSimple() &&
604       getLoadExtAction(ExtType, ValVT, MemVT) == Legal;
605   }
606
607   /// Return true if the specified load with extension is legal or custom
608   /// on this target.
609   bool isLoadExtLegalOrCustom(unsigned ExtType, EVT ValVT, EVT MemVT) const {
610     return ValVT.isSimple() && MemVT.isSimple() &&
611       (getLoadExtAction(ExtType, ValVT, MemVT) == Legal ||
612        getLoadExtAction(ExtType, ValVT, MemVT) == Custom);
613   }
614
615   /// Return how this store with truncation should be treated: either it is
616   /// legal, needs to be promoted to a larger size, needs to be expanded to some
617   /// other code sequence, or the target has a custom expander for it.
618   LegalizeAction getTruncStoreAction(EVT ValVT, EVT MemVT) const {
619     if (ValVT.isExtended() || MemVT.isExtended()) return Expand;
620     unsigned ValI = (unsigned) ValVT.getSimpleVT().SimpleTy;
621     unsigned MemI = (unsigned) MemVT.getSimpleVT().SimpleTy;
622     assert(ValI < MVT::LAST_VALUETYPE && MemI < MVT::LAST_VALUETYPE &&
623            "Table isn't big enough!");
624     return (LegalizeAction)TruncStoreActions[ValI][MemI];
625   }
626
627   /// Return true if the specified store with truncation is legal on this
628   /// target.
629   bool isTruncStoreLegal(EVT ValVT, EVT MemVT) const {
630     return isTypeLegal(ValVT) && MemVT.isSimple() &&
631       getTruncStoreAction(ValVT.getSimpleVT(), MemVT.getSimpleVT()) == Legal;
632   }
633
634   /// Return how the indexed load should be treated: either it is legal, needs
635   /// to be promoted to a larger size, needs to be expanded to some other code
636   /// sequence, or the target has a custom expander for it.
637   LegalizeAction
638   getIndexedLoadAction(unsigned IdxMode, MVT VT) const {
639     assert(IdxMode < ISD::LAST_INDEXED_MODE && VT.isValid() &&
640            "Table isn't big enough!");
641     unsigned Ty = (unsigned)VT.SimpleTy;
642     return (LegalizeAction)((IndexedModeActions[Ty][IdxMode] & 0xf0) >> 4);
643   }
644
645   /// Return true if the specified indexed load is legal on this target.
646   bool isIndexedLoadLegal(unsigned IdxMode, EVT VT) const {
647     return VT.isSimple() &&
648       (getIndexedLoadAction(IdxMode, VT.getSimpleVT()) == Legal ||
649        getIndexedLoadAction(IdxMode, VT.getSimpleVT()) == Custom);
650   }
651
652   /// Return how the indexed store should be treated: either it is legal, needs
653   /// to be promoted to a larger size, needs to be expanded to some other code
654   /// sequence, or the target has a custom expander for it.
655   LegalizeAction
656   getIndexedStoreAction(unsigned IdxMode, MVT VT) const {
657     assert(IdxMode < ISD::LAST_INDEXED_MODE && VT.isValid() &&
658            "Table isn't big enough!");
659     unsigned Ty = (unsigned)VT.SimpleTy;
660     return (LegalizeAction)(IndexedModeActions[Ty][IdxMode] & 0x0f);
661   }
662
663   /// Return true if the specified indexed load is legal on this target.
664   bool isIndexedStoreLegal(unsigned IdxMode, EVT VT) const {
665     return VT.isSimple() &&
666       (getIndexedStoreAction(IdxMode, VT.getSimpleVT()) == Legal ||
667        getIndexedStoreAction(IdxMode, VT.getSimpleVT()) == Custom);
668   }
669
670   /// Return how the condition code should be treated: either it is legal, needs
671   /// to be expanded to some other code sequence, or the target has a custom
672   /// expander for it.
673   LegalizeAction
674   getCondCodeAction(ISD::CondCode CC, MVT VT) const {
675     assert((unsigned)CC < array_lengthof(CondCodeActions) &&
676            ((unsigned)VT.SimpleTy >> 4) < array_lengthof(CondCodeActions[0]) &&
677            "Table isn't big enough!");
678     // See setCondCodeAction for how this is encoded.
679     uint32_t Shift = 4 * (VT.SimpleTy & 0x7);
680     uint32_t Value = CondCodeActions[CC][VT.SimpleTy >> 3];
681     LegalizeAction Action = (LegalizeAction) ((Value >> Shift) & 0xF);
682     assert(Action != Promote && "Can't promote condition code!");
683     return Action;
684   }
685
686   /// Return true if the specified condition code is legal on this target.
687   bool isCondCodeLegal(ISD::CondCode CC, MVT VT) const {
688     return
689       getCondCodeAction(CC, VT) == Legal ||
690       getCondCodeAction(CC, VT) == Custom;
691   }
692
693
694   /// If the action for this operation is to promote, this method returns the
695   /// ValueType to promote to.
696   MVT getTypeToPromoteTo(unsigned Op, MVT VT) const {
697     assert(getOperationAction(Op, VT) == Promote &&
698            "This operation isn't promoted!");
699
700     // See if this has an explicit type specified.
701     std::map<std::pair<unsigned, MVT::SimpleValueType>,
702              MVT::SimpleValueType>::const_iterator PTTI =
703       PromoteToType.find(std::make_pair(Op, VT.SimpleTy));
704     if (PTTI != PromoteToType.end()) return PTTI->second;
705
706     assert((VT.isInteger() || VT.isFloatingPoint()) &&
707            "Cannot autopromote this type, add it with AddPromotedToType.");
708
709     MVT NVT = VT;
710     do {
711       NVT = (MVT::SimpleValueType)(NVT.SimpleTy+1);
712       assert(NVT.isInteger() == VT.isInteger() && NVT != MVT::isVoid &&
713              "Didn't find type to promote to!");
714     } while (!isTypeLegal(NVT) ||
715               getOperationAction(Op, NVT) == Promote);
716     return NVT;
717   }
718
719   /// Return the EVT corresponding to this LLVM type.  This is fixed by the LLVM
720   /// operations except for the pointer size.  If AllowUnknown is true, this
721   /// will return MVT::Other for types with no EVT counterpart (e.g. structs),
722   /// otherwise it will assert.
723   EVT getValueType(const DataLayout &DL, Type *Ty,
724                    bool AllowUnknown = false) const {
725     // Lower scalar pointers to native pointer types.
726     if (PointerType *PTy = dyn_cast<PointerType>(Ty))
727       return getPointerTy(DL, PTy->getAddressSpace());
728
729     if (Ty->isVectorTy()) {
730       VectorType *VTy = cast<VectorType>(Ty);
731       Type *Elm = VTy->getElementType();
732       // Lower vectors of pointers to native pointer types.
733       if (PointerType *PT = dyn_cast<PointerType>(Elm)) {
734         EVT PointerTy(getPointerTy(DL, PT->getAddressSpace()));
735         Elm = PointerTy.getTypeForEVT(Ty->getContext());
736       }
737
738       return EVT::getVectorVT(Ty->getContext(), EVT::getEVT(Elm, false),
739                        VTy->getNumElements());
740     }
741     return EVT::getEVT(Ty, AllowUnknown);
742   }
743
744   /// Return the MVT corresponding to this LLVM type. See getValueType.
745   MVT getSimpleValueType(const DataLayout &DL, Type *Ty,
746                          bool AllowUnknown = false) const {
747     return getValueType(DL, Ty, AllowUnknown).getSimpleVT();
748   }
749
750   /// Return the desired alignment for ByVal or InAlloca aggregate function
751   /// arguments in the caller parameter area.  This is the actual alignment, not
752   /// its logarithm.
753   virtual unsigned getByValTypeAlignment(Type *Ty, const DataLayout &DL) const;
754
755   /// Return the type of registers that this ValueType will eventually require.
756   MVT getRegisterType(MVT VT) const {
757     assert((unsigned)VT.SimpleTy < array_lengthof(RegisterTypeForVT));
758     return RegisterTypeForVT[VT.SimpleTy];
759   }
760
761   /// Return the type of registers that this ValueType will eventually require.
762   MVT getRegisterType(LLVMContext &Context, EVT VT) const {
763     if (VT.isSimple()) {
764       assert((unsigned)VT.getSimpleVT().SimpleTy <
765                 array_lengthof(RegisterTypeForVT));
766       return RegisterTypeForVT[VT.getSimpleVT().SimpleTy];
767     }
768     if (VT.isVector()) {
769       EVT VT1;
770       MVT RegisterVT;
771       unsigned NumIntermediates;
772       (void)getVectorTypeBreakdown(Context, VT, VT1,
773                                    NumIntermediates, RegisterVT);
774       return RegisterVT;
775     }
776     if (VT.isInteger()) {
777       return getRegisterType(Context, getTypeToTransformTo(Context, VT));
778     }
779     llvm_unreachable("Unsupported extended type!");
780   }
781
782   /// Return the number of registers that this ValueType will eventually
783   /// require.
784   ///
785   /// This is one for any types promoted to live in larger registers, but may be
786   /// more than one for types (like i64) that are split into pieces.  For types
787   /// like i140, which are first promoted then expanded, it is the number of
788   /// registers needed to hold all the bits of the original type.  For an i140
789   /// on a 32 bit machine this means 5 registers.
790   unsigned getNumRegisters(LLVMContext &Context, EVT VT) const {
791     if (VT.isSimple()) {
792       assert((unsigned)VT.getSimpleVT().SimpleTy <
793                 array_lengthof(NumRegistersForVT));
794       return NumRegistersForVT[VT.getSimpleVT().SimpleTy];
795     }
796     if (VT.isVector()) {
797       EVT VT1;
798       MVT VT2;
799       unsigned NumIntermediates;
800       return getVectorTypeBreakdown(Context, VT, VT1, NumIntermediates, VT2);
801     }
802     if (VT.isInteger()) {
803       unsigned BitWidth = VT.getSizeInBits();
804       unsigned RegWidth = getRegisterType(Context, VT).getSizeInBits();
805       return (BitWidth + RegWidth - 1) / RegWidth;
806     }
807     llvm_unreachable("Unsupported extended type!");
808   }
809
810   /// If true, then instruction selection should seek to shrink the FP constant
811   /// of the specified type to a smaller type in order to save space and / or
812   /// reduce runtime.
813   virtual bool ShouldShrinkFPConstant(EVT) const { return true; }
814
815   // Return true if it is profitable to reduce the given load node to a smaller
816   // type.
817   //
818   // e.g. (i16 (trunc (i32 (load x))) -> i16 load x should be performed
819   virtual bool shouldReduceLoadWidth(SDNode *Load,
820                                      ISD::LoadExtType ExtTy,
821                                      EVT NewVT) const {
822     return true;
823   }
824
825   /// When splitting a value of the specified type into parts, does the Lo
826   /// or Hi part come first?  This usually follows the endianness, except
827   /// for ppcf128, where the Hi part always comes first.
828   bool hasBigEndianPartOrdering(EVT VT, const DataLayout &DL) const {
829     return DL.isBigEndian() || VT == MVT::ppcf128;
830   }
831
832   /// If true, the target has custom DAG combine transformations that it can
833   /// perform for the specified node.
834   bool hasTargetDAGCombine(ISD::NodeType NT) const {
835     assert(unsigned(NT >> 3) < array_lengthof(TargetDAGCombineArray));
836     return TargetDAGCombineArray[NT >> 3] & (1 << (NT&7));
837   }
838
839   unsigned getGatherAllAliasesMaxDepth() const {
840     return GatherAllAliasesMaxDepth;
841   }
842
843   /// \brief Get maximum # of store operations permitted for llvm.memset
844   ///
845   /// This function returns the maximum number of store operations permitted
846   /// to replace a call to llvm.memset. The value is set by the target at the
847   /// performance threshold for such a replacement. If OptSize is true,
848   /// return the limit for functions that have OptSize attribute.
849   unsigned getMaxStoresPerMemset(bool OptSize) const {
850     return OptSize ? MaxStoresPerMemsetOptSize : MaxStoresPerMemset;
851   }
852
853   /// \brief Get maximum # of store operations permitted for llvm.memcpy
854   ///
855   /// This function returns the maximum number of store operations permitted
856   /// to replace a call to llvm.memcpy. The value is set by the target at the
857   /// performance threshold for such a replacement. If OptSize is true,
858   /// return the limit for functions that have OptSize attribute.
859   unsigned getMaxStoresPerMemcpy(bool OptSize) const {
860     return OptSize ? MaxStoresPerMemcpyOptSize : MaxStoresPerMemcpy;
861   }
862
863   /// \brief Get maximum # of store operations permitted for llvm.memmove
864   ///
865   /// This function returns the maximum number of store operations permitted
866   /// to replace a call to llvm.memmove. The value is set by the target at the
867   /// performance threshold for such a replacement. If OptSize is true,
868   /// return the limit for functions that have OptSize attribute.
869   unsigned getMaxStoresPerMemmove(bool OptSize) const {
870     return OptSize ? MaxStoresPerMemmoveOptSize : MaxStoresPerMemmove;
871   }
872
873   /// \brief Determine if the target supports unaligned memory accesses.
874   ///
875   /// This function returns true if the target allows unaligned memory accesses
876   /// of the specified type in the given address space. If true, it also returns
877   /// whether the unaligned memory access is "fast" in the last argument by
878   /// reference. This is used, for example, in situations where an array
879   /// copy/move/set is converted to a sequence of store operations. Its use
880   /// helps to ensure that such replacements don't generate code that causes an
881   /// alignment error (trap) on the target machine.
882   virtual bool allowsMisalignedMemoryAccesses(EVT,
883                                               unsigned AddrSpace = 0,
884                                               unsigned Align = 1,
885                                               bool * /*Fast*/ = nullptr) const {
886     return false;
887   }
888
889   /// Return true if the target supports a memory access of this type for the
890   /// given address space and alignment. If the access is allowed, the optional
891   /// final parameter returns if the access is also fast (as defined by the
892   /// target).
893   bool allowsMemoryAccess(LLVMContext &Context, const DataLayout &DL, EVT VT,
894                           unsigned AddrSpace = 0, unsigned Alignment = 1,
895                           bool *Fast = nullptr) const;
896
897   /// Returns the target specific optimal type for load and store operations as
898   /// a result of memset, memcpy, and memmove lowering.
899   ///
900   /// If DstAlign is zero that means it's safe to destination alignment can
901   /// satisfy any constraint. Similarly if SrcAlign is zero it means there isn't
902   /// a need to check it against alignment requirement, probably because the
903   /// source does not need to be loaded. If 'IsMemset' is true, that means it's
904   /// expanding a memset. If 'ZeroMemset' is true, that means it's a memset of
905   /// zero. 'MemcpyStrSrc' indicates whether the memcpy source is constant so it
906   /// does not need to be loaded.  It returns EVT::Other if the type should be
907   /// determined using generic target-independent logic.
908   virtual EVT getOptimalMemOpType(uint64_t /*Size*/,
909                                   unsigned /*DstAlign*/, unsigned /*SrcAlign*/,
910                                   bool /*IsMemset*/,
911                                   bool /*ZeroMemset*/,
912                                   bool /*MemcpyStrSrc*/,
913                                   MachineFunction &/*MF*/) const {
914     return MVT::Other;
915   }
916
917   /// Returns true if it's safe to use load / store of the specified type to
918   /// expand memcpy / memset inline.
919   ///
920   /// This is mostly true for all types except for some special cases. For
921   /// example, on X86 targets without SSE2 f64 load / store are done with fldl /
922   /// fstpl which also does type conversion. Note the specified type doesn't
923   /// have to be legal as the hook is used before type legalization.
924   virtual bool isSafeMemOpType(MVT /*VT*/) const { return true; }
925
926   /// Determine if we should use _setjmp or setjmp to implement llvm.setjmp.
927   bool usesUnderscoreSetJmp() const {
928     return UseUnderscoreSetJmp;
929   }
930
931   /// Determine if we should use _longjmp or longjmp to implement llvm.longjmp.
932   bool usesUnderscoreLongJmp() const {
933     return UseUnderscoreLongJmp;
934   }
935
936   /// Return integer threshold on number of blocks to use jump tables rather
937   /// than if sequence.
938   int getMinimumJumpTableEntries() const {
939     return MinimumJumpTableEntries;
940   }
941
942   /// If a physical register, this specifies the register that
943   /// llvm.savestack/llvm.restorestack should save and restore.
944   unsigned getStackPointerRegisterToSaveRestore() const {
945     return StackPointerRegisterToSaveRestore;
946   }
947
948   /// If a physical register, this returns the register that receives the
949   /// exception address on entry to an EH pad.
950   virtual unsigned
951   getExceptionPointerRegister(const Constant *PersonalityFn) const {
952     // 0 is guaranteed to be the NoRegister value on all targets
953     return 0;
954   }
955
956   /// If a physical register, this returns the register that receives the
957   /// exception typeid on entry to a landing pad.
958   virtual unsigned
959   getExceptionSelectorRegister(const Constant *PersonalityFn) const {
960     // 0 is guaranteed to be the NoRegister value on all targets
961     return 0;
962   }
963
964   /// Returns the target's jmp_buf size in bytes (if never set, the default is
965   /// 200)
966   unsigned getJumpBufSize() const {
967     return JumpBufSize;
968   }
969
970   /// Returns the target's jmp_buf alignment in bytes (if never set, the default
971   /// is 0)
972   unsigned getJumpBufAlignment() const {
973     return JumpBufAlignment;
974   }
975
976   /// Return the minimum stack alignment of an argument.
977   unsigned getMinStackArgumentAlignment() const {
978     return MinStackArgumentAlignment;
979   }
980
981   /// Return the minimum function alignment.
982   unsigned getMinFunctionAlignment() const {
983     return MinFunctionAlignment;
984   }
985
986   /// Return the preferred function alignment.
987   unsigned getPrefFunctionAlignment() const {
988     return PrefFunctionAlignment;
989   }
990
991   /// Return the preferred loop alignment.
992   virtual unsigned getPrefLoopAlignment(MachineLoop *ML = nullptr) const {
993     return PrefLoopAlignment;
994   }
995
996   /// Return whether the DAG builder should automatically insert fences and
997   /// reduce ordering for atomics.
998   bool getInsertFencesForAtomic() const {
999     return InsertFencesForAtomic;
1000   }
1001
1002   /// Return true if the target stores stack protector cookies at a fixed offset
1003   /// in some non-standard address space, and populates the address space and
1004   /// offset as appropriate.
1005   virtual bool getStackCookieLocation(unsigned &/*AddressSpace*/,
1006                                       unsigned &/*Offset*/) const {
1007     return false;
1008   }
1009
1010   /// If the target has a standard location for the unsafe stack pointer,
1011   /// returns the address of that location. Otherwise, returns nullptr.
1012   virtual Value *getSafeStackPointerLocation(IRBuilder<> &IRB) const;
1013
1014   /// Returns true if a cast between SrcAS and DestAS is a noop.
1015   virtual bool isNoopAddrSpaceCast(unsigned SrcAS, unsigned DestAS) const {
1016     return false;
1017   }
1018
1019   /// Return true if the pointer arguments to CI should be aligned by aligning
1020   /// the object whose address is being passed. If so then MinSize is set to the
1021   /// minimum size the object must be to be aligned and PrefAlign is set to the
1022   /// preferred alignment.
1023   virtual bool shouldAlignPointerArgs(CallInst * /*CI*/, unsigned & /*MinSize*/,
1024                                       unsigned & /*PrefAlign*/) const {
1025     return false;
1026   }
1027
1028   //===--------------------------------------------------------------------===//
1029   /// \name Helpers for TargetTransformInfo implementations
1030   /// @{
1031
1032   /// Get the ISD node that corresponds to the Instruction class opcode.
1033   int InstructionOpcodeToISD(unsigned Opcode) const;
1034
1035   /// Estimate the cost of type-legalization and the legalized type.
1036   std::pair<int, MVT> getTypeLegalizationCost(const DataLayout &DL,
1037                                               Type *Ty) const;
1038
1039   /// @}
1040
1041   //===--------------------------------------------------------------------===//
1042   /// \name Helpers for atomic expansion.
1043   /// @{
1044
1045   /// Perform a load-linked operation on Addr, returning a "Value *" with the
1046   /// corresponding pointee type. This may entail some non-trivial operations to
1047   /// truncate or reconstruct types that will be illegal in the backend. See
1048   /// ARMISelLowering for an example implementation.
1049   virtual Value *emitLoadLinked(IRBuilder<> &Builder, Value *Addr,
1050                                 AtomicOrdering Ord) const {
1051     llvm_unreachable("Load linked unimplemented on this target");
1052   }
1053
1054   /// Perform a store-conditional operation to Addr. Return the status of the
1055   /// store. This should be 0 if the store succeeded, non-zero otherwise.
1056   virtual Value *emitStoreConditional(IRBuilder<> &Builder, Value *Val,
1057                                       Value *Addr, AtomicOrdering Ord) const {
1058     llvm_unreachable("Store conditional unimplemented on this target");
1059   }
1060
1061   /// Inserts in the IR a target-specific intrinsic specifying a fence.
1062   /// It is called by AtomicExpandPass before expanding an
1063   ///   AtomicRMW/AtomicCmpXchg/AtomicStore/AtomicLoad.
1064   /// RMW and CmpXchg set both IsStore and IsLoad to true.
1065   /// This function should either return a nullptr, or a pointer to an IR-level
1066   ///   Instruction*. Even complex fence sequences can be represented by a
1067   ///   single Instruction* through an intrinsic to be lowered later.
1068   /// Backends with !getInsertFencesForAtomic() should keep a no-op here.
1069   /// Backends should override this method to produce target-specific intrinsic
1070   ///   for their fences.
1071   /// FIXME: Please note that the default implementation here in terms of
1072   ///   IR-level fences exists for historical/compatibility reasons and is
1073   ///   *unsound* ! Fences cannot, in general, be used to restore sequential
1074   ///   consistency. For example, consider the following example:
1075   /// atomic<int> x = y = 0;
1076   /// int r1, r2, r3, r4;
1077   /// Thread 0:
1078   ///   x.store(1);
1079   /// Thread 1:
1080   ///   y.store(1);
1081   /// Thread 2:
1082   ///   r1 = x.load();
1083   ///   r2 = y.load();
1084   /// Thread 3:
1085   ///   r3 = y.load();
1086   ///   r4 = x.load();
1087   ///  r1 = r3 = 1 and r2 = r4 = 0 is impossible as long as the accesses are all
1088   ///  seq_cst. But if they are lowered to monotonic accesses, no amount of
1089   ///  IR-level fences can prevent it.
1090   /// @{
1091   virtual Instruction *emitLeadingFence(IRBuilder<> &Builder,
1092                                         AtomicOrdering Ord, bool IsStore,
1093                                         bool IsLoad) const {
1094     if (!getInsertFencesForAtomic())
1095       return nullptr;
1096
1097     if (isAtLeastRelease(Ord) && IsStore)
1098       return Builder.CreateFence(Ord);
1099     else
1100       return nullptr;
1101   }
1102
1103   virtual Instruction *emitTrailingFence(IRBuilder<> &Builder,
1104                                          AtomicOrdering Ord, bool IsStore,
1105                                          bool IsLoad) const {
1106     if (!getInsertFencesForAtomic())
1107       return nullptr;
1108
1109     if (isAtLeastAcquire(Ord))
1110       return Builder.CreateFence(Ord);
1111     else
1112       return nullptr;
1113   }
1114   /// @}
1115
1116   // Emits code that executes when the comparison result in the ll/sc
1117   // expansion of a cmpxchg instruction is such that the store-conditional will
1118   // not execute.  This makes it possible to balance out the load-linked with
1119   // a dedicated instruction, if desired.
1120   // E.g., on ARM, if ldrex isn't followed by strex, the exclusive monitor would
1121   // be unnecessarily held, except if clrex, inserted by this hook, is executed.
1122   virtual void emitAtomicCmpXchgNoStoreLLBalance(IRBuilder<> &Builder) const {}
1123
1124   /// Returns true if the given (atomic) store should be expanded by the
1125   /// IR-level AtomicExpand pass into an "atomic xchg" which ignores its input.
1126   virtual bool shouldExpandAtomicStoreInIR(StoreInst *SI) const {
1127     return false;
1128   }
1129
1130   /// Returns true if arguments should be sign-extended in lib calls.
1131   virtual bool shouldSignExtendTypeInLibCall(EVT Type, bool IsSigned) const {
1132     return IsSigned;
1133   }
1134
1135   /// Returns how the given (atomic) load should be expanded by the
1136   /// IR-level AtomicExpand pass.
1137   virtual AtomicExpansionKind shouldExpandAtomicLoadInIR(LoadInst *LI) const {
1138     return AtomicExpansionKind::None;
1139   }
1140
1141   /// Returns true if the given atomic cmpxchg should be expanded by the
1142   /// IR-level AtomicExpand pass into a load-linked/store-conditional sequence
1143   /// (through emitLoadLinked() and emitStoreConditional()).
1144   virtual bool shouldExpandAtomicCmpXchgInIR(AtomicCmpXchgInst *AI) const {
1145     return false;
1146   }
1147
1148   /// Returns how the IR-level AtomicExpand pass should expand the given
1149   /// AtomicRMW, if at all. Default is to never expand.
1150   virtual AtomicExpansionKind shouldExpandAtomicRMWInIR(AtomicRMWInst *) const {
1151     return AtomicExpansionKind::None;
1152   }
1153
1154   /// On some platforms, an AtomicRMW that never actually modifies the value
1155   /// (such as fetch_add of 0) can be turned into a fence followed by an
1156   /// atomic load. This may sound useless, but it makes it possible for the
1157   /// processor to keep the cacheline shared, dramatically improving
1158   /// performance. And such idempotent RMWs are useful for implementing some
1159   /// kinds of locks, see for example (justification + benchmarks):
1160   /// http://www.hpl.hp.com/techreports/2012/HPL-2012-68.pdf
1161   /// This method tries doing that transformation, returning the atomic load if
1162   /// it succeeds, and nullptr otherwise.
1163   /// If shouldExpandAtomicLoadInIR returns true on that load, it will undergo
1164   /// another round of expansion.
1165   virtual LoadInst *
1166   lowerIdempotentRMWIntoFencedLoad(AtomicRMWInst *RMWI) const {
1167     return nullptr;
1168   }
1169
1170   /// Returns true if we should normalize
1171   /// select(N0&N1, X, Y) => select(N0, select(N1, X, Y), Y) and
1172   /// select(N0|N1, X, Y) => select(N0, select(N1, X, Y, Y)) if it is likely
1173   /// that it saves us from materializing N0 and N1 in an integer register.
1174   /// Targets that are able to perform and/or on flags should return false here.
1175   virtual bool shouldNormalizeToSelectSequence(LLVMContext &Context,
1176                                                EVT VT) const {
1177     // If a target has multiple condition registers, then it likely has logical
1178     // operations on those registers.
1179     if (hasMultipleConditionRegisters())
1180       return false;
1181     // Only do the transform if the value won't be split into multiple
1182     // registers.
1183     LegalizeTypeAction Action = getTypeAction(Context, VT);
1184     return Action != TypeExpandInteger && Action != TypeExpandFloat &&
1185       Action != TypeSplitVector;
1186   }
1187
1188   //===--------------------------------------------------------------------===//
1189   // TargetLowering Configuration Methods - These methods should be invoked by
1190   // the derived class constructor to configure this object for the target.
1191   //
1192 protected:
1193   /// Specify how the target extends the result of integer and floating point
1194   /// boolean values from i1 to a wider type.  See getBooleanContents.
1195   void setBooleanContents(BooleanContent Ty) {
1196     BooleanContents = Ty;
1197     BooleanFloatContents = Ty;
1198   }
1199
1200   /// Specify how the target extends the result of integer and floating point
1201   /// boolean values from i1 to a wider type.  See getBooleanContents.
1202   void setBooleanContents(BooleanContent IntTy, BooleanContent FloatTy) {
1203     BooleanContents = IntTy;
1204     BooleanFloatContents = FloatTy;
1205   }
1206
1207   /// Specify how the target extends the result of a vector boolean value from a
1208   /// vector of i1 to a wider type.  See getBooleanContents.
1209   void setBooleanVectorContents(BooleanContent Ty) {
1210     BooleanVectorContents = Ty;
1211   }
1212
1213   /// Specify the target scheduling preference.
1214   void setSchedulingPreference(Sched::Preference Pref) {
1215     SchedPreferenceInfo = Pref;
1216   }
1217
1218   /// Indicate whether this target prefers to use _setjmp to implement
1219   /// llvm.setjmp or the version without _.  Defaults to false.
1220   void setUseUnderscoreSetJmp(bool Val) {
1221     UseUnderscoreSetJmp = Val;
1222   }
1223
1224   /// Indicate whether this target prefers to use _longjmp to implement
1225   /// llvm.longjmp or the version without _.  Defaults to false.
1226   void setUseUnderscoreLongJmp(bool Val) {
1227     UseUnderscoreLongJmp = Val;
1228   }
1229
1230   /// Indicate the number of blocks to generate jump tables rather than if
1231   /// sequence.
1232   void setMinimumJumpTableEntries(int Val) {
1233     MinimumJumpTableEntries = Val;
1234   }
1235
1236   /// If set to a physical register, this specifies the register that
1237   /// llvm.savestack/llvm.restorestack should save and restore.
1238   void setStackPointerRegisterToSaveRestore(unsigned R) {
1239     StackPointerRegisterToSaveRestore = R;
1240   }
1241
1242   /// Tells the code generator not to expand operations into sequences that use
1243   /// the select operations if possible.
1244   void setSelectIsExpensive(bool isExpensive = true) {
1245     SelectIsExpensive = isExpensive;
1246   }
1247
1248   /// Tells the code generator that the target has multiple (allocatable)
1249   /// condition registers that can be used to store the results of comparisons
1250   /// for use by selects and conditional branches. With multiple condition
1251   /// registers, the code generator will not aggressively sink comparisons into
1252   /// the blocks of their users.
1253   void setHasMultipleConditionRegisters(bool hasManyRegs = true) {
1254     HasMultipleConditionRegisters = hasManyRegs;
1255   }
1256
1257   /// Tells the code generator that the target has BitExtract instructions.
1258   /// The code generator will aggressively sink "shift"s into the blocks of
1259   /// their users if the users will generate "and" instructions which can be
1260   /// combined with "shift" to BitExtract instructions.
1261   void setHasExtractBitsInsn(bool hasExtractInsn = true) {
1262     HasExtractBitsInsn = hasExtractInsn;
1263   }
1264
1265   /// Tells the code generator not to expand logic operations on comparison
1266   /// predicates into separate sequences that increase the amount of flow
1267   /// control.
1268   void setJumpIsExpensive(bool isExpensive = true);
1269
1270   /// Tells the code generator that fsqrt is cheap, and should not be replaced
1271   /// with an alternative sequence of instructions.
1272   void setFsqrtIsCheap(bool isCheap = true) { FsqrtIsCheap = isCheap; }
1273
1274   /// Tells the code generator that this target supports floating point
1275   /// exceptions and cares about preserving floating point exception behavior.
1276   void setHasFloatingPointExceptions(bool FPExceptions = true) {
1277     HasFloatingPointExceptions = FPExceptions;
1278   }
1279
1280   /// Tells the code generator which bitwidths to bypass.
1281   void addBypassSlowDiv(unsigned int SlowBitWidth, unsigned int FastBitWidth) {
1282     BypassSlowDivWidths[SlowBitWidth] = FastBitWidth;
1283   }
1284
1285   /// Add the specified register class as an available regclass for the
1286   /// specified value type. This indicates the selector can handle values of
1287   /// that class natively.
1288   void addRegisterClass(MVT VT, const TargetRegisterClass *RC) {
1289     assert((unsigned)VT.SimpleTy < array_lengthof(RegClassForVT));
1290     AvailableRegClasses.push_back(std::make_pair(VT, RC));
1291     RegClassForVT[VT.SimpleTy] = RC;
1292   }
1293
1294   /// Remove all register classes.
1295   void clearRegisterClasses() {
1296     std::fill(std::begin(RegClassForVT), std::end(RegClassForVT), nullptr);
1297
1298     AvailableRegClasses.clear();
1299   }
1300
1301   /// \brief Remove all operation actions.
1302   void clearOperationActions() {
1303   }
1304
1305   /// Return the largest legal super-reg register class of the register class
1306   /// for the specified type and its associated "cost".
1307   virtual std::pair<const TargetRegisterClass *, uint8_t>
1308   findRepresentativeClass(const TargetRegisterInfo *TRI, MVT VT) const;
1309
1310   /// Once all of the register classes are added, this allows us to compute
1311   /// derived properties we expose.
1312   void computeRegisterProperties(const TargetRegisterInfo *TRI);
1313
1314   /// Indicate that the specified operation does not work with the specified
1315   /// type and indicate what to do about it.
1316   void setOperationAction(unsigned Op, MVT VT,
1317                           LegalizeAction Action) {
1318     assert(Op < array_lengthof(OpActions[0]) && "Table isn't big enough!");
1319     OpActions[(unsigned)VT.SimpleTy][Op] = (uint8_t)Action;
1320   }
1321
1322   /// Indicate that the specified load with extension does not work with the
1323   /// specified type and indicate what to do about it.
1324   void setLoadExtAction(unsigned ExtType, MVT ValVT, MVT MemVT,
1325                         LegalizeAction Action) {
1326     assert(ExtType < ISD::LAST_LOADEXT_TYPE && ValVT.isValid() &&
1327            MemVT.isValid() && "Table isn't big enough!");
1328     LoadExtActions[ValVT.SimpleTy][MemVT.SimpleTy][ExtType] = (uint8_t)Action;
1329   }
1330
1331   /// Indicate that the specified truncating store does not work with the
1332   /// specified type and indicate what to do about it.
1333   void setTruncStoreAction(MVT ValVT, MVT MemVT,
1334                            LegalizeAction Action) {
1335     assert(ValVT.isValid() && MemVT.isValid() && "Table isn't big enough!");
1336     TruncStoreActions[ValVT.SimpleTy][MemVT.SimpleTy] = (uint8_t)Action;
1337   }
1338
1339   /// Indicate that the specified indexed load does or does not work with the
1340   /// specified type and indicate what to do abort it.
1341   ///
1342   /// NOTE: All indexed mode loads are initialized to Expand in
1343   /// TargetLowering.cpp
1344   void setIndexedLoadAction(unsigned IdxMode, MVT VT,
1345                             LegalizeAction Action) {
1346     assert(VT.isValid() && IdxMode < ISD::LAST_INDEXED_MODE &&
1347            (unsigned)Action < 0xf && "Table isn't big enough!");
1348     // Load action are kept in the upper half.
1349     IndexedModeActions[(unsigned)VT.SimpleTy][IdxMode] &= ~0xf0;
1350     IndexedModeActions[(unsigned)VT.SimpleTy][IdxMode] |= ((uint8_t)Action) <<4;
1351   }
1352
1353   /// Indicate that the specified indexed store does or does not work with the
1354   /// specified type and indicate what to do about it.
1355   ///
1356   /// NOTE: All indexed mode stores are initialized to Expand in
1357   /// TargetLowering.cpp
1358   void setIndexedStoreAction(unsigned IdxMode, MVT VT,
1359                              LegalizeAction Action) {
1360     assert(VT.isValid() && IdxMode < ISD::LAST_INDEXED_MODE &&
1361            (unsigned)Action < 0xf && "Table isn't big enough!");
1362     // Store action are kept in the lower half.
1363     IndexedModeActions[(unsigned)VT.SimpleTy][IdxMode] &= ~0x0f;
1364     IndexedModeActions[(unsigned)VT.SimpleTy][IdxMode] |= ((uint8_t)Action);
1365   }
1366
1367   /// Indicate that the specified condition code is or isn't supported on the
1368   /// target and indicate what to do about it.
1369   void setCondCodeAction(ISD::CondCode CC, MVT VT,
1370                          LegalizeAction Action) {
1371     assert(VT.isValid() && (unsigned)CC < array_lengthof(CondCodeActions) &&
1372            "Table isn't big enough!");
1373     assert((unsigned)Action < 0x10 && "too many bits for bitfield array");
1374     /// The lower 3 bits of the SimpleTy index into Nth 4bit set from the 32-bit
1375     /// value and the upper 29 bits index into the second dimension of the array
1376     /// to select what 32-bit value to use.
1377     uint32_t Shift = 4 * (VT.SimpleTy & 0x7);
1378     CondCodeActions[CC][VT.SimpleTy >> 3] &= ~((uint32_t)0xF << Shift);
1379     CondCodeActions[CC][VT.SimpleTy >> 3] |= (uint32_t)Action << Shift;
1380   }
1381
1382   /// If Opc/OrigVT is specified as being promoted, the promotion code defaults
1383   /// to trying a larger integer/fp until it can find one that works. If that
1384   /// default is insufficient, this method can be used by the target to override
1385   /// the default.
1386   void AddPromotedToType(unsigned Opc, MVT OrigVT, MVT DestVT) {
1387     PromoteToType[std::make_pair(Opc, OrigVT.SimpleTy)] = DestVT.SimpleTy;
1388   }
1389
1390   /// Targets should invoke this method for each target independent node that
1391   /// they want to provide a custom DAG combiner for by implementing the
1392   /// PerformDAGCombine virtual method.
1393   void setTargetDAGCombine(ISD::NodeType NT) {
1394     assert(unsigned(NT >> 3) < array_lengthof(TargetDAGCombineArray));
1395     TargetDAGCombineArray[NT >> 3] |= 1 << (NT&7);
1396   }
1397
1398   /// Set the target's required jmp_buf buffer size (in bytes); default is 200
1399   void setJumpBufSize(unsigned Size) {
1400     JumpBufSize = Size;
1401   }
1402
1403   /// Set the target's required jmp_buf buffer alignment (in bytes); default is
1404   /// 0
1405   void setJumpBufAlignment(unsigned Align) {
1406     JumpBufAlignment = Align;
1407   }
1408
1409   /// Set the target's minimum function alignment (in log2(bytes))
1410   void setMinFunctionAlignment(unsigned Align) {
1411     MinFunctionAlignment = Align;
1412   }
1413
1414   /// Set the target's preferred function alignment.  This should be set if
1415   /// there is a performance benefit to higher-than-minimum alignment (in
1416   /// log2(bytes))
1417   void setPrefFunctionAlignment(unsigned Align) {
1418     PrefFunctionAlignment = Align;
1419   }
1420
1421   /// Set the target's preferred loop alignment. Default alignment is zero, it
1422   /// means the target does not care about loop alignment.  The alignment is
1423   /// specified in log2(bytes). The target may also override
1424   /// getPrefLoopAlignment to provide per-loop values.
1425   void setPrefLoopAlignment(unsigned Align) {
1426     PrefLoopAlignment = Align;
1427   }
1428
1429   /// Set the minimum stack alignment of an argument (in log2(bytes)).
1430   void setMinStackArgumentAlignment(unsigned Align) {
1431     MinStackArgumentAlignment = Align;
1432   }
1433
1434   /// Set if the DAG builder should automatically insert fences and reduce the
1435   /// order of atomic memory operations to Monotonic.
1436   void setInsertFencesForAtomic(bool fence) {
1437     InsertFencesForAtomic = fence;
1438   }
1439
1440 public:
1441   //===--------------------------------------------------------------------===//
1442   // Addressing mode description hooks (used by LSR etc).
1443   //
1444
1445   /// CodeGenPrepare sinks address calculations into the same BB as Load/Store
1446   /// instructions reading the address. This allows as much computation as
1447   /// possible to be done in the address mode for that operand. This hook lets
1448   /// targets also pass back when this should be done on intrinsics which
1449   /// load/store.
1450   virtual bool GetAddrModeArguments(IntrinsicInst * /*I*/,
1451                                     SmallVectorImpl<Value*> &/*Ops*/,
1452                                     Type *&/*AccessTy*/,
1453                                     unsigned AddrSpace = 0) const {
1454     return false;
1455   }
1456
1457   /// This represents an addressing mode of:
1458   ///    BaseGV + BaseOffs + BaseReg + Scale*ScaleReg
1459   /// If BaseGV is null,  there is no BaseGV.
1460   /// If BaseOffs is zero, there is no base offset.
1461   /// If HasBaseReg is false, there is no base register.
1462   /// If Scale is zero, there is no ScaleReg.  Scale of 1 indicates a reg with
1463   /// no scale.
1464   struct AddrMode {
1465     GlobalValue *BaseGV;
1466     int64_t      BaseOffs;
1467     bool         HasBaseReg;
1468     int64_t      Scale;
1469     AddrMode() : BaseGV(nullptr), BaseOffs(0), HasBaseReg(false), Scale(0) {}
1470   };
1471
1472   /// Return true if the addressing mode represented by AM is legal for this
1473   /// target, for a load/store of the specified type.
1474   ///
1475   /// The type may be VoidTy, in which case only return true if the addressing
1476   /// mode is legal for a load/store of any legal type.  TODO: Handle
1477   /// pre/postinc as well.
1478   ///
1479   /// If the address space cannot be determined, it will be -1.
1480   ///
1481   /// TODO: Remove default argument
1482   virtual bool isLegalAddressingMode(const DataLayout &DL, const AddrMode &AM,
1483                                      Type *Ty, unsigned AddrSpace) const;
1484
1485   /// \brief Return the cost of the scaling factor used in the addressing mode
1486   /// represented by AM for this target, for a load/store of the specified type.
1487   ///
1488   /// If the AM is supported, the return value must be >= 0.
1489   /// If the AM is not supported, it returns a negative value.
1490   /// TODO: Handle pre/postinc as well.
1491   /// TODO: Remove default argument
1492   virtual int getScalingFactorCost(const DataLayout &DL, const AddrMode &AM,
1493                                    Type *Ty, unsigned AS = 0) const {
1494     // Default: assume that any scaling factor used in a legal AM is free.
1495     if (isLegalAddressingMode(DL, AM, Ty, AS))
1496       return 0;
1497     return -1;
1498   }
1499
1500   /// Return true if the specified immediate is legal icmp immediate, that is
1501   /// the target has icmp instructions which can compare a register against the
1502   /// immediate without having to materialize the immediate into a register.
1503   virtual bool isLegalICmpImmediate(int64_t) const {
1504     return true;
1505   }
1506
1507   /// Return true if the specified immediate is legal add immediate, that is the
1508   /// target has add instructions which can add a register with the immediate
1509   /// without having to materialize the immediate into a register.
1510   virtual bool isLegalAddImmediate(int64_t) const {
1511     return true;
1512   }
1513
1514   /// Return true if it's significantly cheaper to shift a vector by a uniform
1515   /// scalar than by an amount which will vary across each lane. On x86, for
1516   /// example, there is a "psllw" instruction for the former case, but no simple
1517   /// instruction for a general "a << b" operation on vectors.
1518   virtual bool isVectorShiftByScalarCheap(Type *Ty) const {
1519     return false;
1520   }
1521
1522   /// Return true if it's free to truncate a value of type FromTy to type
1523   /// ToTy. e.g. On x86 it's free to truncate a i32 value in register EAX to i16
1524   /// by referencing its sub-register AX.
1525   /// Targets must return false when FromTy <= ToTy.
1526   virtual bool isTruncateFree(Type *FromTy, Type *ToTy) const {
1527     return false;
1528   }
1529
1530   /// Return true if a truncation from FromTy to ToTy is permitted when deciding
1531   /// whether a call is in tail position. Typically this means that both results
1532   /// would be assigned to the same register or stack slot, but it could mean
1533   /// the target performs adequate checks of its own before proceeding with the
1534   /// tail call.  Targets must return false when FromTy <= ToTy.
1535   virtual bool allowTruncateForTailCall(Type *FromTy, Type *ToTy) const {
1536     return false;
1537   }
1538
1539   virtual bool isTruncateFree(EVT FromVT, EVT ToVT) const {
1540     return false;
1541   }
1542
1543   virtual bool isProfitableToHoist(Instruction *I) const { return true; }
1544
1545   /// Return true if the extension represented by \p I is free.
1546   /// Unlikely the is[Z|FP]ExtFree family which is based on types,
1547   /// this method can use the context provided by \p I to decide
1548   /// whether or not \p I is free.
1549   /// This method extends the behavior of the is[Z|FP]ExtFree family.
1550   /// In other words, if is[Z|FP]Free returns true, then this method
1551   /// returns true as well. The converse is not true.
1552   /// The target can perform the adequate checks by overriding isExtFreeImpl.
1553   /// \pre \p I must be a sign, zero, or fp extension.
1554   bool isExtFree(const Instruction *I) const {
1555     switch (I->getOpcode()) {
1556     case Instruction::FPExt:
1557       if (isFPExtFree(EVT::getEVT(I->getType())))
1558         return true;
1559       break;
1560     case Instruction::ZExt:
1561       if (isZExtFree(I->getOperand(0)->getType(), I->getType()))
1562         return true;
1563       break;
1564     case Instruction::SExt:
1565       break;
1566     default:
1567       llvm_unreachable("Instruction is not an extension");
1568     }
1569     return isExtFreeImpl(I);
1570   }
1571
1572   /// Return true if any actual instruction that defines a value of type FromTy
1573   /// implicitly zero-extends the value to ToTy in the result register.
1574   ///
1575   /// The function should return true when it is likely that the truncate can
1576   /// be freely folded with an instruction defining a value of FromTy. If
1577   /// the defining instruction is unknown (because you're looking at a
1578   /// function argument, PHI, etc.) then the target may require an
1579   /// explicit truncate, which is not necessarily free, but this function
1580   /// does not deal with those cases.
1581   /// Targets must return false when FromTy >= ToTy.
1582   virtual bool isZExtFree(Type *FromTy, Type *ToTy) const {
1583     return false;
1584   }
1585
1586   virtual bool isZExtFree(EVT FromTy, EVT ToTy) const {
1587     return false;
1588   }
1589
1590   /// Return true if the target supplies and combines to a paired load
1591   /// two loaded values of type LoadedType next to each other in memory.
1592   /// RequiredAlignment gives the minimal alignment constraints that must be met
1593   /// to be able to select this paired load.
1594   ///
1595   /// This information is *not* used to generate actual paired loads, but it is
1596   /// used to generate a sequence of loads that is easier to combine into a
1597   /// paired load.
1598   /// For instance, something like this:
1599   /// a = load i64* addr
1600   /// b = trunc i64 a to i32
1601   /// c = lshr i64 a, 32
1602   /// d = trunc i64 c to i32
1603   /// will be optimized into:
1604   /// b = load i32* addr1
1605   /// d = load i32* addr2
1606   /// Where addr1 = addr2 +/- sizeof(i32).
1607   ///
1608   /// In other words, unless the target performs a post-isel load combining,
1609   /// this information should not be provided because it will generate more
1610   /// loads.
1611   virtual bool hasPairedLoad(Type * /*LoadedType*/,
1612                              unsigned & /*RequiredAligment*/) const {
1613     return false;
1614   }
1615
1616   virtual bool hasPairedLoad(EVT /*LoadedType*/,
1617                              unsigned & /*RequiredAligment*/) const {
1618     return false;
1619   }
1620
1621   /// \brief Get the maximum supported factor for interleaved memory accesses.
1622   /// Default to be the minimum interleave factor: 2.
1623   virtual unsigned getMaxSupportedInterleaveFactor() const { return 2; }
1624
1625   /// \brief Lower an interleaved load to target specific intrinsics. Return
1626   /// true on success.
1627   ///
1628   /// \p LI is the vector load instruction.
1629   /// \p Shuffles is the shufflevector list to DE-interleave the loaded vector.
1630   /// \p Indices is the corresponding indices for each shufflevector.
1631   /// \p Factor is the interleave factor.
1632   virtual bool lowerInterleavedLoad(LoadInst *LI,
1633                                     ArrayRef<ShuffleVectorInst *> Shuffles,
1634                                     ArrayRef<unsigned> Indices,
1635                                     unsigned Factor) const {
1636     return false;
1637   }
1638
1639   /// \brief Lower an interleaved store to target specific intrinsics. Return
1640   /// true on success.
1641   ///
1642   /// \p SI is the vector store instruction.
1643   /// \p SVI is the shufflevector to RE-interleave the stored vector.
1644   /// \p Factor is the interleave factor.
1645   virtual bool lowerInterleavedStore(StoreInst *SI, ShuffleVectorInst *SVI,
1646                                      unsigned Factor) const {
1647     return false;
1648   }
1649
1650   /// Return true if zero-extending the specific node Val to type VT2 is free
1651   /// (either because it's implicitly zero-extended such as ARM ldrb / ldrh or
1652   /// because it's folded such as X86 zero-extending loads).
1653   virtual bool isZExtFree(SDValue Val, EVT VT2) const {
1654     return isZExtFree(Val.getValueType(), VT2);
1655   }
1656
1657   /// Return true if an fpext operation is free (for instance, because
1658   /// single-precision floating-point numbers are implicitly extended to
1659   /// double-precision).
1660   virtual bool isFPExtFree(EVT VT) const {
1661     assert(VT.isFloatingPoint());
1662     return false;
1663   }
1664
1665   /// Return true if folding a vector load into ExtVal (a sign, zero, or any
1666   /// extend node) is profitable.
1667   virtual bool isVectorLoadExtDesirable(SDValue ExtVal) const { return false; }
1668
1669   /// Return true if an fneg operation is free to the point where it is never
1670   /// worthwhile to replace it with a bitwise operation.
1671   virtual bool isFNegFree(EVT VT) const {
1672     assert(VT.isFloatingPoint());
1673     return false;
1674   }
1675
1676   /// Return true if an fabs operation is free to the point where it is never
1677   /// worthwhile to replace it with a bitwise operation.
1678   virtual bool isFAbsFree(EVT VT) const {
1679     assert(VT.isFloatingPoint());
1680     return false;
1681   }
1682
1683   /// Return true if an FMA operation is faster than a pair of fmul and fadd
1684   /// instructions. fmuladd intrinsics will be expanded to FMAs when this method
1685   /// returns true, otherwise fmuladd is expanded to fmul + fadd.
1686   ///
1687   /// NOTE: This may be called before legalization on types for which FMAs are
1688   /// not legal, but should return true if those types will eventually legalize
1689   /// to types that support FMAs. After legalization, it will only be called on
1690   /// types that support FMAs (via Legal or Custom actions)
1691   virtual bool isFMAFasterThanFMulAndFAdd(EVT) const {
1692     return false;
1693   }
1694
1695   /// Return true if it's profitable to narrow operations of type VT1 to
1696   /// VT2. e.g. on x86, it's profitable to narrow from i32 to i8 but not from
1697   /// i32 to i16.
1698   virtual bool isNarrowingProfitable(EVT /*VT1*/, EVT /*VT2*/) const {
1699     return false;
1700   }
1701
1702   /// \brief Return true if it is beneficial to convert a load of a constant to
1703   /// just the constant itself.
1704   /// On some targets it might be more efficient to use a combination of
1705   /// arithmetic instructions to materialize the constant instead of loading it
1706   /// from a constant pool.
1707   virtual bool shouldConvertConstantLoadToIntImm(const APInt &Imm,
1708                                                  Type *Ty) const {
1709     return false;
1710   }
1711
1712   /// Return true if EXTRACT_SUBVECTOR is cheap for this result type
1713   /// with this index. This is needed because EXTRACT_SUBVECTOR usually
1714   /// has custom lowering that depends on the index of the first element,
1715   /// and only the target knows which lowering is cheap.
1716   virtual bool isExtractSubvectorCheap(EVT ResVT, unsigned Index) const {
1717     return false;
1718   }
1719
1720   // Return true if it is profitable to use a scalar input to a BUILD_VECTOR
1721   // even if the vector itself has multiple uses.
1722   virtual bool aggressivelyPreferBuildVectorSources(EVT VecVT) const {
1723     return false;
1724   }
1725
1726   //===--------------------------------------------------------------------===//
1727   // Runtime Library hooks
1728   //
1729
1730   /// Rename the default libcall routine name for the specified libcall.
1731   void setLibcallName(RTLIB::Libcall Call, const char *Name) {
1732     LibcallRoutineNames[Call] = Name;
1733   }
1734
1735   /// Get the libcall routine name for the specified libcall.
1736   const char *getLibcallName(RTLIB::Libcall Call) const {
1737     return LibcallRoutineNames[Call];
1738   }
1739
1740   /// Override the default CondCode to be used to test the result of the
1741   /// comparison libcall against zero.
1742   void setCmpLibcallCC(RTLIB::Libcall Call, ISD::CondCode CC) {
1743     CmpLibcallCCs[Call] = CC;
1744   }
1745
1746   /// Get the CondCode that's to be used to test the result of the comparison
1747   /// libcall against zero.
1748   ISD::CondCode getCmpLibcallCC(RTLIB::Libcall Call) const {
1749     return CmpLibcallCCs[Call];
1750   }
1751
1752   /// Set the CallingConv that should be used for the specified libcall.
1753   void setLibcallCallingConv(RTLIB::Libcall Call, CallingConv::ID CC) {
1754     LibcallCallingConvs[Call] = CC;
1755   }
1756
1757   /// Get the CallingConv that should be used for the specified libcall.
1758   CallingConv::ID getLibcallCallingConv(RTLIB::Libcall Call) const {
1759     return LibcallCallingConvs[Call];
1760   }
1761
1762 private:
1763   const TargetMachine &TM;
1764
1765   /// Tells the code generator not to expand operations into sequences that use
1766   /// the select operations if possible.
1767   bool SelectIsExpensive;
1768
1769   /// Tells the code generator that the target has multiple (allocatable)
1770   /// condition registers that can be used to store the results of comparisons
1771   /// for use by selects and conditional branches. With multiple condition
1772   /// registers, the code generator will not aggressively sink comparisons into
1773   /// the blocks of their users.
1774   bool HasMultipleConditionRegisters;
1775
1776   /// Tells the code generator that the target has BitExtract instructions.
1777   /// The code generator will aggressively sink "shift"s into the blocks of
1778   /// their users if the users will generate "and" instructions which can be
1779   /// combined with "shift" to BitExtract instructions.
1780   bool HasExtractBitsInsn;
1781
1782   // Don't expand fsqrt with an approximation based on the inverse sqrt.
1783   bool FsqrtIsCheap;
1784
1785   /// Tells the code generator to bypass slow divide or remainder
1786   /// instructions. For example, BypassSlowDivWidths[32,8] tells the code
1787   /// generator to bypass 32-bit integer div/rem with an 8-bit unsigned integer
1788   /// div/rem when the operands are positive and less than 256.
1789   DenseMap <unsigned int, unsigned int> BypassSlowDivWidths;
1790
1791   /// Tells the code generator that it shouldn't generate extra flow control
1792   /// instructions and should attempt to combine flow control instructions via
1793   /// predication.
1794   bool JumpIsExpensive;
1795
1796   /// Whether the target supports or cares about preserving floating point
1797   /// exception behavior.
1798   bool HasFloatingPointExceptions;
1799
1800   /// This target prefers to use _setjmp to implement llvm.setjmp.
1801   ///
1802   /// Defaults to false.
1803   bool UseUnderscoreSetJmp;
1804
1805   /// This target prefers to use _longjmp to implement llvm.longjmp.
1806   ///
1807   /// Defaults to false.
1808   bool UseUnderscoreLongJmp;
1809
1810   /// Number of blocks threshold to use jump tables.
1811   int MinimumJumpTableEntries;
1812
1813   /// Information about the contents of the high-bits in boolean values held in
1814   /// a type wider than i1. See getBooleanContents.
1815   BooleanContent BooleanContents;
1816
1817   /// Information about the contents of the high-bits in boolean values held in
1818   /// a type wider than i1. See getBooleanContents.
1819   BooleanContent BooleanFloatContents;
1820
1821   /// Information about the contents of the high-bits in boolean vector values
1822   /// when the element type is wider than i1. See getBooleanContents.
1823   BooleanContent BooleanVectorContents;
1824
1825   /// The target scheduling preference: shortest possible total cycles or lowest
1826   /// register usage.
1827   Sched::Preference SchedPreferenceInfo;
1828
1829   /// The size, in bytes, of the target's jmp_buf buffers
1830   unsigned JumpBufSize;
1831
1832   /// The alignment, in bytes, of the target's jmp_buf buffers
1833   unsigned JumpBufAlignment;
1834
1835   /// The minimum alignment that any argument on the stack needs to have.
1836   unsigned MinStackArgumentAlignment;
1837
1838   /// The minimum function alignment (used when optimizing for size, and to
1839   /// prevent explicitly provided alignment from leading to incorrect code).
1840   unsigned MinFunctionAlignment;
1841
1842   /// The preferred function alignment (used when alignment unspecified and
1843   /// optimizing for speed).
1844   unsigned PrefFunctionAlignment;
1845
1846   /// The preferred loop alignment.
1847   unsigned PrefLoopAlignment;
1848
1849   /// Whether the DAG builder should automatically insert fences and reduce
1850   /// ordering for atomics.  (This will be set for for most architectures with
1851   /// weak memory ordering.)
1852   bool InsertFencesForAtomic;
1853
1854   /// If set to a physical register, this specifies the register that
1855   /// llvm.savestack/llvm.restorestack should save and restore.
1856   unsigned StackPointerRegisterToSaveRestore;
1857
1858   /// This indicates the default register class to use for each ValueType the
1859   /// target supports natively.
1860   const TargetRegisterClass *RegClassForVT[MVT::LAST_VALUETYPE];
1861   unsigned char NumRegistersForVT[MVT::LAST_VALUETYPE];
1862   MVT RegisterTypeForVT[MVT::LAST_VALUETYPE];
1863
1864   /// This indicates the "representative" register class to use for each
1865   /// ValueType the target supports natively. This information is used by the
1866   /// scheduler to track register pressure. By default, the representative
1867   /// register class is the largest legal super-reg register class of the
1868   /// register class of the specified type. e.g. On x86, i8, i16, and i32's
1869   /// representative class would be GR32.
1870   const TargetRegisterClass *RepRegClassForVT[MVT::LAST_VALUETYPE];
1871
1872   /// This indicates the "cost" of the "representative" register class for each
1873   /// ValueType. The cost is used by the scheduler to approximate register
1874   /// pressure.
1875   uint8_t RepRegClassCostForVT[MVT::LAST_VALUETYPE];
1876
1877   /// For any value types we are promoting or expanding, this contains the value
1878   /// type that we are changing to.  For Expanded types, this contains one step
1879   /// of the expand (e.g. i64 -> i32), even if there are multiple steps required
1880   /// (e.g. i64 -> i16).  For types natively supported by the system, this holds
1881   /// the same type (e.g. i32 -> i32).
1882   MVT TransformToType[MVT::LAST_VALUETYPE];
1883
1884   /// For each operation and each value type, keep a LegalizeAction that
1885   /// indicates how instruction selection should deal with the operation.  Most
1886   /// operations are Legal (aka, supported natively by the target), but
1887   /// operations that are not should be described.  Note that operations on
1888   /// non-legal value types are not described here.
1889   uint8_t OpActions[MVT::LAST_VALUETYPE][ISD::BUILTIN_OP_END];
1890
1891   /// For each load extension type and each value type, keep a LegalizeAction
1892   /// that indicates how instruction selection should deal with a load of a
1893   /// specific value type and extension type.
1894   uint8_t LoadExtActions[MVT::LAST_VALUETYPE][MVT::LAST_VALUETYPE]
1895                         [ISD::LAST_LOADEXT_TYPE];
1896
1897   /// For each value type pair keep a LegalizeAction that indicates whether a
1898   /// truncating store of a specific value type and truncating type is legal.
1899   uint8_t TruncStoreActions[MVT::LAST_VALUETYPE][MVT::LAST_VALUETYPE];
1900
1901   /// For each indexed mode and each value type, keep a pair of LegalizeAction
1902   /// that indicates how instruction selection should deal with the load /
1903   /// store.
1904   ///
1905   /// The first dimension is the value_type for the reference. The second
1906   /// dimension represents the various modes for load store.
1907   uint8_t IndexedModeActions[MVT::LAST_VALUETYPE][ISD::LAST_INDEXED_MODE];
1908
1909   /// For each condition code (ISD::CondCode) keep a LegalizeAction that
1910   /// indicates how instruction selection should deal with the condition code.
1911   ///
1912   /// Because each CC action takes up 4 bits, we need to have the array size be
1913   /// large enough to fit all of the value types. This can be done by rounding
1914   /// up the MVT::LAST_VALUETYPE value to the next multiple of 8.
1915   uint32_t CondCodeActions[ISD::SETCC_INVALID][(MVT::LAST_VALUETYPE + 7) / 8];
1916
1917 protected:
1918   ValueTypeActionImpl ValueTypeActions;
1919
1920 private:
1921   LegalizeKind getTypeConversion(LLVMContext &Context, EVT VT) const;
1922
1923 private:
1924   std::vector<std::pair<MVT, const TargetRegisterClass*> > AvailableRegClasses;
1925
1926   /// Targets can specify ISD nodes that they would like PerformDAGCombine
1927   /// callbacks for by calling setTargetDAGCombine(), which sets a bit in this
1928   /// array.
1929   unsigned char
1930   TargetDAGCombineArray[(ISD::BUILTIN_OP_END+CHAR_BIT-1)/CHAR_BIT];
1931
1932   /// For operations that must be promoted to a specific type, this holds the
1933   /// destination type.  This map should be sparse, so don't hold it as an
1934   /// array.
1935   ///
1936   /// Targets add entries to this map with AddPromotedToType(..), clients access
1937   /// this with getTypeToPromoteTo(..).
1938   std::map<std::pair<unsigned, MVT::SimpleValueType>, MVT::SimpleValueType>
1939     PromoteToType;
1940
1941   /// Stores the name each libcall.
1942   const char *LibcallRoutineNames[RTLIB::UNKNOWN_LIBCALL];
1943
1944   /// The ISD::CondCode that should be used to test the result of each of the
1945   /// comparison libcall against zero.
1946   ISD::CondCode CmpLibcallCCs[RTLIB::UNKNOWN_LIBCALL];
1947
1948   /// Stores the CallingConv that should be used for each libcall.
1949   CallingConv::ID LibcallCallingConvs[RTLIB::UNKNOWN_LIBCALL];
1950
1951 protected:
1952   /// Return true if the extension represented by \p I is free.
1953   /// \pre \p I is a sign, zero, or fp extension and
1954   ///      is[Z|FP]ExtFree of the related types is not true.
1955   virtual bool isExtFreeImpl(const Instruction *I) const { return false; }
1956
1957   /// Depth that GatherAllAliases should should continue looking for chain
1958   /// dependencies when trying to find a more preferrable chain. As an
1959   /// approximation, this should be more than the number of consecutive stores
1960   /// expected to be merged.
1961   unsigned GatherAllAliasesMaxDepth;
1962
1963   /// \brief Specify maximum number of store instructions per memset call.
1964   ///
1965   /// When lowering \@llvm.memset this field specifies the maximum number of
1966   /// store operations that may be substituted for the call to memset. Targets
1967   /// must set this value based on the cost threshold for that target. Targets
1968   /// should assume that the memset will be done using as many of the largest
1969   /// store operations first, followed by smaller ones, if necessary, per
1970   /// alignment restrictions. For example, storing 9 bytes on a 32-bit machine
1971   /// with 16-bit alignment would result in four 2-byte stores and one 1-byte
1972   /// store.  This only applies to setting a constant array of a constant size.
1973   unsigned MaxStoresPerMemset;
1974
1975   /// Maximum number of stores operations that may be substituted for the call
1976   /// to memset, used for functions with OptSize attribute.
1977   unsigned MaxStoresPerMemsetOptSize;
1978
1979   /// \brief Specify maximum bytes of store instructions per memcpy call.
1980   ///
1981   /// When lowering \@llvm.memcpy this field specifies the maximum number of
1982   /// store operations that may be substituted for a call to memcpy. Targets
1983   /// must set this value based on the cost threshold for that target. Targets
1984   /// should assume that the memcpy will be done using as many of the largest
1985   /// store operations first, followed by smaller ones, if necessary, per
1986   /// alignment restrictions. For example, storing 7 bytes on a 32-bit machine
1987   /// with 32-bit alignment would result in one 4-byte store, a one 2-byte store
1988   /// and one 1-byte store. This only applies to copying a constant array of
1989   /// constant size.
1990   unsigned MaxStoresPerMemcpy;
1991
1992   /// Maximum number of store operations that may be substituted for a call to
1993   /// memcpy, used for functions with OptSize attribute.
1994   unsigned MaxStoresPerMemcpyOptSize;
1995
1996   /// \brief Specify maximum bytes of store instructions per memmove call.
1997   ///
1998   /// When lowering \@llvm.memmove this field specifies the maximum number of
1999   /// store instructions that may be substituted for a call to memmove. Targets
2000   /// must set this value based on the cost threshold for that target. Targets
2001   /// should assume that the memmove will be done using as many of the largest
2002   /// store operations first, followed by smaller ones, if necessary, per
2003   /// alignment restrictions. For example, moving 9 bytes on a 32-bit machine
2004   /// with 8-bit alignment would result in nine 1-byte stores.  This only
2005   /// applies to copying a constant array of constant size.
2006   unsigned MaxStoresPerMemmove;
2007
2008   /// Maximum number of store instructions that may be substituted for a call to
2009   /// memmove, used for functions with OptSize attribute.
2010   unsigned MaxStoresPerMemmoveOptSize;
2011
2012   /// Tells the code generator that select is more expensive than a branch if
2013   /// the branch is usually predicted right.
2014   bool PredictableSelectIsExpensive;
2015
2016   /// MaskAndBranchFoldingIsLegal - Indicates if the target supports folding
2017   /// a mask of a single bit, a compare, and a branch into a single instruction.
2018   bool MaskAndBranchFoldingIsLegal;
2019
2020   /// \see enableExtLdPromotion.
2021   bool EnableExtLdPromotion;
2022
2023 protected:
2024   /// Return true if the value types that can be represented by the specified
2025   /// register class are all legal.
2026   bool isLegalRC(const TargetRegisterClass *RC) const;
2027
2028   /// Replace/modify any TargetFrameIndex operands with a targte-dependent
2029   /// sequence of memory operands that is recognized by PrologEpilogInserter.
2030   MachineBasicBlock *emitPatchPoint(MachineInstr *MI,
2031                                     MachineBasicBlock *MBB) const;
2032 };
2033
2034 /// This class defines information used to lower LLVM code to legal SelectionDAG
2035 /// operators that the target instruction selector can accept natively.
2036 ///
2037 /// This class also defines callbacks that targets must implement to lower
2038 /// target-specific constructs to SelectionDAG operators.
2039 class TargetLowering : public TargetLoweringBase {
2040   TargetLowering(const TargetLowering&) = delete;
2041   void operator=(const TargetLowering&) = delete;
2042
2043 public:
2044   /// NOTE: The TargetMachine owns TLOF.
2045   explicit TargetLowering(const TargetMachine &TM);
2046
2047   /// Returns true by value, base pointer and offset pointer and addressing mode
2048   /// by reference if the node's address can be legally represented as
2049   /// pre-indexed load / store address.
2050   virtual bool getPreIndexedAddressParts(SDNode * /*N*/, SDValue &/*Base*/,
2051                                          SDValue &/*Offset*/,
2052                                          ISD::MemIndexedMode &/*AM*/,
2053                                          SelectionDAG &/*DAG*/) const {
2054     return false;
2055   }
2056
2057   /// Returns true by value, base pointer and offset pointer and addressing mode
2058   /// by reference if this node can be combined with a load / store to form a
2059   /// post-indexed load / store.
2060   virtual bool getPostIndexedAddressParts(SDNode * /*N*/, SDNode * /*Op*/,
2061                                           SDValue &/*Base*/,
2062                                           SDValue &/*Offset*/,
2063                                           ISD::MemIndexedMode &/*AM*/,
2064                                           SelectionDAG &/*DAG*/) const {
2065     return false;
2066   }
2067
2068   /// Return the entry encoding for a jump table in the current function.  The
2069   /// returned value is a member of the MachineJumpTableInfo::JTEntryKind enum.
2070   virtual unsigned getJumpTableEncoding() const;
2071
2072   virtual const MCExpr *
2073   LowerCustomJumpTableEntry(const MachineJumpTableInfo * /*MJTI*/,
2074                             const MachineBasicBlock * /*MBB*/, unsigned /*uid*/,
2075                             MCContext &/*Ctx*/) const {
2076     llvm_unreachable("Need to implement this hook if target has custom JTIs");
2077   }
2078
2079   /// Returns relocation base for the given PIC jumptable.
2080   virtual SDValue getPICJumpTableRelocBase(SDValue Table,
2081                                            SelectionDAG &DAG) const;
2082
2083   /// This returns the relocation base for the given PIC jumptable, the same as
2084   /// getPICJumpTableRelocBase, but as an MCExpr.
2085   virtual const MCExpr *
2086   getPICJumpTableRelocBaseExpr(const MachineFunction *MF,
2087                                unsigned JTI, MCContext &Ctx) const;
2088
2089   /// Return true if folding a constant offset with the given GlobalAddress is
2090   /// legal.  It is frequently not legal in PIC relocation models.
2091   virtual bool isOffsetFoldingLegal(const GlobalAddressSDNode *GA) const;
2092
2093   bool isInTailCallPosition(SelectionDAG &DAG, SDNode *Node,
2094                             SDValue &Chain) const;
2095
2096   void softenSetCCOperands(SelectionDAG &DAG, EVT VT,
2097                            SDValue &NewLHS, SDValue &NewRHS,
2098                            ISD::CondCode &CCCode, SDLoc DL) const;
2099
2100   /// Returns a pair of (return value, chain).
2101   /// It is an error to pass RTLIB::UNKNOWN_LIBCALL as \p LC.
2102   std::pair<SDValue, SDValue> makeLibCall(SelectionDAG &DAG, RTLIB::Libcall LC,
2103                                           EVT RetVT, ArrayRef<SDValue> Ops,
2104                                           bool isSigned, SDLoc dl,
2105                                           bool doesNotReturn = false,
2106                                           bool isReturnValueUsed = true) const;
2107
2108   //===--------------------------------------------------------------------===//
2109   // TargetLowering Optimization Methods
2110   //
2111
2112   /// A convenience struct that encapsulates a DAG, and two SDValues for
2113   /// returning information from TargetLowering to its clients that want to
2114   /// combine.
2115   struct TargetLoweringOpt {
2116     SelectionDAG &DAG;
2117     bool LegalTys;
2118     bool LegalOps;
2119     SDValue Old;
2120     SDValue New;
2121
2122     explicit TargetLoweringOpt(SelectionDAG &InDAG,
2123                                bool LT, bool LO) :
2124       DAG(InDAG), LegalTys(LT), LegalOps(LO) {}
2125
2126     bool LegalTypes() const { return LegalTys; }
2127     bool LegalOperations() const { return LegalOps; }
2128
2129     bool CombineTo(SDValue O, SDValue N) {
2130       Old = O;
2131       New = N;
2132       return true;
2133     }
2134
2135     /// Check to see if the specified operand of the specified instruction is a
2136     /// constant integer.  If so, check to see if there are any bits set in the
2137     /// constant that are not demanded.  If so, shrink the constant and return
2138     /// true.
2139     bool ShrinkDemandedConstant(SDValue Op, const APInt &Demanded);
2140
2141     /// Convert x+y to (VT)((SmallVT)x+(SmallVT)y) if the casts are free.  This
2142     /// uses isZExtFree and ZERO_EXTEND for the widening cast, but it could be
2143     /// generalized for targets with other types of implicit widening casts.
2144     bool ShrinkDemandedOp(SDValue Op, unsigned BitWidth, const APInt &Demanded,
2145                           SDLoc dl);
2146   };
2147
2148   /// Look at Op.  At this point, we know that only the DemandedMask bits of the
2149   /// result of Op are ever used downstream.  If we can use this information to
2150   /// simplify Op, create a new simplified DAG node and return true, returning
2151   /// the original and new nodes in Old and New.  Otherwise, analyze the
2152   /// expression and return a mask of KnownOne and KnownZero bits for the
2153   /// expression (used to simplify the caller).  The KnownZero/One bits may only
2154   /// be accurate for those bits in the DemandedMask.
2155   bool SimplifyDemandedBits(SDValue Op, const APInt &DemandedMask,
2156                             APInt &KnownZero, APInt &KnownOne,
2157                             TargetLoweringOpt &TLO, unsigned Depth = 0) const;
2158
2159   /// Determine which of the bits specified in Mask are known to be either zero
2160   /// or one and return them in the KnownZero/KnownOne bitsets.
2161   virtual void computeKnownBitsForTargetNode(const SDValue Op,
2162                                              APInt &KnownZero,
2163                                              APInt &KnownOne,
2164                                              const SelectionDAG &DAG,
2165                                              unsigned Depth = 0) const;
2166
2167   /// This method can be implemented by targets that want to expose additional
2168   /// information about sign bits to the DAG Combiner.
2169   virtual unsigned ComputeNumSignBitsForTargetNode(SDValue Op,
2170                                                    const SelectionDAG &DAG,
2171                                                    unsigned Depth = 0) const;
2172
2173   struct DAGCombinerInfo {
2174     void *DC;  // The DAG Combiner object.
2175     CombineLevel Level;
2176     bool CalledByLegalizer;
2177   public:
2178     SelectionDAG &DAG;
2179
2180     DAGCombinerInfo(SelectionDAG &dag, CombineLevel level,  bool cl, void *dc)
2181       : DC(dc), Level(level), CalledByLegalizer(cl), DAG(dag) {}
2182
2183     bool isBeforeLegalize() const { return Level == BeforeLegalizeTypes; }
2184     bool isBeforeLegalizeOps() const { return Level < AfterLegalizeVectorOps; }
2185     bool isAfterLegalizeVectorOps() const {
2186       return Level == AfterLegalizeDAG;
2187     }
2188     CombineLevel getDAGCombineLevel() { return Level; }
2189     bool isCalledByLegalizer() const { return CalledByLegalizer; }
2190
2191     void AddToWorklist(SDNode *N);
2192     void RemoveFromWorklist(SDNode *N);
2193     SDValue CombineTo(SDNode *N, ArrayRef<SDValue> To, bool AddTo = true);
2194     SDValue CombineTo(SDNode *N, SDValue Res, bool AddTo = true);
2195     SDValue CombineTo(SDNode *N, SDValue Res0, SDValue Res1, bool AddTo = true);
2196
2197     void CommitTargetLoweringOpt(const TargetLoweringOpt &TLO);
2198   };
2199
2200   /// Return if the N is a constant or constant vector equal to the true value
2201   /// from getBooleanContents().
2202   bool isConstTrueVal(const SDNode *N) const;
2203
2204   /// Return if the N is a constant or constant vector equal to the false value
2205   /// from getBooleanContents().
2206   bool isConstFalseVal(const SDNode *N) const;
2207
2208   /// Try to simplify a setcc built with the specified operands and cc. If it is
2209   /// unable to simplify it, return a null SDValue.
2210   SDValue SimplifySetCC(EVT VT, SDValue N0, SDValue N1,
2211                           ISD::CondCode Cond, bool foldBooleans,
2212                           DAGCombinerInfo &DCI, SDLoc dl) const;
2213
2214   /// Returns true (and the GlobalValue and the offset) if the node is a
2215   /// GlobalAddress + offset.
2216   virtual bool
2217   isGAPlusOffset(SDNode *N, const GlobalValue* &GA, int64_t &Offset) const;
2218
2219   /// This method will be invoked for all target nodes and for any
2220   /// target-independent nodes that the target has registered with invoke it
2221   /// for.
2222   ///
2223   /// The semantics are as follows:
2224   /// Return Value:
2225   ///   SDValue.Val == 0   - No change was made
2226   ///   SDValue.Val == N   - N was replaced, is dead, and is already handled.
2227   ///   otherwise          - N should be replaced by the returned Operand.
2228   ///
2229   /// In addition, methods provided by DAGCombinerInfo may be used to perform
2230   /// more complex transformations.
2231   ///
2232   virtual SDValue PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const;
2233
2234   /// Return true if it is profitable to move a following shift through this
2235   //  node, adjusting any immediate operands as necessary to preserve semantics.
2236   //  This transformation may not be desirable if it disrupts a particularly
2237   //  auspicious target-specific tree (e.g. bitfield extraction in AArch64).
2238   //  By default, it returns true.
2239   virtual bool isDesirableToCommuteWithShift(const SDNode *N /*Op*/) const {
2240     return true;
2241   }
2242
2243   /// Return true if the target has native support for the specified value type
2244   /// and it is 'desirable' to use the type for the given node type. e.g. On x86
2245   /// i16 is legal, but undesirable since i16 instruction encodings are longer
2246   /// and some i16 instructions are slow.
2247   virtual bool isTypeDesirableForOp(unsigned /*Opc*/, EVT VT) const {
2248     // By default, assume all legal types are desirable.
2249     return isTypeLegal(VT);
2250   }
2251
2252   /// Return true if it is profitable for dag combiner to transform a floating
2253   /// point op of specified opcode to a equivalent op of an integer
2254   /// type. e.g. f32 load -> i32 load can be profitable on ARM.
2255   virtual bool isDesirableToTransformToIntegerOp(unsigned /*Opc*/,
2256                                                  EVT /*VT*/) const {
2257     return false;
2258   }
2259
2260   /// This method query the target whether it is beneficial for dag combiner to
2261   /// promote the specified node. If true, it should return the desired
2262   /// promotion type by reference.
2263   virtual bool IsDesirableToPromoteOp(SDValue /*Op*/, EVT &/*PVT*/) const {
2264     return false;
2265   }
2266
2267   //===--------------------------------------------------------------------===//
2268   // Lowering methods - These methods must be implemented by targets so that
2269   // the SelectionDAGBuilder code knows how to lower these.
2270   //
2271
2272   /// This hook must be implemented to lower the incoming (formal) arguments,
2273   /// described by the Ins array, into the specified DAG. The implementation
2274   /// should fill in the InVals array with legal-type argument values, and
2275   /// return the resulting token chain value.
2276   ///
2277   virtual SDValue
2278     LowerFormalArguments(SDValue /*Chain*/, CallingConv::ID /*CallConv*/,
2279                          bool /*isVarArg*/,
2280                          const SmallVectorImpl<ISD::InputArg> &/*Ins*/,
2281                          SDLoc /*dl*/, SelectionDAG &/*DAG*/,
2282                          SmallVectorImpl<SDValue> &/*InVals*/) const {
2283     llvm_unreachable("Not Implemented");
2284   }
2285
2286   struct ArgListEntry {
2287     SDValue Node;
2288     Type* Ty;
2289     bool isSExt     : 1;
2290     bool isZExt     : 1;
2291     bool isInReg    : 1;
2292     bool isSRet     : 1;
2293     bool isNest     : 1;
2294     bool isByVal    : 1;
2295     bool isInAlloca : 1;
2296     bool isReturned : 1;
2297     uint16_t Alignment;
2298
2299     ArgListEntry() : isSExt(false), isZExt(false), isInReg(false),
2300       isSRet(false), isNest(false), isByVal(false), isInAlloca(false),
2301       isReturned(false), Alignment(0) { }
2302
2303     void setAttributes(ImmutableCallSite *CS, unsigned AttrIdx);
2304   };
2305   typedef std::vector<ArgListEntry> ArgListTy;
2306
2307   /// This structure contains all information that is necessary for lowering
2308   /// calls. It is passed to TLI::LowerCallTo when the SelectionDAG builder
2309   /// needs to lower a call, and targets will see this struct in their LowerCall
2310   /// implementation.
2311   struct CallLoweringInfo {
2312     SDValue Chain;
2313     Type *RetTy;
2314     bool RetSExt           : 1;
2315     bool RetZExt           : 1;
2316     bool IsVarArg          : 1;
2317     bool IsInReg           : 1;
2318     bool DoesNotReturn     : 1;
2319     bool IsReturnValueUsed : 1;
2320
2321     // IsTailCall should be modified by implementations of
2322     // TargetLowering::LowerCall that perform tail call conversions.
2323     bool IsTailCall;
2324
2325     unsigned NumFixedArgs;
2326     CallingConv::ID CallConv;
2327     SDValue Callee;
2328     ArgListTy Args;
2329     SelectionDAG &DAG;
2330     SDLoc DL;
2331     ImmutableCallSite *CS;
2332     bool IsPatchPoint;
2333     SmallVector<ISD::OutputArg, 32> Outs;
2334     SmallVector<SDValue, 32> OutVals;
2335     SmallVector<ISD::InputArg, 32> Ins;
2336
2337     CallLoweringInfo(SelectionDAG &DAG)
2338       : RetTy(nullptr), RetSExt(false), RetZExt(false), IsVarArg(false),
2339         IsInReg(false), DoesNotReturn(false), IsReturnValueUsed(true),
2340         IsTailCall(false), NumFixedArgs(-1), CallConv(CallingConv::C),
2341         DAG(DAG), CS(nullptr), IsPatchPoint(false) {}
2342
2343     CallLoweringInfo &setDebugLoc(SDLoc dl) {
2344       DL = dl;
2345       return *this;
2346     }
2347
2348     CallLoweringInfo &setChain(SDValue InChain) {
2349       Chain = InChain;
2350       return *this;
2351     }
2352
2353     CallLoweringInfo &setCallee(CallingConv::ID CC, Type *ResultType,
2354                                 SDValue Target, ArgListTy &&ArgsList,
2355                                 unsigned FixedArgs = -1) {
2356       RetTy = ResultType;
2357       Callee = Target;
2358       CallConv = CC;
2359       NumFixedArgs =
2360         (FixedArgs == static_cast<unsigned>(-1) ? Args.size() : FixedArgs);
2361       Args = std::move(ArgsList);
2362       return *this;
2363     }
2364
2365     CallLoweringInfo &setCallee(Type *ResultType, FunctionType *FTy,
2366                                 SDValue Target, ArgListTy &&ArgsList,
2367                                 ImmutableCallSite &Call) {
2368       RetTy = ResultType;
2369
2370       IsInReg = Call.paramHasAttr(0, Attribute::InReg);
2371       DoesNotReturn = Call.doesNotReturn();
2372       IsVarArg = FTy->isVarArg();
2373       IsReturnValueUsed = !Call.getInstruction()->use_empty();
2374       RetSExt = Call.paramHasAttr(0, Attribute::SExt);
2375       RetZExt = Call.paramHasAttr(0, Attribute::ZExt);
2376
2377       Callee = Target;
2378
2379       CallConv = Call.getCallingConv();
2380       NumFixedArgs = FTy->getNumParams();
2381       Args = std::move(ArgsList);
2382
2383       CS = &Call;
2384
2385       return *this;
2386     }
2387
2388     CallLoweringInfo &setInRegister(bool Value = true) {
2389       IsInReg = Value;
2390       return *this;
2391     }
2392
2393     CallLoweringInfo &setNoReturn(bool Value = true) {
2394       DoesNotReturn = Value;
2395       return *this;
2396     }
2397
2398     CallLoweringInfo &setVarArg(bool Value = true) {
2399       IsVarArg = Value;
2400       return *this;
2401     }
2402
2403     CallLoweringInfo &setTailCall(bool Value = true) {
2404       IsTailCall = Value;
2405       return *this;
2406     }
2407
2408     CallLoweringInfo &setDiscardResult(bool Value = true) {
2409       IsReturnValueUsed = !Value;
2410       return *this;
2411     }
2412
2413     CallLoweringInfo &setSExtResult(bool Value = true) {
2414       RetSExt = Value;
2415       return *this;
2416     }
2417
2418     CallLoweringInfo &setZExtResult(bool Value = true) {
2419       RetZExt = Value;
2420       return *this;
2421     }
2422
2423     CallLoweringInfo &setIsPatchPoint(bool Value = true) {
2424       IsPatchPoint = Value;
2425       return *this;
2426     }
2427
2428     ArgListTy &getArgs() {
2429       return Args;
2430     }
2431
2432   };
2433
2434   // Mark inreg arguments for lib-calls. For normal calls this is done by
2435   // the frontend ABI code.
2436   virtual void markInRegArguments(SelectionDAG &DAG, 
2437                  TargetLowering::ArgListTy &Args) const {
2438     return;
2439   }
2440
2441   /// This function lowers an abstract call to a function into an actual call.
2442   /// This returns a pair of operands.  The first element is the return value
2443   /// for the function (if RetTy is not VoidTy).  The second element is the
2444   /// outgoing token chain. It calls LowerCall to do the actual lowering.
2445   std::pair<SDValue, SDValue> LowerCallTo(CallLoweringInfo &CLI) const;
2446
2447   /// This hook must be implemented to lower calls into the specified
2448   /// DAG. The outgoing arguments to the call are described by the Outs array,
2449   /// and the values to be returned by the call are described by the Ins
2450   /// array. The implementation should fill in the InVals array with legal-type
2451   /// return values from the call, and return the resulting token chain value.
2452   virtual SDValue
2453     LowerCall(CallLoweringInfo &/*CLI*/,
2454               SmallVectorImpl<SDValue> &/*InVals*/) const {
2455     llvm_unreachable("Not Implemented");
2456   }
2457
2458   /// Target-specific cleanup for formal ByVal parameters.
2459   virtual void HandleByVal(CCState *, unsigned &, unsigned) const {}
2460
2461   /// This hook should be implemented to check whether the return values
2462   /// described by the Outs array can fit into the return registers.  If false
2463   /// is returned, an sret-demotion is performed.
2464   virtual bool CanLowerReturn(CallingConv::ID /*CallConv*/,
2465                               MachineFunction &/*MF*/, bool /*isVarArg*/,
2466                const SmallVectorImpl<ISD::OutputArg> &/*Outs*/,
2467                LLVMContext &/*Context*/) const
2468   {
2469     // Return true by default to get preexisting behavior.
2470     return true;
2471   }
2472
2473   /// This hook must be implemented to lower outgoing return values, described
2474   /// by the Outs array, into the specified DAG. The implementation should
2475   /// return the resulting token chain value.
2476   virtual SDValue
2477     LowerReturn(SDValue /*Chain*/, CallingConv::ID /*CallConv*/,
2478                 bool /*isVarArg*/,
2479                 const SmallVectorImpl<ISD::OutputArg> &/*Outs*/,
2480                 const SmallVectorImpl<SDValue> &/*OutVals*/,
2481                 SDLoc /*dl*/, SelectionDAG &/*DAG*/) const {
2482     llvm_unreachable("Not Implemented");
2483   }
2484
2485   /// Return true if result of the specified node is used by a return node
2486   /// only. It also compute and return the input chain for the tail call.
2487   ///
2488   /// This is used to determine whether it is possible to codegen a libcall as
2489   /// tail call at legalization time.
2490   virtual bool isUsedByReturnOnly(SDNode *, SDValue &/*Chain*/) const {
2491     return false;
2492   }
2493
2494   /// Return true if the target may be able emit the call instruction as a tail
2495   /// call. This is used by optimization passes to determine if it's profitable
2496   /// to duplicate return instructions to enable tailcall optimization.
2497   virtual bool mayBeEmittedAsTailCall(CallInst *) const {
2498     return false;
2499   }
2500
2501   /// Return the builtin name for the __builtin___clear_cache intrinsic
2502   /// Default is to invoke the clear cache library call
2503   virtual const char * getClearCacheBuiltinName() const {
2504     return "__clear_cache";
2505   }
2506
2507   /// Return the register ID of the name passed in. Used by named register
2508   /// global variables extension. There is no target-independent behaviour
2509   /// so the default action is to bail.
2510   virtual unsigned getRegisterByName(const char* RegName, EVT VT,
2511                                      SelectionDAG &DAG) const {
2512     report_fatal_error("Named registers not implemented for this target");
2513   }
2514
2515   /// Return the type that should be used to zero or sign extend a
2516   /// zeroext/signext integer argument or return value.  FIXME: Most C calling
2517   /// convention requires the return type to be promoted, but this is not true
2518   /// all the time, e.g. i1 on x86-64. It is also not necessary for non-C
2519   /// calling conventions. The frontend should handle this and include all of
2520   /// the necessary information.
2521   virtual EVT getTypeForExtArgOrReturn(LLVMContext &Context, EVT VT,
2522                                        ISD::NodeType /*ExtendKind*/) const {
2523     EVT MinVT = getRegisterType(Context, MVT::i32);
2524     return VT.bitsLT(MinVT) ? MinVT : VT;
2525   }
2526
2527   /// For some targets, an LLVM struct type must be broken down into multiple
2528   /// simple types, but the calling convention specifies that the entire struct
2529   /// must be passed in a block of consecutive registers.
2530   virtual bool
2531   functionArgumentNeedsConsecutiveRegisters(Type *Ty, CallingConv::ID CallConv,
2532                                             bool isVarArg) const {
2533     return false;
2534   }
2535
2536   /// Returns a 0 terminated array of registers that can be safely used as
2537   /// scratch registers.
2538   virtual const MCPhysReg *getScratchRegisters(CallingConv::ID CC) const {
2539     return nullptr;
2540   }
2541
2542   /// This callback is used to prepare for a volatile or atomic load.
2543   /// It takes a chain node as input and returns the chain for the load itself.
2544   ///
2545   /// Having a callback like this is necessary for targets like SystemZ,
2546   /// which allows a CPU to reuse the result of a previous load indefinitely,
2547   /// even if a cache-coherent store is performed by another CPU.  The default
2548   /// implementation does nothing.
2549   virtual SDValue prepareVolatileOrAtomicLoad(SDValue Chain, SDLoc DL,
2550                                               SelectionDAG &DAG) const {
2551     return Chain;
2552   }
2553
2554   /// This callback is invoked by the type legalizer to legalize nodes with an
2555   /// illegal operand type but legal result types.  It replaces the
2556   /// LowerOperation callback in the type Legalizer.  The reason we can not do
2557   /// away with LowerOperation entirely is that LegalizeDAG isn't yet ready to
2558   /// use this callback.
2559   ///
2560   /// TODO: Consider merging with ReplaceNodeResults.
2561   ///
2562   /// The target places new result values for the node in Results (their number
2563   /// and types must exactly match those of the original return values of
2564   /// the node), or leaves Results empty, which indicates that the node is not
2565   /// to be custom lowered after all.
2566   /// The default implementation calls LowerOperation.
2567   virtual void LowerOperationWrapper(SDNode *N,
2568                                      SmallVectorImpl<SDValue> &Results,
2569                                      SelectionDAG &DAG) const;
2570
2571   /// This callback is invoked for operations that are unsupported by the
2572   /// target, which are registered to use 'custom' lowering, and whose defined
2573   /// values are all legal.  If the target has no operations that require custom
2574   /// lowering, it need not implement this.  The default implementation of this
2575   /// aborts.
2576   virtual SDValue LowerOperation(SDValue Op, SelectionDAG &DAG) const;
2577
2578   /// This callback is invoked when a node result type is illegal for the
2579   /// target, and the operation was registered to use 'custom' lowering for that
2580   /// result type.  The target places new result values for the node in Results
2581   /// (their number and types must exactly match those of the original return
2582   /// values of the node), or leaves Results empty, which indicates that the
2583   /// node is not to be custom lowered after all.
2584   ///
2585   /// If the target has no operations that require custom lowering, it need not
2586   /// implement this.  The default implementation aborts.
2587   virtual void ReplaceNodeResults(SDNode * /*N*/,
2588                                   SmallVectorImpl<SDValue> &/*Results*/,
2589                                   SelectionDAG &/*DAG*/) const {
2590     llvm_unreachable("ReplaceNodeResults not implemented for this target!");
2591   }
2592
2593   /// This method returns the name of a target specific DAG node.
2594   virtual const char *getTargetNodeName(unsigned Opcode) const;
2595
2596   /// This method returns a target specific FastISel object, or null if the
2597   /// target does not support "fast" ISel.
2598   virtual FastISel *createFastISel(FunctionLoweringInfo &,
2599                                    const TargetLibraryInfo *) const {
2600     return nullptr;
2601   }
2602
2603
2604   bool verifyReturnAddressArgumentIsConstant(SDValue Op,
2605                                              SelectionDAG &DAG) const;
2606
2607   //===--------------------------------------------------------------------===//
2608   // Inline Asm Support hooks
2609   //
2610
2611   /// This hook allows the target to expand an inline asm call to be explicit
2612   /// llvm code if it wants to.  This is useful for turning simple inline asms
2613   /// into LLVM intrinsics, which gives the compiler more information about the
2614   /// behavior of the code.
2615   virtual bool ExpandInlineAsm(CallInst *) const {
2616     return false;
2617   }
2618
2619   enum ConstraintType {
2620     C_Register,            // Constraint represents specific register(s).
2621     C_RegisterClass,       // Constraint represents any of register(s) in class.
2622     C_Memory,              // Memory constraint.
2623     C_Other,               // Something else.
2624     C_Unknown              // Unsupported constraint.
2625   };
2626
2627   enum ConstraintWeight {
2628     // Generic weights.
2629     CW_Invalid  = -1,     // No match.
2630     CW_Okay     = 0,      // Acceptable.
2631     CW_Good     = 1,      // Good weight.
2632     CW_Better   = 2,      // Better weight.
2633     CW_Best     = 3,      // Best weight.
2634
2635     // Well-known weights.
2636     CW_SpecificReg  = CW_Okay,    // Specific register operands.
2637     CW_Register     = CW_Good,    // Register operands.
2638     CW_Memory       = CW_Better,  // Memory operands.
2639     CW_Constant     = CW_Best,    // Constant operand.
2640     CW_Default      = CW_Okay     // Default or don't know type.
2641   };
2642
2643   /// This contains information for each constraint that we are lowering.
2644   struct AsmOperandInfo : public InlineAsm::ConstraintInfo {
2645     /// This contains the actual string for the code, like "m".  TargetLowering
2646     /// picks the 'best' code from ConstraintInfo::Codes that most closely
2647     /// matches the operand.
2648     std::string ConstraintCode;
2649
2650     /// Information about the constraint code, e.g. Register, RegisterClass,
2651     /// Memory, Other, Unknown.
2652     TargetLowering::ConstraintType ConstraintType;
2653
2654     /// If this is the result output operand or a clobber, this is null,
2655     /// otherwise it is the incoming operand to the CallInst.  This gets
2656     /// modified as the asm is processed.
2657     Value *CallOperandVal;
2658
2659     /// The ValueType for the operand value.
2660     MVT ConstraintVT;
2661
2662     /// Return true of this is an input operand that is a matching constraint
2663     /// like "4".
2664     bool isMatchingInputConstraint() const;
2665
2666     /// If this is an input matching constraint, this method returns the output
2667     /// operand it matches.
2668     unsigned getMatchedOperand() const;
2669
2670     /// Copy constructor for copying from a ConstraintInfo.
2671     AsmOperandInfo(InlineAsm::ConstraintInfo Info)
2672         : InlineAsm::ConstraintInfo(std::move(Info)),
2673           ConstraintType(TargetLowering::C_Unknown), CallOperandVal(nullptr),
2674           ConstraintVT(MVT::Other) {}
2675   };
2676
2677   typedef std::vector<AsmOperandInfo> AsmOperandInfoVector;
2678
2679   /// Split up the constraint string from the inline assembly value into the
2680   /// specific constraints and their prefixes, and also tie in the associated
2681   /// operand values.  If this returns an empty vector, and if the constraint
2682   /// string itself isn't empty, there was an error parsing.
2683   virtual AsmOperandInfoVector ParseConstraints(const DataLayout &DL,
2684                                                 const TargetRegisterInfo *TRI,
2685                                                 ImmutableCallSite CS) const;
2686
2687   /// Examine constraint type and operand type and determine a weight value.
2688   /// The operand object must already have been set up with the operand type.
2689   virtual ConstraintWeight getMultipleConstraintMatchWeight(
2690       AsmOperandInfo &info, int maIndex) const;
2691
2692   /// Examine constraint string and operand type and determine a weight value.
2693   /// The operand object must already have been set up with the operand type.
2694   virtual ConstraintWeight getSingleConstraintMatchWeight(
2695       AsmOperandInfo &info, const char *constraint) const;
2696
2697   /// Determines the constraint code and constraint type to use for the specific
2698   /// AsmOperandInfo, setting OpInfo.ConstraintCode and OpInfo.ConstraintType.
2699   /// If the actual operand being passed in is available, it can be passed in as
2700   /// Op, otherwise an empty SDValue can be passed.
2701   virtual void ComputeConstraintToUse(AsmOperandInfo &OpInfo,
2702                                       SDValue Op,
2703                                       SelectionDAG *DAG = nullptr) const;
2704
2705   /// Given a constraint, return the type of constraint it is for this target.
2706   virtual ConstraintType getConstraintType(StringRef Constraint) const;
2707
2708   /// Given a physical register constraint (e.g.  {edx}), return the register
2709   /// number and the register class for the register.
2710   ///
2711   /// Given a register class constraint, like 'r', if this corresponds directly
2712   /// to an LLVM register class, return a register of 0 and the register class
2713   /// pointer.
2714   ///
2715   /// This should only be used for C_Register constraints.  On error, this
2716   /// returns a register number of 0 and a null register class pointer.
2717   virtual std::pair<unsigned, const TargetRegisterClass *>
2718   getRegForInlineAsmConstraint(const TargetRegisterInfo *TRI,
2719                                StringRef Constraint, MVT VT) const;
2720
2721   virtual unsigned getInlineAsmMemConstraint(StringRef ConstraintCode) const {
2722     if (ConstraintCode == "i")
2723       return InlineAsm::Constraint_i;
2724     else if (ConstraintCode == "m")
2725       return InlineAsm::Constraint_m;
2726     return InlineAsm::Constraint_Unknown;
2727   }
2728
2729   /// Try to replace an X constraint, which matches anything, with another that
2730   /// has more specific requirements based on the type of the corresponding
2731   /// operand.  This returns null if there is no replacement to make.
2732   virtual const char *LowerXConstraint(EVT ConstraintVT) const;
2733
2734   /// Lower the specified operand into the Ops vector.  If it is invalid, don't
2735   /// add anything to Ops.
2736   virtual void LowerAsmOperandForConstraint(SDValue Op, std::string &Constraint,
2737                                             std::vector<SDValue> &Ops,
2738                                             SelectionDAG &DAG) const;
2739
2740   //===--------------------------------------------------------------------===//
2741   // Div utility functions
2742   //
2743   SDValue BuildSDIV(SDNode *N, const APInt &Divisor, SelectionDAG &DAG,
2744                     bool IsAfterLegalization,
2745                     std::vector<SDNode *> *Created) const;
2746   SDValue BuildUDIV(SDNode *N, const APInt &Divisor, SelectionDAG &DAG,
2747                     bool IsAfterLegalization,
2748                     std::vector<SDNode *> *Created) const;
2749
2750   /// Targets may override this function to provide custom SDIV lowering for
2751   /// power-of-2 denominators.  If the target returns an empty SDValue, LLVM
2752   /// assumes SDIV is expensive and replaces it with a series of other integer
2753   /// operations.
2754   virtual SDValue BuildSDIVPow2(SDNode *N, const APInt &Divisor,
2755                                 SelectionDAG &DAG,
2756                                 std::vector<SDNode *> *Created) const;
2757
2758   /// Indicate whether this target prefers to combine FDIVs with the same
2759   /// divisor. If the transform should never be done, return zero. If the
2760   /// transform should be done, return the minimum number of divisor uses
2761   /// that must exist.
2762   virtual unsigned combineRepeatedFPDivisors() const {
2763     return 0;
2764   }
2765
2766   /// Hooks for building estimates in place of slower divisions and square
2767   /// roots.
2768
2769   /// Return a reciprocal square root estimate value for the input operand.
2770   /// The RefinementSteps output is the number of Newton-Raphson refinement
2771   /// iterations required to generate a sufficient (though not necessarily
2772   /// IEEE-754 compliant) estimate for the value type.
2773   /// The boolean UseOneConstNR output is used to select a Newton-Raphson
2774   /// algorithm implementation that uses one constant or two constants.
2775   /// A target may choose to implement its own refinement within this function.
2776   /// If that's true, then return '0' as the number of RefinementSteps to avoid
2777   /// any further refinement of the estimate.
2778   /// An empty SDValue return means no estimate sequence can be created.
2779   virtual SDValue getRsqrtEstimate(SDValue Operand, DAGCombinerInfo &DCI,
2780                                    unsigned &RefinementSteps,
2781                                    bool &UseOneConstNR) const {
2782     return SDValue();
2783   }
2784
2785   /// Return a reciprocal estimate value for the input operand.
2786   /// The RefinementSteps output is the number of Newton-Raphson refinement
2787   /// iterations required to generate a sufficient (though not necessarily
2788   /// IEEE-754 compliant) estimate for the value type.
2789   /// A target may choose to implement its own refinement within this function.
2790   /// If that's true, then return '0' as the number of RefinementSteps to avoid
2791   /// any further refinement of the estimate.
2792   /// An empty SDValue return means no estimate sequence can be created.
2793   virtual SDValue getRecipEstimate(SDValue Operand, DAGCombinerInfo &DCI,
2794                                    unsigned &RefinementSteps) const {
2795     return SDValue();
2796   }
2797
2798   //===--------------------------------------------------------------------===//
2799   // Legalization utility functions
2800   //
2801
2802   /// Expand a MUL into two nodes.  One that computes the high bits of
2803   /// the result and one that computes the low bits.
2804   /// \param HiLoVT The value type to use for the Lo and Hi nodes.
2805   /// \param LL Low bits of the LHS of the MUL.  You can use this parameter
2806   ///        if you want to control how low bits are extracted from the LHS.
2807   /// \param LH High bits of the LHS of the MUL.  See LL for meaning.
2808   /// \param RL Low bits of the RHS of the MUL.  See LL for meaning
2809   /// \param RH High bits of the RHS of the MUL.  See LL for meaning.
2810   /// \returns true if the node has been expanded. false if it has not
2811   bool expandMUL(SDNode *N, SDValue &Lo, SDValue &Hi, EVT HiLoVT,
2812                  SelectionDAG &DAG, SDValue LL = SDValue(),
2813                  SDValue LH = SDValue(), SDValue RL = SDValue(),
2814                  SDValue RH = SDValue()) const;
2815
2816   /// Expand float(f32) to SINT(i64) conversion
2817   /// \param N Node to expand
2818   /// \param Result output after conversion
2819   /// \returns True, if the expansion was successful, false otherwise
2820   bool expandFP_TO_SINT(SDNode *N, SDValue &Result, SelectionDAG &DAG) const;
2821
2822   //===--------------------------------------------------------------------===//
2823   // Instruction Emitting Hooks
2824   //
2825
2826   /// This method should be implemented by targets that mark instructions with
2827   /// the 'usesCustomInserter' flag.  These instructions are special in various
2828   /// ways, which require special support to insert.  The specified MachineInstr
2829   /// is created but not inserted into any basic blocks, and this method is
2830   /// called to expand it into a sequence of instructions, potentially also
2831   /// creating new basic blocks and control flow.
2832   /// As long as the returned basic block is different (i.e., we created a new
2833   /// one), the custom inserter is free to modify the rest of \p MBB.
2834   virtual MachineBasicBlock *
2835     EmitInstrWithCustomInserter(MachineInstr *MI, MachineBasicBlock *MBB) const;
2836
2837   /// This method should be implemented by targets that mark instructions with
2838   /// the 'hasPostISelHook' flag. These instructions must be adjusted after
2839   /// instruction selection by target hooks.  e.g. To fill in optional defs for
2840   /// ARM 's' setting instructions.
2841   virtual void
2842   AdjustInstrPostInstrSelection(MachineInstr *MI, SDNode *Node) const;
2843
2844   /// If this function returns true, SelectionDAGBuilder emits a
2845   /// LOAD_STACK_GUARD node when it is lowering Intrinsic::stackprotector.
2846   virtual bool useLoadStackGuardNode() const {
2847     return false;
2848   }
2849
2850   /// Lower TLS global address SDNode for target independent emulated TLS model.
2851   virtual SDValue LowerToTLSEmulatedModel(const GlobalAddressSDNode *GA,
2852                                           SelectionDAG &DAG) const;
2853 };
2854
2855 /// Given an LLVM IR type and return type attributes, compute the return value
2856 /// EVTs and flags, and optionally also the offsets, if the return value is
2857 /// being lowered to memory.
2858 void GetReturnInfo(Type *ReturnType, AttributeSet attr,
2859                    SmallVectorImpl<ISD::OutputArg> &Outs,
2860                    const TargetLowering &TLI, const DataLayout &DL);
2861
2862 } // end llvm namespace
2863
2864 #endif