Next step of refactoring
[libfirm] / ir / be / bechordal_main.c
1 /**
2  * @file   bechordal_main.c
3  * @date   29.11.2005
4  * @author Sebastian Hack
5  *
6  * Copyright (C) 2005 Universitaet Karlsruhe
7  * Released under the GPL
8  *
9  * Driver for the chordal register allocator.
10  */
11 #ifdef HAVE_CONFIG_H
12 #include "config.h"
13 #endif
14
15 #include "obst.h"
16 #include "pset.h"
17 #include "list.h"
18 #include "bitset.h"
19 #include "iterator.h"
20
21 #ifdef WITH_LIBCORE
22 #include <libcore/lc_opts.h>
23 #include <libcore/lc_opts_enum.h>
24 #endif /* WITH_LIBCORE */
25
26 #include "irmode_t.h"
27 #include "irgraph_t.h"
28 #include "irprintf_t.h"
29 #include "irgwalk.h"
30 #include "irdump.h"
31 #include "irdom.h"
32 #include "debug.h"
33 #include "xmalloc.h"
34
35 #include "bechordal_t.h"
36 #include "beutil.h"
37 #include "besched.h"
38 #include "benumb_t.h"
39 #include "besched_t.h"
40 #include "belive_t.h"
41 #include "bearch.h"
42 #include "beifg_t.h"
43 #include "beifg_impl.h"
44
45 #include "bespillbelady.h"
46 #include "belower.h"
47
48 #ifdef WITH_ILP
49 #include "bespillilp.h"
50 #endif /* WITH_ILP */
51
52 #include "becopystat.h"
53 #include "becopyopt.h"
54 #include "bessadestr.h"
55
56
57 void be_ra_chordal_check(be_chordal_env_t *chordal_env) {
58         firm_dbg_module_t *dbg = chordal_env->dbg;
59         const arch_env_t *arch_env = chordal_env->birg->main_env->arch_env;
60         struct obstack ob;
61         pmap_entry *pme;
62         ir_node **nodes, *n1, *n2;
63         int i, o;
64
65         /* Collect all irns */
66         obstack_init(&ob);
67         pmap_foreach(chordal_env->border_heads, pme) {
68                 border_t *curr;
69                 struct list_head *head = pme->value;
70                 list_for_each_entry(border_t, curr, head, list)
71                         if (curr->is_def && curr->is_real)
72                                 if (arch_get_irn_reg_class(arch_env, curr->irn, -1) == chordal_env->cls)
73                                         obstack_ptr_grow(&ob, curr->irn);
74         }
75         obstack_ptr_grow(&ob, NULL);
76         nodes = (ir_node **) obstack_finish(&ob);
77
78         /* Check them */
79         for (i = 0, n1 = nodes[i]; n1; n1 = nodes[++i]) {
80                 const arch_register_t *n1_reg, *n2_reg;
81
82                 n1_reg = arch_get_irn_register(arch_env, n1);
83                 if (!arch_reg_is_allocatable(arch_env, n1, -1, n1_reg)) {
84                         DBG((dbg, 0, "Register %s assigned to %+F is not allowed\n", n1_reg->name, n1));
85                         assert(0 && "Register constraint does not hold");
86                 }
87                 for (o = i+1, n2 = nodes[o]; n2; n2 = nodes[++o]) {
88                         n2_reg = arch_get_irn_register(arch_env, n2);
89                         if (values_interfere(n1, n2) && n1_reg == n2_reg) {
90                                 DBG((dbg, 0, "Values %+F and %+F interfere and have the same register assigned\n", n1, n2));
91                                 assert(0 && "Interfering values have the same color!");
92                         }
93                 }
94         }
95         obstack_free(&ob, NULL);
96 }
97
98 static void check_pressure_walker(ir_node *bl, void *data)
99 {
100         be_chordal_env_t *env = data;
101         firm_dbg_module_t *dbg = env->dbg;
102         int n_regs = arch_register_class_n_regs(env->cls);
103
104         pset *live = pset_new_ptr_default();
105         int step = 0;
106         ir_node *irn;
107         irn_live_t *li;
108
109         live_foreach(bl, li) {
110                 if(live_is_end(li) && chordal_has_class(env, li->irn)) {
111                         ir_node *irn = (ir_node *) li->irn;
112                         pset_insert_ptr(live, irn);
113                 }
114         }
115
116         DBG((dbg, LEVEL_1, "end set for %+F\n", bl));
117         for(irn = pset_first(live); irn; irn = pset_next(live))
118                 DBG((dbg, LEVEL_1, "\t%+F\n", irn));
119
120         sched_foreach_reverse(bl, irn) {
121                 int i, n;
122                 int pressure = pset_count(live);
123
124                 DBG((dbg, LEVEL_1, "%+10F@%+10F: pressure %d\n", bl, irn, pressure));
125
126                 if(pressure > n_regs) {
127                         ir_node *x;
128                         ir_printf("%+10F@%+10F: pressure to high: %d\n", bl, irn, pressure);
129                         for(x = pset_first(live); x; x = pset_next(live))
130                                 ir_printf("\t%+10F\n", x);
131                 }
132
133                 if(chordal_has_class(env, irn))
134                         pset_remove_ptr(live, irn);
135
136                 for(i = 0, n = get_irn_arity(irn); i < n; i++) {
137                         ir_node *op = get_irn_n(irn, i);
138                         if(chordal_has_class(env, op) && !is_Phi(irn))
139                                 pset_insert_ptr(live, op);
140                 }
141                 step++;
142         }
143 }
144
145 void be_check_pressure(const be_chordal_env_t *env)
146 {
147         irg_block_walk_graph(env->irg, check_pressure_walker, NULL, (void *) env);
148 }
149
150 int nodes_interfere(const be_chordal_env_t *env, const ir_node *a, const ir_node *b)
151 {
152         if(env->ifg)
153                 return be_ifg_connected(env->ifg, a, b);
154         else
155                 return values_interfere(a, b);
156 }
157
158
159 static be_ra_chordal_opts_t options = {
160         BE_CH_DUMP_NONE,
161         BE_CH_SPILL_BELADY,
162         BE_CH_COPYMIN_HEUR,
163         BE_CH_IFG_STD,
164         BE_CH_LOWER_PERM_SWAP
165 };
166
167 #ifdef WITH_LIBCORE
168 static const lc_opt_enum_int_items_t spill_items[] = {
169         { "belady", BE_CH_SPILL_BELADY },
170 #ifdef WITH_ILP
171         { "ilp",        BE_CH_SPILL_ILP },
172 #endif
173         { NULL, 0 }
174 };
175
176 static const lc_opt_enum_int_items_t copymin_items[] = {
177         { "heur", BE_CH_COPYMIN_HEUR },
178 #ifdef WITH_ILP
179         { "ilp",  BE_CH_COPYMIN_ILP },
180 #endif
181         { NULL, 0 }
182 };
183
184 static const lc_opt_enum_int_items_t ifg_flavor_items[] = {
185         { "std",  BE_CH_IFG_STD },
186         { "fast", BE_CH_IFG_FAST },
187         { NULL, 0 }
188 };
189
190 static const lc_opt_enum_int_items_t lower_perm_items[] = {
191         { "swap", BE_CH_LOWER_PERM_SWAP },
192         { "copy", BE_CH_LOWER_PERM_COPY },
193         { NULL, 0 }
194 };
195
196 static const lc_opt_enum_int_items_t dump_items[] = {
197         { "spill",    BE_CH_DUMP_SPILL },
198         { "live",     BE_CH_DUMP_LIVE },
199         { "color",    BE_CH_DUMP_COLOR },
200         { "copymin",  BE_CH_DUMP_COPYMIN },
201         { "ssadestr", BE_CH_DUMP_SSADESTR },
202         { "tree",     BE_CH_DUMP_TREE_INTV },
203         { "constr",   BE_CH_DUMP_CONSTR },
204         { "lower",    BE_CH_DUMP_LOWER },
205         { NULL, 0 }
206 };
207
208 static lc_opt_enum_int_var_t spill_var = {
209         &options.spill_method, spill_items
210 };
211
212 static lc_opt_enum_int_var_t copymin_var = {
213         &options.copymin_method, copymin_items
214 };
215
216 static lc_opt_enum_int_var_t ifg_flavor_var = {
217         &options.spill_method, ifg_flavor_items
218 };
219
220 static lc_opt_enum_int_var_t lower_perm_var = {
221         &options.lower_perm_method, lower_perm_items
222 };
223
224 static lc_opt_enum_int_var_t dump_var = {
225         &options.dump_flags, dump_items
226 };
227
228 static void be_ra_chordal_register_options(lc_opt_entry_t *grp)
229 {
230         grp = lc_opt_get_grp(grp, "chordal");
231 }
232 #endif
233
234 static void dump(unsigned mask, ir_graph *irg,
235                                  const arch_register_class_t *cls,
236                                  const char *suffix,
237                                  void (*dump_func)(ir_graph *, const char *))
238 {
239         if(1 || ((options.dump_flags & mask) == mask)) {
240                 if(cls) {
241                         char buf[256];
242                         snprintf(buf, sizeof(buf), "-%s%s", cls->name, suffix);
243                         dump_func(irg, buf);
244                 }
245
246                 else
247                         dump_func(irg, suffix);
248         }
249 }
250
251 static void be_ra_chordal_main(const be_irg_t *bi)
252 {
253         int j, m;
254         be_chordal_env_t chordal_env;
255         ir_graph *irg = bi->irg;
256         const be_main_env_t *main_env = bi->main_env;
257         const arch_isa_t *isa = arch_env_get_isa(main_env->arch_env);
258
259         compute_doms(irg);
260
261         chordal_env.opts         = &options;
262         chordal_env.irg          = irg;
263         chordal_env.dbg          = firm_dbg_register("firm.be.chordal");
264         chordal_env.birg                 = bi;
265         chordal_env.dom_front    = be_compute_dominance_frontiers(irg);
266
267         obstack_init(&chordal_env.obst);
268
269         /* Perform the following for each register class. */
270         for(j = 0, m = arch_isa_get_n_reg_class(isa); j < m; ++j) {
271                 chordal_env.cls          = arch_isa_get_reg_class(isa, j);
272                 chordal_env.border_heads = pmap_create();
273
274                 be_liveness(irg);
275                 dump(BE_CH_DUMP_LIVE, irg, chordal_env.cls, "-live", dump_ir_block_graph_sched);
276
277                 /* spilling */
278                 switch(options.spill_method) {
279                 case BE_CH_SPILL_BELADY:
280                         be_spill_belady(&chordal_env);
281                         break;
282 #ifdef WITH_ILP
283                 case BE_CH_SPILL_ILP:
284                         be_spill_ilp(&chordal_env);
285                         break;
286 #endif /* WITH_ILP */
287                 default:
288                         fprintf(stderr, "no valid spiller selected. falling back to belady\n");
289                         be_spill_belady(&chordal_env);
290                 }
291                 dump(BE_CH_DUMP_SPILL, irg, chordal_env.cls, "-spill", dump_ir_block_graph_sched);
292                 be_liveness(irg);
293                 be_check_pressure(&chordal_env);
294
295                 be_liveness(irg);
296                 be_check_pressure(&chordal_env);
297
298                 /* Color the graph. */
299                 be_ra_chordal_color(&chordal_env);
300                 dump(BE_CH_DUMP_CONSTR, irg, chordal_env.cls, "-color", dump_ir_block_graph_sched);
301
302                 /* Build the interference graph. */
303                 chordal_env.ifg = be_ifg_std_new(&chordal_env);
304                 be_ifg_check(chordal_env.ifg);
305
306                 /* copy minimization */
307                 copystat_collect_cls(&chordal_env);
308 #ifdef COPYOPT_STAT
309                 co_compare_solvers(&chordal_env);
310 #else
311                 {
312                 copy_opt_t *co = new_copy_opt(&chordal_env, co_get_costs_loop_depth);
313                 co_solve_heuristic(co);
314                 free_copy_opt(co);
315                 }
316 #endif
317                 dump(BE_CH_DUMP_COPYMIN, irg, chordal_env.cls, "-copymin", dump_ir_block_graph_sched);
318                 be_ra_chordal_check(&chordal_env);
319
320                 /* ssa destruction */
321                 be_ssa_destruction(&chordal_env);
322                 dump(BE_CH_DUMP_SSADESTR, irg, chordal_env.cls, "-ssadestr", dump_ir_block_graph_sched);
323                 be_ssa_destruction_check(&chordal_env);
324 //              be_ra_chordal_check(&chordal_env);
325
326                 copystat_dump(irg);
327
328                 be_ifg_free(chordal_env.ifg);
329
330                 pmap_destroy(chordal_env.border_heads);
331         }
332
333         be_compute_spill_offsets(&chordal_env);
334
335         dump(BE_CH_DUMP_LOWER, irg, NULL, "-spilloff", dump_ir_block_graph_sched);
336
337         lower_nodes_after_ra(&chordal_env, options.lower_perm_method == BE_CH_LOWER_PERM_COPY ? 1 : 0);
338         dump(BE_CH_DUMP_LOWER, irg, NULL, "-belower-after-ra", dump_ir_block_graph_sched);
339
340         obstack_free(&chordal_env.obst, NULL);
341         be_free_dominance_frontiers(chordal_env.dom_front);
342 }
343
344 const be_ra_t be_ra_chordal_allocator = {
345 #ifdef WITH_LIBCORE
346         be_ra_chordal_register_options,
347 #endif
348         be_ra_chordal_main
349 };