Added exec_freq_t type
[libfirm] / ir / ana / execfreq.c
1 /*
2  * Project:     libFIRM
3  * File name:   ir/ana/execfreq.c
4  * Purpose:     Compute an estimate of basic block executions.
5  * Author:      Adam M. Szalkowski
6  * Modified by:
7  * Created:     28.05.2006
8  * CVS-ID:      $Id$
9  * Copyright:   (c) 2006 Universität Karlsruhe
10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
11  */
12
13 #ifdef HAVE_CONFIG_H
14 #include "config.h"
15 #endif
16
17 //#define USE_GSL
18
19 #include <stdio.h>
20 #include <string.h>
21 #include <math.h>
22
23 #ifdef USE_GSL
24 #include <gsl/gsl_linalg.h>
25 #include <gsl/gsl_vector.h>
26 #else
27 #include "gaussjordan.h"
28 #endif
29
30 #include "execfreq.h"
31
32 #include "firm_common_t.h"
33 #include "set.h"
34 #include "hashptr.h"
35
36 #include "irprog_t.h"
37 #include "irgraph_t.h"
38 #include "irnode_t.h"
39 #include "irloop.h"
40 #include "irgwalk.h"
41 #include "irouts.h"
42 #include "irprintf.h"
43 #include "irhooks.h"
44
45 #include "execfreq.h"
46
47 #define set_foreach(s,i) for((i)=set_first((s)); (i); (i)=set_next((s)))
48
49 typedef struct _freq_t {
50         const ir_node    *irn;
51         double            freq;
52 } freq_t;
53
54
55 typedef struct _walkerdata_t {
56   set    *set;
57   size_t  idx;
58 } walkerdata_t;
59
60 struct _exec_freq_t {
61   set *set;
62         hook_entry_t hook;
63         unsigned infeasible : 1;
64 };
65
66 static int
67 cmp_freq(const void *a, const void *b, size_t size)
68 {
69   const freq_t *p = a;
70   const freq_t *q = b;
71
72   return !(p->irn == q->irn);
73 }
74
75 static freq_t *
76 set_find_freq(set * set, const ir_node * irn)
77 {
78   freq_t     query;
79
80   query.irn = irn;
81   return set_find(set, &query, sizeof(query), HASH_PTR(irn));
82 }
83
84 static freq_t *
85 set_insert_freq(set * set, const ir_node * irn)
86 {
87   freq_t     query;
88
89   query.irn = irn;
90   query.freq = 0.0;
91   return set_insert(set, &query, sizeof(query), HASH_PTR(irn));
92 }
93
94 double
95 get_block_execfreq(const exec_freq_t *ef, const ir_node * irn)
96 {
97         if(!ef->infeasible) {
98                 set *freqs = ef->set;
99                 freq_t *freq;
100                 assert(is_Block(irn));
101                 freq = set_find_freq(freqs, irn);
102                 assert(freq);
103                 return freq->freq;
104         }
105
106         return 1.0;
107 }
108
109 #define ZERO(x)   (fabs(x) < 0.0001)
110
111 static void
112 block_walker(ir_node * bb, void * data)
113 {
114   walkerdata_t  *wd = data;
115
116   set_insert_freq(wd->set, bb);
117   set_irn_link(bb, (void*)wd->idx++);
118 }
119
120 #ifdef USE_GSL
121 static gsl_vector *
122 solve_lgs(double * a_data, double * b_data, size_t size)
123 {
124   gsl_matrix_view m
125     = gsl_matrix_view_array (a_data, size, size);
126
127   gsl_vector_view b
128     = gsl_vector_view_array (b_data, size);
129
130   gsl_vector *x = gsl_vector_alloc (size);
131
132   int s;
133
134   gsl_permutation * p = gsl_permutation_alloc (size);
135
136   gsl_linalg_LU_decomp (&m.matrix, p, &s);
137
138   gsl_linalg_LU_solve (&m.matrix, p, &b.vector, x);
139
140   gsl_permutation_free (p);
141
142   return x;
143 }
144 #else
145 static double *
146 solve_lgs(double * A, double * b, size_t size)
147 {
148   if(firm_gaussjordansolve(A,b,size) == 0) {
149     return b;
150   } else {
151     return NULL;
152   }
153 }
154 #endif
155
156 static double
157 get_cf_probability(ir_node *bb, int pos, double loop_weight)
158 {
159   double  sum = 0.0;
160   double  cur = 0.0;
161   int     i;
162   ir_node *pred = get_Block_cfgpred_block(bb, pos);
163
164   cur = get_loop_depth(get_irn_loop(bb)) < get_loop_depth(get_irn_loop(pred)) ? 1.0 : loop_weight;
165
166   for(i = get_Block_n_cfg_outs(pred) - 1; i >= 0; --i) {
167     ir_node *succ = get_Block_cfg_out(pred, i);
168
169     sum += get_loop_depth(get_irn_loop(succ)) < get_loop_depth(get_irn_loop(pred)) ? 1.0 : loop_weight;
170   }
171
172   return cur/sum;
173 }
174
175 static void exec_freq_node_info(void *ctx, FILE *f, const ir_node *irn)
176 {
177         if(is_Block(irn)) {
178                 exec_freq_t *ef = ctx;
179                 fprintf(f, "execution frequency: %g\n", get_block_execfreq(ef, irn));
180         }
181 }
182
183 exec_freq_t *
184 compute_execfreq(ir_graph * irg, double loop_weight)
185 {
186   size_t        size;
187   double       *matrix;
188   double       *rhs;
189   int           i;
190   freq_t       *freq;
191   walkerdata_t  wd;
192         exec_freq_t  *ef;
193         set          *freqs;
194 #ifdef USE_GSL
195   gsl_vector   *x;
196 #else
197   double       *x;
198 #endif
199
200         ef = xmalloc(sizeof(ef[0]));
201         memset(ef, 0, sizeof(ef[0]));
202   freqs = ef->set = new_set(cmp_freq, 32);
203
204   construct_cf_backedges(irg);
205
206   wd.idx = 0;
207   wd.set = freqs;
208
209   irg_block_walk_graph(irg, block_walker, NULL, &wd);
210
211   size = set_count(freqs);
212   matrix = xmalloc(size*size*sizeof(*matrix));
213   memset(matrix, 0, size*size*sizeof(*matrix));
214   rhs = xmalloc(size*sizeof(*rhs));
215   memset(rhs, 0, size*sizeof(*rhs));
216
217   set_foreach(freqs, freq) {
218     ir_node *bb = (ir_node *)freq->irn;
219     size_t  idx = (int)get_irn_link(bb);
220
221     matrix[idx * (size + 1)] = -1.0;
222
223     if (bb == get_irg_start_block(irg)) {
224       rhs[(int)get_irn_link(bb)] = -1.0;
225       continue;
226     }
227
228     for(i = get_Block_n_cfgpreds(bb) - 1; i >= 0; --i) {
229       ir_node *pred    = get_Block_cfgpred_block(bb, i);
230       size_t  pred_idx = (int)get_irn_link(pred);
231
232 //      matrix[pred_idx + idx*size] += 1.0/(double)get_Block_n_cfg_outs(pred);
233       matrix[pred_idx + idx * size] += get_cf_probability(bb, i, loop_weight);
234     }
235   }
236
237   x = solve_lgs(matrix, rhs, size);
238   if(x == NULL) {
239                 ef->infeasible = 1;
240                 return ef;
241   }
242
243   set_foreach(freqs, freq) {
244     const ir_node *bb = freq->irn;
245     size_t        idx = PTR_TO_INT(get_irn_link(bb));
246
247 #ifdef USE_GSL
248     freq->freq = ZERO(gsl_vector_get(x, idx)) ? 0.0 : gsl_vector_get(x, idx);
249 #else
250     freq->freq = ZERO(x[idx]) ? 0.0 : x[idx];
251 #endif
252 //    ir_fprintf(stderr, "execfreq %+F: %f\n", bb, freq->freq);
253   }
254
255 #ifdef USE_GSL
256   gsl_vector_free(x);
257 #endif
258   free(matrix);
259
260         memset(&ef->hook, 0, sizeof(ef->hook));
261         ef->hook.context = ef;
262         ef->hook.hook._hook_node_info = exec_freq_node_info;
263         register_hook(hook_node_info, &ef->hook);
264
265   return ef;
266 }
267
268 void
269 free_execfreq(exec_freq_t *ef)
270 {
271         del_set(ef->set);
272         unregister_hook(hook_node_info, &ef->hook);
273         free(ef);
274 }
275
276 #undef ELEM