1 /* Perform doloop optimizations
2 Copyright (C) 2004, 2005, 2006, 2007, 2008, 2010, 2012
3 Free Software Foundation, Inc.
4 Based on code by Michael P. Hayes (m.hayes@elec.canterbury.ac.nz)
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 3, or (at your option) any later
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
24 #include "coretypes.h"
29 #include "hard-reg-set.h"
30 #include "basic-block.h"
31 #include "diagnostic-core.h"
38 /* This module is used to modify loops with a determinable number of
39 iterations to use special low-overhead looping instructions.
41 It first validates whether the loop is well behaved and has a
42 determinable number of iterations (either at compile or run-time).
43 It then modifies the loop to use a low-overhead looping pattern as
46 1. A pseudo register is allocated as the loop iteration counter.
48 2. The number of loop iterations is calculated and is stored
51 3. At the end of the loop, the jump insn is replaced by the
52 doloop_end pattern. The compare must remain because it might be
53 used elsewhere. If the loop-variable or condition register are
54 used elsewhere, they will be eliminated by flow.
56 4. An optional doloop_begin pattern is inserted at the top of the
59 TODO The optimization should only performed when either the biv used for exit
60 condition is unused at all except for the exit test, or if we do not have to
61 change its value, since otherwise we have to add a new induction variable,
62 which usually will not pay up (unless the cost of the doloop pattern is
63 somehow extremely lower than the cost of compare & jump, or unless the bct
64 register cannot be used for anything else but doloop -- ??? detect these
67 #ifdef HAVE_doloop_end
69 /* Return the loop termination condition for PATTERN or zero
70 if it is not a decrement and branch jump insn. */
73 doloop_condition_get (rtx doloop_pat
)
81 rtx cc_reg
= NULL_RTX
;
82 rtx reg_orig
= NULL_RTX
;
84 /* The canonical doloop pattern we expect has one of the following
87 1) (parallel [(set (pc) (if_then_else (condition)
90 (set (reg) (plus (reg) (const_int -1)))
91 (additional clobbers and uses)])
93 The branch must be the first entry of the parallel (also required
94 by jump.c), and the second entry of the parallel must be a set of
95 the loop counter register. Some targets (IA-64) wrap the set of
96 the loop counter in an if_then_else too.
98 2) (set (reg) (plus (reg) (const_int -1))
99 (set (pc) (if_then_else (reg != 0)
103 Some targets (ARM) do the comparison before the branch, as in the
106 3) (parallel [(set (cc) (compare ((plus (reg) (const_int -1), 0)))
107 (set (reg) (plus (reg) (const_int -1)))])
108 (set (pc) (if_then_else (cc == NE)
112 pattern
= PATTERN (doloop_pat
);
114 if (GET_CODE (pattern
) != PARALLEL
)
117 rtx prev_insn
= prev_nondebug_insn (doloop_pat
);
118 rtx cmp_arg1
, cmp_arg2
;
121 /* In case the pattern is not PARALLEL we expect two forms
122 of doloop which are cases 2) and 3) above: in case 2) the
123 decrement immediately precedes the branch, while in case 3)
124 the compare and decrement instructions immediately precede
127 if (prev_insn
== NULL_RTX
|| !INSN_P (prev_insn
))
131 if (GET_CODE (PATTERN (prev_insn
)) == PARALLEL
)
133 /* The third case: the compare and decrement instructions
134 immediately precede the branch. */
135 cmp_orig
= XVECEXP (PATTERN (prev_insn
), 0, 0);
136 if (GET_CODE (cmp_orig
) != SET
)
138 if (GET_CODE (SET_SRC (cmp_orig
)) != COMPARE
)
140 cmp_arg1
= XEXP (SET_SRC (cmp_orig
), 0);
141 cmp_arg2
= XEXP (SET_SRC (cmp_orig
), 1);
142 if (cmp_arg2
!= const0_rtx
143 || GET_CODE (cmp_arg1
) != PLUS
)
145 reg_orig
= XEXP (cmp_arg1
, 0);
146 if (XEXP (cmp_arg1
, 1) != GEN_INT (-1)
147 || !REG_P (reg_orig
))
149 cc_reg
= SET_DEST (cmp_orig
);
151 inc
= XVECEXP (PATTERN (prev_insn
), 0, 1);
154 inc
= PATTERN (prev_insn
);
155 /* We expect the condition to be of the form (reg != 0) */
156 cond
= XEXP (SET_SRC (cmp
), 0);
157 if (GET_CODE (cond
) != NE
|| XEXP (cond
, 1) != const0_rtx
)
162 cmp
= XVECEXP (pattern
, 0, 0);
163 inc
= XVECEXP (pattern
, 0, 1);
166 /* Check for (set (reg) (something)). */
167 if (GET_CODE (inc
) != SET
)
169 reg
= SET_DEST (inc
);
173 /* Check if something = (plus (reg) (const_int -1)).
174 On IA-64, this decrement is wrapped in an if_then_else. */
175 inc_src
= SET_SRC (inc
);
176 if (GET_CODE (inc_src
) == IF_THEN_ELSE
)
177 inc_src
= XEXP (inc_src
, 1);
178 if (GET_CODE (inc_src
) != PLUS
179 || XEXP (inc_src
, 0) != reg
180 || XEXP (inc_src
, 1) != constm1_rtx
)
183 /* Check for (set (pc) (if_then_else (condition)
186 if (GET_CODE (cmp
) != SET
187 || SET_DEST (cmp
) != pc_rtx
188 || GET_CODE (SET_SRC (cmp
)) != IF_THEN_ELSE
189 || GET_CODE (XEXP (SET_SRC (cmp
), 1)) != LABEL_REF
190 || XEXP (SET_SRC (cmp
), 2) != pc_rtx
)
193 /* Extract loop termination condition. */
194 condition
= XEXP (SET_SRC (cmp
), 0);
196 /* We expect a GE or NE comparison with 0 or 1. */
197 if ((GET_CODE (condition
) != GE
198 && GET_CODE (condition
) != NE
)
199 || (XEXP (condition
, 1) != const0_rtx
200 && XEXP (condition
, 1) != const1_rtx
))
203 if ((XEXP (condition
, 0) == reg
)
204 /* For the third case: */
205 || ((cc_reg
!= NULL_RTX
)
206 && (XEXP (condition
, 0) == cc_reg
)
207 && (reg_orig
== reg
))
208 || (GET_CODE (XEXP (condition
, 0)) == PLUS
209 && XEXP (XEXP (condition
, 0), 0) == reg
))
211 if (GET_CODE (pattern
) != PARALLEL
)
212 /* For the second form we expect:
214 (set (reg) (plus (reg) (const_int -1))
215 (set (pc) (if_then_else (reg != 0)
219 is equivalent to the following:
221 (parallel [(set (pc) (if_then_else (reg != 1)
224 (set (reg) (plus (reg) (const_int -1)))
225 (additional clobbers and uses)])
227 For the third form we expect:
229 (parallel [(set (cc) (compare ((plus (reg) (const_int -1)), 0))
230 (set (reg) (plus (reg) (const_int -1)))])
231 (set (pc) (if_then_else (cc == NE)
235 which is equivalent to the following:
237 (parallel [(set (cc) (compare (reg, 1))
238 (set (reg) (plus (reg) (const_int -1)))
239 (set (pc) (if_then_else (NE == cc)
243 So we return the second form instead for the two cases.
246 condition
= gen_rtx_fmt_ee (NE
, VOIDmode
, inc_src
, const1_rtx
);
251 /* ??? If a machine uses a funny comparison, we could return a
252 canonicalized form here. */
257 /* Return nonzero if the loop specified by LOOP is suitable for
258 the use of special low-overhead looping instructions. DESC
259 describes the number of iterations of the loop. */
262 doloop_valid_p (struct loop
*loop
, struct niter_desc
*desc
)
264 basic_block
*body
= get_loop_body (loop
), bb
;
269 /* Check for loops that may not terminate under special conditions. */
274 /* There are some cases that would require a special attention.
275 For example if the comparison is LEU and the comparison value
276 is UINT_MAX then the loop will not terminate. Similarly, if the
277 comparison code is GEU and the comparison value is 0, the
278 loop will not terminate.
280 If the absolute increment is not 1, the loop can be infinite
281 even with LTU/GTU, e.g. for (i = 3; i > 0; i -= 2)
283 ??? We could compute these conditions at run-time and have a
284 additional jump around the loop to ensure an infinite loop.
285 However, it is very unlikely that this is the intended
286 behavior of the loop and checking for these rare boundary
287 conditions would pessimize all other code.
289 If the loop is executed only a few times an extra check to
290 restart the loop could use up most of the benefits of using a
291 count register loop. Note however, that normally, this
292 restart branch would never execute, so it could be predicted
293 well by the CPU. We should generate the pessimistic code by
294 default, and have an option, e.g. -funsafe-loops that would
295 enable count-register loops in this case. */
297 fprintf (dump_file
, "Doloop: Possible infinite iteration case.\n");
302 for (i
= 0; i
< loop
->num_nodes
; i
++)
306 for (insn
= BB_HEAD (bb
);
307 insn
!= NEXT_INSN (BB_END (bb
));
308 insn
= NEXT_INSN (insn
))
310 /* Different targets have different necessities for low-overhead
311 looping. Call the back end for each instruction within the loop
312 to let it decide whether the insn prohibits a low-overhead loop.
313 It will then return the cause for it to emit to the dump file. */
314 const char * invalid
= targetm
.invalid_within_doloop (insn
);
318 fprintf (dump_file
, "Doloop: %s\n", invalid
);
332 /* Adds test of COND jumping to DEST on edge *E and set *E to the new fallthru
333 edge. If the condition is always false, do not do anything. If it is always
334 true, redirect E to DEST and return false. In all other cases, true is
338 add_test (rtx cond
, edge
*e
, basic_block dest
)
340 rtx seq
, jump
, label
;
341 enum machine_mode mode
;
342 rtx op0
= XEXP (cond
, 0), op1
= XEXP (cond
, 1);
343 enum rtx_code code
= GET_CODE (cond
);
346 mode
= GET_MODE (XEXP (cond
, 0));
347 if (mode
== VOIDmode
)
348 mode
= GET_MODE (XEXP (cond
, 1));
351 op0
= force_operand (op0
, NULL_RTX
);
352 op1
= force_operand (op1
, NULL_RTX
);
353 label
= block_label (dest
);
354 do_compare_rtx_and_jump (op0
, op1
, code
, 0, mode
, NULL_RTX
,
355 NULL_RTX
, label
, -1);
357 jump
= get_last_insn ();
358 if (!jump
|| !JUMP_P (jump
))
360 /* The condition is always false and the jump was optimized out. */
368 /* There always is at least the jump insn in the sequence. */
369 gcc_assert (seq
!= NULL_RTX
);
371 bb
= split_edge_and_insert (*e
, seq
);
372 *e
= single_succ_edge (bb
);
374 if (any_uncondjump_p (jump
))
376 /* The condition is always true. */
378 redirect_edge_and_branch_force (*e
, dest
);
382 JUMP_LABEL (jump
) = label
;
384 /* The jump is supposed to handle an unlikely special case. */
385 add_reg_note (jump
, REG_BR_PROB
, const0_rtx
);
387 LABEL_NUSES (label
)++;
389 make_edge (bb
, dest
, (*e
)->flags
& ~EDGE_FALLTHRU
);
393 /* Modify the loop to use the low-overhead looping insn where LOOP
394 describes the loop, DESC describes the number of iterations of the
395 loop, and DOLOOP_INSN is the low-overhead looping insn to emit at the
396 end of the loop. CONDITION is the condition separated from the
397 DOLOOP_SEQ. COUNT is the number of iterations of the LOOP. */
400 doloop_modify (struct loop
*loop
, struct niter_desc
*desc
,
401 rtx doloop_seq
, rtx condition
, rtx count
)
404 rtx tmp
, noloop
= NULL_RTX
;
409 bool increment_count
;
410 basic_block loop_end
= desc
->out_edge
->src
;
411 enum machine_mode mode
;
413 double_int iterations
;
415 jump_insn
= BB_END (loop_end
);
419 fprintf (dump_file
, "Doloop: Inserting doloop pattern (");
420 if (desc
->const_iter
)
421 fprintf (dump_file
, HOST_WIDEST_INT_PRINT_DEC
, desc
->niter
);
423 fputs ("runtime", dump_file
);
424 fputs (" iterations).\n", dump_file
);
427 /* Get the probability of the original branch. If it exists we would
428 need to update REG_BR_PROB of the new jump_insn. */
429 true_prob_val
= find_reg_note (jump_insn
, REG_BR_PROB
, NULL_RTX
);
431 /* Discard original jump to continue loop. The original compare
432 result may still be live, so it cannot be discarded explicitly. */
433 delete_insn (jump_insn
);
435 counter_reg
= XEXP (condition
, 0);
436 if (GET_CODE (counter_reg
) == PLUS
)
437 counter_reg
= XEXP (counter_reg
, 0);
438 mode
= GET_MODE (counter_reg
);
440 increment_count
= false;
441 switch (GET_CODE (condition
))
444 /* Currently only NE tests against zero and one are supported. */
445 noloop
= XEXP (condition
, 1);
446 if (noloop
!= const0_rtx
)
448 gcc_assert (noloop
== const1_rtx
);
449 increment_count
= true;
454 /* Currently only GE tests against zero are supported. */
455 gcc_assert (XEXP (condition
, 1) == const0_rtx
);
457 noloop
= constm1_rtx
;
459 /* The iteration count does not need incrementing for a GE test. */
460 increment_count
= false;
462 /* Determine if the iteration counter will be non-negative.
463 Note that the maximum value loaded is iterations_max - 1. */
464 if (max_loop_iterations (loop
, &iterations
)
465 && (iterations
.ule (double_int_one
.llshift
466 (GET_MODE_PRECISION (mode
) - 1,
467 GET_MODE_PRECISION (mode
)))))
471 /* Abort if an invalid doloop pattern has been generated. */
477 count
= simplify_gen_binary (PLUS
, mode
, count
, const1_rtx
);
479 /* Insert initialization of the count register into the loop header. */
481 tmp
= force_operand (count
, counter_reg
);
482 convert_move (counter_reg
, tmp
, 1);
483 sequence
= get_insns ();
485 emit_insn_after (sequence
, BB_END (loop_preheader_edge (loop
)->src
));
487 if (desc
->noloop_assumptions
)
489 rtx ass
= copy_rtx (desc
->noloop_assumptions
);
490 basic_block preheader
= loop_preheader_edge (loop
)->src
;
492 = split_edge (loop_preheader_edge (loop
));
493 basic_block new_preheader
494 = split_edge (loop_preheader_edge (loop
));
497 /* Expand the condition testing the assumptions and if it does not pass,
498 reset the count register to 0. */
499 redirect_edge_and_branch_force (single_succ_edge (preheader
), new_preheader
);
500 set_immediate_dominator (CDI_DOMINATORS
, new_preheader
, preheader
);
503 set_zero
->frequency
= 0;
505 te
= single_succ_edge (preheader
);
506 for (; ass
; ass
= XEXP (ass
, 1))
507 if (!add_test (XEXP (ass
, 0), &te
, set_zero
))
512 /* We reached a condition that is always true. This is very hard to
513 reproduce (such a loop does not roll, and thus it would most
514 likely get optimized out by some of the preceding optimizations).
515 In fact, I do not have any testcase for it. However, it would
516 also be very hard to show that it is impossible, so we must
518 set_zero
->count
= preheader
->count
;
519 set_zero
->frequency
= preheader
->frequency
;
522 if (EDGE_COUNT (set_zero
->preds
) == 0)
524 /* All the conditions were simplified to false, remove the
525 unreachable set_zero block. */
526 delete_basic_block (set_zero
);
530 /* Reset the counter to zero in the set_zero block. */
532 convert_move (counter_reg
, noloop
, 0);
533 sequence
= get_insns ();
535 emit_insn_after (sequence
, BB_END (set_zero
));
537 set_immediate_dominator (CDI_DOMINATORS
, set_zero
,
538 recompute_dominator (CDI_DOMINATORS
,
542 set_immediate_dominator (CDI_DOMINATORS
, new_preheader
,
543 recompute_dominator (CDI_DOMINATORS
,
547 /* Some targets (eg, C4x) need to initialize special looping
549 #ifdef HAVE_doloop_begin
552 unsigned level
= get_loop_level (loop
) + 1;
556 if (!max_loop_iterations (loop
, &iter
)
557 || !iter
.fits_shwi ())
558 iter_rtx
= const0_rtx
;
560 iter_rtx
= GEN_INT (iter
.to_shwi());
561 init
= gen_doloop_begin (counter_reg
,
562 desc
->const_iter
? desc
->niter_expr
: const0_rtx
,
570 sequence
= get_insns ();
572 emit_insn_after (sequence
, BB_END (loop_preheader_edge (loop
)->src
));
577 /* Insert the new low-overhead looping insn. */
578 emit_jump_insn_after (doloop_seq
, BB_END (loop_end
));
579 jump_insn
= BB_END (loop_end
);
580 jump_label
= block_label (desc
->in_edge
->dest
);
581 JUMP_LABEL (jump_insn
) = jump_label
;
582 LABEL_NUSES (jump_label
)++;
584 /* Ensure the right fallthru edge is marked, for case we have reversed
586 desc
->in_edge
->flags
&= ~EDGE_FALLTHRU
;
587 desc
->out_edge
->flags
|= EDGE_FALLTHRU
;
589 /* Add a REG_NONNEG note if the actual or estimated maximum number
590 of iterations is non-negative. */
592 add_reg_note (jump_insn
, REG_NONNEG
, NULL_RTX
);
594 /* Update the REG_BR_PROB note. */
597 /* Seems safer to use the branch probability. */
598 add_reg_note (jump_insn
, REG_BR_PROB
,
599 GEN_INT (desc
->in_edge
->probability
));
603 /* Process loop described by LOOP validating that the loop is suitable for
604 conversion to use a low overhead looping instruction, replacing the jump
605 insn where suitable. Returns true if the loop was successfully
609 doloop_optimize (struct loop
*loop
)
611 enum machine_mode mode
;
612 rtx doloop_seq
, doloop_pat
, doloop_reg
;
613 rtx iterations
, count
;
617 unsigned level
, est_niter
;
619 struct niter_desc
*desc
;
620 unsigned word_mode_size
;
621 unsigned HOST_WIDE_INT word_mode_max
;
626 fprintf (dump_file
, "Doloop: Processing loop %d.\n", loop
->num
);
628 iv_analysis_loop_init (loop
);
630 /* Find the simple exit of a LOOP. */
631 desc
= get_simple_loop_desc (loop
);
633 /* Check that loop is a candidate for a low-overhead looping insn. */
634 if (!doloop_valid_p (loop
, desc
))
638 "Doloop: The loop is not suitable.\n");
644 if (desc
->const_iter
)
645 est_niter
= desc
->niter
;
646 /* If the estimate on number of iterations is reliable (comes from profile
647 feedback), use it. Do not use it normally, since the expected number
648 of iterations of an unrolled loop is 2. */
649 if (loop
->header
->count
)
650 est_niter
= expected_loop_iterations (loop
);
656 "Doloop: Too few iterations (%u) to be profitable.\n",
662 = COSTS_N_INSNS (PARAM_VALUE (PARAM_MAX_ITERATIONS_COMPUTATION_COST
));
663 if (set_src_cost (desc
->niter_expr
, optimize_loop_for_speed_p (loop
))
668 "Doloop: number of iterations too costly to compute.\n");
672 count
= copy_rtx (desc
->niter_expr
);
673 iterations
= desc
->const_iter
? desc
->niter_expr
: const0_rtx
;
674 if (!max_loop_iterations (loop
, &iter
)
675 || !iter
.fits_shwi ())
676 iterations_max
= const0_rtx
;
678 iterations_max
= GEN_INT (iter
.to_shwi());
679 level
= get_loop_level (loop
) + 1;
681 /* Generate looping insn. If the pattern FAILs then give up trying
682 to modify the loop since there is some aspect the back-end does
684 start_label
= block_label (desc
->in_edge
->dest
);
685 doloop_reg
= gen_reg_rtx (mode
);
686 entered_at_top
= (loop
->latch
== desc
->in_edge
->dest
687 && contains_no_active_insn_p (loop
->latch
));
688 doloop_seq
= gen_doloop_end (doloop_reg
, iterations
, iterations_max
,
689 GEN_INT (level
), start_label
,
690 GEN_INT (entered_at_top
));
692 word_mode_size
= GET_MODE_PRECISION (word_mode
);
694 = ((unsigned HOST_WIDE_INT
) 1 << (word_mode_size
- 1) << 1) - 1;
697 /* Before trying mode different from the one in that # of iterations is
698 computed, we must be sure that the number of iterations fits into
700 && (word_mode_size
>= GET_MODE_PRECISION (mode
)
701 || iter
.ule (double_int::from_shwi (word_mode_max
))))
703 if (word_mode_size
> GET_MODE_PRECISION (mode
))
705 count
= simplify_gen_unary (ZERO_EXTEND
, word_mode
,
707 iterations
= simplify_gen_unary (ZERO_EXTEND
, word_mode
,
709 iterations_max
= simplify_gen_unary (ZERO_EXTEND
, word_mode
,
710 iterations_max
, mode
);
714 count
= lowpart_subreg (word_mode
, count
, mode
);
715 iterations
= lowpart_subreg (word_mode
, iterations
, mode
);
716 iterations_max
= lowpart_subreg (word_mode
, iterations_max
, mode
);
718 PUT_MODE (doloop_reg
, word_mode
);
719 doloop_seq
= gen_doloop_end (doloop_reg
, iterations
, iterations_max
,
720 GEN_INT (level
), start_label
,
721 GEN_INT (entered_at_top
));
727 "Doloop: Target unwilling to use doloop pattern!\n");
731 /* If multiple instructions were created, the last must be the
732 jump instruction. Also, a raw define_insn may yield a plain
734 doloop_pat
= doloop_seq
;
735 if (INSN_P (doloop_pat
))
737 while (NEXT_INSN (doloop_pat
) != NULL_RTX
)
738 doloop_pat
= NEXT_INSN (doloop_pat
);
739 if (!JUMP_P (doloop_pat
))
740 doloop_pat
= NULL_RTX
;
744 || ! (condition
= doloop_condition_get (doloop_pat
)))
747 fprintf (dump_file
, "Doloop: Unrecognizable doloop pattern!\n");
751 doloop_modify (loop
, desc
, doloop_seq
, condition
, count
);
755 /* This is the main entry point. Process all loops using doloop_optimize. */
758 doloop_optimize_loops (void)
763 FOR_EACH_LOOP (li
, loop
, 0)
765 doloop_optimize (loop
);
770 #ifdef ENABLE_CHECKING
771 verify_loop_structure ();
774 #endif /* HAVE_doloop_end */