- more irp_resource_reserved()
[libfirm] / ir / ana / phiclass.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 phiclass analysis
23  * @author Daniel Grund, Christian Wuerdig
24  * @cvsid  $Id$
25  * @date   09.08.2005
26  */
27 #include "config.h"
28
29 #ifdef HAVE_STDLIB_H
30 # include <stdlib.h>
31 #endif
32
33 #include "irnode.h"
34 #include "debug.h"
35 #include "irgwalk.h"
36 #include "irop_t.h"
37 #include "iredges_t.h"
38 #include "phiclass.h"
39 #include "irphase_t.h"
40 #include "irnodeset.h"
41
42 struct _phi_classes_t {
43         ir_phase ph;                 /* The phase object holding the irn data */
44         pset     *all_phi_classes;   /* A set containing all Phi classes */
45         ir_graph *irg;               /* The irg this is all about */
46         unsigned pure_phi_classes;   /* Build pure Phi classes */
47         DEBUG_ONLY(firm_dbg_module_t *dbg);
48 };
49
50 typedef struct _irn_phi_class_t {
51         ir_node ***phi_cls; /* the array of node pointers representing the class */
52 } irn_phi_class_t;
53
54 static inline ir_node ***_get_phi_class(ir_phase *ph, ir_node *irn) {
55         irn_phi_class_t *ipc = phase_get_or_set_irn_data(ph, irn);
56         return ipc->phi_cls;
57 }
58
59 static inline void _set_phi_class(ir_phase *ph, ir_node *irn, ir_node ***cls) {
60         irn_phi_class_t *ipc = phase_get_or_set_irn_data(ph, irn);
61         ipc->phi_cls = cls;
62 }
63
64 /* initialize data structure for given irn in given phase */
65 static void *irn_phi_class_init(ir_phase *ph, const ir_node *irn, void *data) {
66         irn_phi_class_t *ipc = data ? data : phase_alloc(ph, sizeof(ipc[0]));
67         (void) irn;
68         memset(ipc, 0, sizeof(ipc[0]));
69         return ipc;
70 }
71
72 /**
73  * Builds the phi class, starting from.
74  * @param phi_classes  The phi class object
75  * @param irn          The to start from
76  * @param pc           The phi class this irn should be put into.
77  *                     Set to NULL if you want a new one.
78  */
79 static void phi_class_build(phi_classes_t *phi_classes, ir_node *irn, ir_node ***pc) {
80         const ir_edge_t *edge;
81
82         assert((! phi_classes->pure_phi_classes || is_Phi(irn)) && "Node must be Phi when pure_phi_classes set.");
83
84         /* If irn has a phi class assigned already
85          * return immediately to stop recursion */
86         if (_get_phi_class(&phi_classes->ph, irn)) {
87                 DBG((phi_classes->dbg, LEVEL_2, "\talready done for %+F\n", irn));
88                 return;
89         }
90
91         /* The initial call to phi_class_build doesn't
92          * provide a nodeset, so alloc it */
93         if (! pc) {
94                 DBG((phi_classes->dbg, LEVEL_1, "Computing phi class for %+F:\n", irn));
95                 assert(is_Phi(irn));
96                 pc  = phase_alloc(&phi_classes->ph, sizeof(*pc));
97                 *pc = NEW_ARR_F(ir_node *, 0);
98                 DBG((phi_classes->dbg, LEVEL_2, "\tcreated class %p in container %p\n", *pc, pc));
99         }
100
101         /* Add the irn to the phi class */
102         DBG((phi_classes->dbg, LEVEL_1, "\t\tadding %+F to class %p, container %p\n", irn, *pc, pc));
103         ARR_APP1(ir_node *, *pc, irn);
104         _set_phi_class(&phi_classes->ph, irn, pc);
105
106         /* Check the 'neighbour' irns */
107         if (is_Phi(irn) && mode_is_datab(get_irn_mode(irn))) {
108                 int i;
109                 DBG((phi_classes->dbg, LEVEL_2, "\tchecking args of %+F:\n", irn));
110                 /* Add all args of the phi to the phi-class. */
111                 for (i = get_irn_arity(irn) - 1; i >= 0; --i) {
112                         ir_node *op = get_irn_n(irn, i);
113                         DBG((phi_classes->dbg, LEVEL_2, "\tchecking arg %+F\n", op));
114                         if (! phi_classes->pure_phi_classes || is_Phi(op))
115                                 phi_class_build(phi_classes, op, pc);
116                 }
117         }
118
119         /* Add a user of the irn to the class,
120          * iff it is a phi node  */
121         if (! phi_classes->pure_phi_classes || 1) {
122                 DBG((phi_classes->dbg, LEVEL_2, "\tchecking users of %+F:\n", irn));
123                 foreach_out_edge(irn, edge) {
124                         ir_node *user = edge->src;
125                         DBG((phi_classes->dbg, LEVEL_2, "\tchecking user %+F ... ", user));
126                         if (is_Phi(user) && mode_is_datab(get_irn_mode(user))) {
127                                 DB((phi_classes->dbg, LEVEL_2, "is a Phi, descend\n"));
128                                 phi_class_build(phi_classes, user, pc);
129                         }
130                         else {
131                                 DB((phi_classes->dbg, LEVEL_2, "not a Phi, skip\n"));
132                         }
133                 }
134         }
135 }
136
137 /**
138  * Call by a walker. If @p node is Phi, it build the Phi class starting from this node.
139  */
140 static void phi_class_construction_walker(ir_node *node, void *env) {
141         phi_classes_t *pc = env;
142
143         if (is_Phi(node) && mode_is_datab(get_irn_mode(node))) {
144                 ir_node ***irn_pc = _get_phi_class(&pc->ph, node);
145
146                 if (! irn_pc) {
147                         ir_node **pc_values;
148                         phi_class_build(pc, node, NULL);
149
150                         pc_values = *_get_phi_class(&pc->ph, node);
151                         DBG((pc->dbg, LEVEL_1, "inserting phiclass %p (%d members) into all classes\n", pc_values, ARR_LEN(pc_values)));
152
153                         pset_insert_ptr(pc->all_phi_classes, pc_values);
154                 }
155         }
156 }
157
158 /**
159  * Walk over the irg and build the Phi classes.
160  */
161 static void phi_class_compute(phi_classes_t *pc) {
162         irg_walk_graph(pc->irg, phi_class_construction_walker, NULL, pc);
163 }
164
165 /**
166  * Build the Phi classes for the set of given Phis.
167  */
168 static void phi_class_compute_by_phis(phi_classes_t *pc, ir_nodeset_t *all_phi_nodes) {
169         if (ir_nodeset_size(all_phi_nodes) > 0) {
170                 ir_nodeset_iterator_t iter;
171                 ir_node               *phi;
172
173                 foreach_ir_nodeset(all_phi_nodes, phi, iter) {
174                         ir_node ***irn_pc = _get_phi_class(&pc->ph, phi);
175
176                         assert(is_Phi(phi) && mode_is_datab(get_irn_mode(phi)));
177
178                         if (! irn_pc) {
179                                 ir_node **pc_values;
180
181                                 phi_class_build(pc, phi, NULL);
182
183                                 pc_values = *_get_phi_class(&pc->ph, phi);
184                                 DBG((pc->dbg, LEVEL_1, "inserting phiclass %p into all classes\n", pc_values));
185
186                                 pset_insert_ptr(pc->all_phi_classes, pc_values);
187                         }
188                 }
189         }
190 }
191
192 /**
193  * Return the array containing all nodes assigned to the same Phi class as @p irn.
194  */
195 ir_node **get_phi_class(phi_classes_t *pc, ir_node *irn) {
196         return *_get_phi_class(&pc->ph, irn);
197 }
198
199 /**
200  * Assigns a new array of nodes representing the new Phi class to @p irn.
201  */
202 void set_phi_class(phi_classes_t *pc, ir_node *irn, ir_node **cls) {
203         _set_phi_class(&pc->ph, irn, &cls);
204 }
205
206 /**
207  * Returns a set containing all computed Phi classes.
208  */
209 pset *get_all_phi_classes(phi_classes_t *pc) {
210         return pc->all_phi_classes;
211 }
212
213 /**
214  * Builds the Phi classes for all Phis in @p irg.
215  * @return The Phi class object for the @p irg.
216  */
217 phi_classes_t *phi_class_new_from_irg(ir_graph *irg, int pure_phi_classes) {
218         phi_classes_t *res = XMALLOC(phi_classes_t);
219
220         FIRM_DBG_REGISTER(res->dbg, "ir.ana.phiclass");
221         phase_init(&res->ph, "phi_classes", irg, PHASE_DEFAULT_GROWTH, irn_phi_class_init, NULL);
222
223         res->irg              = irg;
224         res->all_phi_classes  = pset_new_ptr(5);
225         res->pure_phi_classes = pure_phi_classes;
226
227         phi_class_compute(res);
228
229         return res;
230 }
231
232 /**
233  * Builds all Phi classes for the given set of Phis.
234  * @return The Phis class object for @p all_phis.
235  */
236 phi_classes_t *phi_class_new_from_set(ir_graph *irg, ir_nodeset_t *all_phis, int pure_phi_classes) {
237         phi_classes_t *res = XMALLOC(phi_classes_t);
238
239         FIRM_DBG_REGISTER(res->dbg, "ir.ana.phiclass");
240         phase_init(&res->ph, "phi_classes", irg, PHASE_DEFAULT_GROWTH, irn_phi_class_init, NULL);
241
242         res->irg              = irg;
243         res->all_phi_classes  = pset_new_ptr(5);
244         res->pure_phi_classes = pure_phi_classes;
245
246         phi_class_compute_by_phis(res, all_phis);
247
248         return res;
249 }
250
251 /**
252  * Free all allocated data.
253  */
254 void phi_class_free(phi_classes_t *pc) {
255         ir_node **ipc;
256         foreach_pset(pc->all_phi_classes, ipc) {
257                 DEL_ARR_F(ipc);
258         }
259         del_pset(pc->all_phi_classes);
260         phase_free(&pc->ph);
261         xfree(pc);
262 }