Home | History | Annotate | Download | only in Support
      1 //===-------- BlockFrequency.h - Block Frequency Wrapper --------*- 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 // This file implements Block Frequency class.
     11 //
     12 //===----------------------------------------------------------------------===//
     13 
     14 #ifndef LLVM_SUPPORT_BLOCKFREQUENCY_H
     15 #define LLVM_SUPPORT_BLOCKFREQUENCY_H
     16 
     17 #include "llvm/Support/DataTypes.h"
     18 
     19 namespace llvm {
     20 
     21 class raw_ostream;
     22 class BranchProbability;
     23 
     24 // This class represents Block Frequency as a 64-bit value.
     25 class BlockFrequency {
     26 
     27   uint64_t Frequency;
     28   static const int64_t ENTRY_FREQ = 1024;
     29 
     30 public:
     31   BlockFrequency(uint64_t Freq = 0) : Frequency(Freq) { }
     32 
     33   static uint64_t getEntryFrequency() { return ENTRY_FREQ; }
     34   uint64_t getFrequency() const { return Frequency; }
     35 
     36   BlockFrequency &operator*=(const BranchProbability &Prob);
     37   const BlockFrequency operator*(const BranchProbability &Prob) const;
     38 
     39   BlockFrequency &operator+=(const BlockFrequency &Freq);
     40   const BlockFrequency operator+(const BlockFrequency &Freq) const;
     41 
     42   bool operator<(const BlockFrequency &RHS) const {
     43     return Frequency < RHS.Frequency;
     44   }
     45 
     46   bool operator<=(const BlockFrequency &RHS) const {
     47     return Frequency <= RHS.Frequency;
     48   }
     49 
     50   bool operator>(const BlockFrequency &RHS) const {
     51     return Frequency > RHS.Frequency;
     52   }
     53 
     54   bool operator>=(const BlockFrequency &RHS) const {
     55     return Frequency >= RHS.Frequency;
     56   }
     57 
     58   void print(raw_ostream &OS) const;
     59 };
     60 
     61 raw_ostream &operator<<(raw_ostream &OS, const BlockFrequency &Freq);
     62 
     63 }
     64 
     65 #endif
     66