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