Updated header
[libfirm] / ir / ana / height.c
1 /*
2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief    Compute heights of nodes inside basic blocks
23  * @author   Sebastian Hack
24  * @date     19.04.2006
25  * @version  $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <stdlib.h>
32 #include <stdio.h>
33
34 #include "list.h"
35
36 #include "irdump.h"
37 #include "irgwalk.h"
38 #include "irtools.h"
39 #include "irphase_t.h"
40 #include "iredges_t.h"
41
42 typedef struct _heights_t heights_t;
43
44 struct _heights_t {
45         ir_phase ph;
46         unsigned visited;
47         void *dump_handle;
48 };
49
50 typedef struct {
51         unsigned height;
52         unsigned visited;
53 } irn_height_t;
54
55 static void *irn_height_init(ir_phase *ph, ir_node *irn, void *data)
56 {
57         irn_height_t *h = data ? data : phase_alloc(ph, sizeof(h[0]));
58         memset(h, 0, sizeof(h[0]));
59         return h;
60 }
61
62 static void height_dump_cb(void *data, FILE *f, const ir_node *irn)
63 {
64         heights_t *heights = data;
65         irn_height_t *h    = phase_get_irn_data(&heights->ph, irn);
66
67         if(h)
68                 fprintf(f, "height: %u\n", h->height);
69 }
70
71 /**
72  * Check, if we can reach a target node from a given node inside one basic block.
73  * @param h    The heights object.
74  * @param curr The current node from which we tried to reach the other one.
75  * @param tgt  The node we try to reach.
76  * @return     1, one of tgt can be reached from curr, 0 else.
77  */
78 static int search(heights_t *h, const ir_node *curr, const ir_node *tgt)
79 {
80         irn_height_t *h_curr;
81         irn_height_t *h_tgt;
82         int i, n;
83
84         /* if the current node is the one we were looking for, we're done. */
85         if(curr == tgt)
86                 return 1;
87
88         /* If we are in another block we won't find our target. */
89         if(get_nodes_block(curr) != get_nodes_block(tgt))
90                 return 0;
91
92         /* Check, if we have already been here. Coming more often won't help :-) */
93         h_curr = phase_get_irn_data(&h->ph, curr);
94         if(h_curr->visited >= h->visited)
95                 return 0;
96
97         /* If we are too deep into the DAG we won't find the target either. */
98         h_tgt = phase_get_irn_data(&h->ph, tgt);
99         if(h_curr->height > h_tgt->height)
100                 return 0;
101
102         /* Mark this place as visited. */
103         h_curr->visited = h->visited;
104
105         /* Start a search from this node. */
106         for(i = 0, n = get_irn_ins_or_deps(curr); i < n; ++i) {
107                 ir_node *op = get_irn_in_or_dep(curr, i);
108                 if(search(h, op, tgt))
109                         return 1;
110         }
111
112         return 0;
113 }
114
115 /**
116  * Check, if one node can be reached from another one, according to data dependence.
117  */
118 int heights_reachable_in_block(heights_t *h, const ir_node *n, const ir_node *m)
119 {
120         int res          = 0;
121         irn_height_t *hn = phase_get_irn_data(&h->ph, n);
122         irn_height_t *hm = phase_get_irn_data(&h->ph, m);
123
124         assert(get_nodes_block(n) == get_nodes_block(m));
125         assert(hn != NULL && hm != NULL);
126
127         if(hn->height <= hm->height) {
128                 h->visited++;
129                 res = search(h, n, m);
130         }
131
132         return res;
133 }
134
135 /**
136  * Compute the height of a node in a block.
137  * @param h   The heights object.
138  * @param irn The node.
139  * @param bl  The block.
140  */
141 static unsigned compute_height(heights_t *h, ir_node *irn, const ir_node *bl)
142 {
143         irn_height_t *ih = phase_get_or_set_irn_data(&h->ph, irn);
144
145         const ir_edge_t *edge;
146
147         /* bail out if we already visited that node. */
148         if(ih->visited >= h->visited)
149                 return ih->height;
150
151         ih->visited = h->visited;
152         ih->height  = 0;
153
154         foreach_out_edge(irn, edge) {
155                 ir_node *dep = get_edge_src_irn(edge);
156
157                 if(!is_Block(dep) && get_nodes_block(dep) == bl) {
158                         unsigned dep_height = compute_height(h, dep, bl);
159                         ih->height          = MAX(ih->height, dep_height);
160                 }
161
162                 ih->height++;
163         }
164
165         foreach_out_edge_kind(irn, edge, EDGE_KIND_DEP) {
166                 ir_node *dep = get_edge_src_irn(edge);
167
168                 if(!is_Block(dep) && get_nodes_block(dep) == bl) {
169                         unsigned dep_height = compute_height(h, dep, bl);
170                         ih->height          = MAX(ih->height, dep_height);
171                 }
172
173                 ih->height++;
174         }
175
176         return ih->height;
177 }
178
179 static unsigned compute_heights_in_block(ir_node *bl, heights_t *h)
180 {
181         int             max_height = -1;
182         const ir_edge_t *edge;
183
184         h->visited++;
185
186         foreach_out_edge(bl, edge) {
187                 ir_node *dep = get_edge_src_irn(edge);
188                 int     curh = compute_height(h, dep, bl);
189
190                 max_height = MAX(curh, max_height);
191         }
192
193         foreach_out_edge_kind(bl, edge, EDGE_KIND_DEP) {
194                 ir_node *dep = get_edge_src_irn(edge);
195                 int     curh = compute_height(h, dep, bl);
196
197                 max_height = MAX(curh, max_height);
198         }
199
200         return max_height;
201 }
202
203 static void compute_heights_in_block_walker(ir_node *block, void *data)
204 {
205         heights_t *h = data;
206         compute_heights_in_block(block, h);
207 }
208
209 unsigned get_irn_height(heights_t *heights, const ir_node *irn)
210 {
211         irn_height_t *h = phase_get_irn_data(&heights->ph, irn);
212         assert(h && "No height information for node");
213         return h->height;
214 }
215
216 unsigned heights_recompute_block(heights_t *h, ir_node *block)
217 {
218         const ir_edge_t *edge;
219
220         edges_assure(phase_get_irg(&h->ph));
221
222         /* reset phase data for all nodes in the block */
223         foreach_out_edge(block, edge) {
224                 ir_node      *irn = get_edge_src_irn(edge);
225                 irn_height_t *ih  = phase_get_irn_data(&h->ph, irn);
226
227                 irn_height_init(&h->ph, irn, ih);
228         }
229
230         h->visited = 0;
231         return compute_heights_in_block(block, h);
232 }
233
234 void heights_recompute(heights_t *h)
235 {
236         edges_assure(phase_get_irg(&h->ph));
237         phase_reinit_irn_data(&h->ph);
238         h->visited = 0;
239         irg_block_walk_graph(phase_get_irg(&h->ph), compute_heights_in_block_walker, NULL, h);
240 }
241
242 heights_t *heights_new(ir_graph *irg)
243 {
244         heights_t *res = xmalloc(sizeof(res[0]));
245         phase_init(&res->ph, "heights", irg, PHASE_DEFAULT_GROWTH, irn_height_init, NULL);
246         res->dump_handle = dump_add_node_info_callback(height_dump_cb, res);
247         heights_recompute(res);
248
249         return res;
250 }
251
252 void heights_free(heights_t *h)
253 {
254         phase_free(&h->ph);
255         dump_remv_node_info_callback(h->dump_handle);
256         xfree(h);
257 }