1 /* Calculate branch probabilities, and basic block execution counts.
2 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1996, 1997, 1998, 1999,
3 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2010
4 Free Software Foundation, Inc.
5 Contributed by James E. Wilson, UC Berkeley/Cygnus Support;
6 based on some ideas from Dain Samples of UC Berkeley.
7 Further mangling by Bob Manson, Cygnus Support.
8 Converted to use trees by Dale Johannesen, Apple Computer.
10 This file is part of GCC.
12 GCC is free software; you can redistribute it and/or modify it under
13 the terms of the GNU General Public License as published by the Free
14 Software Foundation; either version 3, or (at your option) any later
17 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
18 WARRANTY; without even the implied warranty of MERCHANTABILITY or
19 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 You should have received a copy of the GNU General Public License
23 along with GCC; see the file COPYING3. If not see
24 <http://www.gnu.org/licenses/>. */
26 /* Generate basic block profile instrumentation and auxiliary files.
27 Tree-based version. See profile.c for overview. */
31 #include "coretypes.h"
35 #include "basic-block.h"
36 #include "diagnostic-core.h"
39 #include "tree-flow.h"
40 #include "tree-pass.h"
41 #include "value-prof.h"
46 static GTY(()) tree gcov_type_node
;
47 static GTY(()) tree gcov_type_tmp_var
;
48 static GTY(()) tree tree_interval_profiler_fn
;
49 static GTY(()) tree tree_pow2_profiler_fn
;
50 static GTY(()) tree tree_one_value_profiler_fn
;
51 static GTY(()) tree tree_indirect_call_profiler_fn
;
52 static GTY(()) tree tree_average_profiler_fn
;
53 static GTY(()) tree tree_ior_profiler_fn
;
56 static GTY(()) tree ic_void_ptr_var
;
57 static GTY(()) tree ic_gcov_type_ptr_var
;
58 static GTY(()) tree ptr_void
;
60 /* Do initialization work for the edge profiler. */
63 static gcov* __gcov_indirect_call_counters; // pointer to actual counter
64 static void* __gcov_indirect_call_callee; // actual callee address
67 init_ic_make_global_vars (void)
71 ptr_void
= build_pointer_type (void_type_node
);
74 = build_decl (UNKNOWN_LOCATION
, VAR_DECL
,
75 get_identifier ("__gcov_indirect_call_callee"),
77 TREE_STATIC (ic_void_ptr_var
) = 1;
78 TREE_PUBLIC (ic_void_ptr_var
) = 0;
79 DECL_ARTIFICIAL (ic_void_ptr_var
) = 1;
80 DECL_INITIAL (ic_void_ptr_var
) = NULL
;
82 DECL_TLS_MODEL (ic_void_ptr_var
) =
83 decl_default_tls_model (ic_void_ptr_var
);
85 varpool_finalize_decl (ic_void_ptr_var
);
87 gcov_type_ptr
= build_pointer_type (get_gcov_type ());
89 = build_decl (UNKNOWN_LOCATION
, VAR_DECL
,
90 get_identifier ("__gcov_indirect_call_counters"),
92 TREE_STATIC (ic_gcov_type_ptr_var
) = 1;
93 TREE_PUBLIC (ic_gcov_type_ptr_var
) = 0;
94 DECL_ARTIFICIAL (ic_gcov_type_ptr_var
) = 1;
95 DECL_INITIAL (ic_gcov_type_ptr_var
) = NULL
;
97 DECL_TLS_MODEL (ic_gcov_type_ptr_var
) =
98 decl_default_tls_model (ic_gcov_type_ptr_var
);
100 varpool_finalize_decl (ic_gcov_type_ptr_var
);
103 /* Create the type and function decls for the interface with gcov. */
106 gimple_init_edge_profiler (void)
108 tree interval_profiler_fn_type
;
109 tree pow2_profiler_fn_type
;
110 tree one_value_profiler_fn_type
;
112 tree ic_profiler_fn_type
;
113 tree average_profiler_fn_type
;
117 gcov_type_node
= get_gcov_type ();
118 gcov_type_ptr
= build_pointer_type (gcov_type_node
);
120 /* void (*) (gcov_type *, gcov_type, int, unsigned) */
121 interval_profiler_fn_type
122 = build_function_type_list (void_type_node
,
123 gcov_type_ptr
, gcov_type_node
,
125 unsigned_type_node
, NULL_TREE
);
126 tree_interval_profiler_fn
127 = build_fn_decl ("__gcov_interval_profiler",
128 interval_profiler_fn_type
);
129 TREE_NOTHROW (tree_interval_profiler_fn
) = 1;
130 DECL_ATTRIBUTES (tree_interval_profiler_fn
)
131 = tree_cons (get_identifier ("leaf"), NULL
,
132 DECL_ATTRIBUTES (tree_interval_profiler_fn
));
134 /* void (*) (gcov_type *, gcov_type) */
135 pow2_profiler_fn_type
136 = build_function_type_list (void_type_node
,
137 gcov_type_ptr
, gcov_type_node
,
139 tree_pow2_profiler_fn
= build_fn_decl ("__gcov_pow2_profiler",
140 pow2_profiler_fn_type
);
141 TREE_NOTHROW (tree_pow2_profiler_fn
) = 1;
142 DECL_ATTRIBUTES (tree_pow2_profiler_fn
)
143 = tree_cons (get_identifier ("leaf"), NULL
,
144 DECL_ATTRIBUTES (tree_pow2_profiler_fn
));
146 /* void (*) (gcov_type *, gcov_type) */
147 one_value_profiler_fn_type
148 = build_function_type_list (void_type_node
,
149 gcov_type_ptr
, gcov_type_node
,
151 tree_one_value_profiler_fn
152 = build_fn_decl ("__gcov_one_value_profiler",
153 one_value_profiler_fn_type
);
154 TREE_NOTHROW (tree_one_value_profiler_fn
) = 1;
155 DECL_ATTRIBUTES (tree_one_value_profiler_fn
)
156 = tree_cons (get_identifier ("leaf"), NULL
,
157 DECL_ATTRIBUTES (tree_one_value_profiler_fn
));
159 init_ic_make_global_vars ();
161 /* void (*) (gcov_type *, gcov_type, void *, void *) */
163 = build_function_type_list (void_type_node
,
164 gcov_type_ptr
, gcov_type_node
,
166 ptr_void
, NULL_TREE
);
167 tree_indirect_call_profiler_fn
168 = build_fn_decl ("__gcov_indirect_call_profiler",
169 ic_profiler_fn_type
);
170 TREE_NOTHROW (tree_indirect_call_profiler_fn
) = 1;
171 DECL_ATTRIBUTES (tree_indirect_call_profiler_fn
)
172 = tree_cons (get_identifier ("leaf"), NULL
,
173 DECL_ATTRIBUTES (tree_indirect_call_profiler_fn
));
175 /* void (*) (gcov_type *, gcov_type) */
176 average_profiler_fn_type
177 = build_function_type_list (void_type_node
,
178 gcov_type_ptr
, gcov_type_node
, NULL_TREE
);
179 tree_average_profiler_fn
180 = build_fn_decl ("__gcov_average_profiler",
181 average_profiler_fn_type
);
182 TREE_NOTHROW (tree_average_profiler_fn
) = 1;
183 DECL_ATTRIBUTES (tree_average_profiler_fn
)
184 = tree_cons (get_identifier ("leaf"), NULL
,
185 DECL_ATTRIBUTES (tree_average_profiler_fn
));
187 = build_fn_decl ("__gcov_ior_profiler",
188 average_profiler_fn_type
);
189 TREE_NOTHROW (tree_ior_profiler_fn
) = 1;
190 DECL_ATTRIBUTES (tree_ior_profiler_fn
)
191 = tree_cons (get_identifier ("leaf"), NULL
,
192 DECL_ATTRIBUTES (tree_ior_profiler_fn
));
194 /* LTO streamer needs assembler names. Because we create these decls
195 late, we need to initialize them by hand. */
196 DECL_ASSEMBLER_NAME (tree_interval_profiler_fn
);
197 DECL_ASSEMBLER_NAME (tree_pow2_profiler_fn
);
198 DECL_ASSEMBLER_NAME (tree_one_value_profiler_fn
);
199 DECL_ASSEMBLER_NAME (tree_indirect_call_profiler_fn
);
200 DECL_ASSEMBLER_NAME (tree_average_profiler_fn
);
201 DECL_ASSEMBLER_NAME (tree_ior_profiler_fn
);
205 /* Output instructions as GIMPLE trees to increment the edge
206 execution count, and insert them on E. We rely on
207 gsi_insert_on_edge to preserve the order. */
210 gimple_gen_edge_profiler (int edgeno
, edge e
)
213 gimple stmt1
, stmt2
, stmt3
;
215 /* We share one temporary variable declaration per function. This
216 gets re-set in tree_profiling. */
217 if (gcov_type_tmp_var
== NULL_TREE
)
218 gcov_type_tmp_var
= create_tmp_reg (gcov_type_node
, "PROF_edge_counter");
219 ref
= tree_coverage_counter_ref (GCOV_COUNTER_ARCS
, edgeno
);
220 one
= build_int_cst (gcov_type_node
, 1);
221 stmt1
= gimple_build_assign (gcov_type_tmp_var
, ref
);
222 gimple_assign_set_lhs (stmt1
, make_ssa_name (gcov_type_tmp_var
, stmt1
));
223 stmt2
= gimple_build_assign_with_ops (PLUS_EXPR
, gcov_type_tmp_var
,
224 gimple_assign_lhs (stmt1
), one
);
225 gimple_assign_set_lhs (stmt2
, make_ssa_name (gcov_type_tmp_var
, stmt2
));
226 stmt3
= gimple_build_assign (unshare_expr (ref
), gimple_assign_lhs (stmt2
));
227 gsi_insert_on_edge (e
, stmt1
);
228 gsi_insert_on_edge (e
, stmt2
);
229 gsi_insert_on_edge (e
, stmt3
);
232 /* Emits code to get VALUE to instrument at GSI, and returns the
233 variable containing the value. */
236 prepare_instrumented_value (gimple_stmt_iterator
*gsi
, histogram_value value
)
238 tree val
= value
->hvalue
.value
;
239 if (POINTER_TYPE_P (TREE_TYPE (val
)))
240 val
= fold_convert (build_nonstandard_integer_type
241 (TYPE_PRECISION (TREE_TYPE (val
)), 1), val
);
242 return force_gimple_operand_gsi (gsi
, fold_convert (gcov_type_node
, val
),
243 true, NULL_TREE
, true, GSI_SAME_STMT
);
246 /* Output instructions as GIMPLE trees to increment the interval histogram
247 counter. VALUE is the expression whose value is profiled. TAG is the
248 tag of the section for counters, BASE is offset of the counter position. */
251 gimple_gen_interval_profiler (histogram_value value
, unsigned tag
, unsigned base
)
253 gimple stmt
= value
->hvalue
.stmt
;
254 gimple_stmt_iterator gsi
= gsi_for_stmt (stmt
);
255 tree ref
= tree_coverage_counter_ref (tag
, base
), ref_ptr
;
258 tree start
= build_int_cst_type (integer_type_node
,
259 value
->hdata
.intvl
.int_start
);
260 tree steps
= build_int_cst_type (unsigned_type_node
,
261 value
->hdata
.intvl
.steps
);
263 ref_ptr
= force_gimple_operand_gsi (&gsi
,
264 build_addr (ref
, current_function_decl
),
265 true, NULL_TREE
, true, GSI_SAME_STMT
);
266 val
= prepare_instrumented_value (&gsi
, value
);
267 call
= gimple_build_call (tree_interval_profiler_fn
, 4,
268 ref_ptr
, val
, start
, steps
);
269 gsi_insert_before (&gsi
, call
, GSI_NEW_STMT
);
272 /* Output instructions as GIMPLE trees to increment the power of two histogram
273 counter. VALUE is the expression whose value is profiled. TAG is the tag
274 of the section for counters, BASE is offset of the counter position. */
277 gimple_gen_pow2_profiler (histogram_value value
, unsigned tag
, unsigned base
)
279 gimple stmt
= value
->hvalue
.stmt
;
280 gimple_stmt_iterator gsi
= gsi_for_stmt (stmt
);
281 tree ref_ptr
= tree_coverage_counter_addr (tag
, base
);
285 ref_ptr
= force_gimple_operand_gsi (&gsi
, ref_ptr
,
286 true, NULL_TREE
, true, GSI_SAME_STMT
);
287 val
= prepare_instrumented_value (&gsi
, value
);
288 call
= gimple_build_call (tree_pow2_profiler_fn
, 2, ref_ptr
, val
);
289 gsi_insert_before (&gsi
, call
, GSI_NEW_STMT
);
292 /* Output instructions as GIMPLE trees for code to find the most common value.
293 VALUE is the expression whose value is profiled. TAG is the tag of the
294 section for counters, BASE is offset of the counter position. */
297 gimple_gen_one_value_profiler (histogram_value value
, unsigned tag
, unsigned base
)
299 gimple stmt
= value
->hvalue
.stmt
;
300 gimple_stmt_iterator gsi
= gsi_for_stmt (stmt
);
301 tree ref_ptr
= tree_coverage_counter_addr (tag
, base
);
305 ref_ptr
= force_gimple_operand_gsi (&gsi
, ref_ptr
,
306 true, NULL_TREE
, true, GSI_SAME_STMT
);
307 val
= prepare_instrumented_value (&gsi
, value
);
308 call
= gimple_build_call (tree_one_value_profiler_fn
, 2, ref_ptr
, val
);
309 gsi_insert_before (&gsi
, call
, GSI_NEW_STMT
);
313 /* Output instructions as GIMPLE trees for code to find the most
314 common called function in indirect call.
315 VALUE is the call expression whose indirect callee is profiled.
316 TAG is the tag of the section for counters, BASE is offset of the
320 gimple_gen_ic_profiler (histogram_value value
, unsigned tag
, unsigned base
)
323 gimple stmt1
, stmt2
, stmt3
;
324 gimple stmt
= value
->hvalue
.stmt
;
325 gimple_stmt_iterator gsi
= gsi_for_stmt (stmt
);
326 tree ref_ptr
= tree_coverage_counter_addr (tag
, base
);
328 ref_ptr
= force_gimple_operand_gsi (&gsi
, ref_ptr
,
329 true, NULL_TREE
, true, GSI_SAME_STMT
);
333 stmt1: __gcov_indirect_call_counters = get_relevant_counter_ptr ();
334 stmt2: tmp1 = (void *) (indirect call argument value)
335 stmt3: __gcov_indirect_call_callee = tmp1;
338 tmp1
= create_tmp_reg (ptr_void
, "PROF");
339 stmt1
= gimple_build_assign (ic_gcov_type_ptr_var
, ref_ptr
);
340 stmt2
= gimple_build_assign (tmp1
, unshare_expr (value
->hvalue
.value
));
341 gimple_assign_set_lhs (stmt2
, make_ssa_name (tmp1
, stmt2
));
342 stmt3
= gimple_build_assign (ic_void_ptr_var
, gimple_assign_lhs (stmt2
));
344 gsi_insert_before (&gsi
, stmt1
, GSI_SAME_STMT
);
345 gsi_insert_before (&gsi
, stmt2
, GSI_SAME_STMT
);
346 gsi_insert_before (&gsi
, stmt3
, GSI_SAME_STMT
);
350 /* Output instructions as GIMPLE trees for code to find the most
351 common called function in indirect call. Insert instructions at the
352 beginning of every possible called function.
356 gimple_gen_ic_func_profiler (void)
358 struct cgraph_node
* c_node
= cgraph_get_node (current_function_decl
);
359 gimple_stmt_iterator gsi
;
361 tree tree_uid
, cur_func
, counter_ptr
, ptr_var
, void0
;
363 if (cgraph_only_called_directly_p (c_node
))
366 gimple_init_edge_profiler ();
370 stmt1: __gcov_indirect_call_profiler (__gcov_indirect_call_counters,
371 current_function_funcdef_no,
372 ¤t_function_decl,
373 __gcov_indirect_call_callee);
375 gsi
= gsi_after_labels (single_succ (ENTRY_BLOCK_PTR
));
377 cur_func
= force_gimple_operand_gsi (&gsi
,
378 build_addr (current_function_decl
,
379 current_function_decl
),
381 true, GSI_SAME_STMT
);
382 counter_ptr
= force_gimple_operand_gsi (&gsi
, ic_gcov_type_ptr_var
,
383 true, NULL_TREE
, true,
385 ptr_var
= force_gimple_operand_gsi (&gsi
, ic_void_ptr_var
,
386 true, NULL_TREE
, true,
388 tree_uid
= build_int_cst (gcov_type_node
, current_function_funcdef_no
);
389 stmt1
= gimple_build_call (tree_indirect_call_profiler_fn
, 4,
390 counter_ptr
, tree_uid
, cur_func
, ptr_var
);
391 gsi_insert_before (&gsi
, stmt1
, GSI_SAME_STMT
);
393 /* Set __gcov_indirect_call_callee to 0,
394 so that calls from other modules won't get misattributed
395 to the last caller of the current callee. */
396 void0
= build_int_cst (build_pointer_type (void_type_node
), 0);
397 stmt2
= gimple_build_assign (ic_void_ptr_var
, void0
);
398 gsi_insert_before (&gsi
, stmt2
, GSI_SAME_STMT
);
401 /* Output instructions as GIMPLE trees for code to find the most common value
402 of a difference between two evaluations of an expression.
403 VALUE is the expression whose value is profiled. TAG is the tag of the
404 section for counters, BASE is offset of the counter position. */
407 gimple_gen_const_delta_profiler (histogram_value value ATTRIBUTE_UNUSED
,
408 unsigned tag ATTRIBUTE_UNUSED
,
409 unsigned base ATTRIBUTE_UNUSED
)
411 /* FIXME implement this. */
412 #ifdef ENABLE_CHECKING
413 internal_error ("unimplemented functionality");
418 /* Output instructions as GIMPLE trees to increment the average histogram
419 counter. VALUE is the expression whose value is profiled. TAG is the
420 tag of the section for counters, BASE is offset of the counter position. */
423 gimple_gen_average_profiler (histogram_value value
, unsigned tag
, unsigned base
)
425 gimple stmt
= value
->hvalue
.stmt
;
426 gimple_stmt_iterator gsi
= gsi_for_stmt (stmt
);
427 tree ref_ptr
= tree_coverage_counter_addr (tag
, base
);
431 ref_ptr
= force_gimple_operand_gsi (&gsi
, ref_ptr
,
433 true, GSI_SAME_STMT
);
434 val
= prepare_instrumented_value (&gsi
, value
);
435 call
= gimple_build_call (tree_average_profiler_fn
, 2, ref_ptr
, val
);
436 gsi_insert_before (&gsi
, call
, GSI_NEW_STMT
);
439 /* Output instructions as GIMPLE trees to increment the ior histogram
440 counter. VALUE is the expression whose value is profiled. TAG is the
441 tag of the section for counters, BASE is offset of the counter position. */
444 gimple_gen_ior_profiler (histogram_value value
, unsigned tag
, unsigned base
)
446 gimple stmt
= value
->hvalue
.stmt
;
447 gimple_stmt_iterator gsi
= gsi_for_stmt (stmt
);
448 tree ref_ptr
= tree_coverage_counter_addr (tag
, base
);
452 ref_ptr
= force_gimple_operand_gsi (&gsi
, ref_ptr
,
453 true, NULL_TREE
, true, GSI_SAME_STMT
);
454 val
= prepare_instrumented_value (&gsi
, value
);
455 call
= gimple_build_call (tree_ior_profiler_fn
, 2, ref_ptr
, val
);
456 gsi_insert_before (&gsi
, call
, GSI_NEW_STMT
);
459 /* Profile all functions in the callgraph. */
462 tree_profiling (void)
464 struct cgraph_node
*node
;
466 /* This is a small-ipa pass that gets called only once, from
467 cgraphunit.c:ipa_passes(). */
468 gcc_assert (cgraph_state
== CGRAPH_STATE_IPA_SSA
);
472 FOR_EACH_DEFINED_FUNCTION (node
)
474 if (!gimple_has_body_p (node
->symbol
.decl
))
477 /* Don't profile functions produced for builtin stuff. */
478 if (DECL_SOURCE_LOCATION (node
->symbol
.decl
) == BUILTINS_LOCATION
)
481 push_cfun (DECL_STRUCT_FUNCTION (node
->symbol
.decl
));
482 current_function_decl
= node
->symbol
.decl
;
484 /* Re-set global shared temporary variable for edge-counters. */
485 gcov_type_tmp_var
= NULL_TREE
;
487 /* Local pure-const may imply need to fixup the cfg. */
488 if (execute_fixup_cfg () & TODO_cleanup_cfg
)
493 if (! flag_branch_probabilities
494 && flag_profile_values
)
495 gimple_gen_ic_func_profiler ();
497 if (flag_branch_probabilities
498 && flag_profile_values
499 && flag_value_profile_transformations
)
500 gimple_value_profile_transformations ();
502 /* The above could hose dominator info. Currently there is
503 none coming in, this is a safety valve. It should be
504 easy to adjust it, if and when there is some. */
505 free_dominance_info (CDI_DOMINATORS
);
506 free_dominance_info (CDI_POST_DOMINATORS
);
508 current_function_decl
= NULL
;
512 /* Drop pure/const flags from instrumented functions. */
513 FOR_EACH_DEFINED_FUNCTION (node
)
515 if (!gimple_has_body_p (node
->symbol
.decl
)
517 || node
->symbol
.decl
!= node
->clone_of
->symbol
.decl
))
520 /* Don't profile functions produced for builtin stuff. */
521 if (DECL_SOURCE_LOCATION (node
->symbol
.decl
) == BUILTINS_LOCATION
)
524 cgraph_set_const_flag (node
, false, false);
525 cgraph_set_pure_flag (node
, false, false);
528 /* Update call statements and rebuild the cgraph. */
529 FOR_EACH_DEFINED_FUNCTION (node
)
533 if (!gimple_has_body_p (node
->symbol
.decl
)
535 || node
->symbol
.decl
!= node
->clone_of
->symbol
.decl
))
538 /* Don't profile functions produced for builtin stuff. */
539 if (DECL_SOURCE_LOCATION (node
->symbol
.decl
) == BUILTINS_LOCATION
)
542 push_cfun (DECL_STRUCT_FUNCTION (node
->symbol
.decl
));
543 current_function_decl
= node
->symbol
.decl
;
547 gimple_stmt_iterator gsi
;
548 for (gsi
= gsi_start_bb (bb
); !gsi_end_p (gsi
); gsi_next (&gsi
))
550 gimple stmt
= gsi_stmt (gsi
);
551 if (is_gimple_call (stmt
))
556 update_ssa (TODO_update_ssa
);
558 rebuild_cgraph_edges ();
560 current_function_decl
= NULL
;
568 /* When profile instrumentation, use or test coverage shall be performed. */
571 gate_tree_profile_ipa (void)
574 && (flag_branch_probabilities
|| flag_test_coverage
575 || profile_arc_flag
));
578 struct simple_ipa_opt_pass pass_ipa_tree_profile
=
582 "profile", /* name */
583 gate_tree_profile_ipa
, /* gate */
584 tree_profiling
, /* execute */
587 0, /* static_pass_number */
588 TV_IPA_PROFILE
, /* tv_id */
589 0, /* properties_required */
590 0, /* properties_provided */
591 0, /* properties_destroyed */
592 0, /* todo_flags_start */
593 0 /* todo_flags_finish */
597 #include "gt-tree-profile.h"