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