include/llvm/Target/MRegisterInfo.h

   1 //===- Target/MRegisterInfo.h - Target Register Information -----*- 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 an abstract interface used to get information about a
  11 // target machines register file.  This information is used for a variety of
  12 // purposed, especially register allocation.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_TARGET_MREGISTERINFO_H
  17 #define LLVM_TARGET_MREGISTERINFO_H
  18
  19 #include "llvm/ADT/SmallVector.h"
  20 #include "llvm/CodeGen/MachineBasicBlock.h"
  21 #include "llvm/CodeGen/ValueTypes.h"
  22 #include <cassert>
  23 #include <functional>
  24
  25 namespace llvm {
  26
  27 class BitVector;
  28 class CalleeSavedInfo;
  29 class MachineFunction;
  30 class MachineInstr;
  31 class MachineLocation;
  32 class MachineMove;
  33 class RegScavenger;
  34 class SDNode;
  35 class SelectionDAG;
  36 class SSARegMap;
  37 class TargetRegisterClass;
  38 class Type;
  39
  40 /// TargetRegisterDesc - This record contains all of the information known about
  41 /// a particular register.  The AliasSet field (if not null) contains a pointer
  42 /// to a Zero terminated array of registers that this register aliases.  This is
  43 /// needed for architectures like X86 which have AL alias AX alias EAX.
  44 /// Registers that this does not apply to simply should set this to null.
  45 /// The SubRegs field is a zero terminated array of registers that are
  46 /// sub-registers of the specific register, e.g. AL, AH are sub-registers of AX.
  47 /// The ImmsubRegs field is a subset of SubRegs. It includes only the immediate
  48 /// sub-registers. e.g. EAX has only one immediate sub-register of AX, not AH,
  49 /// AL which are immediate sub-registers of AX. The SuperRegs field is a zero
  50 /// terminated array of registers that are super-registers of the specific
  51 /// register, e.g. RAX, EAX, are super-registers of AX.
  52 ///
  53 struct TargetRegisterDesc {
  54   const char     *Name;         // Assembly language name for the register
  55   const unsigned *AliasSet;     // Register Alias Set, described above
  56   const unsigned *SubRegs;      // Sub-register set, described above
  57   const unsigned *ImmSubRegs;   // Immediate sub-register set, described above
  58   const unsigned *SuperRegs;    // Super-register set, described above
  59 };
  60
  61 class TargetRegisterClass {
  62 public:
  63   typedef const unsigned* iterator;
  64   typedef const unsigned* const_iterator;
  65
  66   typedef const MVT::ValueType* vt_iterator;
  67   typedef const TargetRegisterClass* const * sc_iterator;
  68 private:
  69   unsigned ID;
  70   bool  isSubClass;
  71   const vt_iterator VTs;
  72   const sc_iterator SubClasses;
  73   const sc_iterator SuperClasses;
  74   const sc_iterator SubRegClasses;
  75   const sc_iterator SuperRegClasses;
  76   const unsigned RegSize, Alignment;    // Size & Alignment of register in bytes
  77   const int CopyCost;
  78   const iterator RegsBegin, RegsEnd;
  79 public:
  80   TargetRegisterClass(unsigned id,
  81                       const MVT::ValueType *vts,
  82                       const TargetRegisterClass * const *subcs,
  83                       const TargetRegisterClass * const *supcs,
  84                       const TargetRegisterClass * const *subregcs,
  85                       const TargetRegisterClass * const *superregcs,
  86                       unsigned RS, unsigned Al, int CC,
  87                       iterator RB, iterator RE)
  88     : ID(id), VTs(vts), SubClasses(subcs), SuperClasses(supcs),
  89     SubRegClasses(subregcs), SuperRegClasses(superregcs),
  90     RegSize(RS), Alignment(Al), CopyCost(CC), RegsBegin(RB), RegsEnd(RE) {}
  91   virtual ~TargetRegisterClass() {}     // Allow subclasses
  92
  93   /// getID() - Return the register class ID number.
  94   ///
  95   unsigned getID() const { return ID; }
  96
  97   /// begin/end - Return all of the registers in this class.
  98   ///
  99   iterator       begin() const { return RegsBegin; }
 100   iterator         end() const { return RegsEnd; }
 101
 102   /// getNumRegs - Return the number of registers in this class.
 103   ///
 104   unsigned getNumRegs() const { return RegsEnd-RegsBegin; }
 105
 106   /// getRegister - Return the specified register in the class.
 107   ///
 108   unsigned getRegister(unsigned i) const {
 109     assert(i < getNumRegs() && "Register number out of range!");
 110     return RegsBegin[i];
 111   }
 112
 113   /// contains - Return true if the specified register is included in this
 114   /// register class.
 115   bool contains(unsigned Reg) const {
 116     for (iterator I = begin(), E = end(); I != E; ++I)
 117       if (*I == Reg) return true;
 118     return false;
 119   }
 120
 121   /// hasType - return true if this TargetRegisterClass has the ValueType vt.
 122   ///
 123   bool hasType(MVT::ValueType vt) const {
 124     for(int i = 0; VTs[i] != MVT::Other; ++i)
 125       if (VTs[i] == vt)
 126         return true;
 127     return false;
 128   }
 129
 130   /// vt_begin / vt_end - Loop over all of the value types that can be
 131   /// represented by values in this register class.
 132   vt_iterator vt_begin() const {
 133     return VTs;
 134   }
 135
 136   vt_iterator vt_end() const {
 137     vt_iterator I = VTs;
 138     while (*I != MVT::Other) ++I;
 139     return I;
 140   }
 141
 142   /// hasSubClass - return true if the specified TargetRegisterClass is a
 143   /// sub-register class of this TargetRegisterClass.
 144   bool hasSubClass(const TargetRegisterClass *cs) const {
 145     for (int i = 0; SubClasses[i] != NULL; ++i)
 146       if (SubClasses[i] == cs)
 147         return true;
 148     return false;
 149   }
 150
 151   /// subclasses_begin / subclasses_end - Loop over all of the sub-classes of
 152   /// this register class.
 153   sc_iterator subclasses_begin() const {
 154     return SubClasses;
 155   }
 156
 157   sc_iterator subclasses_end() const {
 158     sc_iterator I = SubClasses;
 159     while (*I != NULL) ++I;
 160     return I;
 161   }
 162
 163   /// hasSuperClass - return true if the specified TargetRegisterClass is a
 164   /// super-register class of this TargetRegisterClass.
 165   bool hasSuperClass(const TargetRegisterClass *cs) const {
 166     for (int i = 0; SuperClasses[i] != NULL; ++i)
 167       if (SuperClasses[i] == cs)
 168         return true;
 169     return false;
 170   }
 171
 172   /// superclasses_begin / superclasses_end - Loop over all of the super-classes
 173   /// of this register class.
 174   sc_iterator superclasses_begin() const {
 175     return SuperClasses;
 176   }
 177
 178   sc_iterator superclasses_end() const {
 179     sc_iterator I = SuperClasses;
 180     while (*I != NULL) ++I;
 181     return I;
 182   }
 183
 184   /// hasSubRegClass - return true if the specified TargetRegisterClass is a
 185   /// class of a sub-register class for this TargetRegisterClass.
 186   bool hasSubRegClass(const TargetRegisterClass *cs) const {
 187     for (int i = 0; SubRegClasses[i] != NULL; ++i)
 188       if (SubRegClasses[i] == cs)
 189         return true;
 190     return false;
 191   }
 192
 193   /// hasClassForSubReg - return true if the specified TargetRegisterClass is a
 194   /// class of a sub-register class for this TargetRegisterClass.
 195   bool hasClassForSubReg(unsigned SubReg) const {
 196     --SubReg;
 197     for (unsigned i = 0; SubRegClasses[i] != NULL; ++i)
 198       if (i == SubReg)
 199         return true;
 200     return false;
 201   }
 202
 203   /// getClassForSubReg - return theTargetRegisterClass for the sub-register
 204   /// at idx for this TargetRegisterClass.
 205   sc_iterator getClassForSubReg(unsigned SubReg) const {
 206     --SubReg;
 207     for (unsigned i = 0; SubRegClasses[i] != NULL; ++i)
 208       if (i == SubReg)
 209         return &SubRegClasses[i];
 210     assert(0 && "Invalid subregister index for register class");
 211     return NULL;
 212   }
 213
 214   /// subregclasses_begin / subregclasses_end - Loop over all of
 215   /// the subregister classes of this register class.
 216   sc_iterator subregclasses_begin() const {
 217     return SubRegClasses;
 218   }
 219
 220   sc_iterator subregclasses_end() const {
 221     sc_iterator I = SubRegClasses;
 222     while (*I != NULL) ++I;
 223     return I;
 224   }
 225
 226   /// superregclasses_begin / superregclasses_end - Loop over all of
 227   /// the superregister classes of this register class.
 228   sc_iterator superregclasses_begin() const {
 229     return SuperRegClasses;
 230   }
 231
 232   sc_iterator superregclasses_end() const {
 233     sc_iterator I = SuperRegClasses;
 234     while (*I != NULL) ++I;
 235     return I;
 236   }
 237
 238   /// allocation_order_begin/end - These methods define a range of registers
 239   /// which specify the registers in this class that are valid to register
 240   /// allocate, and the preferred order to allocate them in.  For example,
 241   /// callee saved registers should be at the end of the list, because it is
 242   /// cheaper to allocate caller saved registers.
 243   ///
 244   /// These methods take a MachineFunction argument, which can be used to tune
 245   /// the allocatable registers based on the characteristics of the function.
 246   /// One simple example is that the frame pointer register can be used if
 247   /// frame-pointer-elimination is performed.
 248   ///
 249   /// By default, these methods return all registers in the class.
 250   ///
 251   virtual iterator allocation_order_begin(const MachineFunction &MF) const {
 252     return begin();
 253   }
 254   virtual iterator allocation_order_end(const MachineFunction &MF)   const {
 255     return end();
 256   }
 257
 258
 259
 260   /// getSize - Return the size of the register in bytes, which is also the size
 261   /// of a stack slot allocated to hold a spilled copy of this register.
 262   unsigned getSize() const { return RegSize; }
 263
 264   /// getAlignment - Return the minimum required alignment for a register of
 265   /// this class.
 266   unsigned getAlignment() const { return Alignment; }
 267
 268   /// getCopyCost - Return the cost of copying a value between two registers in
 269   /// this class.
 270   int getCopyCost() const { return CopyCost; }
 271 };
 272
 273
 274 /// MRegisterInfo base class - We assume that the target defines a static array
 275 /// of TargetRegisterDesc objects that represent all of the machine registers
 276 /// that the target has.  As such, we simply have to track a pointer to this
 277 /// array so that we can turn register number into a register descriptor.
 278 ///
 279 class MRegisterInfo {
 280 public:
 281   typedef const TargetRegisterClass * const * regclass_iterator;
 282 private:
 283   const TargetRegisterDesc *Desc;             // Pointer to the descriptor array
 284   unsigned NumRegs;                           // Number of entries in the array
 285
 286   regclass_iterator RegClassBegin, RegClassEnd;   // List of regclasses
 287
 288   int CallFrameSetupOpcode, CallFrameDestroyOpcode;
 289 protected:
 290   MRegisterInfo(const TargetRegisterDesc *D, unsigned NR,
 291                 regclass_iterator RegClassBegin, regclass_iterator RegClassEnd,
 292                 int CallFrameSetupOpcode = -1, int CallFrameDestroyOpcode = -1);
 293   virtual ~MRegisterInfo();
 294 public:
 295
 296   enum {                        // Define some target independent constants
 297     /// NoRegister - This physical register is not a real target register.  It
 298     /// is useful as a sentinal.
 299     NoRegister = 0,
 300
 301     /// FirstVirtualRegister - This is the first register number that is
 302     /// considered to be a 'virtual' register, which is part of the SSA
 303     /// namespace.  This must be the same for all targets, which means that each
 304     /// target is limited to 1024 registers.
 305     FirstVirtualRegister = 1024
 306   };
 307
 308   /// isPhysicalRegister - Return true if the specified register number is in
 309   /// the physical register namespace.
 310   static bool isPhysicalRegister(unsigned Reg) {
 311     assert(Reg && "this is not a register!");
 312     return Reg < FirstVirtualRegister;
 313   }
 314
 315   /// isVirtualRegister - Return true if the specified register number is in
 316   /// the virtual register namespace.
 317   static bool isVirtualRegister(unsigned Reg) {
 318     assert(Reg && "this is not a register!");
 319     return Reg >= FirstVirtualRegister;
 320   }
 321
 322   /// getPhysicalRegisterRegClass - Returns the Register Class of a physical
 323   /// register of the given type.
 324   const TargetRegisterClass *getPhysicalRegisterRegClass(MVT::ValueType VT,
 325                                                          unsigned Reg) const;
 326
 327   /// getAllocatableSet - Returns a bitset indexed by register number
 328   /// indicating if a register is allocatable or not. If a register class is
 329   /// specified, returns the subset for the class.
 330   BitVector getAllocatableSet(MachineFunction &MF,
 331                               const TargetRegisterClass *RC = NULL) const;
 332
 333   const TargetRegisterDesc &operator[](unsigned RegNo) const {
 334     assert(RegNo < NumRegs &&
 335            "Attempting to access record for invalid register number!");
 336     return Desc[RegNo];
 337   }
 338
 339   /// Provide a get method, equivalent to [], but more useful if we have a
 340   /// pointer to this object.
 341   ///
 342   const TargetRegisterDesc &get(unsigned RegNo) const {
 343     return operator[](RegNo);
 344   }
 345
 346   /// getAliasSet - Return the set of registers aliased by the specified
 347   /// register, or a null list of there are none.  The list returned is zero
 348   /// terminated.
 349   ///
 350   const unsigned *getAliasSet(unsigned RegNo) const {
 351     return get(RegNo).AliasSet;
 352   }
 353
 354   /// getSubRegisters - Return the set of registers that are sub-registers of
 355   /// the specified register, or a null list of there are none. The list
 356   /// returned is zero terminated.
 357   ///
 358   const unsigned *getSubRegisters(unsigned RegNo) const {
 359     return get(RegNo).SubRegs;
 360   }
 361
 362   /// getImmediateSubRegisters - Return the set of registers that are immediate
 363   /// sub-registers of the specified register, or a null list of there are none.
 364   /// The list returned is zero terminated.
 365   ///
 366   const unsigned *getImmediateSubRegisters(unsigned RegNo) const {
 367     return get(RegNo).ImmSubRegs;
 368   }
 369
 370   /// getSuperRegisters - Return the set of registers that are super-registers
 371   /// of the specified register, or a null list of there are none. The list
 372   /// returned is zero terminated.
 373   ///
 374   const unsigned *getSuperRegisters(unsigned RegNo) const {
 375     return get(RegNo).SuperRegs;
 376   }
 377
 378   /// isSubRegOf - Predicate which returns true if RegA is a sub-register of
 379   /// RegB. Returns false otherwise.
 380   ///
 381   bool isSubRegOf(unsigned RegA, unsigned RegB) const {
 382     const TargetRegisterDesc &RD = (*this)[RegA];
 383     for (const unsigned *reg = RD.SuperRegs; *reg != 0; ++reg)
 384       if (*reg == RegB)
 385         return true;
 386     return false;
 387   }
 388
 389   /// getName - Return the symbolic target specific name for the specified
 390   /// physical register.
 391   const char *getName(unsigned RegNo) const {
 392     return get(RegNo).Name;
 393   }
 394
 395   /// getNumRegs - Return the number of registers this target has (useful for
 396   /// sizing arrays holding per register information)
 397   unsigned getNumRegs() const {
 398     return NumRegs;
 399   }
 400
 401   /// areAliases - Returns true if the two registers alias each other, false
 402   /// otherwise
 403   bool areAliases(unsigned regA, unsigned regB) const {
 404     for (const unsigned *Alias = getAliasSet(regA); *Alias; ++Alias)
 405       if (*Alias == regB) return true;
 406     return false;
 407   }
 408
 409   /// regsOverlap - Returns true if the two registers are equal or alias each
 410   /// other. The registers may be virtual register.
 411   bool regsOverlap(unsigned regA, unsigned regB) const {
 412     if (regA == regB)
 413       return true;
 414
 415     if (isVirtualRegister(regA) || isVirtualRegister(regB))
 416       return false;
 417     return areAliases(regA, regB);
 418   }
 419
 420   /// isSubRegister - Returns true if regB is a sub-register of regA.
 421   ///
 422   bool isSubRegister(unsigned regA, unsigned regB) const {
 423     for (const unsigned *SR = getSubRegisters(regA); *SR; ++SR)
 424       if (*SR == regB) return true;
 425     return false;
 426   }
 427
 428   /// isSuperRegister - Returns true if regB is a super-register of regA.
 429   ///
 430   bool isSuperRegister(unsigned regA, unsigned regB) const {
 431     for (const unsigned *SR = getSuperRegisters(regA); *SR; ++SR)
 432       if (*SR == regB) return true;
 433     return false;
 434   }
 435
 436   /// getCalleeSavedRegs - Return a null-terminated list of all of the
 437   /// callee saved registers on this target. The register should be in the
 438   /// order of desired callee-save stack frame offset. The first register is
 439   /// closed to the incoming stack pointer if stack grows down, and vice versa.
 440   virtual const unsigned* getCalleeSavedRegs(const MachineFunction *MF = 0)
 441                                                                       const = 0;
 442
 443   /// getCalleeSavedRegClasses - Return a null-terminated list of the preferred
 444   /// register classes to spill each callee saved register with.  The order and
 445   /// length of this list match the getCalleeSaveRegs() list.
 446   virtual const TargetRegisterClass* const *getCalleeSavedRegClasses(
 447                                             const MachineFunction *MF) const =0;
 448
 449   /// getReservedRegs - Returns a bitset indexed by physical register number
 450   /// indicating if a register is a special register that has particular uses
 451   /// and should be considered unavailable at all times, e.g. SP, RA. This is
 452   /// used by register scavenger to determine what registers are free.
 453   virtual BitVector getReservedRegs(const MachineFunction &MF) const = 0;
 454
 455   /// getSubReg - Returns the physical register number of sub-register "Index"
 456   /// for physical register RegNo.
 457   virtual unsigned getSubReg(unsigned RegNo, unsigned Index) const = 0;
 458
 459   //===--------------------------------------------------------------------===//
 460   // Register Class Information
 461   //
 462
 463   /// Register class iterators
 464   ///
 465   regclass_iterator regclass_begin() const { return RegClassBegin; }
 466   regclass_iterator regclass_end() const { return RegClassEnd; }
 467
 468   unsigned getNumRegClasses() const {
 469     return regclass_end()-regclass_begin();
 470   }
 471
 472   /// getRegClass - Returns the register class associated with the enumeration
 473   /// value.  See class TargetOperandInfo.
 474   const TargetRegisterClass *getRegClass(unsigned i) const {
 475     assert(i <= getNumRegClasses() && "Register Class ID out of range");
 476     return i ? RegClassBegin[i - 1] : NULL;
 477   }
 478
 479   //===--------------------------------------------------------------------===//
 480   // Interfaces used by the register allocator and stack frame
 481   // manipulation passes to move data around between registers,
 482   // immediates and memory.  FIXME: Move these to TargetInstrInfo.h.
 483   //
 484
 485   /// spillCalleeSavedRegisters - Issues instruction(s) to spill all callee
 486   /// saved registers and returns true if it isn't possible / profitable to do
 487   /// so by issuing a series of store instructions via
 488   /// storeRegToStackSlot(). Returns false otherwise.
 489   virtual bool spillCalleeSavedRegisters(MachineBasicBlock &MBB,
 490                                          MachineBasicBlock::iterator MI,
 491                                 const std::vector<CalleeSavedInfo> &CSI) const {
 492     return false;
 493   }
 494
 495   /// restoreCalleeSavedRegisters - Issues instruction(s) to restore all callee
 496   /// saved registers and returns true if it isn't possible / profitable to do
 497   /// so by issuing a series of load instructions via loadRegToStackSlot().
 498   /// Returns false otherwise.
 499   virtual bool restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
 500                                            MachineBasicBlock::iterator MI,
 501                                 const std::vector<CalleeSavedInfo> &CSI) const {
 502     return false;
 503   }
 504
 505   virtual void storeRegToStackSlot(MachineBasicBlock &MBB,
 506                                    MachineBasicBlock::iterator MI,
 507                                    unsigned SrcReg, int FrameIndex,
 508                                    const TargetRegisterClass *RC) const = 0;
 509
 510   virtual void storeRegToAddr(MachineFunction &MF, unsigned SrcReg,
 511                               SmallVectorImpl<MachineOperand> &Addr,
 512                               const TargetRegisterClass *RC,
 513                               SmallVectorImpl<MachineInstr*> &NewMIs) const = 0;
 514
 515   virtual void loadRegFromStackSlot(MachineBasicBlock &MBB,
 516                                     MachineBasicBlock::iterator MI,
 517                                     unsigned DestReg, int FrameIndex,
 518                                     const TargetRegisterClass *RC) const = 0;
 519
 520   virtual void loadRegFromAddr(MachineFunction &MF, unsigned DestReg,
 521                                SmallVectorImpl<MachineOperand> &Addr,
 522                                const TargetRegisterClass *RC,
 523                                SmallVectorImpl<MachineInstr*> &NewMIs) const =0;
 524
 525   virtual void copyRegToReg(MachineBasicBlock &MBB,
 526                             MachineBasicBlock::iterator MI,
 527                             unsigned DestReg, unsigned SrcReg,
 528                             const TargetRegisterClass *DestRC,
 529                             const TargetRegisterClass *SrcRC) const = 0;
 530
 531   /// getCrossCopyRegClass - Returns a legal register class to copy a register
 532   /// in the specified class to or from. Returns NULL if it is possible to copy
 533   /// between a two registers of the specified class.
 534   virtual const TargetRegisterClass *
 535   getCrossCopyRegClass(const TargetRegisterClass *RC) const {
 536     return NULL;
 537   }
 538
 539   /// reMaterialize - Re-issue the specified 'original' instruction at the
 540   /// specific location targeting a new destination register.
 541   virtual void reMaterialize(MachineBasicBlock &MBB,
 542                              MachineBasicBlock::iterator MI,
 543                              unsigned DestReg,
 544                              const MachineInstr *Orig) const = 0;
 545
 546   /// foldMemoryOperand - Attempt to fold a load or store of the specified stack
 547   /// slot into the specified machine instruction for the specified operand.  If
 548   /// this is possible, a new instruction is returned with the specified operand
 549   /// folded, otherwise NULL is returned. The client is responsible for removing
 550   /// the old instruction and adding the new one in the instruction stream
 551   virtual MachineInstr* foldMemoryOperand(MachineInstr* MI,
 552                                           unsigned OpNum,
 553                                           int FrameIndex) const {
 554     return 0;
 555   }
 556
 557   /// foldMemoryOperand - Same as the previous version except it allows folding
 558   /// of any load and store from / to any address, not just from a specific
 559   /// stack slot.
 560   virtual MachineInstr* foldMemoryOperand(MachineInstr* MI,
 561                                           unsigned OpNum,
 562                                           MachineInstr* LoadMI) const {
 563     return 0;
 564   }
 565
 566   /// unfoldMemoryOperand - Separate a single instruction which folded a load or
 567   /// a a store or a load and a store into two or more instruction. If this is
 568   /// possible, returns true as well as the new instructions by reference.
 569   virtual bool unfoldMemoryOperand(MachineFunction &MF, MachineInstr *MI,
 570                                 unsigned Reg, bool UnfoldLoad, bool UnfoldStore,
 571                                   SmallVectorImpl<MachineInstr*> &NewMIs) const{
 572     return false;
 573   }
 574
 575   virtual bool unfoldMemoryOperand(SelectionDAG &DAG, SDNode *N,
 576                                    SmallVectorImpl<SDNode*> &NewNodes) const {
 577     return false;
 578   }
 579
 580   /// getOpcodeAfterMemoryUnfold - Returns the opcode of the would be new
 581   /// instruction after load / store are unfolded from the specified opcode.
 582   /// It returns zero if the specified unfolding is impossible.
 583   virtual unsigned getOpcodeAfterMemoryUnfold(unsigned Opc,
 584                                       bool UnfoldLoad, bool UnfoldStore) const {
 585     return 0;
 586   }
 587
 588   /// targetHandlesStackFrameRounding - Returns true if the target is
 589   /// responsible for rounding up the stack frame (probably at emitPrologue
 590   /// time).
 591   virtual bool targetHandlesStackFrameRounding() const {
 592     return false;
 593   }
 594
 595   /// requiresRegisterScavenging - returns true if the target requires (and can
 596   /// make use of) the register scavenger.
 597   virtual bool requiresRegisterScavenging(const MachineFunction &MF) const {
 598     return false;
 599   }
 600
 601   /// hasFP - Return true if the specified function should have a dedicated
 602   /// frame pointer register. For most targets this is true only if the function
 603   /// has variable sized allocas or if frame pointer elimination is disabled.
 604   virtual bool hasFP(const MachineFunction &MF) const = 0;
 605
 606   // hasReservedCallFrame - Under normal circumstances, when a frame pointer is
 607   // not required, we reserve argument space for call sites in the function
 608   // immediately on entry to the current function. This eliminates the need for
 609   // add/sub sp brackets around call sites. Returns true if the call frame is
 610   // included as part of the stack frame.
 611   virtual bool hasReservedCallFrame(MachineFunction &MF) const {
 612     return !hasFP(MF);
 613   }
 614
 615   /// getCallFrameSetup/DestroyOpcode - These methods return the opcode of the
 616   /// frame setup/destroy instructions if they exist (-1 otherwise).  Some
 617   /// targets use pseudo instructions in order to abstract away the difference
 618   /// between operating with a frame pointer and operating without, through the
 619   /// use of these two instructions.
 620   ///
 621   int getCallFrameSetupOpcode() const { return CallFrameSetupOpcode; }
 622   int getCallFrameDestroyOpcode() const { return CallFrameDestroyOpcode; }
 623
 624
 625   /// eliminateCallFramePseudoInstr - This method is called during prolog/epilog
 626   /// code insertion to eliminate call frame setup and destroy pseudo
 627   /// instructions (but only if the Target is using them).  It is responsible
 628   /// for eliminating these instructions, replacing them with concrete
 629   /// instructions.  This method need only be implemented if using call frame
 630   /// setup/destroy pseudo instructions.
 631   ///
 632   virtual void
 633   eliminateCallFramePseudoInstr(MachineFunction &MF,
 634                                 MachineBasicBlock &MBB,
 635                                 MachineBasicBlock::iterator MI) const {
 636     assert(getCallFrameSetupOpcode()== -1 && getCallFrameDestroyOpcode()== -1 &&
 637            "eliminateCallFramePseudoInstr must be implemented if using"
 638            " call frame setup/destroy pseudo instructions!");
 639     assert(0 && "Call Frame Pseudo Instructions do not exist on this target!");
 640   }
 641
 642   /// processFunctionBeforeCalleeSavedScan - This method is called immediately
 643   /// before PrologEpilogInserter scans the physical registers used to determine
 644   /// what callee saved registers should be spilled. This method is optional.
 645   virtual void processFunctionBeforeCalleeSavedScan(MachineFunction &MF,
 646                                                 RegScavenger *RS = NULL) const {
 647
 648   }
 649
 650   /// processFunctionBeforeFrameFinalized - This method is called immediately
 651   /// before the specified functions frame layout (MF.getFrameInfo()) is
 652   /// finalized.  Once the frame is finalized, MO_FrameIndex operands are
 653   /// replaced with direct constants.  This method is optional.
 654   ///
 655   virtual void processFunctionBeforeFrameFinalized(MachineFunction &MF) const {
 656   }
 657
 658   /// eliminateFrameIndex - This method must be overriden to eliminate abstract
 659   /// frame indices from instructions which may use them.  The instruction
 660   /// referenced by the iterator contains an MO_FrameIndex operand which must be
 661   /// eliminated by this method.  This method may modify or replace the
 662   /// specified instruction, as long as it keeps the iterator pointing the the
 663   /// finished product. SPAdj is the SP adjustment due to call frame setup
 664   /// instruction. The return value is the number of instructions added to
 665   /// (negative if removed from) the basic block.
 666   ///
 667   virtual void eliminateFrameIndex(MachineBasicBlock::iterator MI,
 668                                    int SPAdj, RegScavenger *RS=NULL) const = 0;
 669
 670   /// emitProlog/emitEpilog - These methods insert prolog and epilog code into
 671   /// the function. The return value is the number of instructions
 672   /// added to (negative if removed from) the basic block (entry for prologue).
 673   ///
 674   virtual void emitPrologue(MachineFunction &MF) const = 0;
 675   virtual void emitEpilogue(MachineFunction &MF,
 676                             MachineBasicBlock &MBB) const = 0;
 677
 678   //===--------------------------------------------------------------------===//
 679   /// Debug information queries.
 680
 681   /// getDwarfRegNum - Map a target register to an equivalent dwarf register
 682   /// number.  Returns -1 if there is no equivalent value.
 683   virtual int getDwarfRegNum(unsigned RegNum) const = 0;
 684
 685   /// getFrameRegister - This method should return the register used as a base
 686   /// for values allocated in the current stack frame.
 687   virtual unsigned getFrameRegister(MachineFunction &MF) const = 0;
 688
 689   /// getRARegister - This method should return the register where the return
 690   /// address can be found.
 691   virtual unsigned getRARegister() const = 0;
 692
 693   /// getLocation - This method should return the actual location of a frame
 694   /// variable given the frame index.  The location is returned in ML.
 695   /// Subclasses should override this method for special handling of frame
 696   /// variables and call MRegisterInfo::getLocation for the default action.
 697   virtual void getLocation(MachineFunction &MF, unsigned Index,
 698                            MachineLocation &ML) const;
 699
 700   /// getInitialFrameState - Returns a list of machine moves that are assumed
 701   /// on entry to all functions.  Note that LabelID is ignored (assumed to be
 702   /// the beginning of the function.)
 703   virtual void getInitialFrameState(std::vector<MachineMove> &Moves) const;
 704 };
 705
 706 // This is useful when building IndexedMaps keyed on virtual registers
 707 struct VirtReg2IndexFunctor : std::unary_function<unsigned, unsigned> {
 708   unsigned operator()(unsigned Reg) const {
 709     return Reg - MRegisterInfo::FirstVirtualRegister;
 710   }
 711 };
 712
 713 } // End llvm namespace
 714
 715 #endif