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