gcc/value-prof.h

   1 /* Definitions for transformations based on profile information for values.
   2    Copyright (C) 2003 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 2, or (at your option) any later
   9 version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING.  If not, write to the Free
  18 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA.  */
  20
  21 #ifndef GCC_VALUE_PROF_H
  22 #define GCC_VALUE_PROF_H
  23
  24 /* Supported histogram types.  */
  25 enum hist_type
  26 {
  27   HIST_TYPE_INTERVAL,   /* Measures histogram of values inside a specified
  28                            interval.  */
  29   HIST_TYPE_POW2,       /* Histogram of power of 2 values.  */
  30   HIST_TYPE_SINGLE_VALUE, /* Tries to identify the value that is (almost)
  31                            always constant.  */
  32   HIST_TYPE_CONST_DELTA /* Tries to identify the (almost) always constant
  33                            difference between two evaluations of a value.  */
  34 };
  35
  36 #define COUNTER_FOR_HIST_TYPE(TYPE) ((int) (TYPE) + GCOV_FIRST_VALUE_COUNTER)
  37 #define HIST_TYPE_FOR_COUNTER(COUNTER) \
  38   ((enum hist_type) ((COUNTER) - GCOV_FIRST_VALUE_COUNTER))
  39
  40 /* The value to measure.  */
  41 /* The void *'s are either rtx or tree, depending on which IR is in use.  */
  42 struct histogram_value
  43 {
  44   void * value;         /* The value to profile.  */
  45   enum machine_mode mode; /* And its mode.  */
  46   void * seq;           /* Insns required to count the profiled value.  */
  47   void * insn;          /* Insn before that to measure.  */
  48   enum hist_type type;  /* Type of information to measure.  */
  49   unsigned n_counters;  /* Number of required counters.  */
  50   union
  51     {
  52       struct
  53         {
  54           int int_start;        /* First value in interval.  */
  55           int steps;            /* Number of values in it.  */
  56           int may_be_less;      /* May the value be below?  */
  57           int may_be_more;      /* Or above.  */
  58         } intvl;        /* Interval histogram data.  */
  59       struct
  60         {
  61           int may_be_other;     /* If the value may be non-positive or not 2^k.  */
  62         } pow2;         /* Power of 2 histogram data.  */
  63     } hdata;            /* Profiled information specific data.  */
  64 };
  65
  66 /* Hooks registration.  */
  67 extern void rtl_register_value_prof_hooks (void);
  68 extern void tree_register_value_prof_hooks (void);
  69
  70 /* IR-independent entry points.  */
  71 extern void find_values_to_profile (unsigned *, struct histogram_value **);
  72 extern void free_profiled_values (unsigned, struct histogram_value *);
  73 extern bool value_profile_transformations (void);
  74 \f
  75 /* External declarations for edge-based profiling.  */
  76 struct profile_hooks {
  77   /* Insert code to increment an edge count. */
  78   void (*gen_edge_profiler) (int, edge);
  79
  80   /* Insert code to increment the interval histogram counter.  */
  81   void (*gen_interval_profiler) (struct histogram_value *, unsigned, unsigned);
  82
  83   /* Insert code to increment the power of two histogram counter.  */
  84   void (*gen_pow2_profiler) (struct histogram_value *, unsigned, unsigned);
  85
  86   /* Insert code to find the most common value. */
  87   void (*gen_one_value_profiler) (struct histogram_value *, unsigned, unsigned);
  88
  89   /* Insert code to find the most common value of a difference between two
  90      evaluations of an expression.  */
  91   void (*gen_const_delta_profiler) (struct histogram_value *, unsigned,
  92                                     unsigned);
  93   FILE * (*profile_dump_file) (void);
  94 };
  95
  96 /* In profile.c.  */
  97 extern void init_branch_prob (void);
  98 extern void branch_prob (void);
  99 extern void end_branch_prob (void);
 100 extern void tree_register_profile_hooks (void);
 101 extern void rtl_register_profile_hooks (void);
 102
 103 /* In tree-profile.c.  */
 104 extern struct profile_hooks tree_profile_hooks;
 105
 106 /* In rtl-profile.c.  */
 107 extern struct profile_hooks rtl_profile_hooks;
 108
 109 #endif  /* GCC_VALUE_PROF_H */
 110