7d9c0fd6674d33f5d1a013b3c1b60233f80c6e92
[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.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 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_copyilp);
69 void be_init_copyilp(void)
70 {
71         lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
72         lc_opt_entry_t *ra_grp = lc_opt_get_grp(be_grp, "ra");
73         lc_opt_entry_t *chordal_grp = lc_opt_get_grp(ra_grp, "chordal");
74         lc_opt_entry_t *co_grp = lc_opt_get_grp(chordal_grp, "co");
75         lc_opt_entry_t *ilp_grp = lc_opt_get_grp(co_grp, "ilp");
76
77         lc_opt_add_table(ilp_grp, options);
78 }
79
80 #include "becopyilp_t.h"
81 #include "beifg_t.h"
82
83 /******************************************************************************
84     _____ _                        _            _   _
85    / ____(_)                      | |          | | (_)
86   | (___  _ _______   _ __ ___  __| |_   _  ___| |_ _  ___  _ __
87    \___ \| |_  / _ \ | '__/ _ \/ _` | | | |/ __| __| |/ _ \| '_ \
88    ____) | |/ /  __/ | | |  __/ (_| | |_| | (__| |_| | (_) | | | |
89   |_____/|_/___\___| |_|  \___|\__,_|\__,_|\___|\__|_|\___/|_| |_|
90
91  *****************************************************************************/
92
93
94 size_red_t *new_size_red(copy_opt_t *co)
95 {
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 {
111         be_ifg_t *ifg  = sr->co->cenv->ifg;
112         void     *iter = be_ifg_neighbours_iter_alloca(ifg);
113         ir_node **all  = ALLOCAN(ir_node*, be_ifg_degree(ifg, ifn));
114         ir_node  *curr;
115         int       size = 0;
116         int       i;
117         int       o;
118
119         /* get all non-removed neighbors */
120         be_ifg_foreach_neighbour(ifg, iter, ifn, curr)
121                 if (!sr_is_removed(sr, curr))
122                         all[size++] = curr;
123
124         /* check if these form a clique */
125         for (i=0; i<size; ++i)
126                 for (o=i+1; o<size; ++o)
127                         if (!be_ifg_connected(ifg, all[i], all[o]))
128                                 return 0;
129
130         /* all edges exist so this is a clique */
131         return 1;
132 }
133
134 void sr_remove(size_red_t *sr)
135 {
136         ir_node *irn;
137         int redo = 1;
138         const be_ifg_t *ifg = sr->co->cenv->ifg;
139         void *iter = be_ifg_nodes_iter_alloca(ifg);
140
141         while (redo) {
142                 redo = 0;
143                 be_ifg_foreach_node(ifg, iter, irn) {
144                         const arch_register_req_t *req = arch_get_register_req_out(irn);
145
146                         if (!arch_register_req_is(req, limited) && !sr_is_removed(sr, irn) && !co_gs_is_optimizable(sr->co, irn)) {
147                                 if (sr_is_simplicial(sr, irn)) {
148                                         coloring_suffix_t *cs = OALLOC(&sr->ob, coloring_suffix_t);
149
150                                         cs->irn = irn;
151                                         cs->next = sr->col_suff;
152                                         sr->col_suff = cs;
153
154                                         pset_insert_ptr(sr->all_removed, irn);
155
156                                         redo = 1;
157                                 }
158                         }
159                 }
160         }
161 }
162
163 void sr_reinsert(size_red_t *sr)
164 {
165         coloring_suffix_t *cs;
166         be_ifg_t *ifg        = sr->co->cenv->ifg;
167         bitset_t *used_cols  = bitset_alloca(arch_register_class_n_regs(sr->co->cls));
168         void *iter           = be_ifg_neighbours_iter_alloca(ifg);
169
170         /* color the removed nodes in right order */
171         for (cs = sr->col_suff; cs; cs = cs->next) {
172                 int free_col;
173                 ir_node *other, *irn;
174
175                 /* get free color by inspecting all neighbors */
176                 irn = cs->irn;
177                 bitset_clear_all(used_cols);
178
179                 be_ifg_foreach_neighbour(ifg, iter, irn, other) {
180                         if (!sr_is_removed(sr, other)) /* only inspect nodes which are in graph right now */
181                                 bitset_set(used_cols, get_irn_col(other));
182                 }
183
184                 /* now all bits not set are possible colors */
185                 free_col = bitset_next_clear(used_cols, 0);
186                 assert(free_col != -1 && "No free color found. This can not be.");
187                 set_irn_col(sr->co, irn, free_col);
188                 pset_remove_ptr(sr->all_removed, irn); /* irn is back in graph again */
189         }
190 }
191
192 void free_size_red(size_red_t *sr)
193 {
194         del_pset(sr->all_removed);
195         obstack_free(&sr->ob, NULL);
196         free(sr);
197 }
198
199 /******************************************************************************
200     _____                      _        _____ _      _____
201    / ____|                    (_)      |_   _| |    |  __ \
202   | |  __  ___ _ __   ___ _ __ _  ___    | | | |    | |__) |
203   | | |_ |/ _ \ '_ \ / _ \ '__| |/ __|   | | | |    |  ___/
204   | |__| |  __/ | | |  __/ |  | | (__   _| |_| |____| |
205    \_____|\___|_| |_|\___|_|  |_|\___| |_____|______|_|
206
207  *****************************************************************************/
208
209 #include <stdio.h>
210
211 ilp_env_t *new_ilp_env(copy_opt_t *co, ilp_callback build, ilp_callback apply, void *env)
212 {
213         ilp_env_t *res = XMALLOC(ilp_env_t);
214
215         res->co         = co;
216         res->build      = build;
217         res->apply      = apply;
218         res->env        = env;
219         res->sr         = new_size_red(co);
220
221         return res;
222 }
223
224 lpp_sol_state_t ilp_go(ilp_env_t *ienv)
225 {
226         be_main_env_t *main_env = ienv->co->cenv->birg->main_env;
227
228         sr_remove(ienv->sr);
229
230         ienv->build(ienv);
231         lpp_set_time_limit(ienv->lp, time_limit);
232
233         if (solve_log)
234                 lpp_set_log(ienv->lp, stdout);
235
236         if (solve_net)
237                 lpp_solve_net(ienv->lp, main_env->options->ilp_server, main_env->options->ilp_solver);
238         else {
239 #ifdef LPP_SOLVE_NET
240                 fprintf(stderr, "can only solve ilp over the net\n");
241 #else
242                 lpp_solve_cplex(ienv->lp);
243 #endif
244         }
245
246         be_stat_ev_dbl("co_ilp_objval",     ienv->lp->objval);
247         be_stat_ev_dbl("co_ilp_best_bound", ienv->lp->best_bound);
248         be_stat_ev    ("co_ilp_iter",       ienv->lp->iterations);
249         be_stat_ev_dbl("co_ilp_sol_time",   ienv->lp->sol_time);
250
251         if (dump_flags & DUMP_ILP) {
252                 char buf[128];
253                 FILE *f;
254
255                 ir_snprintf(buf, sizeof(buf), "%F_%s-co.ilp", ienv->co->cenv->irg,
256                             ienv->co->cenv->cls->name);
257                 f = fopen(buf, "wt");
258                 if (f == NULL) {
259                         panic("Couldn't open '%s' for writing", buf);
260                 }
261                 lpp_dump_plain(ienv->lp, f);
262                 fclose(f);
263         }
264
265         ienv->apply(ienv);
266
267         sr_reinsert(ienv->sr);
268
269         return lpp_get_sol_state(ienv->lp);
270 }
271
272 void free_ilp_env(ilp_env_t *ienv)
273 {
274         free_size_red(ienv->sr);
275         free_lpp(ienv->lp);
276         free(ienv);
277 }
278
279 #else /* WITH_ILP */
280
281 static inline void only_that_you_can_compile_without_WITH_ILP_defined(void)
282 {
283 }
284
285 #endif /* WITH_ILP */