beifg: Collect ifg statistics in one pass instead of two.
[libfirm] / ir / be / becopyilp.c
1 /*
2  * This file is part of libFirm.
3  * Copyright (C) 2012 University of Karlsruhe.
4  */
5
6 /**
7  * @file
8  * @brief       Common stuff used by all ILP formulations.
9  * @author      Daniel Grund
10  * @date        28.02.2006
11  */
12 #include "config.h"
13
14 #include <stdbool.h>
15
16 #include "be_t.h"
17 #include "beintlive_t.h"
18 #include "beirg.h"
19 #include "irtools.h"
20 #include "irprintf.h"
21
22 #include "statev_t.h"
23 #include "bemodule.h"
24 #include "error.h"
25
26 #include "lpp.h"
27
28 #include "lc_opts.h"
29 #include "lc_opts_enum.h"
30
31 #define DUMP_ILP 1
32 #define DUMP_SOL 2
33
34 static int time_limit = 60;
35 static int solve_log  = 0;
36 static unsigned dump_flags = 0;
37
38 static const lc_opt_enum_mask_items_t dump_items[] = {
39         { "ilp",   DUMP_ILP },
40         { "sol",   DUMP_SOL },
41         { NULL,    0 }
42 };
43
44 static lc_opt_enum_mask_var_t dump_var = {
45         &dump_flags, dump_items
46 };
47
48 static const lc_opt_table_entry_t options[] = {
49         LC_OPT_ENT_INT      ("limit", "time limit for solving in seconds (0 for unlimited)", &time_limit),
50         LC_OPT_ENT_BOOL     ("log",   "show ilp solving log",              &solve_log),
51         LC_OPT_ENT_ENUM_MASK("dump",  "dump flags",             &dump_var),
52         LC_OPT_LAST
53 };
54
55 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_copyilp)
56 void be_init_copyilp(void)
57 {
58         lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
59         lc_opt_entry_t *ra_grp = lc_opt_get_grp(be_grp, "ra");
60         lc_opt_entry_t *chordal_grp = lc_opt_get_grp(ra_grp, "chordal");
61         lc_opt_entry_t *co_grp = lc_opt_get_grp(chordal_grp, "co");
62         lc_opt_entry_t *ilp_grp = lc_opt_get_grp(co_grp, "ilp");
63
64         lc_opt_add_table(ilp_grp, options);
65 }
66
67 #include "becopyilp_t.h"
68 #include "beifg.h"
69
70 /******************************************************************************
71     _____ _                        _            _   _
72    / ____(_)                      | |          | | (_)
73   | (___  _ _______   _ __ ___  __| |_   _  ___| |_ _  ___  _ __
74    \___ \| |_  / _ \ | '__/ _ \/ _` | | | |/ __| __| |/ _ \| '_ \
75    ____) | |/ /  __/ | | |  __/ (_| | |_| | (__| |_| | (_) | | | |
76   |_____/|_/___\___| |_|  \___|\__,_|\__,_|\___|\__|_|\___/|_| |_|
77
78  *****************************************************************************/
79
80
81 size_red_t *new_size_red(copy_opt_t *co)
82 {
83         size_red_t *res = XMALLOC(size_red_t);
84
85         res->co = co;
86         res->all_removed = pset_new_ptr_default();
87         res->col_suff = NULL;
88         obstack_init(&res->ob);
89
90         return res;
91 }
92
93 /**
94  * Checks if a node is simplicial in the graph heeding the already removed nodes.
95  */
96 static inline bool sr_is_simplicial(size_red_t *sr, const ir_node *ifn)
97 {
98         be_ifg_t *ifg  = sr->co->cenv->ifg;
99         neighbours_iter_t iter;
100         ir_node **all  = ALLOCAN(ir_node*, be_ifg_degree(ifg, ifn));
101         int       size = 0;
102         int       i;
103         int       o;
104
105         /* get all non-removed neighbors */
106         be_ifg_foreach_neighbour(ifg, &iter, ifn, curr)
107                 if (!sr_is_removed(sr, curr))
108                         all[size++] = curr;
109
110         /* check if these form a clique */
111         be_lv_t *const lv = be_get_irg_liveness(sr->co->irg);
112         for (i = 0; i < size; ++i) {
113                 for (o = i + 1; o < size; ++o) {
114                         if (!be_values_interfere(lv, all[i], all[o]))
115                                 return false;
116                 }
117         }
118
119         /* all edges exist so this is a clique */
120         return true;
121 }
122
123 void sr_remove(size_red_t *sr)
124 {
125         bool redo = true;
126         const be_ifg_t *ifg = sr->co->cenv->ifg;
127
128         while (redo) {
129                 redo = false;
130                 be_ifg_foreach_node(ifg, irn) {
131                         const arch_register_req_t *req = arch_get_irn_register_req(irn);
132                         coloring_suffix_t *cs;
133
134                         if (arch_register_req_is(req, limited) || sr_is_removed(sr, irn))
135                                 continue;
136                         if (co_gs_is_optimizable(sr->co, irn))
137                                 continue;
138                         if (!sr_is_simplicial(sr, irn))
139                                 continue;
140
141                         cs = OALLOC(&sr->ob, coloring_suffix_t);
142                         cs->irn = irn;
143                         cs->next = sr->col_suff;
144                         sr->col_suff = cs;
145
146                         pset_insert_ptr(sr->all_removed, irn);
147
148                         redo = true;
149                 }
150         }
151 }
152
153 void sr_reinsert(size_red_t *sr)
154 {
155         coloring_suffix_t *cs;
156         ir_graph *irg        = sr->co->irg;
157         be_ifg_t *ifg        = sr->co->cenv->ifg;
158         unsigned  n_regs     = arch_register_class_n_regs(sr->co->cls);
159
160         unsigned *const allocatable_cols = rbitset_alloca(n_regs);
161         be_set_allocatable_regs(irg, sr->co->cls, allocatable_cols);
162
163         unsigned *const possible_cols = rbitset_alloca(n_regs);
164         neighbours_iter_t iter;
165
166         /* color the removed nodes in right order */
167         for (cs = sr->col_suff; cs; cs = cs->next) {
168                 unsigned free_col;
169                 ir_node *irn = cs->irn;
170
171                 rbitset_copy(possible_cols, allocatable_cols, n_regs);
172
173                 /* get free color by inspecting all neighbors */
174                 be_ifg_foreach_neighbour(ifg, &iter, irn, other) {
175                         const arch_register_req_t *cur_req;
176                         unsigned cur_col;
177
178                         /* only inspect nodes which are in graph right now */
179                         if (sr_is_removed(sr, other))
180                                 continue;
181
182                         cur_req = arch_get_irn_register_req(other);
183                         cur_col = get_irn_col(other);
184
185                         /* Invalidate all single size register when it is a large one */
186                         do  {
187                                 rbitset_clear(possible_cols, cur_col);
188                                 ++cur_col;
189                         } while ((cur_col % cur_req->width) != 0);
190                 }
191
192                 /* now all bits not set are possible colors */
193                 /* take one that matches the alignment constraint */
194                 free_col = 0;
195                 assert(!rbitset_is_empty(possible_cols, n_regs) && "No free color found. This can not be.");
196                 while (true) {
197                         free_col = (unsigned)rbitset_next(possible_cols, free_col, true);
198                         if (free_col % arch_get_irn_register_req(irn)->width == 0)
199                                 break;
200                         ++free_col;
201                         assert(free_col < n_regs);
202                 }
203                 set_irn_col(sr->co->cls, irn, free_col);
204                 pset_remove_ptr(sr->all_removed, irn); /* irn is back in graph again */
205         }
206 }
207
208 void free_size_red(size_red_t *sr)
209 {
210         del_pset(sr->all_removed);
211         obstack_free(&sr->ob, NULL);
212         free(sr);
213 }
214
215 /******************************************************************************
216     _____                      _        _____ _      _____
217    / ____|                    (_)      |_   _| |    |  __ \
218   | |  __  ___ _ __   ___ _ __ _  ___    | | | |    | |__) |
219   | | |_ |/ _ \ '_ \ / _ \ '__| |/ __|   | | | |    |  ___/
220   | |__| |  __/ | | |  __/ |  | | (__   _| |_| |____| |
221    \_____|\___|_| |_|\___|_|  |_|\___| |_____|______|_|
222
223  *****************************************************************************/
224
225 #include <stdio.h>
226
227 ilp_env_t *new_ilp_env(copy_opt_t *co, ilp_callback build, ilp_callback apply, void *env)
228 {
229         ilp_env_t *res = XMALLOC(ilp_env_t);
230
231         res->co         = co;
232         res->build      = build;
233         res->apply      = apply;
234         res->env        = env;
235         res->sr         = new_size_red(co);
236
237         return res;
238 }
239
240 lpp_sol_state_t ilp_go(ilp_env_t *ienv)
241 {
242         ir_graph *irg = ienv->co->irg;
243
244         sr_remove(ienv->sr);
245
246         ienv->build(ienv);
247
248         if (dump_flags & DUMP_ILP) {
249                 char buf[128];
250                 FILE *f;
251
252                 ir_snprintf(buf, sizeof(buf), "%F_%s-co.ilp", irg,
253                             ienv->co->cenv->cls->name);
254                 f = fopen(buf, "wt");
255                 if (f == NULL) {
256                         panic("Couldn't open '%s' for writing", buf);
257                 }
258                 lpp_dump_plain(ienv->lp, f);
259                 fclose(f);
260         }
261
262         lpp_set_time_limit(ienv->lp, time_limit);
263         if (solve_log)
264                 lpp_set_log(ienv->lp, stdout);
265
266         lpp_solve(ienv->lp, be_options.ilp_server, be_options.ilp_solver);
267
268         //stat_ev_dbl("co_ilp_objval",     ienv->lp->objval);
269         //stat_ev_dbl("co_ilp_best_bound", ienv->lp->best_bound);
270         stat_ev_int("co_ilp_iter",       lpp_get_iter_cnt(ienv->lp));
271         stat_ev_dbl("co_ilp_sol_time",   lpp_get_sol_time(ienv->lp));
272
273         ienv->apply(ienv);
274
275         sr_reinsert(ienv->sr);
276
277         return lpp_get_sol_state(ienv->lp);
278 }
279
280 void free_ilp_env(ilp_env_t *ienv)
281 {
282         free_size_red(ienv->sr);
283         lpp_free(ienv->lp);
284         free(ienv);
285 }