lib/CodeGen/MachineRegisterInfo.cpp

   1 //===-- lib/Codegen/MachineRegisterInfo.cpp -------------------------------===//
   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 // Implementation of the MachineRegisterInfo class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/CodeGen/MachineRegisterInfo.h"
  15 #include "llvm/CodeGen/MachineInstrBuilder.h"
  16 #include "llvm/Support/raw_os_ostream.h"
  17 #include "llvm/Target/TargetInstrInfo.h"
  18 #include "llvm/Target/TargetMachine.h"
  19 #include "llvm/Target/TargetSubtargetInfo.h"
  20
  21 using namespace llvm;
  22
  23 // Pin the vtable to this file.
  24 void MachineRegisterInfo::Delegate::anchor() {}
  25
  26 MachineRegisterInfo::MachineRegisterInfo(const TargetMachine &TM)
  27   : TM(TM), TheDelegate(nullptr), IsSSA(true), TracksLiveness(true) {
  28   VRegInfo.reserve(256);
  29   RegAllocHints.reserve(256);
  30   UsedRegUnits.resize(getTargetRegisterInfo()->getNumRegUnits());
  31   UsedPhysRegMask.resize(getTargetRegisterInfo()->getNumRegs());
  32
  33   // Create the physreg use/def lists.
  34   PhysRegUseDefLists =
  35     new MachineOperand*[getTargetRegisterInfo()->getNumRegs()];
  36   memset(PhysRegUseDefLists, 0,
  37          sizeof(MachineOperand*)*getTargetRegisterInfo()->getNumRegs());
  38 }
  39
  40 MachineRegisterInfo::~MachineRegisterInfo() {
  41   delete [] PhysRegUseDefLists;
  42 }
  43
  44 /// setRegClass - Set the register class of the specified virtual register.
  45 ///
  46 void
  47 MachineRegisterInfo::setRegClass(unsigned Reg, const TargetRegisterClass *RC) {
  48   assert(RC && RC->isAllocatable() && "Invalid RC for virtual register");
  49   VRegInfo[Reg].first = RC;
  50 }
  51
  52 const TargetRegisterClass *
  53 MachineRegisterInfo::constrainRegClass(unsigned Reg,
  54                                        const TargetRegisterClass *RC,
  55                                        unsigned MinNumRegs) {
  56   const TargetRegisterClass *OldRC = getRegClass(Reg);
  57   if (OldRC == RC)
  58     return RC;
  59   const TargetRegisterClass *NewRC =
  60     getTargetRegisterInfo()->getCommonSubClass(OldRC, RC);
  61   if (!NewRC || NewRC == OldRC)
  62     return NewRC;
  63   if (NewRC->getNumRegs() < MinNumRegs)
  64     return nullptr;
  65   setRegClass(Reg, NewRC);
  66   return NewRC;
  67 }
  68
  69 bool
  70 MachineRegisterInfo::recomputeRegClass(unsigned Reg, const TargetMachine &TM) {
  71   const TargetInstrInfo *TII = TM.getSubtargetImpl()->getInstrInfo();
  72   const TargetRegisterClass *OldRC = getRegClass(Reg);
  73   const TargetRegisterClass *NewRC =
  74     getTargetRegisterInfo()->getLargestLegalSuperClass(OldRC);
  75
  76   // Stop early if there is no room to grow.
  77   if (NewRC == OldRC)
  78     return false;
  79
  80   // Accumulate constraints from all uses.
  81   for (MachineOperand &MO : reg_nodbg_operands(Reg)) {
  82     // Apply the effect of the given operand to NewRC.
  83     MachineInstr *MI = MO.getParent();
  84     unsigned OpNo = &MO - &MI->getOperand(0);
  85     NewRC = MI->getRegClassConstraintEffect(OpNo, NewRC, TII,
  86                                             getTargetRegisterInfo());
  87     if (!NewRC || NewRC == OldRC)
  88       return false;
  89   }
  90   setRegClass(Reg, NewRC);
  91   return true;
  92 }
  93
  94 /// createVirtualRegister - Create and return a new virtual register in the
  95 /// function with the specified register class.
  96 ///
  97 unsigned
  98 MachineRegisterInfo::createVirtualRegister(const TargetRegisterClass *RegClass){
  99   assert(RegClass && "Cannot create register without RegClass!");
 100   assert(RegClass->isAllocatable() &&
 101          "Virtual register RegClass must be allocatable.");
 102
 103   // New virtual register number.
 104   unsigned Reg = TargetRegisterInfo::index2VirtReg(getNumVirtRegs());
 105   VRegInfo.grow(Reg);
 106   VRegInfo[Reg].first = RegClass;
 107   RegAllocHints.grow(Reg);
 108   if (TheDelegate)
 109     TheDelegate->MRI_NoteNewVirtualRegister(Reg);
 110   return Reg;
 111 }
 112
 113 /// clearVirtRegs - Remove all virtual registers (after physreg assignment).
 114 void MachineRegisterInfo::clearVirtRegs() {
 115 #ifndef NDEBUG
 116   for (unsigned i = 0, e = getNumVirtRegs(); i != e; ++i) {
 117     unsigned Reg = TargetRegisterInfo::index2VirtReg(i);
 118     if (!VRegInfo[Reg].second)
 119       continue;
 120     verifyUseList(Reg);
 121     llvm_unreachable("Remaining virtual register operands");
 122   }
 123 #endif
 124   VRegInfo.clear();
 125 }
 126
 127 void MachineRegisterInfo::verifyUseList(unsigned Reg) const {
 128 #ifndef NDEBUG
 129   bool Valid = true;
 130   for (MachineOperand &M : reg_operands(Reg)) {
 131     MachineOperand *MO = &M;
 132     MachineInstr *MI = MO->getParent();
 133     if (!MI) {
 134       errs() << PrintReg(Reg, getTargetRegisterInfo())
 135              << " use list MachineOperand " << MO
 136              << " has no parent instruction.\n";
 137       Valid = false;
 138     }
 139     MachineOperand *MO0 = &MI->getOperand(0);
 140     unsigned NumOps = MI->getNumOperands();
 141     if (!(MO >= MO0 && MO < MO0+NumOps)) {
 142       errs() << PrintReg(Reg, getTargetRegisterInfo())
 143              << " use list MachineOperand " << MO
 144              << " doesn't belong to parent MI: " << *MI;
 145       Valid = false;
 146     }
 147     if (!MO->isReg()) {
 148       errs() << PrintReg(Reg, getTargetRegisterInfo())
 149              << " MachineOperand " << MO << ": " << *MO
 150              << " is not a register\n";
 151       Valid = false;
 152     }
 153     if (MO->getReg() != Reg) {
 154       errs() << PrintReg(Reg, getTargetRegisterInfo())
 155              << " use-list MachineOperand " << MO << ": "
 156              << *MO << " is the wrong register\n";
 157       Valid = false;
 158     }
 159   }
 160   assert(Valid && "Invalid use list");
 161 #endif
 162 }
 163
 164 void MachineRegisterInfo::verifyUseLists() const {
 165 #ifndef NDEBUG
 166   for (unsigned i = 0, e = getNumVirtRegs(); i != e; ++i)
 167     verifyUseList(TargetRegisterInfo::index2VirtReg(i));
 168   for (unsigned i = 1, e = getTargetRegisterInfo()->getNumRegs(); i != e; ++i)
 169     verifyUseList(i);
 170 #endif
 171 }
 172
 173 /// Add MO to the linked list of operands for its register.
 174 void MachineRegisterInfo::addRegOperandToUseList(MachineOperand *MO) {
 175   assert(!MO->isOnRegUseList() && "Already on list");
 176   MachineOperand *&HeadRef = getRegUseDefListHead(MO->getReg());
 177   MachineOperand *const Head = HeadRef;
 178
 179   // Head points to the first list element.
 180   // Next is NULL on the last list element.
 181   // Prev pointers are circular, so Head->Prev == Last.
 182
 183   // Head is NULL for an empty list.
 184   if (!Head) {
 185     MO->Contents.Reg.Prev = MO;
 186     MO->Contents.Reg.Next = nullptr;
 187     HeadRef = MO;
 188     return;
 189   }
 190   assert(MO->getReg() == Head->getReg() && "Different regs on the same list!");
 191
 192   // Insert MO between Last and Head in the circular Prev chain.
 193   MachineOperand *Last = Head->Contents.Reg.Prev;
 194   assert(Last && "Inconsistent use list");
 195   assert(MO->getReg() == Last->getReg() && "Different regs on the same list!");
 196   Head->Contents.Reg.Prev = MO;
 197   MO->Contents.Reg.Prev = Last;
 198
 199   // Def operands always precede uses. This allows def_iterator to stop early.
 200   // Insert def operands at the front, and use operands at the back.
 201   if (MO->isDef()) {
 202     // Insert def at the front.
 203     MO->Contents.Reg.Next = Head;
 204     HeadRef = MO;
 205   } else {
 206     // Insert use at the end.
 207     MO->Contents.Reg.Next = nullptr;
 208     Last->Contents.Reg.Next = MO;
 209   }
 210 }
 211
 212 /// Remove MO from its use-def list.
 213 void MachineRegisterInfo::removeRegOperandFromUseList(MachineOperand *MO) {
 214   assert(MO->isOnRegUseList() && "Operand not on use list");
 215   MachineOperand *&HeadRef = getRegUseDefListHead(MO->getReg());
 216   MachineOperand *const Head = HeadRef;
 217   assert(Head && "List already empty");
 218
 219   // Unlink this from the doubly linked list of operands.
 220   MachineOperand *Next = MO->Contents.Reg.Next;
 221   MachineOperand *Prev = MO->Contents.Reg.Prev;
 222
 223   // Prev links are circular, next link is NULL instead of looping back to Head.
 224   if (MO == Head)
 225     HeadRef = Next;
 226   else
 227     Prev->Contents.Reg.Next = Next;
 228
 229   (Next ? Next : Head)->Contents.Reg.Prev = Prev;
 230
 231   MO->Contents.Reg.Prev = nullptr;
 232   MO->Contents.Reg.Next = nullptr;
 233 }
 234
 235 /// Move NumOps operands from Src to Dst, updating use-def lists as needed.
 236 ///
 237 /// The Dst range is assumed to be uninitialized memory. (Or it may contain
 238 /// operands that won't be destroyed, which is OK because the MO destructor is
 239 /// trivial anyway).
 240 ///
 241 /// The Src and Dst ranges may overlap.
 242 void MachineRegisterInfo::moveOperands(MachineOperand *Dst,
 243                                        MachineOperand *Src,
 244                                        unsigned NumOps) {
 245   assert(Src != Dst && NumOps && "Noop moveOperands");
 246
 247   // Copy backwards if Dst is within the Src range.
 248   int Stride = 1;
 249   if (Dst >= Src && Dst < Src + NumOps) {
 250     Stride = -1;
 251     Dst += NumOps - 1;
 252     Src += NumOps - 1;
 253   }
 254
 255   // Copy one operand at a time.
 256   do {
 257     new (Dst) MachineOperand(*Src);
 258
 259     // Dst takes Src's place in the use-def chain.
 260     if (Src->isReg()) {
 261       MachineOperand *&Head = getRegUseDefListHead(Src->getReg());
 262       MachineOperand *Prev = Src->Contents.Reg.Prev;
 263       MachineOperand *Next = Src->Contents.Reg.Next;
 264       assert(Head && "List empty, but operand is chained");
 265       assert(Prev && "Operand was not on use-def list");
 266
 267       // Prev links are circular, next link is NULL instead of looping back to
 268       // Head.
 269       if (Src == Head)
 270         Head = Dst;
 271       else
 272         Prev->Contents.Reg.Next = Dst;
 273
 274       // Update Prev pointer. This also works when Src was pointing to itself
 275       // in a 1-element list. In that case Head == Dst.
 276       (Next ? Next : Head)->Contents.Reg.Prev = Dst;
 277     }
 278
 279     Dst += Stride;
 280     Src += Stride;
 281   } while (--NumOps);
 282 }
 283
 284 /// replaceRegWith - Replace all instances of FromReg with ToReg in the
 285 /// machine function.  This is like llvm-level X->replaceAllUsesWith(Y),
 286 /// except that it also changes any definitions of the register as well.
 287 void MachineRegisterInfo::replaceRegWith(unsigned FromReg, unsigned ToReg) {
 288   assert(FromReg != ToReg && "Cannot replace a reg with itself");
 289
 290   // TODO: This could be more efficient by bulk changing the operands.
 291   for (reg_iterator I = reg_begin(FromReg), E = reg_end(); I != E; ) {
 292     MachineOperand &O = *I;
 293     ++I;
 294     O.setReg(ToReg);
 295   }
 296 }
 297
 298
 299 /// getVRegDef - Return the machine instr that defines the specified virtual
 300 /// register or null if none is found.  This assumes that the code is in SSA
 301 /// form, so there should only be one definition.
 302 MachineInstr *MachineRegisterInfo::getVRegDef(unsigned Reg) const {
 303   // Since we are in SSA form, we can use the first definition.
 304   def_instr_iterator I = def_instr_begin(Reg);
 305   assert((I.atEnd() || std::next(I) == def_instr_end()) &&
 306          "getVRegDef assumes a single definition or no definition");
 307   return !I.atEnd() ? &*I : nullptr;
 308 }
 309
 310 /// getUniqueVRegDef - Return the unique machine instr that defines the
 311 /// specified virtual register or null if none is found.  If there are
 312 /// multiple definitions or no definition, return null.
 313 MachineInstr *MachineRegisterInfo::getUniqueVRegDef(unsigned Reg) const {
 314   if (def_empty(Reg)) return nullptr;
 315   def_instr_iterator I = def_instr_begin(Reg);
 316   if (std::next(I) != def_instr_end())
 317     return nullptr;
 318   return &*I;
 319 }
 320
 321 bool MachineRegisterInfo::hasOneNonDBGUse(unsigned RegNo) const {
 322   use_nodbg_iterator UI = use_nodbg_begin(RegNo);
 323   if (UI == use_nodbg_end())
 324     return false;
 325   return ++UI == use_nodbg_end();
 326 }
 327
 328 /// clearKillFlags - Iterate over all the uses of the given register and
 329 /// clear the kill flag from the MachineOperand. This function is used by
 330 /// optimization passes which extend register lifetimes and need only
 331 /// preserve conservative kill flag information.
 332 void MachineRegisterInfo::clearKillFlags(unsigned Reg) const {
 333   for (MachineOperand &MO : use_operands(Reg))
 334     MO.setIsKill(false);
 335 }
 336
 337 bool MachineRegisterInfo::isLiveIn(unsigned Reg) const {
 338   for (livein_iterator I = livein_begin(), E = livein_end(); I != E; ++I)
 339     if (I->first == Reg || I->second == Reg)
 340       return true;
 341   return false;
 342 }
 343
 344 /// getLiveInPhysReg - If VReg is a live-in virtual register, return the
 345 /// corresponding live-in physical register.
 346 unsigned MachineRegisterInfo::getLiveInPhysReg(unsigned VReg) const {
 347   for (livein_iterator I = livein_begin(), E = livein_end(); I != E; ++I)
 348     if (I->second == VReg)
 349       return I->first;
 350   return 0;
 351 }
 352
 353 /// getLiveInVirtReg - If PReg is a live-in physical register, return the
 354 /// corresponding live-in physical register.
 355 unsigned MachineRegisterInfo::getLiveInVirtReg(unsigned PReg) const {
 356   for (livein_iterator I = livein_begin(), E = livein_end(); I != E; ++I)
 357     if (I->first == PReg)
 358       return I->second;
 359   return 0;
 360 }
 361
 362 /// EmitLiveInCopies - Emit copies to initialize livein virtual registers
 363 /// into the given entry block.
 364 void
 365 MachineRegisterInfo::EmitLiveInCopies(MachineBasicBlock *EntryMBB,
 366                                       const TargetRegisterInfo &TRI,
 367                                       const TargetInstrInfo &TII) {
 368   // Emit the copies into the top of the block.
 369   for (unsigned i = 0, e = LiveIns.size(); i != e; ++i)
 370     if (LiveIns[i].second) {
 371       if (use_empty(LiveIns[i].second)) {
 372         // The livein has no uses. Drop it.
 373         //
 374         // It would be preferable to have isel avoid creating live-in
 375         // records for unused arguments in the first place, but it's
 376         // complicated by the debug info code for arguments.
 377         LiveIns.erase(LiveIns.begin() + i);
 378         --i; --e;
 379       } else {
 380         // Emit a copy.
 381         BuildMI(*EntryMBB, EntryMBB->begin(), DebugLoc(),
 382                 TII.get(TargetOpcode::COPY), LiveIns[i].second)
 383           .addReg(LiveIns[i].first);
 384
 385         // Add the register to the entry block live-in set.
 386         EntryMBB->addLiveIn(LiveIns[i].first);
 387       }
 388     } else {
 389       // Add the register to the entry block live-in set.
 390       EntryMBB->addLiveIn(LiveIns[i].first);
 391     }
 392 }
 393
 394 #ifndef NDEBUG
 395 void MachineRegisterInfo::dumpUses(unsigned Reg) const {
 396   for (MachineInstr &I : use_instructions(Reg))
 397     I.dump();
 398 }
 399 #endif
 400
 401 void MachineRegisterInfo::freezeReservedRegs(const MachineFunction &MF) {
 402   ReservedRegs = getTargetRegisterInfo()->getReservedRegs(MF);
 403   assert(ReservedRegs.size() == getTargetRegisterInfo()->getNumRegs() &&
 404          "Invalid ReservedRegs vector from target");
 405 }
 406
 407 bool MachineRegisterInfo::isConstantPhysReg(unsigned PhysReg,
 408                                             const MachineFunction &MF) const {
 409   assert(TargetRegisterInfo::isPhysicalRegister(PhysReg));
 410
 411   // Check if any overlapping register is modified, or allocatable so it may be
 412   // used later.
 413   for (MCRegAliasIterator AI(PhysReg, getTargetRegisterInfo(), true);
 414        AI.isValid(); ++AI)
 415     if (!def_empty(*AI) || isAllocatable(*AI))
 416       return false;
 417   return true;
 418 }
 419
 420 /// markUsesInDebugValueAsUndef - Mark every DBG_VALUE referencing the
 421 /// specified register as undefined which causes the DBG_VALUE to be
 422 /// deleted during LiveDebugVariables analysis.
 423 void MachineRegisterInfo::markUsesInDebugValueAsUndef(unsigned Reg) const {
 424   // Mark any DBG_VALUE that uses Reg as undef (but don't delete it.)
 425   MachineRegisterInfo::use_instr_iterator nextI;
 426   for (use_instr_iterator I = use_instr_begin(Reg), E = use_instr_end();
 427        I != E; I = nextI) {
 428     nextI = std::next(I);  // I is invalidated by the setReg
 429     MachineInstr *UseMI = &*I;
 430     if (UseMI->isDebugValue())
 431       UseMI->getOperand(0).setReg(0U);
 432   }
 433 }