2014-04-11 23:20:58 +00:00
|
|
|
//===- BlockFrequencyInfo.h - Block Frequency Analysis ----------*- C++ -*-===//
|
2011-06-23 21:56:59 +00:00
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// Loops should be simplified before this analysis.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2011-07-25 19:25:40 +00:00
|
|
|
#ifndef LLVM_ANALYSIS_BLOCKFREQUENCYINFO_H
|
|
|
|
#define LLVM_ANALYSIS_BLOCKFREQUENCYINFO_H
|
2011-06-23 21:56:59 +00:00
|
|
|
|
|
|
|
#include "llvm/Pass.h"
|
2011-07-27 22:05:51 +00:00
|
|
|
#include "llvm/Support/BlockFrequency.h"
|
2011-06-23 21:56:59 +00:00
|
|
|
#include <climits>
|
|
|
|
|
|
|
|
namespace llvm {
|
|
|
|
|
|
|
|
class BranchProbabilityInfo;
|
2014-04-11 23:21:02 +00:00
|
|
|
template <class BlockT> class BlockFrequencyInfoImpl;
|
2011-06-23 21:56:59 +00:00
|
|
|
|
2014-04-11 23:20:58 +00:00
|
|
|
/// BlockFrequencyInfo pass uses BlockFrequencyInfoImpl implementation to
|
|
|
|
/// estimate IR basic block frequencies.
|
2011-07-25 19:25:40 +00:00
|
|
|
class BlockFrequencyInfo : public FunctionPass {
|
2014-04-11 23:21:02 +00:00
|
|
|
typedef BlockFrequencyInfoImpl<BasicBlock> ImplType;
|
2014-03-25 18:01:38 +00:00
|
|
|
std::unique_ptr<ImplType> BFI;
|
2011-06-23 21:56:59 +00:00
|
|
|
|
|
|
|
public:
|
|
|
|
static char ID;
|
|
|
|
|
2011-07-25 19:25:40 +00:00
|
|
|
BlockFrequencyInfo();
|
2011-06-23 21:56:59 +00:00
|
|
|
|
2011-07-25 19:25:40 +00:00
|
|
|
~BlockFrequencyInfo();
|
2011-06-23 21:56:59 +00:00
|
|
|
|
2014-03-05 07:30:04 +00:00
|
|
|
void getAnalysisUsage(AnalysisUsage &AU) const override;
|
2011-06-23 21:56:59 +00:00
|
|
|
|
2014-03-05 07:30:04 +00:00
|
|
|
bool runOnFunction(Function &F) override;
|
2014-03-25 18:01:38 +00:00
|
|
|
void releaseMemory() override;
|
2014-03-05 07:30:04 +00:00
|
|
|
void print(raw_ostream &O, const Module *M) const override;
|
2013-11-14 02:27:46 +00:00
|
|
|
const Function *getFunction() const;
|
|
|
|
void view() const;
|
2011-06-23 21:56:59 +00:00
|
|
|
|
2011-07-22 02:24:57 +00:00
|
|
|
/// getblockFreq - Return block frequency. Return 0 if we don't have the
|
2013-06-25 13:34:40 +00:00
|
|
|
/// information. Please note that initial frequency is equal to ENTRY_FREQ. It
|
|
|
|
/// means that we should not rely on the value itself, but only on the
|
|
|
|
/// comparison to the other block frequencies. We do this to avoid using of
|
|
|
|
/// floating points.
|
2011-12-20 20:03:10 +00:00
|
|
|
BlockFrequency getBlockFreq(const BasicBlock *BB) const;
|
2013-12-14 00:06:03 +00:00
|
|
|
|
|
|
|
// Print the block frequency Freq to OS using the current functions entry
|
|
|
|
// frequency to convert freq into a relative decimal form.
|
|
|
|
raw_ostream &printBlockFreq(raw_ostream &OS, const BlockFrequency Freq) const;
|
|
|
|
|
|
|
|
// Convenience method that attempts to look up the frequency associated with
|
|
|
|
// BB and print it to OS.
|
|
|
|
raw_ostream &printBlockFreq(raw_ostream &OS, const BasicBlock *BB) const;
|
|
|
|
|
2013-12-20 22:11:11 +00:00
|
|
|
uint64_t getEntryFreq() const;
|
|
|
|
|
2011-06-23 21:56:59 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif
|