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