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