include/llvm/Target/TargetLowering.h

   1 //===-- llvm/Target/TargetLowering.h - Target Lowering Info -----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file describes how to lower LLVM code to machine code.  This has two
  11 // main components:
  12 //
  13 //  1. Which ValueTypes are natively supported by the target.
  14 //  2. Which operations are supported for supported ValueTypes.
  15 //  3. Cost thresholds for alternative implementations of certain operations.
  16 //
  17 // In addition it has a few other components, like information about FP
  18 // immediates.
  19 //
  20 //===----------------------------------------------------------------------===//
  21
  22 #ifndef LLVM_TARGET_TARGETLOWERING_H
  23 #define LLVM_TARGET_TARGETLOWERING_H
  24
  25 #include "llvm/Type.h"
  26 #include "llvm/CodeGen/SelectionDAGNodes.h"
  27 #include <map>
  28
  29 namespace llvm {
  30   class Value;
  31   class Function;
  32   class TargetMachine;
  33   class TargetData;
  34   class TargetRegisterClass;
  35   class SDNode;
  36   class SDOperand;
  37   class SelectionDAG;
  38   class MachineBasicBlock;
  39   class MachineInstr;
  40
  41 //===----------------------------------------------------------------------===//
  42 /// TargetLowering - This class defines information used to lower LLVM code to
  43 /// legal SelectionDAG operators that the target instruction selector can accept
  44 /// natively.
  45 ///
  46 /// This class also defines callbacks that targets must implement to lower
  47 /// target-specific constructs to SelectionDAG operators.
  48 ///
  49 class TargetLowering {
  50 public:
  51   /// LegalizeAction - This enum indicates whether operations are valid for a
  52   /// target, and if not, what action should be used to make them valid.
  53   enum LegalizeAction {
  54     Legal,      // The target natively supports this operation.
  55     Promote,    // This operation should be executed in a larger type.
  56     Expand,     // Try to expand this to other ops, otherwise use a libcall.
  57     Custom      // Use the LowerOperation hook to implement custom lowering.
  58   };
  59
  60   enum OutOfRangeShiftAmount {
  61     Undefined,  // Oversized shift amounts are undefined (default).
  62     Mask,       // Shift amounts are auto masked (anded) to value size.
  63     Extend      // Oversized shift pulls in zeros or sign bits.
  64   };
  65
  66   enum SetCCResultValue {
  67     UndefinedSetCCResult,          // SetCC returns a garbage/unknown extend.
  68     ZeroOrOneSetCCResult,          // SetCC returns a zero extended result.
  69     ZeroOrNegativeOneSetCCResult   // SetCC returns a sign extended result.
  70   };
  71
  72   enum SchedPreference {
  73     SchedulingForLatency,          // Scheduling for shortest total latency.
  74     SchedulingForRegPressure       // Scheduling for lowest register pressure.
  75   };
  76
  77   TargetLowering(TargetMachine &TM);
  78   virtual ~TargetLowering();
  79
  80   TargetMachine &getTargetMachine() const { return TM; }
  81   const TargetData *getTargetData() const { return TD; }
  82
  83   bool isLittleEndian() const { return IsLittleEndian; }
  84   MVT::ValueType getPointerTy() const { return PointerTy; }
  85   MVT::ValueType getShiftAmountTy() const { return ShiftAmountTy; }
  86   OutOfRangeShiftAmount getShiftAmountFlavor() const {return ShiftAmtHandling; }
  87
  88   /// usesGlobalOffsetTable - Return true if this target uses a GOT for PIC
  89   /// codegen.
  90   bool usesGlobalOffsetTable() const { return UsesGlobalOffsetTable; }
  91
  92   /// isSetCCExpensive - Return true if the setcc operation is expensive for
  93   /// this target.
  94   bool isSetCCExpensive() const { return SetCCIsExpensive; }
  95
  96   /// isIntDivCheap() - Return true if integer divide is usually cheaper than
  97   /// a sequence of several shifts, adds, and multiplies for this target.
  98   bool isIntDivCheap() const { return IntDivIsCheap; }
  99
 100   /// isPow2DivCheap() - Return true if pow2 div is cheaper than a chain of
 101   /// srl/add/sra.
 102   bool isPow2DivCheap() const { return Pow2DivIsCheap; }
 103
 104   /// getSetCCResultTy - Return the ValueType of the result of setcc operations.
 105   ///
 106   MVT::ValueType getSetCCResultTy() const { return SetCCResultTy; }
 107
 108   /// getSetCCResultContents - For targets without boolean registers, this flag
 109   /// returns information about the contents of the high-bits in the setcc
 110   /// result register.
 111   SetCCResultValue getSetCCResultContents() const { return SetCCResultContents;}
 112
 113   /// getSchedulingPreference - Return target scheduling preference.
 114   SchedPreference getSchedulingPreference() const {
 115     return SchedPreferenceInfo;
 116   }
 117
 118   /// getRegClassFor - Return the register class that should be used for the
 119   /// specified value type.  This may only be called on legal types.
 120   TargetRegisterClass *getRegClassFor(MVT::ValueType VT) const {
 121     TargetRegisterClass *RC = RegClassForVT[VT];
 122     assert(RC && "This value type is not natively supported!");
 123     return RC;
 124   }
 125
 126   /// isTypeLegal - Return true if the target has native support for the
 127   /// specified value type.  This means that it has a register that directly
 128   /// holds it without promotions or expansions.
 129   bool isTypeLegal(MVT::ValueType VT) const {
 130     return RegClassForVT[VT] != 0;
 131   }
 132
 133   class ValueTypeActionImpl {
 134     /// ValueTypeActions - This is a bitvector that contains two bits for each
 135     /// value type, where the two bits correspond to the LegalizeAction enum.
 136     /// This can be queried with "getTypeAction(VT)".
 137     uint32_t ValueTypeActions[2];
 138   public:
 139     ValueTypeActionImpl() {
 140       ValueTypeActions[0] = ValueTypeActions[1] = 0;
 141     }
 142     ValueTypeActionImpl(const ValueTypeActionImpl &RHS) {
 143       ValueTypeActions[0] = RHS.ValueTypeActions[0];
 144       ValueTypeActions[1] = RHS.ValueTypeActions[1];
 145     }
 146
 147     LegalizeAction getTypeAction(MVT::ValueType VT) const {
 148       return (LegalizeAction)((ValueTypeActions[VT>>4] >> ((2*VT) & 31)) & 3);
 149     }
 150     void setTypeAction(MVT::ValueType VT, LegalizeAction Action) {
 151       assert(unsigned(VT >> 4) <
 152              sizeof(ValueTypeActions)/sizeof(ValueTypeActions[0]));
 153       ValueTypeActions[VT>>4] |= Action << ((VT*2) & 31);
 154     }
 155   };
 156
 157   const ValueTypeActionImpl &getValueTypeActions() const {
 158     return ValueTypeActions;
 159   }
 160
 161   /// getTypeAction - Return how we should legalize values of this type, either
 162   /// it is already legal (return 'Legal') or we need to promote it to a larger
 163   /// type (return 'Promote'), or we need to expand it into multiple registers
 164   /// of smaller integer type (return 'Expand').  'Custom' is not an option.
 165   LegalizeAction getTypeAction(MVT::ValueType VT) const {
 166     return ValueTypeActions.getTypeAction(VT);
 167   }
 168
 169   /// getTypeToTransformTo - For types supported by the target, this is an
 170   /// identity function.  For types that must be promoted to larger types, this
 171   /// returns the larger type to promote to.  For types that are larger than the
 172   /// largest integer register, this contains one step in the expansion to get
 173   /// to the smaller register.
 174   MVT::ValueType getTypeToTransformTo(MVT::ValueType VT) const {
 175     return TransformToType[VT];
 176   }
 177
 178   /// getPackedTypeBreakdown - Packed types are broken down into some number of
 179   /// legal first class types.  For example, <8 x float> maps to 2 MVT::v4f32
 180   /// with Altivec or SSE1, or 8 promoted MVT::f64 values with the X86 FP stack.
 181   /// Similarly, <2 x long> turns into 4 MVT::i32 values with both PPC and X86.
 182   ///
 183   /// This method returns the number of registers needed, and the VT for each
 184   /// register.  It also returns the VT of the PackedType elements before they
 185   /// are promoted/expanded.
 186   ///
 187   unsigned getPackedTypeBreakdown(const PackedType *PTy,
 188                                   MVT::ValueType &PTyElementVT,
 189                                   MVT::ValueType &PTyLegalElementVT) const;
 190
 191   typedef std::vector<double>::const_iterator legal_fpimm_iterator;
 192   legal_fpimm_iterator legal_fpimm_begin() const {
 193     return LegalFPImmediates.begin();
 194   }
 195   legal_fpimm_iterator legal_fpimm_end() const {
 196     return LegalFPImmediates.end();
 197   }
 198
 199   /// isShuffleMaskLegal - Targets can use this to indicate that they only
 200   /// support *some* VECTOR_SHUFFLE operations, those with specific masks.
 201   /// By default, if a target supports the VECTOR_SHUFFLE node, all mask values
 202   /// are assumed to be legal.
 203   virtual bool isShuffleMaskLegal(SDOperand Mask, MVT::ValueType VT) const {
 204     return true;
 205   }
 206
 207   /// isVectorClearMaskLegal - Similar to isShuffleMaskLegal. This is
 208   /// used by Targets can use this to indicate if there is a suitable
 209   /// VECTOR_SHUFFLE that can be used to replace a VAND with a constant
 210   /// pool entry.
 211   virtual bool isVectorClearMaskLegal(std::vector<SDOperand> &BVOps,
 212                                       MVT::ValueType EVT,
 213                                       SelectionDAG &DAG) const {
 214     return false;
 215   }
 216
 217   /// getOperationAction - Return how this operation should be treated: either
 218   /// it is legal, needs to be promoted to a larger size, needs to be
 219   /// expanded to some other code sequence, or the target has a custom expander
 220   /// for it.
 221   LegalizeAction getOperationAction(unsigned Op, MVT::ValueType VT) const {
 222     return (LegalizeAction)((OpActions[Op] >> (2*VT)) & 3);
 223   }
 224
 225   /// isOperationLegal - Return true if the specified operation is legal on this
 226   /// target.
 227   bool isOperationLegal(unsigned Op, MVT::ValueType VT) const {
 228     return getOperationAction(Op, VT) == Legal ||
 229            getOperationAction(Op, VT) == Custom;
 230   }
 231
 232   /// getLoadXAction - Return how this load with extension should be treated:
 233   /// either it is legal, needs to be promoted to a larger size, needs to be
 234   /// expanded to some other code sequence, or the target has a custom expander
 235   /// for it.
 236   LegalizeAction getLoadXAction(unsigned LType, MVT::ValueType VT) const {
 237     return (LegalizeAction)((LoadXActions[LType] >> (2*VT)) & 3);
 238   }
 239
 240   /// isLoadXLegal - Return true if the specified load with extension is legal
 241   /// on this target.
 242   bool isLoadXLegal(unsigned LType, MVT::ValueType VT) const {
 243     return getLoadXAction(LType, VT) == Legal ||
 244            getLoadXAction(LType, VT) == Custom;
 245   }
 246
 247   /// getStoreXAction - Return how this store with truncation should be treated:
 248   /// either it is legal, needs to be promoted to a larger size, needs to be
 249   /// expanded to some other code sequence, or the target has a custom expander
 250   /// for it.
 251   LegalizeAction getStoreXAction(MVT::ValueType VT) const {
 252     return (LegalizeAction)((StoreXActions >> (2*VT)) & 3);
 253   }
 254
 255   /// isStoreXLegal - Return true if the specified store with truncation is
 256   /// legal on this target.
 257   bool isStoreXLegal(MVT::ValueType VT) const {
 258     return getStoreXAction(VT) == Legal || getStoreXAction(VT) == Custom;
 259   }
 260
 261   /// getIndexedLoadAction - Return how the indexed load should be treated:
 262   /// either it is legal, needs to be promoted to a larger size, needs to be
 263   /// expanded to some other code sequence, or the target has a custom expander
 264   /// for it.
 265   LegalizeAction
 266   getIndexedLoadAction(unsigned IdxMode, MVT::ValueType VT) const {
 267     return (LegalizeAction)((IndexedModeActions[0][IdxMode] >> (2*VT)) & 3);
 268   }
 269
 270   /// isIndexedLoadLegal - Return true if the specified indexed load is legal
 271   /// on this target.
 272   bool isIndexedLoadLegal(unsigned IdxMode, MVT::ValueType VT) const {
 273     return getIndexedLoadAction(IdxMode, VT) == Legal ||
 274            getIndexedLoadAction(IdxMode, VT) == Custom;
 275   }
 276
 277   /// getIndexedStoreAction - Return how the indexed store should be treated:
 278   /// either it is legal, needs to be promoted to a larger size, needs to be
 279   /// expanded to some other code sequence, or the target has a custom expander
 280   /// for it.
 281   LegalizeAction
 282   getIndexedStoreAction(unsigned IdxMode, MVT::ValueType VT) const {
 283     return (LegalizeAction)((IndexedModeActions[1][IdxMode] >> (2*VT)) & 3);
 284   }
 285
 286   /// isIndexedStoreLegal - Return true if the specified indexed load is legal
 287   /// on this target.
 288   bool isIndexedStoreLegal(unsigned IdxMode, MVT::ValueType VT) const {
 289     return getIndexedStoreAction(IdxMode, VT) == Legal ||
 290            getIndexedStoreAction(IdxMode, VT) == Custom;
 291   }
 292
 293   /// getTypeToPromoteTo - If the action for this operation is to promote, this
 294   /// method returns the ValueType to promote to.
 295   MVT::ValueType getTypeToPromoteTo(unsigned Op, MVT::ValueType VT) const {
 296     assert(getOperationAction(Op, VT) == Promote &&
 297            "This operation isn't promoted!");
 298
 299     // See if this has an explicit type specified.
 300     std::map<std::pair<unsigned, MVT::ValueType>,
 301              MVT::ValueType>::const_iterator PTTI =
 302       PromoteToType.find(std::make_pair(Op, VT));
 303     if (PTTI != PromoteToType.end()) return PTTI->second;
 304
 305     assert((MVT::isInteger(VT) || MVT::isFloatingPoint(VT)) &&
 306            "Cannot autopromote this type, add it with AddPromotedToType.");
 307
 308     MVT::ValueType NVT = VT;
 309     do {
 310       NVT = (MVT::ValueType)(NVT+1);
 311       assert(MVT::isInteger(NVT) == MVT::isInteger(VT) && NVT != MVT::isVoid &&
 312              "Didn't find type to promote to!");
 313     } while (!isTypeLegal(NVT) ||
 314               getOperationAction(Op, NVT) == Promote);
 315     return NVT;
 316   }
 317
 318   /// getValueType - Return the MVT::ValueType corresponding to this LLVM type.
 319   /// This is fixed by the LLVM operations except for the pointer size.
 320   MVT::ValueType getValueType(const Type *Ty) const {
 321     switch (Ty->getTypeID()) {
 322     default: assert(0 && "Unknown type!");
 323     case Type::VoidTyID:    return MVT::isVoid;
 324     case Type::BoolTyID:    return MVT::i1;
 325     case Type::UByteTyID:
 326     case Type::SByteTyID:   return MVT::i8;
 327     case Type::ShortTyID:
 328     case Type::UShortTyID:  return MVT::i16;
 329     case Type::IntTyID:
 330     case Type::UIntTyID:    return MVT::i32;
 331     case Type::LongTyID:
 332     case Type::ULongTyID:   return MVT::i64;
 333     case Type::FloatTyID:   return MVT::f32;
 334     case Type::DoubleTyID:  return MVT::f64;
 335     case Type::PointerTyID: return PointerTy;
 336     case Type::PackedTyID:  return MVT::Vector;
 337     }
 338   }
 339
 340   /// getNumElements - Return the number of registers that this ValueType will
 341   /// eventually require.  This is always one for all non-integer types, is
 342   /// one for any types promoted to live in larger registers, but may be more
 343   /// than one for types (like i64) that are split into pieces.
 344   unsigned getNumElements(MVT::ValueType VT) const {
 345     return NumElementsForVT[VT];
 346   }
 347
 348   /// hasTargetDAGCombine - If true, the target has custom DAG combine
 349   /// transformations that it can perform for the specified node.
 350   bool hasTargetDAGCombine(ISD::NodeType NT) const {
 351     return TargetDAGCombineArray[NT >> 3] & (1 << (NT&7));
 352   }
 353
 354   /// This function returns the maximum number of store operations permitted
 355   /// to replace a call to llvm.memset. The value is set by the target at the
 356   /// performance threshold for such a replacement.
 357   /// @brief Get maximum # of store operations permitted for llvm.memset
 358   unsigned getMaxStoresPerMemset() const { return maxStoresPerMemset; }
 359
 360   /// This function returns the maximum number of store operations permitted
 361   /// to replace a call to llvm.memcpy. The value is set by the target at the
 362   /// performance threshold for such a replacement.
 363   /// @brief Get maximum # of store operations permitted for llvm.memcpy
 364   unsigned getMaxStoresPerMemcpy() const { return maxStoresPerMemcpy; }
 365
 366   /// This function returns the maximum number of store operations permitted
 367   /// to replace a call to llvm.memmove. The value is set by the target at the
 368   /// performance threshold for such a replacement.
 369   /// @brief Get maximum # of store operations permitted for llvm.memmove
 370   unsigned getMaxStoresPerMemmove() const { return maxStoresPerMemmove; }
 371
 372   /// This function returns true if the target allows unaligned memory accesses.
 373   /// This is used, for example, in situations where an array copy/move/set is
 374   /// converted to a sequence of store operations. It's use helps to ensure that
 375   /// such replacements don't generate code that causes an alignment error
 376   /// (trap) on the target machine.
 377   /// @brief Determine if the target supports unaligned memory accesses.
 378   bool allowsUnalignedMemoryAccesses() const {
 379     return allowUnalignedMemoryAccesses;
 380   }
 381
 382   /// usesUnderscoreSetJmpLongJmp - Determine if we should use _setjmp or setjmp
 383   /// to implement llvm.setjmp.
 384   bool usesUnderscoreSetJmpLongJmp() const {
 385     return UseUnderscoreSetJmpLongJmp;
 386   }
 387
 388   /// getStackPointerRegisterToSaveRestore - If a physical register, this
 389   /// specifies the register that llvm.savestack/llvm.restorestack should save
 390   /// and restore.
 391   unsigned getStackPointerRegisterToSaveRestore() const {
 392     return StackPointerRegisterToSaveRestore;
 393   }
 394
 395   /// getJumpBufSize - returns the target's jmp_buf size in bytes (if never
 396   /// set, the default is 200)
 397   unsigned getJumpBufSize() const {
 398     return JumpBufSize;
 399   }
 400
 401   /// getJumpBufAlignment - returns the target's jmp_buf alignment in bytes
 402   /// (if never set, the default is 0)
 403   unsigned getJumpBufAlignment() const {
 404     return JumpBufAlignment;
 405   }
 406
 407   /// getPreIndexedAddressParts - returns true by value, base pointer and
 408   /// offset pointer and addressing mode by reference if the node's address
 409   /// can be legally represented as pre-indexed load / store address.
 410   virtual bool getPreIndexedAddressParts(SDNode *N, SDOperand &Base,
 411                                          SDOperand &Offset,
 412                                          ISD::MemIndexedMode &AM,
 413                                          SelectionDAG &DAG) {
 414     return false;
 415   }
 416
 417   /// getPostIndexedAddressParts - returns true by value, base pointer and
 418   /// offset pointer and addressing mode by reference if this node can be
 419   /// combined with a load / store to form a post-indexed load / store.
 420   virtual bool getPostIndexedAddressParts(SDNode *N, SDNode *Op,
 421                                           SDOperand &Base, SDOperand &Offset,
 422                                           ISD::MemIndexedMode &AM,
 423                                           SelectionDAG &DAG) {
 424     return false;
 425   }
 426
 427   //===--------------------------------------------------------------------===//
 428   // TargetLowering Optimization Methods
 429   //
 430
 431   /// TargetLoweringOpt - A convenience struct that encapsulates a DAG, and two
 432   /// SDOperands for returning information from TargetLowering to its clients
 433   /// that want to combine
 434   struct TargetLoweringOpt {
 435     SelectionDAG &DAG;
 436     SDOperand Old;
 437     SDOperand New;
 438
 439     TargetLoweringOpt(SelectionDAG &InDAG) : DAG(InDAG) {}
 440
 441     bool CombineTo(SDOperand O, SDOperand N) {
 442       Old = O;
 443       New = N;
 444       return true;
 445     }
 446
 447     /// ShrinkDemandedConstant - Check to see if the specified operand of the
 448     /// specified instruction is a constant integer.  If so, check to see if there
 449     /// are any bits set in the constant that are not demanded.  If so, shrink the
 450     /// constant and return true.
 451     bool ShrinkDemandedConstant(SDOperand Op, uint64_t Demanded);
 452   };
 453
 454   /// MaskedValueIsZero - Return true if 'Op & Mask' is known to be zero.  We
 455   /// use this predicate to simplify operations downstream.  Op and Mask are
 456   /// known to be the same type.
 457   bool MaskedValueIsZero(SDOperand Op, uint64_t Mask, unsigned Depth = 0)
 458     const;
 459
 460   /// ComputeMaskedBits - Determine which of the bits specified in Mask are
 461   /// known to be either zero or one and return them in the KnownZero/KnownOne
 462   /// bitsets.  This code only analyzes bits in Mask, in order to short-circuit
 463   /// processing.  Targets can implement the computeMaskedBitsForTargetNode
 464   /// method, to allow target nodes to be understood.
 465   void ComputeMaskedBits(SDOperand Op, uint64_t Mask, uint64_t &KnownZero,
 466                          uint64_t &KnownOne, unsigned Depth = 0) const;
 467
 468   /// SimplifyDemandedBits - Look at Op.  At this point, we know that only the
 469   /// DemandedMask bits of the result of Op are ever used downstream.  If we can
 470   /// use this information to simplify Op, create a new simplified DAG node and
 471   /// return true, returning the original and new nodes in Old and New.
 472   /// Otherwise, analyze the expression and return a mask of KnownOne and
 473   /// KnownZero bits for the expression (used to simplify the caller).
 474   /// The KnownZero/One bits may only be accurate for those bits in the
 475   /// DemandedMask.
 476   bool SimplifyDemandedBits(SDOperand Op, uint64_t DemandedMask,
 477                             uint64_t &KnownZero, uint64_t &KnownOne,
 478                             TargetLoweringOpt &TLO, unsigned Depth = 0) const;
 479
 480   /// computeMaskedBitsForTargetNode - Determine which of the bits specified in
 481   /// Mask are known to be either zero or one and return them in the
 482   /// KnownZero/KnownOne bitsets.
 483   virtual void computeMaskedBitsForTargetNode(const SDOperand Op,
 484                                               uint64_t Mask,
 485                                               uint64_t &KnownZero,
 486                                               uint64_t &KnownOne,
 487                                               unsigned Depth = 0) const;
 488
 489   /// ComputeNumSignBits - Return the number of times the sign bit of the
 490   /// register is replicated into the other bits.  We know that at least 1 bit
 491   /// is always equal to the sign bit (itself), but other cases can give us
 492   /// information.  For example, immediately after an "SRA X, 2", we know that
 493   /// the top 3 bits are all equal to each other, so we return 3.
 494   unsigned ComputeNumSignBits(SDOperand Op, unsigned Depth = 0) const;
 495
 496   /// ComputeNumSignBitsForTargetNode - This method can be implemented by
 497   /// targets that want to expose additional information about sign bits to the
 498   /// DAG Combiner.
 499   virtual unsigned ComputeNumSignBitsForTargetNode(SDOperand Op,
 500                                                    unsigned Depth = 0) const;
 501
 502   struct DAGCombinerInfo {
 503     void *DC;  // The DAG Combiner object.
 504     bool BeforeLegalize;
 505   public:
 506     SelectionDAG &DAG;
 507
 508     DAGCombinerInfo(SelectionDAG &dag, bool bl, void *dc)
 509       : DC(dc), BeforeLegalize(bl), DAG(dag) {}
 510
 511     bool isBeforeLegalize() const { return BeforeLegalize; }
 512
 513     void AddToWorklist(SDNode *N);
 514     SDOperand CombineTo(SDNode *N, const std::vector<SDOperand> &To);
 515     SDOperand CombineTo(SDNode *N, SDOperand Res);
 516     SDOperand CombineTo(SDNode *N, SDOperand Res0, SDOperand Res1);
 517   };
 518
 519   /// PerformDAGCombine - This method will be invoked for all target nodes and
 520   /// for any target-independent nodes that the target has registered with
 521   /// invoke it for.
 522   ///
 523   /// The semantics are as follows:
 524   /// Return Value:
 525   ///   SDOperand.Val == 0   - No change was made
 526   ///   SDOperand.Val == N   - N was replaced, is dead, and is already handled.
 527   ///   otherwise            - N should be replaced by the returned Operand.
 528   ///
 529   /// In addition, methods provided by DAGCombinerInfo may be used to perform
 530   /// more complex transformations.
 531   ///
 532   virtual SDOperand PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const;
 533
 534   //===--------------------------------------------------------------------===//
 535   // TargetLowering Configuration Methods - These methods should be invoked by
 536   // the derived class constructor to configure this object for the target.
 537   //
 538
 539 protected:
 540   /// setUsesGlobalOffsetTable - Specify that this target does or doesn't use a
 541   /// GOT for PC-relative code.
 542   void setUsesGlobalOffsetTable(bool V) { UsesGlobalOffsetTable = V; }
 543
 544   /// setShiftAmountType - Describe the type that should be used for shift
 545   /// amounts.  This type defaults to the pointer type.
 546   void setShiftAmountType(MVT::ValueType VT) { ShiftAmountTy = VT; }
 547
 548   /// setSetCCResultType - Describe the type that shoudl be used as the result
 549   /// of a setcc operation.  This defaults to the pointer type.
 550   void setSetCCResultType(MVT::ValueType VT) { SetCCResultTy = VT; }
 551
 552   /// setSetCCResultContents - Specify how the target extends the result of a
 553   /// setcc operation in a register.
 554   void setSetCCResultContents(SetCCResultValue Ty) { SetCCResultContents = Ty; }
 555
 556   /// setSchedulingPreference - Specify the target scheduling preference.
 557   void setSchedulingPreference(SchedPreference Pref) {
 558     SchedPreferenceInfo = Pref;
 559   }
 560
 561   /// setShiftAmountFlavor - Describe how the target handles out of range shift
 562   /// amounts.
 563   void setShiftAmountFlavor(OutOfRangeShiftAmount OORSA) {
 564     ShiftAmtHandling = OORSA;
 565   }
 566
 567   /// setUseUnderscoreSetJmpLongJmp - Indicate whether this target prefers to
 568   /// use _setjmp and _longjmp to or implement llvm.setjmp/llvm.longjmp or
 569   /// the non _ versions.  Defaults to false.
 570   void setUseUnderscoreSetJmpLongJmp(bool Val) {
 571     UseUnderscoreSetJmpLongJmp = Val;
 572   }
 573
 574   /// setStackPointerRegisterToSaveRestore - If set to a physical register, this
 575   /// specifies the register that llvm.savestack/llvm.restorestack should save
 576   /// and restore.
 577   void setStackPointerRegisterToSaveRestore(unsigned R) {
 578     StackPointerRegisterToSaveRestore = R;
 579   }
 580
 581   /// setSetCCIxExpensive - This is a short term hack for targets that codegen
 582   /// setcc as a conditional branch.  This encourages the code generator to fold
 583   /// setcc operations into other operations if possible.
 584   void setSetCCIsExpensive() { SetCCIsExpensive = true; }
 585
 586   /// setIntDivIsCheap - Tells the code generator that integer divide is
 587   /// expensive, and if possible, should be replaced by an alternate sequence
 588   /// of instructions not containing an integer divide.
 589   void setIntDivIsCheap(bool isCheap = true) { IntDivIsCheap = isCheap; }
 590
 591   /// setPow2DivIsCheap - Tells the code generator that it shouldn't generate
 592   /// srl/add/sra for a signed divide by power of two, and let the target handle
 593   /// it.
 594   void setPow2DivIsCheap(bool isCheap = true) { Pow2DivIsCheap = isCheap; }
 595
 596   /// addRegisterClass - Add the specified register class as an available
 597   /// regclass for the specified value type.  This indicates the selector can
 598   /// handle values of that class natively.
 599   void addRegisterClass(MVT::ValueType VT, TargetRegisterClass *RC) {
 600     AvailableRegClasses.push_back(std::make_pair(VT, RC));
 601     RegClassForVT[VT] = RC;
 602   }
 603
 604   /// computeRegisterProperties - Once all of the register classes are added,
 605   /// this allows us to compute derived properties we expose.
 606   void computeRegisterProperties();
 607
 608   /// setOperationAction - Indicate that the specified operation does not work
 609   /// with the specified type and indicate what to do about it.
 610   void setOperationAction(unsigned Op, MVT::ValueType VT,
 611                           LegalizeAction Action) {
 612     assert(VT < 32 && Op < sizeof(OpActions)/sizeof(OpActions[0]) &&
 613            "Table isn't big enough!");
 614     OpActions[Op] &= ~(uint64_t(3UL) << VT*2);
 615     OpActions[Op] |= (uint64_t)Action << VT*2;
 616   }
 617
 618   /// setLoadXAction - Indicate that the specified load with extension does not
 619   /// work with the with specified type and indicate what to do about it.
 620   void setLoadXAction(unsigned ExtType, MVT::ValueType VT,
 621                       LegalizeAction Action) {
 622     assert(VT < 32 && ExtType < sizeof(LoadXActions)/sizeof(LoadXActions[0]) &&
 623            "Table isn't big enough!");
 624     LoadXActions[ExtType] &= ~(uint64_t(3UL) << VT*2);
 625     LoadXActions[ExtType] |= (uint64_t)Action << VT*2;
 626   }
 627
 628   /// setStoreXAction - Indicate that the specified store with truncation does
 629   /// not work with the with specified type and indicate what to do about it.
 630   void setStoreXAction(MVT::ValueType VT, LegalizeAction Action) {
 631     assert(VT < 32 && "Table isn't big enough!");
 632     StoreXActions &= ~(uint64_t(3UL) << VT*2);
 633     StoreXActions |= (uint64_t)Action << VT*2;
 634   }
 635
 636   /// setIndexedLoadAction - Indicate that the specified indexed load does or
 637   /// does not work with the with specified type and indicate what to do abort
 638   /// it. NOTE: All indexed mode loads are initialized to Expand in
 639   /// TargetLowering.cpp
 640   void setIndexedLoadAction(unsigned IdxMode, MVT::ValueType VT,
 641                             LegalizeAction Action) {
 642     assert(VT < 32 && IdxMode <
 643            sizeof(IndexedModeActions[0]) / sizeof(IndexedModeActions[0][0]) &&
 644            "Table isn't big enough!");
 645     IndexedModeActions[0][IdxMode] &= ~(uint64_t(3UL) << VT*2);
 646     IndexedModeActions[0][IdxMode] |= (uint64_t)Action << VT*2;
 647   }
 648
 649   /// setIndexedStoreAction - Indicate that the specified indexed store does or
 650   /// does not work with the with specified type and indicate what to do about
 651   /// it. NOTE: All indexed mode stores are initialized to Expand in
 652   /// TargetLowering.cpp
 653   void setIndexedStoreAction(unsigned IdxMode, MVT::ValueType VT,
 654                              LegalizeAction Action) {
 655     assert(VT < 32 && IdxMode <
 656            sizeof(IndexedModeActions[1]) / sizeof(IndexedModeActions[1][0]) &&
 657            "Table isn't big enough!");
 658     IndexedModeActions[1][IdxMode] &= ~(uint64_t(3UL) << VT*2);
 659     IndexedModeActions[1][IdxMode] |= (uint64_t)Action << VT*2;
 660   }
 661
 662   /// AddPromotedToType - If Opc/OrigVT is specified as being promoted, the
 663   /// promotion code defaults to trying a larger integer/fp until it can find
 664   /// one that works.  If that default is insufficient, this method can be used
 665   /// by the target to override the default.
 666   void AddPromotedToType(unsigned Opc, MVT::ValueType OrigVT,
 667                          MVT::ValueType DestVT) {
 668     PromoteToType[std::make_pair(Opc, OrigVT)] = DestVT;
 669   }
 670
 671   /// addLegalFPImmediate - Indicate that this target can instruction select
 672   /// the specified FP immediate natively.
 673   void addLegalFPImmediate(double Imm) {
 674     LegalFPImmediates.push_back(Imm);
 675   }
 676
 677   /// setTargetDAGCombine - Targets should invoke this method for each target
 678   /// independent node that they want to provide a custom DAG combiner for by
 679   /// implementing the PerformDAGCombine virtual method.
 680   void setTargetDAGCombine(ISD::NodeType NT) {
 681     TargetDAGCombineArray[NT >> 3] |= 1 << (NT&7);
 682   }
 683
 684   /// setJumpBufSize - Set the target's required jmp_buf buffer size (in
 685   /// bytes); default is 200
 686   void setJumpBufSize(unsigned Size) {
 687     JumpBufSize = Size;
 688   }
 689
 690   /// setJumpBufAlignment - Set the target's required jmp_buf buffer
 691   /// alignment (in bytes); default is 0
 692   void setJumpBufAlignment(unsigned Align) {
 693     JumpBufAlignment = Align;
 694   }
 695
 696 public:
 697
 698   //===--------------------------------------------------------------------===//
 699   // Lowering methods - These methods must be implemented by targets so that
 700   // the SelectionDAGLowering code knows how to lower these.
 701   //
 702
 703   /// LowerArguments - This hook must be implemented to indicate how we should
 704   /// lower the arguments for the specified function, into the specified DAG.
 705   virtual std::vector<SDOperand>
 706   LowerArguments(Function &F, SelectionDAG &DAG);
 707
 708   /// LowerCallTo - This hook lowers an abstract call to a function into an
 709   /// actual call.  This returns a pair of operands.  The first element is the
 710   /// return value for the function (if RetTy is not VoidTy).  The second
 711   /// element is the outgoing token chain.
 712   typedef std::vector<std::pair<SDOperand, const Type*> > ArgListTy;
 713   virtual std::pair<SDOperand, SDOperand>
 714   LowerCallTo(SDOperand Chain, const Type *RetTy, bool isVarArg,
 715               unsigned CallingConv, bool isTailCall, SDOperand Callee,
 716               ArgListTy &Args, SelectionDAG &DAG);
 717
 718   /// LowerFrameReturnAddress - This hook lowers a call to llvm.returnaddress or
 719   /// llvm.frameaddress (depending on the value of the first argument).  The
 720   /// return values are the result pointer and the resultant token chain.  If
 721   /// not implemented, both of these intrinsics will return null.
 722   virtual std::pair<SDOperand, SDOperand>
 723   LowerFrameReturnAddress(bool isFrameAddr, SDOperand Chain, unsigned Depth,
 724                           SelectionDAG &DAG);
 725
 726   /// LowerOperation - This callback is invoked for operations that are
 727   /// unsupported by the target, which are registered to use 'custom' lowering,
 728   /// and whose defined values are all legal.
 729   /// If the target has no operations that require custom lowering, it need not
 730   /// implement this.  The default implementation of this aborts.
 731   virtual SDOperand LowerOperation(SDOperand Op, SelectionDAG &DAG);
 732
 733   /// CustomPromoteOperation - This callback is invoked for operations that are
 734   /// unsupported by the target, are registered to use 'custom' lowering, and
 735   /// whose type needs to be promoted.
 736   virtual SDOperand CustomPromoteOperation(SDOperand Op, SelectionDAG &DAG);
 737
 738   /// getTargetNodeName() - This method returns the name of a target specific
 739   /// DAG node.
 740   virtual const char *getTargetNodeName(unsigned Opcode) const;
 741
 742   //===--------------------------------------------------------------------===//
 743   // Inline Asm Support hooks
 744   //
 745
 746   enum ConstraintType {
 747     C_Register,            // Constraint represents a single register.
 748     C_RegisterClass,       // Constraint represents one or more registers.
 749     C_Memory,              // Memory constraint.
 750     C_Other,               // Something else.
 751     C_Unknown              // Unsupported constraint.
 752   };
 753
 754   /// getConstraintType - Given a constraint letter, return the type of
 755   /// constraint it is for this target.
 756   virtual ConstraintType getConstraintType(char ConstraintLetter) const;
 757
 758
 759   /// getRegClassForInlineAsmConstraint - Given a constraint letter (e.g. "r"),
 760   /// return a list of registers that can be used to satisfy the constraint.
 761   /// This should only be used for C_RegisterClass constraints.
 762   virtual std::vector<unsigned>
 763   getRegClassForInlineAsmConstraint(const std::string &Constraint,
 764                                     MVT::ValueType VT) const;
 765
 766   /// getRegForInlineAsmConstraint - Given a physical register constraint (e.g.
 767   /// {edx}), return the register number and the register class for the
 768   /// register.
 769   ///
 770   /// Given a register class constraint, like 'r', if this corresponds directly
 771   /// to an LLVM register class, return a register of 0 and the register class
 772   /// pointer.
 773   ///
 774   /// This should only be used for C_Register constraints.  On error,
 775   /// this returns a register number of 0 and a null register class pointer..
 776   virtual std::pair<unsigned, const TargetRegisterClass*>
 777     getRegForInlineAsmConstraint(const std::string &Constraint,
 778                                  MVT::ValueType VT) const;
 779
 780
 781   /// isOperandValidForConstraint - Return the specified operand (possibly
 782   /// modified) if the specified SDOperand is valid for the specified target
 783   /// constraint letter, otherwise return null.
 784   virtual SDOperand
 785     isOperandValidForConstraint(SDOperand Op, char ConstraintLetter,
 786                                 SelectionDAG &DAG);
 787
 788   //===--------------------------------------------------------------------===//
 789   // Scheduler hooks
 790   //
 791
 792   // InsertAtEndOfBasicBlock - This method should be implemented by targets that
 793   // mark instructions with the 'usesCustomDAGSchedInserter' flag.  These
 794   // instructions are special in various ways, which require special support to
 795   // insert.  The specified MachineInstr is created but not inserted into any
 796   // basic blocks, and the scheduler passes ownership of it to this method.
 797   virtual MachineBasicBlock *InsertAtEndOfBasicBlock(MachineInstr *MI,
 798                                                      MachineBasicBlock *MBB);
 799
 800   //===--------------------------------------------------------------------===//
 801   // Loop Strength Reduction hooks
 802   //
 803
 804   /// isLegalAddressImmediate - Return true if the integer value or GlobalValue
 805   /// can be used as the offset of the target addressing mode.
 806   virtual bool isLegalAddressImmediate(int64_t V) const;
 807   virtual bool isLegalAddressImmediate(GlobalValue *GV) const;
 808
 809   typedef std::vector<unsigned>::const_iterator legal_am_scale_iterator;
 810   legal_am_scale_iterator legal_am_scale_begin() const {
 811     return LegalAddressScales.begin();
 812   }
 813   legal_am_scale_iterator legal_am_scale_end() const {
 814     return LegalAddressScales.end();
 815   }
 816
 817   //===--------------------------------------------------------------------===//
 818   // Div utility functions
 819   //
 820   SDOperand BuildSDIV(SDNode *N, SelectionDAG &DAG,
 821                       std::vector<SDNode*>* Created) const;
 822   SDOperand BuildUDIV(SDNode *N, SelectionDAG &DAG,
 823                       std::vector<SDNode*>* Created) const;
 824
 825
 826 protected:
 827   /// addLegalAddressScale - Add a integer (> 1) value which can be used as
 828   /// scale in the target addressing mode. Note: the ordering matters so the
 829   /// least efficient ones should be entered first.
 830   void addLegalAddressScale(unsigned Scale) {
 831     LegalAddressScales.push_back(Scale);
 832   }
 833
 834 private:
 835   std::vector<unsigned> LegalAddressScales;
 836
 837   TargetMachine &TM;
 838   const TargetData *TD;
 839
 840   /// IsLittleEndian - True if this is a little endian target.
 841   ///
 842   bool IsLittleEndian;
 843
 844   /// PointerTy - The type to use for pointers, usually i32 or i64.
 845   ///
 846   MVT::ValueType PointerTy;
 847
 848   /// UsesGlobalOffsetTable - True if this target uses a GOT for PIC codegen.
 849   ///
 850   bool UsesGlobalOffsetTable;
 851
 852   /// ShiftAmountTy - The type to use for shift amounts, usually i8 or whatever
 853   /// PointerTy is.
 854   MVT::ValueType ShiftAmountTy;
 855
 856   OutOfRangeShiftAmount ShiftAmtHandling;
 857
 858   /// SetCCIsExpensive - This is a short term hack for targets that codegen
 859   /// setcc as a conditional branch.  This encourages the code generator to fold
 860   /// setcc operations into other operations if possible.
 861   bool SetCCIsExpensive;
 862
 863   /// IntDivIsCheap - Tells the code generator not to expand integer divides by
 864   /// constants into a sequence of muls, adds, and shifts.  This is a hack until
 865   /// a real cost model is in place.  If we ever optimize for size, this will be
 866   /// set to true unconditionally.
 867   bool IntDivIsCheap;
 868
 869   /// Pow2DivIsCheap - Tells the code generator that it shouldn't generate
 870   /// srl/add/sra for a signed divide by power of two, and let the target handle
 871   /// it.
 872   bool Pow2DivIsCheap;
 873
 874   /// SetCCResultTy - The type that SetCC operations use.  This defaults to the
 875   /// PointerTy.
 876   MVT::ValueType SetCCResultTy;
 877
 878   /// SetCCResultContents - Information about the contents of the high-bits in
 879   /// the result of a setcc comparison operation.
 880   SetCCResultValue SetCCResultContents;
 881
 882   /// SchedPreferenceInfo - The target scheduling preference: shortest possible
 883   /// total cycles or lowest register usage.
 884   SchedPreference SchedPreferenceInfo;
 885
 886   /// UseUnderscoreSetJmpLongJmp - This target prefers to use _setjmp and
 887   /// _longjmp to implement llvm.setjmp/llvm.longjmp.  Defaults to false.
 888   bool UseUnderscoreSetJmpLongJmp;
 889
 890   /// JumpBufSize - The size, in bytes, of the target's jmp_buf buffers
 891   unsigned JumpBufSize;
 892
 893   /// JumpBufAlignment - The alignment, in bytes, of the target's jmp_buf
 894   /// buffers
 895   unsigned JumpBufAlignment;
 896
 897   /// StackPointerRegisterToSaveRestore - If set to a physical register, this
 898   /// specifies the register that llvm.savestack/llvm.restorestack should save
 899   /// and restore.
 900   unsigned StackPointerRegisterToSaveRestore;
 901
 902   /// RegClassForVT - This indicates the default register class to use for
 903   /// each ValueType the target supports natively.
 904   TargetRegisterClass *RegClassForVT[MVT::LAST_VALUETYPE];
 905   unsigned char NumElementsForVT[MVT::LAST_VALUETYPE];
 906
 907   /// TransformToType - For any value types we are promoting or expanding, this
 908   /// contains the value type that we are changing to.  For Expanded types, this
 909   /// contains one step of the expand (e.g. i64 -> i32), even if there are
 910   /// multiple steps required (e.g. i64 -> i16).  For types natively supported
 911   /// by the system, this holds the same type (e.g. i32 -> i32).
 912   MVT::ValueType TransformToType[MVT::LAST_VALUETYPE];
 913
 914   /// OpActions - For each operation and each value type, keep a LegalizeAction
 915   /// that indicates how instruction selection should deal with the operation.
 916   /// Most operations are Legal (aka, supported natively by the target), but
 917   /// operations that are not should be described.  Note that operations on
 918   /// non-legal value types are not described here.
 919   uint64_t OpActions[156];
 920
 921   /// LoadXActions - For each load of load extension type and each value type,
 922   /// keep a LegalizeAction that indicates how instruction selection should deal
 923   /// with the load.
 924   uint64_t LoadXActions[ISD::LAST_LOADX_TYPE];
 925
 926   /// StoreXActions - For each store with truncation of each value type, keep a
 927   /// LegalizeAction that indicates how instruction selection should deal with
 928   /// the store.
 929   uint64_t StoreXActions;
 930
 931   /// IndexedModeActions - For each indexed mode and each value type, keep a
 932   /// pair of LegalizeAction that indicates how instruction selection should
 933   /// deal with the load / store.
 934   uint64_t IndexedModeActions[2][ISD::LAST_INDEXED_MODE];
 935
 936   ValueTypeActionImpl ValueTypeActions;
 937
 938   std::vector<double> LegalFPImmediates;
 939
 940   std::vector<std::pair<MVT::ValueType,
 941                         TargetRegisterClass*> > AvailableRegClasses;
 942
 943   /// TargetDAGCombineArray - Targets can specify ISD nodes that they would
 944   /// like PerformDAGCombine callbacks for by calling setTargetDAGCombine(),
 945   /// which sets a bit in this array.
 946   unsigned char TargetDAGCombineArray[156/(sizeof(unsigned char)*8)];
 947
 948   /// PromoteToType - For operations that must be promoted to a specific type,
 949   /// this holds the destination type.  This map should be sparse, so don't hold
 950   /// it as an array.
 951   ///
 952   /// Targets add entries to this map with AddPromotedToType(..), clients access
 953   /// this with getTypeToPromoteTo(..).
 954   std::map<std::pair<unsigned, MVT::ValueType>, MVT::ValueType> PromoteToType;
 955
 956 protected:
 957   /// When lowering %llvm.memset this field specifies the maximum number of
 958   /// store operations that may be substituted for the call to memset. Targets
 959   /// must set this value based on the cost threshold for that target. Targets
 960   /// should assume that the memset will be done using as many of the largest
 961   /// store operations first, followed by smaller ones, if necessary, per
 962   /// alignment restrictions. For example, storing 9 bytes on a 32-bit machine
 963   /// with 16-bit alignment would result in four 2-byte stores and one 1-byte
 964   /// store.  This only applies to setting a constant array of a constant size.
 965   /// @brief Specify maximum number of store instructions per memset call.
 966   unsigned maxStoresPerMemset;
 967
 968   /// When lowering %llvm.memcpy this field specifies the maximum number of
 969   /// store operations that may be substituted for a call to memcpy. Targets
 970   /// must set this value based on the cost threshold for that target. Targets
 971   /// should assume that the memcpy will be done using as many of the largest
 972   /// store operations first, followed by smaller ones, if necessary, per
 973   /// alignment restrictions. For example, storing 7 bytes on a 32-bit machine
 974   /// with 32-bit alignment would result in one 4-byte store, a one 2-byte store
 975   /// and one 1-byte store. This only applies to copying a constant array of
 976   /// constant size.
 977   /// @brief Specify maximum bytes of store instructions per memcpy call.
 978   unsigned maxStoresPerMemcpy;
 979
 980   /// When lowering %llvm.memmove this field specifies the maximum number of
 981   /// store instructions that may be substituted for a call to memmove. Targets
 982   /// must set this value based on the cost threshold for that target. Targets
 983   /// should assume that the memmove will be done using as many of the largest
 984   /// store operations first, followed by smaller ones, if necessary, per
 985   /// alignment restrictions. For example, moving 9 bytes on a 32-bit machine
 986   /// with 8-bit alignment would result in nine 1-byte stores.  This only
 987   /// applies to copying a constant array of constant size.
 988   /// @brief Specify maximum bytes of store instructions per memmove call.
 989   unsigned maxStoresPerMemmove;
 990
 991   /// This field specifies whether the target machine permits unaligned memory
 992   /// accesses.  This is used, for example, to determine the size of store
 993   /// operations when copying small arrays and other similar tasks.
 994   /// @brief Indicate whether the target permits unaligned memory accesses.
 995   bool allowUnalignedMemoryAccesses;
 996 };
 997 } // end llvm namespace
 998
 999 #endif