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