Skip to content

[SHT_LLVM_BB_ADDR_MAP] Adds pretty printing of BFI and BPI for PGO Analysis Map in tools. #82292

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 13 commits into from
Feb 27, 2024
Merged

[SHT_LLVM_BB_ADDR_MAP] Adds pretty printing of BFI and BPI for PGO Analysis Map in tools. #82292

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
e81270d
[BlockFrequency] Moves the block printing function to support to use …
red1bluelost Dec 7, 2023
61891cf
fixup! [BlockFrequency] Moves the block printing function to support …
red1bluelost Dec 14, 2023
35dbac7
[llvm-readobj] Adds pretty printing for pgo analysis map in readobj.
red1bluelost Feb 18, 2024
876fc88
[llvm-objdump] Updates PGO analysis printing.
red1bluelost Feb 20, 2024
dc89247
Adds warning and test for objdump option.
red1bluelost Feb 20, 2024
6aa1e45
Addresses reviewer style feedback.
red1bluelost Feb 22, 2024
897fd37
Adds stricter line matching for objdump test.
red1bluelost Feb 22, 2024
ab933d5
Adds stricter whitespace for objdump test.
red1bluelost Feb 22, 2024
e308a7a
Matches full line for readobj.
red1bluelost Feb 22, 2024
d1ae461
Updates correct objdump option file this time.
red1bluelost Feb 22, 2024
b6cd9c4
Updates documentation for tools.
red1bluelost Feb 22, 2024
6a01ee3
Updates docs based on review feedback.
red1bluelost Feb 23, 2024
88d37aa
Fixes minor typo.
red1bluelost Feb 27, 2024
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
12 changes: 6 additions & 6 deletions llvm/docs/CommandGuide/llvm-objdump.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ OPTIONS

When a bb-address-map section is present (i.e., the object file is built with
``-fbasic-block-sections=labels``), labels are retrieved from that section
instead. If a pgo-analysis-map present along side the bb-address-map, any
instead. If a pgo-analysis-map is present alongside the bb-address-map, any
available analyses are printed after the relevant block label. By default,
any analysis with a special representation (i.e. BlockFrequency,
BranchProbability, etc) are printed as raw hex values.
Expand All @@ -298,12 +298,12 @@ OPTIONS

.. option:: --pretty-pgo-analysis-map

When using ``--symbolize-operands`` with bb-address-map and pgo-analysis-map,
print analyses using same format as there analysis passes would. An example
of pretty format, would be printing block frequencies relative to the entry
block, same as BFI.
When using :option:`--symbolize-operands` with bb-address-map and
pgo-analysis-map, print analyses using same the format as their analysis
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
pgo-analysis-map, print analyses using same the format as their analysis
pgo-analysis-map, print analyses using the same format as their analysis

passes would. An example of pretty format would be printing block frequencies
relative to the entry block, the same as BFI.

Only works when ``--symbolize-operands`` is enabled.
Only works when :option:`--symbolize-operands` is enabled.

.. option:: --triple=<string>

Expand Down
6 changes: 3 additions & 3 deletions llvm/docs/CommandGuide/llvm-readobj.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,16 +159,16 @@ The following options are implemented only for the ELF file format.
Display the contents of the basic block address map section(s), which contain the
address of each function, along with the relative offset of each basic block.

When pgo analysis maps are present, all analyses are printed as there raw
When pgo analysis maps are present, all analyses are printed as their raw
value.

.. option:: --pretty-pgo-analysis-map

When pgo analysis maps are present in the basic block address map section(s),
analyses with special formats (i.e. BlockFrequency, BranchProbability, etc)
are printed using the same format as there respective analysis pass.
are printed using the same format as their respective analysis pass.

Requires ``--bb-addr-map`` to have an effect.
Requires :option:`--bb-addr-map` to have an effect.

.. option:: --demangle, -C

Expand Down