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