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