lib/CodeGen/SplitKit.cpp

   1 //===---------- SplitKit.cpp - Toolkit for splitting 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 // This file contains the SplitAnalysis class as well as mutator functions for
  11 // live range splitting.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "splitter"
  16 #include "SplitKit.h"
  17 #include "VirtRegMap.h"
  18 #include "llvm/CodeGen/CalcSpillWeights.h"
  19 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
  20 #include "llvm/CodeGen/MachineInstrBuilder.h"
  21 #include "llvm/CodeGen/MachineLoopInfo.h"
  22 #include "llvm/CodeGen/MachineRegisterInfo.h"
  23 #include "llvm/Support/CommandLine.h"
  24 #include "llvm/Support/Debug.h"
  25 #include "llvm/Support/raw_ostream.h"
  26 #include "llvm/Target/TargetInstrInfo.h"
  27 #include "llvm/Target/TargetMachine.h"
  28
  29 using namespace llvm;
  30
  31 static cl::opt<bool>
  32 AllowSplit("spiller-splits-edges",
  33            cl::desc("Allow critical edge splitting during spilling"));
  34
  35 //===----------------------------------------------------------------------===//
  36 //                                 Split Analysis
  37 //===----------------------------------------------------------------------===//
  38
  39 SplitAnalysis::SplitAnalysis(const MachineFunction &mf,
  40                              const LiveIntervals &lis,
  41                              const MachineLoopInfo &mli)
  42   : mf_(mf),
  43     lis_(lis),
  44     loops_(mli),
  45     tii_(*mf.getTarget().getInstrInfo()),
  46     curli_(0) {}
  47
  48 void SplitAnalysis::clear() {
  49   usingInstrs_.clear();
  50   usingBlocks_.clear();
  51   usingLoops_.clear();
  52   curli_ = 0;
  53 }
  54
  55 bool SplitAnalysis::canAnalyzeBranch(const MachineBasicBlock *MBB) {
  56   MachineBasicBlock *T, *F;
  57   SmallVector<MachineOperand, 4> Cond;
  58   return !tii_.AnalyzeBranch(const_cast<MachineBasicBlock&>(*MBB), T, F, Cond);
  59 }
  60
  61 /// analyzeUses - Count instructions, basic blocks, and loops using curli.
  62 void SplitAnalysis::analyzeUses() {
  63   const MachineRegisterInfo &MRI = mf_.getRegInfo();
  64   for (MachineRegisterInfo::reg_iterator I = MRI.reg_begin(curli_->reg);
  65        MachineInstr *MI = I.skipInstruction();) {
  66     if (MI->isDebugValue() || !usingInstrs_.insert(MI))
  67       continue;
  68     MachineBasicBlock *MBB = MI->getParent();
  69     if (usingBlocks_[MBB]++)
  70       continue;
  71     if (MachineLoop *Loop = loops_.getLoopFor(MBB))
  72       usingLoops_[Loop]++;
  73   }
  74   DEBUG(dbgs() << "  counted "
  75                << usingInstrs_.size() << " instrs, "
  76                << usingBlocks_.size() << " blocks, "
  77                << usingLoops_.size()  << " loops.\n");
  78 }
  79
  80 /// removeUse - Update statistics by noting that MI no longer uses curli.
  81 void SplitAnalysis::removeUse(const MachineInstr *MI) {
  82   if (!usingInstrs_.erase(MI))
  83     return;
  84
  85   // Decrement MBB count.
  86   const MachineBasicBlock *MBB = MI->getParent();
  87   BlockCountMap::iterator bi = usingBlocks_.find(MBB);
  88   assert(bi != usingBlocks_.end() && "MBB missing");
  89   assert(bi->second && "0 count in map");
  90   if (--bi->second)
  91     return;
  92   // No more uses in MBB.
  93   usingBlocks_.erase(bi);
  94
  95   // Decrement loop count.
  96   MachineLoop *Loop = loops_.getLoopFor(MBB);
  97   if (!Loop)
  98     return;
  99   LoopCountMap::iterator li = usingLoops_.find(Loop);
 100   assert(li != usingLoops_.end() && "Loop missing");
 101   assert(li->second && "0 count in map");
 102   if (--li->second)
 103     return;
 104   // No more blocks in Loop.
 105   usingLoops_.erase(li);
 106 }
 107
 108 // Get three sets of basic blocks surrounding a loop: Blocks inside the loop,
 109 // predecessor blocks, and exit blocks.
 110 void SplitAnalysis::getLoopBlocks(const MachineLoop *Loop, LoopBlocks &Blocks) {
 111   Blocks.clear();
 112
 113   // Blocks in the loop.
 114   Blocks.Loop.insert(Loop->block_begin(), Loop->block_end());
 115
 116   // Predecessor blocks.
 117   const MachineBasicBlock *Header = Loop->getHeader();
 118   for (MachineBasicBlock::const_pred_iterator I = Header->pred_begin(),
 119        E = Header->pred_end(); I != E; ++I)
 120     if (!Blocks.Loop.count(*I))
 121       Blocks.Preds.insert(*I);
 122
 123   // Exit blocks.
 124   for (MachineLoop::block_iterator I = Loop->block_begin(),
 125        E = Loop->block_end(); I != E; ++I) {
 126     const MachineBasicBlock *MBB = *I;
 127     for (MachineBasicBlock::const_succ_iterator SI = MBB->succ_begin(),
 128        SE = MBB->succ_end(); SI != SE; ++SI)
 129       if (!Blocks.Loop.count(*SI))
 130         Blocks.Exits.insert(*SI);
 131   }
 132 }
 133
 134 /// analyzeLoopPeripheralUse - Return an enum describing how curli_ is used in
 135 /// and around the Loop.
 136 SplitAnalysis::LoopPeripheralUse SplitAnalysis::
 137 analyzeLoopPeripheralUse(const SplitAnalysis::LoopBlocks &Blocks) {
 138   LoopPeripheralUse use = ContainedInLoop;
 139   for (BlockCountMap::iterator I = usingBlocks_.begin(), E = usingBlocks_.end();
 140        I != E; ++I) {
 141     const MachineBasicBlock *MBB = I->first;
 142     // Is this a peripheral block?
 143     if (use < MultiPeripheral &&
 144         (Blocks.Preds.count(MBB) || Blocks.Exits.count(MBB))) {
 145       if (I->second > 1) use = MultiPeripheral;
 146       else               use = SinglePeripheral;
 147       continue;
 148     }
 149     // Is it a loop block?
 150     if (Blocks.Loop.count(MBB))
 151       continue;
 152     // It must be an unrelated block.
 153     return OutsideLoop;
 154   }
 155   return use;
 156 }
 157
 158 /// getCriticalExits - It may be necessary to partially break critical edges
 159 /// leaving the loop if an exit block has phi uses of curli. Collect the exit
 160 /// blocks that need special treatment into CriticalExits.
 161 void SplitAnalysis::getCriticalExits(const SplitAnalysis::LoopBlocks &Blocks,
 162                                      BlockPtrSet &CriticalExits) {
 163   CriticalExits.clear();
 164
 165   // A critical exit block contains a phi def of curli, and has a predecessor
 166   // that is not in the loop nor a loop predecessor.
 167   // For such an exit block, the edges carrying the new variable must be moved
 168   // to a new pre-exit block.
 169   for (BlockPtrSet::iterator I = Blocks.Exits.begin(), E = Blocks.Exits.end();
 170        I != E; ++I) {
 171     const MachineBasicBlock *Succ = *I;
 172     SlotIndex SuccIdx = lis_.getMBBStartIdx(Succ);
 173     VNInfo *SuccVNI = curli_->getVNInfoAt(SuccIdx);
 174     // This exit may not have curli live in at all. No need to split.
 175     if (!SuccVNI)
 176       continue;
 177     // If this is not a PHI def, it is either using a value from before the
 178     // loop, or a value defined inside the loop. Both are safe.
 179     if (!SuccVNI->isPHIDef() || SuccVNI->def.getBaseIndex() != SuccIdx)
 180       continue;
 181     // This exit block does have a PHI. Does it also have a predecessor that is
 182     // not a loop block or loop predecessor?
 183     for (MachineBasicBlock::const_pred_iterator PI = Succ->pred_begin(),
 184          PE = Succ->pred_end(); PI != PE; ++PI) {
 185       const MachineBasicBlock *Pred = *PI;
 186       if (Blocks.Loop.count(Pred) || Blocks.Preds.count(Pred))
 187         continue;
 188       // This is a critical exit block, and we need to split the exit edge.
 189       CriticalExits.insert(Succ);
 190       break;
 191     }
 192   }
 193 }
 194
 195 /// canSplitCriticalExits - Return true if it is possible to insert new exit
 196 /// blocks before the blocks in CriticalExits.
 197 bool
 198 SplitAnalysis::canSplitCriticalExits(const SplitAnalysis::LoopBlocks &Blocks,
 199                                      BlockPtrSet &CriticalExits) {
 200   // If we don't allow critical edge splitting, require no critical exits.
 201   if (!AllowSplit)
 202     return CriticalExits.empty();
 203
 204   for (BlockPtrSet::iterator I = CriticalExits.begin(), E = CriticalExits.end();
 205        I != E; ++I) {
 206     const MachineBasicBlock *Succ = *I;
 207     // We want to insert a new pre-exit MBB before Succ, and change all the
 208     // in-loop blocks to branch to the pre-exit instead of Succ.
 209     // Check that all the in-loop predecessors can be changed.
 210     for (MachineBasicBlock::const_pred_iterator PI = Succ->pred_begin(),
 211          PE = Succ->pred_end(); PI != PE; ++PI) {
 212       const MachineBasicBlock *Pred = *PI;
 213       // The external predecessors won't be altered.
 214       if (!Blocks.Loop.count(Pred) && !Blocks.Preds.count(Pred))
 215         continue;
 216       if (!canAnalyzeBranch(Pred))
 217         return false;
 218     }
 219
 220     // If Succ's layout predecessor falls through, that too must be analyzable.
 221     // We need to insert the pre-exit block in the gap.
 222     MachineFunction::const_iterator MFI = Succ;
 223     if (MFI == mf_.begin())
 224       continue;
 225     if (!canAnalyzeBranch(--MFI))
 226       return false;
 227   }
 228   // No problems found.
 229   return true;
 230 }
 231
 232 void SplitAnalysis::analyze(const LiveInterval *li) {
 233   clear();
 234   curli_ = li;
 235   analyzeUses();
 236 }
 237
 238 const MachineLoop *SplitAnalysis::getBestSplitLoop() {
 239   assert(curli_ && "Call analyze() before getBestSplitLoop");
 240   if (usingLoops_.empty())
 241     return 0;
 242
 243   LoopPtrSet Loops, SecondLoops;
 244   LoopBlocks Blocks;
 245   BlockPtrSet CriticalExits;
 246
 247   // Find first-class and second class candidate loops.
 248   // We prefer to split around loops where curli is used outside the periphery.
 249   for (LoopCountMap::const_iterator I = usingLoops_.begin(),
 250        E = usingLoops_.end(); I != E; ++I) {
 251     const MachineLoop *Loop = I->first;
 252     getLoopBlocks(Loop, Blocks);
 253
 254     // FIXME: We need an SSA updater to properly handle multiple exit blocks.
 255     if (Blocks.Exits.size() > 1) {
 256       DEBUG(dbgs() << "  multiple exits from " << *Loop);
 257       continue;
 258     }
 259
 260     LoopPtrSet *LPS = 0;
 261     switch(analyzeLoopPeripheralUse(Blocks)) {
 262     case OutsideLoop:
 263       LPS = &Loops;
 264       break;
 265     case MultiPeripheral:
 266       LPS = &SecondLoops;
 267       break;
 268     case ContainedInLoop:
 269       DEBUG(dbgs() << "  contained in " << *Loop);
 270       continue;
 271     case SinglePeripheral:
 272       DEBUG(dbgs() << "  single peripheral use in " << *Loop);
 273       continue;
 274     }
 275     // Will it be possible to split around this loop?
 276     getCriticalExits(Blocks, CriticalExits);
 277     DEBUG(dbgs() << "  " << CriticalExits.size() << " critical exits from "
 278                  << *Loop);
 279     if (!canSplitCriticalExits(Blocks, CriticalExits))
 280       continue;
 281     // This is a possible split.
 282     assert(LPS);
 283     LPS->insert(Loop);
 284   }
 285
 286   DEBUG(dbgs() << "  getBestSplitLoop found " << Loops.size() << " + "
 287                << SecondLoops.size() << " candidate loops.\n");
 288
 289   // If there are no first class loops available, look at second class loops.
 290   if (Loops.empty())
 291     Loops = SecondLoops;
 292
 293   if (Loops.empty())
 294     return 0;
 295
 296   // Pick the earliest loop.
 297   // FIXME: Are there other heuristics to consider?
 298   const MachineLoop *Best = 0;
 299   SlotIndex BestIdx;
 300   for (LoopPtrSet::const_iterator I = Loops.begin(), E = Loops.end(); I != E;
 301        ++I) {
 302     SlotIndex Idx = lis_.getMBBStartIdx((*I)->getHeader());
 303     if (!Best || Idx < BestIdx)
 304       Best = *I, BestIdx = Idx;
 305   }
 306   DEBUG(dbgs() << "  getBestSplitLoop found " << *Best);
 307   return Best;
 308 }
 309
 310 /// getMultiUseBlocks - if curli has more than one use in a basic block, it
 311 /// may be an advantage to split curli for the duration of the block.
 312 bool SplitAnalysis::getMultiUseBlocks(BlockPtrSet &Blocks) {
 313   // If curli is local to one block, there is no point to splitting it.
 314   if (usingBlocks_.size() <= 1)
 315     return false;
 316   // Add blocks with multiple uses.
 317   for (BlockCountMap::iterator I = usingBlocks_.begin(), E = usingBlocks_.end();
 318        I != E; ++I)
 319     switch (I->second) {
 320     case 0:
 321     case 1:
 322       continue;
 323     case 2: {
 324       // It doesn't pay to split a 2-instr block if it redefines curli.
 325       VNInfo *VN1 = curli_->getVNInfoAt(lis_.getMBBStartIdx(I->first));
 326       VNInfo *VN2 =
 327         curli_->getVNInfoAt(lis_.getMBBEndIdx(I->first).getPrevIndex());
 328       // live-in and live-out with a different value.
 329       if (VN1 && VN2 && VN1 != VN2)
 330         continue;
 331     } // Fall through.
 332     default:
 333       Blocks.insert(I->first);
 334     }
 335   return !Blocks.empty();
 336 }
 337
 338 //===----------------------------------------------------------------------===//
 339 //                               LiveIntervalMap
 340 //===----------------------------------------------------------------------===//
 341
 342 // defValue - Introduce a li_ def for ParentVNI that could be later than
 343 // ParentVNI->def.
 344 VNInfo *LiveIntervalMap::defValue(const VNInfo *ParentVNI, SlotIndex Idx) {
 345   assert(ParentVNI && "Mapping  NULL value");
 346   assert(Idx.isValid() && "Invalid SlotIndex");
 347   assert(parentli_.getVNInfoAt(Idx) == ParentVNI && "Bad ParentVNI");
 348
 349   // Is this a simple 1-1 mapping? Not likely.
 350   if (Idx == ParentVNI->def)
 351     return mapValue(ParentVNI, Idx);
 352
 353   // This is a complex def. Mark with a NULL in valueMap.
 354   VNInfo *OldVNI =
 355     valueMap_.insert(ValueMap::value_type(ParentVNI, 0)).first->second;
 356   (void)OldVNI;
 357   assert(OldVNI == 0 && "Simple/Complex values mixed");
 358
 359   // Should we insert a minimal snippet of VNI LiveRange, or can we count on
 360   // callers to do that? We need it for lookups of complex values.
 361   VNInfo *VNI = li_.getNextValue(Idx, 0, true, lis_.getVNInfoAllocator());
 362   return VNI;
 363 }
 364
 365 // mapValue - Find the mapped value for ParentVNI at Idx.
 366 // Potentially create phi-def values.
 367 VNInfo *LiveIntervalMap::mapValue(const VNInfo *ParentVNI, SlotIndex Idx) {
 368   assert(ParentVNI && "Mapping  NULL value");
 369   assert(Idx.isValid() && "Invalid SlotIndex");
 370   assert(parentli_.getVNInfoAt(Idx) == ParentVNI && "Bad ParentVNI");
 371
 372   // Use insert for lookup, so we can add missing values with a second lookup.
 373   std::pair<ValueMap::iterator,bool> InsP =
 374     valueMap_.insert(ValueMap::value_type(ParentVNI, 0));
 375
 376   // This was an unknown value. Create a simple mapping.
 377   if (InsP.second)
 378     return InsP.first->second = li_.createValueCopy(ParentVNI,
 379                                                     lis_.getVNInfoAllocator());
 380   // This was a simple mapped value.
 381   if (InsP.first->second)
 382     return InsP.first->second;
 383
 384   // This is a complex mapped value. There may be multiple defs, and we may need
 385   // to create phi-defs.
 386   MachineBasicBlock *IdxMBB = lis_.getMBBFromIndex(Idx);
 387   assert(IdxMBB && "No MBB at Idx");
 388
 389   // Is there a def in the same MBB we can extend?
 390   if (VNInfo *VNI = extendTo(IdxMBB, Idx))
 391     return VNI;
 392
 393   // Now for the fun part. We know that ParentVNI potentially has multiple defs,
 394   // and we may need to create even more phi-defs to preserve VNInfo SSA form.
 395   // Perform a depth-first search for predecessor blocks where we know the
 396   // dominating VNInfo. Insert phi-def VNInfos along the path back to IdxMBB.
 397
 398   // Track MBBs where we have created or learned the dominating value.
 399   // This may change during the DFS as we create new phi-defs.
 400   typedef DenseMap<MachineBasicBlock*, VNInfo*> MBBValueMap;
 401   MBBValueMap DomValue;
 402
 403   for (idf_iterator<MachineBasicBlock*>
 404          IDFI = idf_begin(IdxMBB),
 405          IDFE = idf_end(IdxMBB); IDFI != IDFE;) {
 406     MachineBasicBlock *MBB = *IDFI;
 407     SlotIndex End = lis_.getMBBEndIdx(MBB);
 408
 409     // We are operating on the restricted CFG where ParentVNI is live.
 410     if (parentli_.getVNInfoAt(End.getPrevSlot()) != ParentVNI) {
 411       IDFI.skipChildren();
 412       continue;
 413     }
 414
 415     // Do we have a dominating value in this block?
 416     VNInfo *VNI = extendTo(MBB, End);
 417     if (!VNI) {
 418       ++IDFI;
 419       continue;
 420     }
 421
 422     // Yes, VNI dominates MBB. Track the path back to IdxMBB, creating phi-defs
 423     // as needed along the way.
 424     for (unsigned PI = IDFI.getPathLength()-1; PI != 0; --PI) {
 425       // Start from MBB's immediate successor. End at IdxMBB.
 426       MachineBasicBlock *Succ = IDFI.getPath(PI-1);
 427       std::pair<MBBValueMap::iterator, bool> InsP =
 428         DomValue.insert(MBBValueMap::value_type(Succ, VNI));
 429
 430       // This is the first time we backtrack to Succ.
 431       if (InsP.second)
 432         continue;
 433
 434       // We reached Succ again with the same VNI. Nothing is going to change.
 435       VNInfo *OVNI = InsP.first->second;
 436       if (OVNI == VNI)
 437         break;
 438
 439       // Succ already has a phi-def. No need to continue.
 440       SlotIndex Start = lis_.getMBBStartIdx(Succ);
 441       if (OVNI->def == Start)
 442         break;
 443
 444       // We have a collision between the old and new VNI at Succ. That means
 445       // neither dominates and we need a new phi-def.
 446       VNI = li_.getNextValue(Start, 0, true, lis_.getVNInfoAllocator());
 447       VNI->setIsPHIDef(true);
 448       InsP.first->second = VNI;
 449
 450       // Replace OVNI with VNI in the remaining path.
 451       for (; PI > 1 ; --PI) {
 452         MBBValueMap::iterator I = DomValue.find(IDFI.getPath(PI-2));
 453         if (I == DomValue.end() || I->second != OVNI)
 454           break;
 455         I->second = VNI;
 456       }
 457     }
 458
 459     // No need to search the children, we found a dominating value.
 460     IDFI.skipChildren();
 461   }
 462
 463   // The search should at least find a dominating value for IdxMBB.
 464   assert(!DomValue.empty() && "Couldn't find a reaching definition");
 465
 466   // Since we went through the trouble of a full DFS visiting all reaching defs,
 467   // the values in DomValue are now accurate. No more phi-defs are needed for
 468   // these blocks, so we can color the live ranges.
 469   // This makes the next mapValue call much faster.
 470   VNInfo *IdxVNI = 0;
 471   for (MBBValueMap::iterator I = DomValue.begin(), E = DomValue.end(); I != E;
 472        ++I) {
 473      MachineBasicBlock *MBB = I->first;
 474      VNInfo *VNI = I->second;
 475      SlotIndex Start = lis_.getMBBStartIdx(MBB);
 476      if (MBB == IdxMBB) {
 477        // Don't add full liveness to IdxMBB, stop at Idx.
 478        if (Start != Idx)
 479          li_.addRange(LiveRange(Start, Idx, VNI));
 480        // The caller had better add some liveness to IdxVNI, or it leaks.
 481        IdxVNI = VNI;
 482      } else
 483       li_.addRange(LiveRange(Start, lis_.getMBBEndIdx(MBB), VNI));
 484   }
 485
 486   assert(IdxVNI && "Didn't find value for Idx");
 487   return IdxVNI;
 488 }
 489
 490 // extendTo - Find the last li_ value defined in MBB at or before Idx. The
 491 // parentli_ is assumed to be live at Idx. Extend the live range to Idx.
 492 // Return the found VNInfo, or NULL.
 493 VNInfo *LiveIntervalMap::extendTo(MachineBasicBlock *MBB, SlotIndex Idx) {
 494   LiveInterval::iterator I = std::upper_bound(li_.begin(), li_.end(), Idx);
 495   if (I == li_.begin())
 496     return 0;
 497   --I;
 498   if (I->start < lis_.getMBBStartIdx(MBB))
 499     return 0;
 500   if (I->end < Idx)
 501     I->end = Idx;
 502   return I->valno;
 503 }
 504
 505 // addSimpleRange - Add a simple range from parentli_ to li_.
 506 // ParentVNI must be live in the [Start;End) interval.
 507 void LiveIntervalMap::addSimpleRange(SlotIndex Start, SlotIndex End,
 508                                      const VNInfo *ParentVNI) {
 509   VNInfo *VNI = mapValue(ParentVNI, Start);
 510   // A simple mappoing is easy.
 511   if (VNI->def == ParentVNI->def) {
 512     li_.addRange(LiveRange(Start, End, VNI));
 513     return;
 514   }
 515
 516   // ParentVNI is a complex value. We must map per MBB.
 517   MachineFunction::iterator MBB = lis_.getMBBFromIndex(Start);
 518   MachineFunction::iterator MBBE = lis_.getMBBFromIndex(End);
 519
 520   if (MBB == MBBE) {
 521     li_.addRange(LiveRange(Start, End, VNI));
 522     return;
 523   }
 524
 525   // First block.
 526   li_.addRange(LiveRange(Start, lis_.getMBBEndIdx(MBB), VNI));
 527
 528   // Run sequence of full blocks.
 529   for (++MBB; MBB != MBBE; ++MBB) {
 530     Start = lis_.getMBBStartIdx(MBB);
 531     li_.addRange(LiveRange(Start, lis_.getMBBEndIdx(MBB),
 532                            mapValue(ParentVNI, Start)));
 533   }
 534
 535   // Final block.
 536   Start = lis_.getMBBStartIdx(MBB);
 537   if (Start != End)
 538     li_.addRange(LiveRange(Start, End, mapValue(ParentVNI, Start)));
 539 }
 540
 541 /// addRange - Add live ranges to li_ where [Start;End) intersects parentli_.
 542 /// All needed values whose def is not inside [Start;End) must be defined
 543 /// beforehand so mapValue will work.
 544 void LiveIntervalMap::addRange(SlotIndex Start, SlotIndex End) {
 545   LiveInterval::const_iterator B = parentli_.begin(), E = parentli_.end();
 546   LiveInterval::const_iterator I = std::lower_bound(B, E, Start);
 547
 548   // Check if --I begins before Start and overlaps.
 549   if (I != B) {
 550     --I;
 551     if (I->end > Start)
 552       addSimpleRange(Start, std::min(End, I->end), I->valno);
 553     ++I;
 554   }
 555
 556   // The remaining ranges begin after Start.
 557   for (;I != E && I->start < End; ++I)
 558     addSimpleRange(I->start, std::min(End, I->end), I->valno);
 559 }
 560
 561 //===----------------------------------------------------------------------===//
 562 //                               Split Editor
 563 //===----------------------------------------------------------------------===//
 564
 565 /// Create a new SplitEditor for editing the LiveInterval analyzed by SA.
 566 SplitEditor::SplitEditor(SplitAnalysis &sa, LiveIntervals &lis, VirtRegMap &vrm,
 567                          SmallVectorImpl<LiveInterval*> &intervals)
 568   : sa_(sa), lis_(lis), vrm_(vrm),
 569     mri_(vrm.getMachineFunction().getRegInfo()),
 570     tii_(*vrm.getMachineFunction().getTarget().getInstrInfo()),
 571     curli_(sa_.getCurLI()),
 572     dupli_(0), openli_(0),
 573     intervals_(intervals),
 574     firstInterval(intervals_.size())
 575 {
 576   assert(curli_ && "SplitEditor created from empty SplitAnalysis");
 577
 578   // Make sure curli_ is assigned a stack slot, so all our intervals get the
 579   // same slot as curli_.
 580   if (vrm_.getStackSlot(curli_->reg) == VirtRegMap::NO_STACK_SLOT)
 581     vrm_.assignVirt2StackSlot(curli_->reg);
 582
 583 }
 584
 585 LiveInterval *SplitEditor::createInterval() {
 586   unsigned curli = sa_.getCurLI()->reg;
 587   unsigned Reg = mri_.createVirtualRegister(mri_.getRegClass(curli));
 588   LiveInterval &Intv = lis_.getOrCreateInterval(Reg);
 589   vrm_.grow();
 590   vrm_.assignVirt2StackSlot(Reg, vrm_.getStackSlot(curli));
 591   return &Intv;
 592 }
 593
 594 LiveInterval *SplitEditor::getDupLI() {
 595   if (!dupli_) {
 596     // Create an interval for dupli that is a copy of curli.
 597     dupli_ = createInterval();
 598     dupli_->Copy(*curli_, &mri_, lis_.getVNInfoAllocator());
 599   }
 600   return dupli_;
 601 }
 602
 603 VNInfo *SplitEditor::mapValue(const VNInfo *curliVNI) {
 604   VNInfo *&VNI = valueMap_[curliVNI];
 605   if (!VNI)
 606     VNI = openli_->createValueCopy(curliVNI, lis_.getVNInfoAllocator());
 607   return VNI;
 608 }
 609
 610 /// Insert a COPY instruction curli -> li. Allocate a new value from li
 611 /// defined by the COPY. Note that rewrite() will deal with the curli
 612 /// register, so this function can be used to copy from any interval - openli,
 613 /// curli, or dupli.
 614 VNInfo *SplitEditor::insertCopy(LiveInterval &LI,
 615                                 MachineBasicBlock &MBB,
 616                                 MachineBasicBlock::iterator I) {
 617   MachineInstr *MI = BuildMI(MBB, I, DebugLoc(), tii_.get(TargetOpcode::COPY),
 618                              LI.reg).addReg(curli_->reg);
 619   SlotIndex DefIdx = lis_.InsertMachineInstrInMaps(MI).getDefIndex();
 620   return LI.getNextValue(DefIdx, MI, true, lis_.getVNInfoAllocator());
 621 }
 622
 623 /// Create a new virtual register and live interval.
 624 void SplitEditor::openIntv() {
 625   assert(!openli_ && "Previous LI not closed before openIntv");
 626   openli_ = createInterval();
 627   intervals_.push_back(openli_);
 628   liveThrough_ = false;
 629 }
 630
 631 /// enterIntvBefore - Enter openli before the instruction at Idx. If curli is
 632 /// not live before Idx, a COPY is not inserted.
 633 void SplitEditor::enterIntvBefore(SlotIndex Idx) {
 634   assert(openli_ && "openIntv not called before enterIntvBefore");
 635
 636   // Copy from curli_ if it is live.
 637   if (VNInfo *CurVNI = curli_->getVNInfoAt(Idx.getUseIndex())) {
 638     MachineInstr *MI = lis_.getInstructionFromIndex(Idx);
 639     assert(MI && "enterIntvBefore called with invalid index");
 640     VNInfo *VNI = insertCopy(*openli_, *MI->getParent(), MI);
 641     openli_->addRange(LiveRange(VNI->def, Idx.getDefIndex(), VNI));
 642
 643     // Make sure CurVNI is properly mapped.
 644     VNInfo *&mapVNI = valueMap_[CurVNI];
 645     // We dont have SSA update yet, so only one entry per value is allowed.
 646     assert(!mapVNI && "enterIntvBefore called more than once for the same value");
 647     mapVNI = VNI;
 648   }
 649   DEBUG(dbgs() << "    enterIntvBefore " << Idx << ": " << *openli_ << '\n');
 650 }
 651
 652 /// enterIntvAtEnd - Enter openli at the end of MBB.
 653 /// PhiMBB is a successor inside openli where a PHI value is created.
 654 /// Currently, all entries must share the same PhiMBB.
 655 void SplitEditor::enterIntvAtEnd(MachineBasicBlock &A, MachineBasicBlock &B) {
 656   assert(openli_ && "openIntv not called before enterIntvAtEnd");
 657
 658   SlotIndex EndA = lis_.getMBBEndIdx(&A);
 659   VNInfo *CurVNIA = curli_->getVNInfoAt(EndA.getPrevIndex());
 660   if (!CurVNIA) {
 661     DEBUG(dbgs() << "    enterIntvAtEnd, curli not live out of BB#"
 662                  << A.getNumber() << ".\n");
 663     return;
 664   }
 665
 666   // Add a phi kill value and live range out of A.
 667   VNInfo *VNIA = insertCopy(*openli_, A, A.getFirstTerminator());
 668   openli_->addRange(LiveRange(VNIA->def, EndA, VNIA));
 669
 670   // FIXME: If this is the only entry edge, we don't need the extra PHI value.
 671   // FIXME: If there are multiple entry blocks (so not a loop), we need proper
 672   // SSA update.
 673
 674   // Now look at the start of B.
 675   SlotIndex StartB = lis_.getMBBStartIdx(&B);
 676   SlotIndex EndB = lis_.getMBBEndIdx(&B);
 677   const LiveRange *CurB = curli_->getLiveRangeContaining(StartB);
 678   if (!CurB) {
 679     DEBUG(dbgs() << "    enterIntvAtEnd: curli not live in to BB#"
 680                  << B.getNumber() << ".\n");
 681     return;
 682   }
 683
 684   VNInfo *VNIB = openli_->getVNInfoAt(StartB);
 685   if (!VNIB) {
 686     // Create a phi value.
 687     VNIB = openli_->getNextValue(SlotIndex(StartB, true), 0, false,
 688                                  lis_.getVNInfoAllocator());
 689     VNIB->setIsPHIDef(true);
 690     VNInfo *&mapVNI = valueMap_[CurB->valno];
 691     if (mapVNI) {
 692       // Multiple copies - must create PHI value.
 693       abort();
 694     } else {
 695       // This is the first copy of dupLR. Mark the mapping.
 696       mapVNI = VNIB;
 697     }
 698
 699   }
 700
 701   DEBUG(dbgs() << "    enterIntvAtEnd: " << *openli_ << '\n');
 702 }
 703
 704 /// useIntv - indicate that all instructions in MBB should use openli.
 705 void SplitEditor::useIntv(const MachineBasicBlock &MBB) {
 706   useIntv(lis_.getMBBStartIdx(&MBB), lis_.getMBBEndIdx(&MBB));
 707 }
 708
 709 void SplitEditor::useIntv(SlotIndex Start, SlotIndex End) {
 710   assert(openli_ && "openIntv not called before useIntv");
 711
 712   // Map the curli values from the interval into openli_
 713   LiveInterval::const_iterator B = curli_->begin(), E = curli_->end();
 714   LiveInterval::const_iterator I = std::lower_bound(B, E, Start);
 715
 716   if (I != B) {
 717     --I;
 718     // I begins before Start, but overlaps.
 719     if (I->end > Start)
 720       openli_->addRange(LiveRange(Start, std::min(End, I->end),
 721                         mapValue(I->valno)));
 722     ++I;
 723   }
 724
 725   // The remaining ranges begin after Start.
 726   for (;I != E && I->start < End; ++I)
 727     openli_->addRange(LiveRange(I->start, std::min(End, I->end),
 728                                 mapValue(I->valno)));
 729   DEBUG(dbgs() << "    use [" << Start << ';' << End << "): " << *openli_
 730                << '\n');
 731 }
 732
 733 /// leaveIntvAfter - Leave openli after the instruction at Idx.
 734 void SplitEditor::leaveIntvAfter(SlotIndex Idx) {
 735   assert(openli_ && "openIntv not called before leaveIntvAfter");
 736
 737   const LiveRange *CurLR = curli_->getLiveRangeContaining(Idx.getDefIndex());
 738   if (!CurLR || CurLR->end <= Idx.getBoundaryIndex()) {
 739     DEBUG(dbgs() << "    leaveIntvAfter " << Idx << ": not live\n");
 740     return;
 741   }
 742
 743   // Was this value of curli live through openli?
 744   if (!openli_->liveAt(CurLR->valno->def)) {
 745     DEBUG(dbgs() << "    leaveIntvAfter " << Idx << ": using external value\n");
 746     liveThrough_ = true;
 747     return;
 748   }
 749
 750   // We are going to insert a back copy, so we must have a dupli_.
 751   LiveRange *DupLR = getDupLI()->getLiveRangeContaining(Idx.getDefIndex());
 752   assert(DupLR && "dupli not live into black, but curli is?");
 753
 754   // Insert the COPY instruction.
 755   MachineBasicBlock::iterator I = lis_.getInstructionFromIndex(Idx);
 756   MachineInstr *MI = BuildMI(*I->getParent(), llvm::next(I), I->getDebugLoc(),
 757                              tii_.get(TargetOpcode::COPY), dupli_->reg)
 758                        .addReg(openli_->reg);
 759   SlotIndex CopyIdx = lis_.InsertMachineInstrInMaps(MI).getDefIndex();
 760   openli_->addRange(LiveRange(Idx.getDefIndex(), CopyIdx,
 761                     mapValue(CurLR->valno)));
 762   DupLR->valno->def = CopyIdx;
 763   DEBUG(dbgs() << "    leaveIntvAfter " << Idx << ": " << *openli_ << '\n');
 764 }
 765
 766 /// leaveIntvAtTop - Leave the interval at the top of MBB.
 767 /// Currently, only one value can leave the interval.
 768 void SplitEditor::leaveIntvAtTop(MachineBasicBlock &MBB) {
 769   assert(openli_ && "openIntv not called before leaveIntvAtTop");
 770
 771   SlotIndex Start = lis_.getMBBStartIdx(&MBB);
 772   const LiveRange *CurLR = curli_->getLiveRangeContaining(Start);
 773
 774   // Is curli even live-in to MBB?
 775   if (!CurLR) {
 776     DEBUG(dbgs() << "    leaveIntvAtTop at " << Start << ": not live\n");
 777     return;
 778   }
 779
 780   // Is curli defined by PHI at the beginning of MBB?
 781   bool isPHIDef = CurLR->valno->isPHIDef() &&
 782                   CurLR->valno->def.getBaseIndex() == Start;
 783
 784   // If MBB is using a value of curli that was defined outside the openli range,
 785   // we don't want to copy it back here.
 786   if (!isPHIDef && !openli_->liveAt(CurLR->valno->def)) {
 787     DEBUG(dbgs() << "    leaveIntvAtTop at " << Start
 788                  << ": using external value\n");
 789     liveThrough_ = true;
 790     return;
 791   }
 792
 793   // We are going to insert a back copy, so we must have a dupli_.
 794   LiveRange *DupLR = getDupLI()->getLiveRangeContaining(Start);
 795   assert(DupLR && "dupli not live into black, but curli is?");
 796
 797   // Insert the COPY instruction.
 798   MachineInstr *MI = BuildMI(MBB, MBB.begin(), DebugLoc(),
 799                              tii_.get(TargetOpcode::COPY), dupli_->reg)
 800                        .addReg(openli_->reg);
 801   SlotIndex Idx = lis_.InsertMachineInstrInMaps(MI).getDefIndex();
 802
 803   // Adjust dupli and openli values.
 804   if (isPHIDef) {
 805     // dupli was already a PHI on entry to MBB. Simply insert an openli PHI,
 806     // and shift the dupli def down to the COPY.
 807     VNInfo *VNI = openli_->getNextValue(SlotIndex(Start, true), 0, false,
 808                                         lis_.getVNInfoAllocator());
 809     VNI->setIsPHIDef(true);
 810     openli_->addRange(LiveRange(VNI->def, Idx, VNI));
 811
 812     dupli_->removeRange(Start, Idx);
 813     DupLR->valno->def = Idx;
 814     DupLR->valno->setIsPHIDef(false);
 815   } else {
 816     // The dupli value was defined somewhere inside the openli range.
 817     DEBUG(dbgs() << "    leaveIntvAtTop source value defined at "
 818                  << DupLR->valno->def << "\n");
 819     // FIXME: We may not need a PHI here if all predecessors have the same
 820     // value.
 821     VNInfo *VNI = openli_->getNextValue(SlotIndex(Start, true), 0, false,
 822                                         lis_.getVNInfoAllocator());
 823     VNI->setIsPHIDef(true);
 824     openli_->addRange(LiveRange(VNI->def, Idx, VNI));
 825
 826     // FIXME: What if DupLR->valno is used by multiple exits? SSA Update.
 827
 828     // closeIntv is going to remove the superfluous live ranges.
 829     DupLR->valno->def = Idx;
 830     DupLR->valno->setIsPHIDef(false);
 831   }
 832
 833   DEBUG(dbgs() << "    leaveIntvAtTop at " << Idx << ": " << *openli_ << '\n');
 834 }
 835
 836 /// closeIntv - Indicate that we are done editing the currently open
 837 /// LiveInterval, and ranges can be trimmed.
 838 void SplitEditor::closeIntv() {
 839   assert(openli_ && "openIntv not called before closeIntv");
 840
 841   DEBUG(dbgs() << "    closeIntv cleaning up\n");
 842   DEBUG(dbgs() << "    open " << *openli_ << '\n');
 843
 844   if (liveThrough_) {
 845     DEBUG(dbgs() << "    value live through region, leaving dupli as is.\n");
 846   } else {
 847     // live out with copies inserted, or killed by region. Either way we need to
 848     // remove the overlapping region from dupli.
 849     getDupLI();
 850     for (LiveInterval::iterator I = openli_->begin(), E = openli_->end();
 851          I != E; ++I) {
 852       dupli_->removeRange(I->start, I->end);
 853     }
 854     // FIXME: A block branching to the entry block may also branch elsewhere
 855     // curli is live. We need both openli and curli to be live in that case.
 856     DEBUG(dbgs() << "    dup2 " << *dupli_ << '\n');
 857   }
 858   openli_ = 0;
 859   valueMap_.clear();
 860 }
 861
 862 /// rewrite - after all the new live ranges have been created, rewrite
 863 /// instructions using curli to use the new intervals.
 864 void SplitEditor::rewrite() {
 865   assert(!openli_ && "Previous LI not closed before rewrite");
 866   const LiveInterval *curli = sa_.getCurLI();
 867   for (MachineRegisterInfo::reg_iterator RI = mri_.reg_begin(curli->reg),
 868        RE = mri_.reg_end(); RI != RE;) {
 869     MachineOperand &MO = RI.getOperand();
 870     MachineInstr *MI = MO.getParent();
 871     ++RI;
 872     if (MI->isDebugValue()) {
 873       DEBUG(dbgs() << "Zapping " << *MI);
 874       // FIXME: We can do much better with debug values.
 875       MO.setReg(0);
 876       continue;
 877     }
 878     SlotIndex Idx = lis_.getInstructionIndex(MI);
 879     Idx = MO.isUse() ? Idx.getUseIndex() : Idx.getDefIndex();
 880     LiveInterval *LI = dupli_;
 881     for (unsigned i = firstInterval, e = intervals_.size(); i != e; ++i) {
 882       LiveInterval *testli = intervals_[i];
 883       if (testli->liveAt(Idx)) {
 884         LI = testli;
 885         break;
 886       }
 887     }
 888     if (LI) {
 889       MO.setReg(LI->reg);
 890       sa_.removeUse(MI);
 891       DEBUG(dbgs() << "  rewrite " << Idx << '\t' << *MI);
 892     }
 893   }
 894
 895   // dupli_ goes in last, after rewriting.
 896   if (dupli_) {
 897     if (dupli_->empty()) {
 898       DEBUG(dbgs() << "  dupli became empty?\n");
 899       lis_.removeInterval(dupli_->reg);
 900       dupli_ = 0;
 901     } else {
 902       dupli_->RenumberValues(lis_);
 903       intervals_.push_back(dupli_);
 904     }
 905   }
 906
 907   // Calculate spill weight and allocation hints for new intervals.
 908   VirtRegAuxInfo vrai(vrm_.getMachineFunction(), lis_, sa_.loops_);
 909   for (unsigned i = firstInterval, e = intervals_.size(); i != e; ++i) {
 910     LiveInterval &li = *intervals_[i];
 911     vrai.CalculateRegClass(li.reg);
 912     vrai.CalculateWeightAndHint(li);
 913     DEBUG(dbgs() << "  new interval " << mri_.getRegClass(li.reg)->getName()
 914                  << ":" << li << '\n');
 915   }
 916 }
 917
 918
 919 //===----------------------------------------------------------------------===//
 920 //                               Loop Splitting
 921 //===----------------------------------------------------------------------===//
 922
 923 bool SplitEditor::splitAroundLoop(const MachineLoop *Loop) {
 924   SplitAnalysis::LoopBlocks Blocks;
 925   sa_.getLoopBlocks(Loop, Blocks);
 926
 927   // Break critical edges as needed.
 928   SplitAnalysis::BlockPtrSet CriticalExits;
 929   sa_.getCriticalExits(Blocks, CriticalExits);
 930   assert(CriticalExits.empty() && "Cannot break critical exits yet");
 931
 932   // Create new live interval for the loop.
 933   openIntv();
 934
 935   // Insert copies in the predecessors.
 936   for (SplitAnalysis::BlockPtrSet::iterator I = Blocks.Preds.begin(),
 937        E = Blocks.Preds.end(); I != E; ++I) {
 938     MachineBasicBlock &MBB = const_cast<MachineBasicBlock&>(**I);
 939     enterIntvAtEnd(MBB, *Loop->getHeader());
 940   }
 941
 942   // Switch all loop blocks.
 943   for (SplitAnalysis::BlockPtrSet::iterator I = Blocks.Loop.begin(),
 944        E = Blocks.Loop.end(); I != E; ++I)
 945      useIntv(**I);
 946
 947   // Insert back copies in the exit blocks.
 948   for (SplitAnalysis::BlockPtrSet::iterator I = Blocks.Exits.begin(),
 949        E = Blocks.Exits.end(); I != E; ++I) {
 950     MachineBasicBlock &MBB = const_cast<MachineBasicBlock&>(**I);
 951     leaveIntvAtTop(MBB);
 952   }
 953
 954   // Done.
 955   closeIntv();
 956   rewrite();
 957   return dupli_;
 958 }
 959
 960
 961 //===----------------------------------------------------------------------===//
 962 //                            Single Block Splitting
 963 //===----------------------------------------------------------------------===//
 964
 965 /// splitSingleBlocks - Split curli into a separate live interval inside each
 966 /// basic block in Blocks. Return true if curli has been completely replaced,
 967 /// false if curli is still intact, and needs to be spilled or split further.
 968 bool SplitEditor::splitSingleBlocks(const SplitAnalysis::BlockPtrSet &Blocks) {
 969   DEBUG(dbgs() << "  splitSingleBlocks for " << Blocks.size() << " blocks.\n");
 970   // Determine the first and last instruction using curli in each block.
 971   typedef std::pair<SlotIndex,SlotIndex> IndexPair;
 972   typedef DenseMap<const MachineBasicBlock*,IndexPair> IndexPairMap;
 973   IndexPairMap MBBRange;
 974   for (SplitAnalysis::InstrPtrSet::const_iterator I = sa_.usingInstrs_.begin(),
 975        E = sa_.usingInstrs_.end(); I != E; ++I) {
 976     const MachineBasicBlock *MBB = (*I)->getParent();
 977     if (!Blocks.count(MBB))
 978       continue;
 979     SlotIndex Idx = lis_.getInstructionIndex(*I);
 980     DEBUG(dbgs() << "  BB#" << MBB->getNumber() << '\t' << Idx << '\t' << **I);
 981     IndexPair &IP = MBBRange[MBB];
 982     if (!IP.first.isValid() || Idx < IP.first)
 983       IP.first = Idx;
 984     if (!IP.second.isValid() || Idx > IP.second)
 985       IP.second = Idx;
 986   }
 987
 988   // Create a new interval for each block.
 989   for (SplitAnalysis::BlockPtrSet::const_iterator I = Blocks.begin(),
 990        E = Blocks.end(); I != E; ++I) {
 991     IndexPair &IP = MBBRange[*I];
 992     DEBUG(dbgs() << "  splitting for BB#" << (*I)->getNumber() << ": ["
 993                  << IP.first << ';' << IP.second << ")\n");
 994     assert(IP.first.isValid() && IP.second.isValid());
 995
 996     openIntv();
 997     enterIntvBefore(IP.first);
 998     useIntv(IP.first.getBaseIndex(), IP.second.getBoundaryIndex());
 999     leaveIntvAfter(IP.second);
1000     closeIntv();
1001   }
1002   rewrite();
1003   return dupli_;
1004 }
1005
1006
1007 //===----------------------------------------------------------------------===//
1008 //                            Sub Block Splitting
1009 //===----------------------------------------------------------------------===//
1010
1011 /// getBlockForInsideSplit - If curli is contained inside a single basic block,
1012 /// and it wou pay to subdivide the interval inside that block, return it.
1013 /// Otherwise return NULL. The returned block can be passed to
1014 /// SplitEditor::splitInsideBlock.
1015 const MachineBasicBlock *SplitAnalysis::getBlockForInsideSplit() {
1016   // The interval must be exclusive to one block.
1017   if (usingBlocks_.size() != 1)
1018     return 0;
1019   // Don't to this for less than 4 instructions. We want to be sure that
1020   // splitting actually reduces the instruction count per interval.
1021   if (usingInstrs_.size() < 4)
1022     return 0;
1023   return usingBlocks_.begin()->first;
1024 }
1025
1026 /// splitInsideBlock - Split curli into multiple intervals inside MBB. Return
1027 /// true if curli has been completely replaced, false if curli is still
1028 /// intact, and needs to be spilled or split further.
1029 bool SplitEditor::splitInsideBlock(const MachineBasicBlock *MBB) {
1030   SmallVector<SlotIndex, 32> Uses;
1031   Uses.reserve(sa_.usingInstrs_.size());
1032   for (SplitAnalysis::InstrPtrSet::const_iterator I = sa_.usingInstrs_.begin(),
1033        E = sa_.usingInstrs_.end(); I != E; ++I)
1034     if ((*I)->getParent() == MBB)
1035       Uses.push_back(lis_.getInstructionIndex(*I));
1036   DEBUG(dbgs() << "  splitInsideBlock BB#" << MBB->getNumber() << " for "
1037                << Uses.size() << " instructions.\n");
1038   assert(Uses.size() >= 3 && "Need at least 3 instructions");
1039   array_pod_sort(Uses.begin(), Uses.end());
1040
1041   // Simple algorithm: Find the largest gap between uses as determined by slot
1042   // indices. Create new intervals for instructions before the gap and after the
1043   // gap.
1044   unsigned bestPos = 0;
1045   int bestGap = 0;
1046   DEBUG(dbgs() << "    dist (" << Uses[0]);
1047   for (unsigned i = 1, e = Uses.size(); i != e; ++i) {
1048     int g = Uses[i-1].distance(Uses[i]);
1049     DEBUG(dbgs() << ") -" << g << "- (" << Uses[i]);
1050     if (g > bestGap)
1051       bestPos = i, bestGap = g;
1052   }
1053   DEBUG(dbgs() << "), best: -" << bestGap << "-\n");
1054
1055   // bestPos points to the first use after the best gap.
1056   assert(bestPos > 0 && "Invalid gap");
1057
1058   // FIXME: Don't create intervals for low densities.
1059
1060   // First interval before the gap. Don't create single-instr intervals.
1061   if (bestPos > 1) {
1062     openIntv();
1063     enterIntvBefore(Uses.front());
1064     useIntv(Uses.front().getBaseIndex(), Uses[bestPos-1].getBoundaryIndex());
1065     leaveIntvAfter(Uses[bestPos-1]);
1066     closeIntv();
1067   }
1068
1069   // Second interval after the gap.
1070   if (bestPos < Uses.size()-1) {
1071     openIntv();
1072     enterIntvBefore(Uses[bestPos]);
1073     useIntv(Uses[bestPos].getBaseIndex(), Uses.back().getBoundaryIndex());
1074     leaveIntvAfter(Uses.back());
1075     closeIntv();
1076   }
1077
1078   rewrite();
1079   return dupli_;
1080 }