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