bolt/docs/CommandLineArgumentReference.md

   1 # BOLT - a post-link optimizer developed to speed up large applications
   2
   3 ## SYNOPSIS
   4
   5 `llvm-bolt <executable> [-o outputfile] <executable>.bolt [-data=perf.fdata] [options]`
   6
   7 ## OPTIONS
   8
   9 ### Generic options:
  10
  11 - `-h`
  12
  13   Alias for --help
  14
  15 - `--help`
  16
  17   Display available options (--help-hidden for more)
  18
  19 - `--help-hidden`
  20
  21   Display all available options
  22
  23 - `--help-list`
  24
  25   Display list of available options (--help-list-hidden for more)
  26
  27 - `--help-list-hidden`
  28
  29   Display list of all available options
  30
  31 - `--version`
  32
  33   Display the version of this program
  34
  35 ### Output options:
  36
  37 - `--bolt-info`
  38
  39   Write bolt info section in the output binary
  40
  41 - `-o <string>`
  42
  43   output file
  44
  45 - `-w <string>`
  46
  47   Save recorded profile to a file
  48
  49 ### BOLT generic options:
  50
  51 - `--align-text=<uint>`
  52
  53   Alignment of .text section
  54
  55 - `--allow-stripped`
  56
  57   Allow processing of stripped binaries
  58
  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
  67 - `--asm-dump[=<dump folder>]`
  68
  69   Dump function into assembly
  70
  71 - `-b`
  72
  73   Alias for -data
  74
  75 - `--bolt-id=<string>`
  76
  77   Add any string to tag this execution in the output binary via bolt info section
  78
  79 - `--break-funcs=<func1,func2,func3,...>`
  80
  81   List of functions to core dump on (debugging)
  82
  83 - `--check-encoding`
  84
  85   Perform verification of LLVM instruction encoding/decoding. Every instruction
  86   in the input is decoded and re-encoded. If the resulting bytes do not match
  87   the input, a warning message is printed.
  88
  89 - `--comp-dir-override=<string>`
  90
  91   Overrides DW_AT_comp_dir, and provides an alternative 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
  99 - `--cu-processing-batch-size=<uint>`
 100
 101   Specifies the size of batches for processing CUs. Higher number has better
 102   performance, but more memory usage. Default value is 1.
 103
 104 - `--data=<string>`
 105
 106   data file
 107
 108 - `--data2=<string>`
 109
 110   data file
 111
 112 - `--debug-skeleton-cu`
 113
 114   Prints out offsets for abbrev and debug_info of Skeleton CUs that get patched.
 115
 116 - `--dot-tooltip-code`
 117
 118   Add basic block instructions as tool tips on nodes
 119
 120 - `--dump-alt-instructions`
 121
 122   Dump Linux alternative instructions info
 123
 124 - `--dump-cg=<string>`
 125
 126   Dump callgraph to the given file
 127
 128 - `--dump-data`
 129
 130   Dump parsed bolt data for debugging
 131
 132 - `--dump-dot-all`
 133
 134   Dump function CFGs to graphviz format after each stage;enable '-print-loops'
 135   for color-coded blocks
 136
 137 - `--dump-linux-exceptions`
 138
 139   Dump Linux kernel exception table
 140
 141 - `--dump-orc`
 142
 143   Dump raw ORC unwind information (sorted)
 144
 145 - `--dump-para-sites`
 146
 147   Dump Linux kernel paravitual patch sites
 148
 149 - `--dump-pci-fixups`
 150
 151   Dump Linux kernel PCI fixup table
 152
 153 - `--dump-smp-locks`
 154
 155   Dump Linux kernel SMP locks
 156
 157 - `--dump-static-calls`
 158
 159   Dump Linux kernel static calls
 160
 161 - `--dump-static-keys`
 162
 163   Dump Linux kernel static keys jump table
 164
 165 - `--dwarf-output-path=<string>`
 166
 167   Path to where .dwo files or dwp file will be written out to.
 168
 169 - `--dwp=<string>`
 170
 171   Path and name to DWP file.
 172
 173 - `--dyno-stats`
 174
 175   Print execution info based on profile
 176
 177 - `--dyno-stats-all`
 178
 179   Print dyno stats after each stage
 180
 181 - `--dyno-stats-scale=<uint>`
 182
 183   Scale to be applied while reporting dyno stats
 184
 185 - `--enable-bat`
 186
 187   Write BOLT Address Translation tables
 188
 189 - `--force-data-relocations`
 190
 191   Force relocations to data sections to always be processed
 192
 193 - `--force-patch`
 194
 195   Force patching of original entry points
 196
 197 - `--funcs=<func1,func2,func3,...>`
 198
 199   Limit optimizations to functions from the list
 200
 201 - `--funcs-file=<string>`
 202
 203   File with list of functions to optimize
 204
 205 - `--funcs-file-no-regex=<string>`
 206
 207   File with list of functions to optimize (non-regex)
 208
 209 - `--funcs-no-regex=<func1,func2,func3,...>`
 210
 211   Limit optimizations to functions from the list (non-regex)
 212
 213 - `--hot-data`
 214
 215   Hot data symbols support (relocation mode)
 216
 217 - `--hot-functions-at-end`
 218
 219   If reorder-functions is used, order functions putting hottest last
 220
 221 - `--hot-text`
 222
 223   Generate hot text symbols. Apply this option to a precompiled binary that
 224   manually calls into hugify, such that at runtime hugify call will put hot code
 225   into 2M pages. This requires relocation.
 226
 227 - `--hot-text-move-sections=<sec1,sec2,sec3,...>`
 228
 229   List of sections containing functions used for hugifying hot text. BOLT makes
 230   sure these functions are not placed on the same page as the hot text.
 231   (default='.stub,.mover').
 232
 233 - `--insert-retpolines`
 234
 235   Run retpoline insertion pass
 236
 237 - `--keep-aranges`
 238
 239   Keep or generate .debug_aranges section if .gdb_index is written
 240
 241 - `--keep-tmp`
 242
 243   Preserve intermediate .o file
 244
 245 - `--lite`
 246
 247   Skip processing of cold functions
 248
 249 - `--log-file=<string>`
 250
 251   Redirect journaling to a file instead of stdout/stderr
 252
 253 - `--long-jump-labels`
 254
 255   Always use long jumps/nops for Linux kernel static keys
 256
 257 - `--match-profile-with-function-hash`
 258
 259   Match profile with function hash
 260
 261 - `--max-data-relocations=<uint>`
 262
 263   Maximum number of data relocations to process
 264
 265 - `--max-funcs=<uint>`
 266
 267   Maximum number of functions to process
 268
 269 - `--no-huge-pages`
 270
 271   Use regular size pages for code alignment
 272
 273 - `--no-threads`
 274
 275   Disable multithreading
 276
 277 - `--pad-funcs=<func1:pad1,func2:pad2,func3:pad3,...>`
 278
 279   List of functions to pad with amount of bytes
 280
 281 - `--print-mappings`
 282
 283   Print mappings in the legend, between characters/blocks and text sections
 284   (default false).
 285
 286
 287 - `--profile-format=<value>`
 288
 289   Format to dump profile output in aggregation mode, default is fdata
 290   - `fdata`: offset-based plaintext format
 291   - `yaml`: dense YAML representation
 292
 293 - `--r11-availability=<value>`
 294
 295   Determine the availability of r11 before indirect branches
 296   - `never`: r11 not available
 297   - `always`: r11 available before calls and jumps
 298   - `abi`: r11 available before calls but not before jumps
 299
 300 - `--relocs`
 301
 302   Use relocations in the binary (default=autodetect)
 303
 304 - `--remove-symtab`
 305
 306   Remove .symtab section
 307
 308 - `--reorder-skip-symbols=<symbol1,symbol2,symbol3,...>`
 309
 310   List of symbol names that cannot be reordered
 311
 312 - `--reorder-symbols=<symbol1,symbol2,symbol3,...>`
 313
 314   List of symbol names that can be reordered
 315
 316 - `--retpoline-lfence`
 317
 318   Determine if lfence instruction should exist in the retpoline
 319
 320 - `--skip-funcs=<func1,func2,func3,...>`
 321
 322   List of functions to skip
 323
 324 - `--skip-funcs-file=<string>`
 325
 326   File with list of functions to skip
 327
 328 - `--strict`
 329
 330   Trust the input to be from a well-formed source
 331
 332 - `--tasks-per-thread=<uint>`
 333
 334   Number of tasks to be created per thread
 335
 336 - `--terminal-trap`
 337
 338   Assume that execution stops at trap instruction
 339
 340 - `--thread-count=<uint>`
 341
 342   Number of threads
 343
 344 - `--top-called-limit=<uint>`
 345
 346   Maximum number of functions to print in top called functions section
 347
 348 - `--trap-avx512`
 349
 350   In relocation mode trap upon entry to any function that uses AVX-512
 351   instructions
 352
 353 - `--trap-old-code`
 354
 355   Insert traps in old function bodies (relocation mode)
 356
 357 - `--update-debug-sections`
 358
 359   Update DWARF debug sections of the executable
 360
 361 - `--use-gnu-stack`
 362
 363   Use GNU_STACK program header for new segment (workaround for issues with
 364   strip/objcopy)
 365
 366 - `--use-old-text`
 367
 368   Re-use space in old .text if possible (relocation mode)
 369
 370 - `-v <uint>`
 371
 372   Set verbosity level for diagnostic output
 373
 374 - `--write-dwp`
 375
 376   Output a single dwarf package file (dwp) instead of multiple non-relocatable
 377   dwarf object files (dwo).
 378
 379 ### BOLT optimization options:
 380
 381 - `--align-blocks`
 382
 383   Align basic blocks
 384
 385 - `--align-blocks-min-size=<uint>`
 386
 387   Minimal size of the basic block that should be aligned
 388
 389 - `--align-blocks-threshold=<uint>`
 390
 391   Align only blocks with frequency larger than containing function execution
 392   frequency specified in percent. E.g. 1000 means aligning blocks that are 10
 393   times more frequently executed than the containing function.
 394
 395 - `--align-functions=<uint>`
 396
 397   Align functions at a given value (relocation mode)
 398
 399 - `--align-functions-max-bytes=<uint>`
 400
 401   Maximum number of bytes to use to align functions
 402
 403 - `--assume-abi`
 404
 405   Assume the ABI is never violated
 406
 407 - `--block-alignment=<uint>`
 408
 409   Boundary to use for alignment of basic blocks
 410
 411 - `--bolt-seed=<uint>`
 412
 413   Seed for randomization
 414
 415 - `--cg-from-perf-data`
 416
 417   Use perf data directly when constructing the call graph for stale functions
 418
 419 - `--cg-ignore-recursive-calls`
 420
 421   Ignore recursive calls when constructing the call graph
 422
 423 - `--cg-use-split-hot-size`
 424
 425   Use hot/cold data on basic blocks to determine hot sizes for call graph
 426   functions
 427
 428 - `--cold-threshold=<uint>`
 429
 430   Tenths of percents of main entry frequency to use as a threshold when
 431   evaluating whether a basic block is cold (0 means it is only considered cold
 432   if the block has zero samples). Default: 0
 433
 434 - `--elim-link-veneers`
 435
 436   Run veneer elimination pass
 437
 438 - `--eliminate-unreachable`
 439
 440   Eliminate unreachable code
 441
 442 - `--equalize-bb-counts`
 443
 444   Use same count for BBs that should have equivalent count (used in non-LBR and
 445   shrink wrapping)
 446
 447 - `--execution-count-threshold=<uint>`
 448
 449   Perform profiling accuracy-sensitive optimizations only if function execution
 450   count >= the threshold (default: 0)
 451
 452 - `--fix-block-counts`
 453
 454   Adjust block counts based on outgoing branch counts
 455
 456 - `--fix-func-counts`
 457
 458   Adjust function counts based on basic blocks execution count
 459
 460 - `--force-inline=<func1,func2,func3,...>`
 461
 462   List of functions to always consider for inlining
 463
 464 - `--frame-opt=<value>`
 465
 466   Optimize stack frame accesses
 467   - `none`: do not perform frame optimization
 468   - `hot`: perform FOP on hot functions
 469   - `all`: perform FOP on all functions
 470
 471 - `--frame-opt-rm-stores`
 472
 473   Apply additional analysis to remove stores (experimental)
 474
 475 - `--function-order=<string>`
 476
 477   File containing an ordered list of functions to use for function reordering
 478
 479 - `--generate-function-order=<string>`
 480
 481   File to dump the ordered list of functions to use for function reordering
 482
 483 - `--generate-link-sections=<string>`
 484
 485   Generate a list of function sections in a format suitable for inclusion in a
 486   linker script
 487
 488 - `--group-stubs`
 489
 490   Share stubs across functions
 491
 492 - `--hugify`
 493
 494   Automatically put hot code on 2MB page(s) (hugify) at runtime. No manual call
 495   to hugify is needed in the binary (which is what --hot-text relies on).
 496
 497 - `--icf`
 498
 499   Fold functions with identical code
 500
 501 - `--icp`
 502
 503   Alias for --indirect-call-promotion
 504
 505 - `--icp-calls-remaining-percent-threshold=<uint>`
 506
 507   The percentage threshold against remaining unpromoted indirect call count for
 508   the promotion for calls
 509
 510 - `--icp-calls-topn`
 511
 512   Alias for --indirect-call-promotion-calls-topn
 513
 514 - `--icp-calls-total-percent-threshold=<uint>`
 515
 516   The percentage threshold against total count for the promotion for calls
 517
 518 - `--icp-eliminate-loads`
 519
 520   Enable load elimination using memory profiling data when performing ICP
 521
 522 - `--icp-funcs=<func1,func2,func3,...>`
 523
 524   List of functions to enable ICP for
 525
 526 - `--icp-inline`
 527
 528   Only promote call targets eligible for inlining
 529
 530 - `--icp-jt-remaining-percent-threshold=<uint>`
 531
 532   The percentage threshold against remaining unpromoted indirect call count for
 533   the promotion for jump tables
 534
 535 - `--icp-jt-targets`
 536
 537   Alias for --icp-jump-tables-targets
 538
 539 - `--icp-jt-topn`
 540
 541   Alias for --indirect-call-promotion-jump-tables-topn
 542
 543 - `--icp-jt-total-percent-threshold=<uint>`
 544
 545   The percentage threshold against total count for the promotion for jump tables
 546
 547 - `--icp-jump-tables-targets`
 548
 549   For jump tables, optimize indirect jmp targets instead of indices
 550
 551 - `--icp-mp-threshold`
 552
 553   Alias for --indirect-call-promotion-mispredict-threshold
 554
 555 - `--icp-old-code-sequence`
 556
 557   Use old code sequence for promoted calls
 558
 559 - `--icp-top-callsites=<uint>`
 560
 561   Optimize hottest calls until at least this percentage of all indirect calls
 562   frequency is covered. 0 = all callsites
 563
 564 - `--icp-topn`
 565
 566   Alias for --indirect-call-promotion-topn
 567
 568 - `--icp-use-mp`
 569
 570   Alias for --indirect-call-promotion-use-mispredicts
 571
 572 - `--indirect-call-promotion=<value>`
 573
 574   Indirect call promotion
 575   - `none`: do not perform indirect call promotion
 576   - `calls`: perform ICP on indirect calls
 577   - `jump-tables`: perform ICP on jump tables
 578   - `all`: perform ICP on calls and jump tables
 579
 580 - `--indirect-call-promotion-calls-topn=<uint>`
 581
 582   Limit number of targets to consider when doing indirect call promotion on
 583   calls. 0 = no limit
 584
 585 - `--indirect-call-promotion-jump-tables-topn=<uint>`
 586
 587   Limit number of targets to consider when doing indirect call promotion on jump
 588   tables. 0 = no limit
 589
 590 - `--indirect-call-promotion-topn=<uint>`
 591
 592   Limit number of targets to consider when doing indirect call promotion. 0 = no
 593   limit
 594
 595 - `--indirect-call-promotion-use-mispredicts`
 596
 597   Use misprediction frequency for determining whether or not ICP should be
 598   applied at a callsite.  The -indirect-call-promotion-mispredict-threshold
 599   value will be used by this heuristic
 600
 601 - `--infer-fall-throughs`
 602
 603   Infer execution count for fall-through blocks
 604
 605 - `--infer-stale-profile`
 606
 607   Infer counts from stale profile data.
 608
 609 - `--inline-all`
 610
 611   Inline all functions
 612
 613 - `--inline-ap`
 614
 615   Adjust function profile after inlining
 616
 617 - `--inline-limit=<uint>`
 618
 619   Maximum number of call sites to inline
 620
 621 - `--inline-max-iters=<uint>`
 622
 623   Maximum number of inline iterations
 624
 625 - `--inline-memcpy`
 626
 627   Inline memcpy using 'rep movsb' instruction (X86-only)
 628
 629 - `--inline-small-functions`
 630
 631   Inline functions if increase in size is less than defined by -inline-small-
 632   functions-bytes
 633
 634 - `--inline-small-functions-bytes=<uint>`
 635
 636   Max number of bytes for the function to be considered small for inlining
 637   purposes
 638
 639 - `--instrument`
 640
 641   Instrument code to generate accurate profile data
 642
 643 - `--iterative-guess`
 644
 645   In non-LBR mode, guess edge counts using iterative technique
 646
 647 - `--jt-footprint-optimize-for-icache`
 648
 649   With jt-footprint-reduction, only process PIC jumptables and turn off other
 650   transformations that increase code size
 651
 652 - `--jt-footprint-reduction`
 653
 654   Make jump tables size smaller at the cost of using more instructions at jump
 655   sites
 656
 657 - `--jump-tables=<value>`
 658
 659   Jump tables support (default=basic)
 660   - `none`: do not optimize functions with jump tables
 661   - `basic`: optimize functions with jump tables
 662   - `move`: move jump tables to a separate section
 663   - `split`: split jump tables section into hot and cold based on function
 664   execution frequency
 665   - `aggressive`: aggressively split jump tables section based on usage of the
 666   tables
 667
 668 - `--keep-nops`
 669
 670   Keep no-op instructions. By default they are removed.
 671
 672 - `--lite-threshold-count=<uint>`
 673
 674   Similar to '-lite-threshold-pct' but specify threshold using absolute function
 675   call count. I.e. limit processing to functions executed at least the specified
 676   number of times.
 677
 678 - `--lite-threshold-pct=<uint>`
 679
 680   Threshold (in percent) for selecting functions to process in lite mode. Higher
 681   threshold means fewer functions to process. E.g threshold of 90 means only top
 682   10 percent of functions with profile will be processed.
 683
 684 - `--match-with-call-graph`
 685
 686   Match functions with call graph
 687
 688 - `--memcpy1-spec=<func1,func2:cs1:cs2,func3:cs1,...>`
 689
 690   List of functions with call sites for which to specialize memcpy() for size 1
 691
 692 - `--min-branch-clusters`
 693
 694   Use a modified clustering algorithm geared towards minimizing branches
 695
 696 - `--name-similarity-function-matching-threshold=<uint>`
 697
 698   Match functions using namespace and edit distance.
 699
 700 - `--no-inline`
 701
 702   Disable all inlining (overrides other inlining options)
 703
 704 - `--no-scan`
 705
 706   Do not scan cold functions for external references (may result in slower binary)
 707
 708 - `--peepholes=<value>`
 709
 710   Enable peephole optimizations
 711   - `none`: disable peepholes
 712   - `double-jumps`: remove double jumps when able
 713   - `tailcall-traps`: insert tail call traps
 714   - `useless-branches`: remove useless conditional branches
 715   - `all`: enable all peephole optimizations
 716
 717 - `--plt=<value>`
 718
 719   Optimize PLT calls (requires linking with -znow)
 720   - `none`: do not optimize PLT calls
 721   - `hot`: optimize executed (hot) PLT calls
 722   - `all`: optimize all PLT calls
 723
 724 - `--preserve-blocks-alignment`
 725
 726   Try to preserve basic block alignment
 727
 728 - `--profile-ignore-hash`
 729
 730   Ignore hash while reading function profile
 731
 732 - `--profile-use-dfs`
 733
 734   Use DFS order for YAML profile
 735
 736 - `--reg-reassign`
 737
 738   Reassign registers so as to avoid using REX prefixes in hot code
 739
 740 - `--reorder-blocks=<value>`
 741
 742   Change layout of basic blocks in a function
 743   - `none`: do not reorder basic blocks
 744   - `reverse`: layout blocks in reverse order
 745   - `normal`: perform optimal layout based on profile
 746   - `branch-predictor`: perform optimal layout prioritizing branch predictions
 747   - `cache`: perform optimal layout prioritizing I-cache behavior
 748   - `cache+`: perform layout optimizing I-cache behavior
 749   - `ext-tsp`: perform layout optimizing I-cache behavior
 750   - `cluster-shuffle`: perform random layout of clusters
 751
 752 - `--reorder-data=<section1,section2,section3,...>`
 753
 754   List of sections to reorder
 755
 756 - `--reorder-data-algo=<value>`
 757
 758   Algorithm used to reorder data sections
 759   - `count`: sort hot data by read counts
 760   - `funcs`: sort hot data by hot function usage and count
 761
 762 - `--reorder-data-inplace`
 763
 764   Reorder data sections in place
 765
 766 - `--reorder-data-max-bytes=<uint>`
 767
 768   Maximum number of bytes to reorder
 769
 770 - `--reorder-data-max-symbols=<uint>`
 771
 772   Maximum number of symbols to reorder
 773
 774 - `--reorder-functions=<value>`
 775
 776   Reorder and cluster functions (works only with relocations)
 777   - `none`: do not reorder functions
 778   - `exec-count`: order by execution count
 779   - `hfsort`: use hfsort algorithm
 780   - `hfsort+`: use cache-directed sort
 781   - `cdsort`: use cache-directed sort
 782   - `pettis-hansen`: use Pettis-Hansen algorithm
 783   - `random`: reorder functions randomly
 784   - `user`: use function order specified by -function-order
 785
 786 - `--reorder-functions-use-hot-size`
 787
 788   Use a function's hot size when doing clustering
 789
 790 - `--report-bad-layout=<uint>`
 791
 792   Print top <uint> functions with suboptimal code layout on input
 793
 794 - `--report-stale`
 795
 796   Print the list of functions with stale profile
 797
 798 - `--runtime-hugify-lib=<string>`
 799
 800   Specify file name of the runtime hugify library
 801
 802 - `--runtime-instrumentation-lib=<string>`
 803
 804   Specify file name of the runtime instrumentation library
 805
 806 - `--sctc-mode=<value>`
 807
 808   Mode for simplify conditional tail calls
 809   - `always`: always perform sctc
 810   - `preserve`: only perform sctc when branch direction is preserved
 811   - `heuristic`: use branch prediction data to control sctc
 812
 813 - `--sequential-disassembly`
 814
 815   Performs disassembly sequentially
 816
 817 - `--shrink-wrapping-threshold=<uint>`
 818
 819   Percentage of prologue execution count to use as threshold when evaluating
 820   whether a block is cold enough to be profitable to move eligible spills there
 821
 822 - `--simplify-conditional-tail-calls`
 823
 824   Simplify conditional tail calls by removing unnecessary jumps
 825
 826 - `--simplify-rodata-loads`
 827
 828   Simplify loads from read-only sections by replacing the memory operand with
 829   the constant found in the corresponding section
 830
 831 - `--split-align-threshold=<uint>`
 832
 833   When deciding to split a function, apply this alignment while doing the size
 834   comparison (see -split-threshold). Default value: 2.
 835
 836 - `--split-all-cold`
 837
 838   Outline as many cold basic blocks as possible
 839
 840 - `--split-eh`
 841
 842   Split C++ exception handling code
 843
 844 - `--split-functions`
 845
 846   Split functions into fragments
 847
 848 - `--split-strategy=<value>`
 849
 850   Strategy used to partition blocks into fragments
 851   - `profile2`: split each function into a hot and cold fragment using profiling
 852   information
 853   - `cdsplit`: split each function into a hot, warm, and cold fragment using
 854   profiling information
 855   - `random2`: split each function into a hot and cold fragment at a randomly
 856   chosen split point (ignoring any available profiling information)
 857   - `randomN`: split each function into N fragments at a randomly chosen split
 858   points (ignoring any available profiling information)
 859   - `all`: split all basic blocks of each function into fragments such that each
 860   fragment contains exactly a single basic block
 861
 862 - `--split-threshold=<uint>`
 863
 864   Split function only if its main size is reduced by more than given amount of
 865   bytes. Default value: 0, i.e. split iff the size is reduced. Note that on some
 866   architectures the size can increase after splitting.
 867
 868 - `--stale-matching-max-func-size=<uint>`
 869
 870   The maximum size of a function to consider for inference.
 871
 872 - `--stale-matching-min-matched-block=<uint>`
 873
 874   Percentage threshold of matched basic blocks at which stale profile inference
 875   is executed.
 876
 877 - `--stale-threshold=<uint>`
 878
 879   Maximum percentage of stale functions to tolerate (default: 100)
 880
 881 - `--stoke`
 882
 883   Turn on the stoke analysis
 884
 885 - `--strip-rep-ret`
 886
 887   Strip 'repz' prefix from 'repz retq' sequence (on by default)
 888
 889 - `--tail-duplication=<value>`
 890
 891   Duplicate unconditional branches that cross a cache line
 892   - `none`: do not apply
 893   - `aggressive`: aggressive strategy
 894   - `moderate`: moderate strategy
 895   - `cache`: cache-aware duplication strategy
 896
 897 - `--tsp-threshold=<uint>`
 898
 899   Maximum number of hot basic blocks in a function for which to use a precise
 900   TSP solution while re-ordering basic blocks
 901
 902 - `--use-aggr-reg-reassign`
 903
 904   Use register liveness analysis to try to find more opportunities for -reg-
 905   reassign optimization
 906
 907 - `--use-compact-aligner`
 908
 909   Use compact approach for aligning functions
 910
 911 - `--use-edge-counts`
 912
 913   Use edge count data when doing clustering
 914
 915 - `--verify-cfg`
 916
 917   Verify the CFG after every pass
 918
 919 - `--x86-align-branch-boundary-hot-only`
 920
 921   Only apply branch boundary alignment in hot code
 922
 923 - `--x86-strip-redundant-address-size`
 924
 925   Remove redundant Address-Size override prefix
 926
 927 ### BOLT options in relocation mode:
 928
 929 - `--align-macro-fusion=<value>`
 930
 931   Fix instruction alignment for macro-fusion (x86 relocation mode)
 932   - `none`: do not insert alignment no-ops for macro-fusion
 933   - `hot`: only insert alignment no-ops on hot execution paths (default)
 934   - `all`: always align instructions to allow macro-fusion
 935
 936 ### BOLT instrumentation options:
 937
 938 `llvm-bolt <executable> -instrument [-o outputfile] <instrumented-executable>`
 939
 940 - `--conservative-instrumentation`
 941
 942   Disable instrumentation optimizations that sacrifice profile accuracy (for
 943   debugging, default: false)
 944
 945 - `--instrument-calls`
 946
 947   Record profile for inter-function control flow activity (default: true)
 948
 949 - `--instrument-hot-only`
 950
 951   Only insert instrumentation on hot functions (needs profile, default: false)
 952
 953 - `--instrumentation-binpath=<string>`
 954
 955   Path to instrumented binary in case if /proc/self/map_files is not accessible
 956   due to access restriction issues
 957
 958 - `--instrumentation-file=<string>`
 959
 960   File name where instrumented profile will be saved (default: /tmp/prof.fdata)
 961
 962 - `--instrumentation-file-append-pid`
 963
 964   Append PID to saved profile file name (default: false)
 965
 966 - `--instrumentation-no-counters-clear`
 967
 968   Don't clear counters across dumps (use with instrumentation-sleep-time option)
 969
 970 - `--instrumentation-sleep-time=<uint>`
 971
 972   Interval between profile writes (default: 0 = write only at program end).
 973   This is useful for service workloads when you want to dump profile every X
 974   minutes or if you are killing the program and the profile is not being dumped
 975   at the end.
 976
 977 - `--instrumentation-wait-forks`
 978
 979   Wait until all forks of instrumented process will finish (use with
 980   instrumentation-sleep-time option)
 981
 982 ### BOLT printing options:
 983
 984 - `--print-aliases`
 985
 986   Print aliases when printing objects
 987
 988 - `--print-all`
 989
 990   Print functions after each stage
 991
 992 - `--print-cfg`
 993
 994   Print functions after CFG construction
 995
 996 - `--print-debug-info`
 997
 998   Print debug info when printing functions
 999
1000 - `--print-disasm`
1001
1002   Print function after disassembly
1003
1004 - `--print-dyno-opcode-stats=<uint>`
1005
1006   Print per instruction opcode dyno stats and the functionnames:BB offsets of
1007   the nth highest execution counts
1008
1009 - `--print-dyno-stats-only`
1010
1011   While printing functions output dyno-stats and skip instructions
1012
1013 - `--print-exceptions`
1014
1015   Print exception handling data
1016
1017 - `--print-globals`
1018
1019   Print global symbols after disassembly
1020
1021 - `--print-jump-tables`
1022
1023   Print jump tables
1024
1025 - `--print-loops`
1026
1027   Print loop related information
1028
1029 - `--print-mem-data`
1030
1031   Print memory data annotations when printing functions
1032
1033 - `--print-normalized`
1034
1035   Print functions after CFG is normalized
1036
1037 - `--print-only=<func1,func2,func3,...>`
1038
1039   List of functions to print
1040
1041 - `--print-orc`
1042
1043   Print ORC unwind information for instructions
1044
1045 - `--print-profile`
1046
1047   Print functions after attaching profile
1048
1049 - `--print-profile-stats`
1050
1051   Print profile quality/bias analysis
1052
1053 - `--print-pseudo-probes=<value>`
1054
1055   Print pseudo probe info
1056   - `decode`: decode probes section from binary
1057   - `address_conversion`: update address2ProbesMap with output block address
1058   - `encoded_probes`: display the encoded probes in binary section
1059   - `all`: enable all debugging printout
1060
1061 - `--print-relocations`
1062
1063   Print relocations when printing functions/objects
1064
1065 - `--print-reordered-data`
1066
1067   Print section contents after reordering
1068
1069 - `--print-retpoline-insertion`
1070
1071   Print functions after retpoline insertion pass
1072
1073 - `--print-sdt`
1074
1075   Print all SDT markers
1076
1077 - `--print-sections`
1078
1079   Print all registered sections
1080
1081 - `--print-unknown`
1082
1083   Print names of functions with unknown control flow
1084
1085 - `--time-build`
1086
1087   Print time spent constructing binary functions
1088
1089 - `--time-rewrite`
1090
1091   Print time spent in rewriting passes
1092
1093 - `--print-after-branch-fixup`
1094
1095   Print function after fixing local branches
1096
1097 - `--print-after-jt-footprint-reduction`
1098
1099   Print function after jt-footprint-reduction pass
1100
1101 - `--print-after-lowering`
1102
1103   Print function after instruction lowering
1104
1105 - `--print-cache-metrics`
1106
1107   Calculate and print various metrics for instruction cache
1108
1109 - `--print-clusters`
1110
1111   Print clusters
1112
1113 - `--print-estimate-edge-counts`
1114
1115   Print function after edge counts are set for no-LBR profile
1116
1117 - `--print-finalized`
1118
1119   Print function after CFG is finalized
1120
1121 - `--print-fix-relaxations`
1122
1123   Print functions after fix relaxations pass
1124
1125 - `--print-fix-riscv-calls`
1126
1127   Print functions after fix RISCV calls pass
1128
1129 - `--print-fop`
1130
1131   Print functions after frame optimizer pass
1132
1133 - `--print-function-statistics=<uint>`
1134
1135   Print statistics about basic block ordering
1136
1137 - `--print-icf`
1138
1139   Print functions after ICF optimization
1140
1141 - `--print-icp`
1142
1143   Print functions after indirect call promotion
1144
1145 - `--print-inline`
1146
1147   Print functions after inlining optimization
1148
1149 - `--print-large-functions`
1150
1151   Print functions that could not be overwritten due to excessive size
1152
1153 - `--print-longjmp`
1154
1155   Print functions after longjmp pass
1156
1157 - `--print-optimize-bodyless`
1158
1159   Print functions after bodyless optimization
1160
1161 - `--print-output-address-range`
1162
1163   Print output address range for each basic block in the function
1164   whenBinaryFunction::print is called
1165
1166 - `--print-peepholes`
1167
1168   Print functions after peephole optimization
1169
1170 - `--print-plt`
1171
1172   Print functions after PLT optimization
1173
1174 - `--print-regreassign`
1175
1176   Print functions after regreassign pass
1177
1178 - `--print-reordered`
1179
1180   Print functions after layout optimization
1181
1182 - `--print-reordered-functions`
1183
1184   Print functions after clustering
1185
1186 - `--print-sctc`
1187
1188   Print functions after conditional tail call simplification
1189
1190 - `--print-simplify-rodata-loads`
1191
1192   Print functions after simplification of RO data loads
1193
1194 - `--print-sorted-by=<value>`
1195
1196   Print functions sorted by order of dyno stats
1197   - `executed-forward-branches`: executed forward branches
1198   - `taken-forward-branches`: taken forward branches
1199   - `executed-backward-branches`: executed backward branches
1200   - `taken-backward-branches`: taken backward branches
1201   - `executed-unconditional-branches`: executed unconditional branches
1202   - `all-function-calls`: all function calls
1203   - `indirect-calls`: indirect calls
1204   - `PLT-calls`: PLT calls
1205   - `executed-instructions`: executed instructions
1206   - `executed-load-instructions`: executed load instructions
1207   - `executed-store-instructions`: executed store instructions
1208   - `taken-jump-table-branches`: taken jump table branches
1209   - `taken-unknown-indirect-branches`: taken unknown indirect branches
1210   - `total-branches`: total branches
1211   - `taken-branches`: taken branches
1212   - `non-taken-conditional-branches`: non-taken conditional branches
1213   - `taken-conditional-branches`: taken conditional branches
1214   - `all-conditional-branches`: all conditional branches
1215   - `linker-inserted-veneer-calls`: linker-inserted veneer calls
1216   - `all`: sorted by all names
1217
1218 - `--print-sorted-by-order=<value>`
1219
1220   Use ascending or descending order when printing functions ordered by dyno stats
1221
1222 - `--print-split`
1223
1224   Print functions after code splitting
1225
1226 - `--print-stoke`
1227
1228   Print functions after stoke analysis
1229
1230 - `--print-uce`
1231
1232   Print functions after unreachable code elimination
1233
1234 - `--print-veneer-elimination`
1235
1236   Print functions after veneer elimination pass
1237
1238 - `--time-opts`
1239
1240   Print time spent in each optimization
1241
1242 - `--print-all-options`
1243
1244   Print all option values after command line parsing
1245
1246 - `--print-options`
1247
1248   Print non-default options after command line parsing