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