1 /* Perform doloop optimizations
2 Copyright (C) 2004-2015 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"
28 #include "hard-reg-set.h"
32 #include "insn-config.h"
41 #include "diagnostic-core.h"
44 #include "dominance.h"
48 #include "basic-block.h"
52 #include "loop-unroll.h"
54 /* This module is used to modify loops with a determinable number of
55 iterations to use special low-overhead looping instructions.
57 It first validates whether the loop is well behaved and has a
58 determinable number of iterations (either at compile or run-time).
59 It then modifies the loop to use a low-overhead looping pattern as
62 1. A pseudo register is allocated as the loop iteration counter.
64 2. The number of loop iterations is calculated and is stored
67 3. At the end of the loop, the jump insn is replaced by the
68 doloop_end pattern. The compare must remain because it might be
69 used elsewhere. If the loop-variable or condition register are
70 used elsewhere, they will be eliminated by flow.
72 4. An optional doloop_begin pattern is inserted at the top of the
75 TODO The optimization should only performed when either the biv used for exit
76 condition is unused at all except for the exit test, or if we do not have to
77 change its value, since otherwise we have to add a new induction variable,
78 which usually will not pay up (unless the cost of the doloop pattern is
79 somehow extremely lower than the cost of compare & jump, or unless the bct
80 register cannot be used for anything else but doloop -- ??? detect these
83 #ifdef HAVE_doloop_end
85 /* Return the loop termination condition for PATTERN or zero
86 if it is not a decrement and branch jump insn. */
89 doloop_condition_get (rtx doloop_pat
)
97 rtx cc_reg
= NULL_RTX
;
98 rtx reg_orig
= NULL_RTX
;
100 /* The canonical doloop pattern we expect has one of the following
103 1) (parallel [(set (pc) (if_then_else (condition)
106 (set (reg) (plus (reg) (const_int -1)))
107 (additional clobbers and uses)])
109 The branch must be the first entry of the parallel (also required
110 by jump.c), and the second entry of the parallel must be a set of
111 the loop counter register. Some targets (IA-64) wrap the set of
112 the loop counter in an if_then_else too.
114 2) (set (reg) (plus (reg) (const_int -1))
115 (set (pc) (if_then_else (reg != 0)
119 Some targets (ARM) do the comparison before the branch, as in the
122 3) (parallel [(set (cc) (compare ((plus (reg) (const_int -1), 0)))
123 (set (reg) (plus (reg) (const_int -1)))])
124 (set (pc) (if_then_else (cc == NE)
128 pattern
= PATTERN (doloop_pat
);
130 if (GET_CODE (pattern
) != PARALLEL
)
133 rtx_insn
*prev_insn
= prev_nondebug_insn (doloop_pat
);
134 rtx cmp_arg1
, cmp_arg2
;
137 /* In case the pattern is not PARALLEL we expect two forms
138 of doloop which are cases 2) and 3) above: in case 2) the
139 decrement immediately precedes the branch, while in case 3)
140 the compare and decrement instructions immediately precede
143 if (prev_insn
== NULL_RTX
|| !INSN_P (prev_insn
))
147 if (GET_CODE (PATTERN (prev_insn
)) == PARALLEL
)
149 /* The third case: the compare and decrement instructions
150 immediately precede the branch. */
151 cmp_orig
= XVECEXP (PATTERN (prev_insn
), 0, 0);
152 if (GET_CODE (cmp_orig
) != SET
)
154 if (GET_CODE (SET_SRC (cmp_orig
)) != COMPARE
)
156 cmp_arg1
= XEXP (SET_SRC (cmp_orig
), 0);
157 cmp_arg2
= XEXP (SET_SRC (cmp_orig
), 1);
158 if (cmp_arg2
!= const0_rtx
159 || GET_CODE (cmp_arg1
) != PLUS
)
161 reg_orig
= XEXP (cmp_arg1
, 0);
162 if (XEXP (cmp_arg1
, 1) != GEN_INT (-1)
163 || !REG_P (reg_orig
))
165 cc_reg
= SET_DEST (cmp_orig
);
167 inc
= XVECEXP (PATTERN (prev_insn
), 0, 1);
170 inc
= PATTERN (prev_insn
);
171 /* We expect the condition to be of the form (reg != 0) */
172 cond
= XEXP (SET_SRC (cmp
), 0);
173 if (GET_CODE (cond
) != NE
|| XEXP (cond
, 1) != const0_rtx
)
178 cmp
= XVECEXP (pattern
, 0, 0);
179 inc
= XVECEXP (pattern
, 0, 1);
182 /* Check for (set (reg) (something)). */
183 if (GET_CODE (inc
) != SET
)
185 reg
= SET_DEST (inc
);
189 /* Check if something = (plus (reg) (const_int -1)).
190 On IA-64, this decrement is wrapped in an if_then_else. */
191 inc_src
= SET_SRC (inc
);
192 if (GET_CODE (inc_src
) == IF_THEN_ELSE
)
193 inc_src
= XEXP (inc_src
, 1);
194 if (GET_CODE (inc_src
) != PLUS
195 || XEXP (inc_src
, 0) != reg
196 || XEXP (inc_src
, 1) != constm1_rtx
)
199 /* Check for (set (pc) (if_then_else (condition)
202 if (GET_CODE (cmp
) != SET
203 || SET_DEST (cmp
) != pc_rtx
204 || GET_CODE (SET_SRC (cmp
)) != IF_THEN_ELSE
205 || GET_CODE (XEXP (SET_SRC (cmp
), 1)) != LABEL_REF
206 || XEXP (SET_SRC (cmp
), 2) != pc_rtx
)
209 /* Extract loop termination condition. */
210 condition
= XEXP (SET_SRC (cmp
), 0);
212 /* We expect a GE or NE comparison with 0 or 1. */
213 if ((GET_CODE (condition
) != GE
214 && GET_CODE (condition
) != NE
)
215 || (XEXP (condition
, 1) != const0_rtx
216 && XEXP (condition
, 1) != const1_rtx
))
219 if ((XEXP (condition
, 0) == reg
)
220 /* For the third case: */
221 || ((cc_reg
!= NULL_RTX
)
222 && (XEXP (condition
, 0) == cc_reg
)
223 && (reg_orig
== reg
))
224 || (GET_CODE (XEXP (condition
, 0)) == PLUS
225 && XEXP (XEXP (condition
, 0), 0) == reg
))
227 if (GET_CODE (pattern
) != PARALLEL
)
228 /* For the second form we expect:
230 (set (reg) (plus (reg) (const_int -1))
231 (set (pc) (if_then_else (reg != 0)
235 is equivalent to the following:
237 (parallel [(set (pc) (if_then_else (reg != 1)
240 (set (reg) (plus (reg) (const_int -1)))
241 (additional clobbers and uses)])
243 For the third form we expect:
245 (parallel [(set (cc) (compare ((plus (reg) (const_int -1)), 0))
246 (set (reg) (plus (reg) (const_int -1)))])
247 (set (pc) (if_then_else (cc == NE)
251 which is equivalent to the following:
253 (parallel [(set (cc) (compare (reg, 1))
254 (set (reg) (plus (reg) (const_int -1)))
255 (set (pc) (if_then_else (NE == cc)
259 So we return the second form instead for the two cases.
262 condition
= gen_rtx_fmt_ee (NE
, VOIDmode
, inc_src
, const1_rtx
);
267 /* ??? If a machine uses a funny comparison, we could return a
268 canonicalized form here. */
273 /* Return nonzero if the loop specified by LOOP is suitable for
274 the use of special low-overhead looping instructions. DESC
275 describes the number of iterations of the loop. */
278 doloop_valid_p (struct loop
*loop
, struct niter_desc
*desc
)
280 basic_block
*body
= get_loop_body (loop
), bb
;
285 /* Check for loops that may not terminate under special conditions. */
290 /* There are some cases that would require a special attention.
291 For example if the comparison is LEU and the comparison value
292 is UINT_MAX then the loop will not terminate. Similarly, if the
293 comparison code is GEU and the comparison value is 0, the
294 loop will not terminate.
296 If the absolute increment is not 1, the loop can be infinite
297 even with LTU/GTU, e.g. for (i = 3; i > 0; i -= 2)
299 ??? We could compute these conditions at run-time and have a
300 additional jump around the loop to ensure an infinite loop.
301 However, it is very unlikely that this is the intended
302 behavior of the loop and checking for these rare boundary
303 conditions would pessimize all other code.
305 If the loop is executed only a few times an extra check to
306 restart the loop could use up most of the benefits of using a
307 count register loop. Note however, that normally, this
308 restart branch would never execute, so it could be predicted
309 well by the CPU. We should generate the pessimistic code by
310 default, and have an option, e.g. -funsafe-loops that would
311 enable count-register loops in this case. */
313 fprintf (dump_file
, "Doloop: Possible infinite iteration case.\n");
318 for (i
= 0; i
< loop
->num_nodes
; i
++)
322 for (insn
= BB_HEAD (bb
);
323 insn
!= NEXT_INSN (BB_END (bb
));
324 insn
= NEXT_INSN (insn
))
326 /* Different targets have different necessities for low-overhead
327 looping. Call the back end for each instruction within the loop
328 to let it decide whether the insn prohibits a low-overhead loop.
329 It will then return the cause for it to emit to the dump file. */
330 const char * invalid
= targetm
.invalid_within_doloop (insn
);
334 fprintf (dump_file
, "Doloop: %s\n", invalid
);
348 /* Adds test of COND jumping to DEST on edge *E and set *E to the new fallthru
349 edge. If the condition is always false, do not do anything. If it is always
350 true, redirect E to DEST and return false. In all other cases, true is
354 add_test (rtx cond
, edge
*e
, basic_block dest
)
356 rtx_insn
*seq
, *jump
;
357 rtx_code_label
*label
;
359 rtx op0
= XEXP (cond
, 0), op1
= XEXP (cond
, 1);
360 enum rtx_code code
= GET_CODE (cond
);
363 mode
= GET_MODE (XEXP (cond
, 0));
364 if (mode
== VOIDmode
)
365 mode
= GET_MODE (XEXP (cond
, 1));
368 op0
= force_operand (op0
, NULL_RTX
);
369 op1
= force_operand (op1
, NULL_RTX
);
370 label
= block_label (dest
);
371 do_compare_rtx_and_jump (op0
, op1
, code
, 0, mode
, NULL_RTX
, NULL
, label
, -1);
373 jump
= get_last_insn ();
374 if (!jump
|| !JUMP_P (jump
))
376 /* The condition is always false and the jump was optimized out. */
384 /* There always is at least the jump insn in the sequence. */
385 gcc_assert (seq
!= NULL_RTX
);
387 bb
= split_edge_and_insert (*e
, seq
);
388 *e
= single_succ_edge (bb
);
390 if (any_uncondjump_p (jump
))
392 /* The condition is always true. */
394 redirect_edge_and_branch_force (*e
, dest
);
398 JUMP_LABEL (jump
) = label
;
400 /* The jump is supposed to handle an unlikely special case. */
401 add_int_reg_note (jump
, REG_BR_PROB
, 0);
403 LABEL_NUSES (label
)++;
405 make_edge (bb
, dest
, (*e
)->flags
& ~EDGE_FALLTHRU
);
409 /* Modify the loop to use the low-overhead looping insn where LOOP
410 describes the loop, DESC describes the number of iterations of the
411 loop, and DOLOOP_INSN is the low-overhead looping insn to emit at the
412 end of the loop. CONDITION is the condition separated from the
413 DOLOOP_SEQ. COUNT is the number of iterations of the LOOP. */
416 doloop_modify (struct loop
*loop
, struct niter_desc
*desc
,
417 rtx doloop_seq
, rtx condition
, rtx count
)
420 rtx tmp
, noloop
= NULL_RTX
;
423 rtx_code_label
*jump_label
;
425 bool increment_count
;
426 basic_block loop_end
= desc
->out_edge
->src
;
429 widest_int iterations
;
431 jump_insn
= BB_END (loop_end
);
435 fprintf (dump_file
, "Doloop: Inserting doloop pattern (");
436 if (desc
->const_iter
)
437 fprintf (dump_file
, "%" PRId64
, desc
->niter
);
439 fputs ("runtime", dump_file
);
440 fputs (" iterations).\n", dump_file
);
443 /* Get the probability of the original branch. If it exists we would
444 need to update REG_BR_PROB of the new jump_insn. */
445 true_prob_val
= find_reg_note (jump_insn
, REG_BR_PROB
, NULL_RTX
);
447 /* Discard original jump to continue loop. The original compare
448 result may still be live, so it cannot be discarded explicitly. */
449 delete_insn (jump_insn
);
451 counter_reg
= XEXP (condition
, 0);
452 if (GET_CODE (counter_reg
) == PLUS
)
453 counter_reg
= XEXP (counter_reg
, 0);
454 mode
= GET_MODE (counter_reg
);
456 increment_count
= false;
457 switch (GET_CODE (condition
))
460 /* Currently only NE tests against zero and one are supported. */
461 noloop
= XEXP (condition
, 1);
462 if (noloop
!= const0_rtx
)
464 gcc_assert (noloop
== const1_rtx
);
465 increment_count
= true;
470 /* Currently only GE tests against zero are supported. */
471 gcc_assert (XEXP (condition
, 1) == const0_rtx
);
473 noloop
= constm1_rtx
;
475 /* The iteration count does not need incrementing for a GE test. */
476 increment_count
= false;
478 /* Determine if the iteration counter will be non-negative.
479 Note that the maximum value loaded is iterations_max - 1. */
480 if (get_max_loop_iterations (loop
, &iterations
)
481 && wi::leu_p (iterations
,
482 wi::set_bit_in_zero
<widest_int
>
483 (GET_MODE_PRECISION (mode
) - 1)))
487 /* Abort if an invalid doloop pattern has been generated. */
493 count
= simplify_gen_binary (PLUS
, mode
, count
, const1_rtx
);
495 /* Insert initialization of the count register into the loop header. */
497 tmp
= force_operand (count
, counter_reg
);
498 convert_move (counter_reg
, tmp
, 1);
499 sequence
= get_insns ();
501 emit_insn_after (sequence
, BB_END (loop_preheader_edge (loop
)->src
));
503 if (desc
->noloop_assumptions
)
505 rtx ass
= copy_rtx (desc
->noloop_assumptions
);
506 basic_block preheader
= loop_preheader_edge (loop
)->src
;
508 = split_edge (loop_preheader_edge (loop
));
509 basic_block new_preheader
510 = split_edge (loop_preheader_edge (loop
));
513 /* Expand the condition testing the assumptions and if it does not pass,
514 reset the count register to 0. */
515 redirect_edge_and_branch_force (single_succ_edge (preheader
), new_preheader
);
516 set_immediate_dominator (CDI_DOMINATORS
, new_preheader
, preheader
);
519 set_zero
->frequency
= 0;
521 te
= single_succ_edge (preheader
);
522 for (; ass
; ass
= XEXP (ass
, 1))
523 if (!add_test (XEXP (ass
, 0), &te
, set_zero
))
528 /* We reached a condition that is always true. This is very hard to
529 reproduce (such a loop does not roll, and thus it would most
530 likely get optimized out by some of the preceding optimizations).
531 In fact, I do not have any testcase for it. However, it would
532 also be very hard to show that it is impossible, so we must
534 set_zero
->count
= preheader
->count
;
535 set_zero
->frequency
= preheader
->frequency
;
538 if (EDGE_COUNT (set_zero
->preds
) == 0)
540 /* All the conditions were simplified to false, remove the
541 unreachable set_zero block. */
542 delete_basic_block (set_zero
);
546 /* Reset the counter to zero in the set_zero block. */
548 convert_move (counter_reg
, noloop
, 0);
549 sequence
= get_insns ();
551 emit_insn_after (sequence
, BB_END (set_zero
));
553 set_immediate_dominator (CDI_DOMINATORS
, set_zero
,
554 recompute_dominator (CDI_DOMINATORS
,
558 set_immediate_dominator (CDI_DOMINATORS
, new_preheader
,
559 recompute_dominator (CDI_DOMINATORS
,
563 /* Some targets (eg, C4x) need to initialize special looping
565 #ifdef HAVE_doloop_begin
569 init
= gen_doloop_begin (counter_reg
, doloop_seq
);
574 sequence
= get_insns ();
576 emit_insn_after (sequence
, BB_END (loop_preheader_edge (loop
)->src
));
581 /* Insert the new low-overhead looping insn. */
582 emit_jump_insn_after (doloop_seq
, BB_END (loop_end
));
583 jump_insn
= BB_END (loop_end
);
584 jump_label
= block_label (desc
->in_edge
->dest
);
585 JUMP_LABEL (jump_insn
) = jump_label
;
586 LABEL_NUSES (jump_label
)++;
588 /* Ensure the right fallthru edge is marked, for case we have reversed
590 desc
->in_edge
->flags
&= ~EDGE_FALLTHRU
;
591 desc
->out_edge
->flags
|= EDGE_FALLTHRU
;
593 /* Add a REG_NONNEG note if the actual or estimated maximum number
594 of iterations is non-negative. */
596 add_reg_note (jump_insn
, REG_NONNEG
, NULL_RTX
);
598 /* Update the REG_BR_PROB note. */
601 /* Seems safer to use the branch probability. */
602 add_int_reg_note (jump_insn
, REG_BR_PROB
, desc
->in_edge
->probability
);
606 /* Process loop described by LOOP validating that the loop is suitable for
607 conversion to use a low overhead looping instruction, replacing the jump
608 insn where suitable. Returns true if the loop was successfully
612 doloop_optimize (struct loop
*loop
)
615 rtx doloop_seq
, doloop_pat
, doloop_reg
;
617 widest_int iterations
, iterations_max
;
618 rtx_code_label
*start_label
;
620 unsigned level
, est_niter
;
622 struct niter_desc
*desc
;
623 unsigned word_mode_size
;
624 unsigned HOST_WIDE_INT word_mode_max
;
628 fprintf (dump_file
, "Doloop: Processing loop %d.\n", loop
->num
);
630 iv_analysis_loop_init (loop
);
632 /* Find the simple exit of a LOOP. */
633 desc
= get_simple_loop_desc (loop
);
635 /* Check that loop is a candidate for a low-overhead looping insn. */
636 if (!doloop_valid_p (loop
, desc
))
640 "Doloop: The loop is not suitable.\n");
646 if (desc
->const_iter
)
647 est_niter
= desc
->niter
;
648 /* If the estimate on number of iterations is reliable (comes from profile
649 feedback), use it. Do not use it normally, since the expected number
650 of iterations of an unrolled loop is 2. */
651 if (loop
->header
->count
)
652 est_niter
= expected_loop_iterations (loop
);
658 "Doloop: Too few iterations (%u) to be profitable.\n",
664 = COSTS_N_INSNS (PARAM_VALUE (PARAM_MAX_ITERATIONS_COMPUTATION_COST
));
665 if (set_src_cost (desc
->niter_expr
, optimize_loop_for_speed_p (loop
))
670 "Doloop: number of iterations too costly to compute.\n");
674 if (desc
->const_iter
)
675 iterations
= widest_int::from (std::make_pair (desc
->niter_expr
, mode
),
679 if (!get_max_loop_iterations (loop
, &iterations_max
))
681 level
= get_loop_level (loop
) + 1;
682 entered_at_top
= (loop
->latch
== desc
->in_edge
->dest
683 && contains_no_active_insn_p (loop
->latch
));
684 if (!targetm
.can_use_doloop_p (iterations
, iterations_max
, level
,
688 fprintf (dump_file
, "Loop rejected by can_use_doloop_p.\n");
692 /* Generate looping insn. If the pattern FAILs then give up trying
693 to modify the loop since there is some aspect the back-end does
695 count
= copy_rtx (desc
->niter_expr
);
696 start_label
= block_label (desc
->in_edge
->dest
);
697 doloop_reg
= gen_reg_rtx (mode
);
698 doloop_seq
= gen_doloop_end (doloop_reg
, start_label
);
700 word_mode_size
= GET_MODE_PRECISION (word_mode
);
702 = ((unsigned HOST_WIDE_INT
) 1 << (word_mode_size
- 1) << 1) - 1;
705 /* Before trying mode different from the one in that # of iterations is
706 computed, we must be sure that the number of iterations fits into
708 && (word_mode_size
>= GET_MODE_PRECISION (mode
)
709 || wi::leu_p (iterations_max
, word_mode_max
)))
711 if (word_mode_size
> GET_MODE_PRECISION (mode
))
712 count
= simplify_gen_unary (ZERO_EXTEND
, word_mode
, count
, mode
);
714 count
= lowpart_subreg (word_mode
, count
, mode
);
715 PUT_MODE (doloop_reg
, word_mode
);
716 doloop_seq
= gen_doloop_end (doloop_reg
, start_label
);
722 "Doloop: Target unwilling to use doloop pattern!\n");
726 /* If multiple instructions were created, the last must be the
727 jump instruction. Also, a raw define_insn may yield a plain
729 doloop_pat
= doloop_seq
;
730 if (INSN_P (doloop_pat
))
732 rtx_insn
*doloop_insn
= as_a
<rtx_insn
*> (doloop_pat
);
733 while (NEXT_INSN (doloop_insn
) != NULL_RTX
)
734 doloop_insn
= NEXT_INSN (doloop_insn
);
735 if (!JUMP_P (doloop_insn
))
737 doloop_pat
= doloop_insn
;
741 || ! (condition
= doloop_condition_get (doloop_pat
)))
744 fprintf (dump_file
, "Doloop: Unrecognizable doloop pattern!\n");
748 doloop_modify (loop
, desc
, doloop_seq
, condition
, count
);
752 /* This is the main entry point. Process all loops using doloop_optimize. */
755 doloop_optimize_loops (void)
759 FOR_EACH_LOOP (loop
, 0)
761 doloop_optimize (loop
);
766 #ifdef ENABLE_CHECKING
767 verify_loop_structure ();
770 #endif /* HAVE_doloop_end */