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 Copy node statistics.
23 * @author Daniel Grund
35 #include "iredges_t.h"
37 #include "irnodeset.h"
39 #include "bechordal_t.h"
42 #include "becopyopt_t.h"
43 #include "becopystat.h"
46 #include "beintlive_t.h"
48 #define DEBUG_LVL SET_LEVEL_1
49 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
52 #define MAX_CLS_SIZE 20
53 #define MAX_CLS_PHIS 20
56 * For an explanation of these values see the code of copystat_dump_pretty
59 /* FROM HERE: PROBLEM CHARACTERIZATION */
65 I_PHI_CNT, /* number of phi nodes */
66 I_PHI_ARG_CNT, /* number of arguments of phis */
67 I_PHI_ARG_SELF, /* number of arguments of phis being the phi itself */
68 I_PHI_ARG_CONST, /* number of arguments of phis being consts */
69 I_PHI_ARG_PRED, /* ... being defined in a cf-pred */
70 I_PHI_ARG_GLOB, /* ... being defined elsewhere */
72 I_PHI_ARITY_E = I_PHI_ARITY_S+MAX_ARITY,
75 I_CPY_CNT, /* number of copynodes */
78 I_CLS_CNT, /* number of phi classes */
79 I_CLS_IF_FREE, /* number of pc having no interference */
80 I_CLS_IF_MAX, /* number of possible interferences in all classes */
81 I_CLS_IF_CNT, /* number of actual interferences in all classes */
83 I_CLS_SIZE_E = I_CLS_SIZE_S+MAX_CLS_SIZE,
85 I_CLS_PHIS_E = I_CLS_PHIS_S+MAX_CLS_PHIS,
87 /* FROM HERE: RESULT VLAUES */
88 /* all of them are external set */
91 I_HEUR_TIME, /* solving time in milli seconds */
92 I_ILP_TIME, /* solving time in milli seconds */
95 I_ILP_ITER, /* number of simplex iterations */
97 /* copy instructions */
98 I_COPIES_MAX, /* max possible costs of copies*/
99 I_COPIES_INIT, /* number of copies in initial allocation */
100 I_COPIES_HEUR, /* number of copies after heuristic */
101 I_COPIES_5SEC, /* number of copies after ilp with max n sec */
102 I_COPIES_30SEC, /* number of copies after ilp with max n sec */
103 I_COPIES_OPT, /* number of copies after ilp */
104 I_COPIES_IF, /* number of copies inevitable due to root-arg-interf */
110 * Holds current values. Values are added till next copystat_reset
112 int curr_vals[ASIZE];
114 static ir_nodeset_t *all_phi_nodes;
115 static ir_nodeset_t *all_copy_nodes;
116 static ir_graph *last_irg;
118 void be_init_copystat(void) {
119 FIRM_DBG_REGISTER(dbg, "firm.be.copystat");
121 all_phi_nodes = ir_nodeset_new(64);
122 all_copy_nodes = ir_nodeset_new(64);
123 memset(curr_vals, 0, sizeof(curr_vals));
125 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_copystat);
127 void be_quit_copystat(void) {
128 ir_nodeset_del(all_phi_nodes);
129 ir_nodeset_del(all_copy_nodes);
131 BE_REGISTER_MODULE_DESTRUCTOR(be_quit_copystat);
133 void copystat_reset(void) {
139 * Collect general data
141 static void irg_stat_walker(ir_node *node, void *env)
145 curr_vals[I_ALL_NODES]++; /* count all nodes */
147 if (is_Block(node)) /* count all blocks */
148 curr_vals[I_BLOCKS]++;
150 if (is_Reg_Phi(node)) /* collect phis */
151 ir_nodeset_insert(all_phi_nodes, node);
153 if (is_Perm_Proj(node))
154 ir_nodeset_insert(all_copy_nodes, node);
156 /* TODO: Add 2-Addr-Code nodes */
159 static void copystat_collect_irg(ir_graph *irg)
161 irg_walk_graph(irg, irg_stat_walker, NULL, NULL);
166 * @return 1 if the block at pos @p pos removed a critical edge
169 static inline int was_edge_critical(const ir_node *bl, int pos) {
170 const ir_edge_t *edge;
171 const ir_node *bl_at_pos, *bl_before;
172 assert(is_Block(bl));
174 /* Does bl have several predecessors ?*/
175 if (get_irn_arity(bl) <= 1)
178 /* Does the pred have exactly one predecessor */
179 bl_at_pos = get_irn_n(bl, pos);
180 if (get_irn_arity(bl_at_pos) != 1)
183 /* Does the pred of the pred have several successors */
184 bl_before = get_irn_n(bl_at_pos, 0);
185 edge = get_block_succ_first(bl_before);
186 return get_block_succ_next(bl_before, edge) ? 1 : 0;
190 * Collect phi node data
192 static void stat_phi_node(be_chordal_env_t *chordal_env, ir_node *phi)
199 /* count all phi phis */
200 curr_vals[I_PHI_CNT]++;
203 arity = get_irn_arity(phi);
204 curr_vals[I_PHI_ARG_CNT] += arity;
205 if (arity > MAX_ARITY)
206 curr_vals[I_PHI_ARITY_E]++;
208 curr_vals[I_PHI_ARITY_S + arity]++;
210 phi_bl = get_nodes_block(phi);
211 /* type of argument {self, const, pred, glob} */
212 for (i = 0; i < arity; i++) {
213 ir_node *block_of_arg, *block_ith_pred;
214 ir_node *arg = get_irn_n(phi, i);
217 curr_vals[I_PHI_ARG_SELF]++;
221 if (iro_Const == get_irn_opcode(arg)) {
222 curr_vals[I_PHI_ARG_CONST]++;
226 /* get the pred block skipping blocks on critical edges */
227 block_ith_pred = get_Block_cfgpred_block(phi_bl, i);
228 if (was_edge_critical(phi_bl, i))
229 block_ith_pred = get_Block_cfgpred_block(block_ith_pred, 0);
231 block_of_arg = get_nodes_block(arg);
232 if (block_of_arg == block_ith_pred) {
233 curr_vals[I_PHI_ARG_PRED]++;
237 curr_vals[I_PHI_ARG_GLOB]++;
242 * Collect register-constrained node data
244 static void stat_copy_node(be_chordal_env_t *chordal_env, ir_node *root) {
245 curr_vals[I_CPY_CNT]++;
246 curr_vals[I_COPIES_MAX]++;
247 if (values_interfere(chordal_env->birg, root, get_Perm_src(root))) {
248 curr_vals[I_COPIES_IF]++;
249 assert(0 && "A Perm pair (in/out) should never interfere!");
254 * Collect phi class data
256 static void stat_phi_class(be_chordal_env_t *chordal_env, ir_node **pc) {
257 int i, o, size, if_free, phis;
259 /* phi class count */
260 curr_vals[I_CLS_CNT]++;
264 if (size > MAX_CLS_SIZE)
265 curr_vals[I_CLS_SIZE_E]++;
267 curr_vals[I_CLS_SIZE_S + size]++;
269 /* determine number of phis on this class */
270 for (phis = i = 0; i < size; ++i)
274 if (phis > MAX_CLS_PHIS)
275 curr_vals[I_CLS_PHIS_E]++;
277 curr_vals[I_CLS_PHIS_S + phis]++;
279 /* determine interference of phi class members */
280 curr_vals[I_CLS_IF_MAX] += size * (size - 1) / 2;
281 for (if_free = 1, i = 0; i < size - 1; ++i)
282 for (o = i + 1; o < size; ++o)
283 if (values_interfere(chordal_env->birg, pc[i], pc[o])) {
285 curr_vals[I_CLS_IF_CNT]++;
288 /* Does this phi class have an inner interference? */
289 curr_vals[I_CLS_IF_FREE] += if_free;
292 static void copystat_collect_cls(be_chordal_env_t *cenv) {
293 ir_graph *irg = cenv->irg;
295 phi_classes_t *pc_obj;
296 pset *all_phi_classes;
297 ir_nodeset_iterator_t iter;
300 copystat_collect_irg(irg);
302 /* compute the Phi classes of the collected Phis */
303 pc_obj = phi_class_new_from_set(cenv->irg, all_phi_nodes, 0);
304 all_phi_classes = get_all_phi_classes(pc_obj);
306 foreach_ir_nodeset(all_phi_nodes, n, iter) {
307 if (arch_get_irn_reg_class_out(n) == cenv->cls)
308 stat_phi_node(cenv, n);
311 foreach_ir_nodeset(all_copy_nodes, n, iter) {
312 if (arch_get_irn_reg_class_out(n) == cenv->cls)
313 stat_copy_node(cenv, n);
316 foreach_pset(all_phi_classes, pc) {
317 ir_node *member = pc[0];
318 if (arch_get_irn_reg_class_out(member) == cenv->cls)
319 stat_phi_class(cenv, pc);
322 /* free the phi class object */
323 phi_class_free(pc_obj);
326 void copystat_add_max_costs(int costs) {
327 curr_vals[I_COPIES_MAX] += costs;
329 void copystat_add_inevit_costs(int costs) {
330 curr_vals[I_COPIES_IF] += costs;
332 void copystat_add_init_costs(int costs) {
333 curr_vals[I_COPIES_INIT] += costs;
335 void copystat_add_heur_costs(int costs) {
336 curr_vals[I_COPIES_HEUR] += costs;
338 void copystat_add_ilp_5_sec_costs(int costs) {
339 curr_vals[I_COPIES_5SEC] += costs;
341 void copystat_add_ilp_30_sec_costs(int costs) {
342 curr_vals[I_COPIES_30SEC] += costs;
344 void copystat_add_opt_costs(int costs) {
345 curr_vals[I_COPIES_OPT] += costs;
347 void copystat_add_heur_time(int time) {
348 curr_vals[I_HEUR_TIME] += time;
353 void copystat_add_ilp_time(int time) {
354 curr_vals[I_ILP_TIME] += time;
356 void copystat_add_ilp_vars(int vars) {
357 curr_vals[I_ILP_VARS] += vars;
359 void copystat_add_ilp_csts(int csts) {
360 curr_vals[I_ILP_CSTR] += csts;
362 void copystat_add_ilp_iter(int iters) {
363 curr_vals[I_ILP_ITER] += iters;
366 #endif /* WITH_ILP */
368 void copystat_dump(ir_graph *irg) {
373 snprintf(buf, sizeof(buf), "%s__%s", get_irp_name(), get_entity_name(get_irg_entity(irg)));
374 buf[sizeof(buf) - 1] = '\0';
375 out = be_ffopen(buf, "stat", "wt");
377 fprintf(out, "%d\n", ASIZE);
378 for (i = 0; i < ASIZE; i++) {
380 if (i >= I_PHI_ARITY_S && i <= I_PHI_ARITY_E)
381 fprintf(out, "%i %i\n", curr_vals[i], curr_vals[I_PHI_CNT]);
382 else if (i >= I_CLS_SIZE_S && i <= I_CLS_SIZE_E)
383 fprintf(out, "%i %i\n", curr_vals[i], curr_vals[I_CLS_CNT]);
386 fprintf(out, "%i\n", curr_vals[i]);
392 void copystat_dump_pretty(ir_graph *irg) {
397 snprintf(buf, sizeof(buf), "%s__%s", get_irp_name(), get_entity_name(get_irg_entity(irg)));
398 buf[sizeof(buf) - 1] = '\0';
399 out = be_ffopen(buf, "pstat", "wt");
401 fprintf(out, "Nodes %4d\n", curr_vals[I_ALL_NODES]);
402 fprintf(out, "Blocks %4d\n", curr_vals[I_BLOCKS]);
403 fprintf(out, "CopyIrn %4d\n", curr_vals[I_CPY_CNT]);
405 fprintf(out, "\nPhis %4d\n", curr_vals[I_PHI_CNT]);
406 fprintf(out, "... argument types\n");
407 fprintf(out, " Total %4d\n", curr_vals[I_PHI_ARG_CNT]);
408 fprintf(out, " Self %4d\n", curr_vals[I_PHI_ARG_SELF]);
409 fprintf(out, " Constants %4d\n", curr_vals[I_PHI_ARG_CONST]);
410 fprintf(out, " CF-Pred %4d\n", curr_vals[I_PHI_ARG_PRED]);
411 fprintf(out, " Others %4d\n", curr_vals[I_PHI_ARG_GLOB]);
412 fprintf(out, "... arities\n");
413 for (i = I_PHI_ARITY_S; i<=I_PHI_ARITY_E; i++)
414 fprintf(out, " %2i %4d\n", i-I_PHI_ARITY_S, curr_vals[i]);
416 fprintf(out, "\nPhi classes %4d\n", curr_vals[I_CLS_CNT]);
417 fprintf(out, " compl. free %4d\n", curr_vals[I_CLS_IF_FREE]);
418 fprintf(out, " inner intf. %4d / %4d\n", curr_vals[I_CLS_IF_CNT], curr_vals[I_CLS_IF_MAX]);
419 fprintf(out, "... sizes\n");
420 for (i = I_CLS_SIZE_S; i<=I_CLS_SIZE_E; i++)
421 fprintf(out, " %2i %4d\n", i-I_CLS_SIZE_S, curr_vals[i]);
422 fprintf(out, "... contained phis\n");
423 for (i = I_CLS_PHIS_S; i<=I_CLS_PHIS_E; i++)
424 fprintf(out, " %2i %4d\n", i-I_CLS_PHIS_S, curr_vals[i]);
426 fprintf(out, "\nILP stat\n");
427 fprintf(out, " Time %8d\n", curr_vals[I_ILP_TIME]);
428 fprintf(out, " Iter %8d\n", curr_vals[I_ILP_ITER]);
430 fprintf(out, "\nCopy stat\n");
431 fprintf(out, " Max %4d\n", curr_vals[I_COPIES_MAX]);
432 fprintf(out, " Init %4d\n", curr_vals[I_COPIES_INIT]);
433 fprintf(out, " Heur %4d\n", curr_vals[I_COPIES_HEUR]);
434 fprintf(out, " Opt %4d\n", curr_vals[I_COPIES_OPT]);
435 fprintf(out, " Intf %4d\n", curr_vals[I_COPIES_IF]);
441 * Helpers for saving and restoring colors of nodes.
442 * Used to get dependable and comparable benchmark results.
444 typedef struct color_saver {
445 be_chordal_env_t *chordal_env;
447 int flag; /* 0 save, 1 load */
450 static void save_load(ir_node *irn, void *env) {
451 color_save_t *saver = env;
452 if (saver->chordal_env->cls == arch_get_irn_reg_class_out(irn)) {
453 if (saver->flag == 0) { /* save */
454 const arch_register_t *reg = arch_get_irn_register(irn);
455 pmap_insert(saver->saved_colors, irn, (void *) reg);
457 arch_register_t *reg = pmap_get(saver->saved_colors, irn);
458 arch_set_irn_register(irn, reg);
463 static void save_colors(color_save_t *color_saver) {
464 color_saver->flag = 0;
465 irg_walk_graph(color_saver->chordal_env->irg, save_load, NULL, color_saver);
469 static void load_colors(color_save_t *color_saver) {
470 color_saver->flag = 1;
471 irg_walk_graph(color_saver->chordal_env->irg, save_load, NULL, color_saver);
476 * Main compare routine
478 void co_compare_solvers(be_chordal_env_t *chordal_env) {
482 int costs_inevit, costs_init, costs_solved, lower_bound;
484 copystat_collect_cls(chordal_env);
486 co = new_copy_opt(chordal_env, co_get_costs_loop_depth);
487 co_build_ou_structure(co);
488 co_build_graph_structure(co);
489 DBG((dbg, LEVEL_1, "----> CO: %s\n", co->name));
492 saver.chordal_env = chordal_env;
493 saver.saved_colors = pmap_create();
497 costs_inevit = co_get_inevit_copy_costs(co);
498 lower_bound = co_get_lower_bound(co);
499 costs_init = co_get_copy_costs(co);
501 DBG((dbg, LEVEL_1, "Inevit Costs: %3d\n", costs_inevit));
502 DBG((dbg, LEVEL_1, "Lower Bound: %3d\n", lower_bound));
503 DBG((dbg, LEVEL_1, "Init costs: %3d\n", costs_init));
505 copystat_add_inevit_costs(costs_inevit);
506 copystat_add_init_costs(costs_init);
507 copystat_add_max_costs(co_get_max_copy_costs(co));
509 /* heuristic 1 (Daniel Grund) */
510 timer = ir_timer_register("heur1", NULL);
511 ir_timer_reset_and_start(timer);
513 co_solve_heuristic(co);
515 ir_timer_stop(timer);
517 costs_solved = co_get_copy_costs(co);
518 DBG((dbg, LEVEL_1, "HEUR1 costs: %3d\n", costs_solved));
519 copystat_add_heur_time(ir_timer_elapsed_msec(timer));
520 copystat_add_heur_costs(costs_solved);
521 assert(lower_bound <= costs_solved);
523 /* heuristic 2 (Sebastian Hack) */
524 timer = ir_timer_register("heur2", NULL);
525 ir_timer_reset_and_start(timer);
527 co_solve_heuristic_new(co);
529 ir_timer_stop(timer);
531 costs_solved = co_get_copy_costs(co);
532 DBG((dbg, LEVEL_1, "HEUR2 costs: %3d\n", costs_solved));
533 copystat_add_heur_time(ir_timer_elapsed_msec(timer));
534 copystat_add_heur_costs(costs_solved);
535 assert(lower_bound <= costs_solved);
537 /* Park & Moon register coalescing (Kimon Hoffmann) */
538 timer = ir_timer_register("park", NULL);
539 ir_timer_reset_and_start(timer);
541 co_solve_park_moon(co);
543 ir_timer_stop(timer);
545 costs_solved = co_get_copy_costs(co);
546 DBG((dbg, LEVEL_1, "Park/Moon costs: %3d\n", costs_solved));
547 copystat_add_heur_time(ir_timer_elapsed_msec(timer));
548 copystat_add_heur_costs(costs_solved);
549 assert(lower_bound <= costs_solved);
554 /* ILP 1 is not yet implemented, so it makes no sense to compare */
558 co_solve_ilp1(co, 60.0);
560 costs_solved = co_get_copy_costs(co);
561 DBG((dbg, LEVEL_1, "ILP1 costs: %3d\n", costs_solved));
562 copystat_add_opt_costs(costs_solved); /* TODO: ADAPT */
563 assert(lower_bound <= costs_solved);
571 costs_solved = co_get_copy_costs(co);
572 DBG((dbg, LEVEL_1, "ILP2 costs: %3d\n", costs_solved));
573 copystat_add_opt_costs(costs_solved); /* TODO: ADAPT */
574 assert(lower_bound <= costs_solved);
576 #endif /* WITH_ILP */
578 /* free memory for statistic structures */
579 pmap_destroy(saver.saved_colors);
580 co_free_graph_structure(co);
581 co_free_ou_structure(co);