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 Code instrumentation and execution count profiling.
23 * @author Adam M. Szalkowski
53 #include "besched_t.h"
63 #include "bechordal_t.h"
65 #include "beprofile.h"
67 /** An entry in the id-to-location map */
68 typedef struct loc_entry {
69 ir_entity *fname; /**< the entity holding the file name */
70 unsigned int lineno; /**< line number */
73 typedef struct _block_id_walker_data_t {
74 tarval **array; /**< the entity the holds the block counts */
75 unsigned int id; /**< current block id number */
76 ir_node *symconst; /**< the SymConst representing array */
77 pmap *fname_map; /**< set containing all found filenames */
78 loc_entry *locs; /**< locations */
79 ir_type *tp_char; /**< the character type */
80 unsigned flags; /**< profile flags */
81 } block_id_walker_data_t;
83 typedef struct _execcount_t {
89 cmp_execcount(const void * a, const void * b, size_t size)
92 return ((execcount_t*)a)->block != ((execcount_t*)b)->block;
96 block_counter(ir_node * bb, void * data)
98 unsigned int *count = data;
104 count_blocks(ir_graph * irg)
106 unsigned int count = 0;
108 irg_block_walk_graph(irg, block_counter, NULL, &count);
112 /* keep the execcounts here because they are only read once per compiler run */
113 static set * profile = NULL;
114 static hook_entry_t hook;
117 * Instrument a block with code needed for profiling
120 instrument_block(ir_node * bb, ir_node * address, unsigned int id)
122 ir_graph *irg = get_irn_irg(bb);
123 ir_node *start_block = get_irg_start_block(irg);
124 ir_node *load, *store, *offset, *add, *projm, *proji, *unknown;
128 * We can't instrument the end block as there are no real instructions there
130 if(bb == get_irg_end_block(irg))
133 unknown = new_r_Unknown(irg, mode_M);
134 cnst = new_r_Const_long(irg, start_block, mode_Iu, get_mode_size_bytes(mode_Iu) * id);
135 offset = new_r_Add(irg, bb, address, cnst, mode_P);
136 load = new_r_Load(irg, bb, unknown, offset, mode_Iu);
137 projm = new_r_Proj(irg, bb, load, mode_M, pn_Load_M);
138 proji = new_r_Proj(irg, bb, load, mode_Iu, pn_Load_res);
139 cnst = new_r_Const_long(irg, start_block, mode_Iu, 1);
140 add = new_r_Add(irg, bb, proji, cnst, mode_Iu);
141 store = new_r_Store(irg, bb, projm, offset, add);
142 projm = new_r_Proj(irg, bb, store, mode_M, pn_Store_M);
143 set_irn_link(bb, projm);
144 set_irn_link(projm, load);
147 typedef struct fix_env {
152 * SSA Construction for instrumentation code memory
155 fix_ssa(ir_node * bb, void * data)
159 int arity = get_Block_n_cfgpreds(bb);
161 /* start and end block are not instrumented, skip! */
162 if (bb == env->end_block)
165 if (bb == get_irg_start_block(get_irn_irg(bb))) {
167 } else if (arity == 1) {
168 mem = get_irn_link(get_Block_cfgpred_block(bb, 0));
172 ir_graph *irg = current_ir_graph;
174 NEW_ARR_A(ir_node*, ins, arity);
175 for (n = arity - 1; n >= 0; --n) {
176 ins[n] = get_irn_link(get_Block_cfgpred_block(bb, n));
178 mem = new_r_Phi(irg, bb, arity, ins, mode_M);
180 set_Load_mem(get_irn_link(get_irn_link(bb)), mem);
185 * Generates a new irg which calls the initializer
188 * void __firmprof_initializer(void) { __init_firmprof(ent_filename, bblock_id, bblock_counts, n_blocks); }
191 gen_initializer_irg(ir_entity * ent_filename, ir_entity * bblock_id, ir_entity * bblock_counts, int n_blocks)
193 ir_node *start_block;
196 ident *name = new_id_from_str("__firmprof_initializer");
197 ir_entity *ent = new_entity(get_glob_type(), name, new_type_method(name, 0, 0));
198 ir_node *ret, *call, *symconst;
201 ident *init_name = new_id_from_str("__init_firmprof");
202 ir_type *init_type = new_type_method(init_name, 4, 0);
203 ir_type *uint, *uintptr, *string;
207 ir_type *empty_frame_type;
209 set_entity_ld_ident(ent, name);
211 uint = new_type_primitive(new_id_from_str("__uint"), mode_Iu);
212 uintptr = new_type_pointer(new_id_from_str("__uintptr"), uint, mode_P);
213 string = new_type_pointer(new_id_from_str("__charptr"), new_type_primitive(new_id_from_str("__char"), mode_Bs), mode_P);
215 set_method_param_type(init_type, 0, string);
216 set_method_param_type(init_type, 1, uintptr);
217 set_method_param_type(init_type, 2, uintptr);
218 set_method_param_type(init_type, 3, uint);
219 init_ent = new_entity(get_glob_type(), init_name, init_type);
220 set_entity_ld_ident(init_ent, init_name);
222 irg = new_ir_graph(ent, 0);
223 empty_frame_type = get_irg_frame_type(irg);
224 set_type_size_bytes(empty_frame_type, 0);
226 bb = get_cur_block();
228 start_block = get_irg_start_block(irg);
230 sym.entity_p = init_ent;
231 symconst = new_r_SymConst(irg, start_block, sym, symconst_addr_ent);
233 sym.entity_p = ent_filename;
234 ins[0] = new_r_SymConst(irg, start_block, sym, symconst_addr_ent);
235 sym.entity_p = bblock_id;
236 ins[1] = new_r_SymConst(irg, start_block, sym, symconst_addr_ent);
237 sym.entity_p = bblock_counts;
238 ins[2] = new_r_SymConst(irg, start_block, sym, symconst_addr_ent);
239 ins[3] = new_r_Const_long(irg, start_block, mode_Iu, n_blocks);
241 call = new_r_Call(irg, bb, get_irg_initial_mem(irg), symconst, 4, ins, init_type);
242 ret = new_r_Return(irg, bb, new_r_Proj(irg, bb, call, mode_M, pn_Call_M_regular), 0, NULL);
245 add_immBlock_pred(get_irg_end_block(irg), ret);
246 mature_immBlock(get_irg_end_block(irg));
248 irg_finalize_cons(irg);
254 * Create the location data for the given debug info.
256 static void create_location_data(dbg_info *dbg, block_id_walker_data_t *wd)
259 const char *fname = be_retrieve_dbg_info(dbg, &lineno);
262 pmap_entry *entry = pmap_find(wd->fname_map, (void *)fname);
266 static unsigned nr = 0;
270 int i, len = strlen(fname) + 1;
271 tarval **tarval_string;
273 snprintf(buf, sizeof(buf), "firm_name_arr.%d", nr);
274 arr = new_type_array(new_id_from_str(buf), 1, wd->tp_char);
275 set_array_bounds_int(arr, 0, 0, len);
277 snprintf(buf, sizeof(buf), "__firm_name.%d", nr++);
278 id = new_id_from_str(buf);
279 ent = new_entity(get_glob_type(), id, arr);
280 set_entity_ld_ident(ent, id);
282 pmap_insert(wd->fname_map, (void *)fname, ent);
284 /* initialize file name string constant */
285 tarval_string = alloca(sizeof(*tarval_string) * (len));
286 for (i = 0; i < len; ++i) {
287 tarval_string[i] = new_tarval_from_long(fname[i], mode_Bs);
289 set_entity_variability(ent, variability_constant);
290 set_array_entity_values(ent, tarval_string, len);
294 wd->locs[wd->id].fname = ent;
295 wd->locs[wd->id].lineno = lineno;
297 wd->locs[wd->id].fname = NULL;
298 wd->locs[wd->id].lineno = 0;
303 * Walker: assigns an ID to every block.
304 * Builds the string table
307 block_id_walker(ir_node * bb, void * data)
309 block_id_walker_data_t *wd = data;
311 wd->array[wd->id] = new_tarval_from_long(get_irn_node_nr(bb), mode_Iu);
312 instrument_block(bb, wd->symconst, wd->id);
314 if (wd->flags & profile_with_locations) {
315 dbg_info *dbg = get_irn_dbg_info(bb);
316 create_location_data(dbg, wd);
321 #define IDENT(x) new_id_from_chars(x, sizeof(x) - 1)
324 be_profile_instrument(const char *filename, unsigned flags)
328 ir_entity *bblock_id;
329 ir_entity *bblock_counts;
330 ir_entity *ent_filename;
331 ir_entity *ent_locations = NULL;
332 ir_entity *loc_lineno = NULL;
333 ir_entity *loc_name = NULL;
337 ir_type *string_type;
338 ir_type *character_type;
339 ir_type *loc_type = NULL;
340 ir_type *charptr_type;
342 ir_node *start_block;
343 tarval **tarval_array;
344 tarval **tarval_string;
346 int filename_len = strlen(filename)+1;
348 int align_l, align_n, size;
350 block_id_walker_data_t wd;
353 /* count the number of block first */
354 for (n = get_irp_n_irgs() - 1; n >= 0; --n) {
355 ir_graph *irg = get_irp_irg(n);
357 n_blocks += count_blocks(irg);
360 /* create all the necessary types and entities. Note that the
361 types must have a fixed layout, because we already running in the
363 uint_type = new_type_primitive(IDENT("__uint"), mode_Iu);
364 set_type_alignment_bytes(uint_type, get_type_size_bytes(uint_type));
366 array_type = new_type_array(IDENT("__block_info_array"), 1, uint_type);
367 set_array_bounds_int(array_type, 0, 0, n_blocks);
368 set_type_size_bytes(array_type, n_blocks * get_mode_size_bytes(mode_Iu));
369 set_type_alignment_bytes(array_type, get_mode_size_bytes(mode_Iu));
370 set_type_state(array_type, layout_fixed);
372 character_type = new_type_primitive(IDENT("__char"), mode_Bs);
373 string_type = new_type_array(IDENT("__filename"), 1, character_type);
374 set_array_bounds_int(string_type, 0, 0, filename_len);
375 set_type_size_bytes(string_type, filename_len);
376 set_type_alignment_bytes(string_type, 1);
377 set_type_state(string_type, layout_fixed);
379 gtp = get_glob_type();
381 cur_ident = IDENT("__FIRMPROF__BLOCK_IDS");
382 bblock_id = new_entity(gtp, cur_ident, array_type);
383 set_entity_ld_ident(bblock_id, cur_ident);
384 set_entity_variability(bblock_id, variability_initialized);
386 cur_ident = IDENT("__FIRMPROF__BLOCK_COUNTS");
387 bblock_counts = new_entity(gtp, cur_ident, array_type);
388 set_entity_ld_ident(bblock_counts, cur_ident);
389 set_entity_variability(bblock_counts, variability_initialized);
391 cur_ident = IDENT("__FIRMPROF__FILE_NAME");
392 ent_filename = new_entity(gtp, cur_ident, string_type);
393 set_entity_ld_ident(ent_filename, cur_ident);
395 if (flags & profile_with_locations) {
396 loc_type = new_type_struct(IDENT("__location"));
397 loc_lineno = new_entity(loc_type, IDENT("lineno"), uint_type);
398 align_l = get_type_alignment_bytes(uint_type);
399 size = get_type_size_bytes(uint_type);
400 set_entity_offset(loc_lineno, 0);
402 charptr_type = new_type_pointer(IDENT("__charptr"), character_type, mode_P_data);
403 align_n = get_type_size_bytes(charptr_type);
404 set_type_alignment_bytes(charptr_type, align_n);
405 loc_name = new_entity(loc_type, IDENT("name"), charptr_type);
406 size = (size + align_n - 1) & -align_n;
407 set_entity_offset(loc_name, size);
410 if (align_n > align_l)
412 size = (size + align_l - 1) & -align_l;
413 set_type_size_bytes(loc_type, size);
414 set_type_state(loc_type, layout_fixed);
416 loc_type = new_type_array(IDENT("__locarray"), 1, loc_type);
417 set_array_bounds_int(string_type, 0, 0, n_blocks);
419 cur_ident = IDENT("__FIRMPROF__LOCATIONS");
420 ent_locations = new_entity(gtp, cur_ident, loc_type);
421 set_entity_ld_ident(ent_locations, cur_ident);
424 /* initialize count array */
425 NEW_ARR_A(tarval *, tarval_array, n_blocks);
426 tv = get_tarval_null(mode_Iu);
427 for (i = 0; i < n_blocks; ++i) {
428 tarval_array[i] = tv;
430 set_array_entity_values(bblock_counts, tarval_array, n_blocks);
432 /* initialize function name string constant */
433 tarval_string = alloca(sizeof(*tarval_string) * (filename_len));
434 for (i = 0; i < filename_len; ++i) {
435 tarval_string[i] = new_tarval_from_long(filename[i], mode_Bs);
437 set_entity_variability(ent_filename, variability_constant);
438 set_array_entity_values(ent_filename, tarval_string, filename_len);
440 /* initialize block id array and instrument blocks */
441 wd.array = tarval_array;
443 wd.tp_char = character_type;
445 if (flags & profile_with_locations) {
446 wd.fname_map = pmap_create();
447 NEW_ARR_A(loc_entry, wd.locs, n_blocks);
450 for (n = get_irp_n_irgs() - 1; n >= 0; --n) {
451 ir_graph *irg = get_irp_irg(n);
453 ir_node *endbb = get_irg_end_block(irg);
456 set_current_ir_graph(irg);
458 /* generate a symbolic constant pointing to the count array */
459 sym.entity_p = bblock_counts;
460 wd.symconst = new_r_SymConst(irg, get_irg_start_block(irg), sym, symconst_addr_ent);
462 irg_block_walk_graph(irg, block_id_walker, NULL, &wd);
463 start_block = get_irg_start_block(irg);
464 env.end_block = get_irg_end_block(irg);
465 irg_block_walk_graph(irg, fix_ssa, NULL, &env);
466 for (i = get_Block_n_cfgpreds(endbb) - 1; i >= 0; --i) {
467 ir_node *node = skip_Proj(get_Block_cfgpred(endbb, i));
468 ir_node *bb = get_Block_cfgpred_block(endbb, i);
472 switch (get_irn_opcode(node)) {
474 ins[0] = get_irn_link(bb);
475 ins[1] = get_Return_mem(node);
476 sync = new_r_Sync(irg, bb, 2, ins);
477 set_Return_mem(node, sync);
480 ins[0] = get_irn_link(bb);
481 ins[1] = get_Raise_mem(node);
482 sync = new_r_Sync(irg, bb, 2, ins);
483 set_Raise_mem(node, sync);
486 /* a fragile's op exception. There should be another path to End,
488 assert(is_fragile_op(node) && "unexpected End control flow predecessor");
492 set_array_entity_values(bblock_id, tarval_array, n_blocks);
494 if (flags & profile_with_locations) {
495 /* build the initializer for the locations */
496 rem = current_ir_graph;
497 current_ir_graph = get_const_code_irg();
498 ent = get_array_element_entity(loc_type);
499 set_entity_variability(ent_locations, variability_constant);
500 for (i = 0; i < n_blocks; ++i) {
501 compound_graph_path *path;
506 path = new_compound_graph_path(loc_type, 2);
507 set_compound_graph_path_array_index(path, 0, i);
508 set_compound_graph_path_node(path, 0, ent);
509 set_compound_graph_path_node(path, 1, loc_lineno);
510 tv = new_tarval_from_long(wd.locs[i].lineno, mode_Iu);
511 add_compound_ent_value_w_path(ent_locations, new_Const(mode_Iu, tv), path);
514 path = new_compound_graph_path(loc_type, 2);
515 set_compound_graph_path_array_index(path, 0, i);
516 set_compound_graph_path_node(path, 0, ent);
517 set_compound_graph_path_node(path, 1, loc_name);
518 if (wd.locs[i].fname) {
519 sym.entity_p = wd.locs[i].fname;
520 n = new_SymConst(sym, symconst_addr_ent);
522 n = new_Const(mode_P_data, get_mode_null(mode_P_data));
524 add_compound_ent_value_w_path(ent_locations, n, path);
526 pmap_destroy(wd.fname_map);
528 return gen_initializer_irg(ent_filename, bblock_id, bblock_counts, n_blocks);
532 profile_node_info(void *ctx, FILE *f, const ir_node *irn)
536 fprintf(f, "profiled execution count: %u\n", be_profile_get_block_execcount(irn));
541 register_vcg_hook(void)
543 memset(&hook, 0, sizeof(hook));
544 hook.hook._hook_node_info = profile_node_info;
545 register_hook(hook_node_info, &hook);
549 unregister_vcg_hook(void)
551 unregister_hook(hook_node_info, &hook);
555 * Reads the corresponding profile info file if it exists and returns a
556 * profile info struct
559 be_profile_read(const char *filename)
565 f = fopen(filename, "r");
569 printf("found profile data '%s'.\n", filename);
572 ret = fread(buf, 8, 1, f);
573 if(ret == 0 || strncmp(buf, "firmprof", 8) != 0) {
577 if(profile) be_profile_free();
578 profile = new_set(cmp_execcount, 16);
582 ret = fread(&query, sizeof(unsigned int), 2, f);
586 set_insert(profile, &query, sizeof(query), query.block);
594 * Frees the profile info
597 be_profile_free(void)
600 unregister_vcg_hook();
606 * Tells whether profile module has acquired data
609 be_profile_has_data(void)
611 return (profile != NULL);
615 * Get block execution count as determined be profiling
618 be_profile_get_block_execcount(const ir_node *block)
620 execcount_t *ec, query;
625 query.block = get_irn_node_nr(block);
626 ec = set_find(profile, &query, sizeof(query), get_irn_node_nr(block));
631 ir_fprintf(stderr, "Warning: Profile contains no data for %+F\n",
637 typedef struct _intialize_execfreq_env_t {
639 ir_exec_freq *execfreqs;
641 } initialize_execfreq_env_t;
643 // minimal execution frequency (an execfreq of 0 confuses algos)
644 static const double MIN_EXECFREQ = 0.00001;
646 static void initialize_execfreq(ir_node *block, void *data) {
647 initialize_execfreq_env_t *env = data;
650 if(block == get_irg_start_block(env->irg)
651 || block == get_irg_end_block(env->irg)) {
654 freq = be_profile_get_block_execcount(block);
655 freq *= env->freq_factor;
656 if(freq < MIN_EXECFREQ)
660 set_execfreq(env->execfreqs, block, freq);
663 ir_exec_freq *be_create_execfreqs_from_profile(ir_graph *irg)
665 ir_node *start_block;
666 initialize_execfreq_env_t env;
670 env.execfreqs = create_execfreq(irg);
671 start_block = get_irg_start_block(irg);
673 count = be_profile_get_block_execcount(start_block);
675 // the function was never executed, so fallback to estimated freqs
676 free_execfreq(env.execfreqs);
678 return compute_execfreq(irg, 10);
681 env.freq_factor = 1.0 / count;
682 irg_block_walk_graph(irg, initialize_execfreq, NULL, &env);
684 return env.execfreqs;