OSDN Git Service

PR gomp/26238
[pf3gnuchains/gcc-fork.git] / gcc / doc / passes.texi
1 @c markers: CROSSREF BUG TODO
2
3 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 @c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
5 @c This is part of the GCC manual.
6 @c For copying conditions, see the file gcc.texi.
7
8 @node Passes
9 @chapter Passes and Files of the Compiler
10 @cindex passes and files of the compiler
11 @cindex files and passes of the compiler
12 @cindex compiler passes and files
13
14 This chapter is dedicated to giving an overview of the optimization and
15 code generation passes of the compiler.  In the process, it describes
16 some of the language front end interface, though this description is no
17 where near complete.
18
19 @menu
20 * Parsing pass::         The language front end turns text into bits.
21 * Gimplification pass::  The bits are turned into something we can optimize.
22 * Pass manager::         Sequencing the optimization passes.
23 * Tree-SSA passes::      Optimizations on a high-level representation.
24 * RTL passes::           Optimizations on a low-level representation.
25 @end menu
26
27 @node Parsing pass
28 @section Parsing pass
29 @cindex GENERIC
30 @findex lang_hooks.parse_file
31 The language front end is invoked only once, via
32 @code{lang_hooks.parse_file}, to parse the entire input.  The language
33 front end may use any intermediate language representation deemed
34 appropriate.  The C front end uses GENERIC trees (CROSSREF), plus
35 a double handful of language specific tree codes defined in
36 @file{c-common.def}.  The Fortran front end uses a completely different
37 private representation.
38
39 @cindex GIMPLE
40 @cindex gimplification
41 @cindex gimplifier
42 @cindex language-independent intermediate representation
43 @cindex intermediate representation lowering
44 @cindex lowering, language-dependent intermediate representation
45 At some point the front end must translate the representation used in the
46 front end to a representation understood by the language-independent
47 portions of the compiler.  Current practice takes one of two forms.
48 The C front end manually invokes the gimplifier (CROSSREF) on each function,
49 and uses the gimplifier callbacks to convert the language-specific tree
50 nodes directly to GIMPLE (CROSSREF) before passing the function off to
51 be compiled.
52 The Fortran front end converts from a private representation to GENERIC,
53 which is later lowered to GIMPLE when the function is compiled.  Which
54 route to choose probably depends on how well GENERIC (plus extensions)
55 can be made to match up with the source language and necessary parsing
56 data structures.
57
58 BUG: Gimplification must occur before nested function lowering,
59 and nested function lowering must be done by the front end before
60 passing the data off to cgraph.
61
62 TODO: Cgraph should control nested function lowering.  It would
63 only be invoked when it is certain that the outer-most function
64 is used.
65
66 TODO: Cgraph needs a gimplify_function callback.  It should be
67 invoked when (1) it is certain that the function is used, (2)
68 warning flags specified by the user require some amount of
69 compilation in order to honor, (3) the language indicates that
70 semantic analysis is not complete until gimplification occurs.
71 Hum@dots{} this sounds overly complicated.  Perhaps we should just
72 have the front end gimplify always; in most cases it's only one
73 function call.
74
75 The front end needs to pass all function definitions and top level
76 declarations off to the middle-end so that they can be compiled and
77 emitted to the object file.  For a simple procedural language, it is
78 usually most convenient to do this as each top level declaration or
79 definition is seen.  There is also a distinction to be made between
80 generating functional code and generating complete debug information.
81 The only thing that is absolutely required for functional code is that
82 function and data @emph{definitions} be passed to the middle-end.  For
83 complete debug information, function, data and type declarations
84 should all be passed as well.
85
86 @findex rest_of_decl_compilation
87 @findex rest_of_type_compilation
88 @findex cgraph_finalize_function
89 In any case, the front end needs each complete top-level function or
90 data declaration, and each data definition should be passed to
91 @code{rest_of_decl_compilation}.  Each complete type definition should
92 be passed to @code{rest_of_type_compilation}.  Each function definition
93 should be passed to @code{cgraph_finalize_function}.
94
95 TODO: I know rest_of_compilation currently has all sorts of
96 rtl-generation semantics.  I plan to move all code generation
97 bits (both tree and rtl) to compile_function.  Should we hide
98 cgraph from the front ends and move back to rest_of_compilation
99 as the official interface?  Possibly we should rename all three
100 interfaces such that the names match in some meaningful way and
101 that is more descriptive than "rest_of".
102
103 The middle-end will, at its option, emit the function and data
104 definitions immediately or queue them for later processing.
105
106 @node Gimplification pass
107 @section Gimplification pass
108
109 @cindex gimplification
110 @cindex GIMPLE
111 @dfn{Gimplification} is a whimsical term for the process of converting
112 the intermediate representation of a function into the GIMPLE language
113 (CROSSREF).  The term stuck, and so words like ``gimplification'',
114 ``gimplify'', ``gimplifier'' and the like are sprinkled throughout this
115 section of code.
116
117 @cindex GENERIC
118 While a front end may certainly choose to generate GIMPLE directly if
119 it chooses, this can be a moderately complex process unless the
120 intermediate language used by the front end is already fairly simple.
121 Usually it is easier to generate GENERIC trees plus extensions
122 and let the language-independent gimplifier do most of the work.
123
124 @findex gimplify_function_tree
125 @findex gimplify_expr
126 @findex lang_hooks.gimplify_expr
127 The main entry point to this pass is @code{gimplify_function_tree}
128 located in @file{gimplify.c}.  From here we process the entire
129 function gimplifying each statement in turn.  The main workhorse
130 for this pass is @code{gimplify_expr}.  Approximately everything
131 passes through here at least once, and it is from here that we
132 invoke the @code{lang_hooks.gimplify_expr} callback.
133
134 The callback should examine the expression in question and return
135 @code{GS_UNHANDLED} if the expression is not a language specific
136 construct that requires attention.  Otherwise it should alter the
137 expression in some way to such that forward progress is made toward
138 producing valid GIMPLE@.  If the callback is certain that the
139 transformation is complete and the expression is valid GIMPLE, it
140 should return @code{GS_ALL_DONE}.  Otherwise it should return
141 @code{GS_OK}, which will cause the expression to be processed again.
142 If the callback encounters an error during the transformation (because
143 the front end is relying on the gimplification process to finish
144 semantic checks), it should return @code{GS_ERROR}.
145
146 @node Pass manager
147 @section Pass manager
148
149 The pass manager is located in @file{passes.c}, @file{tree-optimize.c}
150 and @file{tree-pass.h}.
151 Its job is to run all of the individual passes in the correct order,
152 and take care of standard bookkeeping that applies to every pass.
153
154 The theory of operation is that each pass defines a structure that
155 represents everything we need to know about that pass---when it
156 should be run, how it should be run, what intermediate language
157 form or on-the-side data structures it needs.  We register the pass
158 to be run in some particular order, and the pass manager arranges
159 for everything to happen in the correct order.
160
161 The actuality doesn't completely live up to the theory at present.
162 Command-line switches and @code{timevar_id_t} enumerations must still
163 be defined elsewhere.  The pass manager validates constraints but does
164 not attempt to (re-)generate data structures or lower intermediate
165 language form based on the requirements of the next pass.  Nevertheless,
166 what is present is useful, and a far sight better than nothing at all.
167
168 TODO: describe the global variables set up by the pass manager,
169 and a brief description of how a new pass should use it.
170 I need to look at what info rtl passes use first...
171
172 @node Tree-SSA passes
173 @section Tree-SSA passes
174
175 The following briefly describes the tree optimization passes that are
176 run after gimplification and what source files they are located in.
177
178 @itemize @bullet
179 @item Remove useless statements
180
181 This pass is an extremely simple sweep across the gimple code in which
182 we identify obviously dead code and remove it.  Here we do things like
183 simplify @code{if} statements with constant conditions, remove
184 exception handling constructs surrounding code that obviously cannot
185 throw, remove lexical bindings that contain no variables, and other
186 assorted simplistic cleanups.  The idea is to get rid of the obvious
187 stuff quickly rather than wait until later when it's more work to get
188 rid of it.  This pass is located in @file{tree-cfg.c} and described by
189 @code{pass_remove_useless_stmts}.
190
191 @item Mudflap declaration registration
192
193 If mudflap (@pxref{Optimize Options,,-fmudflap -fmudflapth
194 -fmudflapir,gcc.info,Using the GNU Compiler Collection (GCC)}) is
195 enabled, we generate code to register some variable declarations with
196 the mudflap runtime.  Specifically, the runtime tracks the lifetimes of
197 those variable declarations that have their addresses taken, or whose
198 bounds are unknown at compile time (@code{extern}).  This pass generates
199 new exception handling constructs (@code{try}/@code{finally}), and so
200 must run before those are lowered.  In addition, the pass enqueues
201 declarations of static variables whose lifetimes extend to the entire
202 program.  The pass is located in @file{tree-mudflap.c} and is described
203 by @code{pass_mudflap_1}.
204
205 @item OpenMP lowerering
206
207 If OpenMP generation (@option{-fopenmp}) is enabled, this pass lowers
208 OpenMP constructs into GIMPLE.
209
210 Lowering of OpenMP constructs involves creating replacement
211 expressions for local variables that have been mapped using data
212 sharing clauses, exposing the control flow of most synchronization
213 directives and adding region markers to facilitate the creation of the
214 control flow graph.  The pass is located in @file{omp-low.c} and is
215 described by @code{pass_lower_omp}.
216
217 @item OpenMP expansion
218
219 If OpenMP generation (@option{-fopenmp}) is enabled, this pass expands
220 parallel regions into their own functions to be invoked by the thread
221 library.  The pass is located in @file{omp-low.c} and is described by
222 @code{pass_expand_omp}.
223
224 @item Lower control flow
225
226 This pass flattens @code{if} statements (@code{COND_EXPR}) and
227 and moves lexical bindings (@code{BIND_EXPR}) out of line.  After
228 this pass, all @code{if} statements will have exactly two @code{goto}
229 statements in its @code{then} and @code{else} arms.  Lexical binding
230 information for each statement will be found in @code{TREE_BLOCK} rather
231 than being inferred from its position under a @code{BIND_EXPR}.  This
232 pass is found in @file{gimple-low.c} and is described by
233 @code{pass_lower_cf}.
234
235 @item Lower exception handling control flow
236
237 This pass decomposes high-level exception handling constructs
238 (@code{TRY_FINALLY_EXPR} and @code{TRY_CATCH_EXPR}) into a form
239 that explicitly represents the control flow involved.  After this
240 pass, @code{lookup_stmt_eh_region} will return a non-negative
241 number for any statement that may have EH control flow semantics;
242 examine @code{tree_can_throw_internal} or @code{tree_can_throw_external}
243 for exact semantics.  Exact control flow may be extracted from
244 @code{foreach_reachable_handler}.  The EH region nesting tree is defined
245 in @file{except.h} and built in @file{except.c}.  The lowering pass
246 itself is in @file{tree-eh.c} and is described by @code{pass_lower_eh}.
247
248 @item Build the control flow graph
249
250 This pass decomposes a function into basic blocks and creates all of
251 the edges that connect them.  It is located in @file{tree-cfg.c} and
252 is described by @code{pass_build_cfg}.
253
254 @item Find all referenced variables
255
256 This pass walks the entire function and collects an array of all
257 variables referenced in the function, @code{referenced_vars}.  The
258 index at which a variable is found in the array is used as a UID
259 for the variable within this function.  This data is needed by the
260 SSA rewriting routines.  The pass is located in @file{tree-dfa.c}
261 and is described by @code{pass_referenced_vars}.
262
263 @item Enter static single assignment form
264
265 This pass rewrites the function such that it is in SSA form.  After
266 this pass, all @code{is_gimple_reg} variables will be referenced by
267 @code{SSA_NAME}, and all occurrences of other variables will be
268 annotated with @code{VDEFS} and @code{VUSES}; phi nodes will have
269 been inserted as necessary for each basic block.  This pass is
270 located in @file{tree-ssa.c} and is described by @code{pass_build_ssa}.
271
272 @item Warn for uninitialized variables
273
274 This pass scans the function for uses of @code{SSA_NAME}s that
275 are fed by default definition.  For non-parameter variables, such
276 uses are uninitialized.  The pass is run twice, before and after
277 optimization.  In the first pass we only warn for uses that are
278 positively uninitialized; in the second pass we warn for uses that
279 are possibly uninitialized.  The pass is located in @file{tree-ssa.c}
280 and is defined by @code{pass_early_warn_uninitialized} and
281 @code{pass_late_warn_uninitialized}.
282
283 @item Dead code elimination
284
285 This pass scans the function for statements without side effects whose
286 result is unused.  It does not do memory life analysis, so any value
287 that is stored in memory is considered used.  The pass is run multiple
288 times throughout the optimization process.  It is located in
289 @file{tree-ssa-dce.c} and is described by @code{pass_dce}.
290
291 @item Dominator optimizations
292
293 This pass performs trivial dominator-based copy and constant propagation,
294 expression simplification, and jump threading.  It is run multiple times
295 throughout the optimization process.  It it located in @file{tree-ssa-dom.c}
296 and is described by @code{pass_dominator}.
297
298 @item Redundant phi elimination
299
300 This pass removes phi nodes for which all of the arguments are the same
301 value, excluding feedback.  Such degenerate forms are typically created
302 by removing unreachable code.  The pass is run multiple times throughout
303 the optimization process.  It is located in @file{tree-ssa.c} and is
304 described by @code{pass_redundant_phi}.o
305
306 @item Forward propagation of single-use variables
307
308 This pass attempts to remove redundant computation by substituting
309 variables that are used once into the expression that uses them and
310 seeing if the result can be simplified.  It is located in
311 @file{tree-ssa-forwprop.c} and is described by @code{pass_forwprop}.
312
313 @item Copy Renaming
314
315 This pass attempts to change the name of compiler temporaries involved in
316 copy operations such that SSA->normal can coalesce the copy away.  When compiler
317 temporaries are copies of user variables, it also renames the compiler
318 temporary to the user variable resulting in better use of user symbols.  It is
319 located in @file{tree-ssa-copyrename.c} and is described by
320 @code{pass_copyrename}.
321
322 @item PHI node optimizations
323
324 This pass recognizes forms of phi inputs that can be represented as
325 conditional expressions and rewrites them into straight line code.
326 It is located in @file{tree-ssa-phiopt.c} and is described by
327 @code{pass_phiopt}.
328
329 @item May-alias optimization
330
331 This pass performs a flow sensitive SSA-based points-to analysis.
332 The resulting may-alias, must-alias, and escape analysis information
333 is used to promote variables from in-memory addressable objects to
334 non-aliased variables that can be renamed into SSA form.  We also
335 update the @code{VDEF}/@code{VUSE} memory tags for non-renamable
336 aggregates so that we get fewer false kills.  The pass is located
337 in @file{tree-ssa-alias.c} and is described by @code{pass_may_alias}.
338
339 @item Profiling
340
341 This pass rewrites the function in order to collect runtime block
342 and value profiling data.  Such data may be fed back into the compiler
343 on a subsequent run so as to allow optimization based on expected
344 execution frequencies.  The pass is located in @file{predict.c} and
345 is described by @code{pass_profile}.
346
347 @item Lower complex arithmetic
348
349 This pass rewrites complex arithmetic operations into their component
350 scalar arithmetic operations.  The pass is located in @file{tree-complex.c}
351 and is described by @code{pass_lower_complex}.
352
353 @item Scalar replacement of aggregates
354
355 This pass rewrites suitable non-aliased local aggregate variables into
356 a set of scalar variables.  The resulting scalar variables are
357 rewritten into SSA form, which allows subsequent optimization passes
358 to do a significantly better job with them.  The pass is located in
359 @file{tree-sra.c} and is described by @code{pass_sra}.
360
361 @item Dead store elimination
362
363 This pass eliminates stores to memory that are subsequently overwritten
364 by another store, without any intervening loads.  The pass is located
365 in @file{tree-ssa-dse.c} and is described by @code{pass_dse}.
366
367 @item Tail recursion elimination
368
369 This pass transforms tail recursion into a loop.  It is located in
370 @file{tree-tailcall.c} and is described by @code{pass_tail_recursion}.
371
372 @item Forward store motion
373
374 This pass sinks stores and assignments down the flowgraph closer to it's
375 use point.  The pass is located in @file{tree-ssa-sink.c} and is
376 described by @code{pass_sink_code}.
377
378 @item Partial redundancy elimination
379
380 This pass eliminates partially redundant computations, as well as
381 performing load motion.  The pass is located in @file{tree-ssa-pre.c}
382 and is described by @code{pass_pre}.
383
384 Just before partial redundancy elimination, if
385 @option{-funsafe-math-optimizations} is on, GCC tries to convert
386 divisions to multiplications by the reciprocal.  The pass is located
387 in @file{tree-ssa-math-opts.c} and is described by
388 @code{pass_cse_reciprocal}.
389
390 @item Loop optimization
391
392 The main driver of the pass is placed in @file{tree-ssa-loop.c}
393 and described by @code{pass_loop}.
394
395 The optimizations performed by this pass are:
396
397 Loop invariant motion.  This pass moves only invariants that
398 would be hard to handle on rtl level (function calls, operations that expand to
399 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
400 operands of conditions that are invariant out of the loop, so that we can use
401 just trivial invariantness analysis in loop unswitching.  The pass also includes
402 store motion.  The pass is implemented in @file{tree-ssa-loop-im.c}.
403
404 Canonical induction variable creation.  This pass creates a simple counter
405 for number of iterations of the loop and replaces the exit condition of the
406 loop using it, in case when a complicated analysis is necessary to determine
407 the number of iterations.  Later optimizations then may determine the number
408 easily.  The pass is implemented in @file{tree-ssa-loop-ivcanon.c}.
409
410 Induction variable optimizations.  This pass performs standard induction
411 variable optimizations, including strength reduction, induction variable
412 merging and induction variable elimination.  The pass is implemented in
413 @file{tree-ssa-loop-ivopts.c}.
414
415 Loop unswitching.  This pass moves the conditional jumps that are invariant
416 out of the loops.  To achieve this, a duplicate of the loop is created for
417 each possible outcome of conditional jump(s).  The pass is implemented in
418 @file{tree-ssa-loop-unswitch.c}.  This pass should eventually replace the
419 rtl-level loop unswitching in @file{loop-unswitch.c}, but currently
420 the rtl-level pass is not completely redundant yet due to deficiencies
421 in tree level alias analysis.
422
423 The optimizations also use various utility functions contained in
424 @file{tree-ssa-loop-manip.c}, @file{cfgloop.c}, @file{cfgloopanal.c} and
425 @file{cfgloopmanip.c}.
426
427 Vectorization.  This pass transforms loops to operate on vector types
428 instead of scalar types.  Data parallelism across loop iterations is exploited
429 to group data elements from consecutive iterations into a vector and operate 
430 on them in parallel.  Depending on available target support the loop is 
431 conceptually unrolled by a factor @code{VF} (vectorization factor), which is
432 the number of elements operated upon in parallel in each iteration, and the 
433 @code{VF} copies of each scalar operation are fused to form a vector operation.
434 Additional loop transformations such as peeling and versioning may take place
435 to align the number of iterations, and to align the memory accesses in the loop.
436 The pass is implemented in @file{tree-vectorizer.c} (the main driver and general
437 utilities), @file{tree-vect-analyze.c} and @file{tree-vect-transform.c}.
438 Analysis of data references is in @file{tree-data-ref.c}.
439
440 @item Tree level if-conversion for vectorizer
441
442 This pass applies if-conversion to simple loops to help vectorizer.
443 We identify if convertable loops, if-convert statements and merge
444 basic blocks in one big block.  The idea is to present loop in such
445 form so that vectorizer can have one to one mapping between statements
446 and available vector operations.  This patch re-introduces COND_EXPR
447 at GIMPLE level.  This pass is located in @file{tree-if-conv.c}.
448
449 @item Conditional constant propagation
450
451 This pass relaxes a lattice of values in order to identify those
452 that must be constant even in the presence of conditional branches.
453 The pass is located in @file{tree-ssa-ccp.c} and is described
454 by @code{pass_ccp}.
455
456 @item Folding builtin functions
457
458 This pass simplifies builtin functions, as applicable, with constant
459 arguments or with inferrable string lengths.  It is located in
460 @file{tree-ssa-ccp.c} and is described by @code{pass_fold_builtins}.
461
462 @item Split critical edges
463
464 This pass identifies critical edges and inserts empty basic blocks
465 such that the edge is no longer critical.  The pass is located in
466 @file{tree-cfg.c} and is described by @code{pass_split_crit_edges}.
467
468 @item Partial redundancy elimination
469
470 This pass answers the question ``given a hypothetical temporary
471 variable, what expressions could we eliminate?''  It is located
472 in @file{tree-ssa-pre.c} and is described by @code{pass_pre}.
473
474 @item Control dependence dead code elimination
475
476 This pass is a stronger form of dead code elimination that can
477 eliminate unnecessary control flow statements.   It is located
478 in @file{tree-ssa-dce.c} and is described by @code{pass_cd_dce}.
479
480 @item Tail call elimination
481
482 This pass identifies function calls that may be rewritten into
483 jumps.  No code transformation is actually applied here, but the
484 data and control flow problem is solved.  The code transformation
485 requires target support, and so is delayed until RTL@.  In the
486 meantime @code{CALL_EXPR_TAILCALL} is set indicating the possibility.
487 The pass is located in @file{tree-tailcall.c} and is described by
488 @code{pass_tail_calls}.  The RTL transformation is handled by
489 @code{fixup_tail_calls} in @file{calls.c}.
490
491 @item Warn for function return without value
492
493 For non-void functions, this pass locates return statements that do
494 not specify a value and issues a warning.  Such a statement may have
495 been injected by falling off the end of the function.  This pass is
496 run last so that we have as much time as possible to prove that the
497 statement is not reachable.  It is located in @file{tree-cfg.c} and
498 is described by @code{pass_warn_function_return}.
499
500 @item Mudflap statement annotation
501
502 If mudflap is enabled, we rewrite some memory accesses with code to
503 validate that the memory access is correct.  In particular, expressions
504 involving pointer dereferences (@code{INDIRECT_REF}, @code{ARRAY_REF},
505 etc.) are replaced by code that checks the selected address range
506 against the mudflap runtime's database of valid regions.  This check
507 includes an inline lookup into a direct-mapped cache, based on
508 shift/mask operations of the pointer value, with a fallback function
509 call into the runtime.  The pass is located in @file{tree-mudflap.c} and
510 is described by @code{pass_mudflap_2}.
511
512 @item Leave static single assignment form
513
514 This pass rewrites the function such that it is in normal form.  At
515 the same time, we eliminate as many single-use temporaries as possible,
516 so the intermediate language is no longer GIMPLE, but GENERIC@.  The
517 pass is located in @file{tree-ssa.c} and is described by @code{pass_del_ssa}.
518 @end itemize
519
520 @node RTL passes
521 @section RTL passes
522
523 The following briefly describes the rtl generation and optimization
524 passes that are run after tree optimization.
525
526 @itemize @bullet
527 @item RTL generation
528
529 @c Avoiding overfull is tricky here.
530 The source files for RTL generation include
531 @file{stmt.c},
532 @file{calls.c},
533 @file{expr.c},
534 @file{explow.c},
535 @file{expmed.c},
536 @file{function.c},
537 @file{optabs.c}
538 and @file{emit-rtl.c}.
539 Also, the file
540 @file{insn-emit.c}, generated from the machine description by the
541 program @code{genemit}, is used in this pass.  The header file
542 @file{expr.h} is used for communication within this pass.
543
544 @findex genflags
545 @findex gencodes
546 The header files @file{insn-flags.h} and @file{insn-codes.h},
547 generated from the machine description by the programs @code{genflags}
548 and @code{gencodes}, tell this pass which standard names are available
549 for use and which patterns correspond to them.
550
551 @item Generate exception handling landing pads
552
553 This pass generates the glue that handles communication between the
554 exception handling library routines and the exception handlers within
555 the function.  Entry points in the function that are invoked by the
556 exception handling library are called @dfn{landing pads}.  The code
557 for this pass is located within @file{except.c}.
558
559 @item Cleanup control flow graph
560
561 This pass removes unreachable code, simplifies jumps to next, jumps to
562 jump, jumps across jumps, etc.  The pass is run multiple times.
563 For historical reasons, it is occasionally referred to as the ``jump
564 optimization pass''.  The bulk of the code for this pass is in
565 @file{cfgcleanup.c}, and there are support routines in @file{cfgrtl.c}
566 and @file{jump.c}.
567
568 @item Common subexpression elimination
569
570 This pass removes redundant computation within basic blocks, and
571 optimizes addressing modes based on cost.  The pass is run twice.
572 The source is located in @file{cse.c}.
573
574 @item Global common subexpression elimination.
575
576 This pass performs two
577 different types of GCSE  depending on whether you are optimizing for
578 size or not (LCM based GCSE tends to increase code size for a gain in
579 speed, while Morel-Renvoise based GCSE does not).
580 When optimizing for size, GCSE is done using Morel-Renvoise Partial
581 Redundancy Elimination, with the exception that it does not try to move
582 invariants out of loops---that is left to  the loop optimization pass.
583 If MR PRE GCSE is done, code hoisting (aka unification) is also done, as
584 well as load motion.
585 If you are optimizing for speed, LCM (lazy code motion) based GCSE is
586 done.  LCM is based on the work of Knoop, Ruthing, and Steffen.  LCM
587 based GCSE also does loop invariant code motion.  We also perform load
588 and store motion when optimizing for speed.
589 Regardless of which type of GCSE is used, the GCSE pass also performs
590 global constant and  copy propagation.
591 The source file for this pass is @file{gcse.c}, and the LCM routines
592 are in @file{lcm.c}.
593
594 @item Loop optimization
595
596 This pass performs several loop related optimizations.
597 The source files @file{cfgloopanal.c} and @file{cfgloopmanip.c} contain
598 generic loop analysis and manipulation code.  Initialization and finalization
599 of loop structures is handled by @file{loop-init.c}.
600 A loop invariant motion pass is implemented in @file{loop-invariant.c}.
601 Basic block level optimizations---unrolling, peeling and unswitching loops---
602 are implemented in @file{loop-unswitch.c} and @file{loop-unroll.c}.
603 Replacing of the exit condition of loops by special machine-dependent
604 instructions is handled by @file{loop-doloop.c}.
605
606 @item Jump bypassing
607
608 This pass is an aggressive form of GCSE that transforms the control
609 flow graph of a function by propagating constants into conditional
610 branch instructions.  The source file for this pass is @file{gcse.c}.
611
612 @item If conversion
613
614 This pass attempts to replace conditional branches and surrounding
615 assignments with arithmetic, boolean value producing comparison
616 instructions, and conditional move instructions.  In the very last
617 invocation after reload, it will generate predicated instructions
618 when supported by the target.  The pass is located in @file{ifcvt.c}.
619
620 @item Web construction
621
622 This pass splits independent uses of each pseudo-register.  This can
623 improve effect of the other transformation, such as CSE or register
624 allocation.  Its source files are @file{web.c}.
625
626 @item Life analysis
627
628 This pass computes which pseudo-registers are live at each point in
629 the program, and makes the first instruction that uses a value point
630 at the instruction that computed the value.  It then deletes
631 computations whose results are never used, and combines memory
632 references with add or subtract instructions to make autoincrement or
633 autodecrement addressing.  The pass is located in @file{flow.c}.
634
635 @item Instruction combination
636
637 This pass attempts to combine groups of two or three instructions that
638 are related by data flow into single instructions.  It combines the
639 RTL expressions for the instructions by substitution, simplifies the
640 result using algebra, and then attempts to match the result against
641 the machine description.  The pass is located in @file{combine.c}.
642
643 @item Register movement
644
645 This pass looks for cases where matching constraints would force an
646 instruction to need a reload, and this reload would be a
647 register-to-register move.  It then attempts to change the registers
648 used by the instruction to avoid the move instruction.
649 The pass is located in @file{regmove.c}.
650
651 @item Optimize mode switching
652
653 This pass looks for instructions that require the processor to be in a
654 specific ``mode'' and minimizes the number of mode changes required to
655 satisfy all users.  What these modes are, and what they apply to are
656 completely target-specific.
657 The source is located in @file{mode-switching.c}.
658
659 @cindex modulo scheduling
660 @cindex sms, swing, software pipelining
661 @item Modulo scheduling
662
663 This pass looks at innermost loops and reorders their instructions
664 by overlapping different iterations.  Modulo scheduling is performed
665 immediately before instruction scheduling.
666 The pass is located in (@file{modulo-sched.c}).
667
668 @item Instruction scheduling
669
670 This pass looks for instructions whose output will not be available by
671 the time that it is used in subsequent instructions.  Memory loads and
672 floating point instructions often have this behavior on RISC machines.
673 It re-orders instructions within a basic block to try to separate the
674 definition and use of items that otherwise would cause pipeline
675 stalls.  This pass is performed twice, before and after register
676 allocation.  The pass is located in @file{haifa-sched.c},
677 @file{sched-deps.c}, @file{sched-ebb.c}, @file{sched-rgn.c} and
678 @file{sched-vis.c}.
679
680 @item Register allocation
681
682 These passes make sure that all occurrences of pseudo registers are
683 eliminated, either by allocating them to a hard register, replacing
684 them by an equivalent expression (e.g.@: a constant) or by placing
685 them on the stack.  This is done in several subpasses:
686
687 @itemize @bullet
688 @item
689 Register class preferencing.  The RTL code is scanned to find out
690 which register class is best for each pseudo register.  The source
691 file is @file{regclass.c}.
692
693 @item
694 Local register allocation.  This pass allocates hard registers to
695 pseudo registers that are used only within one basic block.  Because
696 the basic block is linear, it can use fast and powerful techniques to
697 do a decent job.  The source is located in @file{local-alloc.c}.
698
699 @item
700 Global register allocation.  This pass allocates hard registers for
701 the remaining pseudo registers (those whose life spans are not
702 contained in one basic block).  The pass is located in @file{global.c}.
703
704 @cindex reloading
705 @item
706 Reloading.  This pass renumbers pseudo registers with the hardware
707 registers numbers they were allocated.  Pseudo registers that did not
708 get hard registers are replaced with stack slots.  Then it finds
709 instructions that are invalid because a value has failed to end up in
710 a register, or has ended up in a register of the wrong kind.  It fixes
711 up these instructions by reloading the problematical values
712 temporarily into registers.  Additional instructions are generated to
713 do the copying.
714
715 The reload pass also optionally eliminates the frame pointer and inserts
716 instructions to save and restore call-clobbered registers around calls.
717
718 Source files are @file{reload.c} and @file{reload1.c}, plus the header
719 @file{reload.h} used for communication between them.
720 @end itemize
721
722 @item Basic block reordering
723
724 This pass implements profile guided code positioning.  If profile
725 information is not available, various types of static analysis are
726 performed to make the predictions normally coming from the profile
727 feedback (IE execution frequency, branch probability, etc).  It is
728 implemented in the file @file{bb-reorder.c}, and the various
729 prediction routines are in @file{predict.c}.
730
731 @item Variable tracking
732
733 This pass computes where the variables are stored at each
734 position in code and generates notes describing the variable locations
735 to RTL code.  The location lists are then generated according to these
736 notes to debug information if the debugging information format supports
737 location lists.
738
739 @item Delayed branch scheduling
740
741 This optional pass attempts to find instructions that can go into the
742 delay slots of other instructions, usually jumps and calls.  The
743 source file name is @file{reorg.c}.
744
745 @item Branch shortening
746
747 On many RISC machines, branch instructions have a limited range.
748 Thus, longer sequences of instructions must be used for long branches.
749 In this pass, the compiler figures out what how far each instruction
750 will be from each other instruction, and therefore whether the usual
751 instructions, or the longer sequences, must be used for each branch.
752
753 @item Register-to-stack conversion
754
755 Conversion from usage of some hard registers to usage of a register
756 stack may be done at this point.  Currently, this is supported only
757 for the floating-point registers of the Intel 80387 coprocessor.   The
758 source file name is @file{reg-stack.c}.
759
760 @item Final
761
762 This pass outputs the assembler code for the function.  The source files
763 are @file{final.c} plus @file{insn-output.c}; the latter is generated
764 automatically from the machine description by the tool @file{genoutput}.
765 The header file @file{conditions.h} is used for communication between
766 these files.  If mudflap is enabled, the queue of deferred declarations
767 and any addressed constants (e.g., string literals) is processed by
768 @code{mudflap_finish_file} into a synthetic constructor function
769 containing calls into the mudflap runtime.
770
771 @item Debugging information output
772
773 This is run after final because it must output the stack slot offsets
774 for pseudo registers that did not get hard registers.  Source files
775 are @file{dbxout.c} for DBX symbol table format, @file{sdbout.c} for
776 SDB symbol table format, @file{dwarfout.c} for DWARF symbol table
777 format, files @file{dwarf2out.c} and @file{dwarf2asm.c} for DWARF2
778 symbol table format, and @file{vmsdbgout.c} for VMS debug symbol table
779 format.
780
781 @end itemize