a2c72d911b7dffde75472897aec88c000ccbe7e8
[libfirm] / ir / ana / irscc.c
1 /*
2  * Project:     libFIRM
3  * File name:   ir/ana/irscc.c
4  * Purpose:     Compute the strongly connected regions and build
5  *              backedge/loop datastructures.
6  *              A variation on the Tarjan algorithm. See also [Trapp:99],
7  *              Chapter 5.2.1.2.
8  * Author:      Goetz Lindenmaier
9  * Modified by:
10  * Created:     7.2002
11  * CVS-ID:      $Id$
12  * Copyright:   (c) 2002-2003 Universität Karlsruhe
13  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
14  */
15
16 #ifdef HAVE_CONFIG_H
17 #include "config.h"
18 #endif
19
20 #include <string.h>
21
22 #include "irloop_t.h"
23 #include "irnode.h"
24 #include "irgraph_t.h"
25 #include "array.h"
26 #include "pmap.h"
27 #include "irgwalk.h"
28 #include "irprog_t.h"
29
30 ir_graph *outermost_ir_graph;      /* The outermost graph the scc is computed
31                                       for */
32 static ir_loop *current_loop;      /* Current loop construction is working
33                                       on. */
34 static int loop_node_cnt = 0;      /* Counts the number of allocated loop nodes.
35                                       Each loop node gets a unique number.
36                                       What for? ev. remove. @@@ */
37 static int current_dfn = 1;        /* Counter to generate depth first numbering
38                                       of visited nodes.  */
39
40 /**********************************************************************/
41 /* Node attributes                                                   **/
42 /**********************************************************************/
43
44 /* A map to get from irnodes to loop nodes. */
45 static pmap *node_loop_map = NULL;
46
47 /**********************************************************************/
48 /* Node attributes needed for the construction.                      **/
49 /**********************************************************************/
50
51 typedef struct scc_info {
52   bool in_stack;         /* Marks whether node is on the stack. */
53   int dfn;               /* Depth first search number. */
54   int uplink;            /* dfn number of ancestor. */
55   //  ir_loop *loop;         /* Refers to the containing loop. */
56   /*
57       struct section *section;
58       xset def;
59       xset use;
60   */
61 } scc_info;
62
63 static INLINE scc_info* new_scc_info(void) {
64   scc_info *info = obstack_alloc (outermost_ir_graph->obst, sizeof (scc_info));
65   memset (info, 0, sizeof (scc_info));
66   return info;
67 }
68
69 static INLINE void
70 mark_irn_in_stack (ir_node *n) {
71   assert(get_irn_link(n));
72   ((scc_info *)get_irn_link(n))->in_stack = true;
73 }
74
75 static INLINE void
76 mark_irn_not_in_stack (ir_node *n) {
77   assert(get_irn_link(n));
78   ((scc_info *)get_irn_link(n))->in_stack = false;
79 }
80
81 static INLINE bool
82 irn_is_in_stack (ir_node *n) {
83   assert(get_irn_link(n));
84   return ((scc_info *)get_irn_link(n))->in_stack;
85 }
86
87 static INLINE void
88 set_irn_uplink (ir_node *n, int uplink) {
89   assert(get_irn_link(n));
90   ((scc_info *)get_irn_link(n))->uplink = uplink;
91 }
92
93 static INLINE int
94 get_irn_uplink (ir_node *n) {
95   assert(get_irn_link(n));
96   return ((scc_info *)get_irn_link(n))->uplink;
97 }
98
99 static INLINE void
100 set_irn_dfn (ir_node *n, int dfn) {
101   if (! get_irn_link(n)) { DDMN(n); DDME(get_irg_ent(current_ir_graph));}
102   assert(get_irn_link(n));
103   ((scc_info *)get_irn_link(n))->dfn = dfn;
104 }
105
106 static INLINE int
107 get_irn_dfn (ir_node *n) {
108   assert(get_irn_link(n));
109   return ((scc_info *)get_irn_link(n))->dfn;
110 }
111
112 /* Uses temporary information to set the loop */
113 static INLINE void
114 set_irn_loop (ir_node *n, ir_loop* loop) {
115   //assert(get_irn_link(n));
116   //((scc_info *)get_irn_link(n))->loop = loop;
117   assert(node_loop_map && "not initialized!");
118   pmap_insert(node_loop_map, (void *)n, (void *)loop);
119 }
120
121 /* Uses temporary information to get the loop */
122 INLINE ir_loop *
123 get_irn_loop (ir_node *n) {
124   ir_loop *res = NULL;
125   //assert(get_irn_link(n));
126   //return ((scc_info *)get_irn_link(n))->loop;
127   assert(node_loop_map && "not initialized!");
128
129   if (pmap_contains(node_loop_map, (void *)n))
130     res = (ir_loop *) pmap_get(node_loop_map, (void *)n);
131
132   return res;
133 }
134
135 #if 0
136 static ir_loop *find_nodes_loop (ir_node *n, ir_loop *l) {
137   int i;
138   ir_loop *res = NULL;
139
140   /* Test whether n is contained in this loop. */
141   for (i = 0; i < get_loop_n_nodes(l); i++)
142     if (n == get_loop_node(l, i)) return l;
143
144   /* Is this a leave in the loop tree? If so loop not found. */
145   if (get_loop_n_sons(l) == 0) return NULL;
146
147   /* Else descend in the loop tree. */
148   for (i = 0; i < get_loop_n_sons(l); i++) {
149     res = find_nodes_loop(n, get_loop_son(l, i));
150     if (res) break;
151   }
152   return res;
153 }
154
155 /* @@@ temporary implementation, costly!!! */
156 ir_loop * get_irn_loop(ir_node *n) {
157   ir_loop *l = get_irg_loop(current_ir_graph);
158   l = find_nodes_loop(n, l);
159   return l;
160 }
161 #endif
162
163 /**********************************************************************/
164 /* A stack.                                                          **/
165 /**********************************************************************/
166
167 static ir_node **stack = NULL;
168 static int tos = 0;                /* top of stack */
169
170 static INLINE void init_stack(void) {
171   if (stack) {
172     ARR_RESIZE (ir_node *, stack, 1000);
173   } else {
174     stack = NEW_ARR_F (ir_node *, 1000);
175   }
176   tos = 0;
177 }
178
179 #if 0
180 static INLINE void free_stack(void) {
181   DEL_ARR_F(stack);
182   stack = NULL;
183   tos = 0;
184 }
185 #endif
186
187 static INLINE void
188 push (ir_node *n)
189 {
190   /*DDMN(n);*/
191
192   if (tos == ARR_LEN (stack)) {
193     int nlen = ARR_LEN (stack) * 2;
194     ARR_RESIZE (ir_node *, stack, nlen);
195   }
196   stack [tos++] = n;
197   mark_irn_in_stack(n);
198 }
199
200 static INLINE ir_node *
201 pop (void)
202 {
203   ir_node *n = stack[--tos];
204   mark_irn_not_in_stack(n);
205   return n;
206 }
207
208 /* The nodes up to n belong to the current loop.
209    Removes them from the stack and adds them to the current loop. */
210 static INLINE void
211 pop_scc_to_loop (ir_node *n)
212 {
213   ir_node *m;
214   int i = 0;
215
216   /*for (;;) {*/
217   do
218     {
219     m = pop();
220     loop_node_cnt++;
221     set_irn_dfn(m, loop_node_cnt);
222     add_loop_node(current_loop, m);
223     set_irn_loop(m, current_loop);
224     i++;
225     /*    if (m==n) break;*/
226     } while(m != n);
227
228   if(i > 1)
229     printf("Mehr als eine Iteration!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n");
230 }
231
232 /* GL ??? my last son is my grandson???  Removes loops with no
233    ir_nodes in them.  Such loops have only another loop as son. (Why
234    can't they have two loops as sons? Does it never get that far? ) */
235 void close_loop (ir_loop *l)
236 {
237   int last = get_loop_n_elements(l) - 1;
238   loop_element lelement = get_loop_element(l, last);
239   ir_loop *last_son = lelement.son;
240
241   if (get_kind(last_son) == k_ir_loop &&
242       get_loop_n_elements(last_son) == 1)
243     {
244       ir_loop *gson;
245
246       lelement = get_loop_element(last_son, 0);
247       gson = lelement.son;
248       if(get_kind(gson) == k_ir_loop)
249         {
250           loop_element new_last_son;
251
252           gson -> outer_loop = l;
253           new_last_son.son = gson;
254           l -> children[last] = new_last_son;
255         }
256     }
257
258   current_loop = l;
259 }
260
261 /* Removes and unmarks all nodes up to n from the stack.
262    The nodes must be visited once more to assign them to a scc. */
263 static INLINE void
264 pop_scc_unmark_visit (ir_node *n)
265 {
266   ir_node *m = NULL;
267
268   while (m != n) {
269     m = pop();
270     set_irn_visited(m, 0);
271   }
272 }
273
274 /**********************************************************************/
275 /* The loop datastructure.                                           **/
276 /**********************************************************************/
277
278 /* Allocates a new loop as son of current_loop.  Sets current_loop
279    to the new loop and returns the father. */
280 static ir_loop *new_loop (void) {
281   ir_loop *father, *son;
282
283   father = current_loop;
284
285   son = (ir_loop *) obstack_alloc (outermost_ir_graph->obst, sizeof (ir_loop));
286   memset (son, 0, sizeof (ir_loop));
287   son->kind = k_ir_loop;
288   son->children = NEW_ARR_F (loop_element, 0);
289   son->n_nodes = 0;
290   son->n_sons=0;
291   if (father) {
292     son->outer_loop = father;
293     add_loop_son(father, son);
294     son->depth = father->depth+1;
295   } else {  /* The root loop */
296     son->outer_loop = son;
297     son->depth = 0;
298   }
299
300 #ifdef DEBUG_libfirm
301   son->loop_nr = get_irp_new_node_nr();
302 #endif
303
304   current_loop = son;
305   return father;
306 }
307
308 #if 0
309 /* Finishes the datastructures, copies the arrays to the obstack
310    of current_ir_graph.
311    A. Schoesser: Caution: loop -> sons is gone. */
312 static void mature_loop (ir_loop *loop) {
313   ir_loop **new_sons;
314
315   new_sons = NEW_ARR_D (ir_loop *, current_ir_graph->obst, ARR_LEN(loop->sons));
316   memcpy (new_sons, loop->sons, sizeof (ir_loop *) * ARR_LEN(loop->sons));
317   DEL_ARR_F(loop->sons);
318   loop->sons = new_sons;
319 }
320 #endif
321
322 /* Returns outer loop, itself if outermost. */
323 ir_loop *get_loop_outer_loop (ir_loop *loop) {
324   assert(loop && loop->kind == k_ir_loop);
325   return loop->outer_loop;
326 }
327
328 /* Returns nesting depth of this loop */
329 int get_loop_depth (ir_loop *loop) {
330   assert(loop); assert(loop->kind == k_ir_loop);
331   return loop->depth;
332 }
333
334 /* Returns the number of inner loops */
335 int      get_loop_n_sons (ir_loop *loop) {
336   assert(loop && loop->kind == k_ir_loop);
337   return(loop -> n_sons);
338 }
339
340 /* Returns the pos`th loop_node-child              *
341  * TODO: This method isn`t very efficient !        *
342  * Returns NULL if there isnt`t a pos`th loop_node */
343 ir_loop *get_loop_son (ir_loop *loop, int pos) {
344   int child_nr = 0, loop_nr = -1;
345
346   assert(loop && loop->kind == k_ir_loop);
347   while(child_nr < ARR_LEN(loop->children))
348    {
349     if(*(loop -> children[child_nr].kind) == k_ir_loop)
350       loop_nr++;
351     if(loop_nr == pos)
352       return(loop -> children[child_nr].son);
353     child_nr++;
354    }
355   return NULL;
356 }
357
358 /* Use EXCLUSIVELY this function to add sons, otherwise the loop->n_sons
359    is invalid! */
360
361 static INLINE void
362 add_loop_son(ir_loop *loop, ir_loop *son) {
363   loop_element lson;
364   lson.son = son;
365   assert(loop && loop->kind == k_ir_loop);
366   assert(get_kind(son) == k_ir_loop);
367   ARR_APP1 (loop_element, loop->children, lson);
368   loop -> n_sons++;
369 }
370
371 /* Returns the number of nodes in the loop */
372 int      get_loop_n_nodes (ir_loop *loop) {
373   assert(loop); assert(loop->kind == k_ir_loop);
374   return loop -> n_nodes;
375 /*  return ARR_LEN(loop->nodes); */
376 }
377
378 /* Returns the pos`th ir_node-child                *
379  * TODO: This method isn`t very efficient !        *
380  * Returns NULL if there isnt`t a pos`th ir_node   */
381 ir_node *get_loop_node (ir_loop *loop, int pos) {
382   int child_nr, node_nr = -1;
383
384   assert(loop && loop->kind == k_ir_loop);
385   assert(pos < get_loop_n_nodes(loop));
386
387   for (child_nr = 0; child_nr < ARR_LEN(loop->children); child_nr++) {
388     if(*(loop -> children[child_nr].kind) == k_ir_node)
389       node_nr++;
390     if(node_nr == pos)
391       return(loop -> children[child_nr].node);
392   }
393   assert(0 && "no child at pos found");
394   return NULL;
395 }
396
397 /* Use EXCLUSIVELY this function to add nodes, otherwise the loop->n_nodes
398    is invalid! */
399
400 static INLINE void
401 add_loop_node(ir_loop *loop, ir_node *n) {
402   loop_element ln;
403   ln.node=n;
404   assert(loop && loop->kind == k_ir_loop);
405   assert(get_kind(n) == k_ir_node);
406   ARR_APP1 (loop_element, loop->children, ln);
407   loop->n_nodes++;
408 }
409
410 /** Returns the number of elements contained in loop.  */
411 int get_loop_n_elements (ir_loop *loop) {
412   assert(loop && loop->kind == k_ir_loop);
413   return(ARR_LEN(loop->children));
414 }
415
416 /*
417  Returns the pos`th loop element.
418  This may be a loop_node or a ir_node. The caller of this function has
419  to check the *(loop_element.kind) field for "k_ir_node" or "k_ir_loop"
420  and then select the apropriate "loop_element.node" or "loop_element.son".
421 */
422
423 loop_element get_loop_element (ir_loop *loop, int pos) {
424   assert(loop && loop->kind == k_ir_loop && pos < ARR_LEN(loop->children));
425
426   return(loop -> children[pos]);
427 }
428
429 int get_loop_element_pos(ir_loop *loop, void *le) {
430   assert(loop && loop->kind == k_ir_loop);
431   int i;
432
433   for (i = 0; i < get_loop_n_elements(loop); i++)
434     if (get_loop_element(loop, i).node == le) return i;
435   return -1;
436 }
437
438 int get_loop_loop_nr(ir_loop *loop) {
439   assert(loop && loop->kind == k_ir_loop);
440 #ifdef DEBUG_libfirm
441   return loop->loop_nr;
442 #else
443   return (int)loop;
444 #endif
445 }
446
447 /* The outermost loop is remarked in the surrounding graph. */
448 void     set_irg_loop(ir_graph *irg, ir_loop *loop) {
449   assert(irg);
450   irg->loop = loop;
451 }
452 ir_loop *get_irg_loop(ir_graph *irg) {
453   assert(irg);
454   return irg->loop;
455 }
456
457
458 /**********************************************************************/
459 /* Constructing and destructing the loop/backedge information.       **/
460 /**********************************************************************/
461
462 /* Initialization steps. **********************************************/
463
464 static INLINE void
465 init_node (ir_node *n, void *env) {
466   set_irn_link (n, new_scc_info());
467   clear_backedges(n);
468 #if 0
469   /* Also init nodes not visible in intraproc_view. */
470     /* @@@ init_node is called for too many nodes -- this wastes memory!.
471        The mem is not lost as its on the obstack. */
472   if (get_irn_op(n) == op_Filter) {
473     for (i = 0; i < get_Filter_n_cg_preds(n); i++)
474       init_node(get_Filter_cg_pred(n, i), NULL);
475   }
476   if (get_irn_op(n) == op_Block) {
477     for (i = 0; i < get_Block_cg_n_cfgpreds(n); i++) {
478       init_node(get_Block_cg_cfgpred(n, i), NULL);
479     }
480   }
481   /* The following pattern matches only after a call from above pattern. */
482   if ((get_irn_op(n) == op_Proj) /*&& (get_Proj_proj(n) == 0)*/) {
483     /* @@@ init_node is called for every proj -- this wastes memory!.
484        The mem is not lost as its on the obstack. */
485     ir_node *cb = get_Proj_pred(n);
486     if ((get_irn_op(cb) == op_CallBegin) ||
487         (get_irn_op(cb) == op_EndReg) ||
488         (get_irn_op(cb) == op_EndExcept)) {
489       init_node(cb, NULL);
490       init_node(get_nodes_Block(cb), NULL);
491     }
492   }
493 #endif
494 }
495
496 static INLINE void
497 init_scc_common (void) {
498   current_dfn = 1;
499   loop_node_cnt = 0;
500   if (!node_loop_map) node_loop_map = pmap_create();
501   init_stack();
502 }
503
504 static INLINE void
505 init_scc (ir_graph *irg) {
506   init_scc_common();
507   irg_walk_graph (irg, init_node, NULL, NULL);
508   /*
509   irg_walk (irg, link_to_reg_end, NULL, NULL);
510   */
511 }
512
513 static INLINE void
514 init_ip_scc (void) {
515   init_scc_common();
516   cg_walk (init_node, NULL, NULL);
517 }
518
519 #if 0
520 Works, but is inefficient.
521 static INLINE void
522 init_ip_scc (void) {
523   int i;
524   interprocedural_view = 1;
525   current_dfn = 1;
526   loop_node_cnt = 0;
527   init_stack();
528   for (i = 0; i < get_irp_n_irgs(); i++) {
529     current_ir_graph = get_irp_irg(i);
530     irg_walk_graph (current_ir_graph, init_node, NULL, NULL);
531     /* @@@ decrease max_visited to avoide double walks */
532   }
533 }
534 #endif
535
536 /* Condition for breaking the recursion. */
537 static bool is_outermost_Start(ir_node *n) {
538   /* Test whether this is the outermost Start node.  If so
539      recursion must end. */
540   if ((get_irn_op(n) == op_Block)     &&
541       (get_Block_n_cfgpreds(n) == 1)  &&
542       (get_irn_op(skip_Proj(get_Block_cfgpred(n, 0))) == op_Start) &&
543       (get_nodes_Block(skip_Proj(get_Block_cfgpred(n, 0))) == n)) {
544     return true;
545   }
546 #if 0
547   /*  @@@ Bad condition:
548       not possible in interprocedural view as outermost_graph is
549       not necessarily the only with a dead-end start block.
550       Besides current_ir_graph is not set properly. */
551   if ((get_irn_op(n) == op_Block) &&
552       (n == get_irg_start_block(current_ir_graph))) {
553     if ((!interprocedural_view)  ||
554         (current_ir_graph == outermost_ir_graph))
555       return true;
556   }
557 #endif
558   return false;
559 }
560
561 /* Don't walk from nodes to blocks except for Control flow operations. */
562 static INLINE int
563 get_start_index(ir_node *n) {
564   if (is_cfop(n) || is_fragile_op(n) || get_irn_op(n) == op_Start)
565     return -1;
566   else
567     return 0;
568 }
569
570 /* Returns current_ir_graph and set it to the irg of predecessor index
571    of node n. */
572 static INLINE ir_graph *
573 switch_irg (ir_node *n, int index) {
574   ir_graph *old_current = current_ir_graph;
575
576   if (interprocedural_view) {
577     /* Only Filter and Block nodes can have predecessors in other graphs. */
578     if (get_irn_op(n) == op_Filter)
579       n = get_nodes_Block(n);
580     if (get_irn_op(n) == op_Block) {
581       ir_node *cfop = skip_Proj(get_Block_cfgpred(n, index));
582       if (is_ip_cfop(cfop)) {
583         current_ir_graph = get_irn_irg(cfop);
584         set_irg_visited(current_ir_graph, get_max_irg_visited());
585       }
586     }
587   }
588
589   return old_current;
590 }
591
592 /* Walks up the stack passing n and then finding the node
593    where we walked into the irg n is contained in.
594    Here we switch the irg. */
595 static ir_graph *
596 find_irg_on_stack (ir_node *n) {
597   ir_node *m;
598   ir_graph *old_current = current_ir_graph;
599   int i;
600
601   if (interprocedural_view) {
602     for (i = tos; i >= 0; i--) {
603       if (stack[i] == n) break;
604     }
605     if (i < 0) i = tos;
606
607     assert (i >= 0);
608     for (; i >= 0; i--) {
609       m = stack[i];
610       /*printf(" Visiting %d ", i); DDMN(m);*/
611       if (is_ip_cfop(m)) {
612         current_ir_graph = get_irn_irg(m);
613         break;
614       }
615       if (get_irn_op(m) == op_Filter) {
616         /* Find the corresponding ip_cfop */
617         ir_node *pred = stack[i+1];
618         int j;
619         for (j = 0; j < get_Filter_n_cg_preds(m); j++)
620           if (get_Filter_cg_pred(m, j) == pred) break;
621         if (j >= get_Filter_n_cg_preds(m))
622           /* It is a filter we didn't pass as the predecessors are marked. */
623           continue;
624         assert(get_Filter_cg_pred(m, j) == pred);
625         switch_irg(m, j);
626         break;
627       }
628     }
629   }
630
631   return old_current;
632 }
633
634 #if 0
635 static void test(ir_node *pred, ir_node *root, ir_node *this) {
636   int i;
637   if (get_irn_uplink(pred) >= get_irn_uplink(root)) return;
638
639   printf("this: %d ", get_irn_uplink(this)); DDMN(this);
640   printf("pred: %d ", get_irn_uplink(pred)); DDMN(pred);
641   printf("root: %d ", get_irn_uplink(root)); DDMN(root);
642
643   printf("tos: %d\n", tos);
644
645   for (i = tos; i >= 0; i--) {
646     ir_node *n = stack[i];
647     if (!n) continue;
648     printf(" uplink: %d, pos: %d ", get_irn_uplink(n), i); DDMN(n);
649   }
650 }
651 #endif
652
653 /* Test for legal loop header: Block, Phi, ... */
654 INLINE static bool is_possible_loop_head(ir_node *n) {
655   return ((get_irn_op(n) == op_Block) ||
656           (get_irn_op(n) == op_Phi) ||
657           ((get_irn_op(n) == op_Filter) && interprocedural_view));
658 }
659
660 /* Returns true if n is a loop header, i.e., it is a Block, Phi
661    or Filter node and has predecessors within the loop and out
662    of the loop.
663    @arg root: only needed for assertion. */
664 static bool
665 is_head (ir_node *n, ir_node *root)
666 {
667   int i;
668   int some_outof_loop = 0, some_in_loop = 0;
669
670   /* Test for legal loop header: Block, Phi, ... */
671   if (!is_possible_loop_head(n))
672     return false;
673
674   if (!is_outermost_Start(n)) {
675     for (i = get_start_index(n); i < get_irn_arity(n); i++) {
676       ir_node *pred = get_irn_n(n, i);
677       assert(pred);
678       if (is_backedge(n, i)) continue;
679       if (!irn_is_in_stack(pred)) {
680         some_outof_loop = 1;
681       } else {
682         assert(get_irn_uplink(pred) >= get_irn_uplink(root));
683         some_in_loop = 1;
684       }
685     }
686   }
687   return some_outof_loop && some_in_loop;
688 }
689
690 /* Returns index of the predecessor with the smallest dfn number
691    greater-equal than limit. */
692 static int
693 smallest_dfn_pred (ir_node *n, int limit)
694 {
695   int i, index = -2, min = -1;
696
697   if (!is_outermost_Start(n)) {
698     for (i = get_start_index(n); i < get_irn_arity(n); i++) {
699       ir_node *pred = get_irn_n(n, i);
700       assert(pred);
701       if (is_backedge(n, i) || !irn_is_in_stack(pred)) continue;
702       if (get_irn_dfn(pred) >= limit && (min == -1 || get_irn_dfn(pred) < min)) {
703         index = i;
704         min = get_irn_dfn(pred);
705       }
706     }
707   }
708   return index;
709 }
710
711 /* Returns index of the predecessor with the largest dfn number. */
712 static int
713 largest_dfn_pred (ir_node *n)
714 {
715   int i, index = -2, max = -1;
716
717   if (!is_outermost_Start(n)) {
718     for (i = get_start_index(n); i < get_irn_arity(n); i++) {
719       ir_node *pred = get_irn_n(n, i);
720       if (is_backedge (n, i) || !irn_is_in_stack(pred)) continue;
721       if (get_irn_dfn(pred) > max) {
722         index = i;
723         max = get_irn_dfn(pred);
724       }
725     }
726   }
727   return index;
728 }
729
730 /* Searches the stack for possible loop heads.  Tests these for backedges.
731    If it finds a head with an unmarked backedge it marks this edge and
732    returns the tail of the loop.
733    If it finds no backedge returns NULL.
734    ("disable_backedge" in fiasco) */
735
736 static ir_node *
737 find_tail (ir_node *n) {
738   ir_node *m;
739   int i, res_index = -2;
740
741   /*
742     if (!icfg && rm_cyclic_phis && remove_cyclic_phis (n)) return NULL;
743   */
744
745   m = stack[tos-1];  /* tos = top of stack */
746   if (is_head (m, n)) {
747     res_index = smallest_dfn_pred(m, 0);
748     if ((res_index == -2) &&  /* no smallest dfn pred found. */
749         (n == m))
750       return NULL;
751   } else {
752     if (m == n) return NULL;
753     for (i = tos-2; ; --i) {
754       m = stack[i];
755       if (is_head (m, n)) {
756         res_index = smallest_dfn_pred (m, get_irn_dfn(m) + 1);
757         if (res_index == -2)  /* no smallest dfn pred found. */
758           res_index = largest_dfn_pred (m);
759         break;
760       }
761     }
762   }
763   assert (res_index > -2);
764
765   set_backedge (m, res_index);
766   return is_outermost_Start(n) ? NULL : get_irn_n(m, res_index);
767 }
768
769
770 /* The core algorithm. *****************************************/
771
772 static void scc (ir_node *n) {
773   int i;
774   ir_graph *rem;
775
776   if (irn_visited(n)) return;
777   mark_irn_visited(n);
778   /*printf("mark: %d ", get_irn_visited(n)); DDMN(n);
779   DDME(get_irg_ent(current_ir_graph));*/
780
781   /* Initialize the node */
782   set_irn_dfn(n, current_dfn);      /* Depth first number for this node */
783   set_irn_uplink(n, current_dfn);   /* ... is default uplink. */
784   set_irn_loop(n, NULL);
785   current_dfn ++;
786
787   /* What's this good for?
788   n->ana.scc.section = NULL;
789   */
790
791   push(n);
792
793   /* AS: get_start_index might return -1 for Control Flow Nodes, and thus a negative
794      array index would be passed to is_backedge(). But CFG Nodes dont't have a backedge array,
795      so is_backedge does not access array[-1] but correctly returns false! */
796
797   if (!is_outermost_Start(n)) {
798     for (i = get_start_index(n); i < get_irn_arity(n); i++) {
799       ir_node *m;
800       if (is_backedge(n, i)) continue;
801
802       m = get_irn_n(n, i); /*get_irn_ip_pred(n, i);*/
803       if ((!m) || (get_irn_op(m) == op_Unknown)) continue;
804       scc (m);
805       /*return_recur(n, i);*/
806
807       if (irn_is_in_stack(m)) {
808         /* Uplink of m is smaller if n->m is a backedge.
809            Propagate the uplink to mark the loop. */
810         if (get_irn_uplink(m) < get_irn_uplink(n))
811           set_irn_uplink(n, get_irn_uplink(m));
812       }
813     }
814   }
815
816   if (get_irn_dfn(n) == get_irn_uplink(n)) {
817     /* This condition holds for the node with the incoming backedge.
818        AS: That is: For the loop head. */
819     ir_node *tail = find_tail(n);
820     if (tail) {
821       /* We found a new inner loop! */
822       ir_loop *l = new_loop();
823
824       /* Remove the loop from the stack ... */
825       pop_scc_unmark_visit (n);
826       /* and recompute it in a better order; and so that it goes into
827          the new loop. */
828       rem = find_irg_on_stack(tail);
829
830       scc (tail);
831       current_ir_graph = rem;
832
833       assert (irn_visited(n));
834       close_loop(l);
835     } else {
836       /* AS: No inner loop was found. Pop all nodes from the stack
837          to the current loop. */
838       pop_scc_to_loop(n);
839     }
840   }
841 }
842
843 /* Constructs backedge information for irg. In interprocedural view constructs
844    backedges for all methods called by irg, too. */
845 void construct_backedges(ir_graph *irg) {
846   ir_graph *rem = current_ir_graph;
847   ir_loop *head_rem;
848   int i;
849
850   assert(!interprocedural_view &&
851          "not implemented, use construct_ip_backedges");
852
853   current_ir_graph = irg;
854   outermost_ir_graph = irg;
855
856   init_scc(irg);
857
858   current_loop = NULL;
859   new_loop();  /* sets current_loop */
860   head_rem = current_loop; /* Just for assertion */
861
862   if (interprocedural_view) {
863     set_irg_visited(irg, inc_max_irg_visited());
864     init_ip_walk ();
865   } else {
866     inc_irg_visited(irg);
867   }
868
869   scc(get_irg_end(irg));
870   for (i = 0; i < get_End_n_keepalives(get_irg_end(irg)); i++)
871     scc(get_End_keepalive(get_irg_end(irg), i));
872
873   if (interprocedural_view) finish_ip_walk();
874
875   assert(head_rem == current_loop);
876   set_irg_loop(irg, current_loop);
877   assert(get_irg_loop(irg)->kind == k_ir_loop);
878   /*
879   irg->loops = current_loop;
880   if (icfg == 1) {
881     int count = 0;
882     int depth = 0;
883     count_loop (the_loop, &count, &depth);
884     }
885   }
886   */
887   current_ir_graph = rem;
888 }
889
890
891
892 void construct_ip_backedges (void) {
893   ir_graph *rem = current_ir_graph;
894   int rem_ipv = interprocedural_view;
895   int i, j;
896
897   outermost_ir_graph = get_irp_main_irg();
898
899   init_ip_scc();
900
901   current_loop = NULL;
902   new_loop();  /* sets current_loop */
903   interprocedural_view = 1;
904
905   inc_max_irg_visited();
906   for (i = 0; i < get_irp_n_irgs(); i++)
907     set_irg_visited(get_irp_irg(i), get_max_irg_visited());
908
909   for (i = 0; i < get_irp_n_irgs(); i++) {
910     ir_node *sb;
911     current_ir_graph = get_irp_irg(i);
912     /*DDME(get_irg_ent(current_ir_graph));*/
913     /* Find real entry points */
914     sb = get_irg_start_block(current_ir_graph);
915     if ((get_Block_n_cfgpreds(sb) > 1) ||
916         (get_nodes_Block(get_Block_cfgpred(sb, 0)) != sb)) continue;
917     /*    printf("running scc for "); DDME(get_irg_ent(current_ir_graph));   */
918     /* Compute scc for this graph */
919     outermost_ir_graph = current_ir_graph;
920     set_irg_visited(outermost_ir_graph, get_max_irg_visited());
921     scc(get_irg_end(current_ir_graph));
922     for (j = 0; j < get_End_n_keepalives(get_irg_end(outermost_ir_graph)); j++)
923       scc(get_End_keepalive(get_irg_end(outermost_ir_graph), j));
924   }
925
926   set_irg_loop(outermost_ir_graph, current_loop);
927   assert(get_irg_loop(outermost_ir_graph)->kind == k_ir_loop);
928
929   current_ir_graph = rem;
930   interprocedural_view = rem_ipv;
931 }
932
933
934 static void reset_backedges(ir_node *n, void *env) {
935   if (is_possible_loop_head(n))
936     clear_backedges(n);
937 }
938
939 /** Removes all loop information.
940     Resets all backedges */
941 void free_loop_information(ir_graph *irg) {
942   set_irg_loop(irg, NULL);
943   /* We cannot free the loop nodes, they are on the obstack. */
944   irg_walk_graph(irg, NULL, reset_backedges, NULL);
945 }
946
947
948 void free_all_loop_information (void) {
949   int i;
950   int rem = interprocedural_view;
951   interprocedural_view = 1;  /* To visit all filter nodes */
952   for (i = 0; i < get_irp_n_irgs(); i++) {
953     free_loop_information(get_irp_irg(i));
954   }
955   pmap_destroy(node_loop_map);
956   node_loop_map = NULL;
957   interprocedural_view = rem;
958 }