TargetRegisterInfo.h revision da1f1f495066f95957fd1c19ad44d4453e47aff4
1//=== Target/TargetRegisterInfo.h - Target Register Information -*- 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// 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_TARGETREGISTERINFO_H 17#define LLVM_TARGET_TARGETREGISTERINFO_H 18 19#include "llvm/CodeGen/MachineBasicBlock.h" 20#include "llvm/CodeGen/ValueTypes.h" 21#include "llvm/ADT/DenseSet.h" 22#include <cassert> 23#include <functional> 24 25namespace llvm { 26 27class BitVector; 28class MachineFunction; 29class MachineMove; 30class RegScavenger; 31template<class T> class SmallVectorImpl; 32class raw_ostream; 33 34/// TargetRegisterDesc - This record contains all of the information known about 35/// a particular register. The Overlaps field contains a pointer to a zero 36/// terminated array of registers that this register aliases, starting with 37/// itself. This is needed for architectures like X86 which have AL alias AX 38/// alias EAX. The SubRegs field is a zero terminated array of registers that 39/// are sub-registers of the specific register, e.g. AL, AH are sub-registers of 40/// AX. The SuperRegs field is a zero terminated array of registers that are 41/// super-registers of the specific register, e.g. RAX, EAX, are super-registers 42/// of AX. 43/// 44struct TargetRegisterDesc { 45 const char *Name; // Printable name for the reg (for debugging) 46 const unsigned *Overlaps; // Overlapping registers, described above 47 const unsigned *SubRegs; // Sub-register set, described above 48 const unsigned *SuperRegs; // Super-register set, described above 49}; 50 51class TargetRegisterClass { 52public: 53 typedef const unsigned* iterator; 54 typedef const unsigned* const_iterator; 55 56 typedef const EVT* vt_iterator; 57 typedef const TargetRegisterClass* const * sc_iterator; 58private: 59 unsigned ID; 60 const char *Name; 61 const vt_iterator VTs; 62 const sc_iterator SubClasses; 63 const sc_iterator SuperClasses; 64 const sc_iterator SubRegClasses; 65 const sc_iterator SuperRegClasses; 66 const unsigned RegSize, Alignment; // Size & Alignment of register in bytes 67 const int CopyCost; 68 const iterator RegsBegin, RegsEnd; 69 DenseSet<unsigned> RegSet; 70public: 71 TargetRegisterClass(unsigned id, 72 const char *name, 73 const EVT *vts, 74 const TargetRegisterClass * const *subcs, 75 const TargetRegisterClass * const *supcs, 76 const TargetRegisterClass * const *subregcs, 77 const TargetRegisterClass * const *superregcs, 78 unsigned RS, unsigned Al, int CC, 79 iterator RB, iterator RE) 80 : ID(id), Name(name), VTs(vts), SubClasses(subcs), SuperClasses(supcs), 81 SubRegClasses(subregcs), SuperRegClasses(superregcs), 82 RegSize(RS), Alignment(Al), CopyCost(CC), RegsBegin(RB), RegsEnd(RE) { 83 for (iterator I = RegsBegin, E = RegsEnd; I != E; ++I) 84 RegSet.insert(*I); 85 } 86 virtual ~TargetRegisterClass() {} // Allow subclasses 87 88 /// getID() - Return the register class ID number. 89 /// 90 unsigned getID() const { return ID; } 91 92 /// getName() - Return the register class name for debugging. 93 /// 94 const char *getName() const { return Name; } 95 96 /// begin/end - Return all of the registers in this class. 97 /// 98 iterator begin() const { return RegsBegin; } 99 iterator end() const { return RegsEnd; } 100 101 /// getNumRegs - Return the number of registers in this class. 102 /// 103 unsigned getNumRegs() const { return (unsigned)(RegsEnd-RegsBegin); } 104 105 /// getRegister - Return the specified register in the class. 106 /// 107 unsigned getRegister(unsigned i) const { 108 assert(i < getNumRegs() && "Register number out of range!"); 109 return RegsBegin[i]; 110 } 111 112 /// contains - Return true if the specified register is included in this 113 /// register class. This does not include virtual registers. 114 bool contains(unsigned Reg) const { 115 return RegSet.count(Reg); 116 } 117 118 /// contains - Return true if both registers are in this class. 119 bool contains(unsigned Reg1, unsigned Reg2) const { 120 return contains(Reg1) && contains(Reg2); 121 } 122 123 /// hasType - return true if this TargetRegisterClass has the ValueType vt. 124 /// 125 bool hasType(EVT vt) const { 126 for(int i = 0; VTs[i] != MVT::Other; ++i) 127 if (VTs[i] == vt) 128 return true; 129 return false; 130 } 131 132 /// vt_begin / vt_end - Loop over all of the value types that can be 133 /// represented by values in this register class. 134 vt_iterator vt_begin() const { 135 return VTs; 136 } 137 138 vt_iterator vt_end() const { 139 vt_iterator I = VTs; 140 while (*I != MVT::Other) ++I; 141 return I; 142 } 143 144 /// subregclasses_begin / subregclasses_end - Loop over all of 145 /// the subreg register classes of this register class. 146 sc_iterator subregclasses_begin() const { 147 return SubRegClasses; 148 } 149 150 sc_iterator subregclasses_end() const { 151 sc_iterator I = SubRegClasses; 152 while (*I != NULL) ++I; 153 return I; 154 } 155 156 /// getSubRegisterRegClass - Return the register class of subregisters with 157 /// index SubIdx, or NULL if no such class exists. 158 const TargetRegisterClass* getSubRegisterRegClass(unsigned SubIdx) const { 159 assert(SubIdx>0 && "Invalid subregister index"); 160 return SubRegClasses[SubIdx-1]; 161 } 162 163 /// superregclasses_begin / superregclasses_end - Loop over all of 164 /// the superreg register classes of this register class. 165 sc_iterator superregclasses_begin() const { 166 return SuperRegClasses; 167 } 168 169 sc_iterator superregclasses_end() const { 170 sc_iterator I = SuperRegClasses; 171 while (*I != NULL) ++I; 172 return I; 173 } 174 175 /// hasSubClass - return true if the specified TargetRegisterClass 176 /// is a proper subset of this TargetRegisterClass. 177 bool hasSubClass(const TargetRegisterClass *cs) const { 178 for (int i = 0; SubClasses[i] != NULL; ++i) 179 if (SubClasses[i] == cs) 180 return true; 181 return false; 182 } 183 184 /// subclasses_begin / subclasses_end - Loop over all of the classes 185 /// that are proper subsets of this register class. 186 sc_iterator subclasses_begin() const { 187 return SubClasses; 188 } 189 190 sc_iterator subclasses_end() const { 191 sc_iterator I = SubClasses; 192 while (*I != NULL) ++I; 193 return I; 194 } 195 196 /// hasSuperClass - return true if the specified TargetRegisterClass is a 197 /// proper superset of this TargetRegisterClass. 198 bool hasSuperClass(const TargetRegisterClass *cs) const { 199 for (int i = 0; SuperClasses[i] != NULL; ++i) 200 if (SuperClasses[i] == cs) 201 return true; 202 return false; 203 } 204 205 /// superclasses_begin / superclasses_end - Loop over all of the classes 206 /// that are proper supersets of this register class. 207 sc_iterator superclasses_begin() const { 208 return SuperClasses; 209 } 210 211 sc_iterator superclasses_end() const { 212 sc_iterator I = SuperClasses; 213 while (*I != NULL) ++I; 214 return I; 215 } 216 217 /// isASubClass - return true if this TargetRegisterClass is a subset 218 /// class of at least one other TargetRegisterClass. 219 bool isASubClass() const { 220 return SuperClasses[0] != 0; 221 } 222 223 /// allocation_order_begin/end - These methods define a range of registers 224 /// which specify the registers in this class that are valid to register 225 /// allocate, and the preferred order to allocate them in. For example, 226 /// callee saved registers should be at the end of the list, because it is 227 /// cheaper to allocate caller saved registers. 228 /// 229 /// These methods take a MachineFunction argument, which can be used to tune 230 /// the allocatable registers based on the characteristics of the function, 231 /// subtarget, or other criteria. 232 /// 233 /// Register allocators should account for the fact that an allocation 234 /// order iterator may return a reserved register and always check 235 /// if the register is allocatable (getAllocatableSet()) before using it. 236 /// 237 /// By default, these methods return all registers in the class. 238 /// 239 virtual iterator allocation_order_begin(const MachineFunction &MF) const { 240 return begin(); 241 } 242 virtual iterator allocation_order_end(const MachineFunction &MF) const { 243 return end(); 244 } 245 246 /// getSize - Return the size of the register in bytes, which is also the size 247 /// of a stack slot allocated to hold a spilled copy of this register. 248 unsigned getSize() const { return RegSize; } 249 250 /// getAlignment - Return the minimum required alignment for a register of 251 /// this class. 252 unsigned getAlignment() const { return Alignment; } 253 254 /// getCopyCost - Return the cost of copying a value between two registers in 255 /// this class. A negative number means the register class is very expensive 256 /// to copy e.g. status flag register classes. 257 int getCopyCost() const { return CopyCost; } 258}; 259 260 261/// TargetRegisterInfo base class - We assume that the target defines a static 262/// array of TargetRegisterDesc objects that represent all of the machine 263/// registers that the target has. As such, we simply have to track a pointer 264/// to this array so that we can turn register number into a register 265/// descriptor. 266/// 267class TargetRegisterInfo { 268protected: 269 const unsigned* SubregHash; 270 const unsigned SubregHashSize; 271 const unsigned* AliasesHash; 272 const unsigned AliasesHashSize; 273public: 274 typedef const TargetRegisterClass * const * regclass_iterator; 275private: 276 const TargetRegisterDesc *Desc; // Pointer to the descriptor array 277 const char *const *SubRegIndexNames; // Names of subreg indexes. 278 unsigned NumRegs; // Number of entries in the array 279 280 regclass_iterator RegClassBegin, RegClassEnd; // List of regclasses 281 282 int CallFrameSetupOpcode, CallFrameDestroyOpcode; 283 284protected: 285 TargetRegisterInfo(const TargetRegisterDesc *D, unsigned NR, 286 regclass_iterator RegClassBegin, 287 regclass_iterator RegClassEnd, 288 const char *const *subregindexnames, 289 int CallFrameSetupOpcode = -1, 290 int CallFrameDestroyOpcode = -1, 291 const unsigned* subregs = 0, 292 const unsigned subregsize = 0, 293 const unsigned* aliases = 0, 294 const unsigned aliasessize = 0); 295 virtual ~TargetRegisterInfo(); 296public: 297 298 enum { // Define some target independent constants 299 /// NoRegister - This physical register is not a real target register. It 300 /// is useful as a sentinel. 301 NoRegister = 0 302 }; 303 304 /// isStackSlot - Sometimes it is useful the be able to store a non-negative 305 /// frame index in a variable that normally holds a register. isStackSlot() 306 /// returns true if Reg is in the range used for stack slots. 307 /// 308 /// Note that isVirtualRegister() and isPhysicalRegister() cannot handle stack 309 /// slots, so if a variable may contains a stack slot, always check 310 /// isStackSlot() first. 311 /// 312 static bool isStackSlot(unsigned Reg) { 313 return int(Reg) >= (1 << 30); 314 } 315 316 /// stackSlot2Index - Compute the frame index from a register value 317 /// representing a stack slot. 318 static int stackSlot2Index(unsigned Reg) { 319 assert(isStackSlot(Reg) && "Not a stack slot"); 320 return int(Reg - (1u << 30)); 321 } 322 323 /// index2StackSlot - Convert a non-negative frame index to a stack slot 324 /// register value. 325 static unsigned index2StackSlot(int FI) { 326 assert(FI >= 0 && "Cannot hold a negative frame index."); 327 return FI + (1u << 30); 328 } 329 330 /// isPhysicalRegister - Return true if the specified register number is in 331 /// the physical register namespace. 332 static bool isPhysicalRegister(unsigned Reg) { 333 assert(!isStackSlot(Reg) && "Not a register! Check isStackSlot() first."); 334 return int(Reg) > 0; 335 } 336 337 /// isVirtualRegister - Return true if the specified register number is in 338 /// the virtual register namespace. 339 static bool isVirtualRegister(unsigned Reg) { 340 assert(!isStackSlot(Reg) && "Not a register! Check isStackSlot() first."); 341 return int(Reg) < 0; 342 } 343 344 /// virtReg2Index - Convert a virtual register number to a 0-based index. 345 /// The first virtual register in a function will get the index 0. 346 static unsigned virtReg2Index(unsigned Reg) { 347 assert(isVirtualRegister(Reg) && "Not a virtual register"); 348 return Reg - (1u << 31); 349 } 350 351 /// index2VirtReg - Convert a 0-based index to a virtual register number. 352 /// This is the inverse operation of VirtReg2IndexFunctor below. 353 static unsigned index2VirtReg(unsigned Index) { 354 return Index + (1u << 31); 355 } 356 357 /// getMinimalPhysRegClass - Returns the Register Class of a physical 358 /// register of the given type, picking the most sub register class of 359 /// the right type that contains this physreg. 360 const TargetRegisterClass * 361 getMinimalPhysRegClass(unsigned Reg, EVT VT = MVT::Other) const; 362 363 /// getAllocatableSet - Returns a bitset indexed by register number 364 /// indicating if a register is allocatable or not. If a register class is 365 /// specified, returns the subset for the class. 366 BitVector getAllocatableSet(const MachineFunction &MF, 367 const TargetRegisterClass *RC = NULL) const; 368 369 const TargetRegisterDesc &operator[](unsigned RegNo) const { 370 assert(RegNo < NumRegs && 371 "Attempting to access record for invalid register number!"); 372 return Desc[RegNo]; 373 } 374 375 /// Provide a get method, equivalent to [], but more useful if we have a 376 /// pointer to this object. 377 /// 378 const TargetRegisterDesc &get(unsigned RegNo) const { 379 return operator[](RegNo); 380 } 381 382 /// getAliasSet - Return the set of registers aliased by the specified 383 /// register, or a null list of there are none. The list returned is zero 384 /// terminated. 385 /// 386 const unsigned *getAliasSet(unsigned RegNo) const { 387 // The Overlaps set always begins with Reg itself. 388 return get(RegNo).Overlaps + 1; 389 } 390 391 /// getOverlaps - Return a list of registers that overlap Reg, including 392 /// itself. This is the same as the alias set except Reg is included in the 393 /// list. 394 /// These are exactly the registers in { x | regsOverlap(x, Reg) }. 395 /// 396 const unsigned *getOverlaps(unsigned RegNo) const { 397 return get(RegNo).Overlaps; 398 } 399 400 /// getSubRegisters - Return the list of registers that are sub-registers of 401 /// the specified register, or a null list of there are none. The list 402 /// returned is zero terminated and sorted according to super-sub register 403 /// relations. e.g. X86::RAX's sub-register list is EAX, AX, AL, AH. 404 /// 405 const unsigned *getSubRegisters(unsigned RegNo) const { 406 return get(RegNo).SubRegs; 407 } 408 409 /// getSuperRegisters - Return the list of registers that are super-registers 410 /// of the specified register, or a null list of there are none. The list 411 /// returned is zero terminated and sorted according to super-sub register 412 /// relations. e.g. X86::AL's super-register list is RAX, EAX, AX. 413 /// 414 const unsigned *getSuperRegisters(unsigned RegNo) const { 415 return get(RegNo).SuperRegs; 416 } 417 418 /// getName - Return the human-readable symbolic target-specific name for the 419 /// specified physical register. 420 const char *getName(unsigned RegNo) const { 421 return get(RegNo).Name; 422 } 423 424 /// getNumRegs - Return the number of registers this target has (useful for 425 /// sizing arrays holding per register information) 426 unsigned getNumRegs() const { 427 return NumRegs; 428 } 429 430 /// getSubRegIndexName - Return the human-readable symbolic target-specific 431 /// name for the specified SubRegIndex. 432 const char *getSubRegIndexName(unsigned SubIdx) const { 433 assert(SubIdx && "This is not a subregister index"); 434 return SubRegIndexNames[SubIdx-1]; 435 } 436 437 /// regsOverlap - Returns true if the two registers are equal or alias each 438 /// other. The registers may be virtual register. 439 bool regsOverlap(unsigned regA, unsigned regB) const { 440 if (regA == regB) 441 return true; 442 443 if (isVirtualRegister(regA) || isVirtualRegister(regB)) 444 return false; 445 446 // regA and regB are distinct physical registers. Do they alias? 447 size_t index = (regA + regB * 37) & (AliasesHashSize-1); 448 unsigned ProbeAmt = 0; 449 while (AliasesHash[index*2] != 0 && 450 AliasesHash[index*2+1] != 0) { 451 if (AliasesHash[index*2] == regA && AliasesHash[index*2+1] == regB) 452 return true; 453 454 index = (index + ProbeAmt) & (AliasesHashSize-1); 455 ProbeAmt += 2; 456 } 457 458 return false; 459 } 460 461 /// isSubRegister - Returns true if regB is a sub-register of regA. 462 /// 463 bool isSubRegister(unsigned regA, unsigned regB) const { 464 // SubregHash is a simple quadratically probed hash table. 465 size_t index = (regA + regB * 37) & (SubregHashSize-1); 466 unsigned ProbeAmt = 2; 467 while (SubregHash[index*2] != 0 && 468 SubregHash[index*2+1] != 0) { 469 if (SubregHash[index*2] == regA && SubregHash[index*2+1] == regB) 470 return true; 471 472 index = (index + ProbeAmt) & (SubregHashSize-1); 473 ProbeAmt += 2; 474 } 475 476 return false; 477 } 478 479 /// isSuperRegister - Returns true if regB is a super-register of regA. 480 /// 481 bool isSuperRegister(unsigned regA, unsigned regB) const { 482 return isSubRegister(regB, regA); 483 } 484 485 /// getCalleeSavedRegs - Return a null-terminated list of all of the 486 /// callee saved registers on this target. The register should be in the 487 /// order of desired callee-save stack frame offset. The first register is 488 /// closed to the incoming stack pointer if stack grows down, and vice versa. 489 virtual const unsigned* getCalleeSavedRegs(const MachineFunction *MF = 0) 490 const = 0; 491 492 493 /// getReservedRegs - Returns a bitset indexed by physical register number 494 /// indicating if a register is a special register that has particular uses 495 /// and should be considered unavailable at all times, e.g. SP, RA. This is 496 /// used by register scavenger to determine what registers are free. 497 virtual BitVector getReservedRegs(const MachineFunction &MF) const = 0; 498 499 /// getSubReg - Returns the physical register number of sub-register "Index" 500 /// for physical register RegNo. Return zero if the sub-register does not 501 /// exist. 502 virtual unsigned getSubReg(unsigned RegNo, unsigned Index) const = 0; 503 504 /// getSubRegIndex - For a given register pair, return the sub-register index 505 /// if the second register is a sub-register of the first. Return zero 506 /// otherwise. 507 virtual unsigned getSubRegIndex(unsigned RegNo, unsigned SubRegNo) const = 0; 508 509 /// getMatchingSuperReg - Return a super-register of the specified register 510 /// Reg so its sub-register of index SubIdx is Reg. 511 unsigned getMatchingSuperReg(unsigned Reg, unsigned SubIdx, 512 const TargetRegisterClass *RC) const { 513 for (const unsigned *SRs = getSuperRegisters(Reg); unsigned SR = *SRs;++SRs) 514 if (Reg == getSubReg(SR, SubIdx) && RC->contains(SR)) 515 return SR; 516 return 0; 517 } 518 519 /// canCombineSubRegIndices - Given a register class and a list of 520 /// subregister indices, return true if it's possible to combine the 521 /// subregister indices into one that corresponds to a larger 522 /// subregister. Return the new subregister index by reference. Note the 523 /// new index may be zero if the given subregisters can be combined to 524 /// form the whole register. 525 virtual bool canCombineSubRegIndices(const TargetRegisterClass *RC, 526 SmallVectorImpl<unsigned> &SubIndices, 527 unsigned &NewSubIdx) const { 528 return 0; 529 } 530 531 /// getMatchingSuperRegClass - Return a subclass of the specified register 532 /// class A so that each register in it has a sub-register of the 533 /// specified sub-register index which is in the specified register class B. 534 virtual const TargetRegisterClass * 535 getMatchingSuperRegClass(const TargetRegisterClass *A, 536 const TargetRegisterClass *B, unsigned Idx) const { 537 return 0; 538 } 539 540 /// composeSubRegIndices - Return the subregister index you get from composing 541 /// two subregister indices. 542 /// 543 /// If R:a:b is the same register as R:c, then composeSubRegIndices(a, b) 544 /// returns c. Note that composeSubRegIndices does not tell you about illegal 545 /// compositions. If R does not have a subreg a, or R:a does not have a subreg 546 /// b, composeSubRegIndices doesn't tell you. 547 /// 548 /// The ARM register Q0 has two D subregs dsub_0:D0 and dsub_1:D1. It also has 549 /// ssub_0:S0 - ssub_3:S3 subregs. 550 /// If you compose subreg indices dsub_1, ssub_0 you get ssub_2. 551 /// 552 virtual unsigned composeSubRegIndices(unsigned a, unsigned b) const { 553 // This default implementation is correct for most targets. 554 return b; 555 } 556 557 //===--------------------------------------------------------------------===// 558 // Register Class Information 559 // 560 561 /// Register class iterators 562 /// 563 regclass_iterator regclass_begin() const { return RegClassBegin; } 564 regclass_iterator regclass_end() const { return RegClassEnd; } 565 566 unsigned getNumRegClasses() const { 567 return (unsigned)(regclass_end()-regclass_begin()); 568 } 569 570 /// getRegClass - Returns the register class associated with the enumeration 571 /// value. See class TargetOperandInfo. 572 const TargetRegisterClass *getRegClass(unsigned i) const { 573 assert(i < getNumRegClasses() && "Register Class ID out of range"); 574 return RegClassBegin[i]; 575 } 576 577 /// getPointerRegClass - Returns a TargetRegisterClass used for pointer 578 /// values. If a target supports multiple different pointer register classes, 579 /// kind specifies which one is indicated. 580 virtual const TargetRegisterClass *getPointerRegClass(unsigned Kind=0) const { 581 assert(0 && "Target didn't implement getPointerRegClass!"); 582 return 0; // Must return a value in order to compile with VS 2005 583 } 584 585 /// getCrossCopyRegClass - Returns a legal register class to copy a register 586 /// in the specified class to or from. Returns NULL if it is possible to copy 587 /// between a two registers of the specified class. 588 virtual const TargetRegisterClass * 589 getCrossCopyRegClass(const TargetRegisterClass *RC) const { 590 return NULL; 591 } 592 593 /// getAllocationOrder - Returns the register allocation order for a specified 594 /// register class in the form of a pair of TargetRegisterClass iterators. 595 virtual std::pair<TargetRegisterClass::iterator,TargetRegisterClass::iterator> 596 getAllocationOrder(const TargetRegisterClass *RC, 597 unsigned HintType, unsigned HintReg, 598 const MachineFunction &MF) const { 599 return std::make_pair(RC->allocation_order_begin(MF), 600 RC->allocation_order_end(MF)); 601 } 602 603 /// ResolveRegAllocHint - Resolves the specified register allocation hint 604 /// to a physical register. Returns the physical register if it is successful. 605 virtual unsigned ResolveRegAllocHint(unsigned Type, unsigned Reg, 606 const MachineFunction &MF) const { 607 if (Type == 0 && Reg && isPhysicalRegister(Reg)) 608 return Reg; 609 return 0; 610 } 611 612 /// UpdateRegAllocHint - A callback to allow target a chance to update 613 /// register allocation hints when a register is "changed" (e.g. coalesced) 614 /// to another register. e.g. On ARM, some virtual registers should target 615 /// register pairs, if one of pair is coalesced to another register, the 616 /// allocation hint of the other half of the pair should be changed to point 617 /// to the new register. 618 virtual void UpdateRegAllocHint(unsigned Reg, unsigned NewReg, 619 MachineFunction &MF) const { 620 // Do nothing. 621 } 622 623 /// requiresRegisterScavenging - returns true if the target requires (and can 624 /// make use of) the register scavenger. 625 virtual bool requiresRegisterScavenging(const MachineFunction &MF) const { 626 return false; 627 } 628 629 /// requiresFrameIndexScavenging - returns true if the target requires post 630 /// PEI scavenging of registers for materializing frame index constants. 631 virtual bool requiresFrameIndexScavenging(const MachineFunction &MF) const { 632 return false; 633 } 634 635 /// requiresVirtualBaseRegisters - Returns true if the target wants the 636 /// LocalStackAllocation pass to be run and virtual base registers 637 /// used for more efficient stack access. 638 virtual bool requiresVirtualBaseRegisters(const MachineFunction &MF) const { 639 return false; 640 } 641 642 /// hasReservedSpillSlot - Return true if target has reserved a spill slot in 643 /// the stack frame of the given function for the specified register. e.g. On 644 /// x86, if the frame register is required, the first fixed stack object is 645 /// reserved as its spill slot. This tells PEI not to create a new stack frame 646 /// object for the given register. It should be called only after 647 /// processFunctionBeforeCalleeSavedScan(). 648 virtual bool hasReservedSpillSlot(const MachineFunction &MF, unsigned Reg, 649 int &FrameIdx) const { 650 return false; 651 } 652 653 /// needsStackRealignment - true if storage within the function requires the 654 /// stack pointer to be aligned more than the normal calling convention calls 655 /// for. 656 virtual bool needsStackRealignment(const MachineFunction &MF) const { 657 return false; 658 } 659 660 /// getFrameIndexInstrOffset - Get the offset from the referenced frame 661 /// index in the instruction, if the is one. 662 virtual int64_t getFrameIndexInstrOffset(const MachineInstr *MI, 663 int Idx) const { 664 return 0; 665 } 666 667 /// needsFrameBaseReg - Returns true if the instruction's frame index 668 /// reference would be better served by a base register other than FP 669 /// or SP. Used by LocalStackFrameAllocation to determine which frame index 670 /// references it should create new base registers for. 671 virtual bool needsFrameBaseReg(MachineInstr *MI, int64_t Offset) const { 672 return false; 673 } 674 675 /// materializeFrameBaseRegister - Insert defining instruction(s) for 676 /// BaseReg to be a pointer to FrameIdx before insertion point I. 677 virtual void materializeFrameBaseRegister(MachineBasicBlock *MBB, 678 unsigned BaseReg, int FrameIdx, 679 int64_t Offset) const { 680 assert(0 && "materializeFrameBaseRegister does not exist on this target"); 681 } 682 683 /// resolveFrameIndex - Resolve a frame index operand of an instruction 684 /// to reference the indicated base register plus offset instead. 685 virtual void resolveFrameIndex(MachineBasicBlock::iterator I, 686 unsigned BaseReg, int64_t Offset) const { 687 assert(0 && "resolveFrameIndex does not exist on this target"); 688 } 689 690 /// isFrameOffsetLegal - Determine whether a given offset immediate is 691 /// encodable to resolve a frame index. 692 virtual bool isFrameOffsetLegal(const MachineInstr *MI, 693 int64_t Offset) const { 694 assert(0 && "isFrameOffsetLegal does not exist on this target"); 695 return false; // Must return a value in order to compile with VS 2005 696 } 697 698 /// getCallFrameSetup/DestroyOpcode - These methods return the opcode of the 699 /// frame setup/destroy instructions if they exist (-1 otherwise). Some 700 /// targets use pseudo instructions in order to abstract away the difference 701 /// between operating with a frame pointer and operating without, through the 702 /// use of these two instructions. 703 /// 704 int getCallFrameSetupOpcode() const { return CallFrameSetupOpcode; } 705 int getCallFrameDestroyOpcode() const { return CallFrameDestroyOpcode; } 706 707 /// eliminateCallFramePseudoInstr - This method is called during prolog/epilog 708 /// code insertion to eliminate call frame setup and destroy pseudo 709 /// instructions (but only if the Target is using them). It is responsible 710 /// for eliminating these instructions, replacing them with concrete 711 /// instructions. This method need only be implemented if using call frame 712 /// setup/destroy pseudo instructions. 713 /// 714 virtual void 715 eliminateCallFramePseudoInstr(MachineFunction &MF, 716 MachineBasicBlock &MBB, 717 MachineBasicBlock::iterator MI) const { 718 assert(getCallFrameSetupOpcode()== -1 && getCallFrameDestroyOpcode()== -1 && 719 "eliminateCallFramePseudoInstr must be implemented if using" 720 " call frame setup/destroy pseudo instructions!"); 721 assert(0 && "Call Frame Pseudo Instructions do not exist on this target!"); 722 } 723 724 725 /// saveScavengerRegister - Spill the register so it can be used by the 726 /// register scavenger. Return true if the register was spilled, false 727 /// otherwise. If this function does not spill the register, the scavenger 728 /// will instead spill it to the emergency spill slot. 729 /// 730 virtual bool saveScavengerRegister(MachineBasicBlock &MBB, 731 MachineBasicBlock::iterator I, 732 MachineBasicBlock::iterator &UseMI, 733 const TargetRegisterClass *RC, 734 unsigned Reg) const { 735 return false; 736 } 737 738 /// eliminateFrameIndex - This method must be overriden to eliminate abstract 739 /// frame indices from instructions which may use them. The instruction 740 /// referenced by the iterator contains an MO_FrameIndex operand which must be 741 /// eliminated by this method. This method may modify or replace the 742 /// specified instruction, as long as it keeps the iterator pointing at the 743 /// finished product. SPAdj is the SP adjustment due to call frame setup 744 /// instruction. 745 virtual void eliminateFrameIndex(MachineBasicBlock::iterator MI, 746 int SPAdj, RegScavenger *RS=NULL) const = 0; 747 748 //===--------------------------------------------------------------------===// 749 /// Debug information queries. 750 751 /// getDwarfRegNum - Map a target register to an equivalent dwarf register 752 /// number. Returns -1 if there is no equivalent value. The second 753 /// parameter allows targets to use different numberings for EH info and 754 /// debugging info. 755 virtual int getDwarfRegNum(unsigned RegNum, bool isEH) const = 0; 756 757 /// getFrameRegister - This method should return the register used as a base 758 /// for values allocated in the current stack frame. 759 virtual unsigned getFrameRegister(const MachineFunction &MF) const = 0; 760 761 /// getRARegister - This method should return the register where the return 762 /// address can be found. 763 virtual unsigned getRARegister() const = 0; 764}; 765 766 767// This is useful when building IndexedMaps keyed on virtual registers 768struct VirtReg2IndexFunctor : public std::unary_function<unsigned, unsigned> { 769 unsigned operator()(unsigned Reg) const { 770 return TargetRegisterInfo::virtReg2Index(Reg); 771 } 772}; 773 774/// getCommonSubClass - find the largest common subclass of A and B. Return NULL 775/// if there is no common subclass. 776const TargetRegisterClass *getCommonSubClass(const TargetRegisterClass *A, 777 const TargetRegisterClass *B); 778 779/// PrintReg - Helper class for printing registers on a raw_ostream. 780/// Prints virtual and physical registers with or without a TRI instance. 781/// 782/// The format is: 783/// %noreg - NoRegister 784/// %vreg5 - a virtual register. 785/// %vreg5:sub_8bit - a virtual register with sub-register index (with TRI). 786/// %EAX - a physical register 787/// %physreg17 - a physical register when no TRI instance given. 788/// 789/// Usage: OS << PrintReg(Reg, TRI) << '\n'; 790/// 791class PrintReg { 792 const TargetRegisterInfo *TRI; 793 unsigned Reg; 794 unsigned SubIdx; 795public: 796 PrintReg(unsigned reg, const TargetRegisterInfo *tri = 0, unsigned subidx = 0) 797 : TRI(tri), Reg(reg), SubIdx(subidx) {} 798 void print(raw_ostream&) const; 799}; 800 801static inline raw_ostream &operator<<(raw_ostream &OS, const PrintReg &PR) { 802 PR.print(OS); 803 return OS; 804} 805 806} // End llvm namespace 807 808#endif 809