Remove the unused parameter const arch_env_t *arch_env from be_liveness_end_of_block().
[libfirm] / ir / be / beloopana.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       Compute register pressure in loops.
23  * @author      Christian Wuerdig
24  * @date        19.02.2007
25  * @version     $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include "set.h"
32 #include "pset.h"
33 #include "irnode.h"
34 #include "irtools.h"
35 #include "irloop_t.h"
36 #include "error.h"
37 #include "debug.h"
38
39 #include "bearch_t.h"
40 #include "belive.h"
41 #include "besched.h"
42 #include "beloopana.h"
43 #include "bemodule.h"
44
45 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL);
46
47 #define HASH_LOOP_INFO(info) (HASH_PTR((info)->loop) ^ HASH_PTR((info)->cls))
48
49 typedef struct _be_loop_info_t {
50         ir_loop                     *loop;
51         const arch_register_class_t *cls;
52         unsigned                    max_pressure;
53 } be_loop_info_t;
54
55 struct _be_loopana_t {
56         set      *data;
57         be_irg_t *birg;
58 };
59
60 static int cmp_loop_info(const void *a, const void *b, size_t size) {
61         const be_loop_info_t *i1 = a;
62         const be_loop_info_t *i2 = b;
63         (void) size;
64
65         return ! (i1->loop == i2->loop && i1->cls == i2->cls);
66 }
67
68 /**
69  * Compute the highest register pressure in a block.
70  * @param loop_ana  The loop ana object.
71  * @param block     The block to compute pressure for.
72  * @param cls       The register class to compute pressure for.
73  * @return The highest register pressure in the given block.
74  */
75 static unsigned be_compute_block_pressure(be_loopana_t *loop_ana,
76                 ir_node *block, const arch_register_class_t *cls)
77 {
78         const be_irg_t   *birg       = loop_ana->birg;
79         be_lv_t          *lv         = be_get_birg_liveness(birg);
80         ir_nodeset_t      live_nodes;
81         ir_node          *irn;
82         int              max_live;
83
84         DBG((dbg, LEVEL_1, "Processing Block %+F\n", block));
85
86         /* determine largest pressure with this block */
87         ir_nodeset_init(&live_nodes);
88         be_liveness_end_of_block(lv, cls, block, &live_nodes);
89         max_live   = ir_nodeset_size(&live_nodes);
90
91         sched_foreach_reverse(block, irn) {
92                 int cnt;
93
94                 if (is_Phi(irn))
95                         break;
96
97                 be_liveness_transfer(cls, irn, &live_nodes);
98                 cnt        = ir_nodeset_size(&live_nodes);
99                 max_live   = MAX(cnt, max_live);
100         }
101
102         DBG((dbg, LEVEL_1, "Finished with Block %+F (%s %u)\n", block, cls->name, max_live));
103
104         ir_nodeset_destroy(&live_nodes);
105         return max_live;
106 }
107
108 /**
109  * Compute the highest register pressure in a loop and it's sub-loops.
110  * @param loop_ana  The loop ana object.
111  * @param loop      The loop to compute pressure for.
112  * @param cls       The register class to compute pressure for.
113  * @return The highest register pressure in the given loop.
114  */
115 static unsigned be_compute_loop_pressure(be_loopana_t *loop_ana, ir_loop *loop, const arch_register_class_t *cls) {
116         int            i, max;
117         unsigned       pressure;
118         be_loop_info_t *entry, key;
119
120         DBG((dbg, LEVEL_1, "\nProcessing Loop %d\n", loop->loop_nr));
121         assert(get_loop_n_elements(loop) > 0);
122         pressure = 0;
123
124         /* determine maximal pressure in all loop elements */
125         for (i = 0, max = get_loop_n_elements(loop); i < max; ++i) {
126                 unsigned     son_pressure;
127                 loop_element elem = get_loop_element(loop, i);
128
129                 switch (*elem.kind) {
130                         case k_ir_node:
131                                 son_pressure = be_compute_block_pressure(loop_ana, elem.node, cls);
132                                 break;
133                         case k_ir_loop:
134                                 son_pressure = be_compute_loop_pressure(loop_ana, elem.son, cls);
135                                 break;
136                         default:
137                                 panic("Unknown element found in loop");
138                                 break;
139                 }
140
141                 pressure = MAX(pressure, son_pressure);
142         }
143         DBG((dbg, LEVEL_1, "Done with loop %d, pressure %u for class %s\n", loop->loop_nr, pressure, cls->name));
144
145         /* update info in set */
146         key.loop            = loop;
147         key.cls             = cls;
148         key.max_pressure    = 0;
149         entry               = set_insert(loop_ana->data, &key, sizeof(key), HASH_LOOP_INFO(&key));
150         entry->max_pressure = MAX(entry->max_pressure, pressure);
151
152         return pressure;
153 }
154
155 /**
156  * Compute the register pressure for a class of all loops in the birg.
157  * @param birg  The backend irg object
158  * @param cls   The register class to compute the pressure for
159  * @return The loop analysis object.
160  */
161 be_loopana_t *be_new_loop_pressure_cls(be_irg_t *birg,
162                                        const arch_register_class_t *cls) {
163         ir_graph     *irg      = be_get_birg_irg(birg);
164         be_loopana_t *loop_ana = XMALLOC(be_loopana_t);
165
166         loop_ana->data = new_set(cmp_loop_info, 16);
167         loop_ana->birg = birg;
168
169         DBG((dbg, LEVEL_1, "\n=====================================================\n", cls->name));
170         DBG((dbg, LEVEL_1, " Computing register pressure for class %s:\n", cls->name));
171         DBG((dbg, LEVEL_1, "=====================================================\n", cls->name));
172
173         /* construct control flow loop tree */
174         if (! (get_irg_loopinfo_state(irg) & loopinfo_cf_consistent)) {
175                 construct_cf_backedges(irg);
176         }
177
178         be_compute_loop_pressure(loop_ana, get_irg_loop(irg), cls);
179
180         return loop_ana;
181 }
182
183 /**
184  * Compute the register pressure for all classes of all loops in the birg.
185  * @param birg  The backend irg object
186  * @return The loop analysis object.
187  */
188 be_loopana_t *be_new_loop_pressure(be_irg_t *birg,
189                                    const arch_register_class_t *cls)
190 {
191         ir_graph         *irg      = be_get_birg_irg(birg);
192         be_loopana_t     *loop_ana = XMALLOC(be_loopana_t);
193         ir_loop          *irg_loop = get_irg_loop(irg);
194         const arch_env_t *arch_env = be_get_birg_arch_env(birg);
195         int               i;
196
197         loop_ana->data = new_set(cmp_loop_info, 16);
198         loop_ana->birg = birg;
199
200         /* construct control flow loop tree */
201         if (! (get_irg_loopinfo_state(irg) & loopinfo_cf_consistent)) {
202                 construct_cf_backedges(irg);
203         }
204
205         if (cls != NULL) {
206                 be_compute_loop_pressure(loop_ana, irg_loop, cls);
207         } else {
208                 for (i = arch_env_get_n_reg_class(arch_env) - 1; i >= 0; --i) {
209                         const arch_register_class_t *cls = arch_env_get_reg_class(arch_env, i);
210                         DBG((dbg, LEVEL_1, "\n=====================================================\n", cls->name));
211                         DBG((dbg, LEVEL_1, " Computing register pressure for class %s:\n", cls->name));
212                         DBG((dbg, LEVEL_1, "=====================================================\n", cls->name));
213                         be_compute_loop_pressure(loop_ana, irg_loop, cls);
214                 }
215         }
216
217         return loop_ana;
218 }
219
220 /**
221  * Returns the computed register pressure for the given class and loop.
222  * @return The pressure or INT_MAX if not found
223  */
224 unsigned be_get_loop_pressure(be_loopana_t *loop_ana, const arch_register_class_t *cls, ir_loop *loop) {
225         unsigned pressure = INT_MAX;
226         be_loop_info_t *entry, key;
227
228         assert(cls && loop);
229
230         key.loop = loop;
231         key.cls  = cls;
232         entry    = set_find(loop_ana->data, &key, sizeof(key), HASH_LOOP_INFO(&key));
233
234         if (entry)
235                 pressure = entry->max_pressure;
236         else
237                 assert(0 && "Pressure not computed for given class and loop object.");
238
239         return pressure;
240 }
241
242 /**
243  * Frees the loop analysis object.
244  */
245 void be_free_loop_pressure(be_loopana_t *loop_ana) {
246         del_set(loop_ana->data);
247         xfree(loop_ana);
248 }
249
250 void be_init_loopana(void)
251 {
252         FIRM_DBG_REGISTER(dbg, "firm.be.loopana");
253 }
254
255 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_loopana);