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