Remove entity_usage_state attribute
[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_t.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 ir_node *(get_cdep_node)(const ir_cdep *cdep)
47 {
48         return _get_cdep_node(cdep);
49 }
50
51 ir_cdep *(get_cdep_next)(const ir_cdep *cdep)
52 {
53         return _get_cdep_next(cdep);
54 }
55
56 /* Return a list of all control dependences of a block. */
57 ir_cdep *find_cdep(const ir_node *block)
58 {
59         assert(is_Block(block));
60         return (ir_cdep*) pmap_get(cdep_data->cdep_map, block);
61 }
62
63 void exchange_cdep(ir_node *old, const ir_node *nw)
64 {
65         ir_cdep *cdep = find_cdep(nw);
66         assert(is_Block(old));
67         pmap_insert(cdep_data->cdep_map, old, cdep);
68 }
69
70 /**
71  * Adds a control dependence from node to dep_on.
72  */
73 static void add_cdep(ir_node *node, ir_node *dep_on)
74 {
75         ir_cdep *dep = find_cdep(node);
76
77         assert(is_Block(dep_on));
78         if (dep == NULL) {
79                 ir_cdep *newdep = OALLOC(&cdep_data->obst, ir_cdep);
80
81                 newdep->node = dep_on;
82                 newdep->next = NULL;
83                 pmap_insert(cdep_data->cdep_map, node, newdep);
84         } else {
85                 ir_cdep *newdep;
86
87                 for (;;) {
88                         if (get_cdep_node(dep) == dep_on) return;
89                         if (dep->next == NULL) break;
90                         dep = dep->next;
91                 }
92                 newdep = OALLOC(&cdep_data->obst, ir_cdep);
93                 newdep->node = dep_on;
94                 newdep->next = NULL;
95                 dep->next = newdep;
96         }
97 }
98
99 typedef struct cdep_env {
100         ir_node *start_block;
101         ir_node *end_block;
102 } cdep_env;
103
104 /**
105  * Pre-block-walker: calculate the control dependence
106  */
107 static void cdep_pre(ir_node *node, void *ctx)
108 {
109         cdep_env *env = (cdep_env*) ctx;
110         int i;
111
112         /* special case:
113          * start and end block have no control dependency
114          */
115         if (node == env->start_block) return;
116         if (node == env->end_block) return;
117
118         for (i = get_Block_n_cfgpreds(node) - 1; i >= 0; --i) {
119                 ir_node *pred = get_Block_cfgpred_block(node, i);
120                 ir_node *pdom;
121                 ir_node *dependee;
122
123                 if (is_Bad(pred)) continue;
124
125                 pdom = get_Block_ipostdom(pred);
126                 for (dependee = node; dependee != pdom; dependee = get_Block_ipostdom(dependee)) {
127                         assert(!is_Bad(pdom));
128                         add_cdep(dependee, pred);
129                 }
130         }
131 }
132
133
134 /**
135  * A block edge hook: add all cdep edges of block.
136  */
137 static int cdep_edge_hook(FILE *F, ir_node *block)
138 {
139         ir_cdep *cd;
140
141         for (cd = find_cdep(block); cd != NULL; cd = cd->next) {
142                 fprintf(
143                         F,
144                         "edge:{sourcename:\"n%ld\" targetname:\"n%ld\" "
145                         "linestyle:dashed color:gold}\n",
146                         get_irn_node_nr(block), get_irn_node_nr(cd->node)
147                 );
148         }
149
150         return 0;
151 }
152
153 void compute_cdep(ir_graph *irg)
154 {
155         ir_node *rem;
156         cdep_env env;
157
158         free_cdep(irg);
159         cdep_data = XMALLOC(cdep_info);
160         obstack_init(&cdep_data->obst);
161
162         cdep_data->cdep_map = pmap_create();
163
164         assure_postdoms(irg);
165
166         /* we must temporary change the post dominator relation:
167            the ipdom of the startblock is the end block.
168            Firm does NOT add the phantom edge from Start to End.
169          */
170         env.start_block = get_irg_start_block(irg);
171         env.end_block   = get_irg_end_block(irg);
172
173         rem = get_Block_ipostdom(env.start_block);
174         set_Block_ipostdom(env.start_block, env.end_block);
175
176         irg_block_walk_graph(irg, cdep_pre, NULL, &env);
177
178 #if 0
179         set_dump_block_edge_hook(cdep_edge_hook);
180         dump_ir_block_graph(irg, "_cdep");
181         set_dump_block_edge_hook(NULL);
182 #else
183         (void) cdep_edge_hook;
184 #endif
185
186         /* restore the post dominator relation */
187         set_Block_ipostdom(env.start_block, rem);
188 }
189
190 void free_cdep(ir_graph *irg)
191 {
192         (void) irg;
193         if (cdep_data != NULL) {
194                 pmap_destroy(cdep_data->cdep_map);
195                 obstack_free(&cdep_data->obst, NULL);
196                 xfree(cdep_data);
197                 cdep_data = NULL;
198         }
199 }
200
201 int is_cdep_on(const ir_node *dependee, const ir_node *candidate)
202 {
203         const ir_cdep *dep;
204
205         for (dep = find_cdep(dependee); dep != NULL; dep = dep->next) {
206                 if (get_cdep_node(dep) == candidate) return 1;
207         }
208         return 0;
209 }
210
211 ir_node *get_unique_cdep(const ir_node *block)
212 {
213         ir_cdep *cdep = find_cdep(block);
214
215         return cdep != NULL && cdep->next == NULL ? get_cdep_node(cdep) : NULL;
216 }
217
218 int has_multiple_cdep(const ir_node *block)
219 {
220         ir_cdep *cdep = find_cdep(block);
221
222         return cdep != NULL && cdep->next != NULL;
223 }