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