libgcc/libgcov.h

   1 /* Header file for libgcov-*.c.
   2    Copyright (C) 1996-2019 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 3, 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    Under Section 7 of GPL version 3, you are granted additional
  17    permissions described in the GCC Runtime Library Exception, version
  18    3.1, as published by the Free Software Foundation.
  19
  20    You should have received a copy of the GNU General Public License and
  21    a copy of the GCC Runtime Library Exception along with this program;
  22    see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  23    <http://www.gnu.org/licenses/>.  */
  24
  25 #ifndef GCC_LIBGCOV_H
  26 #define GCC_LIBGCOV_H
  27
  28 /* work around the poisoned malloc/calloc in system.h.  */
  29 #ifndef xmalloc
  30 #define xmalloc malloc
  31 #endif
  32 #ifndef xcalloc
  33 #define xcalloc calloc
  34 #endif
  35
  36 #ifndef IN_GCOV_TOOL
  37 /* About the target.  */
  38 /* This path will be used by libgcov runtime.  */
  39
  40 #include "tconfig.h"
  41 #include "auto-target.h"
  42 #include "tsystem.h"
  43 #include "coretypes.h"
  44 #include "tm.h"
  45 #include "libgcc_tm.h"
  46 #include "gcov.h"
  47
  48 #if __CHAR_BIT__ == 8
  49 typedef unsigned gcov_unsigned_t __attribute__ ((mode (SI)));
  50 typedef unsigned gcov_position_t __attribute__ ((mode (SI)));
  51 #if LONG_LONG_TYPE_SIZE > 32
  52 typedef signed gcov_type __attribute__ ((mode (DI)));
  53 typedef unsigned gcov_type_unsigned __attribute__ ((mode (DI)));
  54 #else
  55 typedef signed gcov_type __attribute__ ((mode (SI)));
  56 typedef unsigned gcov_type_unsigned __attribute__ ((mode (SI)));
  57 #endif
  58 #else
  59 #if __CHAR_BIT__ == 16
  60 typedef unsigned gcov_unsigned_t __attribute__ ((mode (HI)));
  61 typedef unsigned gcov_position_t __attribute__ ((mode (HI)));
  62 #if LONG_LONG_TYPE_SIZE > 32
  63 typedef signed gcov_type __attribute__ ((mode (SI)));
  64 typedef unsigned gcov_type_unsigned __attribute__ ((mode (SI)));
  65 #else
  66 typedef signed gcov_type __attribute__ ((mode (HI)));
  67 typedef unsigned gcov_type_unsigned __attribute__ ((mode (HI)));
  68 #endif
  69 #else
  70 typedef unsigned gcov_unsigned_t __attribute__ ((mode (QI)));
  71 typedef unsigned gcov_position_t __attribute__ ((mode (QI)));
  72 #if LONG_LONG_TYPE_SIZE > 32
  73 typedef signed gcov_type __attribute__ ((mode (HI)));
  74 typedef unsigned gcov_type_unsigned __attribute__ ((mode (HI)));
  75 #else
  76 typedef signed gcov_type __attribute__ ((mode (QI)));
  77 typedef unsigned gcov_type_unsigned __attribute__ ((mode (QI)));
  78 #endif
  79 #endif
  80 #endif
  81
  82 #if defined (TARGET_POSIX_IO)
  83 #define GCOV_LOCKED 1
  84 #else
  85 #define GCOV_LOCKED 0
  86 #endif
  87
  88 /* In libgcov we need these functions to be extern, so prefix them with
  89    __gcov.  In libgcov they must also be hidden so that the instance in
  90    the executable is not also used in a DSO.  */
  91 #define gcov_var __gcov_var
  92 #define gcov_open __gcov_open
  93 #define gcov_close __gcov_close
  94 #define gcov_write_tag_length __gcov_write_tag_length
  95 #define gcov_position __gcov_position
  96 #define gcov_seek __gcov_seek
  97 #define gcov_rewrite __gcov_rewrite
  98 #define gcov_is_error __gcov_is_error
  99 #define gcov_write_unsigned __gcov_write_unsigned
 100 #define gcov_write_counter __gcov_write_counter
 101 #define gcov_write_summary __gcov_write_summary
 102 #define gcov_read_unsigned __gcov_read_unsigned
 103 #define gcov_read_counter __gcov_read_counter
 104 #define gcov_read_summary __gcov_read_summary
 105 #define gcov_sort_n_vals __gcov_sort_n_vals
 106
 107 #else /* IN_GCOV_TOOL */
 108 /* About the host.  */
 109 /* This path will be compiled for the host and linked into
 110    gcov-tool binary.  */
 111
 112 #include "config.h"
 113 #include "system.h"
 114 #include "coretypes.h"
 115 #include "tm.h"
 116
 117 typedef unsigned gcov_unsigned_t;
 118 typedef unsigned gcov_position_t;
 119 /* gcov_type is typedef'd elsewhere for the compiler */
 120 #if defined (HOST_HAS_F_SETLKW)
 121 #define GCOV_LOCKED 1
 122 #else
 123 #define GCOV_LOCKED 0
 124 #endif
 125
 126 /* Some Macros specific to gcov-tool.  */
 127
 128 #define L_gcov 1
 129 #define L_gcov_merge_add 1
 130 #define L_gcov_merge_single 1
 131 #define L_gcov_merge_ior 1
 132 #define L_gcov_merge_time_profile 1
 133 #define L_gcov_merge_icall_topn 1
 134
 135 extern gcov_type gcov_read_counter_mem ();
 136 extern unsigned gcov_get_merge_weight ();
 137 extern struct gcov_info *gcov_list;
 138
 139 #endif /* !IN_GCOV_TOOL */
 140
 141 #if defined(inhibit_libc)
 142 #define IN_LIBGCOV (-1)
 143 #else
 144 #define IN_LIBGCOV 1
 145 #if defined(L_gcov)
 146 #define GCOV_LINKAGE /* nothing */
 147 #endif
 148 #endif
 149
 150 /* Poison these, so they don't accidentally slip in.  */
 151 #pragma GCC poison gcov_write_string gcov_write_tag gcov_write_length
 152 #pragma GCC poison gcov_time gcov_magic
 153
 154 #ifdef HAVE_GAS_HIDDEN
 155 #define ATTRIBUTE_HIDDEN  __attribute__ ((__visibility__ ("hidden")))
 156 #else
 157 #define ATTRIBUTE_HIDDEN
 158 #endif
 159
 160 #include "gcov-io.h"
 161
 162 /* Structures embedded in coveraged program.  The structures generated
 163    by write_profile must match these.  */
 164
 165 /* Information about counters for a single function.  */
 166 struct gcov_ctr_info
 167 {
 168   gcov_unsigned_t num;          /* number of counters.  */
 169   gcov_type *values;            /* their values.  */
 170 };
 171
 172 /* Information about a single function.  This uses the trailing array
 173    idiom. The number of counters is determined from the merge pointer
 174    array in gcov_info.  The key is used to detect which of a set of
 175    comdat functions was selected -- it points to the gcov_info object
 176    of the object file containing the selected comdat function.  */
 177
 178 struct gcov_fn_info
 179 {
 180   const struct gcov_info *key;          /* comdat key */
 181   gcov_unsigned_t ident;                /* unique ident of function */
 182   gcov_unsigned_t lineno_checksum;      /* function lineo_checksum */
 183   gcov_unsigned_t cfg_checksum;         /* function cfg checksum */
 184   struct gcov_ctr_info ctrs[1];         /* instrumented counters */
 185 };
 186
 187 /* Type of function used to merge counters.  */
 188 typedef void (*gcov_merge_fn) (gcov_type *, gcov_unsigned_t);
 189
 190 /* Information about a single object file.  */
 191 struct gcov_info
 192 {
 193   gcov_unsigned_t version;      /* expected version number */
 194   struct gcov_info *next;       /* link to next, used by libgcov */
 195
 196   gcov_unsigned_t stamp;        /* uniquifying time stamp */
 197   const char *filename;         /* output file name */
 198
 199   gcov_merge_fn merge[GCOV_COUNTERS];  /* merge functions (null for
 200                                           unused) */
 201
 202   unsigned n_functions;         /* number of functions */
 203
 204 #ifndef IN_GCOV_TOOL
 205   const struct gcov_fn_info *const *functions; /* pointer to pointers
 206                                                   to function information  */
 207 #else
 208   const struct gcov_fn_info **functions;
 209 #endif /* !IN_GCOV_TOOL */
 210 };
 211
 212 /* Root of a program/shared-object state */
 213 struct gcov_root
 214 {
 215   struct gcov_info *list;
 216   unsigned dumped : 1;  /* counts have been dumped.  */
 217   unsigned run_counted : 1;  /* run has been accounted for.  */
 218   struct gcov_root *next;
 219   struct gcov_root *prev;
 220 };
 221
 222 extern struct gcov_root __gcov_root ATTRIBUTE_HIDDEN;
 223
 224 struct gcov_master
 225 {
 226   gcov_unsigned_t version;
 227   struct gcov_root *root;
 228 };
 229
 230 struct indirect_call_tuple
 231 {
 232   /* Callee function.  */
 233   void *callee;
 234
 235   /* Pointer to counters.  */
 236   gcov_type *counters;
 237 };
 238
 239 /* Exactly one of these will be active in the process.  */
 240 extern struct gcov_master __gcov_master;
 241
 242 /* Dump a set of gcov objects.  */
 243 extern void __gcov_dump_one (struct gcov_root *) ATTRIBUTE_HIDDEN;
 244
 245 /* Register a new object file module.  */
 246 extern void __gcov_init (struct gcov_info *) ATTRIBUTE_HIDDEN;
 247
 248 /* GCOV exit function registered via a static destructor.  */
 249 extern void __gcov_exit (void) ATTRIBUTE_HIDDEN;
 250
 251 /* Function to reset all counters to 0.  Both externally visible (and
 252    overridable) and internal version.  */
 253 extern void __gcov_reset_int (void) ATTRIBUTE_HIDDEN;
 254
 255 /* User function to enable early write of profile information so far.  */
 256 extern void __gcov_dump_int (void) ATTRIBUTE_HIDDEN;
 257
 258 /* The merge function that just sums the counters.  */
 259 extern void __gcov_merge_add (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
 260
 261 /* The merge function to select the minimum valid counter value.  */
 262 extern void __gcov_merge_time_profile (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
 263
 264 /* The merge function to choose the most common value.  */
 265 extern void __gcov_merge_single (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
 266
 267 /* The merge function that just ors the counters together.  */
 268 extern void __gcov_merge_ior (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
 269
 270 /* The merge function is used for topn indirect call counters.  */
 271 extern void __gcov_merge_icall_topn (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
 272
 273 /* The profiler functions.  */
 274 extern void __gcov_interval_profiler (gcov_type *, gcov_type, int, unsigned);
 275 extern void __gcov_interval_profiler_atomic (gcov_type *, gcov_type, int,
 276                                              unsigned);
 277 extern void __gcov_pow2_profiler (gcov_type *, gcov_type);
 278 extern void __gcov_pow2_profiler_atomic (gcov_type *, gcov_type);
 279 extern void __gcov_one_value_profiler (gcov_type *, gcov_type);
 280 extern void __gcov_one_value_profiler_atomic (gcov_type *, gcov_type);
 281 extern void __gcov_indirect_call_profiler_v3 (gcov_type, void *);
 282 extern void __gcov_time_profiler (gcov_type *);
 283 extern void __gcov_time_profiler_atomic (gcov_type *);
 284 extern void __gcov_average_profiler (gcov_type *, gcov_type);
 285 extern void __gcov_average_profiler_atomic (gcov_type *, gcov_type);
 286 extern void __gcov_ior_profiler (gcov_type *, gcov_type);
 287 extern void __gcov_ior_profiler_atomic (gcov_type *, gcov_type);
 288 extern void __gcov_indirect_call_topn_profiler (gcov_type, void *);
 289 extern void gcov_sort_n_vals (gcov_type *, int);
 290
 291 #ifndef inhibit_libc
 292 /* The wrappers around some library functions..  */
 293 extern pid_t __gcov_fork (void) ATTRIBUTE_HIDDEN;
 294 extern int __gcov_execl (const char *, char *, ...) ATTRIBUTE_HIDDEN;
 295 extern int __gcov_execlp (const char *, char *, ...) ATTRIBUTE_HIDDEN;
 296 extern int __gcov_execle (const char *, char *, ...) ATTRIBUTE_HIDDEN;
 297 extern int __gcov_execv (const char *, char *const []) ATTRIBUTE_HIDDEN;
 298 extern int __gcov_execvp (const char *, char *const []) ATTRIBUTE_HIDDEN;
 299 extern int __gcov_execve (const char *, char  *const [], char *const [])
 300   ATTRIBUTE_HIDDEN;
 301
 302 /* Functions that only available in libgcov.  */
 303 GCOV_LINKAGE int gcov_open (const char */*name*/) ATTRIBUTE_HIDDEN;
 304 GCOV_LINKAGE void gcov_write_counter (gcov_type) ATTRIBUTE_HIDDEN;
 305 GCOV_LINKAGE void gcov_write_tag_length (gcov_unsigned_t, gcov_unsigned_t)
 306     ATTRIBUTE_HIDDEN;
 307 GCOV_LINKAGE void gcov_write_summary (gcov_unsigned_t /*tag*/,
 308                                       const struct gcov_summary *)
 309     ATTRIBUTE_HIDDEN;
 310 GCOV_LINKAGE void gcov_seek (gcov_position_t /*position*/) ATTRIBUTE_HIDDEN;
 311 GCOV_LINKAGE void gcov_rewrite (void) ATTRIBUTE_HIDDEN;
 312
 313 /* "Counts" stored in gcda files can be a real counter value, or
 314    an target address. When differentiate these two types because
 315    when manipulating counts, we should only change real counter values,
 316    rather target addresses.  */
 317
 318 static inline gcov_type
 319 gcov_get_counter (void)
 320 {
 321 #ifndef IN_GCOV_TOOL
 322   /* This version is for reading count values in libgcov runtime:
 323      we read from gcda files.  */
 324
 325   return gcov_read_counter ();
 326 #else
 327   /* This version is for gcov-tool. We read the value from memory and
 328      multiply it by the merge weight.  */
 329
 330   return gcov_read_counter_mem () * gcov_get_merge_weight ();
 331 #endif
 332 }
 333
 334 /* Similar function as gcov_get_counter(), but handles target address
 335    counters.  */
 336
 337 static inline gcov_type
 338 gcov_get_counter_target (void)
 339 {
 340 #ifndef IN_GCOV_TOOL
 341   /* This version is for reading count target values in libgcov runtime:
 342      we read from gcda files.  */
 343
 344   return gcov_read_counter ();
 345 #else
 346   /* This version is for gcov-tool.  We read the value from memory and we do NOT
 347      multiply it by the merge weight.  */
 348
 349   return gcov_read_counter_mem ();
 350 #endif
 351 }
 352
 353 #endif /* !inhibit_libc */
 354
 355 #endif /* GCC_LIBGCOV_H */