1/* Definitions for transformations based on profile information for values.
2   Copyright (C) 2003, 2004, 2005, 2007, 2008 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14for more details.
15
16You should have received a copy of the GNU General Public License
17along with GCC; see the file COPYING3.  If not see
18<http://www.gnu.org/licenses/>.  */
19
20#ifndef GCC_VALUE_PROF_H
21#define GCC_VALUE_PROF_H
22
23/* Supported histogram types.  */
24enum hist_type
25{
26  HIST_TYPE_INTERVAL,	/* Measures histogram of values inside a specified
27			   interval.  */
28  HIST_TYPE_POW2,	/* Histogram of power of 2 values.  */
29  HIST_TYPE_SINGLE_VALUE, /* Tries to identify the value that is (almost)
30			   always constant.  */
31  HIST_TYPE_CONST_DELTA, /* Tries to identify the (almost) always constant
32			   difference between two evaluations of a value.  */
33  HIST_TYPE_INDIR_CALL,   /* Tries to identify the function that is (almost)
34			    called in indirect call */
35  HIST_TYPE_AVERAGE,	/* Compute average value (sum of all values).  */
36  HIST_TYPE_IOR		/* Used to compute expected alignment.  */
37};
38
39#define COUNTER_FOR_HIST_TYPE(TYPE) ((int) (TYPE) + GCOV_FIRST_VALUE_COUNTER)
40#define HIST_TYPE_FOR_COUNTER(COUNTER) \
41  ((enum hist_type) ((COUNTER) - GCOV_FIRST_VALUE_COUNTER))
42
43/* The value to measure.  */
44struct histogram_value_t
45{
46  struct
47    {
48      tree value;		/* The value to profile.  */
49      gimple stmt;		/* Insn containing the value.  */
50      gcov_type *counters;		        /* Pointer to first counter.  */
51      struct histogram_value_t *next;		/* Linked list pointer.  */
52    } hvalue;
53  enum hist_type type;			/* Type of information to measure.  */
54  unsigned n_counters;			/* Number of required counters.  */
55  union
56    {
57      struct
58	{
59	  int int_start;	/* First value in interval.  */
60	  unsigned int steps;	/* Number of values in it.  */
61	} intvl;	/* Interval histogram data.  */
62    } hdata;		/* Profiled information specific data.  */
63};
64
65typedef struct histogram_value_t *histogram_value;
66typedef const struct histogram_value_t *const_histogram_value;
67
68DEF_VEC_P(histogram_value);
69DEF_VEC_ALLOC_P(histogram_value,heap);
70
71typedef VEC(histogram_value,heap) *histogram_values;
72
73/* Hooks registration.  */
74extern void gimple_register_value_prof_hooks (void);
75
76/* IR-independent entry points.  */
77extern void find_values_to_profile (histogram_values *);
78extern bool value_profile_transformations (void);
79
80/* External declarations for edge-based profiling.  */
81struct profile_hooks {
82
83  /* Insert code to initialize edge profiler.  */
84  void (*init_edge_profiler) (void);
85
86  /* Insert code to increment an edge count.  */
87  void (*gen_edge_profiler) (int, edge);
88
89  /* Insert code to increment the interval histogram counter.  */
90  void (*gen_interval_profiler) (histogram_value, unsigned, unsigned);
91
92  /* Insert code to increment the power of two histogram counter.  */
93  void (*gen_pow2_profiler) (histogram_value, unsigned, unsigned);
94
95  /* Insert code to find the most common value.  */
96  void (*gen_one_value_profiler) (histogram_value, unsigned, unsigned);
97
98  /* Insert code to find the most common value of a difference between two
99     evaluations of an expression.  */
100  void (*gen_const_delta_profiler) (histogram_value, unsigned, unsigned);
101
102  /* Insert code to find the most common indirect call */
103  void (*gen_ic_profiler) (histogram_value, unsigned, unsigned);
104
105  /* Insert code to find the average value of an expression.  */
106  void (*gen_average_profiler) (histogram_value, unsigned, unsigned);
107
108  /* Insert code to ior value of an expression.  */
109  void (*gen_ior_profiler) (histogram_value, unsigned, unsigned);
110};
111
112histogram_value gimple_histogram_value (struct function *, gimple);
113histogram_value gimple_histogram_value_of_type (struct function *, gimple,
114						enum hist_type);
115void gimple_add_histogram_value (struct function *, gimple, histogram_value);
116void dump_histograms_for_stmt (struct function *, FILE *, gimple);
117void gimple_remove_histogram_value (struct function *, gimple, histogram_value);
118void gimple_remove_stmt_histograms (struct function *, gimple);
119void gimple_duplicate_stmt_histograms (struct function *, gimple,
120				       struct function *, gimple);
121void gimple_move_stmt_histograms (struct function *, gimple, gimple);
122void verify_histograms (void);
123void free_histograms (void);
124void stringop_block_profile (gimple, unsigned int *, HOST_WIDE_INT *);
125
126/* In profile.c.  */
127extern void init_branch_prob (void);
128extern void branch_prob (void);
129extern void end_branch_prob (void);
130extern void tree_register_profile_hooks (void);
131
132/* In tree-profile.c.  */
133extern struct profile_hooks tree_profile_hooks;
134
135#endif	/* GCC_VALUE_PROF_H */
136
137