nsz Git - libfirm/blob - ir/ana/execfreq.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       Compute an estimate of basic block executions.
  23  * @author      Adam M. Szalkowski
  24  * @date        28.05.2006
  25  * @version     $Id$
  26  */
  27 #include "config.h"
  28
  29 #include <stdio.h>
  30 #include <string.h>
  31 #include <limits.h>
  32 #include <math.h>
  33
  34 #include "gaussseidel.h"
  35
  36 #include "set.h"
  37 #include "hashptr.h"
  38 #include "debug.h"
  39 #include "statev.h"
  40 #include "dfs_t.h"
  41 #include "absgraph.h"
  42
  43 #include "irprog_t.h"
  44 #include "irgraph_t.h"
  45 #include "irnode_t.h"
  46 #include "irloop.h"
  47 #include "irgwalk.h"
  48 #include "iredges.h"
  49 #include "irprintf.h"
  50 #include "irtools.h"
  51 #include "irhooks.h"
  52
  53 #include "execfreq.h"
  54
  55 /* enable to also solve the equations with Gauss-Jordan */
  56 #undef COMPARE_AGAINST_GAUSSJORDAN
  57
  58 #ifdef COMPARE_AGAINST_GAUSSJORDAN
  59 #include "gaussjordan.h"
  60 #endif
  61
  62
  63 #define EPSILON              1e-5
  64 #define UNDEF(x)         (fabs(x) < EPSILON)
  65 #define SEIDEL_TOLERANCE 1e-7
  66
  67 #define MAX_INT_FREQ 1000000
  68
  69 #define set_foreach(s,i) for((i)=set_first((s)); (i); (i)=set_next((s)))
  70
  71 typedef struct _freq_t {
  72         const ir_node    *irn;
  73         int               idx;
  74         double            freq;
  75 } freq_t;
  76
  77 struct ir_exec_freq {
  78         set *set;
  79         hook_entry_t hook;
  80         double max;
  81         double min_non_zero;
  82         double m, b;
  83         unsigned infeasible : 1;
  84 };
  85
  86 static int
  87 cmp_freq(const void *a, const void *b, size_t size)
  88 {
  89         const freq_t *p = a;
  90         const freq_t *q = b;
  91         (void) size;
  92
  93         return !(p->irn == q->irn);
  94 }
  95
  96 static freq_t *
  97 set_find_freq(set * set, const ir_node * irn)
  98 {
  99         freq_t     query;
 100
 101         query.irn = irn;
 102         return set_find(set, &query, sizeof(query), HASH_PTR(irn));
 103 }
 104
 105 static freq_t *
 106 set_insert_freq(set * set, const ir_node * irn)
 107 {
 108         freq_t query;
 109
 110         query.irn = irn;
 111         query.freq = 0.0;
 112         query.idx  = -1;
 113         return set_insert(set, &query, sizeof(query), HASH_PTR(irn));
 114 }
 115
 116 double
 117 get_block_execfreq(const ir_exec_freq *ef, const ir_node * irn)
 118 {
 119         if(!ef->infeasible) {
 120                 set *freqs = ef->set;
 121                 freq_t *freq;
 122                 assert(is_Block(irn));
 123                 freq = set_find_freq(freqs, irn);
 124                 assert(freq);
 125
 126                 assert(freq->freq >= 0);
 127                 return freq->freq;
 128         }
 129
 130         return 1.0;
 131 }
 132
 133 unsigned long
 134 get_block_execfreq_ulong(const ir_exec_freq *ef, const ir_node *bb)
 135 {
 136         double f       = get_block_execfreq(ef, bb);
 137         int res        = (int) (f > ef->min_non_zero ? ef->m * f + ef->b : 1.0);
 138         return res;
 139 }
 140
 141 static double *
 142 solve_lgs(gs_matrix_t *mat, double *x, int size)
 143 {
 144         double init = 1.0 / size;
 145         double dev;
 146         int i, iter = 0;
 147
 148         /* better convergence. */
 149         for (i = 0; i < size; ++i)
 150                 x[i] = init;
 151
 152         stat_ev_dbl("execfreq_matrix_size", size);
 153         stat_ev_tim_push();
 154         do {
 155                 ++iter;
 156                 dev = gs_matrix_gauss_seidel(mat, x, size);
 157         } while(fabs(dev) > SEIDEL_TOLERANCE);
 158         stat_ev_tim_pop("execfreq_seidel_time");
 159         stat_ev_dbl("execfreq_seidel_iter", iter);
 160
 161 #ifdef COMPARE_AGAINST_GAUSSJORDAN
 162         {
 163                 double *nw = XMALLOCN(double, size * size);
 164                 double *nx = XMALLOCNZ(double, size);
 165
 166                 gs_matrix_export(mat, nw, size);
 167
 168                 stat_ev_tim_push();
 169                 firm_gaussjordansolve(nw, nx, size);
 170                 stat_ev_tim_pop("execfreq_jordan_time");
 171
 172                 xfree(nw);
 173                 xfree(nx);
 174         }
 175 #endif
 176
 177         return x;
 178 }
 179
 180 static double
 181 get_cf_probability(ir_node *bb, int pos, double loop_weight)
 182 {
 183         double           sum = 0.0;
 184         double           cur = 0.0;
 185         double           inv_loop_weight = 1./loop_weight;
 186         const ir_node   *pred = get_Block_cfgpred_block(bb, pos);
 187         const ir_loop   *pred_loop;
 188         int              pred_depth;
 189         const ir_edge_t *edge;
 190         const ir_loop   *loop;
 191         int              depth;
 192         int              d;
 193
 194         if (is_Bad(pred))
 195                 return 0;
 196
 197         loop       = get_irn_loop(bb);
 198         depth      = get_loop_depth(loop);
 199         pred_loop  = get_irn_loop(pred);
 200         pred_depth = get_loop_depth(pred_loop);
 201
 202         cur = 1.0;
 203         for (d = depth; d < pred_depth; ++d) {
 204                 cur *= inv_loop_weight;
 205         }
 206
 207         foreach_block_succ(pred, edge) {
 208                 const ir_node *succ       = get_edge_src_irn(edge);
 209                 const ir_loop *succ_loop  = get_irn_loop(succ);
 210                 int            succ_depth = get_loop_depth(succ_loop);
 211
 212                 double         fac = 1.0;
 213                 for (d = succ_depth; d < pred_depth; ++d) {
 214                         fac *= inv_loop_weight;
 215                 }
 216                 sum += fac;
 217         }
 218
 219         return cur/sum;
 220 }
 221
 222 static void exec_freq_node_info(void *ctx, FILE *f, const ir_node *irn)
 223 {
 224         if(is_Block(irn)) {
 225                 ir_exec_freq *ef = ctx;
 226                 fprintf(f, "execution frequency: %g/%lu\n", get_block_execfreq(ef, irn), get_block_execfreq_ulong(ef, irn));
 227         }
 228 }
 229
 230 ir_exec_freq *create_execfreq(ir_graph *irg)
 231 {
 232         ir_exec_freq *execfreq = XMALLOCZ(ir_exec_freq);
 233         execfreq->set = new_set(cmp_freq, 32);
 234
 235         memset(&execfreq->hook, 0, sizeof(execfreq->hook));
 236         execfreq->hook.context = execfreq;
 237         execfreq->hook.hook._hook_node_info = exec_freq_node_info;
 238         register_hook(hook_node_info, &execfreq->hook);
 239         (void) irg;
 240
 241         return execfreq;
 242 }
 243
 244 void set_execfreq(ir_exec_freq *execfreq, const ir_node *block, double freq)
 245 {
 246         freq_t *f = set_insert_freq(execfreq->set, block);
 247         f->freq = freq;
 248 }
 249
 250 static void collect_blocks(ir_node *bl, void *data)
 251 {
 252         set *freqs = data;
 253         set_insert_freq(freqs, bl);
 254 }
 255
 256 ir_exec_freq *
 257 compute_execfreq(ir_graph * irg, double loop_weight)
 258 {
 259         gs_matrix_t  *mat;
 260         int           size;
 261         int           idx;
 262         freq_t       *freq, *s, *e;
 263         ir_exec_freq *ef;
 264         set          *freqs;
 265         dfs_t        *dfs;
 266         double       *x;
 267         double        norm;
 268
 269         /*
 270          * compute a DFS.
 271          * using a toposort on the CFG (without back edges) will propagate
 272          * the values better for the gauss/seidel iteration.
 273          * => they can "flow" from start to end.
 274          */
 275         dfs = dfs_new(&absgraph_irg_cfg_succ, irg);
 276         ef = XMALLOCZ(ir_exec_freq);
 277         ef->min_non_zero = HUGE_VAL; /* initialize with a reasonable large number. */
 278         freqs = ef->set = new_set(cmp_freq, dfs_get_n_nodes(dfs));
 279
 280         /*
 281          * Populate the exec freq set.
 282          * The DFS cannot be used alone, since the CFG might not be connected
 283          * due to unreachable code.
 284          */
 285         irg_block_walk_graph(irg, collect_blocks, NULL, freqs);
 286
 287         construct_cf_backedges(irg);
 288         edges_assure(irg);
 289
 290         size = dfs_get_n_nodes(dfs);
 291         mat  = gs_new_matrix(size, size);
 292         x    = XMALLOCN(double, size);
 293
 294         for (idx = dfs_get_n_nodes(dfs) - 1; idx >= 0; --idx) {
 295                 ir_node *bb = (ir_node *) dfs_get_post_num_node(dfs, size - idx - 1);
 296                 freq_t *freq;
 297                 int i;
 298
 299                 freq = set_insert_freq(freqs, bb);
 300                 freq->idx = idx;
 301
 302                 for(i = get_Block_n_cfgpreds(bb) - 1; i >= 0; --i) {
 303                         ir_node *pred = get_Block_cfgpred_block(bb, i);
 304                         int pred_idx  = size - dfs_get_post_num(dfs, pred) - 1;
 305
 306                         gs_matrix_set(mat, idx, pred_idx, get_cf_probability(bb, i, loop_weight));
 307                 }
 308                 gs_matrix_set(mat, idx, idx, -1.0);
 309         }
 310
 311         dfs_free(dfs);
 312
 313         /*
 314          * Add a loop from end to start.
 315          * The problem is then an eigenvalue problem:
 316          * Solve A*x = 1*x => (A-I)x = 0
 317          */
 318         s = set_find_freq(freqs, get_irg_start_block(irg));
 319         e = set_find_freq(freqs, get_irg_end_block(irg));
 320         if (e->idx >= 0)
 321                 gs_matrix_set(mat, s->idx, e->idx, 1.0);
 322
 323         /* solve the system and delete the matrix */
 324         solve_lgs(mat, x, size);
 325         gs_delete_matrix(mat);
 326
 327         /*
 328          * compute the normalization factor.
 329          * 1.0 / exec freq of start block.
 330          */
 331         norm = x[s->idx] != 0.0 ? 1.0 / x[s->idx] : 1.0;
 332
 333         ef->max = 0.0;
 334         set_foreach(freqs, freq) {
 335                 int idx = freq->idx;
 336
 337                 /* take abs because it sometimes can be -0 in case of endless loops */
 338                 freq->freq = fabs(x[idx]) * norm;
 339
 340                 /* get the maximum exec freq */
 341                 ef->max = MAX(ef->max, freq->freq);
 342
 343                 /* Get the minimum non-zero execution frequency. */
 344                 if(freq->freq > 0.0)
 345                         ef->min_non_zero = MIN(ef->min_non_zero, freq->freq);
 346         }
 347
 348         /* compute m and b of the transformation used to convert the doubles into scaled ints */
 349         {
 350                 double smallest_diff = 1.0;
 351
 352                 double l2 = ef->min_non_zero;
 353                 double h2 = ef->max;
 354                 double l1 = 1.0;
 355                 double h1 = MAX_INT_FREQ;
 356
 357                 double *fs = malloc(set_count(freqs) * sizeof(fs[0]));
 358                 int i, j, n = 0;
 359
 360                 set_foreach(freqs, freq)
 361                         fs[n++] = freq->freq;
 362
 363                 /*
 364                  * find the smallest difference of the execution frequencies
 365                  * we try to ressolve it with 1 integer.
 366                  */
 367                 for(i = 0; i < n; ++i) {
 368                         if(fs[i] <= 0.0)
 369                                 continue;
 370
 371                         for(j = i + 1; j < n; ++j) {
 372                                 double diff = fabs(fs[i] - fs[j]);
 373
 374                                 if(!UNDEF(diff))
 375                                         smallest_diff = MIN(diff, smallest_diff);
 376                         }
 377                 }
 378
 379                 /* according to that the slope of the translation function is 1.0 / smallest diff */
 380                 ef->m = 1.0 / smallest_diff;
 381
 382                 /* the abscissa is then given by */
 383                 ef->b = l1 - ef->m * l2;
 384
 385                 /*
 386                  * if the slope is so high that the largest integer would be larger than MAX_INT_FREQ
 387                  * set the largest int freq to that upper limit and recompute the translation function
 388                  */
 389                 if(ef->m * h2 + ef->b > MAX_INT_FREQ) {
 390                         ef->m = (h1 - l1) / (h2 - l2);
 391                         ef->b = l1 - ef->m * l2;
 392                 }
 393
 394                 free(fs);
 395         }
 396
 397         memset(&ef->hook, 0, sizeof(ef->hook));
 398         ef->hook.context = ef;
 399         ef->hook.hook._hook_node_info = exec_freq_node_info;
 400         register_hook(hook_node_info, &ef->hook);
 401
 402         xfree(x);
 403
 404         return ef;
 405 }
 406
 407 void
 408 free_execfreq(ir_exec_freq *ef)
 409 {
 410         del_set(ef->set);
 411         unregister_hook(hook_node_info, &ef->hook);
 412         free(ef);
 413 }