Remove the unused parameter const arch_env_t *env from arch_get_irn_register().
[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 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif /* HAVE_CONFIG_H */
30
31 #include "irtools.h"
32 #include "irprintf.h"
33
34 #include "bestatevent.h"
35 #include "beirg_t.h"
36 #include "bemodule.h"
37 #include "error.h"
38
39 #include "lc_opts.h"
40 #include "lc_opts_enum.h"
41
42 #ifdef WITH_ILP
43
44 #define DUMP_ILP 1
45 #define DUMP_SOL 2
46
47 static int time_limit = 60;
48 static int solve_net  = 1;
49 static int solve_log  = 0;
50 static unsigned dump_flags = 0;
51
52 static const lc_opt_enum_mask_items_t dump_items[] = {
53         { "ilp",   DUMP_ILP },
54         { "sol",   DUMP_SOL },
55         { NULL,    0 }
56 };
57
58 static lc_opt_enum_mask_var_t dump_var = {
59         &dump_flags, dump_items
60 };
61
62 static const lc_opt_table_entry_t options[] = {
63         LC_OPT_ENT_INT      ("limit", "time limit for solving in seconds (0 for unlimited)", &time_limit),
64         LC_OPT_ENT_BOOL     ("net",   "solve over the net", &solve_net),
65         LC_OPT_ENT_BOOL     ("log",   "show ilp solving log",              &solve_log),
66         LC_OPT_ENT_ENUM_MASK("dump",  "dump flags",             &dump_var),
67         LC_OPT_LAST
68 };
69
70 void be_init_copyilp(void)
71 {
72         lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
73         lc_opt_entry_t *ra_grp = lc_opt_get_grp(be_grp, "ra");
74         lc_opt_entry_t *chordal_grp = lc_opt_get_grp(ra_grp, "chordal");
75         lc_opt_entry_t *co_grp = lc_opt_get_grp(chordal_grp, "co");
76         lc_opt_entry_t *ilp_grp = lc_opt_get_grp(co_grp, "ilp");
77
78         lc_opt_add_table(ilp_grp, options);
79 }
80
81 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_copyilp);
82
83 #include "becopyilp_t.h"
84 #include "beifg_t.h"
85
86 /******************************************************************************
87     _____ _                        _            _   _
88    / ____(_)                      | |          | | (_)
89   | (___  _ _______   _ __ ___  __| |_   _  ___| |_ _  ___  _ __
90    \___ \| |_  / _ \ | '__/ _ \/ _` | | | |/ __| __| |/ _ \| '_ \
91    ____) | |/ /  __/ | | |  __/ (_| | |_| | (__| |_| | (_) | | | |
92   |_____/|_/___\___| |_|  \___|\__,_|\__,_|\___|\__|_|\___/|_| |_|
93
94  *****************************************************************************/
95
96
97 size_red_t *new_size_red(copy_opt_t *co) {
98         size_red_t *res = XMALLOC(size_red_t);
99
100         res->co = co;
101         res->all_removed = pset_new_ptr_default();
102         res->col_suff = NULL;
103         obstack_init(&res->ob);
104
105         return res;
106 }
107
108 /**
109  * Checks if a node is simplicial in the graph heeding the already removed nodes.
110  */
111 static INLINE int sr_is_simplicial(size_red_t *sr, const ir_node *ifn) {
112         int i, o, size = 0;
113         ir_node **all, *curr;
114         be_ifg_t *ifg = sr->co->cenv->ifg;
115         void *iter = be_ifg_neighbours_iter_alloca(ifg);
116
117         all = alloca(be_ifg_degree(ifg, ifn) * sizeof(*all));
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         ir_node *irn;
136         int redo = 1;
137         const be_ifg_t *ifg = sr->co->cenv->ifg;
138         void *iter = be_ifg_nodes_iter_alloca(ifg);
139
140         while (redo) {
141                 redo = 0;
142                 be_ifg_foreach_node(ifg, iter, irn) {
143                         const arch_register_req_t *req = arch_get_register_req(irn, -1);
144
145                         if (!arch_register_req_is(req, limited) && !sr_is_removed(sr, irn) && !co_gs_is_optimizable(sr->co, irn)) {
146                                 if (sr_is_simplicial(sr, irn)) {
147                                         coloring_suffix_t *cs = obstack_alloc(&sr->ob, sizeof(*cs));
148
149                                         cs->irn = irn;
150                                         cs->next = sr->col_suff;
151                                         sr->col_suff = cs;
152
153                                         pset_insert_ptr(sr->all_removed, irn);
154
155                                         redo = 1;
156                                 }
157                         }
158                 }
159         }
160 }
161
162 void sr_reinsert(size_red_t *sr) {
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         void *iter           = be_ifg_neighbours_iter_alloca(ifg);
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         del_pset(sr->all_removed);
192         obstack_free(&sr->ob, NULL);
193         free(sr);
194 }
195
196 /******************************************************************************
197     _____                      _        _____ _      _____
198    / ____|                    (_)      |_   _| |    |  __ \
199   | |  __  ___ _ __   ___ _ __ _  ___    | | | |    | |__) |
200   | | |_ |/ _ \ '_ \ / _ \ '__| |/ __|   | | | |    |  ___/
201   | |__| |  __/ | | |  __/ |  | | (__   _| |_| |____| |
202    \_____|\___|_| |_|\___|_|  |_|\___| |_____|______|_|
203
204  *****************************************************************************/
205
206 #include <stdio.h>
207
208 ilp_env_t *new_ilp_env(copy_opt_t *co, ilp_callback build, ilp_callback apply, void *env) {
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         be_main_env_t *main_env = ienv->co->cenv->birg->main_env;
222
223         sr_remove(ienv->sr);
224
225         ienv->build(ienv);
226         lpp_set_time_limit(ienv->lp, time_limit);
227
228         if(solve_log)
229                 lpp_set_log(ienv->lp, stdout);
230
231         if(solve_net)
232                 lpp_solve_net(ienv->lp, main_env->options->ilp_server, main_env->options->ilp_solver);
233         else {
234 #ifdef LPP_SOLVE_NET
235                 fprintf(stderr, "can only solve ilp over the net\n");
236 #else
237                 lpp_solve_cplex(ienv->lp);
238 #endif
239         }
240
241         be_stat_ev_dbl("co_ilp_objval",     ienv->lp->objval);
242         be_stat_ev_dbl("co_ilp_best_bound", ienv->lp->best_bound);
243         be_stat_ev    ("co_ilp_iter",       ienv->lp->iterations);
244         be_stat_ev_dbl("co_ilp_sol_time",   ienv->lp->sol_time);
245
246         if(dump_flags & DUMP_ILP) {
247                 char buf[128];
248                 FILE *f;
249
250                 ir_snprintf(buf, sizeof(buf), "%F_%s-co.ilp", ienv->co->cenv->irg,
251                             ienv->co->cenv->cls->name);
252                 f = fopen(buf, "wt");
253                 if(f == NULL) {
254                         panic("Couldn't open '%s' for writing", buf);
255                 }
256                 lpp_dump_plain(ienv->lp, f);
257                 fclose(f);
258         }
259
260         ienv->apply(ienv);
261
262         sr_reinsert(ienv->sr);
263
264         return lpp_get_sol_state(ienv->lp);
265 }
266
267 void free_ilp_env(ilp_env_t *ienv) {
268         free_size_red(ienv->sr);
269         free_lpp(ienv->lp);
270         free(ienv);
271 }
272
273 #else /* WITH_ILP */
274
275 static INLINE void only_that_you_can_compile_without_WITH_ILP_defined(void) {
276 }
277
278 #endif /* WITH_ILP */