Skip to content

[BOLT][NFC] Sync CommandLineArgumentReference with options #96563

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.

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
Changes from all commits
Commits
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
84 changes: 75 additions & 9 deletions bolt/docs/CommandLineArgumentReference.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@

Allow processing of stripped binaries

- `--alt-inst-feature-size=<uint>`

Size of feature field in .altinstructions

- `--alt-inst-has-padlen`

Specify that .altinstructions has padlen field

- `--asm-dump[=<dump folder>]`

Dump function into assembly
Expand All @@ -78,6 +86,16 @@
in the input is decoded and re-encoded. If the resulting bytes do not match
the input, a warning message is printed.

- `--comp-dir-override=<string>`

Overrides DW_AT_comp_dir, and provides an alterantive base location, which is
used with DW_AT_dwo_name to construct a path to *.dwo files.

- `--create-debug-names-section`

Creates .debug_names section, if the input binary doesn't have it already, for
DWARF5 CU/TUs.

- `--cu-processing-batch-size=<uint>`

Specifies the size of batches for processing CUs. Higher number has better
Expand All @@ -93,7 +111,7 @@

- `--debug-skeleton-cu`

Prints out offsetrs for abbrev and debu_info of Skeleton CUs that get patched.
Prints out offsets for abbrev and debug_info of Skeleton CUs that get patched.

- `--deterministic-debuginfo`

Expand All @@ -104,6 +122,10 @@

Add basic block instructions as tool tips on nodes

- `--dump-alt-instructions`

Dump Linux alternative instructions info

- `--dump-cg=<string>`

Dump callgraph to the given file
Expand All @@ -117,10 +139,34 @@
Dump function CFGs to graphviz format after each stage;enable '-print-loops'
for color-coded blocks

- `--dump-linux-exceptions`

Dump Linux kernel exception table

- `--dump-orc`

Dump raw ORC unwind information (sorted)

- `--dump-para-sites`

Dump Linux kernel paravitual patch sites

- `--dump-pci-fixups`

Dump Linux kernel PCI fixup table

- `--dump-smp-locks`

Dump Linux kernel SMP locks

- `--dump-static-calls`

Dump Linux kernel static calls

- `--dump-static-keys`

Dump Linux kernel static keys jump table

- `--dwarf-output-path=<string>`

Path to where .dwo files or dwp file will be written out to.
Expand Down Expand Up @@ -205,6 +251,14 @@

Skip processing of cold functions

- `--log-file=<string>`

Redirect journaling to a file instead of stdout/stderr

- `--long-jump-labels`

Always use long jumps/nops for Linux kernel static keys

- `--max-data-relocations=<uint>`

Maximum number of data relocations to process
Expand Down Expand Up @@ -274,6 +328,10 @@

Number of tasks to be created per thread

- `--terminal-trap`

Assume that execution stops at trap instruction

- `--thread-count=<uint>`

Number of threads
Expand Down Expand Up @@ -618,10 +676,6 @@
threshold means fewer functions to process. E.g threshold of 90 means only top
10 percent of functions with profile will be processed.

- `--mcf-use-rarcs`

In MCF, consider the possibility of cancelling flow to balance edges

- `--memcpy1-spec=<func1,func2:cs1:cs2,func3:cs1,...>`

List of functions with call sites for which to specialize memcpy() for size 1
Expand Down Expand Up @@ -710,7 +764,7 @@
- `none`: do not reorder functions
- `exec-count`: order by execution count
- `hfsort`: use hfsort algorithm
- `hfsort+`: use hfsort+ algorithm
- `hfsort+`: use cache-directed sort
- `cdsort`: use cache-directed sort
- `pettis-hansen`: use Pettis-Hansen algorithm
- `random`: reorder functions randomly
Expand Down Expand Up @@ -804,8 +858,8 @@

- `--stale-matching-min-matched-block=<uint>`

Minimum percent of exact match block for a function to be considered for
profile inference.
Percentage threshold of matched basic blocks at which stale profile inference
is executed.

- `--stale-threshold=<uint>`

Expand Down Expand Up @@ -853,6 +907,10 @@

Only apply branch boundary alignment in hot code

- `--x86-strip-redundant-address-size`

Remove redundant Address-Size override prefix

### BOLT options in relocation mode:

- `--align-macro-fusion=<value>`
Expand Down Expand Up @@ -1039,6 +1097,10 @@

Print clusters

- `--print-estimate-edge-counts`

Print function after edge counts are set for no-LBR profile

- `--print-finalized`

Print function after CFG is finalized
Expand Down Expand Up @@ -1071,6 +1133,10 @@

Print functions after inlining optimization

- `--print-large-functions`

Print functions that could not be overwritten due to excessive size

- `--print-longjmp`

Print functions after longjmp pass
Expand Down Expand Up @@ -1166,4 +1232,4 @@

- `--print-options`

Print non-default options after command line parsing
Print non-default options after command line parsing
Loading