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