Skip to content

[CSSPGO]Add a flag to limit unsymbolized context depth #121531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 7, 2025
Merged

[CSSPGO]Add a flag to limit unsymbolized context depth #121531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca865de
[CSSPGO]Add a flag to set max unsymbolized context depth
wlei-llvm Jan 2, 2025
38a356b
add comment
wlei-llvm Jan 7, 2025
f8fcc32
tweak the comment
wlei-llvm Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 125 additions & 0 deletions llvm/test/tools/llvm-profgen/context-depth.test
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
; Test --csprof-max-context-depth and --csprof-max-unsymbolized-context-depth

; RUN: llvm-profgen --format=text --perfscript=%S/Inputs/recursion-compression-pseudoprobe.perfscript --binary=%S/Inputs/recursion-compression-pseudoprobe.perfbin --output=%t --compress-recursion=0 --profile-summary-hot-count=0 --csprof-max-context-depth=0 --csspgo-preinliner=0 --gen-cs-nested-profile=0
; RUN: FileCheck %s --input-file %t -check-prefix=CHECK-MAX-CTX-DEPTH
; RUN: llvm-profgen --format=text --perfscript=%S/Inputs/recursion-compression-pseudoprobe.perfscript --binary=%S/Inputs/recursion-compression-pseudoprobe.perfbin --output=%t --compress-recursion=0 --profile-summary-hot-count=0 --csprof-max-unsymbolized-context-depth=2 --csspgo-preinliner=0 --gen-cs-nested-profile=0 --skip-symbolization
; RUN: FileCheck %s --input-file %t -check-prefix=CHECK-MAX-UNSYM-CTX-DEPTH
; RUN: llvm-profgen --format=text --perfscript=%S/Inputs/recursion-compression-pseudoprobe.perfscript --binary=%S/Inputs/recursion-compression-pseudoprobe.perfbin --output=%t --compress-recursion=0 --profile-summary-hot-count=0 --csprof-max-unsymbolized-context-depth=2 --csspgo-preinliner=0 --gen-cs-nested-profile=0
; RUN: FileCheck %s --input-file %t -check-prefix=CHECK-MAX-UNSYM-CTX-DEPTH-PROF
; RUN: llvm-profgen --format=text --perfscript=%S/Inputs/recursion-compression-pseudoprobe.perfscript --binary=%S/Inputs/recursion-compression-pseudoprobe.perfbin --output=%t --compress-recursion=0 --profile-summary-hot-count=0 --csprof-max-unsymbolized-context-depth=2 --csprof-max-context-depth=0 --csspgo-preinliner=0 --gen-cs-nested-profile=0
; RUN: FileCheck %s --input-file %t -check-prefix=CHECK-MAX-CTX-DEPTH


; CHECK-MAX-CTX-DEPTH: [fb]:19:6
; CHECK-MAX-CTX-DEPTH: 1: 6
; CHECK-MAX-CTX-DEPTH: 2: 3
; CHECK-MAX-CTX-DEPTH: 3: 3
; CHECK-MAX-CTX-DEPTH: 4: 0
; CHECK-MAX-CTX-DEPTH: 5: 4 fb:4
; CHECK-MAX-CTX-DEPTH: 6: 3 fa:3
; CHECK-MAX-CTX-DEPTH: !CFGChecksum: 563022570642068
; CHECK-MAX-CTX-DEPTH: [fa]:14:4
; CHECK-MAX-CTX-DEPTH: 1: 4
; CHECK-MAX-CTX-DEPTH: 3: 4
; CHECK-MAX-CTX-DEPTH: 4: 2
; CHECK-MAX-CTX-DEPTH: 5: 1
; CHECK-MAX-CTX-DEPTH: 6: 0
; CHECK-MAX-CTX-DEPTH: 7: 2 fb:2
; CHECK-MAX-CTX-DEPTH: 8: 1 fa:1
; CHECK-MAX-CTX-DEPTH: !CFGChecksum: 563070469352221


; CHECK-MAX-UNSYM-CTX-DEPTH: [0x7ab @ 0x7ab]
; CHECK-MAX-UNSYM-CTX-DEPTH: 3
; CHECK-MAX-UNSYM-CTX-DEPTH: 7a0-7a7:1
; CHECK-MAX-UNSYM-CTX-DEPTH: 7a0-7ab:3
; CHECK-MAX-UNSYM-CTX-DEPTH: 7b2-7b5:1
; CHECK-MAX-UNSYM-CTX-DEPTH: 3
; CHECK-MAX-UNSYM-CTX-DEPTH: 7a7->7b2:1
; CHECK-MAX-UNSYM-CTX-DEPTH: 7ab->7a0:4
; CHECK-MAX-UNSYM-CTX-DEPTH: 7b5->7c0:1
; CHECK-MAX-UNSYM-CTX-DEPTH: [0x7ab @ 0x7b5]
; CHECK-MAX-UNSYM-CTX-DEPTH: 1
; CHECK-MAX-UNSYM-CTX-DEPTH: 7c0-7d4:1
; CHECK-MAX-UNSYM-CTX-DEPTH: 1
; CHECK-MAX-UNSYM-CTX-DEPTH: 7d4->7c0:1
; CHECK-MAX-UNSYM-CTX-DEPTH: [0x7b5 @ 0x7d4]
; CHECK-MAX-UNSYM-CTX-DEPTH: 2
; CHECK-MAX-UNSYM-CTX-DEPTH: 7c0-7cd:1
; CHECK-MAX-UNSYM-CTX-DEPTH: 7db-7e0:1
; CHECK-MAX-UNSYM-CTX-DEPTH: 2
; CHECK-MAX-UNSYM-CTX-DEPTH: 7cd->7db:1
; CHECK-MAX-UNSYM-CTX-DEPTH: 7e0->7a0:1
; CHECK-MAX-UNSYM-CTX-DEPTH: [0x7b5 @ 0x7e0]
; CHECK-MAX-UNSYM-CTX-DEPTH: 2
; CHECK-MAX-UNSYM-CTX-DEPTH: 7a0-7a7:1
; CHECK-MAX-UNSYM-CTX-DEPTH: 7b2-7b5:1
; CHECK-MAX-UNSYM-CTX-DEPTH: 2
; CHECK-MAX-UNSYM-CTX-DEPTH: 7a7->7b2:1
; CHECK-MAX-UNSYM-CTX-DEPTH: 7b5->7c0:1
; CHECK-MAX-UNSYM-CTX-DEPTH: [0x7d4 @ 0x7e0]
; CHECK-MAX-UNSYM-CTX-DEPTH: 2
; CHECK-MAX-UNSYM-CTX-DEPTH: 7a0-7a7:1
; CHECK-MAX-UNSYM-CTX-DEPTH: 7b2-7b5:1
; CHECK-MAX-UNSYM-CTX-DEPTH: 2
; CHECK-MAX-UNSYM-CTX-DEPTH: 7a7->7b2:1
; CHECK-MAX-UNSYM-CTX-DEPTH: 7b5->7c0:1
; CHECK-MAX-UNSYM-CTX-DEPTH: [0x7e0 @ 0x7b5]
; CHECK-MAX-UNSYM-CTX-DEPTH: 2
; CHECK-MAX-UNSYM-CTX-DEPTH: 7c0-7cd:2
; CHECK-MAX-UNSYM-CTX-DEPTH: 7db-7e0:1
; CHECK-MAX-UNSYM-CTX-DEPTH: 2
; CHECK-MAX-UNSYM-CTX-DEPTH: 7cd->7db:2
; CHECK-MAX-UNSYM-CTX-DEPTH: 7e0->7a0:1

; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: [fb:5 @ fb:5 @ fb]:13:4
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 1: 4
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 2: 3
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 3: 1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 4: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 5: 4 fb:4
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 6: 1 fa:1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: !CFGChecksum: 563022570642068
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: [fa:7 @ fb:6 @ fa]:6:2
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 1: 2
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 3: 2
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 4: 1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 5: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 6: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 7: 1 fb:1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 8: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: !CFGChecksum: 563070469352221
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: [fb:5 @ fb:6 @ fa]:4:1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 1: 1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 3: 1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 4: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 5: 1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 6: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 7: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 8: 1 fa:1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: !CFGChecksum: 563070469352221
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: [fb:6 @ fa:8 @ fa]:4:1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 1: 1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 3: 1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 4: 1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 5: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 6: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 7: 1 fb:1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 8: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: !CFGChecksum: 563070469352221
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: [fa:8 @ fa:7 @ fb]:3:1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 1: 1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 2: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 3: 1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 4: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 5: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 6: 1 fa:1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: !CFGChecksum: 563022570642068
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: [fb:6 @ fa:7 @ fb]:3:1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 1: 1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 2: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 3: 1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 4: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 5: 0
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: 6: 1 fa:1
; CHECK-MAX-UNSYM-CTX-DEPTH-PROF: !CFGChecksum: 563022570642068
20 changes: 0 additions & 20 deletions llvm/test/tools/llvm-profgen/recursion-compression-pseudoprobe.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@
; RUN: FileCheck %s --input-file %t --check-prefix=CHECK-UNWINDER
; RUN: llvm-profgen --format=text --perfscript=%S/Inputs/recursion-compression-pseudoprobe-nommap.perfscript --binary=%S/Inputs/recursion-compression-pseudoprobe.perfbin --output=%t --profile-summary-hot-count=0 --csspgo-preinliner=0 --gen-cs-nested-profile=0
; RUN: FileCheck %s --input-file %t
; RUN: llvm-profgen --format=text --perfscript=%S/Inputs/recursion-compression-pseudoprobe.perfscript --binary=%S/Inputs/recursion-compression-pseudoprobe.perfbin --output=%t --compress-recursion=0 --profile-summary-hot-count=0 --csprof-max-context-depth=0 --csspgo-preinliner=0 --gen-cs-nested-profile=0
; RUN: FileCheck %s --input-file %t -check-prefix=CHECK-MAX-CTX-DEPTH


; CHECK-UNCOMPRESS: [main:2 @ foo:5 @ fa:8 @ fa:7 @ fb:5 @ fb:5 @ fb:5 @ fb:5 @ fb:5 @ fb:5 @ fb:5 @ fb:5 @ fb:6 @ fa]:4:1
; CHECK-UNCOMPRESS: 1: 1
Expand Down Expand Up @@ -68,23 +65,6 @@
; CHECK-UNCOMPRESS: [main:2 @ foo:5 @ fa:8 @ fa:7 @ fb:5 @ fb:5 @ fb:5 @ fb:5 @ fb]:1:0
; CHECK-UNCOMPRESS: 5: 1 fb:1
; CHECK-UNCOMPRESS: !CFGChecksum: 563022570642068
; CHECK-MAX-CTX-DEPTH: [fb]:19:6
; CHECK-MAX-CTX-DEPTH: 1: 6
; CHECK-MAX-CTX-DEPTH: 2: 3
; CHECK-MAX-CTX-DEPTH: 3: 3
; CHECK-MAX-CTX-DEPTH: 4: 0
; CHECK-MAX-CTX-DEPTH: 5: 4 fb:4
; CHECK-MAX-CTX-DEPTH: 6: 3 fa:3
; CHECK-MAX-CTX-DEPTH: !CFGChecksum: 563022570642068
; CHECK-MAX-CTX-DEPTH: [fa]:14:4
; CHECK-MAX-CTX-DEPTH: 1: 4
; CHECK-MAX-CTX-DEPTH: 3: 4
; CHECK-MAX-CTX-DEPTH: 4: 2
; CHECK-MAX-CTX-DEPTH: 5: 1
; CHECK-MAX-CTX-DEPTH: 6: 0
; CHECK-MAX-CTX-DEPTH: 7: 2 fb:2
; CHECK-MAX-CTX-DEPTH: 8: 1 fa:1
; CHECK-MAX-CTX-DEPTH: !CFGChecksum: 563070469352221


; CHECK: [main:2 @ foo:5 @ fa:8 @ fa:7 @ fb:5 @ fb]:13:4
Expand Down
19 changes: 18 additions & 1 deletion llvm/tools/llvm-profgen/PerfReader.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ static cl::opt<bool>
cl::opt<bool> ShowDetailedWarning("show-detailed-warning",
cl::desc("Show detailed warning message."));

static cl::opt<int> CSProfMaxUnsymbolizedCtxDepth(
"csprof-max-unsymbolized-context-depth", cl::init(-1),
cl::desc("Keep the last K contexts while merging unsymbolized profile. -1 "
"means no depth limit."));

extern cl::opt<std::string> PerfTraceFilename;
extern cl::opt<bool> ShowDisassemblyOnly;
extern cl::opt<bool> ShowSourceLocations;
Expand Down Expand Up @@ -172,7 +177,19 @@ std::shared_ptr<AddrBasedCtxKey> AddressStack::getContextKey() {
std::shared_ptr<AddrBasedCtxKey> KeyStr = std::make_shared<AddrBasedCtxKey>();
KeyStr->Context = Stack;
CSProfileGenerator::compressRecursionContext<uint64_t>(KeyStr->Context);
CSProfileGenerator::trimContext<uint64_t>(KeyStr->Context);
// MaxContextDepth(--csprof-max-context-depth) is used to trim both symbolized
// and unsymbolized profile context. Sometimes we want to at least preserve
// the inlinings for the leaf frame(the profiled binary inlining),
// --csprof-max-context-depth may not be flexible enough, in this case,
// --csprof-max-unsymbolized-context-depth is used to limit the context for
// unsymbolized profile. If both are set, use the minimum of them.
int Depth = CSProfileGenerator::MaxContextDepth != -1
? CSProfileGenerator::MaxContextDepth
: KeyStr->Context.size();
Depth = CSProfMaxUnsymbolizedCtxDepth != -1
? std::min(static_cast<int>(CSProfMaxUnsymbolizedCtxDepth), Depth)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need the static_cast here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It gave errordeduced conflicting types for parameter '_Tp' ('cl::opt<int>' vs. 'int') without the casting, it seems the deduction doesn't work very well for some environment.

Comment on lines +186 to +190
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add some comment to explain?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

comment added

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice to explain the intention of having dedicated depth limit for unsymbolized context.

: Depth;
CSProfileGenerator::trimContext<uint64_t>(KeyStr->Context, Depth);
return KeyStr;
}

Expand Down
Loading