lib/CodeGen/LiveRangeCalc.cpp

   1 //===---- LiveRangeCalc.cpp - Calculate live ranges -----------------------===//
   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 LiveRangeCalc class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "LiveRangeCalc.h"
  15 #include "llvm/CodeGen/MachineDominators.h"
  16 #include "llvm/CodeGen/MachineRegisterInfo.h"
  17
  18 using namespace llvm;
  19
  20 #define DEBUG_TYPE "regalloc"
  21
  22 void LiveRangeCalc::reset(const MachineFunction *mf,
  23                           SlotIndexes *SI,
  24                           MachineDominatorTree *MDT,
  25                           VNInfo::Allocator *VNIA) {
  26   MF = mf;
  27   MRI = &MF->getRegInfo();
  28   Indexes = SI;
  29   DomTree = MDT;
  30   Alloc = VNIA;
  31
  32   MainLiveOutData.reset(MF->getNumBlockIDs());
  33   LiveIn.clear();
  34 }
  35
  36
  37 static SlotIndex getDefIndex(const SlotIndexes &Indexes, const MachineInstr &MI,
  38                              bool EarlyClobber) {
  39   // PHI defs begin at the basic block start index.
  40   if (MI.isPHI())
  41     return Indexes.getMBBStartIdx(MI.getParent());
  42
  43   // Instructions are either normal 'r', or early clobber 'e'.
  44   return Indexes.getInstructionIndex(&MI).getRegSlot(EarlyClobber);
  45 }
  46
  47 void LiveRangeCalc::createDeadDefs(LiveInterval &LI) {
  48   assert(MRI && Indexes && "call reset() first");
  49
  50   // Visit all def operands. If the same instruction has multiple defs of Reg,
  51   // LR.createDeadDef() will deduplicate.
  52   const TargetRegisterInfo &TRI = *MRI->getTargetRegisterInfo();
  53   unsigned Reg = LI.reg;
  54   for (const MachineOperand &MO : MRI->def_operands(Reg)) {
  55     const MachineInstr *MI = MO.getParent();
  56     SlotIndex Idx = getDefIndex(*Indexes, *MI, MO.isEarlyClobber());
  57     unsigned SubReg = MO.getSubReg();
  58     if (LI.hasSubRanges() || (SubReg != 0 && MRI->tracksSubRegLiveness())) {
  59       unsigned Mask = SubReg != 0 ? TRI.getSubRegIndexLaneMask(SubReg)
  60                                   : MRI->getMaxLaneMaskForVReg(Reg);
  61
  62       // If this is the first time we see a subregister def, initialize
  63       // subranges by creating a copy of the main range.
  64       if (!LI.hasSubRanges() && !LI.empty()) {
  65         unsigned ClassMask = MRI->getMaxLaneMaskForVReg(Reg);
  66         LI.createSubRangeFrom(*Alloc, ClassMask, LI);
  67       }
  68
  69       for (LiveInterval::SubRange &S : LI.subranges()) {
  70         // A Mask for subregs common to the existing subrange and current def.
  71         unsigned Common = S.LaneMask & Mask;
  72         if (Common == 0)
  73           continue;
  74         // A Mask for subregs covered by the subrange but not the current def.
  75         unsigned LRest = S.LaneMask & ~Mask;
  76         LiveInterval::SubRange *CommonRange;
  77         if (LRest != 0) {
  78           // Split current subrange into Common and LRest ranges.
  79           S.LaneMask = LRest;
  80           CommonRange = LI.createSubRangeFrom(*Alloc, Common, S);
  81         } else {
  82           assert(Common == S.LaneMask);
  83           CommonRange = &S;
  84         }
  85         CommonRange->createDeadDef(Idx, *Alloc);
  86         Mask &= ~Common;
  87       }
  88       if (Mask != 0) {
  89         LiveInterval::SubRange *SubRange = LI.createSubRange(*Alloc, Mask);
  90         SubRange->createDeadDef(Idx, *Alloc);
  91       }
  92     }
  93
  94     // Create the def in LR. This may find an existing def.
  95     LI.createDeadDef(Idx, *Alloc);
  96   }
  97 }
  98
  99
 100 void LiveRangeCalc::createDeadDefs(LiveRange &LR, unsigned Reg) {
 101   assert(MRI && Indexes && "call reset() first");
 102
 103   // Visit all def operands. If the same instruction has multiple defs of Reg,
 104   // LR.createDeadDef() will deduplicate.
 105   for (MachineOperand &MO : MRI->def_operands(Reg)) {
 106     const MachineInstr *MI = MO.getParent();
 107     SlotIndex Idx = getDefIndex(*Indexes, *MI, MO.isEarlyClobber());
 108     // Create the def in LR. This may find an existing def.
 109     LR.createDeadDef(Idx, *Alloc);
 110   }
 111 }
 112
 113
 114 static SlotIndex getUseIndex(const SlotIndexes &Indexes,
 115                              const MachineOperand &MO) {
 116   const MachineInstr *MI = MO.getParent();
 117   unsigned OpNo = (&MO - &MI->getOperand(0));
 118   if (MI->isPHI()) {
 119     assert(!MO.isDef() && "Cannot handle PHI def of partial register.");
 120     // The actual place where a phi operand is used is the end of the pred MBB.
 121     // PHI operands are paired: (Reg, PredMBB).
 122     return Indexes.getMBBEndIdx(MI->getOperand(OpNo+1).getMBB());
 123   }
 124
 125   // Check for early-clobber redefs.
 126   bool isEarlyClobber = false;
 127   unsigned DefIdx;
 128   if (MO.isDef()) {
 129     isEarlyClobber = MO.isEarlyClobber();
 130   } else if (MI->isRegTiedToDefOperand(OpNo, &DefIdx)) {
 131     // FIXME: This would be a lot easier if tied early-clobber uses also
 132     // had an early-clobber flag.
 133     isEarlyClobber = MI->getOperand(DefIdx).isEarlyClobber();
 134   }
 135   return Indexes.getInstructionIndex(MI).getRegSlot(isEarlyClobber);
 136 }
 137
 138
 139 void LiveRangeCalc::extendToUses(LiveRange &LR, unsigned Reg) {
 140   assert(MRI && Indexes && "call reset() first");
 141
 142   // Visit all operands that read Reg. This may include partial defs.
 143   for (MachineOperand &MO : MRI->reg_nodbg_operands(Reg)) {
 144     // Clear all kill flags. They will be reinserted after register allocation
 145     // by LiveIntervalAnalysis::addKillFlags().
 146     if (MO.isUse())
 147       MO.setIsKill(false);
 148     if (!MO.readsReg())
 149       continue;
 150     // MI is reading Reg. We may have visited MI before if it happens to be
 151     // reading Reg multiple times. That is OK, extend() is idempotent.
 152     SlotIndex Idx = getUseIndex(*Indexes, MO);
 153     extend(LR, Idx, Reg, MainLiveOutData);
 154   }
 155 }
 156
 157
 158 void LiveRangeCalc::extendToUses(LiveInterval &LI) {
 159   assert(MRI && Indexes && "call reset() first");
 160
 161   const TargetRegisterInfo &TRI = *MRI->getTargetRegisterInfo();
 162   SmallVector<LiveOutData,2> LiveOuts;
 163   unsigned NumSubRanges = 0;
 164   for (const auto &S : LI.subranges()) {
 165     (void)S;
 166     ++NumSubRanges;
 167     LiveOuts.push_back(LiveOutData());
 168     LiveOuts.back().reset(MF->getNumBlockIDs());
 169   }
 170
 171   // Visit all operands that read Reg. This may include partial defs.
 172   unsigned Reg = LI.reg;
 173   for (MachineOperand &MO : MRI->reg_nodbg_operands(Reg)) {
 174     // Clear all kill flags. They will be reinserted after register allocation
 175     // by LiveIntervalAnalysis::addKillFlags().
 176     if (MO.isUse())
 177       MO.setIsKill(false);
 178     if (!MO.readsReg())
 179       continue;
 180     SlotIndex Idx = getUseIndex(*Indexes, MO);
 181     unsigned SubReg = MO.getSubReg();
 182     if (MO.isUse() && (LI.hasSubRanges() ||
 183                        (MRI->tracksSubRegLiveness() && SubReg != 0))) {
 184       unsigned Mask = SubReg != 0
 185         ? TRI.getSubRegIndexLaneMask(SubReg)
 186         : MRI->getMaxLaneMaskForVReg(Reg);
 187
 188       // If this is the first time we see a subregister def/use. Initialize
 189       // subranges by creating a copy of the main range.
 190       if (!LI.hasSubRanges()) {
 191         unsigned ClassMask = MRI->getMaxLaneMaskForVReg(Reg);
 192         LI.createSubRangeFrom(*Alloc, ClassMask, LI);
 193         LiveOuts.insert(LiveOuts.begin(), LiveOutData());
 194         LiveOuts.front().reset(MF->getNumBlockIDs());
 195         ++NumSubRanges;
 196       }
 197       unsigned SubRangeIdx = 0;
 198       for (LiveInterval::subrange_iterator S = LI.subrange_begin(),
 199            SE = LI.subrange_end(); S != SE; ++S, ++SubRangeIdx) {
 200         // A Mask for subregs common to the existing subrange and current def.
 201         unsigned Common = S->LaneMask & Mask;
 202         if (Common == 0)
 203           continue;
 204         // A Mask for subregs covered by the subrange but not the current def.
 205         unsigned LRest = S->LaneMask & ~Mask;
 206         LiveInterval::SubRange *CommonRange;
 207         unsigned CommonRangeIdx;
 208         if (LRest != 0) {
 209           // Split current subrange into Common and LRest ranges.
 210           S->LaneMask = LRest;
 211           CommonRange = LI.createSubRangeFrom(*Alloc, Common, *S);
 212           CommonRangeIdx = 0;
 213           LiveOuts.insert(LiveOuts.begin(), LiveOutData());
 214           LiveOuts.front().reset(MF->getNumBlockIDs());
 215           ++NumSubRanges;
 216           ++SubRangeIdx;
 217         } else {
 218           // The subrange and current def lanemasks match completely.
 219           assert(Common == S->LaneMask);
 220           CommonRange = &*S;
 221           CommonRangeIdx = SubRangeIdx;
 222         }
 223         extend(*CommonRange, Idx, Reg, LiveOuts[CommonRangeIdx]);
 224         Mask &= ~Common;
 225       }
 226       assert(SubRangeIdx == NumSubRanges);
 227     }
 228     extend(LI, Idx, Reg, MainLiveOutData);
 229   }
 230 }
 231
 232
 233 void LiveRangeCalc::updateFromLiveIns(LiveOutData &LiveOuts) {
 234   LiveRangeUpdater Updater;
 235   for (const LiveInBlock &I : LiveIn) {
 236     if (!I.DomNode)
 237       continue;
 238     MachineBasicBlock *MBB = I.DomNode->getBlock();
 239     assert(I.Value && "No live-in value found");
 240     SlotIndex Start, End;
 241     std::tie(Start, End) = Indexes->getMBBRange(MBB);
 242
 243     if (I.Kill.isValid())
 244       // Value is killed inside this block.
 245       End = I.Kill;
 246     else {
 247       // The value is live-through, update LiveOut as well.
 248       // Defer the Domtree lookup until it is needed.
 249       assert(LiveOuts.Seen.test(MBB->getNumber()));
 250       LiveOuts.Map[MBB] = LiveOutPair(I.Value, nullptr);
 251     }
 252     Updater.setDest(&I.LR);
 253     Updater.add(Start, End, I.Value);
 254   }
 255   LiveIn.clear();
 256 }
 257
 258
 259 void LiveRangeCalc::extend(LiveRange &LR, SlotIndex Kill, unsigned PhysReg,
 260                            LiveOutData &LiveOuts) {
 261   assert(Kill.isValid() && "Invalid SlotIndex");
 262   assert(Indexes && "Missing SlotIndexes");
 263   assert(DomTree && "Missing dominator tree");
 264
 265   MachineBasicBlock *KillMBB = Indexes->getMBBFromIndex(Kill.getPrevSlot());
 266   assert(KillMBB && "No MBB at Kill");
 267
 268   // Is there a def in the same MBB we can extend?
 269   if (LR.extendInBlock(Indexes->getMBBStartIdx(KillMBB), Kill))
 270     return;
 271
 272   // Find the single reaching def, or determine if Kill is jointly dominated by
 273   // multiple values, and we may need to create even more phi-defs to preserve
 274   // VNInfo SSA form.  Perform a search for all predecessor blocks where we
 275   // know the dominating VNInfo.
 276   if (findReachingDefs(LR, *KillMBB, Kill, PhysReg, LiveOuts))
 277     return;
 278
 279   // When there were multiple different values, we may need new PHIs.
 280   calculateValues(LiveOuts);
 281 }
 282
 283
 284 // This function is called by a client after using the low-level API to add
 285 // live-out and live-in blocks.  The unique value optimization is not
 286 // available, SplitEditor::transferValues handles that case directly anyway.
 287 void LiveRangeCalc::calculateValues(LiveOutData &LiveOuts) {
 288   assert(Indexes && "Missing SlotIndexes");
 289   assert(DomTree && "Missing dominator tree");
 290   updateSSA(LiveOuts);
 291   updateFromLiveIns(LiveOuts);
 292 }
 293
 294
 295 bool LiveRangeCalc::findReachingDefs(LiveRange &LR, MachineBasicBlock &KillMBB,
 296                                      SlotIndex Kill, unsigned PhysReg,
 297                                      LiveOutData &LiveOuts) {
 298   unsigned KillMBBNum = KillMBB.getNumber();
 299
 300   // Block numbers where LR should be live-in.
 301   SmallVector<unsigned, 16> WorkList(1, KillMBBNum);
 302
 303   // Remember if we have seen more than one value.
 304   bool UniqueVNI = true;
 305   VNInfo *TheVNI = nullptr;
 306
 307   // Using Seen as a visited set, perform a BFS for all reaching defs.
 308   for (unsigned i = 0; i != WorkList.size(); ++i) {
 309     MachineBasicBlock *MBB = MF->getBlockNumbered(WorkList[i]);
 310
 311 #ifndef NDEBUG
 312     if (MBB->pred_empty()) {
 313       MBB->getParent()->verify();
 314       llvm_unreachable("Use not jointly dominated by defs.");
 315     }
 316
 317     if (TargetRegisterInfo::isPhysicalRegister(PhysReg) &&
 318         !MBB->isLiveIn(PhysReg)) {
 319       MBB->getParent()->verify();
 320       errs() << "The register needs to be live in to BB#" << MBB->getNumber()
 321              << ", but is missing from the live-in list.\n";
 322       llvm_unreachable("Invalid global physical register");
 323     }
 324 #endif
 325
 326     for (MachineBasicBlock::pred_iterator PI = MBB->pred_begin(),
 327          PE = MBB->pred_end(); PI != PE; ++PI) {
 328        MachineBasicBlock *Pred = *PI;
 329
 330        // Is this a known live-out block?
 331        if (LiveOuts.Seen.test(Pred->getNumber())) {
 332          if (VNInfo *VNI = LiveOuts.Map[Pred].first) {
 333            if (TheVNI && TheVNI != VNI)
 334              UniqueVNI = false;
 335            TheVNI = VNI;
 336          }
 337          continue;
 338        }
 339
 340        SlotIndex Start, End;
 341        std::tie(Start, End) = Indexes->getMBBRange(Pred);
 342
 343        // First time we see Pred.  Try to determine the live-out value, but set
 344        // it as null if Pred is live-through with an unknown value.
 345        VNInfo *VNI = LR.extendInBlock(Start, End);
 346        LiveOuts.setLiveOutValue(Pred, VNI);
 347        if (VNI) {
 348          if (TheVNI && TheVNI != VNI)
 349            UniqueVNI = false;
 350          TheVNI = VNI;
 351          continue;
 352        }
 353
 354        // No, we need a live-in value for Pred as well
 355        if (Pred != &KillMBB)
 356           WorkList.push_back(Pred->getNumber());
 357        else
 358           // Loopback to KillMBB, so value is really live through.
 359          Kill = SlotIndex();
 360     }
 361   }
 362
 363   LiveIn.clear();
 364
 365   // Both updateSSA() and LiveRangeUpdater benefit from ordered blocks, but
 366   // neither require it. Skip the sorting overhead for small updates.
 367   if (WorkList.size() > 4)
 368     array_pod_sort(WorkList.begin(), WorkList.end());
 369
 370   // If a unique reaching def was found, blit in the live ranges immediately.
 371   if (UniqueVNI) {
 372     LiveRangeUpdater Updater(&LR);
 373     for (SmallVectorImpl<unsigned>::const_iterator I = WorkList.begin(),
 374          E = WorkList.end(); I != E; ++I) {
 375        SlotIndex Start, End;
 376        std::tie(Start, End) = Indexes->getMBBRange(*I);
 377        // Trim the live range in KillMBB.
 378        if (*I == KillMBBNum && Kill.isValid())
 379          End = Kill;
 380        else
 381          LiveOuts.Map[MF->getBlockNumbered(*I)] =
 382            LiveOutPair(TheVNI, nullptr);
 383        Updater.add(Start, End, TheVNI);
 384     }
 385     return true;
 386   }
 387
 388   // Multiple values were found, so transfer the work list to the LiveIn array
 389   // where UpdateSSA will use it as a work list.
 390   LiveIn.reserve(WorkList.size());
 391   for (SmallVectorImpl<unsigned>::const_iterator
 392        I = WorkList.begin(), E = WorkList.end(); I != E; ++I) {
 393     MachineBasicBlock *MBB = MF->getBlockNumbered(*I);
 394     addLiveInBlock(LR, DomTree->getNode(MBB));
 395     if (MBB == &KillMBB)
 396       LiveIn.back().Kill = Kill;
 397   }
 398
 399   return false;
 400 }
 401
 402
 403 // This is essentially the same iterative algorithm that SSAUpdater uses,
 404 // except we already have a dominator tree, so we don't have to recompute it.
 405 void LiveRangeCalc::updateSSA(LiveOutData &LiveOuts) {
 406   assert(Indexes && "Missing SlotIndexes");
 407   assert(DomTree && "Missing dominator tree");
 408
 409   // Interate until convergence.
 410   unsigned Changes;
 411   do {
 412     Changes = 0;
 413     // Propagate live-out values down the dominator tree, inserting phi-defs
 414     // when necessary.
 415     for (LiveInBlock &I : LiveIn) {
 416       MachineDomTreeNode *Node = I.DomNode;
 417       // Skip block if the live-in value has already been determined.
 418       if (!Node)
 419         continue;
 420       MachineBasicBlock *MBB = Node->getBlock();
 421       MachineDomTreeNode *IDom = Node->getIDom();
 422       LiveOutPair IDomValue;
 423
 424       // We need a live-in value to a block with no immediate dominator?
 425       // This is probably an unreachable block that has survived somehow.
 426       bool needPHI = !IDom
 427                   || !LiveOuts.Seen.test(IDom->getBlock()->getNumber());
 428
 429       // IDom dominates all of our predecessors, but it may not be their
 430       // immediate dominator. Check if any of them have live-out values that are
 431       // properly dominated by IDom. If so, we need a phi-def here.
 432       if (!needPHI) {
 433         IDomValue = LiveOuts.Map[IDom->getBlock()];
 434
 435         // Cache the DomTree node that defined the value.
 436         if (IDomValue.first && !IDomValue.second)
 437           LiveOuts.Map[IDom->getBlock()].second = IDomValue.second =
 438             DomTree->getNode(Indexes->getMBBFromIndex(IDomValue.first->def));
 439
 440         for (MachineBasicBlock::pred_iterator PI = MBB->pred_begin(),
 441                PE = MBB->pred_end(); PI != PE; ++PI) {
 442           LiveOutPair &Value = LiveOuts.Map[*PI];
 443           if (!Value.first || Value.first == IDomValue.first)
 444             continue;
 445
 446           // Cache the DomTree node that defined the value.
 447           if (!Value.second)
 448             Value.second =
 449               DomTree->getNode(Indexes->getMBBFromIndex(Value.first->def));
 450
 451           // This predecessor is carrying something other than IDomValue.
 452           // It could be because IDomValue hasn't propagated yet, or it could be
 453           // because MBB is in the dominance frontier of that value.
 454           if (DomTree->dominates(IDom, Value.second)) {
 455             needPHI = true;
 456             break;
 457           }
 458         }
 459       }
 460
 461       // The value may be live-through even if Kill is set, as can happen when
 462       // we are called from extendRange. In that case LiveOutSeen is true, and
 463       // LiveOut indicates a foreign or missing value.
 464       LiveOutPair &LOP = LiveOuts.Map[MBB];
 465
 466       // Create a phi-def if required.
 467       if (needPHI) {
 468         ++Changes;
 469         assert(Alloc && "Need VNInfo allocator to create PHI-defs");
 470         SlotIndex Start, End;
 471         std::tie(Start, End) = Indexes->getMBBRange(MBB);
 472         LiveRange &LR = I.LR;
 473         VNInfo *VNI = LR.getNextValue(Start, *Alloc);
 474         I.Value = VNI;
 475         // This block is done, we know the final value.
 476         I.DomNode = nullptr;
 477
 478         // Add liveness since updateFromLiveIns now skips this node.
 479         if (I.Kill.isValid())
 480           LR.addSegment(LiveInterval::Segment(Start, I.Kill, VNI));
 481         else {
 482           LR.addSegment(LiveInterval::Segment(Start, End, VNI));
 483           LOP = LiveOutPair(VNI, Node);
 484         }
 485       } else if (IDomValue.first) {
 486         // No phi-def here. Remember incoming value.
 487         I.Value = IDomValue.first;
 488
 489         // If the IDomValue is killed in the block, don't propagate through.
 490         if (I.Kill.isValid())
 491           continue;
 492
 493         // Propagate IDomValue if it isn't killed:
 494         // MBB is live-out and doesn't define its own value.
 495         if (LOP.first == IDomValue.first)
 496           continue;
 497         ++Changes;
 498         LOP = IDomValue;
 499       }
 500     }
 501   } while (Changes);
 502 }