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