[ctxprof] Override type of instrumentation if `-profile-context-root` is specified #128940

mtrofin · 2025-02-26T20:06:03Z

This patch makes it easy to enable ctxprof instrumentation for targets where the build has a bunch of defaults for instrumented PGO that we want to inherit for ctxprof.

This is switching experimental defaults: we'll eventually enable ctxprof instrumentation through PGOOpt but that type is currently quite entangled and, for the time being, no point adding to that.

mtrofin · 2025-02-26T20:06:21Z

This stack of pull requests is managed by Graphite. Learn more about stacking.

teresajohnson

Changes looks ok but needs a test.

llvmbot · 2025-02-26T21:54:35Z

@llvm/pr-subscribers-llvm-transforms

Author: Mircea Trofin (mtrofin)

Changes

This patch makes it easy to enable ctxprof instrumentation for targets where the build has a bunch of defaults for instrumented PGO that we want to inherit for ctxprof.

This is switching experimental defaults: we'll eventually enable ctxprof instrumentation through PGOOpt but that type is currently quite entangled and, for the time being, no point adding to that.

Full diff: https://github.com/llvm/llvm-project/pull/128940.diff

2 Files Affected:

(modified) llvm/lib/Passes/PassBuilderPipelines.cpp (+4-4)
(added) llvm/test/Transforms/PGOProfile/ctx-instrumentation-optin.ll (+14)

diff --git a/llvm/lib/Passes/PassBuilderPipelines.cpp b/llvm/lib/Passes/PassBuilderPipelines.cpp
index d4c3fe9562f9e..546a5eb1ec283 100644
--- a/llvm/lib/Passes/PassBuilderPipelines.cpp
+++ b/llvm/lib/Passes/PassBuilderPipelines.cpp
@@ -1206,7 +1206,10 @@ PassBuilder::buildModuleSimplificationPipeline(OptimizationLevel Level,
 
   // We already asserted this happens in non-FullLTOPostLink earlier.
   const bool IsPreLink = Phase != ThinOrFullLTOPhase::ThinLTOPostLink;
-  const bool IsPGOPreLink = PGOOpt && IsPreLink;
+  // Enable contextual profiling instrumentation.
+  const bool IsCtxProfGen =
+      IsPreLink && PGOCtxProfLoweringPass::isCtxIRPGOInstrEnabled();
+  const bool IsPGOPreLink = !IsCtxProfGen && PGOOpt && IsPreLink;
   const bool IsPGOInstrGen =
       IsPGOPreLink && PGOOpt->Action == PGOOptions::IRInstr;
   const bool IsPGOInstrUse =
@@ -1217,9 +1220,6 @@ PassBuilder::buildModuleSimplificationPipeline(OptimizationLevel Level,
   assert(!(IsPGOInstrGen && PGOCtxProfLoweringPass::isCtxIRPGOInstrEnabled()) &&
          "Enabling both instrumented PGO and contextual instrumentation is not "
          "supported.");
-  // Enable contextual profiling instrumentation.
-  const bool IsCtxProfGen = !IsPGOInstrGen && IsPreLink &&
-                            PGOCtxProfLoweringPass::isCtxIRPGOInstrEnabled();
   const bool IsCtxProfUse =
       !UseCtxProfile.empty() && Phase == ThinOrFullLTOPhase::ThinLTOPreLink;
 
diff --git a/llvm/test/Transforms/PGOProfile/ctx-instrumentation-optin.ll b/llvm/test/Transforms/PGOProfile/ctx-instrumentation-optin.ll
new file mode 100644
index 0000000000000..5231007803433
--- /dev/null
+++ b/llvm/test/Transforms/PGOProfile/ctx-instrumentation-optin.ll
@@ -0,0 +1,14 @@
+; RUN: opt -O2 -debug-pass-manager -S -pgo-kind=pgo-instr-gen-pipeline -profile-file='temp' \
+; RUN:  < %s  2>&1 | FileCheck %s --check-prefixes=COMMON,PGO
+; RUN: opt -O2 -debug-pass-manager -S -pgo-kind=pgo-instr-gen-pipeline -profile-file='temp' \
+; RUN:  -profile-context-root=something < %s 2>&1 | FileCheck %s --check-prefixes=COMMON,CTXPROF
+
+; COMMON:   Running pass: PGOInstrumentationGen
+; COMMON:   Invalidating analysis: InnerAnalysisManagerProxy<FunctionAnalysisManager, Module>
+; COMMON:   Invalidating analysis: LazyCallGraphAnalysis
+; COMMON:   Invalidating analysis: InnerAnalysisManagerProxy<CGSCCAnalysisManager, Module>
+; CTXPROF:  Running pass: AssignGUIDPass
+; CTXPROF:  Running pass: NoinlineNonPrevailing on [module]
+; COMMON:   Running analysis: InnerAnalysisManagerProxy<FunctionAnalysisManager, Module>
+; PGO:      Running pass: InstrProfilingLoweringPass
+; CTXPROF:  Running pass: PGOCtxProfLoweringPass on [module]
\ No newline at end of file

llvmbot · 2025-02-26T21:54:36Z

@llvm/pr-subscribers-pgo

Author: Mircea Trofin (mtrofin)

Changes

This patch makes it easy to enable ctxprof instrumentation for targets where the build has a bunch of defaults for instrumented PGO that we want to inherit for ctxprof.

This is switching experimental defaults: we'll eventually enable ctxprof instrumentation through PGOOpt but that type is currently quite entangled and, for the time being, no point adding to that.

Full diff: https://github.com/llvm/llvm-project/pull/128940.diff

2 Files Affected:

(modified) llvm/lib/Passes/PassBuilderPipelines.cpp (+4-4)
(added) llvm/test/Transforms/PGOProfile/ctx-instrumentation-optin.ll (+14)

diff --git a/llvm/lib/Passes/PassBuilderPipelines.cpp b/llvm/lib/Passes/PassBuilderPipelines.cpp
index d4c3fe9562f9e..546a5eb1ec283 100644
--- a/llvm/lib/Passes/PassBuilderPipelines.cpp
+++ b/llvm/lib/Passes/PassBuilderPipelines.cpp
@@ -1206,7 +1206,10 @@ PassBuilder::buildModuleSimplificationPipeline(OptimizationLevel Level,
 
   // We already asserted this happens in non-FullLTOPostLink earlier.
   const bool IsPreLink = Phase != ThinOrFullLTOPhase::ThinLTOPostLink;
-  const bool IsPGOPreLink = PGOOpt && IsPreLink;
+  // Enable contextual profiling instrumentation.
+  const bool IsCtxProfGen =
+      IsPreLink && PGOCtxProfLoweringPass::isCtxIRPGOInstrEnabled();
+  const bool IsPGOPreLink = !IsCtxProfGen && PGOOpt && IsPreLink;
   const bool IsPGOInstrGen =
       IsPGOPreLink && PGOOpt->Action == PGOOptions::IRInstr;
   const bool IsPGOInstrUse =
@@ -1217,9 +1220,6 @@ PassBuilder::buildModuleSimplificationPipeline(OptimizationLevel Level,
   assert(!(IsPGOInstrGen && PGOCtxProfLoweringPass::isCtxIRPGOInstrEnabled()) &&
          "Enabling both instrumented PGO and contextual instrumentation is not "
          "supported.");
-  // Enable contextual profiling instrumentation.
-  const bool IsCtxProfGen = !IsPGOInstrGen && IsPreLink &&
-                            PGOCtxProfLoweringPass::isCtxIRPGOInstrEnabled();
   const bool IsCtxProfUse =
       !UseCtxProfile.empty() && Phase == ThinOrFullLTOPhase::ThinLTOPreLink;
 
diff --git a/llvm/test/Transforms/PGOProfile/ctx-instrumentation-optin.ll b/llvm/test/Transforms/PGOProfile/ctx-instrumentation-optin.ll
new file mode 100644
index 0000000000000..5231007803433
--- /dev/null
+++ b/llvm/test/Transforms/PGOProfile/ctx-instrumentation-optin.ll
@@ -0,0 +1,14 @@
+; RUN: opt -O2 -debug-pass-manager -S -pgo-kind=pgo-instr-gen-pipeline -profile-file='temp' \
+; RUN:  < %s  2>&1 | FileCheck %s --check-prefixes=COMMON,PGO
+; RUN: opt -O2 -debug-pass-manager -S -pgo-kind=pgo-instr-gen-pipeline -profile-file='temp' \
+; RUN:  -profile-context-root=something < %s 2>&1 | FileCheck %s --check-prefixes=COMMON,CTXPROF
+
+; COMMON:   Running pass: PGOInstrumentationGen
+; COMMON:   Invalidating analysis: InnerAnalysisManagerProxy<FunctionAnalysisManager, Module>
+; COMMON:   Invalidating analysis: LazyCallGraphAnalysis
+; COMMON:   Invalidating analysis: InnerAnalysisManagerProxy<CGSCCAnalysisManager, Module>
+; CTXPROF:  Running pass: AssignGUIDPass
+; CTXPROF:  Running pass: NoinlineNonPrevailing on [module]
+; COMMON:   Running analysis: InnerAnalysisManagerProxy<FunctionAnalysisManager, Module>
+; PGO:      Running pass: InstrProfilingLoweringPass
+; CTXPROF:  Running pass: PGOCtxProfLoweringPass on [module]
\ No newline at end of file

mtrofin · 2025-02-26T21:57:58Z

Changes looks ok but needs a test.

Yup, done.

teresajohnson

lgtm

… is specified

mtrofin · 2025-02-27T03:55:10Z

Merge activity

Feb 26, 10:55 PM EST: A user started a stack merge that includes this pull request via Graphite.
Feb 26, 10:57 PM EST: A user merged this pull request with Graphite.

llvm-ci · 2025-02-27T04:03:56Z

LLVM Buildbot has detected a new failure on builder clang-debian-cpp20 running on clang-debian-cpp20 while building llvm at step 2 "checkout".

Full details are available at: https://lab.llvm.org/buildbot/#/builders/108/builds/9775

Here is the relevant piece of the build log for the reference

Step 2 (checkout) failure: update (failure)
git version 2.43.0
fatal: unable to access 'https://github.com/llvm/llvm-project.git/': Could not resolve host: github.com
fatal: unable to access 'https://github.com/llvm/llvm-project.git/': Could not resolve host: github.com

… is specified (llvm#128940) This patch makes it easy to enable ctxprof instrumentation for targets where the build has a bunch of defaults for instrumented PGO that we want to inherit for ctxprof. This is switching experimental defaults: we'll eventually enable ctxprof instrumentation through `PGOOpt` but that type is currently quite entangled and, for the time being, no point adding to that.

mtrofin requested a review from teresajohnson February 26, 2025 20:09

mtrofin marked this pull request as ready for review February 26, 2025 20:09

teresajohnson reviewed Feb 26, 2025

View reviewed changes

mtrofin force-pushed the users/mtrofin/02-26-_ctxprof_override_type_of_instrumentation_if_-profile-context-root_is_specified branch from aa7a62f to e773265 Compare February 26, 2025 21:54

llvmbot added PGO Profile Guided Optimizations llvm:transforms labels Feb 26, 2025

mtrofin force-pushed the users/mtrofin/02-26-_ctxprof_override_type_of_instrumentation_if_-profile-context-root_is_specified branch from e773265 to 68811b9 Compare February 26, 2025 21:58

teresajohnson approved these changes Feb 26, 2025

View reviewed changes

[ctxprof] Override type of instrumentation if -profile-context-root…

14a6958

… is specified

mtrofin force-pushed the users/mtrofin/02-26-_ctxprof_override_type_of_instrumentation_if_-profile-context-root_is_specified branch from 68811b9 to 14a6958 Compare February 27, 2025 01:00

mtrofin merged commit eb1c3ac into main Feb 27, 2025
11 checks passed

mtrofin deleted the users/mtrofin/02-26-_ctxprof_override_type_of_instrumentation_if_-profile-context-root_is_specified branch February 27, 2025 03:57

huaatian mentioned this pull request Feb 28, 2025

fix live interval empty issue huaatian/llvm-project#1

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[ctxprof] Override type of instrumentation if `-profile-context-root` is specified #128940

[ctxprof] Override type of instrumentation if `-profile-context-root` is specified #128940

Uh oh!

mtrofin commented Feb 26, 2025 •

edited

Loading

Uh oh!

mtrofin commented Feb 26, 2025

Uh oh!

teresajohnson left a comment

Uh oh!

llvmbot commented Feb 26, 2025

Uh oh!

llvmbot commented Feb 26, 2025

Uh oh!

mtrofin commented Feb 26, 2025

Uh oh!

teresajohnson left a comment

Uh oh!

mtrofin commented Feb 27, 2025 •

edited

Loading

Uh oh!

Uh oh!

llvm-ci commented Feb 27, 2025

Uh oh!

Uh oh!

[ctxprof] Override type of instrumentation if -profile-context-root is specified #128940

[ctxprof] Override type of instrumentation if -profile-context-root is specified #128940

Uh oh!

Conversation

mtrofin commented Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mtrofin commented Feb 26, 2025

Uh oh!

teresajohnson left a comment

Choose a reason for hiding this comment

Uh oh!

llvmbot commented Feb 26, 2025

Uh oh!

llvmbot commented Feb 26, 2025

Uh oh!

mtrofin commented Feb 26, 2025

Uh oh!

teresajohnson left a comment

Choose a reason for hiding this comment

Uh oh!

mtrofin commented Feb 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

llvm-ci commented Feb 27, 2025

Uh oh!

Uh oh!

[ctxprof] Override type of instrumentation if `-profile-context-root` is specified #128940

[ctxprof] Override type of instrumentation if `-profile-context-root` is specified #128940

mtrofin commented Feb 26, 2025 •

edited

Loading

mtrofin commented Feb 27, 2025 •

edited

Loading