Skip to content

Commit 75ac887

Browse files
authored
[BOLT][NFC] Sync CommandLineArgumentReference with options (llvm#96563)
1 parent a32b719 commit 75ac887

File tree

1 file changed

+75
-9
lines changed

1 file changed

+75
-9
lines changed

bolt/docs/CommandLineArgumentReference.md

+75-9
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,14 @@
5656

5757
Allow processing of stripped binaries
5858

59+
- `--alt-inst-feature-size=<uint>`
60+
61+
Size of feature field in .altinstructions
62+
63+
- `--alt-inst-has-padlen`
64+
65+
Specify that .altinstructions has padlen field
66+
5967
- `--asm-dump[=<dump folder>]`
6068

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

89+
- `--comp-dir-override=<string>`
90+
91+
Overrides DW_AT_comp_dir, and provides an alterantive base location, which is
92+
used with DW_AT_dwo_name to construct a path to *.dwo files.
93+
94+
- `--create-debug-names-section`
95+
96+
Creates .debug_names section, if the input binary doesn't have it already, for
97+
DWARF5 CU/TUs.
98+
8199
- `--cu-processing-batch-size=<uint>`
82100

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

94112
- `--debug-skeleton-cu`
95113

96-
Prints out offsetrs for abbrev and debu_info of Skeleton CUs that get patched.
114+
Prints out offsets for abbrev and debug_info of Skeleton CUs that get patched.
97115

98116
- `--deterministic-debuginfo`
99117

@@ -104,6 +122,10 @@
104122

105123
Add basic block instructions as tool tips on nodes
106124

125+
- `--dump-alt-instructions`
126+
127+
Dump Linux alternative instructions info
128+
107129
- `--dump-cg=<string>`
108130

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

142+
- `--dump-linux-exceptions`
143+
144+
Dump Linux kernel exception table
145+
120146
- `--dump-orc`
121147

122148
Dump raw ORC unwind information (sorted)
123149

150+
- `--dump-para-sites`
151+
152+
Dump Linux kernel paravitual patch sites
153+
154+
- `--dump-pci-fixups`
155+
156+
Dump Linux kernel PCI fixup table
157+
158+
- `--dump-smp-locks`
159+
160+
Dump Linux kernel SMP locks
161+
162+
- `--dump-static-calls`
163+
164+
Dump Linux kernel static calls
165+
166+
- `--dump-static-keys`
167+
168+
Dump Linux kernel static keys jump table
169+
124170
- `--dwarf-output-path=<string>`
125171

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

206252
Skip processing of cold functions
207253

254+
- `--log-file=<string>`
255+
256+
Redirect journaling to a file instead of stdout/stderr
257+
258+
- `--long-jump-labels`
259+
260+
Always use long jumps/nops for Linux kernel static keys
261+
208262
- `--max-data-relocations=<uint>`
209263

210264
Maximum number of data relocations to process
@@ -274,6 +328,10 @@
274328

275329
Number of tasks to be created per thread
276330

331+
- `--terminal-trap`
332+
333+
Assume that execution stops at trap instruction
334+
277335
- `--thread-count=<uint>`
278336

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

621-
- `--mcf-use-rarcs`
622-
623-
In MCF, consider the possibility of cancelling flow to balance edges
624-
625679
- `--memcpy1-spec=<func1,func2:cs1:cs2,func3:cs1,...>`
626680

627681
List of functions with call sites for which to specialize memcpy() for size 1
@@ -710,7 +764,7 @@
710764
- `none`: do not reorder functions
711765
- `exec-count`: order by execution count
712766
- `hfsort`: use hfsort algorithm
713-
- `hfsort+`: use hfsort+ algorithm
767+
- `hfsort+`: use cache-directed sort
714768
- `cdsort`: use cache-directed sort
715769
- `pettis-hansen`: use Pettis-Hansen algorithm
716770
- `random`: reorder functions randomly
@@ -804,8 +858,8 @@
804858

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

807-
Minimum percent of exact match block for a function to be considered for
808-
profile inference.
861+
Percentage threshold of matched basic blocks at which stale profile inference
862+
is executed.
809863

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

@@ -853,6 +907,10 @@
853907

854908
Only apply branch boundary alignment in hot code
855909

910+
- `--x86-strip-redundant-address-size`
911+
912+
Remove redundant Address-Size override prefix
913+
856914
### BOLT options in relocation mode:
857915

858916
- `--align-macro-fusion=<value>`
@@ -1039,6 +1097,10 @@
10391097

10401098
Print clusters
10411099

1100+
- `--print-estimate-edge-counts`
1101+
1102+
Print function after edge counts are set for no-LBR profile
1103+
10421104
- `--print-finalized`
10431105

10441106
Print function after CFG is finalized
@@ -1071,6 +1133,10 @@
10711133

10721134
Print functions after inlining optimization
10731135

1136+
- `--print-large-functions`
1137+
1138+
Print functions that could not be overwritten due to excessive size
1139+
10741140
- `--print-longjmp`
10751141

10761142
Print functions after longjmp pass
@@ -1166,4 +1232,4 @@
11661232

11671233
- `--print-options`
11681234

1169-
Print non-default options after command line parsing
1235+
Print non-default options after command line parsing

0 commit comments

Comments
 (0)