Daily bump.
[official-gcc.git] / libgcc / libgcov.h
blob21422873cf2260899d91a8bdb0c4a5ea9dc53ff9
1 /* Header file for libgcov-*.c.
2 Copyright (C) 1996-2018 Free Software Foundation, Inc.
4 This file is part of GCC.
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.
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.
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.
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/>. */
25 #ifndef GCC_LIBGCOV_H
26 #define GCC_LIBGCOV_H
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
36 #ifndef IN_GCOV_TOOL
37 /* About the target. */
38 /* This path will be used by libgcov runtime. */
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"
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
82 #if defined (TARGET_POSIX_IO)
83 #define GCOV_LOCKED 1
84 #else
85 #define GCOV_LOCKED 0
86 #endif
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
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. */
112 #include "config.h"
113 #include "system.h"
114 #include "coretypes.h"
115 #include "tm.h"
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
126 /* Some Macros specific to gcov-tool. */
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
135 extern gcov_type gcov_read_counter_mem ();
136 extern unsigned gcov_get_merge_weight ();
137 extern struct gcov_info *gcov_list;
139 #endif /* !IN_GCOV_TOOL */
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
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
154 #ifdef HAVE_GAS_HIDDEN
155 #define ATTRIBUTE_HIDDEN __attribute__ ((__visibility__ ("hidden")))
156 #else
157 #define ATTRIBUTE_HIDDEN
158 #endif
160 #include "gcov-io.h"
162 /* Structures embedded in coveraged program. The structures generated
163 by write_profile must match these. */
165 /* Information about counters for a single function. */
166 struct gcov_ctr_info
168 gcov_unsigned_t num; /* number of counters. */
169 gcov_type *values; /* their values. */
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. */
178 struct gcov_fn_info
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 */
187 /* Type of function used to merge counters. */
188 typedef void (*gcov_merge_fn) (gcov_type *, gcov_unsigned_t);
190 /* Information about a single object file. */
191 struct gcov_info
193 gcov_unsigned_t version; /* expected version number */
194 struct gcov_info *next; /* link to next, used by libgcov */
196 gcov_unsigned_t stamp; /* uniquifying time stamp */
197 const char *filename; /* output file name */
199 gcov_merge_fn merge[GCOV_COUNTERS]; /* merge functions (null for
200 unused) */
202 unsigned n_functions; /* number of functions */
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 */
212 /* Root of a program/shared-object state */
213 struct gcov_root
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;
222 extern struct gcov_root __gcov_root ATTRIBUTE_HIDDEN;
224 struct gcov_master
226 gcov_unsigned_t version;
227 struct gcov_root *root;
230 /* Exactly one of these will be active in the process. */
231 extern struct gcov_master __gcov_master;
233 /* Dump a set of gcov objects. */
234 extern void __gcov_dump_one (struct gcov_root *) ATTRIBUTE_HIDDEN;
236 /* Register a new object file module. */
237 extern void __gcov_init (struct gcov_info *) ATTRIBUTE_HIDDEN;
239 /* GCOV exit function registered via a static destructor. */
240 extern void __gcov_exit (void) ATTRIBUTE_HIDDEN;
242 /* Function to reset all counters to 0. Both externally visible (and
243 overridable) and internal version. */
244 extern void __gcov_reset_int (void) ATTRIBUTE_HIDDEN;
246 /* User function to enable early write of profile information so far. */
247 extern void __gcov_dump_int (void) ATTRIBUTE_HIDDEN;
249 /* The merge function that just sums the counters. */
250 extern void __gcov_merge_add (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
252 /* The merge function to select the minimum valid counter value. */
253 extern void __gcov_merge_time_profile (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
255 /* The merge function to choose the most common value. */
256 extern void __gcov_merge_single (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
258 /* The merge function that just ors the counters together. */
259 extern void __gcov_merge_ior (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
261 /* The merge function is used for topn indirect call counters. */
262 extern void __gcov_merge_icall_topn (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
264 /* The profiler functions. */
265 extern void __gcov_interval_profiler (gcov_type *, gcov_type, int, unsigned);
266 extern void __gcov_interval_profiler_atomic (gcov_type *, gcov_type, int,
267 unsigned);
268 extern void __gcov_pow2_profiler (gcov_type *, gcov_type);
269 extern void __gcov_pow2_profiler_atomic (gcov_type *, gcov_type);
270 extern void __gcov_one_value_profiler (gcov_type *, gcov_type);
271 extern void __gcov_one_value_profiler_atomic (gcov_type *, gcov_type);
272 extern void __gcov_indirect_call_profiler_v2 (gcov_type, void *);
273 extern void __gcov_time_profiler (gcov_type *);
274 extern void __gcov_time_profiler_atomic (gcov_type *);
275 extern void __gcov_average_profiler (gcov_type *, gcov_type);
276 extern void __gcov_average_profiler_atomic (gcov_type *, gcov_type);
277 extern void __gcov_ior_profiler (gcov_type *, gcov_type);
278 extern void __gcov_ior_profiler_atomic (gcov_type *, gcov_type);
279 extern void __gcov_indirect_call_topn_profiler (gcov_type, void *);
280 extern void gcov_sort_n_vals (gcov_type *, int);
282 #ifndef inhibit_libc
283 /* The wrappers around some library functions.. */
284 extern pid_t __gcov_fork (void) ATTRIBUTE_HIDDEN;
285 extern int __gcov_execl (const char *, char *, ...) ATTRIBUTE_HIDDEN;
286 extern int __gcov_execlp (const char *, char *, ...) ATTRIBUTE_HIDDEN;
287 extern int __gcov_execle (const char *, char *, ...) ATTRIBUTE_HIDDEN;
288 extern int __gcov_execv (const char *, char *const []) ATTRIBUTE_HIDDEN;
289 extern int __gcov_execvp (const char *, char *const []) ATTRIBUTE_HIDDEN;
290 extern int __gcov_execve (const char *, char *const [], char *const [])
291 ATTRIBUTE_HIDDEN;
293 /* Functions that only available in libgcov. */
294 GCOV_LINKAGE int gcov_open (const char */*name*/) ATTRIBUTE_HIDDEN;
295 GCOV_LINKAGE void gcov_write_counter (gcov_type) ATTRIBUTE_HIDDEN;
296 GCOV_LINKAGE void gcov_write_tag_length (gcov_unsigned_t, gcov_unsigned_t)
297 ATTRIBUTE_HIDDEN;
298 GCOV_LINKAGE void gcov_write_summary (gcov_unsigned_t /*tag*/,
299 const struct gcov_summary *)
300 ATTRIBUTE_HIDDEN;
301 GCOV_LINKAGE void gcov_seek (gcov_position_t /*position*/) ATTRIBUTE_HIDDEN;
302 GCOV_LINKAGE void gcov_rewrite (void) ATTRIBUTE_HIDDEN;
304 /* "Counts" stored in gcda files can be a real counter value, or
305 an target address. When differentiate these two types because
306 when manipulating counts, we should only change real counter values,
307 rather target addresses. */
309 static inline gcov_type
310 gcov_get_counter (void)
312 #ifndef IN_GCOV_TOOL
313 /* This version is for reading count values in libgcov runtime:
314 we read from gcda files. */
316 return gcov_read_counter ();
317 #else
318 /* This version is for gcov-tool. We read the value from memory and
319 multiply it by the merge weight. */
321 return gcov_read_counter_mem () * gcov_get_merge_weight ();
322 #endif
325 /* Similar function as gcov_get_counter(), but handles target address
326 counters. */
328 static inline gcov_type
329 gcov_get_counter_target (void)
331 #ifndef IN_GCOV_TOOL
332 /* This version is for reading count target values in libgcov runtime:
333 we read from gcda files. */
335 return gcov_read_counter ();
336 #else
337 /* This version is for gcov-tool. We read the value from memory and we do NOT
338 multiply it by the merge weight. */
340 return gcov_read_counter_mem ();
341 #endif
344 #endif /* !inhibit_libc */
346 #endif /* GCC_LIBGCOV_H */