2 * Copyright (C) 1995-2007 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 Compute an estimate of basic block executions.
23 * @author Adam M. Szalkowski
39 #include <gsl/gsl_linalg.h>
40 #include <gsl/gsl_vector.h>
42 #include "gaussjordan.h"
45 #include "firm_common_t.h"
51 #include "irgraph_t.h"
61 #define set_foreach(s,i) for((i)=set_first((s)); (i); (i)=set_next((s)))
63 #define MAX_INT_FREQ 1000000
65 typedef struct _freq_t {
71 typedef struct _walkerdata_t {
82 unsigned infeasible : 1;
86 cmp_freq(const void *a, const void *b, size_t size)
92 return !(p->irn == q->irn);
96 set_find_freq(set * set, const ir_node * irn)
101 return set_find(set, &query, sizeof(query), HASH_PTR(irn));
105 set_insert_freq(set * set, const ir_node * irn)
111 return set_insert(set, &query, sizeof(query), HASH_PTR(irn));
115 get_block_execfreq(const ir_exec_freq *ef, const ir_node * irn)
117 if(!ef->infeasible) {
118 set *freqs = ef->set;
120 assert(is_Block(irn));
121 freq = set_find_freq(freqs, irn);
124 assert(freq->freq >= 0);
132 get_block_execfreq_ulong(const ir_exec_freq *ef, const ir_node *bb)
134 double f = get_block_execfreq(ef, bb);
135 int res = (int) (f > ef->min_non_zero ? ef->m * f + ef->b : 1.0);
137 // printf("%20.6f %10d\n", f, res);
141 #define EPSILON 0.0001
142 #define UNDEF(x) !(x > EPSILON)
145 block_walker(ir_node * bb, void * data)
147 walkerdata_t *wd = data;
149 set_insert_freq(wd->set, bb);
150 set_irn_link(bb, (void*)wd->idx++);
155 solve_lgs(double * a_data, double * b_data, size_t size)
158 = gsl_matrix_view_array (a_data, size, size);
161 = gsl_vector_view_array (b_data, size);
163 gsl_vector *x = gsl_vector_alloc (size);
167 gsl_permutation * p = gsl_permutation_alloc (size);
169 gsl_linalg_LU_decomp (&m.matrix, p, &s);
171 gsl_linalg_LU_solve (&m.matrix, p, &b.vector, x);
173 gsl_permutation_free (p);
179 solve_lgs(double * A, double * b, size_t size)
181 if(firm_gaussjordansolve(A,b,size) == 0) {
190 get_cf_probability(ir_node *bb, int pos, double loop_weight)
194 const ir_node *pred = get_Block_cfgpred_block(bb, pos);
195 const ir_loop *pred_loop = get_irn_loop(pred);
196 int pred_depth = get_loop_depth(pred_loop);
197 const ir_edge_t *edge;
199 cur = get_loop_depth(get_irn_loop(bb)) < get_loop_depth(get_irn_loop(pred)) ? 1.0 : loop_weight;
201 foreach_block_succ(pred, edge) {
202 const ir_node *block = get_edge_src_irn(edge);
203 const ir_loop *loop = get_irn_loop(block);
204 int depth = get_loop_depth(loop);
205 sum += depth < pred_depth ? 1.0 : loop_weight;
211 static void exec_freq_node_info(void *ctx, FILE *f, const ir_node *irn)
214 ir_exec_freq *ef = ctx;
215 fprintf(f, "execution frequency: %g/%lu\n", get_block_execfreq(ef, irn), get_block_execfreq_ulong(ef, irn));
219 ir_exec_freq *create_execfreq(ir_graph *irg)
221 ir_exec_freq *execfreq = xmalloc(sizeof(execfreq[0]));
222 memset(execfreq, 0, sizeof(execfreq[0]));
223 execfreq->set = new_set(cmp_freq, 32);
225 memset(&execfreq->hook, 0, sizeof(execfreq->hook));
226 execfreq->hook.context = execfreq;
227 execfreq->hook.hook._hook_node_info = exec_freq_node_info;
228 register_hook(hook_node_info, &execfreq->hook);
234 void set_execfreq(ir_exec_freq *execfreq, const ir_node *block, double freq)
236 freq_t *f = set_insert_freq(execfreq->set, block);
241 compute_execfreq(ir_graph * irg, double loop_weight)
257 ef = xmalloc(sizeof(ef[0]));
258 memset(ef, 0, sizeof(ef[0]));
259 ef->min_non_zero = 1e50; /* initialize with a reasonable large number. */
260 freqs = ef->set = new_set(cmp_freq, 32);
262 construct_cf_backedges(irg);
263 /* TODO: edges are corrupt for EDGE_KIND_BLOCK after the local optimize
264 graph phase merges blocks in the x86 backend */
265 edges_deactivate(irg);
267 /* edges_assure(irg); */
272 irg_block_walk_graph(irg, block_walker, NULL, &wd);
274 size = set_count(freqs);
275 matrix = xmalloc(size*size*sizeof(*matrix));
276 memset(matrix, 0, size*size*sizeof(*matrix));
277 rhs = xmalloc(size*sizeof(*rhs));
278 memset(rhs, 0, size*sizeof(*rhs));
280 set_foreach(freqs, freq) {
281 ir_node *bb = (ir_node *)freq->irn;
282 size_t idx = (int)get_irn_link(bb);
284 matrix[idx * (size + 1)] = -1.0;
286 if (bb == get_irg_start_block(irg)) {
287 rhs[(int)get_irn_link(bb)] = -1.0;
291 for(i = get_Block_n_cfgpreds(bb) - 1; i >= 0; --i) {
292 ir_node *pred = get_Block_cfgpred_block(bb, i);
293 size_t pred_idx = (int)get_irn_link(pred);
295 // matrix[pred_idx + idx*size] += 1.0/(double)get_Block_n_cfg_outs(pred);
296 matrix[pred_idx + idx * size] += get_cf_probability(bb, i, loop_weight);
300 x = solve_lgs(matrix, rhs, size);
302 DEBUG_ONLY(ir_fprintf(stderr, "Debug Warning: Couldn't estimate execution frequencies for %+F\n", irg));
307 set_foreach(freqs, freq) {
308 const ir_node *bb = freq->irn;
309 size_t idx = PTR_TO_INT(get_irn_link(bb));
312 freq->freq = UNDEF(gsl_vector_get(x, idx)) ? EPSILON : gsl_vector_get(x, idx);
314 freq->freq = UNDEF(x[idx]) ? EPSILON : x[idx];
317 /* get the maximum exec freq */
318 ef->max = MAX(ef->max, freq->freq);
320 /* Get the minimum non-zero execution frequency. */
322 ef->min_non_zero = MIN(ef->min_non_zero, freq->freq);
325 /* compute m and b of the transformation used to convert the doubles into scaled ints */
327 double smallest_diff = 1.0;
329 double l2 = ef->min_non_zero;
332 double h1 = MAX_INT_FREQ;
334 double *fs = malloc(set_count(freqs) * sizeof(fs[0]));
337 set_foreach(freqs, freq)
338 fs[n++] = freq->freq;
341 * find the smallest difference of the execution frequencies
342 * we try to ressolve it with 1 integer.
344 for(i = 0; i < n; ++i) {
348 for(j = i + 1; j < n; ++j) {
349 double diff = fabs(fs[i] - fs[j]);
352 smallest_diff = MIN(diff, smallest_diff);
356 /* according to that the slope of the translation function is 1.0 / smallest diff */
357 ef->m = 1.0 / smallest_diff;
359 /* the abscissa is then given by */
360 ef->b = l1 - ef->m * l2;
363 * if the slope is so high that the largest integer would be larger than MAX_INT_FREQ
364 * set the largest int freq to that upper limit and recompute the translation function
366 if(ef->m * h2 + ef->b > MAX_INT_FREQ) {
367 ef->m = (h1 - l1) / (h2 - l2);
368 ef->b = l1 - ef->m * l2;
371 // printf("smallest_diff: %g, l1: %f, h1: %f, l2: %f, h2: %f, m: %f, b: %f\n", smallest_diff, l1, h1, l2, h2, ef->m, ef->b);
378 memset(&ef->hook, 0, sizeof(ef->hook));
379 ef->hook.context = ef;
380 ef->hook.hook._hook_node_info = exec_freq_node_info;
381 register_hook(hook_node_info, &ef->hook);
391 free_execfreq(ir_exec_freq *ef)
394 unregister_hook(hook_node_info, &ef->hook);