1 //===-------- BlockFrequency.h - Block Frequency Wrapper --------*- 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 Block Frequency class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_SUPPORT_BLOCKFREQUENCY_H
15 #define LLVM_SUPPORT_BLOCKFREQUENCY_H
17 #include "llvm/Support/DataTypes.h"
22 class BranchProbability;
24 // This class represents Block Frequency as a 64-bit value.
25 class BlockFrequency {
28 static const int64_t ENTRY_FREQ = 1024;
31 BlockFrequency(uint64_t Freq = 0) : Frequency(Freq) { }
33 /// \brief Returns the frequency of the entry block of the function.
34 static uint64_t getEntryFrequency() { return ENTRY_FREQ; }
36 /// \brief Returns the frequency as a fixpoint number scaled by the entry
38 uint64_t getFrequency() const { return Frequency; }
40 /// \brief Multiplies with a branch probability. The computation will never
42 BlockFrequency &operator*=(const BranchProbability &Prob);
43 const BlockFrequency operator*(const BranchProbability &Prob) const;
45 /// \brief Adds another block frequency using saturating arithmetic.
46 BlockFrequency &operator+=(const BlockFrequency &Freq);
47 const BlockFrequency operator+(const BlockFrequency &Freq) const;
49 bool operator<(const BlockFrequency &RHS) const {
50 return Frequency < RHS.Frequency;
53 bool operator<=(const BlockFrequency &RHS) const {
54 return Frequency <= RHS.Frequency;
57 bool operator>(const BlockFrequency &RHS) const {
58 return Frequency > RHS.Frequency;
61 bool operator>=(const BlockFrequency &RHS) const {
62 return Frequency >= RHS.Frequency;
65 void print(raw_ostream &OS) const;
68 raw_ostream &operator<<(raw_ostream &OS, const BlockFrequency &Freq);