remove some unused code
[libfirm] / ir / ana / cdep.c
1 /*
2  * Copyright (C) 1995-2008 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   Implementation of cdep
23  * @author  Christoph Mallon
24  * @version $Id$
25  */
26 #include <assert.h>
27 #include <stdlib.h>
28 #include "irdom.h"
29 #include "irgraph.h"
30 #include "irgwalk.h"
31 #include "irnode.h"
32 #include "pmap.h"
33 #include "obst.h"
34 #include "xmalloc.h"
35 #include "cdep.h"
36 #include "irprintf.h"
37 #include "irdump.h"
38
39 typedef struct cdep_info {
40         pmap   *cdep_map;     /**< A map to find the list of all control dependence nodes for a block. */
41         struct obstack obst;  /**< An obstack where all cdep data lives on. */
42 } cdep_info;
43
44 static cdep_info *cdep_data;
45
46 /* Return a list of all control dependences of a block. */
47 ir_cdep *find_cdep(const ir_node *block) {
48         return pmap_get(cdep_data->cdep_map, block);
49 }
50
51 /* Replace the control dependence info of old by the info of nw. */
52 void exchange_cdep(ir_node *old, const ir_node *nw) {
53         ir_cdep *cdep = find_cdep(nw);
54         pmap_insert(cdep_data->cdep_map, old, cdep);
55 }
56
57 /**
58  * Adds a control dependence from node to dep_on.
59  */
60 static void add_cdep(ir_node *node, ir_node *dep_on) {
61         ir_cdep *dep = find_cdep(node);
62 #if 0
63         ir_fprintf(stderr, "Adding cdep of %+F on %+F\n", node, dep_on);
64 #endif
65
66         if (dep == NULL) {
67                 ir_cdep *newdep = OALLOC(&cdep_data->obst, ir_cdep);
68
69                 newdep->node = dep_on;
70                 newdep->next = NULL;
71                 pmap_insert(cdep_data->cdep_map, node, newdep);
72         } else {
73                 ir_cdep *newdep;
74
75                 for (;;) {
76                         if (dep->node == dep_on) return;
77                         if (dep->next == NULL) break;
78                         dep = dep->next;
79                 }
80                 newdep = OALLOC(&cdep_data->obst, ir_cdep);
81                 newdep->node = dep_on;
82                 newdep->next = NULL;
83                 dep->next = newdep;
84         }
85 }
86
87 typedef struct cdep_env {
88         ir_node *start_block;
89         ir_node *end_block;
90 } cdep_env;
91
92 /**
93  * Pre-block-walker: calculate the control dependence
94  */
95 static void cdep_pre(ir_node *node, void *ctx) {
96         cdep_env *env = ctx;
97         int i;
98
99         /* special case:
100          * start and end block have no control dependency
101          */
102         if (node == env->start_block) return;
103         if (node == env->end_block) return;
104
105         for (i = get_Block_n_cfgpreds(node) - 1; i >= 0; --i) {
106                 ir_node *pred = get_Block_cfgpred_block(node, i);
107                 ir_node *pdom;
108                 ir_node *dependee;
109
110                 if (is_Bad(pred)) continue;
111
112                 pdom = get_Block_ipostdom(pred);
113                 for (dependee = node; dependee != pdom; dependee = get_Block_ipostdom(dependee)) {
114                         assert(!is_Bad(pdom));
115                         add_cdep(dependee, pred);
116                 }
117         }
118 }
119
120
121 /**
122  * A block edge hook: add all cdep edges of block.
123  */
124 static int cdep_edge_hook(FILE *F, ir_node *block)
125 {
126         ir_cdep *cd;
127
128 #if 0
129         ir_node *pdom = get_Block_ipostdom(block);
130         if (pdom != NULL) {
131                 fprintf(
132                         F,
133                         "edge:{sourcename:\"n%ld\" targetname:\"n%ld\" color:gold}\n",
134                         get_irn_node_nr(pdom), get_irn_node_nr(block)
135                 );
136         }
137 #endif
138
139         for (cd = find_cdep(block); cd != NULL; cd = cd->next) {
140                 fprintf(
141                         F,
142                         "edge:{sourcename:\"n%ld\" targetname:\"n%ld\" "
143                         "linestyle:dashed color:gold}\n",
144                         get_irn_node_nr(block), get_irn_node_nr(cd->node)
145                 );
146         }
147
148         return 0;
149 }
150
151 /* Compute the control dependence graph for a graph. */
152 void compute_cdep(ir_graph *irg) {
153         ir_node *rem;
154         cdep_env env;
155
156         free_cdep(irg);
157         cdep_data = XMALLOC(cdep_info);
158         obstack_init(&cdep_data->obst);
159
160         cdep_data->cdep_map = pmap_create();
161
162         assure_postdoms(irg);
163
164         /* we must temporary change the post dominator relation:
165            the ipdom of the startblock is the end block.
166            Firm does NOT add the phantom edge from Start to End.
167          */
168         env.start_block = get_irg_start_block(irg);
169         env.end_block   = get_irg_end_block(irg);
170
171         rem = get_Block_ipostdom(env.start_block);
172         set_Block_ipostdom(env.start_block, env.end_block);
173
174         irg_block_walk_graph(irg, cdep_pre, NULL, &env);
175
176 #if 0
177         set_dump_block_edge_hook(cdep_edge_hook);
178         dump_ir_block_graph(irg, "_cdep");
179         set_dump_block_edge_hook(NULL);
180 #else
181         (void) cdep_edge_hook;
182 #endif
183
184         /* restore the post dominator relation */
185         set_Block_ipostdom(env.start_block, rem);
186 }
187
188 /* Free the control dependence info. */
189 void free_cdep(ir_graph *irg) {
190         (void) irg;
191         if (cdep_data != NULL) {
192                 pmap_destroy(cdep_data->cdep_map);
193                 obstack_free(&cdep_data->obst, NULL);
194                 xfree(cdep_data);
195                 cdep_data = NULL;
196         }
197 }
198
199 /* Check whether dependee is (directly) control dependent on candidate. */
200 int is_cdep_on(const ir_node *dependee, const ir_node *candidate) {
201         const ir_cdep *dep;
202
203         for (dep = find_cdep(dependee); dep != NULL; dep = dep->next) {
204                 if (dep->node == candidate) return 1;
205         }
206         return 0;
207 }
208
209 /* Check whether dependee is (possible iterated) control dependent on candidate. */
210 int is_iterated_cdep_on(ir_node *dependee, ir_node *candidate) {
211         const ir_cdep *dep;
212
213         while ((dep = find_cdep(dependee)) != NULL) {
214                 if (dep->next != NULL) return 0;
215                 if (dep->node == candidate) return 1;
216                 dependee = dep->node;
217         }
218         return 0;
219 }
220
221 /* If block is control dependent on exactly one node, return this node, else NULL. */
222 ir_node *get_unique_cdep(const ir_node *block) {
223         ir_cdep *cdep = find_cdep(block);
224
225         return cdep != NULL && cdep->next == NULL ? cdep->node : NULL;
226 }
227
228 /* Check if the given block is control dependent of more than one node. */
229 int has_multiple_cdep(const ir_node *block) {
230         ir_cdep *cdep = find_cdep(block);
231
232         return cdep != NULL && cdep->next != NULL;
233 }