add docu and prototype for find_value()
[libfirm] / ir / ana / height.c
1 /*
2  * Project:     libFIRM
3  * File name:   ir/ana/height.c
4  * Purpose:     Compute heights of nodes inside basic blocks
5  * Author:      Sebastian Hack
6  * Modified by:
7  * Created:     19.04.2006
8  * CVS-ID:      $Id$
9  * Copyright:   (c) 2006 Universität Karlsruhe
10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
11  */
12
13 #include <stdlib.h>
14 #include <stdio.h>
15
16 #include "list.h"
17
18 #include "irdump.h"
19 #include "irgwalk.h"
20 #include "irtools.h"
21 #include "irphase_t.h"
22 #include "iredges_t.h"
23
24 typedef struct _heights_t heights_t;
25
26 struct _heights_t {
27         phase_t ph;
28         unsigned visited;
29         void *dump_handle;
30         struct list_head sink_head;
31 };
32
33 typedef struct {
34         unsigned height;
35         unsigned visited;
36         unsigned is_sink : 1;
37         struct list_head sink_list;
38 } irn_height_t;
39
40 static void *irn_height_init(phase_t *ph, ir_node *irn, void *data)
41 {
42         irn_height_t *h = data ? data : phase_alloc(ph, sizeof(h[0]));
43         memset(h, 0, sizeof(h[0]));
44         INIT_LIST_HEAD(&h->sink_list);
45         return h;
46 }
47
48 static void height_dump_cb(void *data, FILE *f, const ir_node *irn)
49 {
50         heights_t *heights = data;
51         irn_height_t *h    = phase_get_irn_data(&heights->ph, irn);
52
53         if(h)
54                 fprintf(f, "height: %u\n", h->height);
55 }
56
57 /**
58  * Check, if we can reach a target node from a given node inside one basic block.
59  * @param h    The heights object.
60  * @param curr The current node from which we tried to reach the other one.
61  * @param tgt  The node we try to reach.
62  * @return     1, one of tgt can be reached from curr, 0 else.
63  */
64 static int search(heights_t *h, const ir_node *curr, const ir_node *tgt)
65 {
66         irn_height_t *h_curr;
67         irn_height_t *h_tgt;
68         int i, n;
69
70         /* if the current node is the one we were looking for, we're done. */
71         if(curr == tgt)
72                 return 1;
73
74         /* If we are in another block we won't find our target. */
75         if(get_nodes_block(curr) != get_nodes_block(tgt))
76                 return 0;
77
78         /* Check, if we have already been here. Coming more often won't help :-) */
79         h_curr = phase_get_irn_data(&h->ph, curr);
80         if(h_curr->visited >= h->visited)
81                 return 0;
82
83         /* If we are too deep into the DAG we won't find the target either. */
84         h_tgt = phase_get_irn_data(&h->ph, tgt);
85         if(h_curr->height > h_tgt->height)
86                 return 0;
87
88         /* Mark this place as visited. */
89         h_curr->visited = h->visited;
90
91         /* Start a search from this node. */
92         for(i = 0, n = get_irn_ins_or_deps(curr); i < n; ++i) {
93                 ir_node *op = get_irn_in_or_dep(curr, i);
94                 if(search(h, op, tgt))
95                         return 1;
96         }
97
98         return 0;
99 }
100
101 /**
102  * Check, if one node can be reached from another one, according to data dependence.
103  */
104 int heights_reachable_in_block(heights_t *h, const ir_node *n, const ir_node *m)
105 {
106         int res          = 0;
107         irn_height_t *hn = phase_get_irn_data(&h->ph, n);
108         irn_height_t *hm = phase_get_irn_data(&h->ph, m);
109
110         assert(get_nodes_block(n) == get_nodes_block(m));
111         assert(hn != NULL && hm != NULL);
112
113         if(hn->height <= hm->height) {
114                 h->visited++;
115                 res = search(h, n, m);
116         }
117
118         return res;
119 }
120
121 /**
122  * Compute the height of a node in a block.
123  * @param h   The heights object.
124  * @param irn The node.
125  * @param bl  The block.
126  */
127 static unsigned compute_height(heights_t *h, ir_node *irn, const ir_node *bl)
128 {
129         irn_height_t *ih = phase_get_or_set_irn_data(&h->ph, irn);
130         int is_sink;
131
132         const ir_edge_t *edge;
133
134         /* bail out if we already visited that node. */
135         if(ih->visited >= h->visited)
136                 return ih->height;
137
138         ih->visited = h->visited;
139         ih->height  = 0;
140
141         is_sink = 1;
142
143         foreach_out_edge(irn, edge) {
144                 ir_node *dep = get_edge_src_irn(edge);
145
146                 if(!is_Block(dep) && get_nodes_block(dep) == bl) {
147                         unsigned dep_height = compute_height(h, dep, bl);
148                         ih->height          = MAX(ih->height, dep_height);
149                         is_sink             = 0;
150                 }
151
152                 ih->height++;
153         }
154
155         foreach_out_edge_kind(irn, edge, EDGE_KIND_DEP) {
156                 ir_node *dep = get_edge_src_irn(edge);
157
158                 if(!is_Block(dep) && get_nodes_block(dep) == bl) {
159                         unsigned dep_height = compute_height(h, dep, bl);
160                         ih->height          = MAX(ih->height, dep_height);
161                         is_sink             = 0;
162                 }
163
164                 ih->height++;
165         }
166
167         ih->is_sink = is_sink;
168         if(is_sink)
169                 list_add(&ih->sink_list, &h->sink_head);
170
171         return ih->height;
172 }
173
174 static void compute_heights_in_block(ir_node *bl, void *data)
175 {
176         heights_t *h = data;
177         const ir_edge_t *edge;
178
179         h->visited++;
180
181         foreach_out_edge(bl, edge) {
182                 ir_node *dep = get_edge_src_irn(edge);
183                 compute_height(h, dep, bl);
184         }
185
186         foreach_out_edge_kind(bl, edge, EDGE_KIND_DEP) {
187                 ir_node *dep = get_edge_src_irn(edge);
188                 compute_height(h, dep, bl);
189         }
190 }
191
192 unsigned get_irn_height(heights_t *heights, const ir_node *irn)
193 {
194         irn_height_t *h = phase_get_irn_data(&heights->ph, irn);
195         assert(h && "No height information for node");
196         return h->height;
197 }
198
199 void heights_recompute(heights_t *h)
200 {
201         edges_assure(phase_get_irg(&h->ph));
202         phase_reinit_irn_data(&h->ph);
203         h->visited = 0;
204         INIT_LIST_HEAD(&h->sink_head);
205         irg_block_walk_graph(phase_get_irg(&h->ph), compute_heights_in_block, NULL, h);
206 }
207
208 heights_t *heights_new(ir_graph *irg)
209 {
210         heights_t *res = xmalloc(sizeof(res[0]));
211         phase_init(&res->ph, "heights", irg, PHASE_DEFAULT_GROWTH, irn_height_init);
212         res->dump_handle = dump_add_node_info_callback(height_dump_cb, res);
213         heights_recompute(res);
214
215         return res;
216 }
217
218 void heights_free(heights_t *h)
219 {
220         phase_free(&h->ph);
221         dump_remv_node_info_callback(h->dump_handle);
222         xfree(h);
223 }