OSDN Git Service

Change TARGET_ALTIVEC to TARGET_ALTIVEC_ABI.
[pf3gnuchains/gcc-fork.git] / gcc / cfgloopmanip.c
1 /* Loop manipulation code for GNU compiler.
2    Copyright (C) 2002, 2003 Free Software Foundation, Inc.
3
4 This file is part of GCC.
5
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 2, or (at your option) any later
9 version.
10
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.
15
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING.  If not, write to the Free
18 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
19 02111-1307, USA.  */
20
21 #include "config.h"
22 #include "system.h"
23 #include "coretypes.h"
24 #include "tm.h"
25 #include "rtl.h"
26 #include "hard-reg-set.h"
27 #include "basic-block.h"
28 #include "cfgloop.h"
29 #include "cfglayout.h"
30 #include "output.h"
31
32 static struct loop * duplicate_loop (struct loops *, struct loop *,
33                                      struct loop *);
34 static void duplicate_subloops (struct loops *, struct loop *, struct loop *);
35 static void copy_loops_to (struct loops *, struct loop **, int,
36                            struct loop *);
37 static void loop_redirect_edge (edge, basic_block);
38 static bool loop_delete_branch_edge (edge, int);
39 static void remove_bbs (dominance_info, basic_block *, int);
40 static bool rpe_enum_p (basic_block, void *);
41 static int find_path (edge, dominance_info, basic_block **);
42 static bool alp_enum_p (basic_block, void *);
43 static void add_loop (struct loops *, struct loop *);
44 static void fix_loop_placements (struct loop *);
45 static bool fix_bb_placement (struct loops *, basic_block);
46 static void fix_bb_placements (struct loops *, basic_block);
47 static void place_new_loop (struct loops *, struct loop *);
48 static void scale_loop_frequencies (struct loop *, int, int);
49 static void scale_bbs_frequencies (basic_block *, int, int, int);
50 static basic_block create_preheader (struct loop *, dominance_info, int);
51 static void fix_irreducible_loops (basic_block);
52
53 /* Splits basic block BB after INSN, returns created edge.  Updates loops
54    and dominators.  */
55 edge
56 split_loop_bb (struct loops *loops, basic_block bb, rtx insn)
57 {
58   edge e;
59   basic_block *dom_bbs;
60   int n_dom_bbs, i;
61
62   /* Split the block.  */
63   e = split_block (bb, insn);
64
65   /* Add dest to loop.  */
66   add_bb_to_loop (e->dest, e->src->loop_father);
67
68   /* Fix dominators.  */
69   add_to_dominance_info (loops->cfg.dom, e->dest);
70   n_dom_bbs = get_dominated_by (loops->cfg.dom, e->src, &dom_bbs);
71   for (i = 0; i < n_dom_bbs; i++)
72     set_immediate_dominator (loops->cfg.dom, dom_bbs[i], e->dest);
73   free (dom_bbs);
74   set_immediate_dominator (loops->cfg.dom, e->dest, e->src);
75
76   return e;
77 }
78
79 /* Checks whether basic block BB is dominated by RPE->DOM, where
80    RPE is passed through DATA.  */
81 struct rpe_data
82  {
83    basic_block dom;
84    dominance_info doms;
85  };
86
87 static bool
88 rpe_enum_p (basic_block bb, void *data)
89 {
90   struct rpe_data *rpe = data;
91   return dominated_by_p (rpe->doms, bb, rpe->dom);
92 }
93
94 /* Remove basic blocks BBS from loop structure and dominance info,
95    and delete them afterwards.  */
96 static void
97 remove_bbs (dominance_info dom, basic_block *bbs, int nbbs)
98 {
99   int i;
100
101   for (i = 0; i < nbbs; i++)
102     {
103       remove_bb_from_loops (bbs[i]);
104       delete_from_dominance_info (dom, bbs[i]);
105       delete_block (bbs[i]);
106     }
107 }
108
109 /* Find path -- i.e. the basic blocks dominated by edge E and put them
110    into array BBS, that will be allocated large enough to contain them.
111    E->dest must have exactly one predecessor for this to work (it is
112    easy to achieve and we do not put it here because we do not want to
113    alter anything by this function).  The number of basic blocks in the
114    path is returned.  */
115 static int
116 find_path (edge e, dominance_info doms, basic_block **bbs)
117 {
118   struct rpe_data rpe;
119
120   if (e->dest->pred->pred_next)
121     abort ();
122
123   /* Find bbs in the path.  */
124   rpe.dom = e->dest;
125   rpe.doms = doms;
126   *bbs = xcalloc (n_basic_blocks, sizeof (basic_block));
127   return dfs_enumerate_from (e->dest, 0, rpe_enum_p, *bbs,
128                              n_basic_blocks, &rpe);
129 }
130
131 /* Fix placement of basic block BB inside loop hierarchy stored in LOOPS --
132    Let L be a loop to that BB belongs.  Then every successor of BB must either
133      1) belong to some superloop of loop L, or
134      2) be a header of loop K such that K->outer is superloop of L
135    Returns true if we had to move BB into other loop to enforce this condition,
136    false if the placement of BB was already correct (provided that placements
137    of its successors are correct).  */
138 static bool
139 fix_bb_placement (struct loops *loops, basic_block bb)
140 {
141   edge e;
142   struct loop *loop = loops->tree_root, *act;
143
144   for (e = bb->succ; e; e = e->succ_next)
145     {
146       if (e->dest == EXIT_BLOCK_PTR)
147         continue;
148
149       act = e->dest->loop_father;
150       if (act->header == e->dest)
151         act = act->outer;
152
153       if (flow_loop_nested_p (loop, act))
154         loop = act;
155     }
156
157   if (loop == bb->loop_father)
158     return false;
159
160   remove_bb_from_loops (bb);
161   add_bb_to_loop (bb, loop);
162
163   return true;
164 }
165
166 /* Fix placements of basic blocks inside loop hierarchy stored in loops; i.e.
167    enforce condition condition stated in description of fix_bb_placement. We
168    start from basic block FROM that had some of its successors removed, so that
169    his placement no longer has to be correct, and iteratively fix placement of
170    its predecessors that may change if placement of FROM changed.  Also fix
171    placement of subloops of FROM->loop_father, that might also be altered due
172    to this change; the condition for them is similar, except that instead of
173    successors we consider edges coming out of the loops.  */
174 static void
175 fix_bb_placements (struct loops *loops, basic_block from)
176 {
177   sbitmap in_queue;
178   basic_block *queue, *qtop, *qbeg, *qend;
179   struct loop *base_loop;
180   edge e;
181
182   /* We pass through blocks back-reachable from FROM, testing whether some
183      of their successors moved to outer loop.  It may be necessary to
184      iterate several times, but it is finite, as we stop unless we move
185      the basic block up the loop structure.  The whole story is a bit
186      more complicated due to presence of subloops, those are moved using
187      fix_loop_placement.  */
188
189   base_loop = from->loop_father;
190   if (base_loop == loops->tree_root)
191     return;
192
193   in_queue = sbitmap_alloc (last_basic_block);
194   sbitmap_zero (in_queue);
195   SET_BIT (in_queue, from->index);
196   /* Prevent us from going out of the base_loop.  */
197   SET_BIT (in_queue, base_loop->header->index);
198
199   queue = xmalloc ((base_loop->num_nodes + 1) * sizeof (basic_block));
200   qtop = queue + base_loop->num_nodes + 1;
201   qbeg = queue;
202   qend = queue + 1;
203   *qbeg = from;
204
205   while (qbeg != qend)
206     {
207       from = *qbeg;
208       qbeg++;
209       if (qbeg == qtop)
210         qbeg = queue;
211       RESET_BIT (in_queue, from->index);
212
213       if (from->loop_father->header == from)
214         {
215           /* Subloop header, maybe move the loop upward.  */
216           if (!fix_loop_placement (from->loop_father))
217             continue;
218         }
219       else
220         {
221           /* Ordinary basic block.  */
222           if (!fix_bb_placement (loops, from))
223             continue;
224         }
225
226       /* Something has changed, insert predecessors into queue.  */
227       for (e = from->pred; e; e = e->pred_next)
228         {
229           basic_block pred = e->src;
230           struct loop *nca;
231
232           if (TEST_BIT (in_queue, pred->index))
233             continue;
234
235           /* If it is subloop, then it either was not moved, or
236              the path up the loop tree from base_loop do not contain
237              it.  */
238           nca = find_common_loop (pred->loop_father, base_loop);
239           if (pred->loop_father != base_loop
240               && (nca == base_loop
241                   || nca != pred->loop_father))
242             pred = pred->loop_father->header;
243           else if (!flow_loop_nested_p (from->loop_father, pred->loop_father))
244             {
245               /* No point in processing it.  */
246               continue;
247             }
248
249           if (TEST_BIT (in_queue, pred->index))
250             continue;
251
252           /* Schedule the basic block.  */
253           *qend = pred;
254           qend++;
255           if (qend == qtop)
256             qend = queue;
257           SET_BIT (in_queue, pred->index);
258         }
259     }
260   free (in_queue);
261   free (queue);
262 }
263
264 /* Basic block from has lost one or more of its predecessors, so it might
265    mo longer be part irreducible loop.  Fix it and proceed recursively
266    for its successors if needed.  */
267 static void
268 fix_irreducible_loops (basic_block from)
269 {
270   basic_block bb;
271   basic_block *stack;
272   int stack_top;
273   sbitmap on_stack;
274   edge *edges, e;
275   unsigned n_edges, i;
276
277   if (!(from->flags & BB_IRREDUCIBLE_LOOP))
278     return;
279
280   on_stack = sbitmap_alloc (last_basic_block);
281   sbitmap_zero (on_stack);
282   SET_BIT (on_stack, from->index);
283   stack = xmalloc (from->loop_father->num_nodes * sizeof (basic_block));
284   stack[0] = from;
285   stack_top = 1;
286
287   while (stack_top)
288     {
289       bb = stack[--stack_top];
290       RESET_BIT (on_stack, bb->index);
291
292       for (e = bb->pred; e; e = e->pred_next)
293         if (e->flags & EDGE_IRREDUCIBLE_LOOP)
294           break;
295       if (e)
296         continue;
297
298       bb->flags &= ~BB_IRREDUCIBLE_LOOP;
299       if (bb->loop_father->header == bb)
300         edges = get_loop_exit_edges (bb->loop_father, &n_edges);
301       else
302         {
303           n_edges = 0;
304           for (e = bb->succ; e; e = e->succ_next)
305             n_edges++;
306           edges = xmalloc (n_edges * sizeof (edge));
307           n_edges = 0;
308           for (e = bb->succ; e; e = e->succ_next)
309             edges[n_edges++] = e;
310         }
311
312       for (i = 0; i < n_edges; i++)
313         {
314           e = edges[i];
315
316           if (e->flags & EDGE_IRREDUCIBLE_LOOP)
317             {
318               if (!flow_bb_inside_loop_p (from->loop_father, e->dest))
319                 continue;
320
321               e->flags &= ~EDGE_IRREDUCIBLE_LOOP;
322               if (TEST_BIT (on_stack, e->dest->index))
323                 continue;
324
325               SET_BIT (on_stack, e->dest->index);
326               stack[stack_top++] = e->dest;
327             }
328         }
329       free (edges);
330     }
331
332   free (on_stack);
333   free (stack);
334 }
335
336 /* Removes path beginning at edge E, i.e. remove basic blocks dominated by E
337    and update loop structure stored in LOOPS and dominators.  Return true if
338    we were able to remove the path, false otherwise (and nothing is affected
339    then).  */
340 bool
341 remove_path (struct loops *loops, edge e)
342 {
343   edge ae;
344   basic_block *rem_bbs, *bord_bbs, *dom_bbs, from, bb;
345   int i, nrem, n_bord_bbs, n_dom_bbs;
346   sbitmap seen;
347
348   if (!loop_delete_branch_edge (e, 0))
349     return false;
350
351   /* We need to check whether basic blocks are dominated by the edge
352      e, but we only have basic block dominators.  This is easy to
353      fix -- when e->dest has exactly one predecessor, this corresponds
354      to blocks dominated by e->dest, if not, split the edge.  */
355   if (e->dest->pred->pred_next)
356     e = loop_split_edge_with (e, NULL_RTX, loops)->pred;
357
358   /* It may happen that by removing path we remove one or more loops
359      we belong to.  In this case first unloop the loops, then proceed
360      normally.   We may assume that e->dest is not a header of any loop,
361      as it now has exactly one predecessor.  */
362   while (e->src->loop_father->outer
363          && dominated_by_p (loops->cfg.dom,
364                             e->src->loop_father->latch, e->dest))
365     unloop (loops, e->src->loop_father);
366
367   /* Identify the path.  */
368   nrem = find_path (e, loops->cfg.dom, &rem_bbs);
369
370   n_bord_bbs = 0;
371   bord_bbs = xcalloc (n_basic_blocks, sizeof (basic_block));
372   seen = sbitmap_alloc (last_basic_block);
373   sbitmap_zero (seen);
374
375   /* Find "border" hexes -- i.e. those with predecessor in removed path.  */
376   for (i = 0; i < nrem; i++)
377     SET_BIT (seen, rem_bbs[i]->index);
378   for (i = 0; i < nrem; i++)
379     {
380       bb = rem_bbs[i];
381       for (ae = rem_bbs[i]->succ; ae; ae = ae->succ_next)
382         if (ae->dest != EXIT_BLOCK_PTR && !TEST_BIT (seen, ae->dest->index))
383           {
384             SET_BIT (seen, ae->dest->index);
385             bord_bbs[n_bord_bbs++] = ae->dest;
386           }
387     }
388
389   /* Remove the path.  */
390   from = e->src;
391   if (!loop_delete_branch_edge (e, 1))
392     abort ();
393   dom_bbs = xcalloc (n_basic_blocks, sizeof (basic_block));
394
395   /* Cancel loops contained in the path.  */
396   for (i = 0; i < nrem; i++)
397     if (rem_bbs[i]->loop_father->header == rem_bbs[i])
398       cancel_loop_tree (loops, rem_bbs[i]->loop_father);
399
400   remove_bbs (loops->cfg.dom, rem_bbs, nrem);
401   free (rem_bbs);
402
403   /* Find blocks whose dominators may be affected.  */
404   n_dom_bbs = 0;
405   sbitmap_zero (seen);
406   for (i = 0; i < n_bord_bbs; i++)
407     {
408       int j, nldom;
409       basic_block *ldom;
410
411       bb = get_immediate_dominator (loops->cfg.dom, bord_bbs[i]);
412       if (TEST_BIT (seen, bb->index))
413         continue;
414       SET_BIT (seen, bb->index);
415
416       nldom = get_dominated_by (loops->cfg.dom, bb, &ldom);
417       for (j = 0; j < nldom; j++)
418         if (!dominated_by_p (loops->cfg.dom, from, ldom[j]))
419           dom_bbs[n_dom_bbs++] = ldom[j];
420       free(ldom);
421     }
422
423   free (seen);
424
425   /* Recount dominators.  */
426   iterate_fix_dominators (loops->cfg.dom, dom_bbs, n_dom_bbs);
427   free (dom_bbs);
428
429   /* These blocks have lost some predecessor(s), thus their irreducible
430      status could be changed.  */
431   for (i = 0; i < n_bord_bbs; i++)
432     fix_irreducible_loops (bord_bbs[i]);
433   free (bord_bbs);
434
435   /* Fix placements of basic blocks inside loops and the placement of
436      loops in the loop tree.  */
437   fix_bb_placements (loops, from);
438   fix_loop_placements (from->loop_father);
439
440   return true;
441 }
442
443 /* Predicate for enumeration in add_loop.  */
444 static bool
445 alp_enum_p (basic_block bb, void *alp_header)
446 {
447   return bb != (basic_block) alp_header;
448 }
449
450 /* Given LOOP structure with filled header and latch, find the body of the
451    corresponding loop and add it to LOOPS tree.  */
452 static void
453 add_loop (struct loops *loops, struct loop *loop)
454 {
455   basic_block *bbs;
456   int i, n;
457
458   /* Add it to loop structure.  */
459   place_new_loop (loops, loop);
460   loop->level = 1;
461
462   /* Find its nodes.  */
463   bbs = xcalloc (n_basic_blocks, sizeof (basic_block));
464   n = dfs_enumerate_from (loop->latch, 1, alp_enum_p,
465                           bbs, n_basic_blocks, loop->header);
466
467   for (i = 0; i < n; i++)
468     add_bb_to_loop (bbs[i], loop);
469   add_bb_to_loop (loop->header, loop);
470
471   free (bbs);
472 }
473
474 /* Multiply all frequencies of basic blocks in array BBS of length NBBS
475    by NUM/DEN.  */
476 static void
477 scale_bbs_frequencies (basic_block *bbs, int nbbs, int num, int den)
478 {
479   int i;
480   edge e;
481
482   for (i = 0; i < nbbs; i++)
483     {
484       bbs[i]->frequency = (bbs[i]->frequency * num) / den;
485       bbs[i]->count = (bbs[i]->count * num) / den;
486       for (e = bbs[i]->succ; e; e = e->succ_next)
487         e->count = (e->count * num) /den;
488     }
489 }
490
491 /* Multiply all frequencies in LOOP by NUM/DEN.  */
492 static void
493 scale_loop_frequencies (struct loop *loop, int num, int den)
494 {
495   basic_block *bbs;
496
497   bbs = get_loop_body (loop);
498   scale_bbs_frequencies (bbs, loop->num_nodes, num, den);
499   free (bbs);
500 }
501
502 /* Make area between HEADER_EDGE and LATCH_EDGE a loop by connecting
503    latch to header and update loop tree stored in LOOPS and dominators
504    accordingly. Everything between them plus LATCH_EDGE destination must
505    be dominated by HEADER_EDGE destination, and back-reachable from
506    LATCH_EDGE source.  HEADER_EDGE is redirected to basic block SWITCH_BB,
507    SWITCH_BB->succ to original destination of LATCH_EDGE and
508    SWITCH_BB->succ->succ_next to original destination of HEADER_EDGE.
509    Returns newly created loop.  */
510 struct loop *
511 loopify (struct loops *loops, edge latch_edge, edge header_edge, basic_block switch_bb)
512 {
513   basic_block succ_bb = latch_edge->dest;
514   basic_block pred_bb = header_edge->src;
515   basic_block *dom_bbs, *body;
516   unsigned n_dom_bbs, i, j;
517   sbitmap seen;
518   struct loop *loop = xcalloc (1, sizeof (struct loop));
519   struct loop *outer = succ_bb->loop_father->outer;
520   int freq, prob, tot_prob;
521   gcov_type cnt;
522   edge e;
523
524   loop->header = header_edge->dest;
525   loop->latch = latch_edge->src;
526
527   freq = EDGE_FREQUENCY (header_edge);
528   cnt = header_edge->count;
529   prob = switch_bb->succ->probability;
530   tot_prob = prob + switch_bb->succ->succ_next->probability;
531   if (tot_prob == 0)
532     tot_prob = 1;
533
534   /* Redirect edges.  */
535   loop_redirect_edge (latch_edge, loop->header);
536   loop_redirect_edge (header_edge, switch_bb);
537   loop_redirect_edge (switch_bb->succ->succ_next, loop->header);
538   loop_redirect_edge (switch_bb->succ, succ_bb);
539
540   /* Update dominators.  */
541   set_immediate_dominator (loops->cfg.dom, switch_bb, pred_bb);
542   set_immediate_dominator (loops->cfg.dom, loop->header, switch_bb);
543   set_immediate_dominator (loops->cfg.dom, succ_bb, switch_bb);
544
545   /* Compute new loop.  */
546   add_loop (loops, loop);
547   flow_loop_tree_node_add (outer, loop);
548
549   /* Add switch_bb to appropriate loop.  */
550   add_bb_to_loop (switch_bb, outer);
551
552   /* Fix frequencies.  */
553   switch_bb->frequency = freq;
554   switch_bb->count = cnt;
555   for (e = switch_bb->succ; e; e = e->succ_next)
556     e->count = (switch_bb->count * e->probability) / REG_BR_PROB_BASE;
557   scale_loop_frequencies (loop, prob, tot_prob);
558   scale_loop_frequencies (succ_bb->loop_father, tot_prob - prob, tot_prob);
559
560   /* Update dominators of blocks outside of LOOP.  */
561   dom_bbs = xcalloc (n_basic_blocks, sizeof (basic_block));
562   n_dom_bbs = 0;
563   seen = sbitmap_alloc (last_basic_block);
564   sbitmap_zero (seen);
565   body = get_loop_body (loop);
566
567   for (i = 0; i < loop->num_nodes; i++)
568     SET_BIT (seen, body[i]->index);
569
570   for (i = 0; i < loop->num_nodes; i++)
571     {
572       unsigned nldom;
573       basic_block *ldom;
574
575       nldom = get_dominated_by (loops->cfg.dom, body[i], &ldom);
576       for (j = 0; j < nldom; j++)
577         if (!TEST_BIT (seen, ldom[j]->index))
578           {
579             SET_BIT (seen, ldom[j]->index);
580             dom_bbs[n_dom_bbs++] = ldom[j];
581           }
582       free (ldom);
583     }
584
585   iterate_fix_dominators (loops->cfg.dom, dom_bbs, n_dom_bbs);
586
587   free (body);
588   free (seen);
589   free (dom_bbs);
590
591   return loop;
592 }
593
594 /* Remove the latch edge of a LOOP and update LOOPS tree to indicate that
595    the LOOP was removed.  After this function, original loop latch will
596    have no successor, which caller is expected to fix somehow.  */
597 void
598 unloop (struct loops *loops, struct loop *loop)
599 {
600   basic_block *body;
601   struct loop *ploop;
602   unsigned i, n;
603   basic_block latch = loop->latch;
604   edge *edges;
605   unsigned n_edges;
606
607   /* This is relatively straightforward.  The dominators are unchanged, as
608      loop header dominates loop latch, so the only thing we have to care of
609      is the placement of loops and basic blocks inside the loop tree.  We
610      move them all to the loop->outer, and then let fix_bb_placements do
611      its work.  */
612
613   body = get_loop_body (loop);
614   edges = get_loop_exit_edges (loop, &n_edges);
615   n = loop->num_nodes;
616   for (i = 0; i < n; i++)
617     if (body[i]->loop_father == loop)
618       {
619         remove_bb_from_loops (body[i]);
620         add_bb_to_loop (body[i], loop->outer);
621       }
622   free(body);
623
624   while (loop->inner)
625     {
626       ploop = loop->inner;
627       flow_loop_tree_node_remove (ploop);
628       flow_loop_tree_node_add (loop->outer, ploop);
629     }
630
631   /* Remove the loop and free its data.  */
632   flow_loop_tree_node_remove (loop);
633   loops->parray[loop->num] = NULL;
634   flow_loop_free (loop);
635
636   remove_edge (latch->succ);
637   fix_bb_placements (loops, latch);
638
639   /* If the loop was inside an irreducible region, we would have to somehow
640      update the irreducible marks inside its body.  While it is certainly
641      possible to do, it is a bit complicated and this situation should be
642      very rare, so we just remark all loops in this case.  */
643   for (i = 0; i < n_edges; i++)
644     if (edges[i]->flags & EDGE_IRREDUCIBLE_LOOP)
645       break;
646   if (i != n_edges)
647     mark_irreducible_loops (loops);
648   free (edges);
649 }
650
651 /* Fix placement of LOOP inside loop tree, i.e. find the innermost superloop
652    FATHER of LOOP such that all of the edges coming out of LOOP belong to
653    FATHER, and set it as outer loop of LOOP.  Return 1 if placement of
654    LOOP changed.  */
655 int
656 fix_loop_placement (struct loop *loop)
657 {
658   basic_block *body;
659   unsigned i;
660   edge e;
661   struct loop *father = loop->pred[0], *act;
662
663   body = get_loop_body (loop);
664   for (i = 0; i < loop->num_nodes; i++)
665     for (e = body[i]->succ; e; e = e->succ_next)
666       if (!flow_bb_inside_loop_p (loop, e->dest))
667         {
668           act = find_common_loop (loop, e->dest->loop_father);
669           if (flow_loop_nested_p (father, act))
670             father = act;
671         }
672   free (body);
673
674   if (father != loop->outer)
675     {
676       for (act = loop->outer; act != father; act = act->outer)
677         act->num_nodes -= loop->num_nodes;
678       flow_loop_tree_node_remove (loop);
679       flow_loop_tree_node_add (father, loop);
680       return 1;
681     }
682   return 0;
683 }
684
685 /* Fix placement of superloops of LOOP inside loop tree, i.e. ensure that
686    condition stated in description of fix_loop_placement holds for them.
687    It is used in case when we removed some edges coming out of LOOP, which
688    may cause the right placement of LOOP inside loop tree to change.  */
689 static void
690 fix_loop_placements (struct loop *loop)
691 {
692   struct loop *outer;
693
694   while (loop->outer)
695     {
696       outer = loop->outer;
697       if (!fix_loop_placement (loop))
698         break;
699       loop = outer;
700     }
701 }
702
703 /* Creates place for a new LOOP in LOOPS structure.  */
704 static void
705 place_new_loop (struct loops *loops, struct loop *loop)
706 {
707   loops->parray =
708     xrealloc (loops->parray, (loops->num + 1) * sizeof (struct loop *));
709   loops->parray[loops->num] = loop;
710
711   loop->num = loops->num++;
712 }
713
714 /* Copies copy of LOOP as subloop of TARGET loop, placing newly
715    created loop into LOOPS structure.  */
716 static struct loop *
717 duplicate_loop (struct loops *loops, struct loop *loop, struct loop *target)
718 {
719   struct loop *cloop;
720   cloop = xcalloc (1, sizeof (struct loop));
721   place_new_loop (loops, cloop);
722
723   /* Initialize copied loop.  */
724   cloop->level = loop->level;
725
726   /* Set it as copy of loop.  */
727   loop->copy = cloop;
728
729   /* Add it to target.  */
730   flow_loop_tree_node_add (target, cloop);
731
732   return cloop;
733 }
734
735 /* Copies structure of subloops of LOOP into TARGET loop, placing
736    newly created loops into loop tree stored in LOOPS.  */
737 static void
738 duplicate_subloops (struct loops *loops, struct loop *loop, struct loop *target)
739 {
740   struct loop *aloop, *cloop;
741
742   for (aloop = loop->inner; aloop; aloop = aloop->next)
743     {
744       cloop = duplicate_loop (loops, aloop, target);
745       duplicate_subloops (loops, aloop, cloop);
746     }
747 }
748
749 /* Copies structure of subloops of N loops, stored in array COPIED_LOOPS,
750    into TARGET loop, placing newly created loops into loop tree LOOPS.  */
751 static void
752 copy_loops_to (struct loops *loops, struct loop **copied_loops, int n, struct loop *target)
753 {
754   struct loop *aloop;
755   int i;
756
757   for (i = 0; i < n; i++)
758     {
759       aloop = duplicate_loop (loops, copied_loops[i], target);
760       duplicate_subloops (loops, copied_loops[i], aloop);
761     }
762 }
763
764 /* Redirects edge E to basic block DEST.  */
765 static void
766 loop_redirect_edge (edge e, basic_block dest)
767 {
768   if (e->dest == dest)
769     return;
770
771   redirect_edge_and_branch_force (e, dest);
772 }
773
774 /* Deletes edge E from a branch if possible.  Unless REALLY_DELETE is set,
775    just test whether it is possible to remove the edge.  */
776 static bool
777 loop_delete_branch_edge (edge e, int really_delete)
778 {
779   basic_block src = e->src;
780   int irr;
781   edge snd;
782
783   if (src->succ->succ_next)
784     {
785       basic_block newdest;
786
787       /* Cannot handle more than two exit edges.  */
788       if (src->succ->succ_next->succ_next)
789         return false;
790       /* And it must be just a simple branch.  */
791       if (!any_condjump_p (src->end))
792         return false;
793
794       snd = e == src->succ ? src->succ->succ_next : src->succ;
795       newdest = snd->dest;
796       if (newdest == EXIT_BLOCK_PTR)
797         return false;
798
799       /* Hopefully the above conditions should suffice.  */
800       if (!really_delete)
801         return true;
802
803       /* Redirecting behaves wrongly wrto this flag.  */
804       irr = snd->flags & EDGE_IRREDUCIBLE_LOOP;
805
806       if (!redirect_edge_and_branch (e, newdest))
807         return false;
808       src->succ->flags &= ~EDGE_IRREDUCIBLE_LOOP;
809       src->succ->flags |= irr;
810
811       return true;
812     }
813   else
814     {
815       /* Cannot happen -- we are using this only to remove an edge
816          from branch.  */
817       abort ();
818     }
819
820   return false;  /* To avoid warning, cannot get here.  */
821 }
822
823 /* Check whether LOOP's body can be duplicated.  */
824 bool
825 can_duplicate_loop_p (struct loop *loop)
826 {
827   int ret;
828   basic_block *bbs = get_loop_body (loop);
829
830   ret = can_copy_bbs_p (bbs, loop->num_nodes);
831   free (bbs);
832   
833   return ret;
834 }
835
836 #define RDIV(X,Y) (((X) + (Y) / 2) / (Y))
837
838 /* Duplicates body of LOOP to given edge E NDUPL times.  Takes care of updating
839    LOOPS structure and dominators.  E's destination must be LOOP header for
840    this to work, i.e. it must be entry or latch edge of this loop; these are
841    unique, as the loops must have preheaders for this function to work
842    correctly (in case E is latch, the function unrolls the loop, if E is entry
843    edge, it peels the loop).  Store edges created by copying ORIG edge from
844    copies corresponding to set bits in WONT_EXIT bitmap (bit 0 corresponds to
845    original LOOP body, the other copies are numbered in order given by control
846    flow through them) into TO_REMOVE array.  Returns false if duplication is
847    impossible.  */
848 int
849 duplicate_loop_to_header_edge (struct loop *loop, edge e, struct loops *loops,
850                                unsigned int ndupl, sbitmap wont_exit,
851                                edge orig, edge *to_remove,
852                                unsigned int *n_to_remove, int flags)
853 {
854   struct loop *target, *aloop;
855   struct loop **orig_loops;
856   unsigned n_orig_loops;
857   basic_block header = loop->header, latch = loop->latch;
858   basic_block *new_bbs, *bbs, *first_active;
859   basic_block new_bb, bb, first_active_latch = NULL;
860   edge ae, latch_edge;
861   edge spec_edges[2], new_spec_edges[2];
862 #define SE_LATCH 0
863 #define SE_ORIG 1
864   unsigned i, j, n;
865   int is_latch = (latch == e->src);
866   int scale_act = 0, *scale_step = NULL, scale_main = 0;
867   int p, freq_in, freq_le, freq_out_orig;
868   int prob_pass_thru, prob_pass_wont_exit, prob_pass_main;
869   int add_irreducible_flag;
870
871   if (e->dest != loop->header)
872     abort ();
873   if (ndupl <= 0)
874     abort ();
875
876   if (orig)
877     {
878       /* Orig must be edge out of the loop.  */
879       if (!flow_bb_inside_loop_p (loop, orig->src))
880         abort ();
881       if (flow_bb_inside_loop_p (loop, orig->dest))
882         abort ();
883     }
884
885   bbs = get_loop_body (loop);
886
887   /* Check whether duplication is possible.  */
888   if (!can_copy_bbs_p (bbs, loop->num_nodes))
889     {
890       free (bbs);
891       return false;
892     }
893   new_bbs = xmalloc (sizeof (basic_block) * loop->num_nodes);
894
895   /* In case we are doing loop peeling and the loop is in the middle of
896      irreducible region, the peeled copies will be inside it too.  */
897   add_irreducible_flag = e->flags & EDGE_IRREDUCIBLE_LOOP;
898   if (is_latch && add_irreducible_flag)
899     abort ();
900
901   /* Find edge from latch.  */
902   latch_edge = loop_latch_edge (loop);
903
904   if (flags & DLTHE_FLAG_UPDATE_FREQ)
905     {
906       /* Calculate coefficients by that we have to scale frequencies
907          of duplicated loop bodies.  */
908       freq_in = header->frequency;
909       freq_le = EDGE_FREQUENCY (latch_edge);
910       if (freq_in == 0)
911         freq_in = 1;
912       if (freq_in < freq_le)
913         freq_in = freq_le;
914       freq_out_orig = orig ? EDGE_FREQUENCY (orig) : freq_in - freq_le;
915       if (freq_out_orig > freq_in - freq_le)
916         freq_out_orig = freq_in - freq_le;
917       prob_pass_thru = RDIV (REG_BR_PROB_BASE * freq_le, freq_in);
918       prob_pass_wont_exit =
919               RDIV (REG_BR_PROB_BASE * (freq_le + freq_out_orig), freq_in);
920
921       scale_step = xmalloc (ndupl * sizeof (int));
922
923         for (i = 1; i <= ndupl; i++)
924           scale_step[i - 1] = TEST_BIT (wont_exit, i)
925                                 ? prob_pass_wont_exit
926                                 : prob_pass_thru;
927
928       if (is_latch)
929         {
930           prob_pass_main = TEST_BIT (wont_exit, 0)
931                                 ? prob_pass_wont_exit
932                                 : prob_pass_thru;
933           p = prob_pass_main;
934           scale_main = REG_BR_PROB_BASE;
935           for (i = 0; i < ndupl; i++)
936             {
937               scale_main += p;
938               p = RDIV (p * scale_step[i], REG_BR_PROB_BASE);
939             }
940           scale_main = RDIV (REG_BR_PROB_BASE * REG_BR_PROB_BASE, scale_main);
941           scale_act = RDIV (scale_main * prob_pass_main, REG_BR_PROB_BASE);
942         }
943       else
944         {
945           scale_main = REG_BR_PROB_BASE;
946           for (i = 0; i < ndupl; i++)
947             scale_main = RDIV (scale_main * scale_step[i], REG_BR_PROB_BASE);
948           scale_act = REG_BR_PROB_BASE - prob_pass_thru;
949         }
950       for (i = 0; i < ndupl; i++)
951         if (scale_step[i] < 0 || scale_step[i] > REG_BR_PROB_BASE)
952           abort ();
953       if (scale_main < 0 || scale_main > REG_BR_PROB_BASE
954           || scale_act < 0  || scale_act > REG_BR_PROB_BASE)
955         abort ();
956     }
957
958   /* Loop the new bbs will belong to.  */
959   target = e->src->loop_father;
960
961   /* Original loops.  */
962   n_orig_loops = 0;
963   for (aloop = loop->inner; aloop; aloop = aloop->next)
964     n_orig_loops++;
965   orig_loops = xcalloc (n_orig_loops, sizeof (struct loop *));
966   for (aloop = loop->inner, i = 0; aloop; aloop = aloop->next, i++)
967     orig_loops[i] = aloop;
968
969   loop->copy = target;
970
971   n = loop->num_nodes;
972
973   first_active = xmalloc (n * sizeof (basic_block));
974   if (is_latch)
975     {
976       memcpy (first_active, bbs, n * sizeof (basic_block));
977       first_active_latch = latch;
978     }
979
980   /* Record exit edge in original loop body.  */
981   if (orig && TEST_BIT (wont_exit, 0))
982     to_remove[(*n_to_remove)++] = orig;
983
984   spec_edges[SE_ORIG] = orig;
985   spec_edges[SE_LATCH] = latch_edge;
986
987   for (j = 0; j < ndupl; j++)
988     {
989       /* Copy loops.  */
990       copy_loops_to (loops, orig_loops, n_orig_loops, target);
991
992       /* Copy bbs.  */
993       copy_bbs (bbs, n, new_bbs, spec_edges, 2, new_spec_edges, loop, loops);
994
995       /* Note whether the blocks and edges belong to an irreducible loop.  */
996       if (add_irreducible_flag)
997         {
998           for (i = 0; i < n; i++)
999             new_bbs[i]->rbi->duplicated = 1;
1000           for (i = 0; i < n; i++)
1001             {
1002               new_bb = new_bbs[i];
1003               if (new_bb->loop_father == target)
1004                 new_bb->flags |= BB_IRREDUCIBLE_LOOP;
1005
1006               for (ae = new_bb->succ; ae; ae = ae->succ_next)
1007                 if (ae->dest->rbi->duplicated
1008                     && (ae->src->loop_father == target
1009                         || ae->dest->loop_father == target))
1010                   ae->flags |= EDGE_IRREDUCIBLE_LOOP;
1011             }
1012           for (i = 0; i < n; i++)
1013             new_bbs[i]->rbi->duplicated = 0;
1014         }
1015
1016       /* Redirect the special edges.  */
1017       if (is_latch)
1018         {
1019           redirect_edge_and_branch_force (latch_edge, new_bbs[0]);
1020           redirect_edge_and_branch_force (new_spec_edges[SE_LATCH],
1021                                           loop->header);
1022           set_immediate_dominator (loops->cfg.dom, new_bbs[0], latch);
1023           latch = loop->latch = new_bbs[1];
1024           e = latch_edge = new_spec_edges[SE_LATCH];
1025         }
1026       else
1027         {
1028           redirect_edge_and_branch_force (new_spec_edges[SE_LATCH],
1029                                           loop->header);
1030           redirect_edge_and_branch_force (e, new_bbs[0]);
1031           set_immediate_dominator (loops->cfg.dom, new_bbs[0], e->src);
1032           e = new_spec_edges[SE_LATCH];
1033         }
1034
1035       /* Record exit edge in this copy.  */
1036       if (orig && TEST_BIT (wont_exit, j + 1))
1037         to_remove[(*n_to_remove)++] = new_spec_edges[SE_ORIG];
1038
1039       /* Record the first copy in the control flow order if it is not
1040          the original loop (i.e. in case of peeling).  */
1041       if (!first_active_latch)
1042         {
1043           memcpy (first_active, new_bbs, n * sizeof (basic_block));
1044           first_active_latch = new_bbs[1];
1045         }
1046
1047       /* Set counts and frequencies.  */
1048       if (flags & DLTHE_FLAG_UPDATE_FREQ)
1049         {
1050           scale_bbs_frequencies (new_bbs, n, scale_act, REG_BR_PROB_BASE);
1051           scale_act = RDIV (scale_act * scale_step[j], REG_BR_PROB_BASE);
1052         }
1053     }
1054   free (new_bbs);
1055   free (orig_loops);
1056   
1057   /* Update the original loop.  */
1058   if (!is_latch)
1059     set_immediate_dominator (loops->cfg.dom, e->dest, e->src);
1060   if (flags & DLTHE_FLAG_UPDATE_FREQ)
1061     {
1062       scale_bbs_frequencies (bbs, n, scale_main, REG_BR_PROB_BASE);
1063       free (scale_step);
1064     }
1065
1066   /* Update dominators of outer blocks if affected.  */
1067   for (i = 0; i < n; i++)
1068     {
1069       basic_block dominated, dom_bb, *dom_bbs;
1070       int n_dom_bbs,j;
1071
1072       bb = bbs[i];
1073       n_dom_bbs = get_dominated_by (loops->cfg.dom, bb, &dom_bbs);
1074       for (j = 0; j < n_dom_bbs; j++)
1075         {
1076           dominated = dom_bbs[j];
1077           if (flow_bb_inside_loop_p (loop, dominated))
1078             continue;
1079           dom_bb = nearest_common_dominator (
1080                         loops->cfg.dom, first_active[i], first_active_latch);
1081           set_immediate_dominator (loops->cfg.dom, dominated, dom_bb);
1082         }
1083       free (dom_bbs);
1084     }
1085   free (first_active);
1086
1087   free (bbs);
1088
1089   return true;
1090 }
1091
1092 /* Creates a pre-header for a LOOP.  Returns newly created block.  Unless
1093    CP_SIMPLE_PREHEADERS is set in FLAGS, we only force LOOP to have single
1094    entry; otherwise we also force preheader block to have only one successor.
1095    The function also updates dominators stored in DOM.  */
1096 static basic_block
1097 create_preheader (struct loop *loop, dominance_info dom, int flags)
1098 {
1099   edge e, fallthru;
1100   basic_block dummy;
1101   basic_block jump, src = 0;
1102   struct loop *cloop, *ploop;
1103   int nentry = 0;
1104   rtx insn;
1105
1106   cloop = loop->outer;
1107
1108   for (e = loop->header->pred; e; e = e->pred_next)
1109     {
1110       if (e->src == loop->latch)
1111         continue;
1112       nentry++;
1113     }
1114   if (!nentry)
1115     abort ();
1116   if (nentry == 1)
1117     {
1118       for (e = loop->header->pred; e->src == loop->latch; e = e->pred_next);
1119       if (!(flags & CP_SIMPLE_PREHEADERS)
1120           || !e->src->succ->succ_next)
1121         return NULL;
1122     }
1123
1124   insn = first_insn_after_basic_block_note (loop->header);
1125   if (insn)
1126     insn = PREV_INSN (insn);
1127   else
1128     insn = get_last_insn ();
1129   if (insn == loop->header->end)
1130     {
1131       /* Split_block would not split block after its end.  */
1132       emit_note_after (NOTE_INSN_DELETED, insn);
1133     }
1134   fallthru = split_block (loop->header, insn);
1135   dummy = fallthru->src;
1136   loop->header = fallthru->dest;
1137
1138   /* The header could be a latch of some superloop(s); due to design of
1139      split_block, it would now move to fallthru->dest.  */
1140   for (ploop = loop; ploop; ploop = ploop->outer)
1141     if (ploop->latch == dummy)
1142       ploop->latch = fallthru->dest;
1143
1144   add_to_dominance_info (dom, fallthru->dest);
1145
1146   /* Redirect edges.  */
1147   for (e = dummy->pred; e; e = e->pred_next)
1148     {
1149       src = e->src;
1150       if (src == loop->latch)
1151         break;
1152     }
1153   if (!e)
1154     abort ();
1155
1156   dummy->frequency -= EDGE_FREQUENCY (e);
1157   dummy->count -= e->count;
1158   fallthru->count -= e->count;
1159   jump = redirect_edge_and_branch_force (e, loop->header);
1160   if (jump)
1161     {
1162       add_to_dominance_info (dom, jump);
1163       set_immediate_dominator (dom, jump, src);
1164       add_bb_to_loop (jump, loop);
1165       loop->latch = jump;
1166     }
1167
1168   /* Update structures.  */
1169   redirect_immediate_dominators (dom, dummy, loop->header);
1170   set_immediate_dominator (dom, loop->header, dummy);
1171   loop->header->loop_father = loop;
1172   add_bb_to_loop (dummy, cloop);
1173   if (rtl_dump_file)
1174     fprintf (rtl_dump_file, "Created preheader block for loop %i\n",
1175              loop->num);
1176
1177   return dummy;
1178 }
1179
1180 /* Create preheaders for each loop from loop tree stored in LOOPS; for meaning
1181    of FLAGS see create_preheader.  */
1182 void
1183 create_preheaders (struct loops *loops, int flags)
1184 {
1185   unsigned i;
1186   for (i = 1; i < loops->num; i++)
1187     create_preheader (loops->parray[i], loops->cfg.dom, flags);
1188   loops->state |= LOOPS_HAVE_PREHEADERS;
1189 }
1190
1191 /* Forces all loop latches of loops from loop tree LOOPS to have only single
1192    successor.  */
1193 void
1194 force_single_succ_latches (struct loops *loops)
1195 {
1196   unsigned i;
1197   struct loop *loop;
1198   edge e;
1199
1200   for (i = 1; i < loops->num; i++)
1201     {
1202       loop = loops->parray[i];
1203       if (loop->latch != loop->header
1204           && !loop->latch->succ->succ_next)
1205         continue;
1206
1207       for (e = loop->header->pred; e->src != loop->latch; e = e->pred_next)
1208         continue;
1209
1210       loop_split_edge_with (e, NULL_RTX, loops);
1211     }
1212   loops->state |= LOOPS_HAVE_SIMPLE_LATCHES;
1213 }
1214
1215 /* A quite stupid function to put INSNS on edge E. They are supposed to form
1216    just one basic block.  Jumps in INSNS are not handled, so cfg do not have to
1217    be ok after this function.  The created block is placed on correct place
1218    in LOOPS structure and its dominator is set.  */
1219 basic_block
1220 loop_split_edge_with (edge e, rtx insns, struct loops *loops)
1221 {
1222   basic_block src, dest, new_bb;
1223   struct loop *loop_c;
1224   edge new_e;
1225
1226   src = e->src;
1227   dest = e->dest;
1228
1229   loop_c = find_common_loop (src->loop_father, dest->loop_father);
1230
1231   /* Create basic block for it.  */
1232
1233   new_bb = split_edge (e);
1234   add_to_dominance_info (loops->cfg.dom, new_bb);
1235   add_bb_to_loop (new_bb, loop_c);
1236   new_bb->flags = insns ? BB_SUPERBLOCK : 0;
1237
1238   new_e = new_bb->succ;
1239   if (e->flags & EDGE_IRREDUCIBLE_LOOP)
1240     {
1241       new_bb->flags |= BB_IRREDUCIBLE_LOOP;
1242       new_e->flags |= EDGE_IRREDUCIBLE_LOOP;
1243     }
1244
1245   if (insns)
1246     emit_insn_after (insns, new_bb->end);
1247
1248   set_immediate_dominator (loops->cfg.dom, new_bb, src);
1249   set_immediate_dominator (loops->cfg.dom, dest,
1250     recount_dominator (loops->cfg.dom, dest));
1251
1252   if (dest->loop_father->latch == src)
1253     dest->loop_father->latch = new_bb;
1254
1255   return new_bb;
1256 }