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