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