be_abi_put_ignore_regs returns now number of ignore registers as unsigned
[libfirm] / ir / be / becopystat.c
1 /*
2  * Copyright (C) 1995-2007 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       Copy node statistics.
23  * @author      Daniel Grund
24  * @date        19.04.2005
25  * @version     $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include <string.h>
32 #include <libcore/lc_timing.h>
33
34 #include "xmalloc.h"
35 #include "irgraph.h"
36 #include "irgwalk.h"
37 #include "irprog.h"
38 #include "iredges_t.h"
39 #include "phiclass.h"
40 #include "irnodeset.h"
41
42 #include "bechordal_t.h"
43 #include "beutil.h"
44 #include "becopyopt_t.h"
45 #include "becopystat.h"
46 #include "beirg_t.h"
47 #include "bemodule.h"
48 #include "beintlive_t.h"
49
50 #define DEBUG_LVL SET_LEVEL_1
51 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
52
53 #define MAX_ARITY 20
54 #define MAX_CLS_SIZE 20
55 #define MAX_CLS_PHIS 20
56
57 /**
58  * For an explanation of these values see the code of copystat_dump_pretty
59  */
60 enum vals_t {
61         /* FROM HERE: PROBLEM CHARACTERIZATION */
62
63         I_ALL_NODES = 0,
64         I_BLOCKS,
65
66         /* phi nodes */
67         I_PHI_CNT,                      /* number of phi nodes */
68         I_PHI_ARG_CNT,          /* number of arguments of phis */
69         I_PHI_ARG_SELF,         /* number of arguments of phis being the phi itself */
70         I_PHI_ARG_CONST,        /* number of arguments of phis being consts */
71         I_PHI_ARG_PRED,         /* ... being defined in a cf-pred */
72         I_PHI_ARG_GLOB,         /* ... being defined elsewhere */
73         I_PHI_ARITY_S,
74         I_PHI_ARITY_E    = I_PHI_ARITY_S+MAX_ARITY,
75
76         /* copy nodes */
77         I_CPY_CNT,                      /* number of copynodes */
78
79         /* phi classes */
80         I_CLS_CNT,                      /* number of phi classes */
81         I_CLS_IF_FREE,          /* number of pc having no interference */
82         I_CLS_IF_MAX,           /* number of possible interferences in all classes */
83         I_CLS_IF_CNT,           /* number of actual interferences in all classes */
84         I_CLS_SIZE_S,
85         I_CLS_SIZE_E = I_CLS_SIZE_S+MAX_CLS_SIZE,
86         I_CLS_PHIS_S,
87         I_CLS_PHIS_E = I_CLS_PHIS_S+MAX_CLS_PHIS,
88
89         /* FROM HERE: RESULT VLAUES */
90         /* all of them are external set */
91
92         /* ilp values */
93         I_HEUR_TIME,            /* solving time in milli seconds */
94         I_ILP_TIME,                     /* solving time in milli seconds */
95         I_ILP_VARS,
96         I_ILP_CSTR,
97         I_ILP_ITER,                     /* number of simplex iterations */
98
99         /* copy instructions */
100         I_COPIES_MAX,           /* max possible costs of copies*/
101         I_COPIES_INIT,          /* number of copies in initial allocation */
102         I_COPIES_HEUR,          /* number of copies after heuristic */
103         I_COPIES_5SEC,          /* number of copies after ilp with max n sec */
104         I_COPIES_30SEC,         /* number of copies after ilp with max n sec */
105         I_COPIES_OPT,           /* number of copies after ilp */
106         I_COPIES_IF,            /* number of copies inevitable due to root-arg-interf */
107
108         ASIZE
109 };
110
111 /**
112  * Holds current values. Values are added till next copystat_reset
113  */
114 int curr_vals[ASIZE];
115
116 static ir_nodeset_t *all_phi_nodes;
117 static ir_nodeset_t *all_copy_nodes;
118 static ir_graph *last_irg;
119
120 void be_init_copystat(void) {
121         FIRM_DBG_REGISTER(dbg, "firm.be.copystat");
122
123         all_phi_nodes  = ir_nodeset_new(64);
124         all_copy_nodes = ir_nodeset_new(64);
125         memset(curr_vals, 0, sizeof(curr_vals));
126 }
127 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_copystat);
128
129 void be_quit_copystat(void) {
130         ir_nodeset_del(all_phi_nodes);
131         ir_nodeset_del(all_copy_nodes);
132 }
133 BE_REGISTER_MODULE_DESTRUCTOR(be_quit_copystat);
134
135 void copystat_reset(void) {
136         be_quit_copystat();
137         be_init_copystat();
138 }
139
140 /**
141  * Collect general data
142  */
143 static void irg_stat_walker(ir_node *node, void *env) {
144         arch_env_t *arch_env = env;
145         curr_vals[I_ALL_NODES]++; /* count all nodes */
146
147         if (is_Block(node)) /* count all blocks */
148                 curr_vals[I_BLOCKS]++;
149
150         if (is_Reg_Phi(node)) /* collect phis */
151                 ir_nodeset_insert(all_phi_nodes, node);
152
153         if (is_Perm_Proj(arch_env, node))
154                 ir_nodeset_insert(all_copy_nodes, node);
155
156         /* TODO: Add 2-Addr-Code nodes */
157 }
158
159 static void copystat_collect_irg(ir_graph *irg, arch_env_t *arch_env) {
160         irg_walk_graph(irg, irg_stat_walker, NULL, arch_env);
161         last_irg = irg;
162 }
163
164 /**
165  * @return 1 if the block at pos @p pos removed a critical edge
166  *                 0 else
167  */
168 static INLINE int was_edge_critical(const ir_node *bl, int pos) {
169         const ir_edge_t *edge;
170         const ir_node *bl_at_pos, *bl_before;
171         assert(is_Block(bl));
172
173         /* Does bl have several predecessors ?*/
174         if (get_irn_arity(bl) <= 1)
175                 return 0;
176
177         /* Does the pred have exactly one predecessor */
178         bl_at_pos = get_irn_n(bl, pos);
179         if (get_irn_arity(bl_at_pos) != 1)
180                 return 0;
181
182         /* Does the pred of the pred have several successors */
183         bl_before = get_irn_n(bl_at_pos, 0);
184         edge = get_block_succ_first(bl_before);
185         return get_block_succ_next(bl_before, edge) ? 1 : 0;
186 }
187
188 /**
189  * Collect phi node data
190  */
191 static void stat_phi_node(be_chordal_env_t *chordal_env, ir_node *phi) {
192         int arity, i;
193         ir_node *phi_bl;
194         assert(is_Phi(phi));
195
196         /* count all phi phis */
197         curr_vals[I_PHI_CNT]++;
198
199         /* argument count */
200         arity = get_irn_arity(phi);
201         curr_vals[I_PHI_ARG_CNT] += arity;
202         if (arity > MAX_ARITY)
203                 curr_vals[I_PHI_ARITY_E]++;
204         else
205                 curr_vals[I_PHI_ARITY_S + arity]++;
206
207         phi_bl = get_nodes_block(phi);
208         /* type of argument {self, const, pred, glob} */
209         for (i = 0; i < arity; i++) {
210         ir_node *block_of_arg, *block_ith_pred;
211                 ir_node *arg = get_irn_n(phi, i);
212
213                 if (arg == phi) {
214                         curr_vals[I_PHI_ARG_SELF]++;
215                         continue;
216                 }
217
218                 if (iro_Const == get_irn_opcode(arg)) {
219                         curr_vals[I_PHI_ARG_CONST]++;
220                         continue;
221                 }
222
223                 /* get the pred block skipping blocks on critical edges */
224                 block_ith_pred = get_Block_cfgpred_block(phi_bl, i);
225                 if (was_edge_critical(phi_bl, i))
226                         block_ith_pred = get_Block_cfgpred_block(block_ith_pred, 0);
227
228                 block_of_arg = get_nodes_block(arg);
229                 if (block_of_arg == block_ith_pred) {
230                         curr_vals[I_PHI_ARG_PRED]++;
231                         continue;
232                 }
233
234                 curr_vals[I_PHI_ARG_GLOB]++;
235         }
236 }
237
238 /**
239  * Collect register-constrained node data
240  */
241 static void stat_copy_node(be_chordal_env_t *chordal_env, ir_node *root) {
242         curr_vals[I_CPY_CNT]++;
243         curr_vals[I_COPIES_MAX]++;
244         if (values_interfere(chordal_env->birg, root, get_Perm_src(root))) {
245                 curr_vals[I_COPIES_IF]++;
246                 assert(0 && "A Perm pair (in/out) should never interfere!");
247         }
248 }
249
250 /**
251  * Collect phi class data
252  */
253 static void stat_phi_class(be_chordal_env_t *chordal_env, ir_node **pc) {
254         int i, o, size, if_free, phis;
255
256         /* phi class count */
257         curr_vals[I_CLS_CNT]++;
258
259         /* phi class size */
260         size = ARR_LEN(pc);
261         if (size > MAX_CLS_SIZE)
262                 curr_vals[I_CLS_SIZE_E]++;
263         else
264                 curr_vals[I_CLS_SIZE_S + size]++;
265
266         /* determine number of phis on this class */
267         for (phis = i = 0; i < size; ++i)
268                 if (is_Phi(pc[i]))
269                         phis++;
270
271         if (phis > MAX_CLS_PHIS)
272                 curr_vals[I_CLS_PHIS_E]++;
273         else
274                 curr_vals[I_CLS_PHIS_S + phis]++;
275
276         /* determine interference of phi class members */
277         curr_vals[I_CLS_IF_MAX] += size * (size - 1) / 2;
278         for (if_free = 1, i = 0; i < size - 1; ++i)
279                 for (o = i + 1; o < size; ++o)
280                         if (values_interfere(chordal_env->birg, pc[i], pc[o])) {
281                                 if_free = 0;
282                                 curr_vals[I_CLS_IF_CNT]++;
283                         }
284
285         /* Does this phi class have an inner interference? */
286         curr_vals[I_CLS_IF_FREE] += if_free;
287 }
288
289 static void copystat_collect_cls(be_chordal_env_t *cenv) {
290         ir_graph              *irg  = cenv->irg;
291         arch_env_t            *aenv = cenv->birg->main_env->arch_env;
292         ir_node               *n, **pc;
293         phi_classes_t         *pc_obj;
294         pset                  *all_phi_classes;
295         ir_nodeset_iterator_t iter;
296
297         copystat_reset();
298         copystat_collect_irg(irg, aenv);
299
300         /* compute the Phi classes of the collected Phis */
301         pc_obj          = phi_class_new_from_set(cenv->irg, all_phi_nodes, 0);
302         all_phi_classes = get_all_phi_classes(pc_obj);
303
304         foreach_ir_nodeset(all_phi_nodes, n, iter) {
305                 if (arch_get_irn_reg_class(aenv, n, -1) == cenv->cls)
306                         stat_phi_node(cenv, n);
307         }
308
309         foreach_ir_nodeset(all_copy_nodes, n, iter) {
310                 if (arch_get_irn_reg_class(aenv, n, -1) == cenv->cls)
311                         stat_copy_node(cenv, n);
312         }
313
314         foreach_pset(all_phi_classes, pc) {
315                 ir_node *member = pc[0];
316                 if (arch_get_irn_reg_class(aenv, member, -1) == cenv->cls)
317                         stat_phi_class(cenv, pc);
318         }
319
320         /* free the phi class object */
321         phi_class_free(pc_obj);
322 }
323
324 void copystat_add_max_costs(int costs) {
325         curr_vals[I_COPIES_MAX] += costs;
326 }
327 void copystat_add_inevit_costs(int costs) {
328         curr_vals[I_COPIES_IF] += costs;
329 }
330 void copystat_add_init_costs(int costs) {
331         curr_vals[I_COPIES_INIT] += costs;
332 }
333 void copystat_add_heur_costs(int costs) {
334         curr_vals[I_COPIES_HEUR] += costs;
335 }
336 void copystat_add_ilp_5_sec_costs(int costs) {
337         curr_vals[I_COPIES_5SEC] += costs;
338 }
339 void copystat_add_ilp_30_sec_costs(int costs) {
340         curr_vals[I_COPIES_30SEC] += costs;
341 }
342 void copystat_add_opt_costs(int costs) {
343         curr_vals[I_COPIES_OPT] += costs;
344 }
345 void copystat_add_heur_time(int time) {
346         curr_vals[I_HEUR_TIME] += time;
347 }
348
349 #ifdef WITH_ILP
350
351 void copystat_add_ilp_time(int time) {
352         curr_vals[I_ILP_TIME] += time;
353 }
354 void copystat_add_ilp_vars(int vars) {
355         curr_vals[I_ILP_VARS] += vars;
356 }
357 void copystat_add_ilp_csts(int csts) {
358         curr_vals[I_ILP_CSTR] += csts;
359 }
360 void copystat_add_ilp_iter(int iters) {
361         curr_vals[I_ILP_ITER] += iters;
362 }
363
364 #endif /* WITH_ILP */
365
366 void copystat_dump(ir_graph *irg) {
367         int i;
368         char buf[1024];
369         FILE *out;
370
371         snprintf(buf, sizeof(buf), "%s__%s", get_irp_prog_name(), get_entity_name(get_irg_entity(irg)));
372         buf[sizeof(buf) - 1] = '\0';
373         out = be_ffopen(buf, "stat", "wt");
374
375         fprintf(out, "%d\n", ASIZE);
376         for (i = 0; i < ASIZE; i++) {
377 #if 0
378                 if (i >= I_PHI_ARITY_S && i <= I_PHI_ARITY_E)
379                         fprintf(out, "%i %i\n", curr_vals[i], curr_vals[I_PHI_CNT]);
380                 else if (i >= I_CLS_SIZE_S && i <= I_CLS_SIZE_E)
381                         fprintf(out, "%i %i\n", curr_vals[i], curr_vals[I_CLS_CNT]);
382                 else
383 #endif
384                         fprintf(out, "%i\n", curr_vals[i]);
385         }
386
387         fclose(out);
388 }
389
390 void copystat_dump_pretty(ir_graph *irg) {
391         int i;
392         char buf[1024];
393         FILE *out;
394
395         snprintf(buf, sizeof(buf), "%s__%s", get_irp_prog_name(), get_entity_name(get_irg_entity(irg)));
396         buf[sizeof(buf) - 1] = '\0';
397         out = be_ffopen(buf, "pstat", "wt");
398
399         fprintf(out, "Nodes     %4d\n", curr_vals[I_ALL_NODES]);
400         fprintf(out, "Blocks    %4d\n", curr_vals[I_BLOCKS]);
401         fprintf(out, "CopyIrn   %4d\n", curr_vals[I_CPY_CNT]);
402
403         fprintf(out, "\nPhis      %4d\n", curr_vals[I_PHI_CNT]);
404         fprintf(out, "... argument types\n");
405         fprintf(out, " Total      %4d\n", curr_vals[I_PHI_ARG_CNT]);
406         fprintf(out, " Self       %4d\n", curr_vals[I_PHI_ARG_SELF]);
407         fprintf(out, " Constants  %4d\n", curr_vals[I_PHI_ARG_CONST]);
408         fprintf(out, " CF-Pred    %4d\n", curr_vals[I_PHI_ARG_PRED]);
409         fprintf(out, " Others     %4d\n", curr_vals[I_PHI_ARG_GLOB]);
410         fprintf(out, "... arities\n");
411         for (i = I_PHI_ARITY_S; i<=I_PHI_ARITY_E; i++)
412                 fprintf(out, " %2i %4d\n", i-I_PHI_ARITY_S, curr_vals[i]);
413
414         fprintf(out, "\nPhi classes   %4d\n", curr_vals[I_CLS_CNT]);
415         fprintf(out, " compl. free  %4d\n", curr_vals[I_CLS_IF_FREE]);
416         fprintf(out, " inner intf.  %4d / %4d\n", curr_vals[I_CLS_IF_CNT], curr_vals[I_CLS_IF_MAX]);
417         fprintf(out, "... sizes\n");
418         for (i = I_CLS_SIZE_S; i<=I_CLS_SIZE_E; i++)
419                 fprintf(out, " %2i %4d\n", i-I_CLS_SIZE_S, curr_vals[i]);
420         fprintf(out, "... contained phis\n");
421         for (i = I_CLS_PHIS_S; i<=I_CLS_PHIS_E; i++)
422                 fprintf(out, " %2i %4d\n", i-I_CLS_PHIS_S, curr_vals[i]);
423
424         fprintf(out, "\nILP stat\n");
425         fprintf(out, " Time %8d\n", curr_vals[I_ILP_TIME]);
426         fprintf(out, " Iter %8d\n", curr_vals[I_ILP_ITER]);
427
428         fprintf(out, "\nCopy stat\n");
429         fprintf(out, " Max  %4d\n", curr_vals[I_COPIES_MAX]);
430         fprintf(out, " Init %4d\n", curr_vals[I_COPIES_INIT]);
431         fprintf(out, " Heur %4d\n", curr_vals[I_COPIES_HEUR]);
432         fprintf(out, " Opt  %4d\n", curr_vals[I_COPIES_OPT]);
433         fprintf(out, " Intf %4d\n", curr_vals[I_COPIES_IF]);
434
435         fclose(out);
436 }
437
438 /**
439  * Helpers for saving and restoring colors of nodes.
440  * Used to get dependable and comparable benchmark results.
441  */
442 typedef struct color_saver {
443         arch_env_t *arch_env;
444         be_chordal_env_t *chordal_env;
445         pmap *saved_colors;
446         int flag; /* 0 save, 1 load */
447 } color_save_t;
448
449 static void save_load(ir_node *irn, void *env) {
450         color_save_t *saver = env;
451         if (saver->chordal_env->cls == arch_get_irn_reg_class(saver->arch_env, irn, -1)) {
452                 if (saver->flag == 0) { /* save */
453                         const arch_register_t *reg = arch_get_irn_register(saver->arch_env, irn);
454                         pmap_insert(saver->saved_colors, irn, (void *) reg);
455                 } else { /*load */
456                         arch_register_t *reg = pmap_get(saver->saved_colors, irn);
457                         arch_set_irn_register(saver->arch_env, irn, reg);
458                 }
459         }
460 }
461
462 static void save_colors(color_save_t *color_saver) {
463         color_saver->flag = 0;
464         irg_walk_graph(color_saver->chordal_env->irg, save_load, NULL, color_saver);
465 }
466
467 #ifdef WITH_ILP
468 static void load_colors(color_save_t *color_saver) {
469         color_saver->flag = 1;
470         irg_walk_graph(color_saver->chordal_env->irg, save_load, NULL, color_saver);
471 }
472 #endif
473
474 /**
475  * Main compare routine
476  */
477 void co_compare_solvers(be_chordal_env_t *chordal_env) {
478         copy_opt_t    *co;
479         lc_timer_t    *timer;
480         color_save_t  saver;
481         int costs_inevit, costs_init, costs_solved, lower_bound;
482
483         copystat_collect_cls(chordal_env);
484
485         co = new_copy_opt(chordal_env, co_get_costs_loop_depth);
486         co_build_ou_structure(co);
487         co_build_graph_structure(co);
488         DBG((dbg, LEVEL_1, "----> CO: %s\n", co->name));
489
490         /* save colors */
491         saver.arch_env     = chordal_env->birg->main_env->arch_env;
492         saver.chordal_env  = chordal_env;
493         saver.saved_colors = pmap_create();
494         save_colors(&saver);
495
496         /* initial values */
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);
500
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));
504
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));
508
509         /* heuristic 1 (Daniel Grund) */
510         timer = lc_timer_register("heur1", NULL);
511         lc_timer_reset_and_start(timer);
512
513         co_solve_heuristic(co);
514
515         lc_timer_stop(timer);
516
517         costs_solved = co_get_copy_costs(co);
518         DBG((dbg, LEVEL_1, "HEUR1 costs: %3d\n", costs_solved));
519         copystat_add_heur_time(lc_timer_elapsed_msec(timer));
520         copystat_add_heur_costs(costs_solved);
521         assert(lower_bound <= costs_solved);
522
523         /* heuristic 2 (Sebastian Hack) */
524         timer = lc_timer_register("heur2", NULL);
525         lc_timer_reset_and_start(timer);
526
527         co_solve_heuristic_new(co);
528
529         lc_timer_stop(timer);
530
531         costs_solved = co_get_copy_costs(co);
532         DBG((dbg, LEVEL_1, "HEUR2 costs: %3d\n", costs_solved));
533         copystat_add_heur_time(lc_timer_elapsed_msec(timer));
534         copystat_add_heur_costs(costs_solved);
535         assert(lower_bound <= costs_solved);
536
537         /* Park & Moon register coalescing (Kimon Hoffmann) */
538         timer = lc_timer_register("park", NULL);
539         lc_timer_reset_and_start(timer);
540
541         co_solve_park_moon(co);
542
543         lc_timer_stop(timer);
544
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(lc_timer_elapsed_msec(timer));
548         copystat_add_heur_costs(costs_solved);
549         assert(lower_bound <= costs_solved);
550
551
552 #ifdef WITH_ILP
553
554         /* ILP 1 is not yet implemented, so it makes no sense to compare */
555 #if 0
556         load_colors(&saver);
557
558         co_solve_ilp1(co, 60.0);
559
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);
564 #endif /* 0 */
565
566         /* ILP 2 */
567         load_colors(&saver);
568
569         co_solve_ilp2(co);
570
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);
575
576 #endif /* WITH_ILP */
577
578         /* free memory for statistic structures */
579         pmap_destroy(saver.saved_colors);
580         co_free_graph_structure(co);
581         co_free_ou_structure(co);
582         free_copy_opt(co);
583 }