mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-25 20:23:11 +01:00
112 lines
3.5 KiB
C++
112 lines
3.5 KiB
C++
//===- llvm/Analysis/ProfileSummaryInfo.h - profile summary ---*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file contains a pass that provides access to profile summary
|
|
// information.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_ANALYSIS_PROFILE_SUMMARY_INFO_H
|
|
#define LLVM_ANALYSIS_PROFILE_SUMMARY_INFO_H
|
|
|
|
#include "llvm/ADT/ArrayRef.h"
|
|
#include "llvm/ADT/DenseMap.h"
|
|
#include "llvm/ADT/SmallSet.h"
|
|
#include "llvm/IR/Function.h"
|
|
#include "llvm/IR/Instructions.h"
|
|
#include "llvm/IR/PassManager.h"
|
|
#include "llvm/IR/ProfileSummary.h"
|
|
#include "llvm/IR/ValueHandle.h"
|
|
#include "llvm/Pass.h"
|
|
#include <memory>
|
|
|
|
namespace llvm {
|
|
class ProfileSummary;
|
|
/// \brief Analysis providing profile information.
|
|
///
|
|
/// This is an immutable analysis pass that provides ability to query global
|
|
/// (program-level) profile information. The main APIs are isHotCount and
|
|
/// isColdCount that tells whether a given profile count is considered hot/cold
|
|
/// based on the profile summary. This also provides convenience methods to
|
|
/// check whether a function is hot or cold.
|
|
|
|
// FIXME: Provide convenience methods to determine hotness/coldness of other IR
|
|
// units. This would require making this depend on BFI.
|
|
class ProfileSummaryInfo {
|
|
private:
|
|
Module &M;
|
|
std::unique_ptr<ProfileSummary> Summary;
|
|
void computeSummary();
|
|
void computeThresholds();
|
|
// Count thresholds to answer isHotCount and isColdCount queries.
|
|
Optional<uint64_t> HotCountThreshold, ColdCountThreshold;
|
|
|
|
public:
|
|
ProfileSummaryInfo(Module &M) : M(M) {}
|
|
/// \brief Returns true if \p F is a hot function.
|
|
bool isHotFunction(const Function *F);
|
|
/// \brief Returns true if \p F is a cold function.
|
|
bool isColdFunction(const Function *F);
|
|
/// \brief Returns true if count \p C is considered hot.
|
|
bool isHotCount(uint64_t C);
|
|
/// \brief Returns true if count \p C is considered cold.
|
|
bool isColdCount(uint64_t C);
|
|
};
|
|
|
|
/// An analysis pass based on legacy pass manager to deliver ProfileSummaryInfo.
|
|
class ProfileSummaryInfoWrapperPass : public ImmutablePass {
|
|
std::unique_ptr<ProfileSummaryInfo> PSI;
|
|
|
|
public:
|
|
static char ID;
|
|
ProfileSummaryInfoWrapperPass();
|
|
|
|
ProfileSummaryInfo *getPSI(Module &M);
|
|
void getAnalysisUsage(AnalysisUsage &AU) const override {
|
|
AU.setPreservesAll();
|
|
}
|
|
};
|
|
|
|
/// An analysis pass based on the new PM to deliver ProfileSummaryInfo.
|
|
class ProfileSummaryAnalysis
|
|
: public AnalysisInfoMixin<ProfileSummaryAnalysis> {
|
|
public:
|
|
typedef ProfileSummaryInfo Result;
|
|
|
|
ProfileSummaryAnalysis() {}
|
|
ProfileSummaryAnalysis(const ProfileSummaryAnalysis &Arg) {}
|
|
ProfileSummaryAnalysis(ProfileSummaryAnalysis &&Arg) {}
|
|
ProfileSummaryAnalysis &operator=(const ProfileSummaryAnalysis &RHS) {
|
|
return *this;
|
|
}
|
|
ProfileSummaryAnalysis &operator=(ProfileSummaryAnalysis &&RHS) {
|
|
return *this;
|
|
}
|
|
|
|
Result run(Module &M);
|
|
|
|
private:
|
|
friend AnalysisInfoMixin<ProfileSummaryAnalysis>;
|
|
static char PassID;
|
|
};
|
|
|
|
/// \brief Printer pass that uses \c ProfileSummaryAnalysis.
|
|
class ProfileSummaryPrinterPass
|
|
: public PassInfoMixin<ProfileSummaryPrinterPass> {
|
|
raw_ostream &OS;
|
|
|
|
public:
|
|
explicit ProfileSummaryPrinterPass(raw_ostream &OS) : OS(OS) {}
|
|
PreservedAnalyses run(Module &M, AnalysisManager<Module> &AM);
|
|
};
|
|
|
|
} // end namespace llvm
|
|
|
|
#endif
|