include/llvm/Analysis/BlockFrequencyInfoImpl.h

   1 //==- BlockFrequencyInfoImpl.h - Block Frequency Implementation -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // Shared implementation of BlockFrequency for IR and Machine Instructions.
  11 // See the documentation below for BlockFrequencyInfoImpl for details.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_ANALYSIS_BLOCKFREQUENCYINFOIMPL_H
  16 #define LLVM_ANALYSIS_BLOCKFREQUENCYINFOIMPL_H
  17
  18 #include "llvm/ADT/DenseMap.h"
  19 #include "llvm/ADT/PostOrderIterator.h"
  20 #include "llvm/ADT/SCCIterator.h"
  21 #include "llvm/ADT/iterator_range.h"
  22 #include "llvm/IR/BasicBlock.h"
  23 #include "llvm/Support/BlockFrequency.h"
  24 #include "llvm/Support/BranchProbability.h"
  25 #include "llvm/Support/Debug.h"
  26 #include "llvm/Support/raw_ostream.h"
  27 #include <string>
  28 #include <vector>
  29 #include <list>
  30
  31 #define DEBUG_TYPE "block-freq"
  32
  33 //===----------------------------------------------------------------------===//
  34 //
  35 // UnsignedFloat definition.
  36 //
  37 // TODO: Make this private to BlockFrequencyInfoImpl or delete.
  38 //
  39 //===----------------------------------------------------------------------===//
  40 namespace llvm {
  41
  42 class UnsignedFloatBase {
  43 public:
  44   static const int32_t MaxExponent = 16383;
  45   static const int32_t MinExponent = -16382;
  46   static const int DefaultPrecision = 10;
  47
  48   static void dump(uint64_t D, int16_t E, int Width);
  49   static raw_ostream &print(raw_ostream &OS, uint64_t D, int16_t E, int Width,
  50                             unsigned Precision);
  51   static std::string toString(uint64_t D, int16_t E, int Width,
  52                               unsigned Precision);
  53   static int countLeadingZeros32(uint32_t N) { return countLeadingZeros(N); }
  54   static int countLeadingZeros64(uint64_t N) { return countLeadingZeros(N); }
  55   static uint64_t getHalf(uint64_t N) { return (N >> 1) + (N & 1); }
  56
  57   static std::pair<uint64_t, bool> splitSigned(int64_t N) {
  58     if (N >= 0)
  59       return std::make_pair(N, false);
  60     uint64_t Unsigned = N == INT64_MIN ? UINT64_C(1) << 63 : uint64_t(-N);
  61     return std::make_pair(Unsigned, true);
  62   }
  63   static int64_t joinSigned(uint64_t U, bool IsNeg) {
  64     if (U > uint64_t(INT64_MAX))
  65       return IsNeg ? INT64_MIN : INT64_MAX;
  66     return IsNeg ? -int64_t(U) : int64_t(U);
  67   }
  68
  69   static int32_t extractLg(const std::pair<int32_t, int> &Lg) {
  70     return Lg.first;
  71   }
  72   static int32_t extractLgFloor(const std::pair<int32_t, int> &Lg) {
  73     return Lg.first - (Lg.second > 0);
  74   }
  75   static int32_t extractLgCeiling(const std::pair<int32_t, int> &Lg) {
  76     return Lg.first + (Lg.second < 0);
  77   }
  78
  79   static std::pair<uint64_t, int16_t> divide64(uint64_t L, uint64_t R);
  80   static std::pair<uint64_t, int16_t> multiply64(uint64_t L, uint64_t R);
  81
  82   static int compare(uint64_t L, uint64_t R, int Shift) {
  83     assert(Shift >= 0);
  84     assert(Shift < 64);
  85
  86     uint64_t L_adjusted = L >> Shift;
  87     if (L_adjusted < R)
  88       return -1;
  89     if (L_adjusted > R)
  90       return 1;
  91
  92     return L > L_adjusted << Shift ? 1 : 0;
  93   }
  94 };
  95
  96 /// \brief Simple representation of an unsigned floating point.
  97 ///
  98 /// UnsignedFloat is a unsigned floating point number.  It uses simple
  99 /// saturation arithmetic, and every operation is well-defined for every value.
 100 ///
 101 /// The number is split into a signed exponent and unsigned digits.  The number
 102 /// represented is \c getDigits()*2^getExponent().  In this way, the digits are
 103 /// much like the mantissa in the x87 long double, but there is no canonical
 104 /// form, so the same number can be represented by many bit representations
 105 /// (it's always in "denormal" mode).
 106 ///
 107 /// UnsignedFloat is templated on the underlying integer type for digits, which
 108 /// is expected to be one of uint64_t, uint32_t, uint16_t or uint8_t.
 109 ///
 110 /// Unlike builtin floating point types, UnsignedFloat is portable.
 111 ///
 112 /// Unlike APFloat, UnsignedFloat does not model architecture floating point
 113 /// behaviour (this should make it a little faster), and implements most
 114 /// operators (this makes it usable).
 115 ///
 116 /// UnsignedFloat is totally ordered.  However, there is no canonical form, so
 117 /// there are multiple representations of most scalars.  E.g.:
 118 ///
 119 ///     UnsignedFloat(8u, 0) == UnsignedFloat(4u, 1)
 120 ///     UnsignedFloat(4u, 1) == UnsignedFloat(2u, 2)
 121 ///     UnsignedFloat(2u, 2) == UnsignedFloat(1u, 3)
 122 ///
 123 /// UnsignedFloat implements most arithmetic operations.  Precision is kept
 124 /// where possible.  Uses simple saturation arithmetic, so that operations
 125 /// saturate to 0.0 or getLargest() rather than under or overflowing.  It has
 126 /// some extra arithmetic for unit inversion.  0.0/0.0 is defined to be 0.0.
 127 /// Any other division by 0.0 is defined to be getLargest().
 128 ///
 129 /// As a convenience for modifying the exponent, left and right shifting are
 130 /// both implemented, and both interpret negative shifts as positive shifts in
 131 /// the opposite direction.
 132 ///
 133 /// Exponents are limited to the range accepted by x87 long double.  This makes
 134 /// it trivial to add functionality to convert to APFloat (this is already
 135 /// relied on for the implementation of printing).
 136 ///
 137 /// The current plan is to gut this and make the necessary parts of it (even
 138 /// more) private to BlockFrequencyInfo.
 139 template <class DigitsT> class UnsignedFloat : UnsignedFloatBase {
 140 public:
 141   static_assert(!std::numeric_limits<DigitsT>::is_signed,
 142                 "only unsigned floats supported");
 143
 144   typedef DigitsT DigitsType;
 145
 146 private:
 147   typedef std::numeric_limits<DigitsType> DigitsLimits;
 148
 149   static const int Width = sizeof(DigitsType) * 8;
 150   static_assert(Width <= 64, "invalid integer width for digits");
 151
 152 private:
 153   DigitsType Digits;
 154   int16_t Exponent;
 155
 156 public:
 157   UnsignedFloat() : Digits(0), Exponent(0) {}
 158
 159   UnsignedFloat(DigitsType Digits, int16_t Exponent)
 160       : Digits(Digits), Exponent(Exponent) {}
 161
 162 private:
 163   UnsignedFloat(const std::pair<uint64_t, int16_t> &X)
 164       : Digits(X.first), Exponent(X.second) {}
 165
 166 public:
 167   static UnsignedFloat getZero() { return UnsignedFloat(0, 0); }
 168   static UnsignedFloat getOne() { return UnsignedFloat(1, 0); }
 169   static UnsignedFloat getLargest() {
 170     return UnsignedFloat(DigitsLimits::max(), MaxExponent);
 171   }
 172   static UnsignedFloat getFloat(uint64_t N) { return adjustToWidth(N, 0); }
 173   static UnsignedFloat getInverseFloat(uint64_t N) {
 174     return getFloat(N).invert();
 175   }
 176   static UnsignedFloat getFraction(DigitsType N, DigitsType D) {
 177     return getQuotient(N, D);
 178   }
 179
 180   int16_t getExponent() const { return Exponent; }
 181   DigitsType getDigits() const { return Digits; }
 182
 183   /// \brief Convert to the given integer type.
 184   ///
 185   /// Convert to \c IntT using simple saturating arithmetic, truncating if
 186   /// necessary.
 187   template <class IntT> IntT toInt() const;
 188
 189   bool isZero() const { return !Digits; }
 190   bool isLargest() const { return *this == getLargest(); }
 191   bool isOne() const {
 192     if (Exponent > 0 || Exponent <= -Width)
 193       return false;
 194     return Digits == DigitsType(1) << -Exponent;
 195   }
 196
 197   /// \brief The log base 2, rounded.
 198   ///
 199   /// Get the lg of the scalar.  lg 0 is defined to be INT32_MIN.
 200   int32_t lg() const { return extractLg(lgImpl()); }
 201
 202   /// \brief The log base 2, rounded towards INT32_MIN.
 203   ///
 204   /// Get the lg floor.  lg 0 is defined to be INT32_MIN.
 205   int32_t lgFloor() const { return extractLgFloor(lgImpl()); }
 206
 207   /// \brief The log base 2, rounded towards INT32_MAX.
 208   ///
 209   /// Get the lg ceiling.  lg 0 is defined to be INT32_MIN.
 210   int32_t lgCeiling() const { return extractLgCeiling(lgImpl()); }
 211
 212   bool operator==(const UnsignedFloat &X) const { return compare(X) == 0; }
 213   bool operator<(const UnsignedFloat &X) const { return compare(X) < 0; }
 214   bool operator!=(const UnsignedFloat &X) const { return compare(X) != 0; }
 215   bool operator>(const UnsignedFloat &X) const { return compare(X) > 0; }
 216   bool operator<=(const UnsignedFloat &X) const { return compare(X) <= 0; }
 217   bool operator>=(const UnsignedFloat &X) const { return compare(X) >= 0; }
 218
 219   bool operator!() const { return isZero(); }
 220
 221   /// \brief Convert to a decimal representation in a string.
 222   ///
 223   /// Convert to a string.  Uses scientific notation for very large/small
 224   /// numbers.  Scientific notation is used roughly for numbers outside of the
 225   /// range 2^-64 through 2^64.
 226   ///
 227   /// \c Precision indicates the number of decimal digits of precision to use;
 228   /// 0 requests the maximum available.
 229   ///
 230   /// As a special case to make debugging easier, if the number is small enough
 231   /// to convert without scientific notation and has more than \c Precision
 232   /// digits before the decimal place, it's printed accurately to the first
 233   /// digit past zero.  E.g., assuming 10 digits of precision:
 234   ///
 235   ///     98765432198.7654... => 98765432198.8
 236   ///      8765432198.7654... =>  8765432198.8
 237   ///       765432198.7654... =>   765432198.8
 238   ///        65432198.7654... =>    65432198.77
 239   ///         5432198.7654... =>     5432198.765
 240   std::string toString(unsigned Precision = DefaultPrecision) {
 241     return UnsignedFloatBase::toString(Digits, Exponent, Width, Precision);
 242   }
 243
 244   /// \brief Print a decimal representation.
 245   ///
 246   /// Print a string.  See toString for documentation.
 247   raw_ostream &print(raw_ostream &OS,
 248                      unsigned Precision = DefaultPrecision) const {
 249     return UnsignedFloatBase::print(OS, Digits, Exponent, Width, Precision);
 250   }
 251   void dump() const { return UnsignedFloatBase::dump(Digits, Exponent, Width); }
 252
 253   UnsignedFloat &operator+=(const UnsignedFloat &X);
 254   UnsignedFloat &operator-=(const UnsignedFloat &X);
 255   UnsignedFloat &operator*=(const UnsignedFloat &X);
 256   UnsignedFloat &operator/=(const UnsignedFloat &X);
 257   UnsignedFloat &operator<<=(int16_t Shift) { shiftLeft(Shift); return *this; }
 258   UnsignedFloat &operator>>=(int16_t Shift) { shiftRight(Shift); return *this; }
 259
 260 private:
 261   void shiftLeft(int32_t Shift);
 262   void shiftRight(int32_t Shift);
 263
 264   /// \brief Adjust two floats to have matching exponents.
 265   ///
 266   /// Adjust \c this and \c X to have matching exponents.  Returns the new \c X
 267   /// by value.  Does nothing if \a isZero() for either.
 268   ///
 269   /// The value that compares smaller will lose precision, and possibly become
 270   /// \a isZero().
 271   UnsignedFloat matchExponents(UnsignedFloat X);
 272
 273   /// \brief Increase exponent to match another float.
 274   ///
 275   /// Increases \c this to have an exponent matching \c X.  May decrease the
 276   /// exponent of \c X in the process, and \c this may possibly become \a
 277   /// isZero().
 278   void increaseExponentToMatch(UnsignedFloat &X, int32_t ExponentDiff);
 279
 280 public:
 281   /// \brief Scale a large number accurately.
 282   ///
 283   /// Scale N (multiply it by this).  Uses full precision multiplication, even
 284   /// if Width is smaller than 64, so information is not lost.
 285   uint64_t scale(uint64_t N) const;
 286   uint64_t scaleByInverse(uint64_t N) const {
 287     // TODO: implement directly, rather than relying on inverse.  Inverse is
 288     // expensive.
 289     return inverse().scale(N);
 290   }
 291   int64_t scale(int64_t N) const {
 292     std::pair<uint64_t, bool> Unsigned = splitSigned(N);
 293     return joinSigned(scale(Unsigned.first), Unsigned.second);
 294   }
 295   int64_t scaleByInverse(int64_t N) const {
 296     std::pair<uint64_t, bool> Unsigned = splitSigned(N);
 297     return joinSigned(scaleByInverse(Unsigned.first), Unsigned.second);
 298   }
 299
 300   int compare(const UnsignedFloat &X) const;
 301   int compareTo(uint64_t N) const {
 302     UnsignedFloat Float = getFloat(N);
 303     int Compare = compare(Float);
 304     if (Width == 64 || Compare != 0)
 305       return Compare;
 306
 307     // Check for precision loss.  We know *this == RoundTrip.
 308     uint64_t RoundTrip = Float.template toInt<uint64_t>();
 309     return N == RoundTrip ? 0 : RoundTrip < N ? -1 : 1;
 310   }
 311   int compareTo(int64_t N) const { return N < 0 ? 1 : compareTo(uint64_t(N)); }
 312
 313   UnsignedFloat &invert() { return *this = UnsignedFloat::getFloat(1) / *this; }
 314   UnsignedFloat inverse() const { return UnsignedFloat(*this).invert(); }
 315
 316 private:
 317   static UnsignedFloat getProduct(DigitsType L, DigitsType R);
 318   static UnsignedFloat getQuotient(DigitsType Dividend, DigitsType Divisor);
 319
 320   std::pair<int32_t, int> lgImpl() const;
 321   static int countLeadingZerosWidth(DigitsType Digits) {
 322     if (Width == 64)
 323       return countLeadingZeros64(Digits);
 324     if (Width == 32)
 325       return countLeadingZeros32(Digits);
 326     return countLeadingZeros32(Digits) + Width - 32;
 327   }
 328
 329   static UnsignedFloat adjustToWidth(uint64_t N, int32_t S) {
 330     assert(S >= MinExponent);
 331     assert(S <= MaxExponent);
 332     if (Width == 64 || N <= DigitsLimits::max())
 333       return UnsignedFloat(N, S);
 334
 335     // Shift right.
 336     int Shift = 64 - Width - countLeadingZeros64(N);
 337     DigitsType Shifted = N >> Shift;
 338
 339     // Round.
 340     assert(S + Shift <= MaxExponent);
 341     return getRounded(UnsignedFloat(Shifted, S + Shift),
 342                       N & UINT64_C(1) << (Shift - 1));
 343   }
 344
 345   static UnsignedFloat getRounded(UnsignedFloat P, bool Round) {
 346     if (!Round)
 347       return P;
 348     if (P.Digits == DigitsLimits::max())
 349       // Careful of overflow in the exponent.
 350       return UnsignedFloat(1, P.Exponent) <<= Width;
 351     return UnsignedFloat(P.Digits + 1, P.Exponent);
 352   }
 353 };
 354
 355 #define UNSIGNED_FLOAT_BOP(op, base)                                           \
 356   template <class DigitsT>                                                     \
 357   UnsignedFloat<DigitsT> operator op(const UnsignedFloat<DigitsT> &L,          \
 358                                      const UnsignedFloat<DigitsT> &R) {        \
 359     return UnsignedFloat<DigitsT>(L) base R;                                   \
 360   }
 361 UNSIGNED_FLOAT_BOP(+, += )
 362 UNSIGNED_FLOAT_BOP(-, -= )
 363 UNSIGNED_FLOAT_BOP(*, *= )
 364 UNSIGNED_FLOAT_BOP(/, /= )
 365 UNSIGNED_FLOAT_BOP(<<, <<= )
 366 UNSIGNED_FLOAT_BOP(>>, >>= )
 367 #undef UNSIGNED_FLOAT_BOP
 368
 369 template <class DigitsT>
 370 raw_ostream &operator<<(raw_ostream &OS, const UnsignedFloat<DigitsT> &X) {
 371   return X.print(OS, 10);
 372 }
 373
 374 #define UNSIGNED_FLOAT_COMPARE_TO_TYPE(op, T1, T2)                             \
 375   template <class DigitsT>                                                     \
 376   bool operator op(const UnsignedFloat<DigitsT> &L, T1 R) {                    \
 377     return L.compareTo(T2(R)) op 0;                                            \
 378   }                                                                            \
 379   template <class DigitsT>                                                     \
 380   bool operator op(T1 L, const UnsignedFloat<DigitsT> &R) {                    \
 381     return 0 op R.compareTo(T2(L));                                            \
 382   }
 383 #define UNSIGNED_FLOAT_COMPARE_TO(op)                                          \
 384   UNSIGNED_FLOAT_COMPARE_TO_TYPE(op, uint64_t, uint64_t)                       \
 385   UNSIGNED_FLOAT_COMPARE_TO_TYPE(op, uint32_t, uint64_t)                       \
 386   UNSIGNED_FLOAT_COMPARE_TO_TYPE(op, int64_t, int64_t)                         \
 387   UNSIGNED_FLOAT_COMPARE_TO_TYPE(op, int32_t, int64_t)
 388 UNSIGNED_FLOAT_COMPARE_TO(< )
 389 UNSIGNED_FLOAT_COMPARE_TO(> )
 390 UNSIGNED_FLOAT_COMPARE_TO(== )
 391 UNSIGNED_FLOAT_COMPARE_TO(!= )
 392 UNSIGNED_FLOAT_COMPARE_TO(<= )
 393 UNSIGNED_FLOAT_COMPARE_TO(>= )
 394 #undef UNSIGNED_FLOAT_COMPARE_TO
 395 #undef UNSIGNED_FLOAT_COMPARE_TO_TYPE
 396
 397 template <class DigitsT>
 398 uint64_t UnsignedFloat<DigitsT>::scale(uint64_t N) const {
 399   if (Width == 64 || N <= DigitsLimits::max())
 400     return (getFloat(N) * *this).template toInt<uint64_t>();
 401
 402   // Defer to the 64-bit version.
 403   return UnsignedFloat<uint64_t>(Digits, Exponent).scale(N);
 404 }
 405
 406 template <class DigitsT>
 407 UnsignedFloat<DigitsT> UnsignedFloat<DigitsT>::getProduct(DigitsType L,
 408                                                           DigitsType R) {
 409   // Check for zero.
 410   if (!L || !R)
 411     return getZero();
 412
 413   // Check for numbers that we can compute with 64-bit math.
 414   if (Width <= 32 || (L <= UINT32_MAX && R <= UINT32_MAX))
 415     return adjustToWidth(uint64_t(L) * uint64_t(R), 0);
 416
 417   // Do the full thing.
 418   return UnsignedFloat(multiply64(L, R));
 419 }
 420 template <class DigitsT>
 421 UnsignedFloat<DigitsT> UnsignedFloat<DigitsT>::getQuotient(DigitsType Dividend,
 422                                                            DigitsType Divisor) {
 423   // Check for zero.
 424   if (!Dividend)
 425     return getZero();
 426   if (!Divisor)
 427     return getLargest();
 428
 429   if (Width == 64)
 430     return UnsignedFloat(divide64(Dividend, Divisor));
 431
 432   // We can compute this with 64-bit math.
 433   int Shift = countLeadingZeros64(Dividend);
 434   uint64_t Shifted = uint64_t(Dividend) << Shift;
 435   uint64_t Quotient = Shifted / Divisor;
 436
 437   // If Quotient needs to be shifted, then adjustToWidth will round.
 438   if (Quotient > DigitsLimits::max())
 439     return adjustToWidth(Quotient, -Shift);
 440
 441   // Round based on the value of the next bit.
 442   return getRounded(UnsignedFloat(Quotient, -Shift),
 443                     Shifted % Divisor >= getHalf(Divisor));
 444 }
 445
 446 template <class DigitsT>
 447 template <class IntT>
 448 IntT UnsignedFloat<DigitsT>::toInt() const {
 449   typedef std::numeric_limits<IntT> Limits;
 450   if (*this < 1)
 451     return 0;
 452   if (*this >= Limits::max())
 453     return Limits::max();
 454
 455   IntT N = Digits;
 456   if (Exponent > 0) {
 457     assert(size_t(Exponent) < sizeof(IntT) * 8);
 458     return N << Exponent;
 459   }
 460   if (Exponent < 0) {
 461     assert(size_t(-Exponent) < sizeof(IntT) * 8);
 462     return N >> -Exponent;
 463   }
 464   return N;
 465 }
 466
 467 template <class DigitsT>
 468 std::pair<int32_t, int> UnsignedFloat<DigitsT>::lgImpl() const {
 469   if (isZero())
 470     return std::make_pair(INT32_MIN, 0);
 471
 472   // Get the floor of the lg of Digits.
 473   int32_t LocalFloor = Width - countLeadingZerosWidth(Digits) - 1;
 474
 475   // Get the floor of the lg of this.
 476   int32_t Floor = Exponent + LocalFloor;
 477   if (Digits == UINT64_C(1) << LocalFloor)
 478     return std::make_pair(Floor, 0);
 479
 480   // Round based on the next digit.
 481   assert(LocalFloor >= 1);
 482   bool Round = Digits & UINT64_C(1) << (LocalFloor - 1);
 483   return std::make_pair(Floor + Round, Round ? 1 : -1);
 484 }
 485
 486 template <class DigitsT>
 487 UnsignedFloat<DigitsT> UnsignedFloat<DigitsT>::matchExponents(UnsignedFloat X) {
 488   if (isZero() || X.isZero() || Exponent == X.Exponent)
 489     return X;
 490
 491   int32_t Diff = int32_t(X.Exponent) - int32_t(Exponent);
 492   if (Diff > 0)
 493     increaseExponentToMatch(X, Diff);
 494   else
 495     X.increaseExponentToMatch(*this, -Diff);
 496   return X;
 497 }
 498 template <class DigitsT>
 499 void UnsignedFloat<DigitsT>::increaseExponentToMatch(UnsignedFloat &X,
 500                                                      int32_t ExponentDiff) {
 501   assert(ExponentDiff > 0);
 502   if (ExponentDiff >= 2 * Width) {
 503     *this = getZero();
 504     return;
 505   }
 506
 507   // Use up any leading zeros on X, and then shift this.
 508   int32_t ShiftX = std::min(countLeadingZerosWidth(X.Digits), ExponentDiff);
 509   assert(ShiftX < Width);
 510
 511   int32_t ShiftThis = ExponentDiff - ShiftX;
 512   if (ShiftThis >= Width) {
 513     *this = getZero();
 514     return;
 515   }
 516
 517   X.Digits <<= ShiftX;
 518   X.Exponent -= ShiftX;
 519   Digits >>= ShiftThis;
 520   Exponent += ShiftThis;
 521   return;
 522 }
 523
 524 template <class DigitsT>
 525 UnsignedFloat<DigitsT> &UnsignedFloat<DigitsT>::
 526 operator+=(const UnsignedFloat &X) {
 527   if (isLargest() || X.isZero())
 528     return *this;
 529   if (isZero() || X.isLargest())
 530     return *this = X;
 531
 532   // Normalize exponents.
 533   UnsignedFloat Scaled = matchExponents(X);
 534
 535   // Check for zero again.
 536   if (isZero())
 537     return *this = Scaled;
 538   if (Scaled.isZero())
 539     return *this;
 540
 541   // Compute sum.
 542   DigitsType Sum = Digits + Scaled.Digits;
 543   bool DidOverflow = Sum < Digits;
 544   Digits = Sum;
 545   if (!DidOverflow)
 546     return *this;
 547
 548   if (Exponent == MaxExponent)
 549     return *this = getLargest();
 550
 551   ++Exponent;
 552   Digits = UINT64_C(1) << (Width - 1) | Digits >> 1;
 553
 554   return *this;
 555 }
 556 template <class DigitsT>
 557 UnsignedFloat<DigitsT> &UnsignedFloat<DigitsT>::
 558 operator-=(const UnsignedFloat &X) {
 559   if (X.isZero())
 560     return *this;
 561   if (*this <= X)
 562     return *this = getZero();
 563
 564   // Normalize exponents.
 565   UnsignedFloat Scaled = matchExponents(X);
 566   assert(Digits >= Scaled.Digits);
 567
 568   // Compute difference.
 569   if (!Scaled.isZero()) {
 570     Digits -= Scaled.Digits;
 571     return *this;
 572   }
 573
 574   // Check if X just barely lost its last bit.  E.g., for 32-bit:
 575   //
 576   //   1*2^32 - 1*2^0 == 0xffffffff != 1*2^32
 577   if (*this == UnsignedFloat(1, X.lgFloor() + Width)) {
 578     Digits = DigitsType(0) - 1;
 579     --Exponent;
 580   }
 581   return *this;
 582 }
 583 template <class DigitsT>
 584 UnsignedFloat<DigitsT> &UnsignedFloat<DigitsT>::
 585 operator*=(const UnsignedFloat &X) {
 586   if (isZero())
 587     return *this;
 588   if (X.isZero())
 589     return *this = X;
 590
 591   // Save the exponents.
 592   int32_t Exponents = int32_t(Exponent) + int32_t(X.Exponent);
 593
 594   // Get the raw product.
 595   *this = getProduct(Digits, X.Digits);
 596
 597   // Combine with exponents.
 598   return *this <<= Exponents;
 599 }
 600 template <class DigitsT>
 601 UnsignedFloat<DigitsT> &UnsignedFloat<DigitsT>::
 602 operator/=(const UnsignedFloat &X) {
 603   if (isZero())
 604     return *this;
 605   if (X.isZero())
 606     return *this = getLargest();
 607
 608   // Save the exponents.
 609   int32_t Exponents = int32_t(Exponent) - int32_t(X.Exponent);
 610
 611   // Get the raw quotient.
 612   *this = getQuotient(Digits, X.Digits);
 613
 614   // Combine with exponents.
 615   return *this <<= Exponents;
 616 }
 617 template <class DigitsT>
 618 void UnsignedFloat<DigitsT>::shiftLeft(int32_t Shift) {
 619   if (!Shift || isZero())
 620     return;
 621   assert(Shift != INT32_MIN);
 622   if (Shift < 0) {
 623     shiftRight(-Shift);
 624     return;
 625   }
 626
 627   // Shift as much as we can in the exponent.
 628   int32_t ExponentShift = std::min(Shift, MaxExponent - Exponent);
 629   Exponent += ExponentShift;
 630   if (ExponentShift == Shift)
 631     return;
 632
 633   // Check this late, since it's rare.
 634   if (isLargest())
 635     return;
 636
 637   // Shift the digits themselves.
 638   Shift -= ExponentShift;
 639   if (Shift > countLeadingZerosWidth(Digits)) {
 640     // Saturate.
 641     *this = getLargest();
 642     return;
 643   }
 644
 645   Digits <<= Shift;
 646   return;
 647 }
 648
 649 template <class DigitsT>
 650 void UnsignedFloat<DigitsT>::shiftRight(int32_t Shift) {
 651   if (!Shift || isZero())
 652     return;
 653   assert(Shift != INT32_MIN);
 654   if (Shift < 0) {
 655     shiftLeft(-Shift);
 656     return;
 657   }
 658
 659   // Shift as much as we can in the exponent.
 660   int32_t ExponentShift = std::min(Shift, Exponent - MinExponent);
 661   Exponent -= ExponentShift;
 662   if (ExponentShift == Shift)
 663     return;
 664
 665   // Shift the digits themselves.
 666   Shift -= ExponentShift;
 667   if (Shift >= Width) {
 668     // Saturate.
 669     *this = getZero();
 670     return;
 671   }
 672
 673   Digits >>= Shift;
 674   return;
 675 }
 676
 677 template <class DigitsT>
 678 int UnsignedFloat<DigitsT>::compare(const UnsignedFloat &X) const {
 679   // Check for zero.
 680   if (isZero())
 681     return X.isZero() ? 0 : -1;
 682   if (X.isZero())
 683     return 1;
 684
 685   // Check for the scale.  Use lgFloor to be sure that the exponent difference
 686   // is always lower than 64.
 687   int32_t lgL = lgFloor(), lgR = X.lgFloor();
 688   if (lgL != lgR)
 689     return lgL < lgR ? -1 : 1;
 690
 691   // Compare digits.
 692   if (Exponent < X.Exponent)
 693     return UnsignedFloatBase::compare(Digits, X.Digits, X.Exponent - Exponent);
 694
 695   return -UnsignedFloatBase::compare(X.Digits, Digits, Exponent - X.Exponent);
 696 }
 697
 698 template <class T> struct isPodLike<UnsignedFloat<T>> {
 699   static const bool value = true;
 700 };
 701 }
 702
 703 //===----------------------------------------------------------------------===//
 704 //
 705 // BlockMass definition.
 706 //
 707 // TODO: Make this private to BlockFrequencyInfoImpl or delete.
 708 //
 709 //===----------------------------------------------------------------------===//
 710 namespace llvm {
 711
 712 /// \brief Mass of a block.
 713 ///
 714 /// This class implements a sort of fixed-point fraction always between 0.0 and
 715 /// 1.0.  getMass() == UINT64_MAX indicates a value of 1.0.
 716 ///
 717 /// Masses can be added and subtracted.  Simple saturation arithmetic is used,
 718 /// so arithmetic operations never overflow or underflow.
 719 ///
 720 /// Masses can be multiplied.  Multiplication treats full mass as 1.0 and uses
 721 /// an inexpensive floating-point algorithm that's off-by-one (almost, but not
 722 /// quite, maximum precision).
 723 ///
 724 /// Masses can be scaled by \a BranchProbability at maximum precision.
 725 class BlockMass {
 726   uint64_t Mass;
 727
 728 public:
 729   BlockMass() : Mass(0) {}
 730   explicit BlockMass(uint64_t Mass) : Mass(Mass) {}
 731
 732   static BlockMass getEmpty() { return BlockMass(); }
 733   static BlockMass getFull() { return BlockMass(UINT64_MAX); }
 734
 735   uint64_t getMass() const { return Mass; }
 736
 737   bool isFull() const { return Mass == UINT64_MAX; }
 738   bool isEmpty() const { return !Mass; }
 739
 740   bool operator!() const { return isEmpty(); }
 741
 742   /// \brief Add another mass.
 743   ///
 744   /// Adds another mass, saturating at \a isFull() rather than overflowing.
 745   BlockMass &operator+=(const BlockMass &X) {
 746     uint64_t Sum = Mass + X.Mass;
 747     Mass = Sum < Mass ? UINT64_MAX : Sum;
 748     return *this;
 749   }
 750
 751   /// \brief Subtract another mass.
 752   ///
 753   /// Subtracts another mass, saturating at \a isEmpty() rather than
 754   /// undeflowing.
 755   BlockMass &operator-=(const BlockMass &X) {
 756     uint64_t Diff = Mass - X.Mass;
 757     Mass = Diff > Mass ? 0 : Diff;
 758     return *this;
 759   }
 760
 761   /// \brief Scale by another mass.
 762   ///
 763   /// The current implementation is a little imprecise, but it's relatively
 764   /// fast, never overflows, and maintains the property that 1.0*1.0==1.0
 765   /// (where isFull represents the number 1.0).  It's an approximation of
 766   /// 128-bit multiply that gets right-shifted by 64-bits.
 767   ///
 768   /// For a given digit size, multiplying two-digit numbers looks like:
 769   ///
 770   ///                  U1 .    L1
 771   ///                * U2 .    L2
 772   ///                ============
 773   ///           0 .       . L1*L2
 774   ///     +     0 . U1*L2 .     0 // (shift left once by a digit-size)
 775   ///     +     0 . U2*L1 .     0 // (shift left once by a digit-size)
 776   ///     + U1*L2 .     0 .     0 // (shift left twice by a digit-size)
 777   ///
 778   /// BlockMass has 64-bit numbers.  Split each into two 32-bit digits, stored
 779   /// 64-bit.  Add 1 to the lower digits, to model isFull as 1.0; this won't
 780   /// overflow, since we have 64-bit storage for each digit.
 781   ///
 782   /// To do this accurately, (a) multiply into two 64-bit digits, incrementing
 783   /// the upper digit on overflows of the lower digit (carry), (b) subtract 1
 784   /// from the lower digit, decrementing the upper digit on underflow (carry),
 785   /// and (c) truncate the lower digit.  For the 1.0*1.0 case, the upper digit
 786   /// will be 0 at the end of step (a), and then will underflow back to isFull
 787   /// (1.0) in step (b).
 788   ///
 789   /// Instead, the implementation does something a little faster with a small
 790   /// loss of accuracy: ignore the lower 64-bit digit entirely.  The loss of
 791   /// accuracy is small, since the sum of the unmodelled carries is 0 or 1
 792   /// (i.e., step (a) will overflow at most once, and step (b) will underflow
 793   /// only if step (a) overflows).
 794   ///
 795   /// This is the formula we're calculating:
 796   ///
 797   ///     U1.L1 * U2.L2 == U1 * U2 + (U1 * (L2+1))>>32 + (U2 * (L1+1))>>32
 798   ///
 799   /// As a demonstration of 1.0*1.0, consider two 4-bit numbers that are both
 800   /// full (1111).
 801   ///
 802   ///     U1.L1 * U2.L2 == U1 * U2 + (U1 * (L2+1))>>2 + (U2 * (L1+1))>>2
 803   ///     11.11 * 11.11 == 11 * 11 + (11 * (11+1))/4 + (11 * (11+1))/4
 804   ///                   == 1001 + (11 * 100)/4 + (11 * 100)/4
 805   ///                   == 1001 + 1100/4 + 1100/4
 806   ///                   == 1001 + 0011 + 0011
 807   ///                   == 1111
 808   BlockMass &operator*=(const BlockMass &X) {
 809     uint64_t U1 = Mass >> 32, L1 = Mass & UINT32_MAX, U2 = X.Mass >> 32,
 810              L2 = X.Mass & UINT32_MAX;
 811     Mass = U1 * U2 + (U1 * (L2 + 1) >> 32) + ((L1 + 1) * U2 >> 32);
 812     return *this;
 813   }
 814
 815   /// \brief Multiply by a branch probability.
 816   ///
 817   /// Multiply by P.  Guarantees full precision.
 818   ///
 819   /// This could be naively implemented by multiplying by the numerator and
 820   /// dividing by the denominator, but in what order?  Multiplying first can
 821   /// overflow, while dividing first will lose precision (potentially, changing
 822   /// a non-zero mass to zero).
 823   ///
 824   /// The implementation mixes the two methods.  Since \a BranchProbability
 825   /// uses 32-bits and \a BlockMass 64-bits, shift the mass as far to the left
 826   /// as there is room, then divide by the denominator to get a quotient.
 827   /// Multiplying by the numerator and right shifting gives a first
 828   /// approximation.
 829   ///
 830   /// Calculate the error in this first approximation by calculating the
 831   /// opposite mass (multiply by the opposite numerator and shift) and
 832   /// subtracting both from teh original mass.
 833   ///
 834   /// Add to the first approximation the correct fraction of this error value.
 835   /// This time, multiply first and then divide, since there is no danger of
 836   /// overflow.
 837   ///
 838   /// \pre P represents a fraction between 0.0 and 1.0.
 839   BlockMass &operator*=(const BranchProbability &P);
 840
 841   bool operator==(const BlockMass &X) const { return Mass == X.Mass; }
 842   bool operator!=(const BlockMass &X) const { return Mass != X.Mass; }
 843   bool operator<=(const BlockMass &X) const { return Mass <= X.Mass; }
 844   bool operator>=(const BlockMass &X) const { return Mass >= X.Mass; }
 845   bool operator<(const BlockMass &X) const { return Mass < X.Mass; }
 846   bool operator>(const BlockMass &X) const { return Mass > X.Mass; }
 847
 848   /// \brief Convert to floating point.
 849   ///
 850   /// Convert to a float.  \a isFull() gives 1.0, while \a isEmpty() gives
 851   /// slightly above 0.0.
 852   UnsignedFloat<uint64_t> toFloat() const;
 853
 854   void dump() const;
 855   raw_ostream &print(raw_ostream &OS) const;
 856 };
 857
 858 inline BlockMass operator+(const BlockMass &L, const BlockMass &R) {
 859   return BlockMass(L) += R;
 860 }
 861 inline BlockMass operator-(const BlockMass &L, const BlockMass &R) {
 862   return BlockMass(L) -= R;
 863 }
 864 inline BlockMass operator*(const BlockMass &L, const BlockMass &R) {
 865   return BlockMass(L) *= R;
 866 }
 867 inline BlockMass operator*(const BlockMass &L, const BranchProbability &R) {
 868   return BlockMass(L) *= R;
 869 }
 870 inline BlockMass operator*(const BranchProbability &L, const BlockMass &R) {
 871   return BlockMass(R) *= L;
 872 }
 873
 874 inline raw_ostream &operator<<(raw_ostream &OS, const BlockMass &X) {
 875   return X.print(OS);
 876 }
 877
 878 template <> struct isPodLike<BlockMass> {
 879   static const bool value = true;
 880 };
 881 }
 882
 883 //===----------------------------------------------------------------------===//
 884 //
 885 // BlockFrequencyInfoImpl definition.
 886 //
 887 //===----------------------------------------------------------------------===//
 888 namespace llvm {
 889
 890 class BasicBlock;
 891 class BranchProbabilityInfo;
 892 class Function;
 893 class Loop;
 894 class LoopInfo;
 895 class MachineBasicBlock;
 896 class MachineBranchProbabilityInfo;
 897 class MachineFunction;
 898 class MachineLoop;
 899 class MachineLoopInfo;
 900
 901 namespace bfi_detail {
 902 struct IrreducibleGraph;
 903 }
 904
 905 /// \brief Base class for BlockFrequencyInfoImpl
 906 ///
 907 /// BlockFrequencyInfoImplBase has supporting data structures and some
 908 /// algorithms for BlockFrequencyInfoImplBase.  Only algorithms that depend on
 909 /// the block type (or that call such algorithms) are skipped here.
 910 ///
 911 /// Nevertheless, the majority of the overall algorithm documention lives with
 912 /// BlockFrequencyInfoImpl.  See there for details.
 913 class BlockFrequencyInfoImplBase {
 914 public:
 915   typedef UnsignedFloat<uint64_t> Float;
 916
 917   /// \brief Representative of a block.
 918   ///
 919   /// This is a simple wrapper around an index into the reverse-post-order
 920   /// traversal of the blocks.
 921   ///
 922   /// Unlike a block pointer, its order has meaning (location in the
 923   /// topological sort) and it's class is the same regardless of block type.
 924   struct BlockNode {
 925     typedef uint32_t IndexType;
 926     IndexType Index;
 927
 928     bool operator==(const BlockNode &X) const { return Index == X.Index; }
 929     bool operator!=(const BlockNode &X) const { return Index != X.Index; }
 930     bool operator<=(const BlockNode &X) const { return Index <= X.Index; }
 931     bool operator>=(const BlockNode &X) const { return Index >= X.Index; }
 932     bool operator<(const BlockNode &X) const { return Index < X.Index; }
 933     bool operator>(const BlockNode &X) const { return Index > X.Index; }
 934
 935     BlockNode() : Index(UINT32_MAX) {}
 936     BlockNode(IndexType Index) : Index(Index) {}
 937
 938     bool isValid() const { return Index <= getMaxIndex(); }
 939     static size_t getMaxIndex() { return UINT32_MAX - 1; }
 940   };
 941
 942   /// \brief Stats about a block itself.
 943   struct FrequencyData {
 944     Float Floating;
 945     uint64_t Integer;
 946   };
 947
 948   /// \brief Data about a loop.
 949   ///
 950   /// Contains the data necessary to represent represent a loop as a
 951   /// pseudo-node once it's packaged.
 952   struct LoopData {
 953     typedef SmallVector<std::pair<BlockNode, BlockMass>, 4> ExitMap;
 954     typedef SmallVector<BlockNode, 4> NodeList;
 955     LoopData *Parent;       ///< The parent loop.
 956     bool IsPackaged;        ///< Whether this has been packaged.
 957     uint32_t NumHeaders;    ///< Number of headers.
 958     ExitMap Exits;          ///< Successor edges (and weights).
 959     NodeList Nodes;         ///< Header and the members of the loop.
 960     BlockMass BackedgeMass; ///< Mass returned to loop header.
 961     BlockMass Mass;
 962     Float Scale;
 963
 964     LoopData(LoopData *Parent, const BlockNode &Header)
 965         : Parent(Parent), IsPackaged(false), NumHeaders(1), Nodes(1, Header) {}
 966     template <class It1, class It2>
 967     LoopData(LoopData *Parent, It1 FirstHeader, It1 LastHeader, It2 FirstOther,
 968              It2 LastOther)
 969         : Parent(Parent), IsPackaged(false), Nodes(FirstHeader, LastHeader) {
 970       NumHeaders = Nodes.size();
 971       Nodes.insert(Nodes.end(), FirstOther, LastOther);
 972     }
 973     bool isHeader(const BlockNode &Node) const {
 974       if (isIrreducible())
 975         return std::binary_search(Nodes.begin(), Nodes.begin() + NumHeaders,
 976                                   Node);
 977       return Node == Nodes[0];
 978     }
 979     BlockNode getHeader() const { return Nodes[0]; }
 980     bool isIrreducible() const { return NumHeaders > 1; }
 981
 982     NodeList::const_iterator members_begin() const {
 983       return Nodes.begin() + NumHeaders;
 984     }
 985     NodeList::const_iterator members_end() const { return Nodes.end(); }
 986     iterator_range<NodeList::const_iterator> members() const {
 987       return make_range(members_begin(), members_end());
 988     }
 989   };
 990
 991   /// \brief Index of loop information.
 992   struct WorkingData {
 993     BlockNode Node; ///< This node.
 994     LoopData *Loop; ///< The loop this block is inside.
 995     BlockMass Mass; ///< Mass distribution from the entry block.
 996
 997     WorkingData(const BlockNode &Node) : Node(Node), Loop(nullptr) {}
 998
 999     bool isLoopHeader() const { return Loop && Loop->isHeader(Node); }
1000     bool isDoubleLoopHeader() const {
1001       return isLoopHeader() && Loop->Parent && Loop->Parent->isIrreducible() &&
1002              Loop->Parent->isHeader(Node);
1003     }
1004
1005     LoopData *getContainingLoop() const {
1006       if (!isLoopHeader())
1007         return Loop;
1008       if (!isDoubleLoopHeader())
1009         return Loop->Parent;
1010       return Loop->Parent->Parent;
1011     }
1012
1013     /// \brief Resolve a node to its representative.
1014     ///
1015     /// Get the node currently representing Node, which could be a containing
1016     /// loop.
1017     ///
1018     /// This function should only be called when distributing mass.  As long as
1019     /// there are no irreducilbe edges to Node, then it will have complexity
1020     /// O(1) in this context.
1021     ///
1022     /// In general, the complexity is O(L), where L is the number of loop
1023     /// headers Node has been packaged into.  Since this method is called in
1024     /// the context of distributing mass, L will be the number of loop headers
1025     /// an early exit edge jumps out of.
1026     BlockNode getResolvedNode() const {
1027       auto L = getPackagedLoop();
1028       return L ? L->getHeader() : Node;
1029     }
1030     LoopData *getPackagedLoop() const {
1031       if (!Loop || !Loop->IsPackaged)
1032         return nullptr;
1033       auto L = Loop;
1034       while (L->Parent && L->Parent->IsPackaged)
1035         L = L->Parent;
1036       return L;
1037     }
1038
1039     /// \brief Get the appropriate mass for a node.
1040     ///
1041     /// Get appropriate mass for Node.  If Node is a loop-header (whose loop
1042     /// has been packaged), returns the mass of its pseudo-node.  If it's a
1043     /// node inside a packaged loop, it returns the loop's mass.
1044     BlockMass &getMass() {
1045       if (!isAPackage())
1046         return Mass;
1047       if (!isADoublePackage())
1048         return Loop->Mass;
1049       return Loop->Parent->Mass;
1050     }
1051
1052     /// \brief Has ContainingLoop been packaged up?
1053     bool isPackaged() const { return getResolvedNode() != Node; }
1054     /// \brief Has Loop been packaged up?
1055     bool isAPackage() const { return isLoopHeader() && Loop->IsPackaged; }
1056     /// \brief Has Loop been packaged up twice?
1057     bool isADoublePackage() const {
1058       return isDoubleLoopHeader() && Loop->Parent->IsPackaged;
1059     }
1060   };
1061
1062   /// \brief Unscaled probability weight.
1063   ///
1064   /// Probability weight for an edge in the graph (including the
1065   /// successor/target node).
1066   ///
1067   /// All edges in the original function are 32-bit.  However, exit edges from
1068   /// loop packages are taken from 64-bit exit masses, so we need 64-bits of
1069   /// space in general.
1070   ///
1071   /// In addition to the raw weight amount, Weight stores the type of the edge
1072   /// in the current context (i.e., the context of the loop being processed).
1073   /// Is this a local edge within the loop, an exit from the loop, or a
1074   /// backedge to the loop header?
1075   struct Weight {
1076     enum DistType { Local, Exit, Backedge };
1077     DistType Type;
1078     BlockNode TargetNode;
1079     uint64_t Amount;
1080     Weight() : Type(Local), Amount(0) {}
1081   };
1082
1083   /// \brief Distribution of unscaled probability weight.
1084   ///
1085   /// Distribution of unscaled probability weight to a set of successors.
1086   ///
1087   /// This class collates the successor edge weights for later processing.
1088   ///
1089   /// \a DidOverflow indicates whether \a Total did overflow while adding to
1090   /// the distribution.  It should never overflow twice.
1091   struct Distribution {
1092     typedef SmallVector<Weight, 4> WeightList;
1093     WeightList Weights;    ///< Individual successor weights.
1094     uint64_t Total;        ///< Sum of all weights.
1095     bool DidOverflow;      ///< Whether \a Total did overflow.
1096
1097     Distribution() : Total(0), DidOverflow(false) {}
1098     void addLocal(const BlockNode &Node, uint64_t Amount) {
1099       add(Node, Amount, Weight::Local);
1100     }
1101     void addExit(const BlockNode &Node, uint64_t Amount) {
1102       add(Node, Amount, Weight::Exit);
1103     }
1104     void addBackedge(const BlockNode &Node, uint64_t Amount) {
1105       add(Node, Amount, Weight::Backedge);
1106     }
1107
1108     /// \brief Normalize the distribution.
1109     ///
1110     /// Combines multiple edges to the same \a Weight::TargetNode and scales
1111     /// down so that \a Total fits into 32-bits.
1112     ///
1113     /// This is linear in the size of \a Weights.  For the vast majority of
1114     /// cases, adjacent edge weights are combined by sorting WeightList and
1115     /// combining adjacent weights.  However, for very large edge lists an
1116     /// auxiliary hash table is used.
1117     void normalize();
1118
1119   private:
1120     void add(const BlockNode &Node, uint64_t Amount, Weight::DistType Type);
1121   };
1122
1123   /// \brief Data about each block.  This is used downstream.
1124   std::vector<FrequencyData> Freqs;
1125
1126   /// \brief Loop data: see initializeLoops().
1127   std::vector<WorkingData> Working;
1128
1129   /// \brief Indexed information about loops.
1130   std::list<LoopData> Loops;
1131
1132   /// \brief Add all edges out of a packaged loop to the distribution.
1133   ///
1134   /// Adds all edges from LocalLoopHead to Dist.  Calls addToDist() to add each
1135   /// successor edge.
1136   ///
1137   /// \return \c true unless there's an irreducible backedge.
1138   bool addLoopSuccessorsToDist(const LoopData *OuterLoop, LoopData &Loop,
1139                                Distribution &Dist);
1140
1141   /// \brief Add an edge to the distribution.
1142   ///
1143   /// Adds an edge to Succ to Dist.  If \c LoopHead.isValid(), then whether the
1144   /// edge is local/exit/backedge is in the context of LoopHead.  Otherwise,
1145   /// every edge should be a local edge (since all the loops are packaged up).
1146   ///
1147   /// \return \c true unless aborted due to an irreducible backedge.
1148   bool addToDist(Distribution &Dist, const LoopData *OuterLoop,
1149                  const BlockNode &Pred, const BlockNode &Succ, uint64_t Weight);
1150
1151   LoopData &getLoopPackage(const BlockNode &Head) {
1152     assert(Head.Index < Working.size());
1153     assert(Working[Head.Index].isLoopHeader());
1154     return *Working[Head.Index].Loop;
1155   }
1156
1157   /// \brief Analyze irreducible SCCs.
1158   ///
1159   /// Separate irreducible SCCs from \c G, which is an explict graph of \c
1160   /// OuterLoop (or the top-level function, if \c OuterLoop is \c nullptr).
1161   /// Insert them into \a Loops before \c Insert.
1162   ///
1163   /// \return the \c LoopData nodes representing the irreducible SCCs.
1164   iterator_range<std::list<LoopData>::iterator>
1165   analyzeIrreducible(const bfi_detail::IrreducibleGraph &G, LoopData *OuterLoop,
1166                      std::list<LoopData>::iterator Insert);
1167
1168   /// \brief Update a loop after packaging irreducible SCCs inside of it.
1169   ///
1170   /// Update \c OuterLoop.  Before finding irreducible control flow, it was
1171   /// partway through \a computeMassInLoop(), so \a LoopData::Exits and \a
1172   /// LoopData::BackedgeMass need to be reset.  Also, nodes that were packaged
1173   /// up need to be removed from \a OuterLoop::Nodes.
1174   void updateLoopWithIrreducible(LoopData &OuterLoop);
1175
1176   /// \brief Distribute mass according to a distribution.
1177   ///
1178   /// Distributes the mass in Source according to Dist.  If LoopHead.isValid(),
1179   /// backedges and exits are stored in its entry in Loops.
1180   ///
1181   /// Mass is distributed in parallel from two copies of the source mass.
1182   void distributeMass(const BlockNode &Source, LoopData *OuterLoop,
1183                       Distribution &Dist);
1184
1185   /// \brief Compute the loop scale for a loop.
1186   void computeLoopScale(LoopData &Loop);
1187
1188   /// \brief Package up a loop.
1189   void packageLoop(LoopData &Loop);
1190
1191   /// \brief Unwrap loops.
1192   void unwrapLoops();
1193
1194   /// \brief Finalize frequency metrics.
1195   ///
1196   /// Calculates final frequencies and cleans up no-longer-needed data
1197   /// structures.
1198   void finalizeMetrics();
1199
1200   /// \brief Clear all memory.
1201   void clear();
1202
1203   virtual std::string getBlockName(const BlockNode &Node) const;
1204   std::string getLoopName(const LoopData &Loop) const;
1205
1206   virtual raw_ostream &print(raw_ostream &OS) const { return OS; }
1207   void dump() const { print(dbgs()); }
1208
1209   Float getFloatingBlockFreq(const BlockNode &Node) const;
1210
1211   BlockFrequency getBlockFreq(const BlockNode &Node) const;
1212
1213   raw_ostream &printBlockFreq(raw_ostream &OS, const BlockNode &Node) const;
1214   raw_ostream &printBlockFreq(raw_ostream &OS,
1215                               const BlockFrequency &Freq) const;
1216
1217   uint64_t getEntryFreq() const {
1218     assert(!Freqs.empty());
1219     return Freqs[0].Integer;
1220   }
1221   /// \brief Virtual destructor.
1222   ///
1223   /// Need a virtual destructor to mask the compiler warning about
1224   /// getBlockName().
1225   virtual ~BlockFrequencyInfoImplBase() {}
1226 };
1227
1228 namespace bfi_detail {
1229 template <class BlockT> struct TypeMap {};
1230 template <> struct TypeMap<BasicBlock> {
1231   typedef BasicBlock BlockT;
1232   typedef Function FunctionT;
1233   typedef BranchProbabilityInfo BranchProbabilityInfoT;
1234   typedef Loop LoopT;
1235   typedef LoopInfo LoopInfoT;
1236 };
1237 template <> struct TypeMap<MachineBasicBlock> {
1238   typedef MachineBasicBlock BlockT;
1239   typedef MachineFunction FunctionT;
1240   typedef MachineBranchProbabilityInfo BranchProbabilityInfoT;
1241   typedef MachineLoop LoopT;
1242   typedef MachineLoopInfo LoopInfoT;
1243 };
1244
1245 /// \brief Get the name of a MachineBasicBlock.
1246 ///
1247 /// Get the name of a MachineBasicBlock.  It's templated so that including from
1248 /// CodeGen is unnecessary (that would be a layering issue).
1249 ///
1250 /// This is used mainly for debug output.  The name is similar to
1251 /// MachineBasicBlock::getFullName(), but skips the name of the function.
1252 template <class BlockT> std::string getBlockName(const BlockT *BB) {
1253   assert(BB && "Unexpected nullptr");
1254   auto MachineName = "BB" + Twine(BB->getNumber());
1255   if (BB->getBasicBlock())
1256     return (MachineName + "[" + BB->getName() + "]").str();
1257   return MachineName.str();
1258 }
1259 /// \brief Get the name of a BasicBlock.
1260 template <> inline std::string getBlockName(const BasicBlock *BB) {
1261   assert(BB && "Unexpected nullptr");
1262   return BB->getName().str();
1263 }
1264
1265 /// \brief Graph of irreducible control flow.
1266 ///
1267 /// This graph is used for determining the SCCs in a loop (or top-level
1268 /// function) that has irreducible control flow.
1269 ///
1270 /// During the block frequency algorithm, the local graphs are defined in a
1271 /// light-weight way, deferring to the \a BasicBlock or \a MachineBasicBlock
1272 /// graphs for most edges, but getting others from \a LoopData::ExitMap.  The
1273 /// latter only has successor information.
1274 ///
1275 /// \a IrreducibleGraph makes this graph explicit.  It's in a form that can use
1276 /// \a GraphTraits (so that \a analyzeIrreducible() can use \a scc_iterator),
1277 /// and it explicitly lists predecessors and successors.  The initialization
1278 /// that relies on \c MachineBasicBlock is defined in the header.
1279 struct IrreducibleGraph {
1280   typedef BlockFrequencyInfoImplBase BFIBase;
1281
1282   BFIBase &BFI;
1283
1284   typedef BFIBase::BlockNode BlockNode;
1285   struct IrrNode {
1286     BlockNode Node;
1287     unsigned NumIn;
1288     std::deque<const IrrNode *> Edges;
1289     IrrNode(const BlockNode &Node) : Node(Node), NumIn(0) {}
1290
1291     typedef typename std::deque<const IrrNode *>::const_iterator iterator;
1292     iterator pred_begin() const { return Edges.begin(); }
1293     iterator succ_begin() const { return Edges.begin() + NumIn; }
1294     iterator pred_end() const { return succ_begin(); }
1295     iterator succ_end() const { return Edges.end(); }
1296   };
1297   BlockNode Start;
1298   const IrrNode *StartIrr;
1299   std::vector<IrrNode> Nodes;
1300   SmallDenseMap<uint32_t, IrrNode *, 4> Lookup;
1301
1302   /// \brief Construct an explicit graph containing irreducible control flow.
1303   ///
1304   /// Construct an explicit graph of the control flow in \c OuterLoop (or the
1305   /// top-level function, if \c OuterLoop is \c nullptr).  Uses \c
1306   /// addBlockEdges to add block successors that have not been packaged into
1307   /// loops.
1308   ///
1309   /// \a BlockFrequencyInfoImpl::computeIrreducibleMass() is the only expected
1310   /// user of this.
1311   template <class BlockEdgesAdder>
1312   IrreducibleGraph(BFIBase &BFI, const BFIBase::LoopData *OuterLoop,
1313                    BlockEdgesAdder addBlockEdges)
1314       : BFI(BFI), StartIrr(nullptr) {
1315     initialize(OuterLoop, addBlockEdges);
1316   }
1317
1318   template <class BlockEdgesAdder>
1319   void initialize(const BFIBase::LoopData *OuterLoop,
1320                   BlockEdgesAdder addBlockEdges);
1321   void addNodesInLoop(const BFIBase::LoopData &OuterLoop);
1322   void addNodesInFunction();
1323   void addNode(const BlockNode &Node) {
1324     Nodes.emplace_back(Node);
1325     BFI.Working[Node.Index].getMass() = BlockMass::getEmpty();
1326   }
1327   void indexNodes();
1328   template <class BlockEdgesAdder>
1329   void addEdges(const BlockNode &Node, const BFIBase::LoopData *OuterLoop,
1330                 BlockEdgesAdder addBlockEdges);
1331   void addEdge(IrrNode &Irr, const BlockNode &Succ,
1332                const BFIBase::LoopData *OuterLoop);
1333 };
1334 template <class BlockEdgesAdder>
1335 void IrreducibleGraph::initialize(const BFIBase::LoopData *OuterLoop,
1336                                   BlockEdgesAdder addBlockEdges) {
1337   if (OuterLoop) {
1338     addNodesInLoop(*OuterLoop);
1339     for (auto N : OuterLoop->Nodes)
1340       addEdges(N, OuterLoop, addBlockEdges);
1341   } else {
1342     addNodesInFunction();
1343     for (uint32_t Index = 0; Index < BFI.Working.size(); ++Index)
1344       addEdges(Index, OuterLoop, addBlockEdges);
1345   }
1346   StartIrr = Lookup[Start.Index];
1347 }
1348 template <class BlockEdgesAdder>
1349 void IrreducibleGraph::addEdges(const BlockNode &Node,
1350                                 const BFIBase::LoopData *OuterLoop,
1351                                 BlockEdgesAdder addBlockEdges) {
1352   auto L = Lookup.find(Node.Index);
1353   if (L == Lookup.end())
1354     return;
1355   IrrNode &Irr = *L->second;
1356   const auto &Working = BFI.Working[Node.Index];
1357
1358   if (Working.isAPackage())
1359     for (const auto &I : Working.Loop->Exits)
1360       addEdge(Irr, I.first, OuterLoop);
1361   else
1362     addBlockEdges(*this, Irr, OuterLoop);
1363 }
1364 }
1365
1366 /// \brief Shared implementation for block frequency analysis.
1367 ///
1368 /// This is a shared implementation of BlockFrequencyInfo and
1369 /// MachineBlockFrequencyInfo, and calculates the relative frequencies of
1370 /// blocks.
1371 ///
1372 /// LoopInfo defines a loop as a "non-trivial" SCC dominated by a single block,
1373 /// which is called the header.  A given loop, L, can have sub-loops, which are
1374 /// loops within the subgraph of L that exclude its header.  (A "trivial" SCC
1375 /// consists of a single block that does not have a self-edge.)
1376 ///
1377 /// In addition to loops, this algorithm has limited support for irreducible
1378 /// SCCs, which are SCCs with multiple entry blocks.  Irreducible SCCs are
1379 /// discovered on they fly, and modelled as loops with multiple headers.
1380 ///
1381 /// The headers of irreducible sub-SCCs consist of its entry blocks and all
1382 /// nodes that are targets of a backedge within it (excluding backedges within
1383 /// true sub-loops).  Block frequency calculations act as if a block is
1384 /// inserted that intercepts all the edges to the headers.  All backedges and
1385 /// entries point to this block.  Its successors are the headers, which split
1386 /// the frequency evenly.
1387 ///
1388 /// This algorithm leverages BlockMass and UnsignedFloat to maintain precision,
1389 /// separates mass distribution from loop scaling, and dithers to eliminate
1390 /// probability mass loss.
1391 ///
1392 /// The implementation is split between BlockFrequencyInfoImpl, which knows the
1393 /// type of graph being modelled (BasicBlock vs. MachineBasicBlock), and
1394 /// BlockFrequencyInfoImplBase, which doesn't.  The base class uses \a
1395 /// BlockNode, a wrapper around a uint32_t.  BlockNode is numbered from 0 in
1396 /// reverse-post order.  This gives two advantages:  it's easy to compare the
1397 /// relative ordering of two nodes, and maps keyed on BlockT can be represented
1398 /// by vectors.
1399 ///
1400 /// This algorithm is O(V+E), unless there is irreducible control flow, in
1401 /// which case it's O(V*E) in the worst case.
1402 ///
1403 /// These are the main stages:
1404 ///
1405 ///  0. Reverse post-order traversal (\a initializeRPOT()).
1406 ///
1407 ///     Run a single post-order traversal and save it (in reverse) in RPOT.
1408 ///     All other stages make use of this ordering.  Save a lookup from BlockT
1409 ///     to BlockNode (the index into RPOT) in Nodes.
1410 ///
1411 ///  1. Loop initialization (\a initializeLoops()).
1412 ///
1413 ///     Translate LoopInfo/MachineLoopInfo into a form suitable for the rest of
1414 ///     the algorithm.  In particular, store the immediate members of each loop
1415 ///     in reverse post-order.
1416 ///
1417 ///  2. Calculate mass and scale in loops (\a computeMassInLoops()).
1418 ///
1419 ///     For each loop (bottom-up), distribute mass through the DAG resulting
1420 ///     from ignoring backedges and treating sub-loops as a single pseudo-node.
1421 ///     Track the backedge mass distributed to the loop header, and use it to
1422 ///     calculate the loop scale (number of loop iterations).  Immediate
1423 ///     members that represent sub-loops will already have been visited and
1424 ///     packaged into a pseudo-node.
1425 ///
1426 ///     Distributing mass in a loop is a reverse-post-order traversal through
1427 ///     the loop.  Start by assigning full mass to the Loop header.  For each
1428 ///     node in the loop:
1429 ///
1430 ///         - Fetch and categorize the weight distribution for its successors.
1431 ///           If this is a packaged-subloop, the weight distribution is stored
1432 ///           in \a LoopData::Exits.  Otherwise, fetch it from
1433 ///           BranchProbabilityInfo.
1434 ///
1435 ///         - Each successor is categorized as \a Weight::Local, a local edge
1436 ///           within the current loop, \a Weight::Backedge, a backedge to the
1437 ///           loop header, or \a Weight::Exit, any successor outside the loop.
1438 ///           The weight, the successor, and its category are stored in \a
1439 ///           Distribution.  There can be multiple edges to each successor.
1440 ///
1441 ///         - If there's a backedge to a non-header, there's an irreducible SCC.
1442 ///           The usual flow is temporarily aborted.  \a
1443 ///           computeIrreducibleMass() finds the irreducible SCCs within the
1444 ///           loop, packages them up, and restarts the flow.
1445 ///
1446 ///         - Normalize the distribution:  scale weights down so that their sum
1447 ///           is 32-bits, and coalesce multiple edges to the same node.
1448 ///
1449 ///         - Distribute the mass accordingly, dithering to minimize mass loss,
1450 ///           as described in \a distributeMass().
1451 ///
1452 ///     Finally, calculate the loop scale from the accumulated backedge mass.
1453 ///
1454 ///  3. Distribute mass in the function (\a computeMassInFunction()).
1455 ///
1456 ///     Finally, distribute mass through the DAG resulting from packaging all
1457 ///     loops in the function.  This uses the same algorithm as distributing
1458 ///     mass in a loop, except that there are no exit or backedge edges.
1459 ///
1460 ///  4. Unpackage loops (\a unwrapLoops()).
1461 ///
1462 ///     Initialize each block's frequency to a floating point representation of
1463 ///     its mass.
1464 ///
1465 ///     Visit loops top-down, scaling the frequencies of its immediate members
1466 ///     by the loop's pseudo-node's frequency.
1467 ///
1468 ///  5. Convert frequencies to a 64-bit range (\a finalizeMetrics()).
1469 ///
1470 ///     Using the min and max frequencies as a guide, translate floating point
1471 ///     frequencies to an appropriate range in uint64_t.
1472 ///
1473 /// It has some known flaws.
1474 ///
1475 ///   - Loop scale is limited to 4096 per loop (2^12) to avoid exhausting
1476 ///     BlockFrequency's 64-bit integer precision.
1477 ///
1478 ///   - The model of irreducible control flow is a rough approximation.
1479 ///
1480 ///     Modelling irreducible control flow exactly involves setting up and
1481 ///     solving a group of infinite geometric series.  Such precision is
1482 ///     unlikely to be worthwhile, since most of our algorithms give up on
1483 ///     irreducible control flow anyway.
1484 ///
1485 ///     Nevertheless, we might find that we need to get closer.  Here's a sort
1486 ///     of TODO list for the model with diminishing returns, to be completed as
1487 ///     necessary.
1488 ///
1489 ///       - The headers for the \a LoopData representing an irreducible SCC
1490 ///         include non-entry blocks.  When these extra blocks exist, they
1491 ///         indicate a self-contained irreducible sub-SCC.  We could treat them
1492 ///         as sub-loops, rather than arbitrarily shoving the problematic
1493 ///         blocks into the headers of the main irreducible SCC.
1494 ///
1495 ///       - Backedge frequencies are assumed to be evenly split between the
1496 ///         headers of a given irreducible SCC.  Instead, we could track the
1497 ///         backedge mass separately for each header, and adjust their relative
1498 ///         frequencies.
1499 ///
1500 ///       - Entry frequencies are assumed to be evenly split between the
1501 ///         headers of a given irreducible SCC, which is the only option if we
1502 ///         need to compute mass in the SCC before its parent loop.  Instead,
1503 ///         we could partially compute mass in the parent loop, and stop when
1504 ///         we get to the SCC.  Here, we have the correct ratio of entry
1505 ///         masses, which we can use to adjust their relative frequencies.
1506 ///         Compute mass in the SCC, and then continue propagation in the
1507 ///         parent.
1508 ///
1509 ///       - We can propagate mass iteratively through the SCC, for some fixed
1510 ///         number of iterations.  Each iteration starts by assigning the entry
1511 ///         blocks their backedge mass from the prior iteration.  The final
1512 ///         mass for each block (and each exit, and the total backedge mass
1513 ///         used for computing loop scale) is the sum of all iterations.
1514 ///         (Running this until fixed point would "solve" the geometric
1515 ///         series by simulation.)
1516 template <class BT> class BlockFrequencyInfoImpl : BlockFrequencyInfoImplBase {
1517   typedef typename bfi_detail::TypeMap<BT>::BlockT BlockT;
1518   typedef typename bfi_detail::TypeMap<BT>::FunctionT FunctionT;
1519   typedef typename bfi_detail::TypeMap<BT>::BranchProbabilityInfoT
1520   BranchProbabilityInfoT;
1521   typedef typename bfi_detail::TypeMap<BT>::LoopT LoopT;
1522   typedef typename bfi_detail::TypeMap<BT>::LoopInfoT LoopInfoT;
1523
1524   typedef GraphTraits<const BlockT *> Successor;
1525   typedef GraphTraits<Inverse<const BlockT *>> Predecessor;
1526
1527   const BranchProbabilityInfoT *BPI;
1528   const LoopInfoT *LI;
1529   const FunctionT *F;
1530
1531   // All blocks in reverse postorder.
1532   std::vector<const BlockT *> RPOT;
1533   DenseMap<const BlockT *, BlockNode> Nodes;
1534
1535   typedef typename std::vector<const BlockT *>::const_iterator rpot_iterator;
1536
1537   rpot_iterator rpot_begin() const { return RPOT.begin(); }
1538   rpot_iterator rpot_end() const { return RPOT.end(); }
1539
1540   size_t getIndex(const rpot_iterator &I) const { return I - rpot_begin(); }
1541
1542   BlockNode getNode(const rpot_iterator &I) const {
1543     return BlockNode(getIndex(I));
1544   }
1545   BlockNode getNode(const BlockT *BB) const { return Nodes.lookup(BB); }
1546
1547   const BlockT *getBlock(const BlockNode &Node) const {
1548     assert(Node.Index < RPOT.size());
1549     return RPOT[Node.Index];
1550   }
1551
1552   /// \brief Run (and save) a post-order traversal.
1553   ///
1554   /// Saves a reverse post-order traversal of all the nodes in \a F.
1555   void initializeRPOT();
1556
1557   /// \brief Initialize loop data.
1558   ///
1559   /// Build up \a Loops using \a LoopInfo.  \a LoopInfo gives us a mapping from
1560   /// each block to the deepest loop it's in, but we need the inverse.  For each
1561   /// loop, we store in reverse post-order its "immediate" members, defined as
1562   /// the header, the headers of immediate sub-loops, and all other blocks in
1563   /// the loop that are not in sub-loops.
1564   void initializeLoops();
1565
1566   /// \brief Propagate to a block's successors.
1567   ///
1568   /// In the context of distributing mass through \c OuterLoop, divide the mass
1569   /// currently assigned to \c Node between its successors.
1570   ///
1571   /// \return \c true unless there's an irreducible backedge.
1572   bool propagateMassToSuccessors(LoopData *OuterLoop, const BlockNode &Node);
1573
1574   /// \brief Compute mass in a particular loop.
1575   ///
1576   /// Assign mass to \c Loop's header, and then for each block in \c Loop in
1577   /// reverse post-order, distribute mass to its successors.  Only visits nodes
1578   /// that have not been packaged into sub-loops.
1579   ///
1580   /// \pre \a computeMassInLoop() has been called for each subloop of \c Loop.
1581   /// \return \c true unless there's an irreducible backedge.
1582   bool computeMassInLoop(LoopData &Loop);
1583
1584   /// \brief Try to compute mass in the top-level function.
1585   ///
1586   /// Assign mass to the entry block, and then for each block in reverse
1587   /// post-order, distribute mass to its successors.  Skips nodes that have
1588   /// been packaged into loops.
1589   ///
1590   /// \pre \a computeMassInLoops() has been called.
1591   /// \return \c true unless there's an irreducible backedge.
1592   bool tryToComputeMassInFunction();
1593
1594   /// \brief Compute mass in (and package up) irreducible SCCs.
1595   ///
1596   /// Find the irreducible SCCs in \c OuterLoop, add them to \a Loops (in front
1597   /// of \c Insert), and call \a computeMassInLoop() on each of them.
1598   ///
1599   /// If \c OuterLoop is \c nullptr, it refers to the top-level function.
1600   ///
1601   /// \pre \a computeMassInLoop() has been called for each subloop of \c
1602   /// OuterLoop.
1603   /// \pre \c Insert points at the the last loop successfully processed by \a
1604   /// computeMassInLoop().
1605   /// \pre \c OuterLoop has irreducible SCCs.
1606   void computeIrreducibleMass(LoopData *OuterLoop,
1607                               std::list<LoopData>::iterator Insert);
1608
1609   /// \brief Compute mass in all loops.
1610   ///
1611   /// For each loop bottom-up, call \a computeMassInLoop().
1612   ///
1613   /// \a computeMassInLoop() aborts (and returns \c false) on loops that
1614   /// contain a irreducible sub-SCCs.  Use \a computeIrreducibleMass() and then
1615   /// re-enter \a computeMassInLoop().
1616   ///
1617   /// \post \a computeMassInLoop() has returned \c true for every loop.
1618   void computeMassInLoops();
1619
1620   /// \brief Compute mass in the top-level function.
1621   ///
1622   /// Uses \a tryToComputeMassInFunction() and \a computeIrreducibleMass() to
1623   /// compute mass in the top-level function.
1624   ///
1625   /// \post \a tryToComputeMassInFunction() has returned \c true.
1626   void computeMassInFunction();
1627
1628   std::string getBlockName(const BlockNode &Node) const override {
1629     return bfi_detail::getBlockName(getBlock(Node));
1630   }
1631
1632 public:
1633   const FunctionT *getFunction() const { return F; }
1634
1635   void doFunction(const FunctionT *F, const BranchProbabilityInfoT *BPI,
1636                   const LoopInfoT *LI);
1637   BlockFrequencyInfoImpl() : BPI(0), LI(0), F(0) {}
1638
1639   using BlockFrequencyInfoImplBase::getEntryFreq;
1640   BlockFrequency getBlockFreq(const BlockT *BB) const {
1641     return BlockFrequencyInfoImplBase::getBlockFreq(getNode(BB));
1642   }
1643   Float getFloatingBlockFreq(const BlockT *BB) const {
1644     return BlockFrequencyInfoImplBase::getFloatingBlockFreq(getNode(BB));
1645   }
1646
1647   /// \brief Print the frequencies for the current function.
1648   ///
1649   /// Prints the frequencies for the blocks in the current function.
1650   ///
1651   /// Blocks are printed in the natural iteration order of the function, rather
1652   /// than reverse post-order.  This provides two advantages:  writing -analyze
1653   /// tests is easier (since blocks come out in source order), and even
1654   /// unreachable blocks are printed.
1655   ///
1656   /// \a BlockFrequencyInfoImplBase::print() only knows reverse post-order, so
1657   /// we need to override it here.
1658   raw_ostream &print(raw_ostream &OS) const override;
1659   using BlockFrequencyInfoImplBase::dump;
1660
1661   using BlockFrequencyInfoImplBase::printBlockFreq;
1662   raw_ostream &printBlockFreq(raw_ostream &OS, const BlockT *BB) const {
1663     return BlockFrequencyInfoImplBase::printBlockFreq(OS, getNode(BB));
1664   }
1665 };
1666
1667 template <class BT>
1668 void BlockFrequencyInfoImpl<BT>::doFunction(const FunctionT *F,
1669                                             const BranchProbabilityInfoT *BPI,
1670                                             const LoopInfoT *LI) {
1671   // Save the parameters.
1672   this->BPI = BPI;
1673   this->LI = LI;
1674   this->F = F;
1675
1676   // Clean up left-over data structures.
1677   BlockFrequencyInfoImplBase::clear();
1678   RPOT.clear();
1679   Nodes.clear();
1680
1681   // Initialize.
1682   DEBUG(dbgs() << "\nblock-frequency: " << F->getName() << "\n================="
1683                << std::string(F->getName().size(), '=') << "\n");
1684   initializeRPOT();
1685   initializeLoops();
1686
1687   // Visit loops in post-order to find thelocal mass distribution, and then do
1688   // the full function.
1689   computeMassInLoops();
1690   computeMassInFunction();
1691   unwrapLoops();
1692   finalizeMetrics();
1693 }
1694
1695 template <class BT> void BlockFrequencyInfoImpl<BT>::initializeRPOT() {
1696   const BlockT *Entry = F->begin();
1697   RPOT.reserve(F->size());
1698   std::copy(po_begin(Entry), po_end(Entry), std::back_inserter(RPOT));
1699   std::reverse(RPOT.begin(), RPOT.end());
1700
1701   assert(RPOT.size() - 1 <= BlockNode::getMaxIndex() &&
1702          "More nodes in function than Block Frequency Info supports");
1703
1704   DEBUG(dbgs() << "reverse-post-order-traversal\n");
1705   for (rpot_iterator I = rpot_begin(), E = rpot_end(); I != E; ++I) {
1706     BlockNode Node = getNode(I);
1707     DEBUG(dbgs() << " - " << getIndex(I) << ": " << getBlockName(Node) << "\n");
1708     Nodes[*I] = Node;
1709   }
1710
1711   Working.reserve(RPOT.size());
1712   for (size_t Index = 0; Index < RPOT.size(); ++Index)
1713     Working.emplace_back(Index);
1714   Freqs.resize(RPOT.size());
1715 }
1716
1717 template <class BT> void BlockFrequencyInfoImpl<BT>::initializeLoops() {
1718   DEBUG(dbgs() << "loop-detection\n");
1719   if (LI->empty())
1720     return;
1721
1722   // Visit loops top down and assign them an index.
1723   std::deque<std::pair<const LoopT *, LoopData *>> Q;
1724   for (const LoopT *L : *LI)
1725     Q.emplace_back(L, nullptr);
1726   while (!Q.empty()) {
1727     const LoopT *Loop = Q.front().first;
1728     LoopData *Parent = Q.front().second;
1729     Q.pop_front();
1730
1731     BlockNode Header = getNode(Loop->getHeader());
1732     assert(Header.isValid());
1733
1734     Loops.emplace_back(Parent, Header);
1735     Working[Header.Index].Loop = &Loops.back();
1736     DEBUG(dbgs() << " - loop = " << getBlockName(Header) << "\n");
1737
1738     for (const LoopT *L : *Loop)
1739       Q.emplace_back(L, &Loops.back());
1740   }
1741
1742   // Visit nodes in reverse post-order and add them to their deepest containing
1743   // loop.
1744   for (size_t Index = 0; Index < RPOT.size(); ++Index) {
1745     // Loop headers have already been mostly mapped.
1746     if (Working[Index].isLoopHeader()) {
1747       LoopData *ContainingLoop = Working[Index].getContainingLoop();
1748       if (ContainingLoop)
1749         ContainingLoop->Nodes.push_back(Index);
1750       continue;
1751     }
1752
1753     const LoopT *Loop = LI->getLoopFor(RPOT[Index]);
1754     if (!Loop)
1755       continue;
1756
1757     // Add this node to its containing loop's member list.
1758     BlockNode Header = getNode(Loop->getHeader());
1759     assert(Header.isValid());
1760     const auto &HeaderData = Working[Header.Index];
1761     assert(HeaderData.isLoopHeader());
1762
1763     Working[Index].Loop = HeaderData.Loop;
1764     HeaderData.Loop->Nodes.push_back(Index);
1765     DEBUG(dbgs() << " - loop = " << getBlockName(Header)
1766                  << ": member = " << getBlockName(Index) << "\n");
1767   }
1768 }
1769
1770 template <class BT> void BlockFrequencyInfoImpl<BT>::computeMassInLoops() {
1771   // Visit loops with the deepest first, and the top-level loops last.
1772   for (auto L = Loops.rbegin(), E = Loops.rend(); L != E; ++L) {
1773     if (computeMassInLoop(*L))
1774       continue;
1775     auto Next = std::next(L);
1776     computeIrreducibleMass(&*L, L.base());
1777     L = std::prev(Next);
1778     if (computeMassInLoop(*L))
1779       continue;
1780     llvm_unreachable("unhandled irreducible control flow");
1781   }
1782 }
1783
1784 template <class BT>
1785 bool BlockFrequencyInfoImpl<BT>::computeMassInLoop(LoopData &Loop) {
1786   // Compute mass in loop.
1787   DEBUG(dbgs() << "compute-mass-in-loop: " << getLoopName(Loop) << "\n");
1788
1789   if (Loop.isIrreducible()) {
1790     BlockMass Remaining = BlockMass::getFull();
1791     for (uint32_t H = 0; H < Loop.NumHeaders; ++H) {
1792       auto &Mass = Working[Loop.Nodes[H].Index].getMass();
1793       Mass = Remaining * BranchProbability(1, Loop.NumHeaders - H);
1794       Remaining -= Mass;
1795     }
1796     for (const BlockNode &M : Loop.Nodes)
1797       if (!propagateMassToSuccessors(&Loop, M))
1798         llvm_unreachable("unhandled irreducible control flow");
1799   } else {
1800     Working[Loop.getHeader().Index].getMass() = BlockMass::getFull();
1801     if (!propagateMassToSuccessors(&Loop, Loop.getHeader()))
1802       llvm_unreachable("irreducible control flow to loop header!?");
1803     for (const BlockNode &M : Loop.members())
1804       if (!propagateMassToSuccessors(&Loop, M))
1805         // Irreducible backedge.
1806         return false;
1807   }
1808
1809   computeLoopScale(Loop);
1810   packageLoop(Loop);
1811   return true;
1812 }
1813
1814 template <class BT>
1815 bool BlockFrequencyInfoImpl<BT>::tryToComputeMassInFunction() {
1816   // Compute mass in function.
1817   DEBUG(dbgs() << "compute-mass-in-function\n");
1818   assert(!Working.empty() && "no blocks in function");
1819   assert(!Working[0].isLoopHeader() && "entry block is a loop header");
1820
1821   Working[0].getMass() = BlockMass::getFull();
1822   for (rpot_iterator I = rpot_begin(), IE = rpot_end(); I != IE; ++I) {
1823     // Check for nodes that have been packaged.
1824     BlockNode Node = getNode(I);
1825     if (Working[Node.Index].isPackaged())
1826       continue;
1827
1828     if (!propagateMassToSuccessors(nullptr, Node))
1829       return false;
1830   }
1831   return true;
1832 }
1833
1834 template <class BT> void BlockFrequencyInfoImpl<BT>::computeMassInFunction() {
1835   if (tryToComputeMassInFunction())
1836     return;
1837   computeIrreducibleMass(nullptr, Loops.begin());
1838   if (tryToComputeMassInFunction())
1839     return;
1840   llvm_unreachable("unhandled irreducible control flow");
1841 }
1842
1843 template <class BT>
1844 void BlockFrequencyInfoImpl<BT>::computeIrreducibleMass(
1845     LoopData *OuterLoop, std::list<LoopData>::iterator Insert) {
1846   DEBUG(dbgs() << "analyze-irreducible-in-";
1847         if (OuterLoop) dbgs() << "loop: " << getLoopName(*OuterLoop) << "\n";
1848         else dbgs() << "function\n");
1849
1850   using bfi_detail::IrreducibleGraph;
1851   auto addBlockEdges = [&](IrreducibleGraph &G, IrreducibleGraph::IrrNode &Irr,
1852                            const LoopData *OuterLoop) {
1853     const BlockT *BB = RPOT[Irr.Node.Index];
1854     for (auto I = Successor::child_begin(BB), E = Successor::child_end(BB);
1855          I != E; ++I)
1856       G.addEdge(Irr, getNode(*I), OuterLoop);
1857   };
1858   IrreducibleGraph G(*this, OuterLoop, addBlockEdges);
1859
1860   for (auto &L : analyzeIrreducible(G, OuterLoop, Insert))
1861     computeMassInLoop(L);
1862
1863   if (!OuterLoop)
1864     return;
1865   updateLoopWithIrreducible(*OuterLoop);
1866 }
1867
1868 template <class BT>
1869 bool
1870 BlockFrequencyInfoImpl<BT>::propagateMassToSuccessors(LoopData *OuterLoop,
1871                                                       const BlockNode &Node) {
1872   DEBUG(dbgs() << " - node: " << getBlockName(Node) << "\n");
1873   // Calculate probability for successors.
1874   Distribution Dist;
1875   if (auto *Loop = Working[Node.Index].getPackagedLoop()) {
1876     assert(Loop != OuterLoop && "Cannot propagate mass in a packaged loop");
1877     if (!addLoopSuccessorsToDist(OuterLoop, *Loop, Dist))
1878       // Irreducible backedge.
1879       return false;
1880   } else {
1881     const BlockT *BB = getBlock(Node);
1882     for (auto SI = Successor::child_begin(BB), SE = Successor::child_end(BB);
1883          SI != SE; ++SI)
1884       // Do not dereference SI, or getEdgeWeight() is linear in the number of
1885       // successors.
1886       if (!addToDist(Dist, OuterLoop, Node, getNode(*SI),
1887                      BPI->getEdgeWeight(BB, SI)))
1888         // Irreducible backedge.
1889         return false;
1890   }
1891
1892   // Distribute mass to successors, saving exit and backedge data in the
1893   // loop header.
1894   distributeMass(Node, OuterLoop, Dist);
1895   return true;
1896 }
1897
1898 template <class BT>
1899 raw_ostream &BlockFrequencyInfoImpl<BT>::print(raw_ostream &OS) const {
1900   if (!F)
1901     return OS;
1902   OS << "block-frequency-info: " << F->getName() << "\n";
1903   for (const BlockT &BB : *F)
1904     OS << " - " << bfi_detail::getBlockName(&BB)
1905        << ": float = " << getFloatingBlockFreq(&BB)
1906        << ", int = " << getBlockFreq(&BB).getFrequency() << "\n";
1907
1908   // Add an extra newline for readability.
1909   OS << "\n";
1910   return OS;
1911 }
1912 }
1913
1914 #undef DEBUG_TYPE
1915
1916 #endif