2013-02-13 Richard Biener <rguenther@suse.de>
[official-gcc.git] / gcc / cfgloop.h
blob0b2af724e10024043ede1ad14b5433d1241bd7f8
1 /* Natural loop functions
2 Copyright (C) 1987-2013 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
9 version.
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 for more details.
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
20 #ifndef GCC_CFGLOOP_H
21 #define GCC_CFGLOOP_H
23 #include "basic-block.h"
24 #include "double-int.h"
26 #include "bitmap.h"
27 #include "sbitmap.h"
29 /* Structure to hold decision about unrolling/peeling. */
30 enum lpt_dec
32 LPT_NONE,
33 LPT_PEEL_COMPLETELY,
34 LPT_PEEL_SIMPLE,
35 LPT_UNROLL_CONSTANT,
36 LPT_UNROLL_RUNTIME,
37 LPT_UNROLL_STUPID
40 struct GTY (()) lpt_decision {
41 enum lpt_dec decision;
42 unsigned times;
45 /* The type of extend applied to an IV. */
46 enum iv_extend_code
48 IV_SIGN_EXTEND,
49 IV_ZERO_EXTEND,
50 IV_UNKNOWN_EXTEND
53 /* The structure describing a bound on number of iterations of a loop. */
55 struct GTY ((chain_next ("%h.next"))) nb_iter_bound {
56 /* The statement STMT is executed at most ... */
57 gimple stmt;
59 /* ... BOUND + 1 times (BOUND must be an unsigned constant).
60 The + 1 is added for the following reasons:
62 a) 0 would otherwise be unused, while we would need to care more about
63 overflows (as MAX + 1 is sometimes produced as the estimate on number
64 of executions of STMT).
65 b) it is consistent with the result of number_of_iterations_exit. */
66 double_int bound;
68 /* True if the statement will cause the loop to be leaved the (at most)
69 BOUND + 1-st time it is executed, that is, all the statements after it
70 are executed at most BOUND times. */
71 bool is_exit;
73 /* The next bound in the list. */
74 struct nb_iter_bound *next;
77 /* Description of the loop exit. */
79 struct GTY (()) loop_exit {
80 /* The exit edge. */
81 edge e;
83 /* Previous and next exit in the list of the exits of the loop. */
84 struct loop_exit *prev;
85 struct loop_exit *next;
87 /* Next element in the list of loops from that E exits. */
88 struct loop_exit *next_e;
91 typedef struct loop *loop_p;
93 /* An integer estimation of the number of iterations. Estimate_state
94 describes what is the state of the estimation. */
95 enum loop_estimation
97 /* Estimate was not computed yet. */
98 EST_NOT_COMPUTED,
99 /* Estimate is ready. */
100 EST_AVAILABLE
103 /* Structure to hold information for each natural loop. */
104 struct GTY ((chain_next ("%h.next"))) loop {
105 /* Index into loops array. */
106 int num;
108 /* Number of loop insns. */
109 unsigned ninsns;
111 /* Basic block of loop header. */
112 basic_block header;
114 /* Basic block of loop latch. */
115 basic_block latch;
117 /* For loop unrolling/peeling decision. */
118 struct lpt_decision lpt_decision;
120 /* Average number of executed insns per iteration. */
121 unsigned av_ninsns;
123 /* Number of blocks contained within the loop. */
124 unsigned num_nodes;
126 /* Superloops of the loop, starting with the outermost loop. */
127 vec<loop_p, va_gc> *superloops;
129 /* The first inner (child) loop or NULL if innermost loop. */
130 struct loop *inner;
132 /* Link to the next (sibling) loop. */
133 struct loop *next;
135 /* Auxiliary info specific to a pass. */
136 PTR GTY ((skip (""))) aux;
138 /* The number of times the latch of the loop is executed. This can be an
139 INTEGER_CST, or a symbolic expression representing the number of
140 iterations like "N - 1", or a COND_EXPR containing the runtime
141 conditions under which the number of iterations is non zero.
143 Don't access this field directly: number_of_latch_executions
144 computes and caches the computed information in this field. */
145 tree nb_iterations;
147 /* An integer guaranteed to be greater or equal to nb_iterations. Only
148 valid if any_upper_bound is true. */
149 double_int nb_iterations_upper_bound;
151 /* An integer giving an estimate on nb_iterations. Unlike
152 nb_iterations_upper_bound, there is no guarantee that it is at least
153 nb_iterations. */
154 double_int nb_iterations_estimate;
156 bool any_upper_bound;
157 bool any_estimate;
159 /* True if the loop can be parallel. */
160 bool can_be_parallel;
162 /* An integer estimation of the number of iterations. Estimate_state
163 describes what is the state of the estimation. */
164 enum loop_estimation estimate_state;
166 /* Upper bound on number of iterations of a loop. */
167 struct nb_iter_bound *bounds;
169 /* Head of the cyclic list of the exits of the loop. */
170 struct loop_exit *exits;
173 /* Flags for state of loop structure. */
174 enum
176 LOOPS_HAVE_PREHEADERS = 1,
177 LOOPS_HAVE_SIMPLE_LATCHES = 2,
178 LOOPS_HAVE_MARKED_IRREDUCIBLE_REGIONS = 4,
179 LOOPS_HAVE_RECORDED_EXITS = 8,
180 LOOPS_MAY_HAVE_MULTIPLE_LATCHES = 16,
181 LOOP_CLOSED_SSA = 32,
182 LOOPS_NEED_FIXUP = 64,
183 LOOPS_HAVE_FALLTHRU_PREHEADERS = 128
186 #define LOOPS_NORMAL (LOOPS_HAVE_PREHEADERS | LOOPS_HAVE_SIMPLE_LATCHES \
187 | LOOPS_HAVE_MARKED_IRREDUCIBLE_REGIONS)
188 #define AVOID_CFG_MODIFICATIONS (LOOPS_MAY_HAVE_MULTIPLE_LATCHES)
190 /* Structure to hold CFG information about natural loops within a function. */
191 struct GTY (()) loops {
192 /* State of loops. */
193 int state;
195 /* Array of the loops. */
196 vec<loop_p, va_gc> *larray;
198 /* Maps edges to the list of their descriptions as loop exits. Edges
199 whose sources or destinations have loop_father == NULL (which may
200 happen during the cfg manipulations) should not appear in EXITS. */
201 htab_t GTY((param_is (struct loop_exit))) exits;
203 /* Pointer to root of loop hierarchy tree. */
204 struct loop *tree_root;
207 /* Loop recognition. */
208 bool bb_loop_header_p (basic_block);
209 extern struct loops *flow_loops_find (struct loops *);
210 extern void disambiguate_loops_with_multiple_latches (void);
211 extern void flow_loops_free (struct loops *);
212 extern void flow_loops_dump (FILE *,
213 void (*)(const struct loop *, FILE *, int), int);
214 extern void flow_loop_dump (const struct loop *, FILE *,
215 void (*)(const struct loop *, FILE *, int), int);
216 struct loop *alloc_loop (void);
217 extern void flow_loop_free (struct loop *);
218 int flow_loop_nodes_find (basic_block, struct loop *);
219 unsigned fix_loop_structure (bitmap changed_bbs);
220 bool mark_irreducible_loops (void);
221 void release_recorded_exits (void);
222 void record_loop_exits (void);
223 void rescan_loop_exit (edge, bool, bool);
225 /* Loop data structure manipulation/querying. */
226 extern void flow_loop_tree_node_add (struct loop *, struct loop *);
227 extern void flow_loop_tree_node_remove (struct loop *);
228 extern void add_loop (struct loop *, struct loop *);
229 extern bool flow_loop_nested_p (const struct loop *, const struct loop *);
230 extern bool flow_bb_inside_loop_p (const struct loop *, const_basic_block);
231 extern struct loop * find_common_loop (struct loop *, struct loop *);
232 struct loop *superloop_at_depth (struct loop *, unsigned);
233 struct eni_weights_d;
234 extern unsigned tree_num_loop_insns (struct loop *, struct eni_weights_d *);
235 extern int num_loop_insns (const struct loop *);
236 extern int average_num_loop_insns (const struct loop *);
237 extern unsigned get_loop_level (const struct loop *);
238 extern bool loop_exit_edge_p (const struct loop *, const_edge);
239 extern bool loop_exits_to_bb_p (struct loop *, basic_block);
240 extern bool loop_exits_from_bb_p (struct loop *, basic_block);
241 extern void mark_loop_exit_edges (void);
242 extern location_t get_loop_location (struct loop *loop);
244 /* Loops & cfg manipulation. */
245 extern basic_block *get_loop_body (const struct loop *);
246 extern unsigned get_loop_body_with_size (const struct loop *, basic_block *,
247 unsigned);
248 extern basic_block *get_loop_body_in_dom_order (const struct loop *);
249 extern basic_block *get_loop_body_in_bfs_order (const struct loop *);
250 extern basic_block *get_loop_body_in_custom_order (const struct loop *,
251 int (*) (const void *, const void *));
253 extern vec<edge> get_loop_exit_edges (const struct loop *);
254 extern edge single_exit (const struct loop *);
255 extern edge single_likely_exit (struct loop *loop);
256 extern unsigned num_loop_branches (const struct loop *);
258 extern edge loop_preheader_edge (const struct loop *);
259 extern edge loop_latch_edge (const struct loop *);
261 extern void add_bb_to_loop (basic_block, struct loop *);
262 extern void remove_bb_from_loops (basic_block);
264 extern void cancel_loop_tree (struct loop *);
265 extern void delete_loop (struct loop *);
267 enum
269 CP_SIMPLE_PREHEADERS = 1,
270 CP_FALLTHRU_PREHEADERS = 2
273 basic_block create_preheader (struct loop *, int);
274 extern void create_preheaders (int);
275 extern void force_single_succ_latches (void);
277 extern void verify_loop_structure (void);
279 /* Loop analysis. */
280 extern bool just_once_each_iteration_p (const struct loop *, const_basic_block);
281 gcov_type expected_loop_iterations_unbounded (const struct loop *);
282 extern unsigned expected_loop_iterations (const struct loop *);
283 extern rtx doloop_condition_get (rtx);
285 void estimate_numbers_of_iterations_loop (struct loop *);
286 void record_niter_bound (struct loop *, double_int, bool, bool);
287 bool estimated_loop_iterations (struct loop *, double_int *);
288 bool max_loop_iterations (struct loop *, double_int *);
289 HOST_WIDE_INT estimated_loop_iterations_int (struct loop *);
290 HOST_WIDE_INT max_loop_iterations_int (struct loop *);
291 bool max_stmt_executions (struct loop *, double_int *);
292 bool estimated_stmt_executions (struct loop *, double_int *);
293 HOST_WIDE_INT max_stmt_executions_int (struct loop *);
294 HOST_WIDE_INT estimated_stmt_executions_int (struct loop *);
296 /* Loop manipulation. */
297 extern bool can_duplicate_loop_p (const struct loop *loop);
299 #define DLTHE_FLAG_UPDATE_FREQ 1 /* Update frequencies in
300 duplicate_loop_to_header_edge. */
301 #define DLTHE_RECORD_COPY_NUMBER 2 /* Record copy number in the aux
302 field of newly create BB. */
303 #define DLTHE_FLAG_COMPLETTE_PEEL 4 /* Update frequencies expecting
304 a complete peeling. */
306 extern edge create_empty_if_region_on_edge (edge, tree);
307 extern struct loop *create_empty_loop_on_edge (edge, tree, tree, tree, tree,
308 tree *, tree *, struct loop *);
309 extern struct loop * duplicate_loop (struct loop *, struct loop *);
310 extern void copy_loop_info (struct loop *loop, struct loop *target);
311 extern void duplicate_subloops (struct loop *, struct loop *);
312 extern bool duplicate_loop_to_header_edge (struct loop *, edge,
313 unsigned, sbitmap, edge,
314 vec<edge> *, int);
315 extern struct loop *loopify (edge, edge,
316 basic_block, edge, edge, bool,
317 unsigned, unsigned);
318 struct loop * loop_version (struct loop *, void *,
319 basic_block *, unsigned, unsigned, unsigned, bool);
320 extern bool remove_path (edge);
321 extern void unloop (struct loop *, bool *, bitmap);
322 extern void scale_loop_frequencies (struct loop *, int, int);
324 /* Induction variable analysis. */
326 /* The description of induction variable. The things are a bit complicated
327 due to need to handle subregs and extends. The value of the object described
328 by it can be obtained as follows (all computations are done in extend_mode):
330 Value in i-th iteration is
331 delta + mult * extend_{extend_mode} (subreg_{mode} (base + i * step)).
333 If first_special is true, the value in the first iteration is
334 delta + mult * base
336 If extend = UNKNOWN, first_special must be false, delta 0, mult 1 and value is
337 subreg_{mode} (base + i * step)
339 The get_iv_value function can be used to obtain these expressions.
341 ??? Add a third mode field that would specify the mode in that inner
342 computation is done, which would enable it to be different from the
343 outer one? */
345 struct rtx_iv
347 /* Its base and step (mode of base and step is supposed to be extend_mode,
348 see the description above). */
349 rtx base, step;
351 /* The type of extend applied to it (IV_SIGN_EXTEND, IV_ZERO_EXTEND,
352 or IV_UNKNOWN_EXTEND). */
353 enum iv_extend_code extend;
355 /* Operations applied in the extended mode. */
356 rtx delta, mult;
358 /* The mode it is extended to. */
359 enum machine_mode extend_mode;
361 /* The mode the variable iterates in. */
362 enum machine_mode mode;
364 /* Whether the first iteration needs to be handled specially. */
365 unsigned first_special : 1;
368 /* The description of an exit from the loop and of the number of iterations
369 till we take the exit. */
371 struct niter_desc
373 /* The edge out of the loop. */
374 edge out_edge;
376 /* The other edge leading from the condition. */
377 edge in_edge;
379 /* True if we are able to say anything about number of iterations of the
380 loop. */
381 bool simple_p;
383 /* True if the loop iterates the constant number of times. */
384 bool const_iter;
386 /* Number of iterations if constant. */
387 unsigned HOST_WIDEST_INT niter;
389 /* Assumptions under that the rest of the information is valid. */
390 rtx assumptions;
392 /* Assumptions under that the loop ends before reaching the latch,
393 even if value of niter_expr says otherwise. */
394 rtx noloop_assumptions;
396 /* Condition under that the loop is infinite. */
397 rtx infinite;
399 /* Whether the comparison is signed. */
400 bool signed_p;
402 /* The mode in that niter_expr should be computed. */
403 enum machine_mode mode;
405 /* The number of iterations of the loop. */
406 rtx niter_expr;
409 extern void iv_analysis_loop_init (struct loop *);
410 extern bool iv_analyze (rtx, rtx, struct rtx_iv *);
411 extern bool iv_analyze_result (rtx, rtx, struct rtx_iv *);
412 extern bool iv_analyze_expr (rtx, rtx, enum machine_mode, struct rtx_iv *);
413 extern rtx get_iv_value (struct rtx_iv *, rtx);
414 extern bool biv_p (rtx, rtx);
415 extern void find_simple_exit (struct loop *, struct niter_desc *);
416 extern void iv_analysis_done (void);
418 extern struct niter_desc *get_simple_loop_desc (struct loop *loop);
419 extern void free_simple_loop_desc (struct loop *loop);
421 static inline struct niter_desc *
422 simple_loop_desc (struct loop *loop)
424 return (struct niter_desc *) loop->aux;
427 /* Accessors for the loop structures. */
429 /* Returns the loop with index NUM from current_loops. */
431 static inline struct loop *
432 get_loop (unsigned num)
434 return (*current_loops->larray)[num];
437 /* Returns the number of superloops of LOOP. */
439 static inline unsigned
440 loop_depth (const struct loop *loop)
442 return vec_safe_length (loop->superloops);
445 /* Returns the loop depth of the loop BB belongs to. */
447 static inline int
448 bb_loop_depth (const_basic_block bb)
450 return bb->loop_father ? loop_depth (bb->loop_father) : 0;
453 /* Returns the immediate superloop of LOOP, or NULL if LOOP is the outermost
454 loop. */
456 static inline struct loop *
457 loop_outer (const struct loop *loop)
459 unsigned n = vec_safe_length (loop->superloops);
461 if (n == 0)
462 return NULL;
464 return (*loop->superloops)[n - 1];
467 /* Returns true if LOOP has at least one exit edge. */
469 static inline bool
470 loop_has_exit_edges (const struct loop *loop)
472 return loop->exits->next->e != NULL;
475 /* Returns the list of loops in current_loops. */
477 static inline vec<loop_p, va_gc> *
478 get_loops (void)
480 if (!current_loops)
481 return NULL;
483 return current_loops->larray;
486 /* Returns the number of loops in current_loops (including the removed
487 ones and the fake loop that forms the root of the loop tree). */
489 static inline unsigned
490 number_of_loops (void)
492 if (!current_loops)
493 return 0;
495 return vec_safe_length (current_loops->larray);
498 /* Returns true if state of the loops satisfies all properties
499 described by FLAGS. */
501 static inline bool
502 loops_state_satisfies_p (unsigned flags)
504 return (current_loops->state & flags) == flags;
507 /* Sets FLAGS to the loops state. */
509 static inline void
510 loops_state_set (unsigned flags)
512 current_loops->state |= flags;
515 /* Clears FLAGS from the loops state. */
517 static inline void
518 loops_state_clear (unsigned flags)
520 if (!current_loops)
521 return;
522 current_loops->state &= ~flags;
525 /* Loop iterators. */
527 /* Flags for loop iteration. */
529 enum li_flags
531 LI_INCLUDE_ROOT = 1, /* Include the fake root of the loop tree. */
532 LI_FROM_INNERMOST = 2, /* Iterate over the loops in the reverse order,
533 starting from innermost ones. */
534 LI_ONLY_INNERMOST = 4 /* Iterate only over innermost loops. */
537 /* The iterator for loops. */
539 typedef struct
541 /* The list of loops to visit. */
542 vec<int> to_visit;
544 /* The index of the actual loop. */
545 unsigned idx;
546 } loop_iterator;
548 static inline void
549 fel_next (loop_iterator *li, loop_p *loop)
551 int anum;
553 while (li->to_visit.iterate (li->idx, &anum))
555 li->idx++;
556 *loop = get_loop (anum);
557 if (*loop)
558 return;
561 li->to_visit.release ();
562 *loop = NULL;
565 static inline void
566 fel_init (loop_iterator *li, loop_p *loop, unsigned flags)
568 struct loop *aloop;
569 unsigned i;
570 int mn;
572 li->idx = 0;
573 if (!current_loops)
575 li->to_visit.create (0);
576 *loop = NULL;
577 return;
580 li->to_visit.create (number_of_loops ());
581 mn = (flags & LI_INCLUDE_ROOT) ? 0 : 1;
583 if (flags & LI_ONLY_INNERMOST)
585 for (i = 0; vec_safe_iterate (current_loops->larray, i, &aloop); i++)
586 if (aloop != NULL
587 && aloop->inner == NULL
588 && aloop->num >= mn)
589 li->to_visit.quick_push (aloop->num);
591 else if (flags & LI_FROM_INNERMOST)
593 /* Push the loops to LI->TO_VISIT in postorder. */
594 for (aloop = current_loops->tree_root;
595 aloop->inner != NULL;
596 aloop = aloop->inner)
597 continue;
599 while (1)
601 if (aloop->num >= mn)
602 li->to_visit.quick_push (aloop->num);
604 if (aloop->next)
606 for (aloop = aloop->next;
607 aloop->inner != NULL;
608 aloop = aloop->inner)
609 continue;
611 else if (!loop_outer (aloop))
612 break;
613 else
614 aloop = loop_outer (aloop);
617 else
619 /* Push the loops to LI->TO_VISIT in preorder. */
620 aloop = current_loops->tree_root;
621 while (1)
623 if (aloop->num >= mn)
624 li->to_visit.quick_push (aloop->num);
626 if (aloop->inner != NULL)
627 aloop = aloop->inner;
628 else
630 while (aloop != NULL && aloop->next == NULL)
631 aloop = loop_outer (aloop);
632 if (aloop == NULL)
633 break;
634 aloop = aloop->next;
639 fel_next (li, loop);
642 #define FOR_EACH_LOOP(LI, LOOP, FLAGS) \
643 for (fel_init (&(LI), &(LOOP), FLAGS); \
644 (LOOP); \
645 fel_next (&(LI), &(LOOP)))
647 #define FOR_EACH_LOOP_BREAK(LI) \
649 (LI).to_visit.release (); \
650 break; \
653 /* The properties of the target. */
654 struct target_cfgloop {
655 /* Number of available registers. */
656 unsigned x_target_avail_regs;
658 /* Number of available registers that are call-clobbered. */
659 unsigned x_target_clobbered_regs;
661 /* Number of registers reserved for temporary expressions. */
662 unsigned x_target_res_regs;
664 /* The cost for register when there still is some reserve, but we are
665 approaching the number of available registers. */
666 unsigned x_target_reg_cost[2];
668 /* The cost for register when we need to spill. */
669 unsigned x_target_spill_cost[2];
672 extern struct target_cfgloop default_target_cfgloop;
673 #if SWITCHABLE_TARGET
674 extern struct target_cfgloop *this_target_cfgloop;
675 #else
676 #define this_target_cfgloop (&default_target_cfgloop)
677 #endif
679 #define target_avail_regs \
680 (this_target_cfgloop->x_target_avail_regs)
681 #define target_clobbered_regs \
682 (this_target_cfgloop->x_target_clobbered_regs)
683 #define target_res_regs \
684 (this_target_cfgloop->x_target_res_regs)
685 #define target_reg_cost \
686 (this_target_cfgloop->x_target_reg_cost)
687 #define target_spill_cost \
688 (this_target_cfgloop->x_target_spill_cost)
690 /* Register pressure estimation for induction variable optimizations & loop
691 invariant motion. */
692 extern unsigned estimate_reg_pressure_cost (unsigned, unsigned, bool, bool);
693 extern void init_set_costs (void);
695 /* Loop optimizer initialization. */
696 extern void loop_optimizer_init (unsigned);
697 extern void loop_optimizer_finalize (void);
699 /* Optimization passes. */
700 extern void unswitch_loops (void);
702 enum
704 UAP_PEEL = 1, /* Enables loop peeling. */
705 UAP_UNROLL = 2, /* Enables unrolling of loops if it seems profitable. */
706 UAP_UNROLL_ALL = 4 /* Enables unrolling of all loops. */
709 extern void unroll_and_peel_loops (int);
710 extern void doloop_optimize_loops (void);
711 extern void move_loop_invariants (void);
712 extern bool finite_loop_p (struct loop *);
713 extern void scale_loop_profile (struct loop *loop, int scale, gcov_type iteration_bound);
714 extern vec<basic_block> get_loop_hot_path (const struct loop *loop);
716 /* Returns the outermost loop of the loop nest that contains LOOP.*/
717 static inline struct loop *
718 loop_outermost (struct loop *loop)
720 unsigned n = vec_safe_length (loop->superloops);
722 if (n <= 1)
723 return loop;
725 return (*loop->superloops)[1];
729 #endif /* GCC_CFGLOOP_H */