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