2 * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Implementation of interval analysis
33 #include "interval_analysis.h"
34 #include "execution_frequency.h"
35 #include "firm_common_t.h"
46 /*------------------------------------------------------------------*/
47 /* A new in array via a hashmap. */
48 /* The in array refers to the loop the block is contained in if the */
49 /* block is not in blocks loop. */
50 /*------------------------------------------------------------------*/
60 static set *region_attr_set = NULL;
62 int region_attr_cmp(const void *e1, const void *e2, size_t size) {
63 region_attr *ra1 = (region_attr *)e1;
64 region_attr *ra2 = (region_attr *)e2;
65 return (ra1->reg != ra2->reg);
68 static INLINE int attr_set_hash(region_attr *a) {
69 return HASH_PTR(a->reg);
72 static INLINE region_attr *get_region_attr(void *region) {
73 region_attr r_attr, *res;
76 res = set_find(region_attr_set, &r_attr, sizeof(r_attr), attr_set_hash(&r_attr));
79 r_attr.in_array = NEW_ARR_F(void *, 0);
80 if (is_ir_loop(region))
81 r_attr.op_array = NEW_ARR_F(void *, 0);
83 r_attr.op_array = NULL;
85 r_attr.n_exc_outs = 0;
86 res = set_insert(region_attr_set, &r_attr, sizeof(r_attr), attr_set_hash(&r_attr));
92 int get_region_n_ins(void *region) {
93 return ARR_LEN(get_region_attr(region)->in_array);
96 void *get_region_in(void *region, int pos) {
97 assert(0 <= pos && pos < get_region_n_ins(region));
98 return ((get_region_attr(region)->in_array)[pos]);
101 void add_region_in (void *region, void *in) {
102 ARR_APP1(void *, get_region_attr(region)->in_array, in);
103 get_region_attr(in)->n_outs++;
106 int get_region_n_outs(void *region) {
107 return get_region_attr(region)->n_outs;
110 int get_region_n_exc_outs(void *region) {
111 return get_region_attr(region)->n_exc_outs;
114 void inc_region_n_exc_outs(void *region) {
115 (get_region_attr(region)->n_exc_outs)++;
118 void *get_loop_cfop(void *region, int pos) {
119 assert(0 <= pos && pos < get_region_n_ins(region));
120 return ((get_region_attr(region)->op_array)[pos]);
123 void add_loop_cfop (void *region, void *cfop) {
125 ARR_APP1(void *, get_region_attr(region)->op_array, cfop);
128 static INLINE void exc_outs(void *reg, ir_node *cfop) {
129 if (is_fragile_op(cfop) || (is_fragile_Proj(cfop)))
130 inc_region_n_exc_outs(reg);
133 /*------------------------------------------------------------------*/
134 /* Algorithm to construct the interval edges based on a loop tree. */
135 /* Walk a loop and add all edges. Walk inner loops by recursion. */
136 /*------------------------------------------------------------------*/
138 /* return non-zero if outer can be reached from inner via the outer loop relation */
139 static int find_outer_loop(ir_loop *inner, ir_loop *outer, ir_node *b, ir_node *cfop) {
140 if (get_loop_outer_loop(inner) == outer) {
141 add_region_in(inner, b);
142 add_loop_cfop(inner, cfop);
149 static int test_loop_nest(ir_node *pred_b, ir_loop *nest) {
150 int i, n_elems = get_loop_n_elements(nest);
152 for (i = 0; (i < n_elems); ++i) {
153 loop_element e = get_loop_element(nest, i);
156 if (e.node == pred_b) return 1;
159 if (test_loop_nest(pred_b, e.son)) return 1;
167 static int find_inner_loop(ir_node *b, ir_loop *l, ir_node *pred, ir_node *cfop) {
168 int i, n_elems = get_loop_n_elements(l);
171 for (i = 0; (i < n_elems) && !found; ++i) {
172 loop_element e = get_loop_element(l, i);
175 if (e.node == b) return 0;
178 found = test_loop_nest(pred, e.son);
180 add_region_in(b, e.son);
181 exc_outs(e.son, cfop);
182 //if (is_fragile_op(cfop)) inc_region_n_exc_outs(b);
193 static int find_previous_loop(ir_loop *l, ir_loop *pred_l, ir_node *b, ir_node *pred_b, ir_node *cfop) {
194 ir_loop *outer = get_loop_outer_loop(l);
196 int l_pos = get_loop_element_pos(outer, l);
198 assert(l_pos > 0 && "Is this a necessary condition? There could be a perfect nest ...");
200 for (i = l_pos -1, found = 0; i > -1 && !found; --i) {
201 ir_loop *k = get_loop_element(outer, i).son;
203 found = test_loop_nest(pred_b, k);
206 //if (is_fragile_op(cfop)) inc_region_n_exc_outs(k);
208 add_loop_cfop(l, cfop);
209 add_region_in(b, NULL);
215 DDMG(current_ir_graph);
227 * Compute the edges for the interval graph.
229 * @param b The block for which to construct the edges.
230 * @param l The loop of b.
232 * There are four cases:
233 * - The pred block is in the same loop. Add a normal block-block edge.
234 * - The pred block is in a loop contained in this loop, somewhere down in
235 * the nesting. The predecessor of this block is the outermost loop of the nest
236 * directly contained in l.
237 * - The pred block is in the outer loop of l. l gets an edge to the pred block.
238 * - The outer loop of l contains another loop k just before l. The control flow
239 * branches directly from loop k to loop l. Add an edge l->k. Watch it: k must
240 * not be a direct predecessor of l in the loop tree!
242 static void construct_interval_block(ir_node *b, ir_loop *l) {
243 int i, n_cfgpreds = get_Block_n_cfgpreds(b);
245 if (b == get_irg_start_block(current_ir_graph)) return;
246 /* We want nice blocks. */
247 assert(n_cfgpreds > 0);
249 for (i = 0; i < n_cfgpreds; ++i) {
250 ir_node *cfop, *pred;
253 if (is_backedge(b, i)) {
254 if (b != get_loop_element(l, 0).node) {
255 if (get_firm_verbosity()) {
256 printf("Loophead not at loop position 0. "); DDMN(b);
259 /* There are no backedges in the interval decomposition. */
260 add_region_in(b, NULL);
264 cfop = get_Block_cfgpred(b, i);
266 if (get_irn_op(get_Proj_pred(cfop)) != op_Cond) {
267 cfop = skip_Proj(cfop);
269 assert(get_nodes_block(cfop) == get_nodes_block(skip_Proj(cfop)));
273 pred = skip_Proj(get_nodes_block(cfop));
274 /* We want nice blocks. */
275 assert( get_irn_op(pred) != op_Bad
276 && get_irn_op(skip_Proj(get_Block_cfgpred(b, i))) != op_Bad);
277 pred_l = get_irn_loop(pred);
279 add_region_in(b, pred);
280 //if (is_fragile_op(cfop)) inc_region_n_exc_outs(b);
281 exc_outs(pred, cfop);
283 int found = find_inner_loop(b, l, pred, cfop);
285 if (b != get_loop_element(l, 0).node) {
286 if (get_firm_verbosity()) {
287 printf("Loop entry not at loop position 0. "); DDMN(b);
290 found = find_outer_loop(l, pred_l, pred, cfop);
291 if (found) add_region_in(b, NULL); /* placeholder */
294 found = find_previous_loop(l, pred_l, b, pred, cfop);
297 DDMG(current_ir_graph);
300 assert(is_backedge(b, i));
301 assert(found && "backedge from inner loop");
305 if (b != get_loop_element(l, 0).node) {
306 /* Check for improper region */
307 if (has_backedges(b)) {
308 printf("Improper Region!!!!!!\n");
309 DDMG(current_ir_graph);
317 static void construct_interval_edges(ir_loop *l) {
318 int i, n_elems = get_loop_n_elements(l);
319 for (i = 0; i < n_elems; ++i) {
320 loop_element e = get_loop_element(l, i);
323 construct_interval_block(e.node, l);
326 construct_interval_edges(e.son);
333 void construct_intervals(ir_graph *irg) {
335 ir_graph *rem = current_ir_graph;
336 current_ir_graph = irg;
338 if (!region_attr_set)
339 region_attr_set = new_set(region_attr_cmp, 256);
341 construct_cf_backedges(current_ir_graph);
343 l = get_irg_loop(current_ir_graph);
345 construct_interval_edges(l);
347 current_ir_graph = rem;
350 void free_intervals(void) {
352 if (!region_attr_set) return;
354 for (ins = (void **)pmap_first(region_in_map);
356 ins = (void **)pmap_next(region_in_map)) {
360 del_set(region_attr_set);
361 region_attr_set = NULL;
364 /*------------------------------------------------------------------*/
365 /* A vcg dumper showing an interval decomposition of a cfg. */
367 /*------------------------------------------------------------------*/
369 void dump_region_edges(FILE *F, void *reg) {
370 int i, n_ins = get_region_n_ins(reg);
372 if (is_ir_node(reg) && get_Block_n_cfgpreds((ir_node *)reg) > get_region_n_ins(reg)) {
373 for (i = n_ins; i < get_Block_n_cfgpreds((ir_node *)reg); ++i) {
374 if (is_backedge((ir_node *)reg, i))
375 fprintf (F, "backedge: { sourcename: \"");
377 fprintf (F, "edge: { sourcename: \"");
378 PRINT_NODEID(((ir_node *)reg));
379 fprintf (F, "\" targetname: \"");
380 PRINT_NODEID(get_nodes_block(skip_Proj(get_Block_cfgpred((ir_node *)reg, i))));
381 fprintf (F, "\" " BLOCK_EDGE_ATTR "}\n");
385 for (i = 0; i < n_ins; ++i) {
386 void *target = get_region_in(reg, i);
388 if (is_ir_node(reg)) {
389 if (get_Block_n_cfgpreds((ir_node *)reg) != get_region_n_ins(reg)) {
390 printf("n_cfgpreds = %d, n_ins = %d\n", get_Block_n_cfgpreds((ir_node *)reg), get_region_n_ins(reg));
391 DDMN((ir_node *)reg);
395 if ((!target || (is_ir_node(reg) && !is_ir_node(target))) && i < get_Block_n_cfgpreds((ir_node *)reg)) {
396 assert(is_ir_node(reg));
397 if (is_backedge((ir_node *)reg, i))
398 fprintf (F, "backedge: { sourcename: \"");
400 fprintf (F, "edge: { sourcename: \"");
401 PRINT_NODEID(((ir_node *)reg));
402 fprintf (F, "\" targetname: \"");
403 PRINT_NODEID(get_nodes_block(skip_Proj(get_Block_cfgpred((ir_node *)reg, i))));
404 fprintf (F, "\" " BLOCK_EDGE_ATTR "}\n");
406 if (!target) continue;
409 fprintf (F, "edge: { sourcename: \"");
410 if (is_ir_node(reg)) {
411 PRINT_NODEID(((ir_node *)reg));
413 PRINT_LOOPID(((ir_loop *)reg));
415 fprintf (F, "\" targetname: \"");
416 if (is_ir_node(target)) {
417 PRINT_NODEID(((ir_node *)target));
419 PRINT_LOOPID(((ir_loop *)target));
422 if (is_ir_node(reg) && is_fragile_op(skip_Proj(get_Block_cfgpred(reg, i))))
423 fprintf(F, EXC_CF_EDGE_ATTR);
428 #include "execution_frequency.h"
430 void dump_interval_block(FILE *F, ir_node *block) {
432 /* This is a block. Dump a node for the block. */
433 fprintf (F, "node: {title: \""); PRINT_NODEID(block);
434 fprintf (F, "\" label: \"");
435 if (block == get_irg_start_block(get_irn_irg(block)))
436 fprintf(F, "Start ");
437 if (block == get_irg_end_block(get_irn_irg(block)))
440 fprintf (F, "%s ", get_op_name(get_irn_op(block)));
442 fprintf(F, " freq: %9.4lf", get_region_exec_freq(block));
443 fprintf(F, " n_outs: %d", get_region_n_outs(block));
444 fprintf(F, " n_exc_outs: %d", get_region_n_exc_outs(block));
446 fprintf(F, "info1:\"");
447 if (dump_dominator_information_flag)
448 fprintf(F, "dom depth %d\n", get_Block_dom_depth(block));
450 /* show arity and possible Bad predecessors of the block */
451 fprintf(F, "arity: %d\n", get_Block_n_cfgpreds(block));
452 for (fl = i = 0; i < get_Block_n_cfgpreds(block); ++i) {
453 ir_node *pred = get_Block_cfgpred(block, i);
456 fprintf(F, "Bad pred at pos: ");
457 fprintf(F, "%d ", i);
464 fprintf (F, "\""); /* closing quote of info */
466 if ((block == get_irg_start_block(get_irn_irg(block))) ||
467 (block == get_irg_end_block(get_irn_irg(block))) )
468 fprintf(F, " color:blue ");
470 fprintf(F, " color:yellow ");
475 void dump_interval_loop(FILE *F, ir_loop *l) {
476 int i, n_elems = get_loop_n_elements(l);
478 fprintf(F, "graph: { title: \"");
480 fprintf(F, "\" label: \"loop %d", get_loop_loop_nr(l));
481 fprintf(F, " freq: %9.4lf", get_region_exec_freq(l));
482 fprintf(F, " n_outs: %d", get_region_n_outs(l));
483 fprintf(F, " n_exc_outs: %d", get_region_n_exc_outs(l));
484 fprintf(F, "\" status:clustered color:white \n");
486 for (i = 0; i < n_elems; ++i) {
487 loop_element e = get_loop_element(l, i);
488 dump_region_edges(F, e.node);
491 dump_interval_block(F, e.node);
494 dump_interval_loop(F, e.son);
504 void dump_interval_graph(ir_graph *irg, const char *suffix) {
507 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
510 f = vcg_open(irg, suffix, "-intervals");
511 dump_vcg_header(f, get_irg_dump_name(irg), NULL);
513 current_ir_graph = irg;
515 dump_interval_loop(f, get_irg_loop(current_ir_graph));