blob: 1572a49e3384396f25f37aae09e5362897b34b95 [file] [log] [blame]
//===- ModuleSummaryAnalysis.h - Module summary index builder ---*- C++ -*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
/// \file
/// This is the interface to build a ModuleSummaryIndex for a module.
#include "llvm/ADT/Optional.h"
#include "llvm/IR/ModuleSummaryIndex.h"
#include "llvm/IR/PassManager.h"
#include "llvm/Pass.h"
#include <functional>
namespace llvm {
class BlockFrequencyInfo;
class Function;
class Module;
class ProfileSummaryInfo;
/// Direct function to compute a \c ModuleSummaryIndex from a given module.
/// If operating within a pass manager which has defined ways to compute the \c
/// BlockFrequencyInfo for a given function, that can be provided via
/// a std::function callback. Otherwise, this routine will manually construct
/// that information.
ModuleSummaryIndex buildModuleSummaryIndex(
const Module &M,
std::function<BlockFrequencyInfo *(const Function &F)> GetBFICallback,
ProfileSummaryInfo *PSI);
/// Analysis pass to provide the ModuleSummaryIndex object.
class ModuleSummaryIndexAnalysis
: public AnalysisInfoMixin<ModuleSummaryIndexAnalysis> {
friend AnalysisInfoMixin<ModuleSummaryIndexAnalysis>;
static AnalysisKey Key;
using Result = ModuleSummaryIndex;
Result run(Module &M, ModuleAnalysisManager &AM);
/// Legacy wrapper pass to provide the ModuleSummaryIndex object.
class ModuleSummaryIndexWrapperPass : public ModulePass {
Optional<ModuleSummaryIndex> Index;
static char ID;
/// Get the index built by pass
ModuleSummaryIndex &getIndex() { return *Index; }
const ModuleSummaryIndex &getIndex() const { return *Index; }
bool runOnModule(Module &M) override;
bool doFinalization(Module &M) override;
void getAnalysisUsage(AnalysisUsage &AU) const override;
// createModuleSummaryIndexWrapperPass - This pass builds a ModuleSummaryIndex
// object for the module, to be written to bitcode or LLVM assembly.
ModulePass *createModuleSummaryIndexWrapperPass();
} // end namespace llvm