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