beifg: Let be_ifg_foreach_node() declare its iterator internally.
[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 "irtools.h"
18 #include "irprintf.h"
19
20 #include "statev_t.h"
21 #include "bemodule.h"
22 #include "error.h"
23
24 #include "lpp.h"
25
26 #include "lc_opts.h"
27 #include "lc_opts_enum.h"
28
29 #define DUMP_ILP 1
30 #define DUMP_SOL 2
31
32 static int time_limit = 60;
33 static int solve_log  = 0;
34 static unsigned dump_flags = 0;
35
36 static const lc_opt_enum_mask_items_t dump_items[] = {
37         { "ilp",   DUMP_ILP },
38         { "sol",   DUMP_SOL },
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 size_red_t *new_size_red(copy_opt_t *co)
80 {
81         size_red_t *res = XMALLOC(size_red_t);
82
83         res->co = co;
84         res->all_removed = pset_new_ptr_default();
85         res->col_suff = NULL;
86         obstack_init(&res->ob);
87
88         return res;
89 }
90
91 /**
92  * Checks if a node is simplicial in the graph heeding the already removed nodes.
93  */
94 static inline bool sr_is_simplicial(size_red_t *sr, const ir_node *ifn)
95 {
96         be_ifg_t *ifg  = sr->co->cenv->ifg;
97         neighbours_iter_t iter;
98         ir_node **all  = ALLOCAN(ir_node*, be_ifg_degree(ifg, ifn));
99         int       size = 0;
100         int       i;
101         int       o;
102
103         /* get all non-removed neighbors */
104         be_ifg_foreach_neighbour(ifg, &iter, ifn, curr)
105                 if (!sr_is_removed(sr, curr))
106                         all[size++] = curr;
107
108         /* check if these form a clique */
109         for (i=0; i<size; ++i)
110                 for (o=i+1; o<size; ++o)
111                         if (!be_ifg_connected(ifg, all[i], all[o]))
112                                 return false;
113
114         /* all edges exist so this is a clique */
115         return true;
116 }
117
118 void sr_remove(size_red_t *sr)
119 {
120         bool redo = true;
121         const be_ifg_t *ifg = sr->co->cenv->ifg;
122
123         while (redo) {
124                 redo = false;
125                 be_ifg_foreach_node(ifg, irn) {
126                         const arch_register_req_t *req = arch_get_irn_register_req(irn);
127                         coloring_suffix_t *cs;
128
129                         if (arch_register_req_is(req, limited) || sr_is_removed(sr, irn))
130                                 continue;
131                         if (co_gs_is_optimizable(sr->co, irn))
132                                 continue;
133                         if (!sr_is_simplicial(sr, irn))
134                                 continue;
135
136                         cs = OALLOC(&sr->ob, coloring_suffix_t);
137                         cs->irn = irn;
138                         cs->next = sr->col_suff;
139                         sr->col_suff = cs;
140
141                         pset_insert_ptr(sr->all_removed, irn);
142
143                         redo = true;
144                 }
145         }
146 }
147
148 void sr_reinsert(size_red_t *sr)
149 {
150         coloring_suffix_t *cs;
151         ir_graph *irg        = sr->co->irg;
152         be_ifg_t *ifg        = sr->co->cenv->ifg;
153         unsigned  n_regs     = arch_register_class_n_regs(sr->co->cls);
154
155         unsigned *const allocatable_cols = rbitset_alloca(n_regs);
156         be_set_allocatable_regs(irg, sr->co->cls, allocatable_cols);
157
158         unsigned *const possible_cols = rbitset_alloca(n_regs);
159         neighbours_iter_t iter;
160
161         /* color the removed nodes in right order */
162         for (cs = sr->col_suff; cs; cs = cs->next) {
163                 unsigned free_col;
164                 ir_node *irn = cs->irn;
165
166                 rbitset_copy(possible_cols, allocatable_cols, n_regs);
167
168                 /* get free color by inspecting all neighbors */
169                 be_ifg_foreach_neighbour(ifg, &iter, irn, other) {
170                         const arch_register_req_t *cur_req;
171                         unsigned cur_col;
172
173                         /* only inspect nodes which are in graph right now */
174                         if (sr_is_removed(sr, other))
175                                 continue;
176
177                         cur_req = arch_get_irn_register_req(other);
178                         cur_col = get_irn_col(other);
179
180                         /* Invalidate all single size register when it is a large one */
181                         do  {
182                                 rbitset_clear(possible_cols, cur_col);
183                                 ++cur_col;
184                         } while ((cur_col % cur_req->width) != 0);
185                 }
186
187                 /* now all bits not set are possible colors */
188                 /* take one that matches the alignment constraint */
189                 free_col = 0;
190                 assert(!rbitset_is_empty(possible_cols, n_regs) && "No free color found. This can not be.");
191                 while (true) {
192                         free_col = (unsigned)rbitset_next(possible_cols, free_col, true);
193                         if (free_col % arch_get_irn_register_req(irn)->width == 0)
194                                 break;
195                         ++free_col;
196                         assert(free_col < n_regs);
197                 }
198                 set_irn_col(sr->co->cls, irn, free_col);
199                 pset_remove_ptr(sr->all_removed, irn); /* irn is back in graph again */
200         }
201 }
202
203 void free_size_red(size_red_t *sr)
204 {
205         del_pset(sr->all_removed);
206         obstack_free(&sr->ob, NULL);
207         free(sr);
208 }
209
210 /******************************************************************************
211     _____                      _        _____ _      _____
212    / ____|                    (_)      |_   _| |    |  __ \
213   | |  __  ___ _ __   ___ _ __ _  ___    | | | |    | |__) |
214   | | |_ |/ _ \ '_ \ / _ \ '__| |/ __|   | | | |    |  ___/
215   | |__| |  __/ | | |  __/ |  | | (__   _| |_| |____| |
216    \_____|\___|_| |_|\___|_|  |_|\___| |_____|______|_|
217
218  *****************************************************************************/
219
220 #include <stdio.h>
221
222 ilp_env_t *new_ilp_env(copy_opt_t *co, ilp_callback build, ilp_callback apply, void *env)
223 {
224         ilp_env_t *res = XMALLOC(ilp_env_t);
225
226         res->co         = co;
227         res->build      = build;
228         res->apply      = apply;
229         res->env        = env;
230         res->sr         = new_size_red(co);
231
232         return res;
233 }
234
235 lpp_sol_state_t ilp_go(ilp_env_t *ienv)
236 {
237         ir_graph *irg = ienv->co->irg;
238
239         sr_remove(ienv->sr);
240
241         ienv->build(ienv);
242
243         if (dump_flags & DUMP_ILP) {
244                 char buf[128];
245                 FILE *f;
246
247                 ir_snprintf(buf, sizeof(buf), "%F_%s-co.ilp", irg,
248                             ienv->co->cenv->cls->name);
249                 f = fopen(buf, "wt");
250                 if (f == NULL) {
251                         panic("Couldn't open '%s' for writing", buf);
252                 }
253                 lpp_dump_plain(ienv->lp, f);
254                 fclose(f);
255         }
256
257         lpp_set_time_limit(ienv->lp, time_limit);
258         if (solve_log)
259                 lpp_set_log(ienv->lp, stdout);
260
261         lpp_solve(ienv->lp, be_options.ilp_server, be_options.ilp_solver);
262
263         //stat_ev_dbl("co_ilp_objval",     ienv->lp->objval);
264         //stat_ev_dbl("co_ilp_best_bound", ienv->lp->best_bound);
265         stat_ev_int("co_ilp_iter",       lpp_get_iter_cnt(ienv->lp));
266         stat_ev_dbl("co_ilp_sol_time",   lpp_get_sol_time(ienv->lp));
267
268         ienv->apply(ienv);
269
270         sr_reinsert(ienv->sr);
271
272         return lpp_get_sol_state(ienv->lp);
273 }
274
275 void free_ilp_env(ilp_env_t *ienv)
276 {
277         free_size_red(ienv->sr);
278         lpp_free(ienv->lp);
279         free(ienv);
280 }