becopyheur4: Clean up co_mst_irn_init().
[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
33 static int time_limit = 60;
34 static int solve_log  = 0;
35 static unsigned dump_flags = 0;
36
37 static const lc_opt_enum_mask_items_t dump_items[] = {
38         { "ilp", DUMP_ILP },
39         { NULL, 0 }
40 };
41
42 static lc_opt_enum_mask_var_t dump_var = {
43         &dump_flags, dump_items
44 };
45
46 static const lc_opt_table_entry_t options[] = {
47         LC_OPT_ENT_INT      ("limit", "time limit for solving in seconds (0 for unlimited)", &time_limit),
48         LC_OPT_ENT_BOOL     ("log",   "show ilp solving log",              &solve_log),
49         LC_OPT_ENT_ENUM_MASK("dump",  "dump flags",             &dump_var),
50         LC_OPT_LAST
51 };
52
53 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_copyilp)
54 void be_init_copyilp(void)
55 {
56         lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
57         lc_opt_entry_t *ra_grp = lc_opt_get_grp(be_grp, "ra");
58         lc_opt_entry_t *chordal_grp = lc_opt_get_grp(ra_grp, "chordal");
59         lc_opt_entry_t *co_grp = lc_opt_get_grp(chordal_grp, "co");
60         lc_opt_entry_t *ilp_grp = lc_opt_get_grp(co_grp, "ilp");
61
62         lc_opt_add_table(ilp_grp, options);
63 }
64
65 #include "becopyilp_t.h"
66 #include "beifg.h"
67
68 /******************************************************************************
69     _____ _                        _            _   _
70    / ____(_)                      | |          | | (_)
71   | (___  _ _______   _ __ ___  __| |_   _  ___| |_ _  ___  _ __
72    \___ \| |_  / _ \ | '__/ _ \/ _` | | | |/ __| __| |/ _ \| '_ \
73    ____) | |/ /  __/ | | |  __/ (_| | |_| | (__| |_| | (_) | | | |
74   |_____/|_/___\___| |_|  \___|\__,_|\__,_|\___|\__|_|\___/|_| |_|
75
76  *****************************************************************************/
77
78
79 /**
80  * Checks if a node is simplicial in the graph heeding the already removed nodes.
81  */
82 static inline bool sr_is_simplicial(ilp_env_t *const ienv, ir_node const *const ifn)
83 {
84         bool              res = true;
85         ir_node         **all = NEW_ARR_F(ir_node*, 0);
86         be_lv_t    *const lv  = be_get_irg_liveness(ienv->co->irg);
87         neighbours_iter_t iter;
88         be_ifg_foreach_neighbour(ienv->co->cenv->ifg, &iter, ifn, curr) {
89                 /* Only consider non-removed neighbours. */
90                 if (sr_is_removed(ienv, curr))
91                         continue;
92
93                 /* Check whether the current node forms a clique with all previous nodes. */
94                 for (size_t i = ARR_LEN(all); i-- != 0;) {
95                         if (!be_values_interfere(lv, curr, all[i])) {
96                                 res = false;
97                                 goto end;
98                         }
99                 }
100
101                 ARR_APP1(ir_node*, all, curr);
102         }
103
104 end:
105         DEL_ARR_F(all);
106         return res;
107 }
108
109 /**
110  * Virtually remove all nodes not related to the problem
111  * (simplicial AND not adjacent to a equal-color-edge)
112  */
113 static void sr_remove(ilp_env_t *const ienv)
114 {
115         bool redo = true;
116         const be_ifg_t *ifg = ienv->co->cenv->ifg;
117
118         while (redo) {
119                 redo = false;
120                 be_ifg_foreach_node(ifg, irn) {
121                         const arch_register_req_t *req = arch_get_irn_register_req(irn);
122                         if (arch_register_req_is(req, limited) || sr_is_removed(ienv, irn))
123                                 continue;
124                         if (co_gs_is_optimizable(ienv->co, irn))
125                                 continue;
126                         if (!sr_is_simplicial(ienv, irn))
127                                 continue;
128
129                         ARR_APP1(ir_node*, ienv->col_suff, irn);
130                         ir_nodeset_insert(&ienv->all_removed, irn);
131
132                         redo = true;
133                 }
134         }
135 }
136
137 /**
138  * Virtually reinsert the nodes removed before and color them
139  */
140 static void sr_reinsert(ilp_env_t *const ienv)
141 {
142         /* color the removed nodes in right order */
143         unsigned        const n_regs           = arch_register_class_n_regs(ienv->co->cls);
144         unsigned       *const possible_cols    = rbitset_alloca(n_regs);
145         unsigned const *const allocatable_cols = ienv->co->cenv->allocatable_regs->data;
146         be_ifg_t const *const ifg              = ienv->co->cenv->ifg;
147         for (size_t i = ARR_LEN(ienv->col_suff); i-- != 0;) {
148                 ir_node *const irn = ienv->col_suff[i];
149
150                 rbitset_copy(possible_cols, allocatable_cols, n_regs);
151
152                 /* get free color by inspecting all neighbors */
153                 neighbours_iter_t iter;
154                 be_ifg_foreach_neighbour(ifg, &iter, irn, other) {
155                         const arch_register_req_t *cur_req;
156                         unsigned cur_col;
157
158                         /* only inspect nodes which are in graph right now */
159                         if (sr_is_removed(ienv, other))
160                                 continue;
161
162                         cur_req = arch_get_irn_register_req(other);
163                         cur_col = get_irn_col(other);
164
165                         /* Invalidate all single size register when it is a large one */
166                         do  {
167                                 rbitset_clear(possible_cols, cur_col);
168                                 ++cur_col;
169                         } while ((cur_col % cur_req->width) != 0);
170                 }
171
172                 /* now all bits not set are possible colors */
173                 /* take one that matches the alignment constraint */
174                 unsigned free_col;
175                 assert(!rbitset_is_empty(possible_cols, n_regs) && "No free color found. This can not be.");
176                 for (;;) {
177                         free_col = (unsigned)rbitset_next(possible_cols, free_col, true);
178                         if (free_col % arch_get_irn_register_req(irn)->width == 0)
179                                 break;
180                         ++free_col;
181                         assert(free_col < n_regs);
182                 }
183                 set_irn_col(ienv->co->cls, irn, free_col);
184                 ir_nodeset_remove(&ienv->all_removed, irn); /* irn is back in graph again */
185         }
186 }
187
188 /******************************************************************************
189     _____                      _        _____ _      _____
190    / ____|                    (_)      |_   _| |    |  __ \
191   | |  __  ___ _ __   ___ _ __ _  ___    | | | |    | |__) |
192   | | |_ |/ _ \ '_ \ / _ \ '__| |/ __|   | | | |    |  ___/
193   | |__| |  __/ | | |  __/ |  | | (__   _| |_| |____| |
194    \_____|\___|_| |_|\___|_|  |_|\___| |_____|______|_|
195
196  *****************************************************************************/
197
198 #include <stdio.h>
199
200 ilp_env_t *new_ilp_env(copy_opt_t *co, ilp_callback build, ilp_callback apply, void *env)
201 {
202         ilp_env_t *res = XMALLOC(ilp_env_t);
203
204         res->co         = co;
205         res->build      = build;
206         res->apply      = apply;
207         res->env        = env;
208         res->col_suff   = NEW_ARR_F(ir_node*, 0);
209         ir_nodeset_init(&res->all_removed);
210
211         return res;
212 }
213
214 lpp_sol_state_t ilp_go(ilp_env_t *ienv)
215 {
216         ir_graph *irg = ienv->co->irg;
217
218         sr_remove(ienv);
219
220         ienv->build(ienv);
221
222         if (dump_flags & DUMP_ILP) {
223                 char buf[128];
224                 FILE *f;
225
226                 ir_snprintf(buf, sizeof(buf), "%F_%s-co.ilp", irg,
227                             ienv->co->cenv->cls->name);
228                 f = fopen(buf, "wt");
229                 if (f == NULL) {
230                         panic("Couldn't open '%s' for writing", buf);
231                 }
232                 lpp_dump_plain(ienv->lp, f);
233                 fclose(f);
234         }
235
236         lpp_set_time_limit(ienv->lp, time_limit);
237         if (solve_log)
238                 lpp_set_log(ienv->lp, stdout);
239
240         lpp_solve(ienv->lp, be_options.ilp_server, be_options.ilp_solver);
241
242         //stat_ev_dbl("co_ilp_objval",     ienv->lp->objval);
243         //stat_ev_dbl("co_ilp_best_bound", ienv->lp->best_bound);
244         stat_ev_int("co_ilp_iter",       lpp_get_iter_cnt(ienv->lp));
245         stat_ev_dbl("co_ilp_sol_time",   lpp_get_sol_time(ienv->lp));
246
247         ienv->apply(ienv);
248
249         sr_reinsert(ienv);
250
251         return lpp_get_sol_state(ienv->lp);
252 }
253
254 void free_ilp_env(ilp_env_t *ienv)
255 {
256         ir_nodeset_destroy(&ienv->all_removed);
257         DEL_ARR_F(ienv->col_suff);
258         lpp_free(ienv->lp);
259         free(ienv);
260 }