we always have liblpp now, remove WITH_ILP flag
[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 #define DUMP_ILP 1
41 #define DUMP_SOL 2
42
43 static int time_limit = 60;
44 static int solve_log  = 0;
45 static unsigned dump_flags = 0;
46
47 static const lc_opt_enum_mask_items_t dump_items[] = {
48         { "ilp",   DUMP_ILP },
49         { "sol",   DUMP_SOL },
50         { NULL,    0 }
51 };
52
53 static lc_opt_enum_mask_var_t dump_var = {
54         &dump_flags, dump_items
55 };
56
57 static const lc_opt_table_entry_t options[] = {
58         LC_OPT_ENT_INT      ("limit", "time limit for solving in seconds (0 for unlimited)", &time_limit),
59         LC_OPT_ENT_BOOL     ("log",   "show ilp solving log",              &solve_log),
60         LC_OPT_ENT_ENUM_MASK("dump",  "dump flags",             &dump_var),
61         LC_OPT_LAST
62 };
63
64 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_copyilp);
65 void be_init_copyilp(void)
66 {
67         lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
68         lc_opt_entry_t *ra_grp = lc_opt_get_grp(be_grp, "ra");
69         lc_opt_entry_t *chordal_grp = lc_opt_get_grp(ra_grp, "chordal");
70         lc_opt_entry_t *co_grp = lc_opt_get_grp(chordal_grp, "co");
71         lc_opt_entry_t *ilp_grp = lc_opt_get_grp(co_grp, "ilp");
72
73         lc_opt_add_table(ilp_grp, options);
74 }
75
76 #include "becopyilp_t.h"
77 #include "beifg.h"
78
79 /******************************************************************************
80     _____ _                        _            _   _
81    / ____(_)                      | |          | | (_)
82   | (___  _ _______   _ __ ___  __| |_   _  ___| |_ _  ___  _ __
83    \___ \| |_  / _ \ | '__/ _ \/ _` | | | |/ __| __| |/ _ \| '_ \
84    ____) | |/ /  __/ | | |  __/ (_| | |_| | (__| |_| | (_) | | | |
85   |_____/|_/___\___| |_|  \___|\__,_|\__,_|\___|\__|_|\___/|_| |_|
86
87  *****************************************************************************/
88
89
90 size_red_t *new_size_red(copy_opt_t *co)
91 {
92         size_red_t *res = XMALLOC(size_red_t);
93
94         res->co = co;
95         res->all_removed = pset_new_ptr_default();
96         res->col_suff = NULL;
97         obstack_init(&res->ob);
98
99         return res;
100 }
101
102 /**
103  * Checks if a node is simplicial in the graph heeding the already removed nodes.
104  */
105 static inline int sr_is_simplicial(size_red_t *sr, const ir_node *ifn)
106 {
107         be_ifg_t *ifg  = sr->co->cenv->ifg;
108         neighbours_iter_t iter;
109         ir_node **all  = ALLOCAN(ir_node*, be_ifg_degree(ifg, ifn));
110         ir_node  *curr;
111         int       size = 0;
112         int       i;
113         int       o;
114
115         /* get all non-removed neighbors */
116         be_ifg_foreach_neighbour(ifg, &iter, ifn, curr)
117                 if (!sr_is_removed(sr, curr))
118                         all[size++] = curr;
119
120         /* check if these form a clique */
121         for (i=0; i<size; ++i)
122                 for (o=i+1; o<size; ++o)
123                         if (!be_ifg_connected(ifg, all[i], all[o]))
124                                 return 0;
125
126         /* all edges exist so this is a clique */
127         return 1;
128 }
129
130 void sr_remove(size_red_t *sr)
131 {
132         ir_node *irn;
133         int redo = 1;
134         const be_ifg_t *ifg = sr->co->cenv->ifg;
135         nodes_iter_t iter;
136
137         while (redo) {
138                 redo = 0;
139                 be_ifg_foreach_node(ifg, &iter, irn) {
140                         const arch_register_req_t *req = arch_get_register_req_out(irn);
141
142                         if (!arch_register_req_is(req, limited) && !sr_is_removed(sr, irn) && !co_gs_is_optimizable(sr->co, irn)) {
143                                 if (sr_is_simplicial(sr, irn)) {
144                                         coloring_suffix_t *cs = OALLOC(&sr->ob, coloring_suffix_t);
145
146                                         cs->irn = irn;
147                                         cs->next = sr->col_suff;
148                                         sr->col_suff = cs;
149
150                                         pset_insert_ptr(sr->all_removed, irn);
151
152                                         redo = 1;
153                                 }
154                         }
155                 }
156         }
157 }
158
159 void sr_reinsert(size_red_t *sr)
160 {
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         neighbours_iter_t iter;
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 {
190         del_pset(sr->all_removed);
191         obstack_free(&sr->ob, NULL);
192         free(sr);
193 }
194
195 /******************************************************************************
196     _____                      _        _____ _      _____
197    / ____|                    (_)      |_   _| |    |  __ \
198   | |  __  ___ _ __   ___ _ __ _  ___    | | | |    | |__) |
199   | | |_ |/ _ \ '_ \ / _ \ '__| |/ __|   | | | |    |  ___/
200   | |__| |  __/ | | |  __/ |  | | (__   _| |_| |____| |
201    \_____|\___|_| |_|\___|_|  |_|\___| |_____|______|_|
202
203  *****************************************************************************/
204
205 #include <stdio.h>
206
207 ilp_env_t *new_ilp_env(copy_opt_t *co, ilp_callback build, ilp_callback apply, void *env)
208 {
209         ilp_env_t *res = XMALLOC(ilp_env_t);
210
211         res->co         = co;
212         res->build      = build;
213         res->apply      = apply;
214         res->env        = env;
215         res->sr         = new_size_red(co);
216
217         return res;
218 }
219
220 lpp_sol_state_t ilp_go(ilp_env_t *ienv)
221 {
222         be_options_t *options = be_get_irg_options(ienv->co->irg);
223
224         sr_remove(ienv->sr);
225
226         ienv->build(ienv);
227         lpp_set_time_limit(ienv->lp, time_limit);
228
229         if (solve_log)
230                 lpp_set_log(ienv->lp, stdout);
231
232         lpp_solve_net(ienv->lp, options->ilp_server, options->ilp_solver);
233
234         //be_stat_ev_dbl("co_ilp_objval",     ienv->lp->objval);
235         //be_stat_ev_dbl("co_ilp_best_bound", ienv->lp->best_bound);
236         be_stat_ev    ("co_ilp_iter",       lpp_get_iter_cnt(ienv->lp));
237         be_stat_ev_dbl("co_ilp_sol_time",   lpp_get_sol_time(ienv->lp));
238
239         if (dump_flags & DUMP_ILP) {
240                 char buf[128];
241                 FILE *f;
242
243                 ir_snprintf(buf, sizeof(buf), "%F_%s-co.ilp", ienv->co->cenv->irg,
244                             ienv->co->cenv->cls->name);
245                 f = fopen(buf, "wt");
246                 if (f == NULL) {
247                         panic("Couldn't open '%s' for writing", buf);
248                 }
249                 lpp_dump_plain(ienv->lp, f);
250                 fclose(f);
251         }
252
253         ienv->apply(ienv);
254
255         sr_reinsert(ienv->sr);
256
257         return lpp_get_sol_state(ienv->lp);
258 }
259
260 void free_ilp_env(ilp_env_t *ienv)
261 {
262         free_size_red(ienv->sr);
263         free_lpp(ienv->lp);
264         free(ienv);
265 }