2 * Copyright (C) 1995-2008 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
34 #include "interval_analysis.h"
35 #include "execution_frequency.h"
36 #include "firm_common_t.h"
48 DEBUG_ONLY(static firm_dbg_module_t *dbg);
50 /*------------------------------------------------------------------*/
51 /* A new in array via a hashmap. */
52 /* The in array refers to the loop the block is contained in if the */
53 /* block is not in blocks loop. */
54 /*------------------------------------------------------------------*/
64 static set *region_attr_set = NULL;
66 int region_attr_cmp(const void *e1, const void *e2, size_t size) {
67 region_attr *ra1 = (region_attr *)e1;
68 region_attr *ra2 = (region_attr *)e2;
70 return (ra1->reg != ra2->reg);
73 static INLINE int attr_set_hash(region_attr *a) {
74 return HASH_PTR(a->reg);
77 static INLINE region_attr *get_region_attr(void *region) {
78 region_attr r_attr, *res;
81 res = set_find(region_attr_set, &r_attr, sizeof(r_attr), attr_set_hash(&r_attr));
84 r_attr.in_array = NEW_ARR_F(void *, 0);
85 if (is_ir_loop(region))
86 r_attr.op_array = NEW_ARR_F(void *, 0);
88 r_attr.op_array = NULL;
90 r_attr.n_exc_outs = 0;
91 res = set_insert(region_attr_set, &r_attr, sizeof(r_attr), attr_set_hash(&r_attr));
97 int get_region_n_ins(void *region) {
98 return ARR_LEN(get_region_attr(region)->in_array);
101 void *get_region_in(void *region, int pos) {
102 assert(0 <= pos && pos < get_region_n_ins(region));
103 return ((get_region_attr(region)->in_array)[pos]);
106 void add_region_in (void *region, void *in) {
107 ARR_APP1(void *, get_region_attr(region)->in_array, in);
108 get_region_attr(in)->n_outs++;
111 int get_region_n_outs(void *region) {
112 return get_region_attr(region)->n_outs;
115 int get_region_n_exc_outs(void *region) {
116 return get_region_attr(region)->n_exc_outs;
119 void inc_region_n_exc_outs(void *region) {
120 (get_region_attr(region)->n_exc_outs)++;
123 void *get_loop_cfop(void *region, int pos) {
124 assert(0 <= pos && pos < get_region_n_ins(region));
125 return ((get_region_attr(region)->op_array)[pos]);
128 void add_loop_cfop (void *region, void *cfop) {
130 ARR_APP1(void *, get_region_attr(region)->op_array, cfop);
133 static INLINE void exc_outs(void *reg, ir_node *cfop) {
134 if (is_fragile_op(cfop) || (is_fragile_Proj(cfop)))
135 inc_region_n_exc_outs(reg);
138 /*------------------------------------------------------------------*/
139 /* Algorithm to construct the interval edges based on a loop tree. */
140 /* Walk a loop and add all edges. Walk inner loops by recursion. */
141 /*------------------------------------------------------------------*/
143 /* return non-zero if outer can be reached from inner via the outer loop relation */
144 static int find_outer_loop(ir_loop *inner, ir_loop *outer, ir_node *b, ir_node *cfop) {
145 if (get_loop_outer_loop(inner) == outer) {
146 add_region_in(inner, b);
147 add_loop_cfop(inner, cfop);
154 static int test_loop_nest(ir_node *pred_b, ir_loop *nest) {
155 int i, n_elems = get_loop_n_elements(nest);
157 for (i = 0; (i < n_elems); ++i) {
158 loop_element e = get_loop_element(nest, i);
161 if (e.node == pred_b) return 1;
164 if (test_loop_nest(pred_b, e.son)) return 1;
172 static int find_inner_loop(ir_node *b, ir_loop *l, ir_node *pred, ir_node *cfop) {
173 int i, n_elems = get_loop_n_elements(l);
176 for (i = 0; (i < n_elems) && !found; ++i) {
177 loop_element e = get_loop_element(l, i);
180 if (e.node == b) return 0;
183 found = test_loop_nest(pred, e.son);
185 add_region_in(b, e.son);
186 exc_outs(e.son, cfop);
187 //if (is_fragile_op(cfop)) inc_region_n_exc_outs(b);
198 static int find_previous_loop(ir_loop *l, ir_loop *pred_l, ir_node *b,
199 ir_node *pred_b, ir_node *cfop)
201 ir_loop *outer = get_loop_outer_loop(l);
203 int l_pos = get_loop_element_pos(outer, l);
206 assert(l_pos > 0 && "Is this a necessary condition? There could be a perfect nest ...");
208 for (i = l_pos -1, found = 0; i > -1 && !found; --i) {
209 ir_loop *k = get_loop_element(outer, i).son;
211 found = test_loop_nest(pred_b, k);
214 //if (is_fragile_op(cfop)) inc_region_n_exc_outs(k);
216 add_loop_cfop(l, cfop);
217 add_region_in(b, NULL);
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 DB((dbg, LEVEL_1, "Loophead not at loop position 0. %+F\n", b));
257 /* There are no backedges in the interval decomposition. */
258 add_region_in(b, NULL);
262 cfop = get_Block_cfgpred(b, i);
264 if (!is_Cond(get_Proj_pred(cfop))) {
265 cfop = skip_Proj(cfop);
267 assert(get_nodes_block(cfop) == get_nodes_block(skip_Proj(cfop)));
271 pred = skip_Proj(get_nodes_block(cfop));
272 /* We want nice blocks. */
273 assert(!is_Bad(pred) && !is_Bad(skip_Proj(get_Block_cfgpred(b, i))));
274 pred_l = get_irn_loop(pred);
276 add_region_in(b, pred);
277 //if (is_fragile_op(cfop)) inc_region_n_exc_outs(b);
278 exc_outs(pred, cfop);
280 int found = find_inner_loop(b, l, pred, cfop);
282 if (b != get_loop_element(l, 0).node) {
283 DB((dbg, LEVEL_1, "Loop entry not at loop position 0. %+F\n", b));
285 found = find_outer_loop(l, pred_l, pred, cfop);
286 if (found) add_region_in(b, NULL); /* placeholder */
289 found = find_previous_loop(l, pred_l, b, pred, cfop);
292 assert(is_backedge(b, i));
293 assert(found && "backedge from inner loop");
297 if (b != get_loop_element(l, 0).node) {
298 /* Check for improper region */
299 if (has_backedges(b)) {
300 ir_fprintf(stderr, "Improper Region!!!!!! %+F\n", b);
306 static void construct_interval_edges(ir_loop *l) {
307 int i, n_elems = get_loop_n_elements(l);
308 for (i = 0; i < n_elems; ++i) {
309 loop_element e = get_loop_element(l, i);
312 construct_interval_block(e.node, l);
315 construct_interval_edges(e.son);
322 void construct_intervals(ir_graph *irg) {
324 ir_graph *rem = current_ir_graph;
325 current_ir_graph = irg;
327 FIRM_DBG_REGISTER(dbg, "firm.ana.interval");
329 if (!region_attr_set)
330 region_attr_set = new_set(region_attr_cmp, 256);
332 construct_cf_backedges(current_ir_graph);
334 l = get_irg_loop(current_ir_graph);
336 construct_interval_edges(l);
338 current_ir_graph = rem;
341 void free_intervals(void) {
343 if (!region_attr_set) return;
345 for (ins = (void **)pmap_first(region_in_map);
347 ins = (void **)pmap_next(region_in_map)) {
351 del_set(region_attr_set);
352 region_attr_set = NULL;
355 /*------------------------------------------------------------------*/
356 /* A vcg dumper showing an interval decomposition of a cfg. */
358 /*------------------------------------------------------------------*/
360 void dump_region_edges(FILE *F, void *reg) {
361 int i, n_ins = get_region_n_ins(reg);
363 if (is_ir_node(reg) && get_Block_n_cfgpreds((ir_node *)reg) > get_region_n_ins(reg)) {
364 for (i = n_ins; i < get_Block_n_cfgpreds((ir_node *)reg); ++i) {
365 if (is_backedge((ir_node *)reg, i))
366 fprintf (F, "backedge: { sourcename: \"");
368 fprintf (F, "edge: { sourcename: \"");
369 PRINT_NODEID(((ir_node *)reg));
370 fprintf (F, "\" targetname: \"");
371 PRINT_NODEID(get_nodes_block(skip_Proj(get_Block_cfgpred((ir_node *)reg, i))));
372 fprintf (F, "\" " BLOCK_EDGE_ATTR "}\n");
376 for (i = 0; i < n_ins; ++i) {
377 void *target = get_region_in(reg, i);
379 if (is_ir_node(reg)) {
380 if (get_Block_n_cfgpreds((ir_node *)reg) != get_region_n_ins(reg)) {
381 ir_printf("n_cfgpreds = %d, n_ins = %d\n %+F\n", get_Block_n_cfgpreds((ir_node *)reg), get_region_n_ins(reg), (ir_node*) reg);
385 if ((!target || (is_ir_node(reg) && !is_ir_node(target))) && i < get_Block_n_cfgpreds((ir_node *)reg)) {
386 assert(is_ir_node(reg));
387 if (is_backedge((ir_node *)reg, i))
388 fprintf (F, "backedge: { sourcename: \"");
390 fprintf (F, "edge: { sourcename: \"");
391 PRINT_NODEID(((ir_node *)reg));
392 fprintf (F, "\" targetname: \"");
393 PRINT_NODEID(get_nodes_block(skip_Proj(get_Block_cfgpred((ir_node *)reg, i))));
394 fprintf (F, "\" " BLOCK_EDGE_ATTR "}\n");
396 if (!target) continue;
399 fprintf (F, "edge: { sourcename: \"");
400 if (is_ir_node(reg)) {
401 PRINT_NODEID(((ir_node *)reg));
403 PRINT_LOOPID(((ir_loop *)reg));
405 fprintf (F, "\" targetname: \"");
406 if (is_ir_node(target)) {
407 PRINT_NODEID(((ir_node *)target));
409 PRINT_LOOPID(((ir_loop *)target));
412 if (is_ir_node(reg) && is_fragile_op(skip_Proj(get_Block_cfgpred(reg, i))))
413 fprintf(F, EXC_CF_EDGE_ATTR);
418 #include "execution_frequency.h"
420 void dump_interval_block(FILE *F, ir_node *block) {
422 /* This is a block. Dump a node for the block. */
423 fprintf (F, "node: {title: \""); PRINT_NODEID(block);
424 fprintf (F, "\" label: \"");
425 if (block == get_irg_start_block(get_irn_irg(block)))
426 fprintf(F, "Start ");
427 if (block == get_irg_end_block(get_irn_irg(block)))
430 fprintf (F, "%s ", get_op_name(get_irn_op(block)));
432 fprintf(F, " freq: %9.4lf", get_region_exec_freq(block));
433 fprintf(F, " n_outs: %d", get_region_n_outs(block));
434 fprintf(F, " n_exc_outs: %d", get_region_n_exc_outs(block));
436 fprintf(F, "info1:\"");
437 if (dump_dominator_information_flag)
438 fprintf(F, "dom depth %d\n", get_Block_dom_depth(block));
440 /* show arity and possible Bad predecessors of the block */
441 fprintf(F, "arity: %d\n", get_Block_n_cfgpreds(block));
442 for (fl = i = 0; i < get_Block_n_cfgpreds(block); ++i) {
443 ir_node *pred = get_Block_cfgpred(block, i);
446 fprintf(F, "Bad pred at pos: ");
447 fprintf(F, "%d ", i);
454 fprintf (F, "\""); /* closing quote of info */
456 if ((block == get_irg_start_block(get_irn_irg(block))) ||
457 (block == get_irg_end_block(get_irn_irg(block))) )
458 fprintf(F, " color:blue ");
460 fprintf(F, " color:yellow ");
465 void dump_interval_loop(FILE *F, ir_loop *l) {
466 int i, n_elems = get_loop_n_elements(l);
468 fprintf(F, "graph: { title: \"");
470 fprintf(F, "\" label: \"loop %d", get_loop_loop_nr(l));
471 fprintf(F, " freq: %9.4lf", get_region_exec_freq(l));
472 fprintf(F, " n_outs: %d", get_region_n_outs(l));
473 fprintf(F, " n_exc_outs: %d", get_region_n_exc_outs(l));
474 fprintf(F, "\" status:clustered color:white \n");
476 for (i = 0; i < n_elems; ++i) {
477 loop_element e = get_loop_element(l, i);
478 dump_region_edges(F, e.node);
481 dump_interval_block(F, e.node);
484 dump_interval_loop(F, e.son);
494 void dump_interval_graph(ir_graph *irg, const char *suffix) {
497 if (!is_filtered_dump_name(get_entity_ident(get_irg_entity(irg))))
500 f = vcg_open(irg, suffix, "-intervals");
501 dump_vcg_header(f, get_irg_dump_name(irg), NULL, NULL);
503 current_ir_graph = irg;
505 dump_interval_loop(f, get_irg_loop(current_ir_graph));