llvm/docs/Passes.rst

   1 ..
   2     If Passes.html is up to date, the following "one-liner" should print
   3     an empty diff.
   4
   5     egrep -e '^<tr><td><a href="#.*">-.*</a></td><td>.*</td></tr>$' \
   6           -e '^  <a name=".*">.*</a>$' < Passes.html >html; \
   7     perl >help <<'EOT' && diff -u help html; rm -f help html
   8     open HTML, "<Passes.html" or die "open: Passes.html: $!\n";
   9     while (<HTML>) {
  10       m:^<tr><td><a href="#(.*)">-.*</a></td><td>.*</td></tr>$: or next;
  11       $order{$1} = sprintf("%03d", 1 + int %order);
  12     }
  13     open HELP, "../Release/bin/opt -help|" or die "open: opt -help: $!\n";
  14     while (<HELP>) {
  15       m:^    -([^ ]+) +- (.*)$: or next;
  16       my $o = $order{$1};
  17       $o = "000" unless defined $o;
  18       push @x, "$o<tr><td><a href=\"#$1\">-$1</a></td><td>$2</td></tr>\n";
  19       push @y, "$o  <a name=\"$1\">-$1: $2</a>\n";
  20     }
  21     @x = map { s/^\d\d\d//; $_ } sort @x;
  22     @y = map { s/^\d\d\d//; $_ } sort @y;
  23     print @x, @y;
  24     EOT
  25
  26     This (real) one-liner can also be helpful when converting comments to HTML:
  27
  28     perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print "  <p>\n" if !$on && $_ =~ /\S/; print "  </p>\n" if $on && $_ =~ /^\s*$/; print "  $_\n"; $on = ($_ =~ /\S/); } print "  </p>\n" if $on'
  29
  30 ====================================
  31 LLVM's Analysis and Transform Passes
  32 ====================================
  33
  34 .. contents::
  35     :local:
  36
  37 Introduction
  38 ============
  39
  40 This document serves as a high level summary of the optimization features that
  41 LLVM provides.  Optimizations are implemented as Passes that traverse some
  42 portion of a program to either collect information or transform the program.
  43 The table below divides the passes that LLVM provides into three categories.
  44 Analysis passes compute information that other passes can use or for debugging
  45 or program visualization purposes.  Transform passes can use (or invalidate)
  46 the analysis passes.  Transform passes all mutate the program in some way.
  47 Utility passes provides some utility but don't otherwise fit categorization.
  48 For example passes to extract functions to bitcode or write a module to bitcode
  49 are neither analysis nor transform passes.  The table of contents above
  50 provides a quick summary of each pass and links to the more complete pass
  51 description later in the document.
  52
  53 Analysis Passes
  54 ===============
  55
  56 This section describes the LLVM Analysis Passes.
  57
  58 ``-aa-eval``: Exhaustive Alias Analysis Precision Evaluator
  59 -----------------------------------------------------------
  60
  61 This is a simple N^2 alias analysis accuracy evaluator.  Basically, for each
  62 function in the program, it simply queries to see how the alias analysis
  63 implementation answers alias queries between each pair of pointers in the
  64 function.
  65
  66 This is inspired and adapted from code by: Naveen Neelakantam, Francesco
  67 Spadini, and Wojciech Stryjewski.
  68
  69 ``-basic-aa``: Basic Alias Analysis (stateless AA impl)
  70 -------------------------------------------------------
  71
  72 A basic alias analysis pass that implements identities (two different globals
  73 cannot alias, etc), but does no stateful analysis.
  74
  75 ``-basiccg``: Basic CallGraph Construction
  76 ------------------------------------------
  77
  78 Yet to be written.
  79
  80 ``-count-aa``: Count Alias Analysis Query Responses
  81 ---------------------------------------------------
  82
  83 A pass which can be used to count how many alias queries are being made and how
  84 the alias analysis implementation being used responds.
  85
  86 .. _passes-da:
  87
  88 ``-da``: Dependence Analysis
  89 ----------------------------
  90
  91 Dependence analysis framework, which is used to detect dependences in memory
  92 accesses.
  93
  94 ``-debug-aa``: AA use debugger
  95 ------------------------------
  96
  97 This simple pass checks alias analysis users to ensure that if they create a
  98 new value, they do not query AA without informing it of the value.  It acts as
  99 a shim over any other AA pass you want.
 100
 101 Yes keeping track of every value in the program is expensive, but this is a
 102 debugging pass.
 103
 104 ``-domfrontier``: Dominance Frontier Construction
 105 -------------------------------------------------
 106
 107 This pass is a simple dominator construction algorithm for finding forward
 108 dominator frontiers.
 109
 110 ``-domtree``: Dominator Tree Construction
 111 -----------------------------------------
 112
 113 This pass is a simple dominator construction algorithm for finding forward
 114 dominators.
 115
 116
 117 ``-dot-callgraph``: Print Call Graph to "dot" file
 118 --------------------------------------------------
 119
 120 This pass, only available in ``opt``, prints the call graph into a ``.dot``
 121 graph.  This graph can then be processed with the "dot" tool to convert it to
 122 postscript or some other suitable format.
 123
 124 ``-dot-cfg``: Print CFG of function to "dot" file
 125 -------------------------------------------------
 126
 127 This pass, only available in ``opt``, prints the control flow graph into a
 128 ``.dot`` graph.  This graph can then be processed with the :program:`dot` tool
 129 to convert it to postscript or some other suitable format.
 130 Additionally the ``-cfg-func-name=<substring>`` option can be used to filter the
 131 functions that are printed. All functions that contain the specified substring
 132 will be printed.
 133
 134 ``-dot-cfg-only``: Print CFG of function to "dot" file (with no function bodies)
 135 --------------------------------------------------------------------------------
 136
 137 This pass, only available in ``opt``, prints the control flow graph into a
 138 ``.dot`` graph, omitting the function bodies.  This graph can then be processed
 139 with the :program:`dot` tool to convert it to postscript or some other suitable
 140 format.
 141 Additionally the ``-cfg-func-name=<substring>`` option can be used to filter the
 142 functions that are printed. All functions that contain the specified substring
 143 will be printed.
 144
 145 ``-dot-dom``: Print dominance tree of function to "dot" file
 146 ------------------------------------------------------------
 147
 148 This pass, only available in ``opt``, prints the dominator tree into a ``.dot``
 149 graph.  This graph can then be processed with the :program:`dot` tool to
 150 convert it to postscript or some other suitable format.
 151
 152 ``-dot-dom-only``: Print dominance tree of function to "dot" file (with no function bodies)
 153 -------------------------------------------------------------------------------------------
 154
 155 This pass, only available in ``opt``, prints the dominator tree into a ``.dot``
 156 graph, omitting the function bodies.  This graph can then be processed with the
 157 :program:`dot` tool to convert it to postscript or some other suitable format.
 158
 159 ``-dot-postdom``: Print postdominance tree of function to "dot" file
 160 --------------------------------------------------------------------
 161
 162 This pass, only available in ``opt``, prints the post dominator tree into a
 163 ``.dot`` graph.  This graph can then be processed with the :program:`dot` tool
 164 to convert it to postscript or some other suitable format.
 165
 166 ``-dot-postdom-only``: Print postdominance tree of function to "dot" file (with no function bodies)
 167 ---------------------------------------------------------------------------------------------------
 168
 169 This pass, only available in ``opt``, prints the post dominator tree into a
 170 ``.dot`` graph, omitting the function bodies.  This graph can then be processed
 171 with the :program:`dot` tool to convert it to postscript or some other suitable
 172 format.
 173
 174 ``-globalsmodref-aa``: Simple mod/ref analysis for globals
 175 ----------------------------------------------------------
 176
 177 This simple pass provides alias and mod/ref information for global values that
 178 do not have their address taken, and keeps track of whether functions read or
 179 write memory (are "pure").  For this simple (but very common) case, we can
 180 provide pretty accurate and useful information.
 181
 182 ``-instcount``: Counts the various types of ``Instruction``\ s
 183 --------------------------------------------------------------
 184
 185 This pass collects the count of all instructions and reports them.
 186
 187 ``-intervals``: Interval Partition Construction
 188 -----------------------------------------------
 189
 190 This analysis calculates and represents the interval partition of a function,
 191 or a preexisting interval partition.
 192
 193 In this way, the interval partition may be used to reduce a flow graph down to
 194 its degenerate single node interval partition (unless it is irreducible).
 195
 196 ``-iv-users``: Induction Variable Users
 197 ---------------------------------------
 198
 199 Bookkeeping for "interesting" users of expressions computed from induction
 200 variables.
 201
 202 ``-lazy-value-info``: Lazy Value Information Analysis
 203 -----------------------------------------------------
 204
 205 Interface for lazy computation of value constraint information.
 206
 207 ``-libcall-aa``: LibCall Alias Analysis
 208 ---------------------------------------
 209
 210 LibCall Alias Analysis.
 211
 212 ``-lint``: Statically lint-checks LLVM IR
 213 -----------------------------------------
 214
 215 This pass statically checks for common and easily-identified constructs which
 216 produce undefined or likely unintended behavior in LLVM IR.
 217
 218 It is not a guarantee of correctness, in two ways.  First, it isn't
 219 comprehensive.  There are checks which could be done statically which are not
 220 yet implemented.  Some of these are indicated by TODO comments, but those
 221 aren't comprehensive either.  Second, many conditions cannot be checked
 222 statically.  This pass does no dynamic instrumentation, so it can't check for
 223 all possible problems.
 224
 225 Another limitation is that it assumes all code will be executed.  A store
 226 through a null pointer in a basic block which is never reached is harmless, but
 227 this pass will warn about it anyway.
 228
 229 Optimization passes may make conditions that this pass checks for more or less
 230 obvious.  If an optimization pass appears to be introducing a warning, it may
 231 be that the optimization pass is merely exposing an existing condition in the
 232 code.
 233
 234 This code may be run before :ref:`instcombine <passes-instcombine>`.  In many
 235 cases, instcombine checks for the same kinds of things and turns instructions
 236 with undefined behavior into unreachable (or equivalent).  Because of this,
 237 this pass makes some effort to look through bitcasts and so on.
 238
 239 ``-loops``: Natural Loop Information
 240 ------------------------------------
 241
 242 This analysis is used to identify natural loops and determine the loop depth of
 243 various nodes of the CFG.  Note that the loops identified may actually be
 244 several natural loops that share the same header node... not just a single
 245 natural loop.
 246
 247 ``-memdep``: Memory Dependence Analysis
 248 ---------------------------------------
 249
 250 An analysis that determines, for a given memory operation, what preceding
 251 memory operations it depends on.  It builds on alias analysis information, and
 252 tries to provide a lazy, caching interface to a common kind of alias
 253 information query.
 254
 255 ``-module-debuginfo``: Decodes module-level debug info
 256 ------------------------------------------------------
 257
 258 This pass decodes the debug info metadata in a module and prints in a
 259 (sufficiently-prepared-) human-readable form.
 260
 261 For example, run this pass from ``opt`` along with the ``-analyze`` option, and
 262 it'll print to standard output.
 263
 264 ``-postdomfrontier``: Post-Dominance Frontier Construction
 265 ----------------------------------------------------------
 266
 267 This pass is a simple post-dominator construction algorithm for finding
 268 post-dominator frontiers.
 269
 270 ``-postdomtree``: Post-Dominator Tree Construction
 271 --------------------------------------------------
 272
 273 This pass is a simple post-dominator construction algorithm for finding
 274 post-dominators.
 275
 276 ``-print-alias-sets``: Alias Set Printer
 277 ----------------------------------------
 278
 279 Yet to be written.
 280
 281 ``-print-callgraph``: Print a call graph
 282 ----------------------------------------
 283
 284 This pass, only available in ``opt``, prints the call graph to standard error
 285 in a human-readable form.
 286
 287 ``-print-callgraph-sccs``: Print SCCs of the Call Graph
 288 -------------------------------------------------------
 289
 290 This pass, only available in ``opt``, prints the SCCs of the call graph to
 291 standard error in a human-readable form.
 292
 293 ``-print-cfg-sccs``: Print SCCs of each function CFG
 294 ----------------------------------------------------
 295
 296 This pass, only available in ``opt``, printsthe SCCs of each function CFG to
 297 standard error in a human-readable fom.
 298
 299 ``-print-dom-info``: Dominator Info Printer
 300 -------------------------------------------
 301
 302 Dominator Info Printer.
 303
 304 ``-print-externalfnconstants``: Print external fn callsites passed constants
 305 ----------------------------------------------------------------------------
 306
 307 This pass, only available in ``opt``, prints out call sites to external
 308 functions that are called with constant arguments.  This can be useful when
 309 looking for standard library functions we should constant fold or handle in
 310 alias analyses.
 311
 312 ``-print-function``: Print function to stderr
 313 ---------------------------------------------
 314
 315 The ``PrintFunctionPass`` class is designed to be pipelined with other
 316 ``FunctionPasses``, and prints out the functions of the module as they are
 317 processed.
 318
 319 ``-print-module``: Print module to stderr
 320 -----------------------------------------
 321
 322 This pass simply prints out the entire module when it is executed.
 323
 324 .. _passes-print-used-types:
 325
 326 ``-print-used-types``: Find Used Types
 327 --------------------------------------
 328
 329 This pass is used to seek out all of the types in use by the program.  Note
 330 that this analysis explicitly does not include types only used by the symbol
 331 table.
 332
 333 ``-regions``: Detect single entry single exit regions
 334 -----------------------------------------------------
 335
 336 The ``RegionInfo`` pass detects single entry single exit regions in a function,
 337 where a region is defined as any subgraph that is connected to the remaining
 338 graph at only two spots.  Furthermore, a hierarchical region tree is built.
 339
 340 .. _passes-scalar-evolution:
 341
 342 ``-scalar-evolution``: Scalar Evolution Analysis
 343 ------------------------------------------------
 344
 345 The ``ScalarEvolution`` analysis can be used to analyze and categorize scalar
 346 expressions in loops.  It specializes in recognizing general induction
 347 variables, representing them with the abstract and opaque ``SCEV`` class.
 348 Given this analysis, trip counts of loops and other important properties can be
 349 obtained.
 350
 351 This analysis is primarily useful for induction variable substitution and
 352 strength reduction.
 353
 354 ``-scev-aa``: ScalarEvolution-based Alias Analysis
 355 --------------------------------------------------
 356
 357 Simple alias analysis implemented in terms of ``ScalarEvolution`` queries.
 358
 359 This differs from traditional loop dependence analysis in that it tests for
 360 dependencies within a single iteration of a loop, rather than dependencies
 361 between different iterations.
 362
 363 ``ScalarEvolution`` has a more complete understanding of pointer arithmetic
 364 than ``BasicAliasAnalysis``' collection of ad-hoc analyses.
 365
 366 ``-stack-safety``: Stack Safety Analysis
 367 ------------------------------------------------
 368
 369 The ``StackSafety`` analysis can be used to determine if stack allocated
 370 variables can be considered safe from memory access bugs.
 371
 372 This analysis' primary purpose is to be used by sanitizers to avoid unnecessary
 373 instrumentation of safe variables.
 374
 375 ``-targetdata``: Target Data Layout
 376 -----------------------------------
 377
 378 Provides other passes access to information on how the size and alignment
 379 required by the target ABI for various data types.
 380
 381 Transform Passes
 382 ================
 383
 384 This section describes the LLVM Transform Passes.
 385
 386 ``-adce``: Aggressive Dead Code Elimination
 387 -------------------------------------------
 388
 389 ADCE aggressively tries to eliminate code.  This pass is similar to :ref:`DCE
 390 <passes-dce>` but it assumes that values are dead until proven otherwise.  This
 391 is similar to :ref:`SCCP <passes-sccp>`, except applied to the liveness of
 392 values.
 393
 394 ``-always-inline``: Inliner for ``always_inline`` functions
 395 -----------------------------------------------------------
 396
 397 A custom inliner that handles only functions that are marked as "always
 398 inline".
 399
 400 ``-argpromotion``: Promote 'by reference' arguments to scalars
 401 --------------------------------------------------------------
 402
 403 This pass promotes "by reference" arguments to be "by value" arguments.  In
 404 practice, this means looking for internal functions that have pointer
 405 arguments.  If it can prove, through the use of alias analysis, that an
 406 argument is *only* loaded, then it can pass the value into the function instead
 407 of the address of the value.  This can cause recursive simplification of code
 408 and lead to the elimination of allocas (especially in C++ template code like
 409 the STL).
 410
 411 This pass also handles aggregate arguments that are passed into a function,
 412 scalarizing them if the elements of the aggregate are only loaded.  Note that
 413 it refuses to scalarize aggregates which would require passing in more than
 414 three operands to the function, because passing thousands of operands for a
 415 large array or structure is unprofitable!
 416
 417 Note that this transformation could also be done for arguments that are only
 418 stored to (returning the value instead), but does not currently.  This case
 419 would be best handled when and if LLVM starts supporting multiple return values
 420 from functions.
 421
 422 ``-bb-vectorize``: Basic-Block Vectorization
 423 --------------------------------------------
 424
 425 This pass combines instructions inside basic blocks to form vector
 426 instructions.  It iterates over each basic block, attempting to pair compatible
 427 instructions, repeating this process until no additional pairs are selected for
 428 vectorization.  When the outputs of some pair of compatible instructions are
 429 used as inputs by some other pair of compatible instructions, those pairs are
 430 part of a potential vectorization chain.  Instruction pairs are only fused into
 431 vector instructions when they are part of a chain longer than some threshold
 432 length.  Moreover, the pass attempts to find the best possible chain for each
 433 pair of compatible instructions.  These heuristics are intended to prevent
 434 vectorization in cases where it would not yield a performance increase of the
 435 resulting code.
 436
 437 ``-block-placement``: Profile Guided Basic Block Placement
 438 ----------------------------------------------------------
 439
 440 This pass is a very simple profile guided basic block placement algorithm.  The
 441 idea is to put frequently executed blocks together at the start of the function
 442 and hopefully increase the number of fall-through conditional branches.  If
 443 there is no profile information for a particular function, this pass basically
 444 orders blocks in depth-first order.
 445
 446 ``-break-crit-edges``: Break critical edges in CFG
 447 --------------------------------------------------
 448
 449 Break all of the critical edges in the CFG by inserting a dummy basic block.
 450 It may be "required" by passes that cannot deal with critical edges.  This
 451 transformation obviously invalidates the CFG, but can update forward dominator
 452 (set, immediate dominators, tree, and frontier) information.
 453
 454 ``-codegenprepare``: Optimize for code generation
 455 -------------------------------------------------
 456
 457 This pass munges the code in the input function to better prepare it for
 458 SelectionDAG-based code generation.  This works around limitations in its
 459 basic-block-at-a-time approach.  It should eventually be removed.
 460
 461 ``-constmerge``: Merge Duplicate Global Constants
 462 -------------------------------------------------
 463
 464 Merges duplicate global constants together into a single constant that is
 465 shared.  This is useful because some passes (i.e., TraceValues) insert a lot of
 466 string constants into the program, regardless of whether or not an existing
 467 string is available.
 468
 469 .. _passes-dce:
 470
 471 ``-dce``: Dead Code Elimination
 472 -------------------------------
 473
 474 Dead code elimination is similar to :ref:`dead instruction elimination
 475 <passes-die>`, but it rechecks instructions that were used by removed
 476 instructions to see if they are newly dead.
 477
 478 ``-deadargelim``: Dead Argument Elimination
 479 -------------------------------------------
 480
 481 This pass deletes dead arguments from internal functions.  Dead argument
 482 elimination removes arguments which are directly dead, as well as arguments
 483 only passed into function calls as dead arguments of other functions.  This
 484 pass also deletes dead arguments in a similar way.
 485
 486 This pass is often useful as a cleanup pass to run after aggressive
 487 interprocedural passes, which add possibly-dead arguments.
 488
 489 ``-deadtypeelim``: Dead Type Elimination
 490 ----------------------------------------
 491
 492 This pass is used to cleanup the output of GCC.  It eliminate names for types
 493 that are unused in the entire translation unit, using the :ref:`find used types
 494 <passes-print-used-types>` pass.
 495
 496 .. _passes-die:
 497
 498 ``-die``: Dead Instruction Elimination
 499 --------------------------------------
 500
 501 Dead instruction elimination performs a single pass over the function, removing
 502 instructions that are obviously dead.
 503
 504 ``-dse``: Dead Store Elimination
 505 --------------------------------
 506
 507 A trivial dead store elimination that only considers basic-block local
 508 redundant stores.
 509
 510 .. _passes-function-attrs:
 511
 512 ``-function-attrs``: Deduce function attributes
 513 -----------------------------------------------
 514
 515 A simple interprocedural pass which walks the call-graph, looking for functions
 516 which do not access or only read non-local memory, and marking them
 517 ``readnone``/``readonly``.  In addition, it marks function arguments (of
 518 pointer type) "``nocapture``" if a call to the function does not create any
 519 copies of the pointer value that outlive the call.  This more or less means
 520 that the pointer is only dereferenced, and not returned from the function or
 521 stored in a global.  This pass is implemented as a bottom-up traversal of the
 522 call-graph.
 523
 524 ``-globaldce``: Dead Global Elimination
 525 ---------------------------------------
 526
 527 This transform is designed to eliminate unreachable internal globals from the
 528 program.  It uses an aggressive algorithm, searching out globals that are known
 529 to be alive.  After it finds all of the globals which are needed, it deletes
 530 whatever is left over.  This allows it to delete recursive chunks of the
 531 program which are unreachable.
 532
 533 ``-globalopt``: Global Variable Optimizer
 534 -----------------------------------------
 535
 536 This pass transforms simple global variables that never have their address
 537 taken.  If obviously true, it marks read/write globals as constant, deletes
 538 variables only stored to, etc.
 539
 540 ``-gvn``: Global Value Numbering
 541 --------------------------------
 542
 543 This pass performs global value numbering to eliminate fully and partially
 544 redundant instructions.  It also performs redundant load elimination.
 545
 546 .. _passes-indvars:
 547
 548 ``-indvars``: Canonicalize Induction Variables
 549 ----------------------------------------------
 550
 551 This transformation analyzes and transforms the induction variables (and
 552 computations derived from them) into simpler forms suitable for subsequent
 553 analysis and transformation.
 554
 555 This transformation makes the following changes to each loop with an
 556 identifiable induction variable:
 557
 558 * All loops are transformed to have a *single* canonical induction variable
 559   which starts at zero and steps by one.
 560 * The canonical induction variable is guaranteed to be the first PHI node in
 561   the loop header block.
 562 * Any pointer arithmetic recurrences are raised to use array subscripts.
 563
 564 If the trip count of a loop is computable, this pass also makes the following
 565 changes:
 566
 567 * The exit condition for the loop is canonicalized to compare the induction
 568   value against the exit value.  This turns loops like:
 569
 570   .. code-block:: c++
 571
 572     for (i = 7; i*i < 1000; ++i)
 573
 574     into
 575
 576   .. code-block:: c++
 577
 578     for (i = 0; i != 25; ++i)
 579
 580 * Any use outside of the loop of an expression derived from the indvar is
 581   changed to compute the derived value outside of the loop, eliminating the
 582   dependence on the exit value of the induction variable.  If the only purpose
 583   of the loop is to compute the exit value of some derived expression, this
 584   transformation will make the loop dead.
 585
 586 This transformation should be followed by strength reduction after all of the
 587 desired loop transformations have been performed.  Additionally, on targets
 588 where it is profitable, the loop could be transformed to count down to zero
 589 (the "do loop" optimization).
 590
 591 ``-inline``: Function Integration/Inlining
 592 ------------------------------------------
 593
 594 Bottom-up inlining of functions into callees.
 595
 596 .. _passes-instcombine:
 597
 598 ``-instcombine``: Combine redundant instructions
 599 ------------------------------------------------
 600
 601 Combine instructions to form fewer, simple instructions.  This pass does not
 602 modify the CFG. This pass is where algebraic simplification happens.
 603
 604 This pass combines things like:
 605
 606 .. code-block:: llvm
 607
 608   %Y = add i32 %X, 1
 609   %Z = add i32 %Y, 1
 610
 611 into:
 612
 613 .. code-block:: llvm
 614
 615   %Z = add i32 %X, 2
 616
 617 This is a simple worklist driven algorithm.
 618
 619 This pass guarantees that the following canonicalizations are performed on the
 620 program:
 621
 622 #. If a binary operator has a constant operand, it is moved to the right-hand
 623    side.
 624 #. Bitwise operators with constant operands are always grouped so that shifts
 625    are performed first, then ``or``\ s, then ``and``\ s, then ``xor``\ s.
 626 #. Compare instructions are converted from ``<``, ``>``, ``≤``, or ``≥`` to
 627    ``=`` or ``≠`` if possible.
 628 #. All ``cmp`` instructions on boolean values are replaced with logical
 629    operations.
 630 #. ``add X, X`` is represented as ``mul X, 2`` ⇒ ``shl X, 1``
 631 #. Multiplies with a constant power-of-two argument are transformed into
 632    shifts.
 633 #. … etc.
 634
 635 This pass can also simplify calls to specific well-known function calls (e.g.
 636 runtime library functions).  For example, a call ``exit(3)`` that occurs within
 637 the ``main()`` function can be transformed into simply ``return 3``. Whether or
 638 not library calls are simplified is controlled by the
 639 :ref:`-function-attrs <passes-function-attrs>` pass and LLVM's knowledge of
 640 library calls on different targets.
 641
 642 .. _passes-aggressive-instcombine:
 643
 644 ``-aggressive-instcombine``: Combine expression patterns
 645 --------------------------------------------------------
 646
 647 Combine expression patterns to form expressions with fewer, simple instructions.
 648 This pass does not modify the CFG.
 649
 650 For example, this pass reduce width of expressions post-dominated by TruncInst
 651 into smaller width when applicable.
 652
 653 It differs from instcombine pass in that it contains pattern optimization that
 654 requires higher complexity than the O(1), thus, it should run fewer times than
 655 instcombine pass.
 656
 657 ``-internalize``: Internalize Global Symbols
 658 --------------------------------------------
 659
 660 This pass loops over all of the functions in the input module, looking for a
 661 main function.  If a main function is found, all other functions and all global
 662 variables with initializers are marked as internal.
 663
 664 ``-ipsccp``: Interprocedural Sparse Conditional Constant Propagation
 665 --------------------------------------------------------------------
 666
 667 An interprocedural variant of :ref:`Sparse Conditional Constant Propagation
 668 <passes-sccp>`.
 669
 670 ``-jump-threading``: Jump Threading
 671 -----------------------------------
 672
 673 Jump threading tries to find distinct threads of control flow running through a
 674 basic block.  This pass looks at blocks that have multiple predecessors and
 675 multiple successors.  If one or more of the predecessors of the block can be
 676 proven to always cause a jump to one of the successors, we forward the edge
 677 from the predecessor to the successor by duplicating the contents of this
 678 block.
 679
 680 An example of when this can occur is code like this:
 681
 682 .. code-block:: c++
 683
 684   if () { ...
 685     X = 4;
 686   }
 687   if (X < 3) {
 688
 689 In this case, the unconditional branch at the end of the first if can be
 690 revectored to the false side of the second if.
 691
 692 .. _passes-lcssa:
 693
 694 ``-lcssa``: Loop-Closed SSA Form Pass
 695 -------------------------------------
 696
 697 This pass transforms loops by placing phi nodes at the end of the loops for all
 698 values that are live across the loop boundary.  For example, it turns the left
 699 into the right code:
 700
 701 .. code-block:: c++
 702
 703   for (...)                for (...)
 704       if (c)                   if (c)
 705           X1 = ...                 X1 = ...
 706       else                     else
 707           X2 = ...                 X2 = ...
 708       X3 = phi(X1, X2)         X3 = phi(X1, X2)
 709   ... = X3 + 4              X4 = phi(X3)
 710                               ... = X4 + 4
 711
 712 This is still valid LLVM; the extra phi nodes are purely redundant, and will be
 713 trivially eliminated by ``InstCombine``.  The major benefit of this
 714 transformation is that it makes many other loop optimizations, such as
 715 ``LoopUnswitch``\ ing, simpler. You can read more in the
 716 :ref:`loop terminology section for the LCSSA form <loop-terminology-lcssa>`.
 717
 718 .. _passes-licm:
 719
 720 ``-licm``: Loop Invariant Code Motion
 721 -------------------------------------
 722
 723 This pass performs loop invariant code motion, attempting to remove as much
 724 code from the body of a loop as possible.  It does this by either hoisting code
 725 into the preheader block, or by sinking code to the exit blocks if it is safe.
 726 This pass also promotes must-aliased memory locations in the loop to live in
 727 registers, thus hoisting and sinking "invariant" loads and stores.
 728
 729 Hoisting operations out of loops is a canonicalization transform. It enables
 730 and simplifies subsequent optimizations in the middle-end. Rematerialization
 731 of hoisted instructions to reduce register pressure is the responsibility of
 732 the back-end, which has more accurate information about register pressure and
 733 also handles other optimizations than LICM that increase live-ranges.
 734
 735 This pass uses alias analysis for two purposes:
 736
 737 #. Moving loop invariant loads and calls out of loops.  If we can determine
 738    that a load or call inside of a loop never aliases anything stored to, we
 739    can hoist it or sink it like any other instruction.
 740
 741 #. Scalar Promotion of Memory.  If there is a store instruction inside of the
 742    loop, we try to move the store to happen AFTER the loop instead of inside of
 743    the loop.  This can only happen if a few conditions are true:
 744
 745    #. The pointer stored through is loop invariant.
 746    #. There are no stores or loads in the loop which *may* alias the pointer.
 747       There are no calls in the loop which mod/ref the pointer.
 748
 749    If these conditions are true, we can promote the loads and stores in the
 750    loop of the pointer to use a temporary alloca'd variable.  We then use the
 751    :ref:`mem2reg <passes-mem2reg>` functionality to construct the appropriate
 752    SSA form for the variable.
 753
 754 ``-loop-deletion``: Delete dead loops
 755 -------------------------------------
 756
 757 This file implements the Dead Loop Deletion Pass.  This pass is responsible for
 758 eliminating loops with non-infinite computable trip counts that have no side
 759 effects or volatile instructions, and do not contribute to the computation of
 760 the function's return value.
 761
 762 .. _passes-loop-extract:
 763
 764 ``-loop-extract``: Extract loops into new functions
 765 ---------------------------------------------------
 766
 767 A pass wrapper around the ``ExtractLoop()`` scalar transformation to extract
 768 each top-level loop into its own new function.  If the loop is the *only* loop
 769 in a given function, it is not touched.  This is a pass most useful for
 770 debugging via bugpoint.
 771
 772 ``-loop-extract-single``: Extract at most one loop into a new function
 773 ----------------------------------------------------------------------
 774
 775 Similar to :ref:`Extract loops into new functions <passes-loop-extract>`, this
 776 pass extracts one natural loop from the program into a function if it can.
 777 This is used by :program:`bugpoint`.
 778
 779 ``-loop-reduce``: Loop Strength Reduction
 780 -----------------------------------------
 781
 782 This pass performs a strength reduction on array references inside loops that
 783 have as one or more of their components the loop induction variable.  This is
 784 accomplished by creating a new value to hold the initial value of the array
 785 access for the first iteration, and then creating a new GEP instruction in the
 786 loop to increment the value by the appropriate amount.
 787
 788 .. _passes-loop-rotate:
 789
 790 ``-loop-rotate``: Rotate Loops
 791 ------------------------------
 792
 793 A simple loop rotation transformation.  A summary of it can be found in
 794 :ref:`Loop Terminology for Rotated Loops <loop-terminology-loop-rotate>`.
 795
 796
 797 .. _passes-loop-simplify:
 798
 799 ``-loop-simplify``: Canonicalize natural loops
 800 ----------------------------------------------
 801
 802 This pass performs several transformations to transform natural loops into a
 803 simpler form, which makes subsequent analyses and transformations simpler and
 804 more effective. A summary of it can be found in
 805 :ref:`Loop Terminology, Loop Simplify Form <loop-terminology-loop-simplify>`.
 806
 807 Loop pre-header insertion guarantees that there is a single, non-critical entry
 808 edge from outside of the loop to the loop header.  This simplifies a number of
 809 analyses and transformations, such as :ref:`LICM <passes-licm>`.
 810
 811 Loop exit-block insertion guarantees that all exit blocks from the loop (blocks
 812 which are outside of the loop that have predecessors inside of the loop) only
 813 have predecessors from inside of the loop (and are thus dominated by the loop
 814 header).  This simplifies transformations such as store-sinking that are built
 815 into LICM.
 816
 817 This pass also guarantees that loops will have exactly one backedge.
 818
 819 Note that the :ref:`simplifycfg <passes-simplifycfg>` pass will clean up blocks
 820 which are split out but end up being unnecessary, so usage of this pass should
 821 not pessimize generated code.
 822
 823 This pass obviously modifies the CFG, but updates loop information and
 824 dominator information.
 825
 826 ``-loop-unroll``: Unroll loops
 827 ------------------------------
 828
 829 This pass implements a simple loop unroller.  It works best when loops have
 830 been canonicalized by the :ref:`indvars <passes-indvars>` pass, allowing it to
 831 determine the trip counts of loops easily.
 832
 833 ``-loop-unroll-and-jam``: Unroll and Jam loops
 834 ----------------------------------------------
 835
 836 This pass implements a simple unroll and jam classical loop optimisation pass.
 837 It transforms loop from:
 838
 839 .. code-block:: c++
 840
 841   for i.. i+= 1              for i.. i+= 4
 842     for j..                    for j..
 843       code(i, j)                 code(i, j)
 844                                  code(i+1, j)
 845                                  code(i+2, j)
 846                                  code(i+3, j)
 847                              remainder loop
 848
 849 Which can be seen as unrolling the outer loop and "jamming" (fusing) the inner
 850 loops into one. When variables or loads can be shared in the new inner loop, this
 851 can lead to significant performance improvements. It uses
 852 :ref:`Dependence Analysis <passes-da>` for proving the transformations are safe.
 853
 854 .. _passes-loop-unswitch:
 855
 856 ``-loop-unswitch``: Unswitch loops
 857 ----------------------------------
 858
 859 This pass transforms loops that contain branches on loop-invariant conditions
 860 to have multiple loops.  For example, it turns the left into the right code:
 861
 862 .. code-block:: c++
 863
 864   for (...)                  if (lic)
 865       A                          for (...)
 866       if (lic)                       A; B; C
 867           B                  else
 868       C                          for (...)
 869                                      A; C
 870
 871 This can increase the size of the code exponentially (doubling it every time a
 872 loop is unswitched) so we only unswitch if the resultant code will be smaller
 873 than a threshold.
 874
 875 This pass expects :ref:`LICM <passes-licm>` to be run before it to hoist
 876 invariant conditions out of the loop, to make the unswitching opportunity
 877 obvious.
 878
 879 ``-lower-global-dtors``: Lower global destructors
 880 ------------------------------------------------------------
 881
 882 This pass lowers global module destructors (``llvm.global_dtors``) by creating
 883 wrapper functions that are registered as global constructors in
 884 ``llvm.global_ctors`` and which contain a call to ``__cxa_atexit`` to register
 885 their destructor functions.
 886
 887 ``-loweratomic``: Lower atomic intrinsics to non-atomic form
 888 ------------------------------------------------------------
 889
 890 This pass lowers atomic intrinsics to non-atomic form for use in a known
 891 non-preemptible environment.
 892
 893 The pass does not verify that the environment is non-preemptible (in general
 894 this would require knowledge of the entire call graph of the program including
 895 any libraries which may not be available in bitcode form); it simply lowers
 896 every atomic intrinsic.
 897
 898 ``-lowerinvoke``: Lower invokes to calls, for unwindless code generators
 899 ------------------------------------------------------------------------
 900
 901 This transformation is designed for use by code generators which do not yet
 902 support stack unwinding.  This pass converts ``invoke`` instructions to
 903 ``call`` instructions, so that any exception-handling ``landingpad`` blocks
 904 become dead code (which can be removed by running the ``-simplifycfg`` pass
 905 afterwards).
 906
 907 ``-lowerswitch``: Lower ``SwitchInst``\ s to branches
 908 -----------------------------------------------------
 909
 910 Rewrites switch instructions with a sequence of branches, which allows targets
 911 to get away with not implementing the switch instruction until it is
 912 convenient.
 913
 914 .. _passes-mem2reg:
 915
 916 ``-mem2reg``: Promote Memory to Register
 917 ----------------------------------------
 918
 919 This file promotes memory references to be register references.  It promotes
 920 alloca instructions which only have loads and stores as uses.  An ``alloca`` is
 921 transformed by using dominator frontiers to place phi nodes, then traversing
 922 the function in depth-first order to rewrite loads and stores as appropriate.
 923 This is just the standard SSA construction algorithm to construct "pruned" SSA
 924 form.
 925
 926 ``-memcpyopt``: MemCpy Optimization
 927 -----------------------------------
 928
 929 This pass performs various transformations related to eliminating ``memcpy``
 930 calls, or transforming sets of stores into ``memset``\ s.
 931
 932 ``-mergefunc``: Merge Functions
 933 -------------------------------
 934
 935 This pass looks for equivalent functions that are mergeable and folds them.
 936
 937 Total-ordering is introduced among the functions set: we define comparison
 938 that answers for every two functions which of them is greater. It allows to
 939 arrange functions into the binary tree.
 940
 941 For every new function we check for equivalent in tree.
 942
 943 If equivalent exists we fold such functions. If both functions are overridable,
 944 we move the functionality into a new internal function and leave two
 945 overridable thunks to it.
 946
 947 If there is no equivalent, then we add this function to tree.
 948
 949 Lookup routine has O(log(n)) complexity, while whole merging process has
 950 complexity of O(n*log(n)).
 951
 952 Read
 953 :doc:`this <MergeFunctions>`
 954 article for more details.
 955
 956 ``-mergereturn``: Unify function exit nodes
 957 -------------------------------------------
 958
 959 Ensure that functions have at most one ``ret`` instruction in them.
 960 Additionally, it keeps track of which node is the new exit node of the CFG.
 961
 962 ``-partial-inliner``: Partial Inliner
 963 -------------------------------------
 964
 965 This pass performs partial inlining, typically by inlining an ``if`` statement
 966 that surrounds the body of the function.
 967
 968 ``-prune-eh``: Remove unused exception handling info
 969 ----------------------------------------------------
 970
 971 This file implements a simple interprocedural pass which walks the call-graph,
 972 turning invoke instructions into call instructions if and only if the callee
 973 cannot throw an exception.  It implements this as a bottom-up traversal of the
 974 call-graph.
 975
 976 ``-reassociate``: Reassociate expressions
 977 -----------------------------------------
 978
 979 This pass reassociates commutative expressions in an order that is designed to
 980 promote better constant propagation, GCSE, :ref:`LICM <passes-licm>`, PRE, etc.
 981
 982 For example: 4 + (x + 5) ⇒ x + (4 + 5)
 983
 984 In the implementation of this algorithm, constants are assigned rank = 0,
 985 function arguments are rank = 1, and other values are assigned ranks
 986 corresponding to the reverse post order traversal of current function (starting
 987 at 2), which effectively gives values in deep loops higher rank than values not
 988 in loops.
 989
 990 ``-rel-lookup-table-converter``: Relative lookup table converter
 991 ----------------------------------------------------------------
 992
 993 This pass converts lookup tables to PIC-friendly relative lookup tables.
 994
 995 ``-reg2mem``: Demote all values to stack slots
 996 ----------------------------------------------
 997
 998 This file demotes all registers to memory references.  It is intended to be the
 999 inverse of :ref:`mem2reg <passes-mem2reg>`.  By converting to ``load``
1000 instructions, the only values live across basic blocks are ``alloca``
1001 instructions and ``load`` instructions before ``phi`` nodes.  It is intended
1002 that this should make CFG hacking much easier.  To make later hacking easier,
1003 the entry block is split into two, such that all introduced ``alloca``
1004 instructions (and nothing else) are in the entry block.
1005
1006 ``-sroa``: Scalar Replacement of Aggregates
1007 ------------------------------------------------------
1008
1009 The well-known scalar replacement of aggregates transformation.  This transform
1010 breaks up ``alloca`` instructions of aggregate type (structure or array) into
1011 individual ``alloca`` instructions for each member if possible.  Then, if
1012 possible, it transforms the individual ``alloca`` instructions into nice clean
1013 scalar SSA form.
1014
1015 .. _passes-sccp:
1016
1017 ``-sccp``: Sparse Conditional Constant Propagation
1018 --------------------------------------------------
1019
1020 Sparse conditional constant propagation and merging, which can be summarized
1021 as:
1022
1023 * Assumes values are constant unless proven otherwise
1024 * Assumes BasicBlocks are dead unless proven otherwise
1025 * Proves values to be constant, and replaces them with constants
1026 * Proves conditional branches to be unconditional
1027
1028 Note that this pass has a habit of making definitions be dead.  It is a good
1029 idea to run a :ref:`DCE <passes-dce>` pass sometime after running this pass.
1030
1031 .. _passes-simplifycfg:
1032
1033 ``-simplifycfg``: Simplify the CFG
1034 ----------------------------------
1035
1036 Performs dead code elimination and basic block merging.  Specifically:
1037
1038 * Removes basic blocks with no predecessors.
1039 * Merges a basic block into its predecessor if there is only one and the
1040   predecessor only has one successor.
1041 * Eliminates PHI nodes for basic blocks with a single predecessor.
1042 * Eliminates a basic block that only contains an unconditional branch.
1043
1044 ``-sink``: Code sinking
1045 -----------------------
1046
1047 This pass moves instructions into successor blocks, when possible, so that they
1048 aren't executed on paths where their results aren't needed.
1049
1050 ``-strip``: Strip all symbols from a module
1051 -------------------------------------------
1052
1053 Performs code stripping.  This transformation can delete:
1054
1055 * names for virtual registers
1056 * symbols for internal globals and functions
1057 * debug information
1058
1059 Note that this transformation makes code much less readable, so it should only
1060 be used in situations where the strip utility would be used, such as reducing
1061 code size or making it harder to reverse engineer code.
1062
1063 ``-strip-dead-debug-info``: Strip debug info for unused symbols
1064 ---------------------------------------------------------------
1065
1066 .. FIXME: this description is the same as for -strip
1067
1068 performs code stripping. this transformation can delete:
1069
1070 * names for virtual registers
1071 * symbols for internal globals and functions
1072 * debug information
1073
1074 note that this transformation makes code much less readable, so it should only
1075 be used in situations where the strip utility would be used, such as reducing
1076 code size or making it harder to reverse engineer code.
1077
1078 ``-strip-dead-prototypes``: Strip Unused Function Prototypes
1079 ------------------------------------------------------------
1080
1081 This pass loops over all of the functions in the input module, looking for dead
1082 declarations and removes them.  Dead declarations are declarations of functions
1083 for which no implementation is available (i.e., declarations for unused library
1084 functions).
1085
1086 ``-strip-debug-declare``: Strip all ``llvm.dbg.declare`` intrinsics
1087 -------------------------------------------------------------------
1088
1089 .. FIXME: this description is the same as for -strip
1090
1091 This pass implements code stripping.  Specifically, it can delete:
1092
1093 #. names for virtual registers
1094 #. symbols for internal globals and functions
1095 #. debug information
1096
1097 Note that this transformation makes code much less readable, so it should only
1098 be used in situations where the 'strip' utility would be used, such as reducing
1099 code size or making it harder to reverse engineer code.
1100
1101 ``-strip-nondebug``: Strip all symbols, except dbg symbols, from a module
1102 -------------------------------------------------------------------------
1103
1104 .. FIXME: this description is the same as for -strip
1105
1106 This pass implements code stripping.  Specifically, it can delete:
1107
1108 #. names for virtual registers
1109 #. symbols for internal globals and functions
1110 #. debug information
1111
1112 Note that this transformation makes code much less readable, so it should only
1113 be used in situations where the 'strip' utility would be used, such as reducing
1114 code size or making it harder to reverse engineer code.
1115
1116 ``-tailcallelim``: Tail Call Elimination
1117 ----------------------------------------
1118
1119 This file transforms calls of the current function (self recursion) followed by
1120 a return instruction with a branch to the entry of the function, creating a
1121 loop.  This pass also implements the following extensions to the basic
1122 algorithm:
1123
1124 #. Trivial instructions between the call and return do not prevent the
1125    transformation from taking place, though currently the analysis cannot
1126    support moving any really useful instructions (only dead ones).
1127 #. This pass transforms functions that are prevented from being tail recursive
1128    by an associative expression to use an accumulator variable, thus compiling
1129    the typical naive factorial or fib implementation into efficient code.
1130 #. TRE is performed if the function returns void, if the return returns the
1131    result returned by the call, or if the function returns a run-time constant
1132    on all exits from the function.  It is possible, though unlikely, that the
1133    return returns something else (like constant 0), and can still be TRE'd.  It
1134    can be TRE'd if *all other* return instructions in the function return the
1135    exact same value.
1136 #. If it can prove that callees do not access their caller stack frame, they
1137    are marked as eligible for tail call elimination (by the code generator).
1138
1139 Utility Passes
1140 ==============
1141
1142 This section describes the LLVM Utility Passes.
1143
1144 ``-deadarghaX0r``: Dead Argument Hacking (BUGPOINT USE ONLY; DO NOT USE)
1145 ------------------------------------------------------------------------
1146
1147 Same as dead argument elimination, but deletes arguments to functions which are
1148 external.  This is only for use by :doc:`bugpoint <Bugpoint>`.
1149
1150 ``-extract-blocks``: Extract Basic Blocks From Module (for bugpoint use)
1151 ------------------------------------------------------------------------
1152
1153 This pass is used by bugpoint to extract all blocks from the module into their
1154 own functions.
1155
1156 ``-instnamer``: Assign names to anonymous instructions
1157 ------------------------------------------------------
1158
1159 This is a little utility pass that gives instructions names, this is mostly
1160 useful when diffing the effect of an optimization because deleting an unnamed
1161 instruction can change all other instruction numbering, making the diff very
1162 noisy.
1163
1164 .. _passes-verify:
1165
1166 ``-verify``: Module Verifier
1167 ----------------------------
1168
1169 Verifies an LLVM IR code.  This is useful to run after an optimization which is
1170 undergoing testing.  Note that llvm-as verifies its input before emitting
1171 bitcode, and also that malformed bitcode is likely to make LLVM crash.  All
1172 language front-ends are therefore encouraged to verify their output before
1173 performing optimizing transformations.
1174
1175 #. Both of a binary operator's parameters are of the same type.
1176 #. Verify that the indices of mem access instructions match other operands.
1177 #. Verify that arithmetic and other things are only performed on first-class
1178    types.  Verify that shifts and logicals only happen on integrals f.e.
1179 #. All of the constants in a switch statement are of the correct type.
1180 #. The code is in valid SSA form.
1181 #. It is illegal to put a label into any other type (like a structure) or to
1182    return one.
1183 #. Only phi nodes can be self referential: ``%x = add i32 %x``, ``%x`` is
1184    invalid.
1185 #. PHI nodes must have an entry for each predecessor, with no extras.
1186 #. PHI nodes must be the first thing in a basic block, all grouped together.
1187 #. PHI nodes must have at least one entry.
1188 #. All basic blocks should only end with terminator insts, not contain them.
1189 #. The entry node to a function must not have predecessors.
1190 #. All Instructions must be embedded into a basic block.
1191 #. Functions cannot take a void-typed parameter.
1192 #. Verify that a function's argument list agrees with its declared type.
1193 #. It is illegal to specify a name for a void value.
1194 #. It is illegal to have an internal global value with no initializer.
1195 #. It is illegal to have a ``ret`` instruction that returns a value that does
1196    not agree with the function return value type.
1197 #. Function call argument types match the function prototype.
1198 #. All other things that are tested by asserts spread about the code.
1199
1200 Note that this does not provide full security verification (like Java), but
1201 instead just tries to ensure that code is well-formed.
1202
1203 .. _passes-view-cfg:
1204
1205 ``-view-cfg``: View CFG of function
1206 -----------------------------------
1207
1208 Displays the control flow graph using the GraphViz tool.
1209 Additionally the ``-cfg-func-name=<substring>`` option can be used to filter the
1210 functions that are displayed. All functions that contain the specified substring
1211 will be displayed.
1212
1213 ``-view-cfg-only``: View CFG of function (with no function bodies)
1214 ------------------------------------------------------------------
1215
1216 Displays the control flow graph using the GraphViz tool, but omitting function
1217 bodies.
1218 Additionally the ``-cfg-func-name=<substring>`` option can be used to filter the
1219 functions that are displayed. All functions that contain the specified substring
1220 will be displayed.
1221
1222 ``-view-dom``: View dominance tree of function
1223 ----------------------------------------------
1224
1225 Displays the dominator tree using the GraphViz tool.
1226
1227 ``-view-dom-only``: View dominance tree of function (with no function bodies)
1228 -----------------------------------------------------------------------------
1229
1230 Displays the dominator tree using the GraphViz tool, but omitting function
1231 bodies.
1232
1233 ``-view-postdom``: View postdominance tree of function
1234 ------------------------------------------------------
1235
1236 Displays the post dominator tree using the GraphViz tool.
1237
1238 ``-view-postdom-only``: View postdominance tree of function (with no function bodies)
1239 -------------------------------------------------------------------------------------
1240
1241 Displays the post dominator tree using the GraphViz tool, but omitting function
1242 bodies.
1243
1244 ``-transform-warning``: Report missed forced transformations
1245 ------------------------------------------------------------
1246
1247 Emits warnings about not yet applied forced transformations (e.g. from
1248 ``#pragma omp simd``).