lib/Analysis/BlockFrequencyInfoImpl.cpp

   1 //===- BlockFrequencyImplInfo.cpp - Block Frequency Info Implementation ---===//
   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 // Loops should be simplified before this analysis.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Analysis/BlockFrequencyInfoImpl.h"
  15 #include "llvm/ADT/SCCIterator.h"
  16 #include "llvm/Support/raw_ostream.h"
  17 #include <numeric>
  18
  19 using namespace llvm;
  20 using namespace llvm::bfi_detail;
  21
  22 #define DEBUG_TYPE "block-freq"
  23
  24 ScaledNumber<uint64_t> BlockMass::toScaled() const {
  25   if (isFull())
  26     return ScaledNumber<uint64_t>(1, 0);
  27   return ScaledNumber<uint64_t>(getMass() + 1, -64);
  28 }
  29
  30 void BlockMass::dump() const { print(dbgs()); }
  31
  32 static char getHexDigit(int N) {
  33   assert(N < 16);
  34   if (N < 10)
  35     return '0' + N;
  36   return 'a' + N - 10;
  37 }
  38 raw_ostream &BlockMass::print(raw_ostream &OS) const {
  39   for (int Digits = 0; Digits < 16; ++Digits)
  40     OS << getHexDigit(Mass >> (60 - Digits * 4) & 0xf);
  41   return OS;
  42 }
  43
  44 namespace {
  45
  46 typedef BlockFrequencyInfoImplBase::BlockNode BlockNode;
  47 typedef BlockFrequencyInfoImplBase::Distribution Distribution;
  48 typedef BlockFrequencyInfoImplBase::Distribution::WeightList WeightList;
  49 typedef BlockFrequencyInfoImplBase::Scaled64 Scaled64;
  50 typedef BlockFrequencyInfoImplBase::LoopData LoopData;
  51 typedef BlockFrequencyInfoImplBase::Weight Weight;
  52 typedef BlockFrequencyInfoImplBase::FrequencyData FrequencyData;
  53
  54 /// \brief Dithering mass distributer.
  55 ///
  56 /// This class splits up a single mass into portions by weight, dithering to
  57 /// spread out error.  No mass is lost.  The dithering precision depends on the
  58 /// precision of the product of \a BlockMass and \a BranchProbability.
  59 ///
  60 /// The distribution algorithm follows.
  61 ///
  62 ///  1. Initialize by saving the sum of the weights in \a RemWeight and the
  63 ///     mass to distribute in \a RemMass.
  64 ///
  65 ///  2. For each portion:
  66 ///
  67 ///      1. Construct a branch probability, P, as the portion's weight divided
  68 ///         by the current value of \a RemWeight.
  69 ///      2. Calculate the portion's mass as \a RemMass times P.
  70 ///      3. Update \a RemWeight and \a RemMass at each portion by subtracting
  71 ///         the current portion's weight and mass.
  72 struct DitheringDistributer {
  73   uint32_t RemWeight;
  74   BlockMass RemMass;
  75
  76   DitheringDistributer(Distribution &Dist, const BlockMass &Mass);
  77
  78   BlockMass takeMass(uint32_t Weight);
  79 };
  80
  81 } // end namespace
  82
  83 DitheringDistributer::DitheringDistributer(Distribution &Dist,
  84                                            const BlockMass &Mass) {
  85   Dist.normalize();
  86   RemWeight = Dist.Total;
  87   RemMass = Mass;
  88 }
  89
  90 BlockMass DitheringDistributer::takeMass(uint32_t Weight) {
  91   assert(Weight && "invalid weight");
  92   assert(Weight <= RemWeight);
  93   BlockMass Mass = RemMass * BranchProbability(Weight, RemWeight);
  94
  95   // Decrement totals (dither).
  96   RemWeight -= Weight;
  97   RemMass -= Mass;
  98   return Mass;
  99 }
 100
 101 void Distribution::add(const BlockNode &Node, uint64_t Amount,
 102                        Weight::DistType Type) {
 103   assert(Amount && "invalid weight of 0");
 104   uint64_t NewTotal = Total + Amount;
 105
 106   // Check for overflow.  It should be impossible to overflow twice.
 107   bool IsOverflow = NewTotal < Total;
 108   assert(!(DidOverflow && IsOverflow) && "unexpected repeated overflow");
 109   DidOverflow |= IsOverflow;
 110
 111   // Update the total.
 112   Total = NewTotal;
 113
 114   // Save the weight.
 115   Weights.push_back(Weight(Type, Node, Amount));
 116 }
 117
 118 static void combineWeight(Weight &W, const Weight &OtherW) {
 119   assert(OtherW.TargetNode.isValid());
 120   if (!W.Amount) {
 121     W = OtherW;
 122     return;
 123   }
 124   assert(W.Type == OtherW.Type);
 125   assert(W.TargetNode == OtherW.TargetNode);
 126   assert(OtherW.Amount && "Expected non-zero weight");
 127   if (W.Amount > W.Amount + OtherW.Amount)
 128     // Saturate on overflow.
 129     W.Amount = UINT64_MAX;
 130   else
 131     W.Amount += OtherW.Amount;
 132 }
 133 static void combineWeightsBySorting(WeightList &Weights) {
 134   // Sort so edges to the same node are adjacent.
 135   std::sort(Weights.begin(), Weights.end(),
 136             [](const Weight &L,
 137                const Weight &R) { return L.TargetNode < R.TargetNode; });
 138
 139   // Combine adjacent edges.
 140   WeightList::iterator O = Weights.begin();
 141   for (WeightList::const_iterator I = O, L = O, E = Weights.end(); I != E;
 142        ++O, (I = L)) {
 143     *O = *I;
 144
 145     // Find the adjacent weights to the same node.
 146     for (++L; L != E && I->TargetNode == L->TargetNode; ++L)
 147       combineWeight(*O, *L);
 148   }
 149
 150   // Erase extra entries.
 151   Weights.erase(O, Weights.end());
 152   return;
 153 }
 154 static void combineWeightsByHashing(WeightList &Weights) {
 155   // Collect weights into a DenseMap.
 156   typedef DenseMap<BlockNode::IndexType, Weight> HashTable;
 157   HashTable Combined(NextPowerOf2(2 * Weights.size()));
 158   for (const Weight &W : Weights)
 159     combineWeight(Combined[W.TargetNode.Index], W);
 160
 161   // Check whether anything changed.
 162   if (Weights.size() == Combined.size())
 163     return;
 164
 165   // Fill in the new weights.
 166   Weights.clear();
 167   Weights.reserve(Combined.size());
 168   for (const auto &I : Combined)
 169     Weights.push_back(I.second);
 170 }
 171 static void combineWeights(WeightList &Weights) {
 172   // Use a hash table for many successors to keep this linear.
 173   if (Weights.size() > 128) {
 174     combineWeightsByHashing(Weights);
 175     return;
 176   }
 177
 178   combineWeightsBySorting(Weights);
 179 }
 180 static uint64_t shiftRightAndRound(uint64_t N, int Shift) {
 181   assert(Shift >= 0);
 182   assert(Shift < 64);
 183   if (!Shift)
 184     return N;
 185   return (N >> Shift) + (UINT64_C(1) & N >> (Shift - 1));
 186 }
 187 void Distribution::normalize() {
 188   // Early exit for termination nodes.
 189   if (Weights.empty())
 190     return;
 191
 192   // Only bother if there are multiple successors.
 193   if (Weights.size() > 1)
 194     combineWeights(Weights);
 195
 196   // Early exit when combined into a single successor.
 197   if (Weights.size() == 1) {
 198     Total = 1;
 199     Weights.front().Amount = 1;
 200     return;
 201   }
 202
 203   // Determine how much to shift right so that the total fits into 32-bits.
 204   //
 205   // If we shift at all, shift by 1 extra.  Otherwise, the lower limit of 1
 206   // for each weight can cause a 32-bit overflow.
 207   int Shift = 0;
 208   if (DidOverflow)
 209     Shift = 33;
 210   else if (Total > UINT32_MAX)
 211     Shift = 33 - countLeadingZeros(Total);
 212
 213   // Early exit if nothing needs to be scaled.
 214   if (!Shift) {
 215     // If we didn't overflow then combineWeights() shouldn't have changed the
 216     // sum of the weights, but let's double-check.
 217     assert(Total == std::accumulate(Weights.begin(), Weights.end(), UINT64_C(0),
 218                                     [](uint64_t Sum, const Weight &W) {
 219                       return Sum + W.Amount;
 220                     }) &&
 221            "Expected total to be correct");
 222     return;
 223   }
 224
 225   // Recompute the total through accumulation (rather than shifting it) so that
 226   // it's accurate after shifting and any changes combineWeights() made above.
 227   Total = 0;
 228
 229   // Sum the weights to each node and shift right if necessary.
 230   for (Weight &W : Weights) {
 231     // Scale down below UINT32_MAX.  Since Shift is larger than necessary, we
 232     // can round here without concern about overflow.
 233     assert(W.TargetNode.isValid());
 234     W.Amount = std::max(UINT64_C(1), shiftRightAndRound(W.Amount, Shift));
 235     assert(W.Amount <= UINT32_MAX);
 236
 237     // Update the total.
 238     Total += W.Amount;
 239   }
 240   assert(Total <= UINT32_MAX);
 241 }
 242
 243 void BlockFrequencyInfoImplBase::clear() {
 244   // Swap with a default-constructed std::vector, since std::vector<>::clear()
 245   // does not actually clear heap storage.
 246   std::vector<FrequencyData>().swap(Freqs);
 247   std::vector<WorkingData>().swap(Working);
 248   Loops.clear();
 249 }
 250
 251 /// \brief Clear all memory not needed downstream.
 252 ///
 253 /// Releases all memory not used downstream.  In particular, saves Freqs.
 254 static void cleanup(BlockFrequencyInfoImplBase &BFI) {
 255   std::vector<FrequencyData> SavedFreqs(std::move(BFI.Freqs));
 256   BFI.clear();
 257   BFI.Freqs = std::move(SavedFreqs);
 258 }
 259
 260 bool BlockFrequencyInfoImplBase::addToDist(Distribution &Dist,
 261                                            const LoopData *OuterLoop,
 262                                            const BlockNode &Pred,
 263                                            const BlockNode &Succ,
 264                                            uint64_t Weight) {
 265   if (!Weight)
 266     Weight = 1;
 267
 268   auto isLoopHeader = [&OuterLoop](const BlockNode &Node) {
 269     return OuterLoop && OuterLoop->isHeader(Node);
 270   };
 271
 272   BlockNode Resolved = Working[Succ.Index].getResolvedNode();
 273
 274 #ifndef NDEBUG
 275   auto debugSuccessor = [&](const char *Type) {
 276     dbgs() << "  =>"
 277            << " [" << Type << "] weight = " << Weight;
 278     if (!isLoopHeader(Resolved))
 279       dbgs() << ", succ = " << getBlockName(Succ);
 280     if (Resolved != Succ)
 281       dbgs() << ", resolved = " << getBlockName(Resolved);
 282     dbgs() << "\n";
 283   };
 284   (void)debugSuccessor;
 285 #endif
 286
 287   if (isLoopHeader(Resolved)) {
 288     DEBUG(debugSuccessor("backedge"));
 289     Dist.addBackedge(Resolved, Weight);
 290     return true;
 291   }
 292
 293   if (Working[Resolved.Index].getContainingLoop() != OuterLoop) {
 294     DEBUG(debugSuccessor("  exit  "));
 295     Dist.addExit(Resolved, Weight);
 296     return true;
 297   }
 298
 299   if (Resolved < Pred) {
 300     if (!isLoopHeader(Pred)) {
 301       // If OuterLoop is an irreducible loop, we can't actually handle this.
 302       assert((!OuterLoop || !OuterLoop->isIrreducible()) &&
 303              "unhandled irreducible control flow");
 304
 305       // Irreducible backedge.  Abort.
 306       DEBUG(debugSuccessor("abort!!!"));
 307       return false;
 308     }
 309
 310     // If "Pred" is a loop header, then this isn't really a backedge; rather,
 311     // OuterLoop must be irreducible.  These false backedges can come only from
 312     // secondary loop headers.
 313     assert(OuterLoop && OuterLoop->isIrreducible() && !isLoopHeader(Resolved) &&
 314            "unhandled irreducible control flow");
 315   }
 316
 317   DEBUG(debugSuccessor(" local  "));
 318   Dist.addLocal(Resolved, Weight);
 319   return true;
 320 }
 321
 322 bool BlockFrequencyInfoImplBase::addLoopSuccessorsToDist(
 323     const LoopData *OuterLoop, LoopData &Loop, Distribution &Dist) {
 324   // Copy the exit map into Dist.
 325   for (const auto &I : Loop.Exits)
 326     if (!addToDist(Dist, OuterLoop, Loop.getHeader(), I.first,
 327                    I.second.getMass()))
 328       // Irreducible backedge.
 329       return false;
 330
 331   return true;
 332 }
 333
 334 /// \brief Compute the loop scale for a loop.
 335 void BlockFrequencyInfoImplBase::computeLoopScale(LoopData &Loop) {
 336   // Compute loop scale.
 337   DEBUG(dbgs() << "compute-loop-scale: " << getLoopName(Loop) << "\n");
 338
 339   // Infinite loops need special handling. If we give the back edge an infinite
 340   // mass, they may saturate all the other scales in the function down to 1,
 341   // making all the other region temperatures look exactly the same. Choose an
 342   // arbitrary scale to avoid these issues.
 343   //
 344   // FIXME: An alternate way would be to select a symbolic scale which is later
 345   // replaced to be the maximum of all computed scales plus 1. This would
 346   // appropriately describe the loop as having a large scale, without skewing
 347   // the final frequency computation.
 348   const Scaled64 InifiniteLoopScale(1, 12);
 349
 350   // LoopScale == 1 / ExitMass
 351   // ExitMass == HeadMass - BackedgeMass
 352   BlockMass TotalBackedgeMass;
 353   for (auto &Mass : Loop.BackedgeMass)
 354     TotalBackedgeMass += Mass;
 355   BlockMass ExitMass = BlockMass::getFull() - TotalBackedgeMass;
 356
 357   // Block scale stores the inverse of the scale. If this is an infinite loop,
 358   // its exit mass will be zero. In this case, use an arbitrary scale for the
 359   // loop scale.
 360   Loop.Scale =
 361       ExitMass.isEmpty() ? InifiniteLoopScale : ExitMass.toScaled().inverse();
 362
 363   DEBUG(dbgs() << " - exit-mass = " << ExitMass << " (" << BlockMass::getFull()
 364                << " - " << TotalBackedgeMass << ")\n"
 365                << " - scale = " << Loop.Scale << "\n");
 366 }
 367
 368 /// \brief Package up a loop.
 369 void BlockFrequencyInfoImplBase::packageLoop(LoopData &Loop) {
 370   DEBUG(dbgs() << "packaging-loop: " << getLoopName(Loop) << "\n");
 371
 372   // Clear the subloop exits to prevent quadratic memory usage.
 373   for (const BlockNode &M : Loop.Nodes) {
 374     if (auto *Loop = Working[M.Index].getPackagedLoop())
 375       Loop->Exits.clear();
 376     DEBUG(dbgs() << " - node: " << getBlockName(M.Index) << "\n");
 377   }
 378   Loop.IsPackaged = true;
 379 }
 380
 381 #ifndef NDEBUG
 382 static void debugAssign(const BlockFrequencyInfoImplBase &BFI,
 383                         const DitheringDistributer &D, const BlockNode &T,
 384                         const BlockMass &M, const char *Desc) {
 385   dbgs() << "  => assign " << M << " (" << D.RemMass << ")";
 386   if (Desc)
 387     dbgs() << " [" << Desc << "]";
 388   if (T.isValid())
 389     dbgs() << " to " << BFI.getBlockName(T);
 390   dbgs() << "\n";
 391 }
 392 #endif
 393
 394 void BlockFrequencyInfoImplBase::distributeMass(const BlockNode &Source,
 395                                                 LoopData *OuterLoop,
 396                                                 Distribution &Dist) {
 397   BlockMass Mass = Working[Source.Index].getMass();
 398   DEBUG(dbgs() << "  => mass:  " << Mass << "\n");
 399
 400   // Distribute mass to successors as laid out in Dist.
 401   DitheringDistributer D(Dist, Mass);
 402
 403   for (const Weight &W : Dist.Weights) {
 404     // Check for a local edge (non-backedge and non-exit).
 405     BlockMass Taken = D.takeMass(W.Amount);
 406     if (W.Type == Weight::Local) {
 407       Working[W.TargetNode.Index].getMass() += Taken;
 408       DEBUG(debugAssign(*this, D, W.TargetNode, Taken, nullptr));
 409       continue;
 410     }
 411
 412     // Backedges and exits only make sense if we're processing a loop.
 413     assert(OuterLoop && "backedge or exit outside of loop");
 414
 415     // Check for a backedge.
 416     if (W.Type == Weight::Backedge) {
 417       auto ix = OuterLoop->headerIndexFor(W.TargetNode);
 418       OuterLoop->BackedgeMass[ix] += Taken;
 419       DEBUG(debugAssign(*this, D, W.TargetNode, Taken, "back"));
 420       continue;
 421     }
 422
 423     // This must be an exit.
 424     assert(W.Type == Weight::Exit);
 425     OuterLoop->Exits.push_back(std::make_pair(W.TargetNode, Taken));
 426     DEBUG(debugAssign(*this, D, W.TargetNode, Taken, "exit"));
 427   }
 428 }
 429
 430 static void convertFloatingToInteger(BlockFrequencyInfoImplBase &BFI,
 431                                      const Scaled64 &Min, const Scaled64 &Max) {
 432   // Scale the Factor to a size that creates integers.  Ideally, integers would
 433   // be scaled so that Max == UINT64_MAX so that they can be best
 434   // differentiated.  However, in the presence of large frequency values, small
 435   // frequencies are scaled down to 1, making it impossible to differentiate
 436   // small, unequal numbers. When the spread between Min and Max frequencies
 437   // fits well within MaxBits, we make the scale be at least 8.
 438   const unsigned MaxBits = 64;
 439   const unsigned SpreadBits = (Max / Min).lg();
 440   Scaled64 ScalingFactor;
 441   if (SpreadBits <= MaxBits - 3) {
 442     // If the values are small enough, make the scaling factor at least 8 to
 443     // allow distinguishing small values.
 444     ScalingFactor = Min.inverse();
 445     ScalingFactor <<= 3;
 446   } else {
 447     // If the values need more than MaxBits to be represented, saturate small
 448     // frequency values down to 1 by using a scaling factor that benefits large
 449     // frequency values.
 450     ScalingFactor = Scaled64(1, MaxBits) / Max;
 451   }
 452
 453   // Translate the floats to integers.
 454   DEBUG(dbgs() << "float-to-int: min = " << Min << ", max = " << Max
 455                << ", factor = " << ScalingFactor << "\n");
 456   for (size_t Index = 0; Index < BFI.Freqs.size(); ++Index) {
 457     Scaled64 Scaled = BFI.Freqs[Index].Scaled * ScalingFactor;
 458     BFI.Freqs[Index].Integer = std::max(UINT64_C(1), Scaled.toInt<uint64_t>());
 459     DEBUG(dbgs() << " - " << BFI.getBlockName(Index) << ": float = "
 460                  << BFI.Freqs[Index].Scaled << ", scaled = " << Scaled
 461                  << ", int = " << BFI.Freqs[Index].Integer << "\n");
 462   }
 463 }
 464
 465 /// \brief Unwrap a loop package.
 466 ///
 467 /// Visits all the members of a loop, adjusting their BlockData according to
 468 /// the loop's pseudo-node.
 469 static void unwrapLoop(BlockFrequencyInfoImplBase &BFI, LoopData &Loop) {
 470   DEBUG(dbgs() << "unwrap-loop-package: " << BFI.getLoopName(Loop)
 471                << ": mass = " << Loop.Mass << ", scale = " << Loop.Scale
 472                << "\n");
 473   Loop.Scale *= Loop.Mass.toScaled();
 474   Loop.IsPackaged = false;
 475   DEBUG(dbgs() << "  => combined-scale = " << Loop.Scale << "\n");
 476
 477   // Propagate the head scale through the loop.  Since members are visited in
 478   // RPO, the head scale will be updated by the loop scale first, and then the
 479   // final head scale will be used for updated the rest of the members.
 480   for (const BlockNode &N : Loop.Nodes) {
 481     const auto &Working = BFI.Working[N.Index];
 482     Scaled64 &F = Working.isAPackage() ? Working.getPackagedLoop()->Scale
 483                                        : BFI.Freqs[N.Index].Scaled;
 484     Scaled64 New = Loop.Scale * F;
 485     DEBUG(dbgs() << " - " << BFI.getBlockName(N) << ": " << F << " => " << New
 486                  << "\n");
 487     F = New;
 488   }
 489 }
 490
 491 void BlockFrequencyInfoImplBase::unwrapLoops() {
 492   // Set initial frequencies from loop-local masses.
 493   for (size_t Index = 0; Index < Working.size(); ++Index)
 494     Freqs[Index].Scaled = Working[Index].Mass.toScaled();
 495
 496   for (LoopData &Loop : Loops)
 497     unwrapLoop(*this, Loop);
 498 }
 499
 500 void BlockFrequencyInfoImplBase::finalizeMetrics() {
 501   // Unwrap loop packages in reverse post-order, tracking min and max
 502   // frequencies.
 503   auto Min = Scaled64::getLargest();
 504   auto Max = Scaled64::getZero();
 505   for (size_t Index = 0; Index < Working.size(); ++Index) {
 506     // Update min/max scale.
 507     Min = std::min(Min, Freqs[Index].Scaled);
 508     Max = std::max(Max, Freqs[Index].Scaled);
 509   }
 510
 511   // Convert to integers.
 512   convertFloatingToInteger(*this, Min, Max);
 513
 514   // Clean up data structures.
 515   cleanup(*this);
 516
 517   // Print out the final stats.
 518   DEBUG(dump());
 519 }
 520
 521 BlockFrequency
 522 BlockFrequencyInfoImplBase::getBlockFreq(const BlockNode &Node) const {
 523   if (!Node.isValid())
 524     return 0;
 525   return Freqs[Node.Index].Integer;
 526 }
 527 Scaled64
 528 BlockFrequencyInfoImplBase::getFloatingBlockFreq(const BlockNode &Node) const {
 529   if (!Node.isValid())
 530     return Scaled64::getZero();
 531   return Freqs[Node.Index].Scaled;
 532 }
 533
 534 std::string
 535 BlockFrequencyInfoImplBase::getBlockName(const BlockNode &Node) const {
 536   return std::string();
 537 }
 538 std::string
 539 BlockFrequencyInfoImplBase::getLoopName(const LoopData &Loop) const {
 540   return getBlockName(Loop.getHeader()) + (Loop.isIrreducible() ? "**" : "*");
 541 }
 542
 543 raw_ostream &
 544 BlockFrequencyInfoImplBase::printBlockFreq(raw_ostream &OS,
 545                                            const BlockNode &Node) const {
 546   return OS << getFloatingBlockFreq(Node);
 547 }
 548
 549 raw_ostream &
 550 BlockFrequencyInfoImplBase::printBlockFreq(raw_ostream &OS,
 551                                            const BlockFrequency &Freq) const {
 552   Scaled64 Block(Freq.getFrequency(), 0);
 553   Scaled64 Entry(getEntryFreq(), 0);
 554
 555   return OS << Block / Entry;
 556 }
 557
 558 void IrreducibleGraph::addNodesInLoop(const BFIBase::LoopData &OuterLoop) {
 559   Start = OuterLoop.getHeader();
 560   Nodes.reserve(OuterLoop.Nodes.size());
 561   for (auto N : OuterLoop.Nodes)
 562     addNode(N);
 563   indexNodes();
 564 }
 565 void IrreducibleGraph::addNodesInFunction() {
 566   Start = 0;
 567   for (uint32_t Index = 0; Index < BFI.Working.size(); ++Index)
 568     if (!BFI.Working[Index].isPackaged())
 569       addNode(Index);
 570   indexNodes();
 571 }
 572 void IrreducibleGraph::indexNodes() {
 573   for (auto &I : Nodes)
 574     Lookup[I.Node.Index] = &I;
 575 }
 576 void IrreducibleGraph::addEdge(IrrNode &Irr, const BlockNode &Succ,
 577                                const BFIBase::LoopData *OuterLoop) {
 578   if (OuterLoop && OuterLoop->isHeader(Succ))
 579     return;
 580   auto L = Lookup.find(Succ.Index);
 581   if (L == Lookup.end())
 582     return;
 583   IrrNode &SuccIrr = *L->second;
 584   Irr.Edges.push_back(&SuccIrr);
 585   SuccIrr.Edges.push_front(&Irr);
 586   ++SuccIrr.NumIn;
 587 }
 588
 589 namespace llvm {
 590 template <> struct GraphTraits<IrreducibleGraph> {
 591   typedef bfi_detail::IrreducibleGraph GraphT;
 592
 593   typedef const GraphT::IrrNode NodeType;
 594   typedef GraphT::IrrNode::iterator ChildIteratorType;
 595
 596   static const NodeType *getEntryNode(const GraphT &G) {
 597     return G.StartIrr;
 598   }
 599   static ChildIteratorType child_begin(NodeType *N) { return N->succ_begin(); }
 600   static ChildIteratorType child_end(NodeType *N) { return N->succ_end(); }
 601 };
 602 }
 603
 604 /// \brief Find extra irreducible headers.
 605 ///
 606 /// Find entry blocks and other blocks with backedges, which exist when \c G
 607 /// contains irreducible sub-SCCs.
 608 static void findIrreducibleHeaders(
 609     const BlockFrequencyInfoImplBase &BFI,
 610     const IrreducibleGraph &G,
 611     const std::vector<const IrreducibleGraph::IrrNode *> &SCC,
 612     LoopData::NodeList &Headers, LoopData::NodeList &Others) {
 613   // Map from nodes in the SCC to whether it's an entry block.
 614   SmallDenseMap<const IrreducibleGraph::IrrNode *, bool, 8> InSCC;
 615
 616   // InSCC also acts the set of nodes in the graph.  Seed it.
 617   for (const auto *I : SCC)
 618     InSCC[I] = false;
 619
 620   for (auto I = InSCC.begin(), E = InSCC.end(); I != E; ++I) {
 621     auto &Irr = *I->first;
 622     for (const auto *P : make_range(Irr.pred_begin(), Irr.pred_end())) {
 623       if (InSCC.count(P))
 624         continue;
 625
 626       // This is an entry block.
 627       I->second = true;
 628       Headers.push_back(Irr.Node);
 629       DEBUG(dbgs() << "  => entry = " << BFI.getBlockName(Irr.Node) << "\n");
 630       break;
 631     }
 632   }
 633   assert(Headers.size() >= 2 &&
 634          "Expected irreducible CFG; -loop-info is likely invalid");
 635   if (Headers.size() == InSCC.size()) {
 636     // Every block is a header.
 637     std::sort(Headers.begin(), Headers.end());
 638     return;
 639   }
 640
 641   // Look for extra headers from irreducible sub-SCCs.
 642   for (const auto &I : InSCC) {
 643     // Entry blocks are already headers.
 644     if (I.second)
 645       continue;
 646
 647     auto &Irr = *I.first;
 648     for (const auto *P : make_range(Irr.pred_begin(), Irr.pred_end())) {
 649       // Skip forward edges.
 650       if (P->Node < Irr.Node)
 651         continue;
 652
 653       // Skip predecessors from entry blocks.  These can have inverted
 654       // ordering.
 655       if (InSCC.lookup(P))
 656         continue;
 657
 658       // Store the extra header.
 659       Headers.push_back(Irr.Node);
 660       DEBUG(dbgs() << "  => extra = " << BFI.getBlockName(Irr.Node) << "\n");
 661       break;
 662     }
 663     if (Headers.back() == Irr.Node)
 664       // Added this as a header.
 665       continue;
 666
 667     // This is not a header.
 668     Others.push_back(Irr.Node);
 669     DEBUG(dbgs() << "  => other = " << BFI.getBlockName(Irr.Node) << "\n");
 670   }
 671   std::sort(Headers.begin(), Headers.end());
 672   std::sort(Others.begin(), Others.end());
 673 }
 674
 675 static void createIrreducibleLoop(
 676     BlockFrequencyInfoImplBase &BFI, const IrreducibleGraph &G,
 677     LoopData *OuterLoop, std::list<LoopData>::iterator Insert,
 678     const std::vector<const IrreducibleGraph::IrrNode *> &SCC) {
 679   // Translate the SCC into RPO.
 680   DEBUG(dbgs() << " - found-scc\n");
 681
 682   LoopData::NodeList Headers;
 683   LoopData::NodeList Others;
 684   findIrreducibleHeaders(BFI, G, SCC, Headers, Others);
 685
 686   auto Loop = BFI.Loops.emplace(Insert, OuterLoop, Headers.begin(),
 687                                 Headers.end(), Others.begin(), Others.end());
 688
 689   // Update loop hierarchy.
 690   for (const auto &N : Loop->Nodes)
 691     if (BFI.Working[N.Index].isLoopHeader())
 692       BFI.Working[N.Index].Loop->Parent = &*Loop;
 693     else
 694       BFI.Working[N.Index].Loop = &*Loop;
 695 }
 696
 697 iterator_range<std::list<LoopData>::iterator>
 698 BlockFrequencyInfoImplBase::analyzeIrreducible(
 699     const IrreducibleGraph &G, LoopData *OuterLoop,
 700     std::list<LoopData>::iterator Insert) {
 701   assert((OuterLoop == nullptr) == (Insert == Loops.begin()));
 702   auto Prev = OuterLoop ? std::prev(Insert) : Loops.end();
 703
 704   for (auto I = scc_begin(G); !I.isAtEnd(); ++I) {
 705     if (I->size() < 2)
 706       continue;
 707
 708     // Translate the SCC into RPO.
 709     createIrreducibleLoop(*this, G, OuterLoop, Insert, *I);
 710   }
 711
 712   if (OuterLoop)
 713     return make_range(std::next(Prev), Insert);
 714   return make_range(Loops.begin(), Insert);
 715 }
 716
 717 void
 718 BlockFrequencyInfoImplBase::updateLoopWithIrreducible(LoopData &OuterLoop) {
 719   OuterLoop.Exits.clear();
 720   for (auto &Mass : OuterLoop.BackedgeMass)
 721     Mass = BlockMass::getEmpty();
 722   auto O = OuterLoop.Nodes.begin() + 1;
 723   for (auto I = O, E = OuterLoop.Nodes.end(); I != E; ++I)
 724     if (!Working[I->Index].isPackaged())
 725       *O++ = *I;
 726   OuterLoop.Nodes.erase(O, OuterLoop.Nodes.end());
 727 }
 728
 729 void BlockFrequencyInfoImplBase::adjustLoopHeaderMass(LoopData &Loop) {
 730   assert(Loop.isIrreducible() && "this only makes sense on irreducible loops");
 731
 732   // Since the loop has more than one header block, the mass flowing back into
 733   // each header will be different. Adjust the mass in each header loop to
 734   // reflect the masses flowing through back edges.
 735   //
 736   // To do this, we distribute the initial mass using the backedge masses
 737   // as weights for the distribution.
 738   BlockMass LoopMass = BlockMass::getFull();
 739   Distribution Dist;
 740
 741   DEBUG(dbgs() << "adjust-loop-header-mass:\n");
 742   for (uint32_t H = 0; H < Loop.NumHeaders; ++H) {
 743     auto &HeaderNode = Loop.Nodes[H];
 744     auto &BackedgeMass = Loop.BackedgeMass[Loop.headerIndexFor(HeaderNode)];
 745     DEBUG(dbgs() << " - Add back edge mass for node "
 746                  << getBlockName(HeaderNode) << ": " << BackedgeMass << "\n");
 747     Dist.addLocal(HeaderNode, BackedgeMass.getMass());
 748   }
 749
 750   DitheringDistributer D(Dist, LoopMass);
 751
 752   DEBUG(dbgs() << " Distribute loop mass " << LoopMass
 753                << " to headers using above weights\n");
 754   for (const Weight &W : Dist.Weights) {
 755     BlockMass Taken = D.takeMass(W.Amount);
 756     assert(W.Type == Weight::Local && "all weights should be local");
 757     Working[W.TargetNode.Index].getMass() = Taken;
 758     DEBUG(debugAssign(*this, D, W.TargetNode, Taken, nullptr));
 759   }
 760 }