b8d817811706d652287eb86f21f7d47ad254b8fe
[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  * @version     $Id$
26  */
27 #include "config.h"
28
29 #include "irtools.h"
30 #include "irprintf.h"
31
32 #include "bestatevent.h"
33 #include "beirg_t.h"
34 #include "bemodule.h"
35 #include "error.h"
36
37 #include "lc_opts.h"
38 #include "lc_opts_enum.h"
39
40 #ifdef WITH_ILP
41
42 #define DUMP_ILP 1
43 #define DUMP_SOL 2
44
45 static int time_limit = 60;
46 static int solve_net  = 1;
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     ("net",   "solve over the net", &solve_net),
63         LC_OPT_ENT_BOOL     ("log",   "show ilp solving log",              &solve_log),
64         LC_OPT_ENT_ENUM_MASK("dump",  "dump flags",             &dump_var),
65         LC_OPT_LAST
66 };
67
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 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_copyilp);
80
81 #include "becopyilp_t.h"
82 #include "beifg_t.h"
83
84 /******************************************************************************
85     _____ _                        _            _   _
86    / ____(_)                      | |          | | (_)
87   | (___  _ _______   _ __ ___  __| |_   _  ___| |_ _  ___  _ __
88    \___ \| |_  / _ \ | '__/ _ \/ _` | | | |/ __| __| |/ _ \| '_ \
89    ____) | |/ /  __/ | | |  __/ (_| | |_| | (__| |_| | (_) | | | |
90   |_____/|_/___\___| |_|  \___|\__,_|\__,_|\___|\__|_|\___/|_| |_|
91
92  *****************************************************************************/
93
94
95 size_red_t *new_size_red(copy_opt_t *co) {
96         size_red_t *res = XMALLOC(size_red_t);
97
98         res->co = co;
99         res->all_removed = pset_new_ptr_default();
100         res->col_suff = NULL;
101         obstack_init(&res->ob);
102
103         return res;
104 }
105
106 /**
107  * Checks if a node is simplicial in the graph heeding the already removed nodes.
108  */
109 static inline int sr_is_simplicial(size_red_t *sr, const ir_node *ifn) {
110         int i, o, size = 0;
111         ir_node **all, *curr;
112         be_ifg_t *ifg = sr->co->cenv->ifg;
113         void *iter = be_ifg_neighbours_iter_alloca(ifg);
114
115         all = alloca(be_ifg_degree(ifg, ifn) * sizeof(*all));
116
117         /* get all non-removed neighbors */
118         be_ifg_foreach_neighbour(ifg, iter, ifn, curr)
119                 if (!sr_is_removed(sr, curr))
120                         all[size++] = curr;
121
122         /* check if these form a clique */
123         for (i=0; i<size; ++i)
124                 for (o=i+1; o<size; ++o)
125                         if (!be_ifg_connected(ifg, all[i], all[o]))
126                                 return 0;
127
128         /* all edges exist so this is a clique */
129         return 1;
130 }
131
132 void sr_remove(size_red_t *sr) {
133         ir_node *irn;
134         int redo = 1;
135         const be_ifg_t *ifg = sr->co->cenv->ifg;
136         void *iter = be_ifg_nodes_iter_alloca(ifg);
137
138         while (redo) {
139                 redo = 0;
140                 be_ifg_foreach_node(ifg, iter, irn) {
141                         const arch_register_req_t *req = arch_get_register_req(irn, -1);
142
143                         if (!arch_register_req_is(req, limited) && !sr_is_removed(sr, irn) && !co_gs_is_optimizable(sr->co, irn)) {
144                                 if (sr_is_simplicial(sr, irn)) {
145                                         coloring_suffix_t *cs = obstack_alloc(&sr->ob, sizeof(*cs));
146
147                                         cs->irn = irn;
148                                         cs->next = sr->col_suff;
149                                         sr->col_suff = cs;
150
151                                         pset_insert_ptr(sr->all_removed, irn);
152
153                                         redo = 1;
154                                 }
155                         }
156                 }
157         }
158 }
159
160 void sr_reinsert(size_red_t *sr) {
161         coloring_suffix_t *cs;
162         be_ifg_t *ifg        = sr->co->cenv->ifg;
163         bitset_t *used_cols  = bitset_alloca(arch_register_class_n_regs(sr->co->cls));
164         void *iter           = be_ifg_neighbours_iter_alloca(ifg);
165
166         /* color the removed nodes in right order */
167         for (cs = sr->col_suff; cs; cs = cs->next) {
168                 int free_col;
169                 ir_node *other, *irn;
170
171                 /* get free color by inspecting all neighbors */
172                 irn = cs->irn;
173                 bitset_clear_all(used_cols);
174
175                 be_ifg_foreach_neighbour(ifg, iter, irn, other) {
176                         if (!sr_is_removed(sr, other)) /* only inspect nodes which are in graph right now */
177                                 bitset_set(used_cols, get_irn_col(other));
178                 }
179
180                 /* now all bits not set are possible colors */
181                 free_col = bitset_next_clear(used_cols, 0);
182                 assert(free_col != -1 && "No free color found. This can not be.");
183                 set_irn_col(sr->co, irn, free_col);
184                 pset_remove_ptr(sr->all_removed, irn); /* irn is back in graph again */
185         }
186 }
187
188 void free_size_red(size_red_t *sr) {
189         del_pset(sr->all_removed);
190         obstack_free(&sr->ob, NULL);
191         free(sr);
192 }
193
194 /******************************************************************************
195     _____                      _        _____ _      _____
196    / ____|                    (_)      |_   _| |    |  __ \
197   | |  __  ___ _ __   ___ _ __ _  ___    | | | |    | |__) |
198   | | |_ |/ _ \ '_ \ / _ \ '__| |/ __|   | | | |    |  ___/
199   | |__| |  __/ | | |  __/ |  | | (__   _| |_| |____| |
200    \_____|\___|_| |_|\___|_|  |_|\___| |_____|______|_|
201
202  *****************************************************************************/
203
204 #include <stdio.h>
205
206 ilp_env_t *new_ilp_env(copy_opt_t *co, ilp_callback build, ilp_callback apply, void *env) {
207         ilp_env_t *res = XMALLOC(ilp_env_t);
208
209         res->co         = co;
210         res->build      = build;
211         res->apply      = apply;
212         res->env        = env;
213         res->sr         = new_size_red(co);
214
215         return res;
216 }
217
218 lpp_sol_state_t ilp_go(ilp_env_t *ienv) {
219         be_main_env_t *main_env = ienv->co->cenv->birg->main_env;
220
221         sr_remove(ienv->sr);
222
223         ienv->build(ienv);
224         lpp_set_time_limit(ienv->lp, time_limit);
225
226         if(solve_log)
227                 lpp_set_log(ienv->lp, stdout);
228
229         if(solve_net)
230                 lpp_solve_net(ienv->lp, main_env->options->ilp_server, main_env->options->ilp_solver);
231         else {
232 #ifdef LPP_SOLVE_NET
233                 fprintf(stderr, "can only solve ilp over the net\n");
234 #else
235                 lpp_solve_cplex(ienv->lp);
236 #endif
237         }
238
239         be_stat_ev_dbl("co_ilp_objval",     ienv->lp->objval);
240         be_stat_ev_dbl("co_ilp_best_bound", ienv->lp->best_bound);
241         be_stat_ev    ("co_ilp_iter",       ienv->lp->iterations);
242         be_stat_ev_dbl("co_ilp_sol_time",   ienv->lp->sol_time);
243
244         if(dump_flags & DUMP_ILP) {
245                 char buf[128];
246                 FILE *f;
247
248                 ir_snprintf(buf, sizeof(buf), "%F_%s-co.ilp", ienv->co->cenv->irg,
249                             ienv->co->cenv->cls->name);
250                 f = fopen(buf, "wt");
251                 if(f == NULL) {
252                         panic("Couldn't open '%s' for writing", buf);
253                 }
254                 lpp_dump_plain(ienv->lp, f);
255                 fclose(f);
256         }
257
258         ienv->apply(ienv);
259
260         sr_reinsert(ienv->sr);
261
262         return lpp_get_sol_state(ienv->lp);
263 }
264
265 void free_ilp_env(ilp_env_t *ienv) {
266         free_size_red(ienv->sr);
267         free_lpp(ienv->lp);
268         free(ienv);
269 }
270
271 #else /* WITH_ILP */
272
273 static inline void only_that_you_can_compile_without_WITH_ILP_defined(void) {
274 }
275
276 #endif /* WITH_ILP */