Slimified the bitset implementation a little bit
[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 or at a phi we won't find our target. */
89         if(get_nodes_block(curr) != get_nodes_block(tgt))
90                 return 0;
91         if(is_Phi(curr))
92                 return 0;
93
94         /* Check, if we have already been here. Coming more often won't help :-) */
95         h_curr = phase_get_irn_data(&h->ph, curr);
96         if(h_curr->visited >= h->visited)
97                 return 0;
98
99         /* If we are too deep into the DAG we won't find the target either. */
100         h_tgt = phase_get_irn_data(&h->ph, tgt);
101         if(h_curr->height > h_tgt->height)
102                 return 0;
103
104         /* Mark this place as visited. */
105         h_curr->visited = h->visited;
106
107         /* Start a search from this node. */
108         for(i = 0, n = get_irn_ins_or_deps(curr); i < n; ++i) {
109                 ir_node *op = get_irn_in_or_dep(curr, i);
110                 if(search(h, op, tgt))
111                         return 1;
112         }
113
114         return 0;
115 }
116
117 /**
118  * Check, if one node can be reached from another one, according to data dependence.
119  */
120 int heights_reachable_in_block(heights_t *h, const ir_node *n, const ir_node *m)
121 {
122         int res          = 0;
123         irn_height_t *hn = phase_get_irn_data(&h->ph, n);
124         irn_height_t *hm = phase_get_irn_data(&h->ph, m);
125
126         assert(get_nodes_block(n) == get_nodes_block(m));
127         assert(hn != NULL && hm != NULL);
128
129         if(hn->height <= hm->height) {
130                 h->visited++;
131                 res = search(h, n, m);
132         }
133
134         return res;
135 }
136
137 /**
138  * Compute the height of a node in a block.
139  * @param h   The heights object.
140  * @param irn The node.
141  * @param bl  The block.
142  */
143 static unsigned compute_height(heights_t *h, ir_node *irn, const ir_node *bl)
144 {
145         irn_height_t *ih = phase_get_or_set_irn_data(&h->ph, irn);
146
147         const ir_edge_t *edge;
148
149         /* bail out if we already visited that node. */
150         if(ih->visited >= h->visited)
151                 return ih->height;
152
153         ih->visited = h->visited;
154         ih->height  = 0;
155
156         foreach_out_edge(irn, edge) {
157                 ir_node *dep = get_edge_src_irn(edge);
158
159                 if(!is_Block(dep) && !is_Phi(dep) && get_nodes_block(dep) == bl) {
160                         unsigned dep_height = compute_height(h, dep, bl);
161                         ih->height          = MAX(ih->height, dep_height);
162                 }
163
164                 ih->height++;
165         }
166
167         foreach_out_edge_kind(irn, edge, EDGE_KIND_DEP) {
168                 ir_node *dep = get_edge_src_irn(edge);
169
170                 assert(!is_Phi(dep));
171                 if(!is_Block(dep) && get_nodes_block(dep) == bl) {
172                         unsigned dep_height = compute_height(h, dep, bl);
173                         ih->height          = MAX(ih->height, dep_height);
174                 }
175
176                 ih->height++;
177         }
178
179         return ih->height;
180 }
181
182 static unsigned compute_heights_in_block(ir_node *bl, heights_t *h)
183 {
184         int             max_height = -1;
185         const ir_edge_t *edge;
186
187         h->visited++;
188
189         foreach_out_edge(bl, edge) {
190                 ir_node *dep = get_edge_src_irn(edge);
191                 int     curh = compute_height(h, dep, bl);
192
193                 max_height = MAX(curh, max_height);
194         }
195
196         foreach_out_edge_kind(bl, edge, EDGE_KIND_DEP) {
197                 ir_node *dep = get_edge_src_irn(edge);
198                 int     curh = compute_height(h, dep, bl);
199
200                 max_height = MAX(curh, max_height);
201         }
202
203         return max_height;
204 }
205
206 static void compute_heights_in_block_walker(ir_node *block, void *data)
207 {
208         heights_t *h = data;
209         compute_heights_in_block(block, h);
210 }
211
212 unsigned get_irn_height(heights_t *heights, const ir_node *irn)
213 {
214         irn_height_t *h = phase_get_irn_data(&heights->ph, irn);
215         assert(h && "No height information for node");
216         return h->height;
217 }
218
219 unsigned heights_recompute_block(heights_t *h, ir_node *block)
220 {
221         const ir_edge_t *edge;
222
223         edges_assure(phase_get_irg(&h->ph));
224
225         /* reset phase data for all nodes in the block */
226         foreach_out_edge(block, edge) {
227                 ir_node      *irn = get_edge_src_irn(edge);
228                 irn_height_t *ih  = phase_get_irn_data(&h->ph, irn);
229
230                 irn_height_init(&h->ph, irn, ih);
231         }
232
233         h->visited = 0;
234         return compute_heights_in_block(block, h);
235 }
236
237 void heights_recompute(heights_t *h)
238 {
239         edges_assure(phase_get_irg(&h->ph));
240         phase_reinit_irn_data(&h->ph);
241         h->visited = 0;
242         irg_block_walk_graph(phase_get_irg(&h->ph), compute_heights_in_block_walker, NULL, h);
243 }
244
245 heights_t *heights_new(ir_graph *irg)
246 {
247         heights_t *res = xmalloc(sizeof(res[0]));
248         phase_init(&res->ph, "heights", irg, PHASE_DEFAULT_GROWTH, irn_height_init, NULL);
249         res->dump_handle = dump_add_node_info_callback(height_dump_cb, res);
250         heights_recompute(res);
251
252         return res;
253 }
254
255 void heights_free(heights_t *h)
256 {
257         phase_free(&h->ph);
258         dump_remv_node_info_callback(h->dump_handle);
259         xfree(h);
260 }