4 * Copyright: (c) Universitaet Karlsruhe
5 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
21 #include "lpp_local.h"
22 #include "lpp_remote.h"
24 #include "becopyopt.h"
25 #include "becopystat.h"
28 #define DEBUG_LVL SET_LEVEL_1
29 static firm_dbg_module_t *dbg = NULL;
31 #define EPSILON 0.00001
32 #define SLOTS_LIVING 32
34 typedef struct _simpl_t {
35 struct list_head chain;
39 typedef struct _problem_instance_t {
40 const copy_opt_t *co; /** the copy_opt problem */
41 /* problem size reduction removing simple nodes */
42 struct list_head simplicials; /**< holds all simpl_t's in right order to color*/
43 pset *removed; /**< holds all removed simplicial irns */
45 lpp_t *dilp; /**< problem formulation directly as milp */
47 lpp_t *curr_lp; /**< points to the problem currently used */
48 int cst_counter, last_x_var;
53 #define is_removed(irn) pset_find_ptr(pi->removed, irn)
55 #define is_color_possible(irn,color) arch_reg_is_allocatable(pi->co->chordal_env->arch_env, irn, arch_pos_make_out(0), arch_register_for_index(pi->co->chordal_env->cls, color))
58 * Some stuff for variable name handling.
60 #define mangle_cst(buf, prefix, nr) \
61 snprintf((buf), sizeof(buf), "%c%d", (prefix), (nr))
63 #define mangle_var(buf, prefix, node_nr, color) \
64 snprintf((buf), sizeof(buf), "%c%d_%d", (prefix), (node_nr), (color))
66 #define mangle_var_irn(buf, prefix, irn, color) \
67 mangle_var((buf), (prefix), get_irn_graph_nr(irn), (color))
69 #define split_var(var, nnr, col) \
70 sscanf(var, "x%d_%d", (nnr), (col))
74 * Checks if a node is simplicial in the graph
75 * heeding the already removed nodes.
77 static INLINE int pi_is_simplicial(problem_instance_t *pi, const if_node_t *ifn) {
79 if_node_t **all, *curr;
80 all = alloca(ifn_get_degree(ifn) * sizeof(*all));
82 /* get all non-removed neighbors */
83 foreach_neighb(ifn, curr)
84 if (!is_removed(curr))
87 /* check if these form a clique */
88 for (i=0; i<size; ++i)
89 for (o=i+1; o<size; ++o)
90 if (!ifg_has_edge(pi->co->chordal_env, all[i], all[o]))
93 /* all edges exist so this is a clique */
98 * Iterative finds and 'removes' from the graph all nodes which are
99 * simplicial AND not member of a equal-color-wish
101 static void pi_find_simplicials(problem_instance_t *pi) {
106 DBG((dbg, LEVEL_2, "Find simlicials...\n"));
108 if_nodes = be_ra_get_ifg_nodes(pi->co->chordal_env);
111 for (ifn = set_first(if_nodes); ifn; ifn = set_next(if_nodes)) {
112 ir_node *irn = get_irn_for_graph_nr(pi->co->chordal_env->irg, ifn->nnr);
113 if (!is_removed(irn) && !is_optimizable(pi->co->chordal_env->arch_env, irn) &&
114 !is_optimizable_arg(pi->co, irn) && pi_is_simplicial(pi, ifn)) {
115 simpl_t *s = xmalloc(sizeof(*s));
117 list_add(&s->chain, &pi->simplicials);
118 pset_insert_ptr(pi->removed, irn);
120 DBG((dbg, LEVEL_2, " Removed %n %d\n", irn, get_irn_graph_nr(irn)));
124 if (set_count(be_ra_get_ifg_nodes(pi->co->chordal_env)) == pset_count(pi->removed))
125 pi->all_simplicial = 1;
129 * Add coloring-force conditions
130 * Matrix A: knapsack constraint for each node
132 static void pi_add_constr_A(problem_instance_t *pi) {
135 DBG((dbg, LEVEL_2, "Add A constraints...\n"));
136 /* iterate over all blocks */
137 pmap_foreach(pi->co->chordal_env->border_heads, pme) {
138 struct list_head *head = pme->value;
140 bitset_t *pos_regs = bitset_alloca(pi->co->chordal_env->cls->n_regs);
142 list_for_each_entry_reverse(border_t, curr, head, list)
143 if (curr->is_def && curr->is_real && !is_removed(curr->irn)) {
144 int cst_idx, nnr, col;
146 nnr = get_irn_graph_nr(curr->irn);
147 mangle_cst(pi->buf, 'A', nnr);
148 cst_idx = lpp_add_cst(pi->curr_lp, pi->buf, equal, 1);
150 // iterate over all possible colors in order
151 bitset_clear_all(pos_regs);
152 arch_get_allocatable_regs(pi->co->chordal_env->arch_env, curr->irn, arch_pos_make_out(0), pi->co->chordal_env->cls, pos_regs);
153 bitset_foreach(pos_regs, col) {
155 mangle_var(pi->buf, 'x', nnr, col);
156 var_idx = lpp_add_var(pi->curr_lp, pi->buf, binary, 0);
157 pi->last_x_var = var_idx;
158 lpp_set_factor_fast(pi->curr_lp, cst_idx, var_idx, 1);
165 * Checks if all nodes in @p living are live in in block @p block.
166 * @return 1 if all are live in
169 static INLINE int all_live_in(ir_node *block, pset *living) {
171 for (n = pset_first(living); n; n = pset_next(living))
172 if (!is_live_in(block, n)) {
180 * Finds cliques in the interference graph, considering only nodes
181 * for which the color @p color is possible. Finds only 'maximal-cliques',
182 * viz cliques which are not contained in another one.
183 * Matrix B: interference constraints using cliques
185 static void pi_add_constr_B(problem_instance_t *pi, int color) {
186 enum phase_t {growing, shrinking} phase = growing;
189 pset *living = pset_new_ptr(SLOTS_LIVING);
191 DBG((dbg, LEVEL_2, "Add B constraints (col = %d)...\n", color));
192 /* iterate over all blocks */
193 pmap_foreach(pi->co->chordal_env->border_heads, pme) {
194 ir_node *block = pme->key;
195 struct list_head *head = pme->value;
197 list_for_each_entry_reverse(border_t, b, head, list) {
198 const ir_node *irn = b->irn;
199 if (is_removed(irn) || !is_color_possible(irn, color))
203 DBG((dbg, LEVEL_2, "Def %n\n", irn));
204 pset_insert_ptr(living, irn);
206 } else { /* is_use */
207 DBG((dbg, LEVEL_2, "Use %n\n", irn));
209 /* before shrinking the set, store the current 'maximum' clique;
210 * do NOT if clique is a single node
211 * do NOT if all values are live_in (in this case they were contained in a live-out clique elsewhere) */
212 if (phase == growing && pset_count(living) >= 2 && !all_live_in(block, living)) {
215 mangle_cst(pi->buf, 'B', pi->cst_counter);
216 cst_idx = lpp_add_cst(pi->curr_lp, pi->buf, less, 1);
217 for (n = pset_first(living); n; n = pset_next(living)) {
219 mangle_var_irn(pi->buf, 'x', n, color);
220 var_idx = lpp_get_var_idx(pi->curr_lp, pi->buf);
221 lpp_set_factor_fast(pi->curr_lp, cst_idx, var_idx, 1);
225 pset_remove_ptr(living, irn);
230 assert(0 == pset_count(living));
235 * Generates constraints which interrelate x with y variables.
236 * y=1 ==> x1 and x2 must have the same color.
237 * <== is achieved automatically by minimization.
239 static void pi_add_constr_E(problem_instance_t *pi) {
241 bitset_t *root_regs, *arg_regs;
243 unsigned nregs = pi->co->chordal_env->cls->n_regs;
244 root_regs = bitset_alloca(nregs);
245 arg_regs = bitset_alloca(nregs);
247 DBG((dbg, LEVEL_2, "Add E constraints...\n"));
248 /* for all roots of optimization units */
249 list_for_each_entry(unit_t, curr, &pi->co->units, units) {
251 int rootnr, argnr, color;
255 root = curr->nodes[0];
256 rootnr = get_irn_graph_nr(root);
257 bitset_clear_all(root_regs);
258 arch_get_allocatable_regs(pi->co->chordal_env->arch_env, root, arch_pos_make_out(0), pi->co->chordal_env->cls, root_regs);
260 /* for all arguments of root */
261 for (i = 1; i < curr->node_count; ++i) {
262 arg = curr->nodes[i];
263 argnr = get_irn_graph_nr(arg);
264 bitset_clear_all(arg_regs);
265 arch_get_allocatable_regs(pi->co->chordal_env->arch_env, arg, arch_pos_make_out(0), pi->co->chordal_env->cls, arg_regs);
267 /* Introduce new variable and set factor in objective function */
268 mangle_var(buf, 'y', rootnr, argnr);
269 y_idx = lpp_add_var(pi->curr_lp, buf, continous, curr->costs[i]);
271 /* set starting value */
272 //lpp_set_start_value(pi->curr_lp, y_idx, (get_irn_col(pi->co, root) != get_irn_col(pi->co, arg)));
274 /* For all colors root and arg have in common, add 2 constraints to E */
275 bitset_and(arg_regs, root_regs);
276 bitset_foreach(arg_regs, color) {
277 int root_idx, arg_idx, cst_idx;
278 mangle_var(buf, 'x', rootnr, color);
279 root_idx = lpp_get_var_idx(pi->curr_lp, buf);
280 mangle_var(buf, 'x', argnr, color);
281 arg_idx = lpp_get_var_idx(pi->curr_lp, buf);
283 /* add root-arg-y <= 0 */
284 mangle_cst(buf, 'E', cst_counter++);
285 cst_idx = lpp_add_cst(pi->curr_lp, buf, less, 0);
286 lpp_set_factor_fast(pi->curr_lp, cst_idx, root_idx, 1);
287 lpp_set_factor_fast(pi->curr_lp, cst_idx, arg_idx, -1);
288 lpp_set_factor_fast(pi->curr_lp, cst_idx, y_idx, -1);
290 /* add arg-root-y <= 0 */
291 mangle_cst(buf, 'E', cst_counter++);
292 cst_idx = lpp_add_cst(pi->curr_lp, buf, less, 0);
293 lpp_set_factor_fast(pi->curr_lp, cst_idx, root_idx, -1);
294 lpp_set_factor_fast(pi->curr_lp, cst_idx, arg_idx, 1);
295 lpp_set_factor_fast(pi->curr_lp, cst_idx, y_idx, -1);
302 * Matrix M: maximum independent set constraints
303 * Generates lower bound-cuts for optimization units with inner interferences.
304 * Sum(y_{root, arg}, arg \in Args) <= max_indep_set_size - 1
306 static void pi_add_constr_M(problem_instance_t *pi) {
309 DBG((dbg, LEVEL_2, "Add M constraints...\n"));
311 /* for all optimization units */
312 list_for_each_entry(unit_t, curr, &pi->co->units, units) {
313 const ir_node *root, *arg;
315 int cst_idx, y_idx, i;
318 if (curr->minimal_costs == 0)
321 root = curr->nodes[0];
322 rootnr = get_irn_graph_nr(root);
323 mangle_cst(buf, 'M', cst_counter++);
324 cst_idx = lpp_add_cst(pi->curr_lp, buf, greater, curr->minimal_costs);
326 /* for all arguments */
327 for (i = 1; i < curr->node_count; ++i) {
328 arg = curr->nodes[i];
329 argnr = get_irn_graph_nr(arg);
330 mangle_var(buf, 'y', rootnr, argnr);
331 y_idx = lpp_get_var_idx(pi->curr_lp, buf);
332 lpp_set_factor_fast(pi->curr_lp, cst_idx, y_idx, 1);
338 * Generate the initial problem matrices and vectors.
340 static problem_instance_t *new_pi(const copy_opt_t *co) {
341 problem_instance_t *pi;
344 DBG((dbg, LEVEL_2, "Generating new instance...\n"));
345 pi = xcalloc(1, sizeof(*pi));
347 pi->removed = pset_new_ptr_default();
348 INIT_LIST_HEAD(&pi->simplicials);
349 pi->dilp = new_lpp(co->name, minimize);
352 /* problem size reduction */
353 pi_find_simplicials(pi);
354 //TODO If you wish to see it: dump_ifg_w/o_removed
355 if (pi->all_simplicial)
358 /* built objective abd constraints */
359 pi->curr_lp = pi->dilp;
361 for (col = 0; col < pi->co->chordal_env->cls->n_regs; ++col)
362 pi_add_constr_B(pi, col);
370 * Clean the problem instance
372 static void free_pi(problem_instance_t *pi) {
373 simpl_t *simpl, *tmp;
375 DBG((dbg, LEVEL_2, "Free instance...\n"));
377 list_for_each_entry_safe(simpl_t, simpl, tmp, &pi->simplicials, chain)
379 del_pset(pi->removed);
384 * Set starting values for the mip problem according
385 * to the current coloring of the graph.
387 static void pi_set_start_sol(problem_instance_t *pi) {
390 DBG((dbg, LEVEL_2, "Set start solution...\n"));
391 for (i=1; i<=pi->last_x_var; ++i) {
394 /* get variable name */
395 lpp_get_var_name(pi->curr_lp, i, var_name, sizeof(var_name));
396 /* split into components */
397 if (split_var(var_name, &nnr, &col) == 2) {
398 assert(get_irn_col(pi->co, get_irn_for_graph_nr(pi->co->chordal_env->irg, nnr)) != -1);
399 val = (get_irn_col(pi->co, get_irn_for_graph_nr(pi->co->chordal_env->irg, nnr)) == col) ? 1 : 0;
400 lpp_set_start_value(pi->curr_lp, i, val);
402 fprintf(stderr, "Variable name is: %s\n", var_name);
403 assert(0 && "x vars always look like this 'x123_45'");
411 static void pi_solve_ilp(problem_instance_t *pi, void (*lpp_solve)(lpp_t *)) {
412 pi_set_start_sol(pi);
413 lpp_solve(pi->curr_lp);
417 * Set the color of all simplicial nodes removed form
418 * the graph before transforming it to an ilp.
420 static void pi_set_simplicials(problem_instance_t *pi) {
421 simpl_t *simpl, *tmp;
422 bitset_t *used_cols = bitset_alloca(arch_register_class_n_regs(pi->co->chordal_env->cls));
424 DBG((dbg, LEVEL_2, "Set simplicials...\n"));
425 /* color the simplicial nodes in right order */
426 list_for_each_entry_safe(simpl_t, simpl, tmp, &pi->simplicials, chain) {
428 ir_node *other_irn, *irn;
429 if_node_t *other, *ifn;
431 /* get free color by inspecting all neighbors */
433 irn = get_irn_for_graph_nr(pi->co->chordal_env->irg, ifn->nnr);
434 bitset_clear_all(used_cols);
435 foreach_neighb(ifn, other) {
436 other_irn = get_irn_for_graph_nr(pi->co->chordal_env->irg, other->nnr);
437 if (!is_removed(other_irn)) /* only inspect nodes which are in graph right now */
438 bitset_set(used_cols, get_irn_col(pi->co, other_irn));
441 /* now all bits not set are possible colors */
442 free_col = bitset_next_clear(used_cols, 0);
443 assert(free_col != -1 && "No free color found. This can not be.");
444 set_irn_col(pi->co, irn, free_col);
445 pset_remove_ptr(pi->removed, irn); /* irn is back in graph again */
450 * Sets the colors of irns according to the values of variables
451 * provided by the solution of the solver.
453 static void pi_apply_solution(problem_instance_t *pi) {
457 DBG((dbg, LEVEL_2, "Applying solution...\n"));
460 curr_vals[I_ILP_ITER] += lpp_get_iter_cnt(pi->curr_lp);
461 curr_vals[I_ILP_TIME] += lpp_get_sol_time(pi->curr_lp);
464 sol = xmalloc((pi->last_x_var+1) * sizeof(*sol));
465 state = lpp_get_solution(pi->curr_lp, sol, 1, pi->last_x_var);
466 if (state != optimal) {
467 printf("Solution state is not 'optimal': %d\n", state);
468 assert(state >= feasible && "The solution should at least be feasible!");
470 for (i=0; i<pi->last_x_var; ++i) {
474 if (sol[i] > 1-EPSILON) { /* split varibale name into components */
475 lpp_get_var_name(pi->curr_lp, 1+i, var_name, sizeof(var_name));
476 if (split_var(var_name, &nnr, &col) == 2) {
477 DBG((dbg, LEVEL_2, "Irn %n Idx %d Var %s Val %f\n", get_irn_for_graph_nr(pi->co->chordal_env->irg, nnr), i, var_name, sol[i]));
478 DBG((dbg, LEVEL_2, "x%d = %d\n", nnr, col));
479 set_irn_col(pi->co, get_irn_for_graph_nr(pi->co->chordal_env->irg, nnr), col);
481 assert(0 && "This should be a x-var");
486 void co_ilp_opt(copy_opt_t *co) {
487 problem_instance_t *pi;
489 dbg = firm_dbg_register("ir.be.copyoptilp");
490 if (!strcmp(co->name, DEBUG_IRG))
491 firm_dbg_set_mask(dbg, DEBUG_LVL_ILP);
493 firm_dbg_set_mask(dbg, DEBUG_LVL);
496 if (!pi->all_simplicial) {
499 snprintf(buf, sizeof(buf), "%s.mps", co->name);
500 lpp_dump(pi->curr_lp, buf);
502 pi_solve_ilp(pi, lpp_solve_local);
503 pi_apply_solution(pi);
504 pi_set_simplicials(pi);