shylie/llvm-project
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[InlineAdvisor] Update documentation for PluginInlineAdvisorAnalysis (NFC). (#116715)

Browse Source 
This commit updates the documentation for `PluginInlineAdvisorAnalysis`
based on the feedback in PR#114615 suggesting that
`registerAnalysisRegistrationCallback` should be the preferred method to
register the plugin inline advisor analysis.
This commit is contained in:
Michele Scandale 2024-11-19 09:53:07 -08:00 committed by GitHub
parent 197e0125c3
commit c84a99dfd3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 14 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
llvm/include/llvm/Analysis/InlineAdvisor.h
View File

@ -247,37 +247,30 @@ private:
///
/// namespace {
///
/// InlineAdvisor *defaultAdvisorFactory(Module &M, FunctionAnalysisManager
/// &FAM,
/// InlineParams Params, InlineContext IC)
/// {
/// InlineAdvisor *defaultAdvisorFactory(Module &M,
/// FunctionAnalysisManager &FAM,
/// InlineParams Params,
/// InlineContext IC) {
/// return new DefaultInlineAdvisor(M, FAM, Params, IC);
/// }
///
/// struct DefaultDynamicAdvisor : PassInfoMixin<DefaultDynamicAdvisor> {
/// PreservedAnalyses run(Module &, ModuleAnalysisManager &MAM) {
/// PluginInlineAdvisorAnalysis PA(defaultAdvisorFactory);
/// MAM.registerPass([&] { return PA; });
/// return PreservedAnalyses::all();
/// }
/// };
///
/// } // namespace
///
/// extern "C" LLVM_ATTRIBUTE_WEAK ::llvm::PassPluginLibraryInfo
/// llvmGetPassPluginInfo() {
/// return {LLVM_PLUGIN_API_VERSION, "DynamicDefaultAdvisor",
/// LLVM_VERSION_STRING,
/// LLVM_VERSION_STRING,
/// [](PassBuilder &PB) {
/// PB.registerPipelineStartEPCallback(
/// [](ModulePassManager &MPM, OptimizationLevel Level) {
/// MPM.addPass(DefaultDynamicAdvisor());
/// PB.registerAnalysisRegistrationCallback(
/// [](ModuleAnalysisManager &MAM) {
/// PluginInlineAdvisorAnalysis PA(defaultAdvisorFactory);
/// MAM.registerPass([&] { return PA; });
/// });
/// }};
/// }
///
/// A plugin must implement an AdvisorFactory and register it with a
/// PluginInlineAdvisorAnlysis to the provided ModuleanAlysisManager.
/// PluginInlineAdvisorAnlysis to the provided ModuleAnalysisManager.
///
/// If such a plugin has been registered
/// InlineAdvisorAnalysis::Result::tryCreate will return the dynamically loaded

24
llvm/unittests/Analysis/InlineAdvisorPlugin/InlineAdvisorPlugin.cpp
View File

@ -17,32 +17,16 @@ InlineAdvisor *DefaultAdvisorFactory(Module &M, FunctionAnalysisManager &FAM,
return new DefaultInlineAdvisor(M, FAM, Params, IC);
}
struct DefaultDynamicAdvisor : PassInfoMixin<DefaultDynamicAdvisor> {
PreservedAnalyses run(Module &M, ModuleAnalysisManager &MAM) {
PluginInlineAdvisorAnalysis DA(DefaultAdvisorFactory);
MAM.registerPass([&] { return DA; });
return PreservedAnalyses::all();
}
};
} // namespace
/* New PM Registration */
llvm::PassPluginLibraryInfo getDefaultDynamicAdvisorPluginInfo() {
return {LLVM_PLUGIN_API_VERSION, "DynamicDefaultAdvisor", LLVM_VERSION_STRING,
[](PassBuilder &PB) {
PB.registerPipelineStartEPCallback(
[](ModulePassManager &MPM, OptimizationLevel Level) {
MPM.addPass(DefaultDynamicAdvisor());
});
PB.registerPipelineParsingCallback(
[](StringRef Name, ModulePassManager &PM,
ArrayRef<PassBuilder::PipelineElement> InnerPipeline) {
if (Name == "dynamic-inline-advisor") {
PM.addPass(DefaultDynamicAdvisor());
return true;
}
return false;
PB.registerAnalysisRegistrationCallback(
[](ModuleAnalysisManager &MAM) {
PluginInlineAdvisorAnalysis PA(DefaultAdvisorFactory);
MAM.registerPass([&] { return PA; });
});
}};
}

2
llvm/unittests/Analysis/PluginInlineAdvisorAnalysisTest.cpp
View File

@ -66,8 +66,6 @@ struct CompilerInstance {
Expected<PassPlugin> Plugin = PassPlugin::Load(PluginPath);
ASSERT_TRUE(!!Plugin) << "Plugin path: " << PluginPath;
Plugin->registerPassBuilderCallbacks(PB);
ASSERT_THAT_ERROR(PB.parsePassPipeline(MPM, "dynamic-inline-advisor"),
Succeeded());
}
// connect the FooOnlyInlineAdvisor to our compiler instance