1 /* Perform doloop optimizations
2 Copyright (C) 2004-2017 Free Software Foundation, Inc.
3 Based on code by Michael P. Hayes (m.hayes@elec.canterbury.ac.nz)
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
23 #include "coretypes.h"
37 #include "loop-unroll.h"
41 /* This module is used to modify loops with a determinable number of
42 iterations to use special low-overhead looping instructions.
44 It first validates whether the loop is well behaved and has a
45 determinable number of iterations (either at compile or run-time).
46 It then modifies the loop to use a low-overhead looping pattern as
49 1. A pseudo register is allocated as the loop iteration counter.
51 2. The number of loop iterations is calculated and is stored
54 3. At the end of the loop, the jump insn is replaced by the
55 doloop_end pattern. The compare must remain because it might be
56 used elsewhere. If the loop-variable or condition register are
57 used elsewhere, they will be eliminated by flow.
59 4. An optional doloop_begin pattern is inserted at the top of the
62 TODO The optimization should only performed when either the biv used for exit
63 condition is unused at all except for the exit test, or if we do not have to
64 change its value, since otherwise we have to add a new induction variable,
65 which usually will not pay up (unless the cost of the doloop pattern is
66 somehow extremely lower than the cost of compare & jump, or unless the bct
67 register cannot be used for anything else but doloop -- ??? detect these
70 /* Return the loop termination condition for PATTERN or zero
71 if it is not a decrement and branch jump insn. */
74 doloop_condition_get (rtx_insn
*doloop_pat
)
82 rtx cc_reg
= NULL_RTX
;
83 rtx reg_orig
= NULL_RTX
;
85 /* The canonical doloop pattern we expect has one of the following
88 1) (parallel [(set (pc) (if_then_else (condition)
91 (set (reg) (plus (reg) (const_int -1)))
92 (additional clobbers and uses)])
94 The branch must be the first entry of the parallel (also required
95 by jump.c), and the second entry of the parallel must be a set of
96 the loop counter register. Some targets (IA-64) wrap the set of
97 the loop counter in an if_then_else too.
99 2) (set (reg) (plus (reg) (const_int -1))
100 (set (pc) (if_then_else (reg != 0)
104 Some targets (ARM) do the comparison before the branch, as in the
107 3) (parallel [(set (cc) (compare ((plus (reg) (const_int -1), 0)))
108 (set (reg) (plus (reg) (const_int -1)))])
109 (set (pc) (if_then_else (cc == NE)
113 pattern
= PATTERN (doloop_pat
);
115 if (GET_CODE (pattern
) != PARALLEL
)
118 rtx_insn
*prev_insn
= prev_nondebug_insn (doloop_pat
);
119 rtx cmp_arg1
, cmp_arg2
;
122 /* In case the pattern is not PARALLEL we expect two forms
123 of doloop which are cases 2) and 3) above: in case 2) the
124 decrement immediately precedes the branch, while in case 3)
125 the compare and decrement instructions immediately precede
128 if (prev_insn
== NULL_RTX
|| !INSN_P (prev_insn
))
132 if (GET_CODE (PATTERN (prev_insn
)) == PARALLEL
)
134 /* The third case: the compare and decrement instructions
135 immediately precede the branch. */
136 cmp_orig
= XVECEXP (PATTERN (prev_insn
), 0, 0);
137 if (GET_CODE (cmp_orig
) != SET
)
139 if (GET_CODE (SET_SRC (cmp_orig
)) != COMPARE
)
141 cmp_arg1
= XEXP (SET_SRC (cmp_orig
), 0);
142 cmp_arg2
= XEXP (SET_SRC (cmp_orig
), 1);
143 if (cmp_arg2
!= const0_rtx
144 || GET_CODE (cmp_arg1
) != PLUS
)
146 reg_orig
= XEXP (cmp_arg1
, 0);
147 if (XEXP (cmp_arg1
, 1) != GEN_INT (-1)
148 || !REG_P (reg_orig
))
150 cc_reg
= SET_DEST (cmp_orig
);
152 inc
= XVECEXP (PATTERN (prev_insn
), 0, 1);
155 inc
= PATTERN (prev_insn
);
156 /* We expect the condition to be of the form (reg != 0) */
157 cond
= XEXP (SET_SRC (cmp
), 0);
158 if (GET_CODE (cond
) != NE
|| XEXP (cond
, 1) != const0_rtx
)
163 cmp
= XVECEXP (pattern
, 0, 0);
164 inc
= XVECEXP (pattern
, 0, 1);
167 /* Check for (set (reg) (something)). */
168 if (GET_CODE (inc
) != SET
)
170 reg
= SET_DEST (inc
);
174 /* Check if something = (plus (reg) (const_int -1)).
175 On IA-64, this decrement is wrapped in an if_then_else. */
176 inc_src
= SET_SRC (inc
);
177 if (GET_CODE (inc_src
) == IF_THEN_ELSE
)
178 inc_src
= XEXP (inc_src
, 1);
179 if (GET_CODE (inc_src
) != PLUS
180 || XEXP (inc_src
, 0) != reg
181 || XEXP (inc_src
, 1) != constm1_rtx
)
184 /* Check for (set (pc) (if_then_else (condition)
187 if (GET_CODE (cmp
) != SET
188 || SET_DEST (cmp
) != pc_rtx
189 || GET_CODE (SET_SRC (cmp
)) != IF_THEN_ELSE
190 || GET_CODE (XEXP (SET_SRC (cmp
), 1)) != LABEL_REF
191 || XEXP (SET_SRC (cmp
), 2) != pc_rtx
)
194 /* Extract loop termination condition. */
195 condition
= XEXP (SET_SRC (cmp
), 0);
197 /* We expect a GE or NE comparison with 0 or 1. */
198 if ((GET_CODE (condition
) != GE
199 && GET_CODE (condition
) != NE
)
200 || (XEXP (condition
, 1) != const0_rtx
201 && XEXP (condition
, 1) != const1_rtx
))
204 if ((XEXP (condition
, 0) == reg
)
205 /* For the third case: */
206 || ((cc_reg
!= NULL_RTX
)
207 && (XEXP (condition
, 0) == cc_reg
)
208 && (reg_orig
== reg
))
209 || (GET_CODE (XEXP (condition
, 0)) == PLUS
210 && XEXP (XEXP (condition
, 0), 0) == reg
))
212 if (GET_CODE (pattern
) != PARALLEL
)
213 /* For the second form we expect:
215 (set (reg) (plus (reg) (const_int -1))
216 (set (pc) (if_then_else (reg != 0)
220 is equivalent to the following:
222 (parallel [(set (pc) (if_then_else (reg != 1)
225 (set (reg) (plus (reg) (const_int -1)))
226 (additional clobbers and uses)])
228 For the third form we expect:
230 (parallel [(set (cc) (compare ((plus (reg) (const_int -1)), 0))
231 (set (reg) (plus (reg) (const_int -1)))])
232 (set (pc) (if_then_else (cc == NE)
236 which is equivalent to the following:
238 (parallel [(set (cc) (compare (reg, 1))
239 (set (reg) (plus (reg) (const_int -1)))
240 (set (pc) (if_then_else (NE == cc)
244 So we return the second form instead for the two cases.
247 condition
= gen_rtx_fmt_ee (NE
, VOIDmode
, inc_src
, const1_rtx
);
252 /* ??? If a machine uses a funny comparison, we could return a
253 canonicalized form here. */
258 /* Return nonzero if the loop specified by LOOP is suitable for
259 the use of special low-overhead looping instructions. DESC
260 describes the number of iterations of the loop. */
263 doloop_valid_p (struct loop
*loop
, struct niter_desc
*desc
)
265 basic_block
*body
= get_loop_body (loop
), bb
;
270 /* Check for loops that may not terminate under special conditions. */
275 /* There are some cases that would require a special attention.
276 For example if the comparison is LEU and the comparison value
277 is UINT_MAX then the loop will not terminate. Similarly, if the
278 comparison code is GEU and the comparison value is 0, the
279 loop will not terminate.
281 If the absolute increment is not 1, the loop can be infinite
282 even with LTU/GTU, e.g. for (i = 3; i > 0; i -= 2)
284 ??? We could compute these conditions at run-time and have a
285 additional jump around the loop to ensure an infinite loop.
286 However, it is very unlikely that this is the intended
287 behavior of the loop and checking for these rare boundary
288 conditions would pessimize all other code.
290 If the loop is executed only a few times an extra check to
291 restart the loop could use up most of the benefits of using a
292 count register loop. Note however, that normally, this
293 restart branch would never execute, so it could be predicted
294 well by the CPU. We should generate the pessimistic code by
295 default, and have an option, e.g. -funsafe-loops that would
296 enable count-register loops in this case. */
298 fprintf (dump_file
, "Doloop: Possible infinite iteration case.\n");
303 for (i
= 0; i
< loop
->num_nodes
; i
++)
307 for (insn
= BB_HEAD (bb
);
308 insn
!= NEXT_INSN (BB_END (bb
));
309 insn
= NEXT_INSN (insn
))
311 /* Different targets have different necessities for low-overhead
312 looping. Call the back end for each instruction within the loop
313 to let it decide whether the insn prohibits a low-overhead loop.
314 It will then return the cause for it to emit to the dump file. */
315 const char * invalid
= targetm
.invalid_within_doloop (insn
);
319 fprintf (dump_file
, "Doloop: %s\n", invalid
);
333 /* Adds test of COND jumping to DEST on edge *E and set *E to the new fallthru
334 edge. If the condition is always false, do not do anything. If it is always
335 true, redirect E to DEST and return false. In all other cases, true is
339 add_test (rtx cond
, edge
*e
, basic_block dest
)
341 rtx_insn
*seq
, *jump
;
342 rtx_code_label
*label
;
344 rtx op0
= XEXP (cond
, 0), op1
= XEXP (cond
, 1);
345 enum rtx_code code
= GET_CODE (cond
);
348 mode
= GET_MODE (XEXP (cond
, 0));
349 if (mode
== VOIDmode
)
350 mode
= GET_MODE (XEXP (cond
, 1));
353 op0
= force_operand (op0
, NULL_RTX
);
354 op1
= force_operand (op1
, NULL_RTX
);
355 label
= block_label (dest
);
356 do_compare_rtx_and_jump (op0
, op1
, code
, 0, mode
, NULL_RTX
, NULL
, label
, -1);
358 jump
= get_last_insn ();
359 if (!jump
|| !JUMP_P (jump
))
361 /* The condition is always false and the jump was optimized out. */
369 /* There always is at least the jump insn in the sequence. */
370 gcc_assert (seq
!= NULL_RTX
);
372 bb
= split_edge_and_insert (*e
, seq
);
373 *e
= single_succ_edge (bb
);
375 if (any_uncondjump_p (jump
))
377 /* The condition is always true. */
379 redirect_edge_and_branch_force (*e
, dest
);
383 JUMP_LABEL (jump
) = label
;
385 /* The jump is supposed to handle an unlikely special case. */
386 add_int_reg_note (jump
, REG_BR_PROB
, 0);
388 LABEL_NUSES (label
)++;
390 make_edge (bb
, dest
, (*e
)->flags
& ~EDGE_FALLTHRU
);
394 /* Modify the loop to use the low-overhead looping insn where LOOP
395 describes the loop, DESC describes the number of iterations of the
396 loop, and DOLOOP_INSN is the low-overhead looping insn to emit at the
397 end of the loop. CONDITION is the condition separated from the
398 DOLOOP_SEQ. COUNT is the number of iterations of the LOOP. */
401 doloop_modify (struct loop
*loop
, struct niter_desc
*desc
,
402 rtx_insn
*doloop_seq
, rtx condition
, rtx count
)
405 rtx tmp
, noloop
= NULL_RTX
;
408 rtx_code_label
*jump_label
;
410 bool increment_count
;
411 basic_block loop_end
= desc
->out_edge
->src
;
414 widest_int iterations
;
416 jump_insn
= BB_END (loop_end
);
420 fprintf (dump_file
, "Doloop: Inserting doloop pattern (");
421 if (desc
->const_iter
)
422 fprintf (dump_file
, "%" PRId64
, desc
->niter
);
424 fputs ("runtime", dump_file
);
425 fputs (" iterations).\n", dump_file
);
428 /* Get the probability of the original branch. If it exists we would
429 need to update REG_BR_PROB of the new jump_insn. */
430 true_prob_val
= find_reg_note (jump_insn
, REG_BR_PROB
, NULL_RTX
);
432 /* Discard original jump to continue loop. The original compare
433 result may still be live, so it cannot be discarded explicitly. */
434 delete_insn (jump_insn
);
436 counter_reg
= XEXP (condition
, 0);
437 if (GET_CODE (counter_reg
) == PLUS
)
438 counter_reg
= XEXP (counter_reg
, 0);
439 mode
= GET_MODE (counter_reg
);
441 increment_count
= false;
442 switch (GET_CODE (condition
))
445 /* Currently only NE tests against zero and one are supported. */
446 noloop
= XEXP (condition
, 1);
447 if (noloop
!= const0_rtx
)
449 gcc_assert (noloop
== const1_rtx
);
450 increment_count
= true;
455 /* Currently only GE tests against zero are supported. */
456 gcc_assert (XEXP (condition
, 1) == const0_rtx
);
458 noloop
= constm1_rtx
;
460 /* The iteration count does not need incrementing for a GE test. */
461 increment_count
= false;
463 /* Determine if the iteration counter will be non-negative.
464 Note that the maximum value loaded is iterations_max - 1. */
465 if (get_max_loop_iterations (loop
, &iterations
)
466 && wi::leu_p (iterations
,
467 wi::set_bit_in_zero
<widest_int
>
468 (GET_MODE_PRECISION (mode
) - 1)))
472 /* Abort if an invalid doloop pattern has been generated. */
478 count
= simplify_gen_binary (PLUS
, mode
, count
, const1_rtx
);
480 /* Insert initialization of the count register into the loop header. */
482 /* count has been already copied through copy_rtx. */
483 reset_used_flags (count
);
484 set_used_flags (condition
);
485 tmp
= force_operand (count
, counter_reg
);
486 convert_move (counter_reg
, tmp
, 1);
487 sequence
= get_insns ();
488 unshare_all_rtl_in_chain (sequence
);
490 emit_insn_after (sequence
, BB_END (loop_preheader_edge (loop
)->src
));
492 if (desc
->noloop_assumptions
)
494 rtx ass
= copy_rtx (desc
->noloop_assumptions
);
495 basic_block preheader
= loop_preheader_edge (loop
)->src
;
496 basic_block set_zero
= split_edge (loop_preheader_edge (loop
));
497 basic_block new_preheader
= split_edge (loop_preheader_edge (loop
));
500 /* Expand the condition testing the assumptions and if it does not pass,
501 reset the count register to 0. */
502 redirect_edge_and_branch_force (single_succ_edge (preheader
), new_preheader
);
503 set_immediate_dominator (CDI_DOMINATORS
, new_preheader
, preheader
);
506 set_zero
->frequency
= 0;
508 te
= single_succ_edge (preheader
);
509 for (; ass
; ass
= XEXP (ass
, 1))
510 if (!add_test (XEXP (ass
, 0), &te
, set_zero
))
515 /* We reached a condition that is always true. This is very hard to
516 reproduce (such a loop does not roll, and thus it would most
517 likely get optimized out by some of the preceding optimizations).
518 In fact, I do not have any testcase for it. However, it would
519 also be very hard to show that it is impossible, so we must
521 set_zero
->count
= preheader
->count
;
522 set_zero
->frequency
= preheader
->frequency
;
525 if (EDGE_COUNT (set_zero
->preds
) == 0)
527 /* All the conditions were simplified to false, remove the
528 unreachable set_zero block. */
529 delete_basic_block (set_zero
);
533 /* Reset the counter to zero in the set_zero block. */
535 convert_move (counter_reg
, noloop
, 0);
536 sequence
= get_insns ();
538 emit_insn_after (sequence
, BB_END (set_zero
));
540 set_immediate_dominator (CDI_DOMINATORS
, set_zero
,
541 recompute_dominator (CDI_DOMINATORS
,
545 set_immediate_dominator (CDI_DOMINATORS
, new_preheader
,
546 recompute_dominator (CDI_DOMINATORS
,
550 /* Some targets (eg, C4x) need to initialize special looping
552 if (targetm
.have_doloop_begin ())
553 if (rtx_insn
*seq
= targetm
.gen_doloop_begin (counter_reg
, doloop_seq
))
554 emit_insn_after (seq
, BB_END (loop_preheader_edge (loop
)->src
));
556 /* Insert the new low-overhead looping insn. */
557 emit_jump_insn_after (doloop_seq
, BB_END (loop_end
));
558 jump_insn
= BB_END (loop_end
);
559 jump_label
= block_label (desc
->in_edge
->dest
);
560 JUMP_LABEL (jump_insn
) = jump_label
;
561 LABEL_NUSES (jump_label
)++;
563 /* Ensure the right fallthru edge is marked, for case we have reversed
565 desc
->in_edge
->flags
&= ~EDGE_FALLTHRU
;
566 desc
->out_edge
->flags
|= EDGE_FALLTHRU
;
568 /* Add a REG_NONNEG note if the actual or estimated maximum number
569 of iterations is non-negative. */
571 add_reg_note (jump_insn
, REG_NONNEG
, NULL_RTX
);
573 /* Update the REG_BR_PROB note. */
576 /* Seems safer to use the branch probability. */
577 add_int_reg_note (jump_insn
, REG_BR_PROB
, desc
->in_edge
->probability
);
581 /* Called through note_stores. */
584 record_reg_sets (rtx x
, const_rtx pat ATTRIBUTE_UNUSED
, void *data
)
586 bitmap mod
= (bitmap
)data
;
589 unsigned int regno
= REGNO (x
);
590 if (HARD_REGISTER_P (x
))
592 unsigned int end_regno
= end_hard_regno (GET_MODE (x
), regno
);
594 bitmap_set_bit (mod
, regno
);
595 while (++regno
< end_regno
);
598 bitmap_set_bit (mod
, regno
);
602 /* Process loop described by LOOP validating that the loop is suitable for
603 conversion to use a low overhead looping instruction, replacing the jump
604 insn where suitable. Returns true if the loop was successfully
608 doloop_optimize (struct loop
*loop
)
613 widest_int iterations
, iterations_max
;
614 rtx_code_label
*start_label
;
617 HOST_WIDE_INT est_niter
;
619 struct niter_desc
*desc
;
620 unsigned word_mode_size
;
621 unsigned HOST_WIDE_INT word_mode_max
;
625 fprintf (dump_file
, "Doloop: Processing loop %d.\n", loop
->num
);
627 iv_analysis_loop_init (loop
);
629 /* Find the simple exit of a LOOP. */
630 desc
= get_simple_loop_desc (loop
);
632 /* Check that loop is a candidate for a low-overhead looping insn. */
633 if (!doloop_valid_p (loop
, desc
))
637 "Doloop: The loop is not suitable.\n");
642 est_niter
= get_estimated_loop_iterations_int (loop
);
644 est_niter
= get_likely_max_loop_iterations_int (loop
);
646 if (est_niter
>= 0 && est_niter
< 3)
650 "Doloop: Too few iterations (%u) to be profitable.\n",
651 (unsigned int)est_niter
);
656 = COSTS_N_INSNS (PARAM_VALUE (PARAM_MAX_ITERATIONS_COMPUTATION_COST
));
657 if (set_src_cost (desc
->niter_expr
, mode
, optimize_loop_for_speed_p (loop
))
662 "Doloop: number of iterations too costly to compute.\n");
666 if (desc
->const_iter
)
667 iterations
= widest_int::from (rtx_mode_t (desc
->niter_expr
, mode
),
671 if (!get_max_loop_iterations (loop
, &iterations_max
))
673 level
= get_loop_level (loop
) + 1;
674 entered_at_top
= (loop
->latch
== desc
->in_edge
->dest
675 && contains_no_active_insn_p (loop
->latch
));
676 if (!targetm
.can_use_doloop_p (iterations
, iterations_max
, level
,
680 fprintf (dump_file
, "Loop rejected by can_use_doloop_p.\n");
684 /* Generate looping insn. If the pattern FAILs then give up trying
685 to modify the loop since there is some aspect the back-end does
687 count
= copy_rtx (desc
->niter_expr
);
688 start_label
= block_label (desc
->in_edge
->dest
);
689 doloop_reg
= gen_reg_rtx (mode
);
690 rtx_insn
*doloop_seq
= targetm
.gen_doloop_end (doloop_reg
, start_label
);
692 word_mode_size
= GET_MODE_PRECISION (word_mode
);
693 word_mode_max
= (HOST_WIDE_INT_1U
<< (word_mode_size
- 1) << 1) - 1;
696 /* Before trying mode different from the one in that # of iterations is
697 computed, we must be sure that the number of iterations fits into
699 && (word_mode_size
>= GET_MODE_PRECISION (mode
)
700 || wi::leu_p (iterations_max
, word_mode_max
)))
702 if (word_mode_size
> GET_MODE_PRECISION (mode
))
703 count
= simplify_gen_unary (ZERO_EXTEND
, word_mode
, count
, mode
);
705 count
= lowpart_subreg (word_mode
, count
, mode
);
706 PUT_MODE (doloop_reg
, word_mode
);
707 doloop_seq
= targetm
.gen_doloop_end (doloop_reg
, start_label
);
713 "Doloop: Target unwilling to use doloop pattern!\n");
717 /* If multiple instructions were created, the last must be the
719 rtx_insn
*doloop_insn
= doloop_seq
;
720 while (NEXT_INSN (doloop_insn
) != NULL_RTX
)
721 doloop_insn
= NEXT_INSN (doloop_insn
);
722 if (!JUMP_P (doloop_insn
)
723 || !(condition
= doloop_condition_get (doloop_insn
)))
726 fprintf (dump_file
, "Doloop: Unrecognizable doloop pattern!\n");
730 /* Ensure that the new sequence doesn't clobber a register that
731 is live at the end of the block. */
733 bitmap modified
= BITMAP_ALLOC (NULL
);
735 for (rtx_insn
*i
= doloop_seq
; i
!= NULL
; i
= NEXT_INSN (i
))
736 note_stores (PATTERN (i
), record_reg_sets
, modified
);
738 basic_block loop_end
= desc
->out_edge
->src
;
739 bool fail
= bitmap_intersect_p (df_get_live_out (loop_end
), modified
);
740 BITMAP_FREE (modified
);
745 fprintf (dump_file
, "Doloop: doloop pattern clobbers live out\n");
750 doloop_modify (loop
, desc
, doloop_seq
, condition
, count
);
754 /* This is the main entry point. Process all loops using doloop_optimize. */
757 doloop_optimize_loops (void)
763 df_live_add_problem ();
764 df_live_set_all_dirty ();
767 FOR_EACH_LOOP (loop
, 0)
769 doloop_optimize (loop
);
773 df_remove_problem (df_live
);
777 checking_verify_loop_structure ();