2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief ILP based copy minimization.
23 * @author Daniel Grund
27 * ILP formalization using G=(V, E, Q):
28 * - 2 class of variables: coloring vars x_ic and equal color vars y_ij
30 * - Clique-star constraints
33 * \min \sum_{ (i,j) \in Q } w_ij y_ij
35 * \sum_c x_nc = 1 n \in N, c \in C
37 * x_nc = 0 n \in N, c \not\in C(n)
39 * \sum x_nc <= 1 x_nc \in Clique \in AllCliques, c \in C
41 * \sum_{e \in p} y_e >= 1 p \in P path constraints
43 * \sum_{e \in cs} y_e >= |cs| - 1 cs \in CP clique-star constraints
45 * x_nc, y_ij \in N, w_ij \in R^+
52 #include "raw_bitset.h"
57 #include "becopyilp_t.h"
59 #include "besched_t.h"
63 typedef struct _local_env_t {
65 int first_x_var, last_x_var;
67 bitset_t *normal_colors;
69 DEBUG_ONLY(firm_dbg_module_t *dbg;)
72 static void build_coloring_cstr(ilp_env_t *ienv) {
73 be_ifg_t *ifg = ienv->co->cenv->ifg;
74 void *iter = be_ifg_nodes_iter_alloca(ifg);
79 colors = bitset_alloca(arch_register_class_n_regs(ienv->co->cls));
81 be_ifg_foreach_node(ifg, iter, irn)
82 if (!sr_is_removed(ienv->sr, irn)) {
85 const arch_register_req_t *req;
86 int curr_node_color = get_irn_col(irn);
87 int node_nr = (int)get_irn_idx(irn);
88 local_env_t *lenv = ienv->env;
90 pmap_insert(lenv->nr_2_irn, INT_TO_PTR(node_nr), irn);
92 req = arch_get_register_req_out(irn);
94 bitset_clear_all(colors);
96 /* get assignable colors */
97 if (arch_register_req_is(req, limited)) {
98 rbitset_copy_to_bitset(req->limited, colors);
100 bitset_copy(colors, lenv->normal_colors);
103 /* add the coloring constraint */
104 cst_idx = lpp_add_cst(ienv->lp, NULL, lpp_equal, 1.0);
106 bitset_foreach(colors, col) {
107 int var_idx = lpp_add_var(ienv->lp, name_cdd(buf, 'x', node_nr, col), lpp_binary, 0.0);
108 lpp_set_start_value(ienv->lp, var_idx, (col == (unsigned) curr_node_color) ? 1.0 : 0.0);
109 lpp_set_factor_fast(ienv->lp, cst_idx, var_idx, 1);
111 lenv->last_x_var = var_idx;
112 if (lenv->first_x_var == -1)
113 lenv->first_x_var = var_idx;
116 /* add register constraint constraints */
117 bitset_foreach_clear(colors, col) {
118 int cst_idx = lpp_add_cst(ienv->lp, NULL, lpp_equal, 0.0);
119 int var_idx = lpp_add_var(ienv->lp, name_cdd(buf, 'x', node_nr, col), lpp_binary, 0.0);
120 lpp_set_start_value(ienv->lp, var_idx, 0.0);
121 lpp_set_factor_fast(ienv->lp, cst_idx, var_idx, 1);
123 lenv->last_x_var = var_idx;
128 static void build_interference_cstr(ilp_env_t *ienv)
130 lpp_t *lpp = ienv->lp;
131 local_env_t *lenv = ienv->env;
132 be_ifg_t *ifg = ienv->co->cenv->ifg;
133 int n_colors = lenv->n_colors;
134 void *iter = be_ifg_cliques_iter_alloca(ifg);
135 ir_node **clique = ALLOCAN(ir_node*, n_colors);
142 /* for each maximal clique */
143 be_ifg_foreach_clique(ifg, iter, clique, &size) {
146 for (i=0; i<size; ++i)
147 if (!sr_is_removed(ienv->sr, clique[i]))
154 for (col=0; col<n_colors; ++col) {
155 int cst_idx = lpp_add_cst(lpp, NULL, lpp_less, 1.0);
157 /* for each member of this clique */
158 for (i=0; i<size; ++i) {
159 ir_node *irn = clique[i];
161 if (!sr_is_removed(ienv->sr, irn)) {
162 int var_idx = lpp_get_var_idx(lpp, name_cdd(buf, 'x', (int)get_irn_idx(irn), col));
163 lpp_set_factor_fast(lpp, cst_idx, var_idx, 1);
172 * TODO: Remove the dependency of the opt-units data structure
173 * by walking over all affinity edges. Graph structure
174 * does not provide this walker, yet.
176 static void build_affinity_cstr(ilp_env_t *ienv) {
177 local_env_t *lenv = ienv->env;
178 int n_colors = lenv->n_colors;
181 /* for all optimization units */
182 list_for_each_entry(unit_t, curr, &ienv->co->units, units) {
184 int root_nr, arg_nr, i, col, y_idx, root_idx, arg_idx;
186 int root_col, arg_col;
188 root = curr->nodes[0];
189 root_nr = (int) get_irn_idx(root);
190 root_col = get_irn_col(root);
192 for (i = 1; i < curr->node_count; ++i) {
193 arg = curr->nodes[i];
194 arg_nr = (int) get_irn_idx(arg);
195 arg_col = get_irn_col(arg);
197 /* add a new affinity variable */
198 y_idx = lpp_add_var(ienv->lp, name_cdd_sorted(buf, 'y', root_nr, arg_nr), lpp_binary, curr->costs[i]);
199 lpp_set_start_value(ienv->lp, y_idx, (root_col==arg_col) ? 0.0 : 1.0);
201 /* add constraints relating the affinity var to the color vars */
202 for (col=0; col<n_colors; ++col) {
203 int cst_idx = lpp_add_cst(ienv->lp, NULL, lpp_less, 0.0);
204 root_idx = lpp_get_var_idx(ienv->lp, name_cdd(buf, 'x', root_nr, col));
205 arg_idx = lpp_get_var_idx(ienv->lp, name_cdd(buf, 'x', arg_nr, col));
207 lpp_set_factor_fast(ienv->lp, cst_idx, root_idx, 1.0);
208 lpp_set_factor_fast(ienv->lp, cst_idx, arg_idx, -1.0);
209 lpp_set_factor_fast(ienv->lp, cst_idx, y_idx, -1.0);
216 * Helping stuff for build_clique_star_cstr
218 typedef struct _edge_t {
222 static int compare_edge_t(const void *k1, const void *k2, size_t size) {
223 const edge_t *e1 = k1;
224 const edge_t *e2 = k2;
227 return ! (e1->n1 == e2->n1 && e1->n2 == e2->n2);
230 #define HASH_EDGE(e) (hash_irn((e)->n1) ^ hash_irn((e)->n2))
232 static inline edge_t *add_edge(set *edges, ir_node *n1, ir_node *n2, int *counter) {
235 if (PTR_TO_INT(n1) < PTR_TO_INT(n2)) {
243 return set_insert(edges, &new_edge, sizeof(new_edge), HASH_EDGE(&new_edge));
246 static inline edge_t *find_edge(set *edges, ir_node *n1, ir_node *n2) {
249 if (PTR_TO_INT(n1) < PTR_TO_INT(n2)) {
256 return set_find(edges, &new_edge, sizeof(new_edge), HASH_EDGE(&new_edge));
259 static inline void remove_edge(set *edges, ir_node *n1, ir_node *n2, int *counter) {
262 if (PTR_TO_INT(n1) < PTR_TO_INT(n2)) {
269 e = set_find(edges, &new_edge, sizeof(new_edge), HASH_EDGE(&new_edge));
277 #define pset_foreach(pset, irn) for(irn=pset_first(pset); irn; irn=pset_next(pset))
280 * Search for an interference clique and an external node
281 * with affinity edges to all nodes of the clique.
282 * At most 1 node of the clique can be colored equally with the external node.
284 static void build_clique_star_cstr(ilp_env_t *ienv) {
285 affinity_node_t *aff;
287 /* for each node with affinity edges */
288 co_gs_foreach_aff_node(ienv->co, aff) {
291 const ir_node *center = aff->irn;
294 int i, o, n_nodes, n_edges;
296 if (arch_irn_is_ignore(aff->irn))
300 edges = new_set(compare_edge_t, 8);
302 /* get all affinity neighbours */
304 co_gs_foreach_neighb(aff, nbr) {
305 if (!arch_irn_is_ignore(nbr->irn)) {
306 obstack_ptr_grow(&ob, nbr->irn);
310 nodes = obstack_finish(&ob);
312 /* get all interference edges between these */
314 for (i=0; i<n_nodes; ++i)
316 if (be_ifg_connected(ienv->co->cenv->ifg, nodes[i], nodes[o]))
317 add_edge(edges, nodes[i], nodes[o], &n_edges);
319 /* cover all these interference edges with maximal cliques */
322 pset *clique = pset_new_ptr(8);
325 /* get 2 starting nodes to form a clique */
326 for (e=set_first(edges); !e->n1; e=set_next(edges))
329 /* we could be stepped out of the loop before the set iterated to the end */
332 pset_insert_ptr(clique, e->n1);
333 pset_insert_ptr(clique, e->n2);
334 remove_edge(edges, e->n1, e->n2, &n_edges);
336 /* while the clique is growing */
340 /* search for a candidate to extend the clique */
341 for (i=0; i<n_nodes; ++i) {
342 ir_node *member, *cand = nodes[i];
345 /* if its already in the clique try the next */
346 if (pset_find_ptr(clique, cand))
349 /* are there all necessary interferences? */
351 pset_foreach(clique, member) {
352 if (!find_edge(edges, cand, member)) {
359 /* now we know if we have a clique extender */
361 /* first remove all covered edges */
362 pset_foreach(clique, member)
363 remove_edge(edges, cand, member, &n_edges);
365 /* insert into clique */
366 pset_insert_ptr(clique, cand);
373 /* now the clique is maximal. Finally add the constraint */
376 int var_idx, cst_idx, center_nr, member_nr;
379 cst_idx = lpp_add_cst(ienv->lp, NULL, lpp_greater, pset_count(clique)-1);
380 center_nr = get_irn_idx(center);
382 pset_foreach(clique, member) {
383 member_nr = get_irn_idx(member);
384 var_idx = lpp_get_var_idx(ienv->lp, name_cdd_sorted(buf, 'y', center_nr, member_nr));
385 lpp_set_factor_fast(ienv->lp, cst_idx, var_idx, 1.0);
393 obstack_free(&ob, NULL);
398 static void extend_path(ilp_env_t *ienv, pdeq *path, const ir_node *irn) {
399 be_ifg_t *ifg = ienv->co->cenv->ifg;
402 affinity_node_t *aff;
405 /* do not walk backwards or in circles */
406 if (pdeq_contains(path, irn))
409 if (arch_irn_is_ignore(irn))
412 /* insert the new irn */
413 pdeq_putr(path, irn);
417 /* check for forbidden interferences */
418 len = pdeq_len(path);
419 curr_path = ALLOCAN(ir_node*, len);
420 pdeq_copyl(path, (const void **)curr_path);
422 for (i=1; i<len; ++i)
423 if (be_ifg_connected(ifg, irn, curr_path[i]))
428 /* check for terminating interference */
429 if (be_ifg_connected(ifg, irn, curr_path[0])) {
431 /* One node is not a path. */
432 /* And a path of length 2 is covered by a clique star constraint. */
434 /* finally build the constraint */
435 int cst_idx = lpp_add_cst(ienv->lp, NULL, lpp_greater, 1.0);
436 for (i=1; i<len; ++i) {
438 int nr_1 = get_irn_idx(curr_path[i-1]);
439 int nr_2 = get_irn_idx(curr_path[i]);
440 int var_idx = lpp_get_var_idx(ienv->lp, name_cdd_sorted(buf, 'y', nr_1, nr_2));
441 lpp_set_factor_fast(ienv->lp, cst_idx, var_idx, 1.0);
445 /* this path cannot be extended anymore */
451 /* recursively extend the path */
452 aff = get_affinity_info(ienv->co, irn);
453 co_gs_foreach_neighb(aff, nbr)
454 extend_path(ienv, path, nbr->irn);
464 * Search a path of affinity edges, whose ends are connected
465 * by an interference edge and there are no other interference
467 * Then at least one of these affinity edges must break.
469 static void build_path_cstr(ilp_env_t *ienv) {
470 affinity_node_t *aff_info;
472 /* for each node with affinity edges */
473 co_gs_foreach_aff_node(ienv->co, aff_info) {
474 pdeq *path = new_pdeq();
476 extend_path(ienv, path, aff_info->irn);
482 static void ilp2_build(ilp_env_t *ienv) {
483 local_env_t *lenv = ienv->env;
486 ienv->lp = new_lpp(ienv->co->name, lpp_minimize);
487 build_coloring_cstr(ienv);
488 build_interference_cstr(ienv);
489 build_affinity_cstr(ienv);
490 build_clique_star_cstr(ienv);
491 build_path_cstr(ienv);
493 lower_bound = co_get_lower_bound(ienv->co) - co_get_inevit_copy_costs(ienv->co);
494 lpp_set_bound(ienv->lp, lower_bound);
495 lpp_set_time_limit(ienv->lp, lenv->time_limit);
498 static void ilp2_apply(ilp_env_t *ienv) {
499 local_env_t *lenv = ienv->env;
502 /* first check if there was sth. to optimize */
503 if (lenv->first_x_var >= 0) {
504 int count = lenv->last_x_var - lenv->first_x_var + 1;
505 double *sol = XMALLOCN(double, count);
506 lpp_sol_state_t state = lpp_get_solution(ienv->lp, sol, lenv->first_x_var, lenv->last_x_var);
508 if (state != lpp_optimal) {
509 printf("WARNING %s: Solution state is not 'optimal': %d\n", ienv->co->name, state);
510 assert(state >= lpp_feasible && "The solution should at least be feasible!");
513 for (i=0; i<count; ++i) {
517 if (sol[i] > 1-EPSILON) { /* split variable name into components */
518 lpp_get_var_name(ienv->lp, lenv->first_x_var+i, var_name, sizeof(var_name));
520 if (sscanf(var_name, "x_%d_%d", &nodenr, &color) == 2) {
521 ir_node *irn = pmap_get(lenv->nr_2_irn, INT_TO_PTR(nodenr));
522 assert(irn && "This node number must be present in the map");
524 set_irn_col(ienv->co, irn, color);
526 assert(0 && "This should be a x-var");
534 /* TODO adapt to multiple possible ILPs */
535 copystat_add_ilp_time((int)(1000.0*lpp_get_sol_time(pi->curr_lp))); //now we have ms
536 copystat_add_ilp_vars(lpp_get_var_count(pi->curr_lp));
537 copystat_add_ilp_csts(lpp_get_cst_count(pi->curr_lp));
538 copystat_add_ilp_iter(lpp_get_iter_cnt(pi->curr_lp));
542 int co_solve_ilp2(copy_opt_t *co) {
543 lpp_sol_state_t sol_state;
547 ASSERT_OU_AVAIL(co); //See build_clique_st
553 my.nr_2_irn = pmap_create();
554 FIRM_DBG_REGISTER(my.dbg, "firm.be.coilp2");
556 my.normal_colors = bitset_alloca(arch_register_class_n_regs(co->cls));
557 bitset_clear_all(my.normal_colors);
558 arch_put_non_ignore_regs(co->cls, my.normal_colors);
559 my.n_colors = bitset_popcnt(my.normal_colors);
561 ienv = new_ilp_env(co, ilp2_build, ilp2_apply, &my);
563 sol_state = ilp_go(ienv);
565 pmap_destroy(my.nr_2_irn);
568 return sol_state == lpp_optimal;
573 static inline void only_that_you_can_compile_without_WITH_ILP_defined(void) {
576 #endif /* WITH_ILP */