1 //===-------------- lib/Support/BranchProbability.cpp -----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements Branch Probability class.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Support/BranchProbability.h"
15 #include "llvm/Config/llvm-config.h"
16 #include "llvm/Support/Debug.h"
17 #include "llvm/Support/Format.h"
18 #include "llvm/Support/raw_ostream.h"
23 const uint32_t BranchProbability::D;
25 raw_ostream &BranchProbability::print(raw_ostream &OS) const {
29 // Get a percentage rounded to two decimal digits. This avoids
30 // implementation-defined rounding inside printf.
31 double Percent = rint(((double)N / D) * 100.0 * 100.0) / 100.0;
32 return OS << format("0x%08" PRIx32 " / 0x%08" PRIx32 " = %.2f%%", N, D,
36 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
37 LLVM_DUMP_METHOD void BranchProbability::dump() const { print(dbgs()) << '\n'; }
40 BranchProbability::BranchProbability(uint32_t Numerator, uint32_t Denominator) {
41 assert(Denominator > 0 && "Denominator cannot be 0!");
42 assert(Numerator <= Denominator && "Probability cannot be bigger than 1!");
47 (Numerator * static_cast<uint64_t>(D) + Denominator / 2) / Denominator;
48 N = static_cast<uint32_t>(Prob64);
53 BranchProbability::getBranchProbability(uint64_t Numerator,
54 uint64_t Denominator) {
55 assert(Numerator <= Denominator && "Probability cannot be bigger than 1!");
56 // Scale down Denominator to fit in a 32-bit integer.
58 while (Denominator > UINT32_MAX) {
62 return BranchProbability(Numerator >> Scale, Denominator);
65 // If ConstD is not zero, then replace D by ConstD so that division and modulo
66 // operations by D can be optimized, in case this function is not inlined by the
68 template <uint32_t ConstD>
69 static uint64_t scale(uint64_t Num, uint32_t N, uint32_t D) {
73 assert(D && "divide by 0");
75 // Fast path for multiplying by 1.0.
79 // Split Num into upper and lower parts to multiply, then recombine.
80 uint64_t ProductHigh = (Num >> 32) * N;
81 uint64_t ProductLow = (Num & UINT32_MAX) * N;
83 // Split into 32-bit digits.
84 uint32_t Upper32 = ProductHigh >> 32;
85 uint32_t Lower32 = ProductLow & UINT32_MAX;
86 uint32_t Mid32Partial = ProductHigh & UINT32_MAX;
87 uint32_t Mid32 = Mid32Partial + (ProductLow >> 32);
90 Upper32 += Mid32 < Mid32Partial;
92 // Check for overflow.
96 uint64_t Rem = (uint64_t(Upper32) << 32) | Mid32;
97 uint64_t UpperQ = Rem / D;
99 // Check for overflow.
100 if (UpperQ > UINT32_MAX)
103 Rem = ((Rem % D) << 32) | Lower32;
104 uint64_t LowerQ = Rem / D;
105 uint64_t Q = (UpperQ << 32) + LowerQ;
107 // Check for overflow.
108 return Q < LowerQ ? UINT64_MAX : Q;
111 uint64_t BranchProbability::scale(uint64_t Num) const {
112 return ::scale<D>(Num, N, D);
115 uint64_t BranchProbability::scaleByInverse(uint64_t Num) const {
116 return ::scale<0>(Num, D, N);