blob: 4304a253b287c29fdd5091a38f11050fa0e00712 [file] [log] [blame]
//===-------- BlockFrequency.h - Block Frequency Wrapper --------*- C++ -*-===//
// The LLVM Compiler Infrastructure
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
// This file implements Block Frequency class.
#include "llvm/Support/DataTypes.h"
namespace llvm {
class raw_ostream;
class BranchProbability;
// This class represents Block Frequency as a 64-bit value.
class BlockFrequency {
uint64_t Frequency;
BlockFrequency(uint64_t Freq = 0) : Frequency(Freq) { }
/// \brief Returns the maximum possible frequency, the saturation value.
static uint64_t getMaxFrequency() { return -1ULL; }
/// \brief Returns the frequency as a fixpoint number scaled by the entry
/// frequency.
uint64_t getFrequency() const { return Frequency; }
/// \brief Multiplies with a branch probability. The computation will never
/// overflow.
BlockFrequency &operator*=(const BranchProbability &Prob);
const BlockFrequency operator*(const BranchProbability &Prob) const;
/// \brief Divide by a non-zero branch probability using saturating
/// arithmetic.
BlockFrequency &operator/=(const BranchProbability &Prob);
BlockFrequency operator/(const BranchProbability &Prob) const;
/// \brief Adds another block frequency using saturating arithmetic.
BlockFrequency &operator+=(const BlockFrequency &Freq);
const BlockFrequency operator+(const BlockFrequency &Freq) const;
/// \brief Shift block frequency to the right by count digits saturating to 1.
BlockFrequency &operator>>=(const unsigned count);
bool operator<(const BlockFrequency &RHS) const {
return Frequency < RHS.Frequency;
bool operator<=(const BlockFrequency &RHS) const {
return Frequency <= RHS.Frequency;
bool operator>(const BlockFrequency &RHS) const {
return Frequency > RHS.Frequency;
bool operator>=(const BlockFrequency &RHS) const {
return Frequency >= RHS.Frequency;