]> gcc.gnu.org Git - gcc.git/blame - libgcc/libgcov.h
re PR fortran/83057 (OPEN without a filename and without STATUS='SCRATCH' could produ...
[gcc.git] / libgcc / libgcov.h
CommitLineData
40d6b753 1/* Header file for libgcov-*.c.
a5544970 2 Copyright (C) 1996-2019 Free Software Foundation, Inc.
40d6b753
RX
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
c77556a5
RX
36#ifndef IN_GCOV_TOOL
37/* About the target. */
38/* This path will be used by libgcov runtime. */
39
40d6b753 40#include "tconfig.h"
a51a76e5 41#include "auto-target.h"
40d6b753
RX
42#include "tsystem.h"
43#include "coretypes.h"
44#include "tm.h"
45#include "libgcc_tm.h"
46928a8f 46#include "gcov.h"
40d6b753 47
a153644f 48#if __CHAR_BIT__ == 8
40d6b753
RX
49typedef unsigned gcov_unsigned_t __attribute__ ((mode (SI)));
50typedef unsigned gcov_position_t __attribute__ ((mode (SI)));
51#if LONG_LONG_TYPE_SIZE > 32
52typedef signed gcov_type __attribute__ ((mode (DI)));
53typedef unsigned gcov_type_unsigned __attribute__ ((mode (DI)));
54#else
55typedef signed gcov_type __attribute__ ((mode (SI)));
56typedef unsigned gcov_type_unsigned __attribute__ ((mode (SI)));
57#endif
58#else
a153644f 59#if __CHAR_BIT__ == 16
40d6b753
RX
60typedef unsigned gcov_unsigned_t __attribute__ ((mode (HI)));
61typedef unsigned gcov_position_t __attribute__ ((mode (HI)));
62#if LONG_LONG_TYPE_SIZE > 32
63typedef signed gcov_type __attribute__ ((mode (SI)));
64typedef unsigned gcov_type_unsigned __attribute__ ((mode (SI)));
65#else
66typedef signed gcov_type __attribute__ ((mode (HI)));
67typedef unsigned gcov_type_unsigned __attribute__ ((mode (HI)));
68#endif
69#else
70typedef unsigned gcov_unsigned_t __attribute__ ((mode (QI)));
71typedef unsigned gcov_position_t __attribute__ ((mode (QI)));
72#if LONG_LONG_TYPE_SIZE > 32
73typedef signed gcov_type __attribute__ ((mode (HI)));
74typedef unsigned gcov_type_unsigned __attribute__ ((mode (HI)));
75#else
76typedef signed gcov_type __attribute__ ((mode (QI)));
77typedef 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
19926161
NS
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
afe0c5ee 105#define gcov_sort_n_vals __gcov_sort_n_vals
19926161 106
c77556a5
RX
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
117typedef unsigned gcov_unsigned_t;
118typedef 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
c77556a5
RX
131#define L_gcov_merge_ior 1
132#define L_gcov_merge_time_profile 1
afe0c5ee 133#define L_gcov_merge_icall_topn 1
c77556a5 134
c77556a5
RX
135extern gcov_type gcov_read_counter_mem ();
136extern unsigned gcov_get_merge_weight ();
d10ee722 137extern struct gcov_info *gcov_list;
c77556a5
RX
138
139#endif /* !IN_GCOV_TOOL */
140
40d6b753
RX
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
40d6b753
RX
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. */
166struct 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
178struct 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 */
72602c6c 184 struct gcov_ctr_info ctrs[1]; /* instrumented counters */
40d6b753
RX
185};
186
187/* Type of function used to merge counters. */
188typedef void (*gcov_merge_fn) (gcov_type *, gcov_unsigned_t);
189
190/* Information about a single object file. */
191struct 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 */
c77556a5
RX
203
204#ifndef IN_GCOV_TOOL
40d6b753 205 const struct gcov_fn_info *const *functions; /* pointer to pointers
c77556a5
RX
206 to function information */
207#else
208 const struct gcov_fn_info **functions;
209#endif /* !IN_GCOV_TOOL */
40d6b753
RX
210};
211
4303c581
NS
212/* Root of a program/shared-object state */
213struct 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. */
cadb2b96
NS
218 struct gcov_root *next;
219 struct gcov_root *prev;
4303c581
NS
220};
221
222extern struct gcov_root __gcov_root ATTRIBUTE_HIDDEN;
223
cadb2b96
NS
224struct gcov_master
225{
226 gcov_unsigned_t version;
227 struct gcov_root *root;
228};
3edbcdbe
ML
229
230struct indirect_call_tuple
231{
232 /* Callee function. */
233 void *callee;
234
235 /* Pointer to counters. */
236 gcov_type *counters;
237};
cadb2b96
NS
238
239/* Exactly one of these will be active in the process. */
240extern struct gcov_master __gcov_master;
241
4303c581
NS
242/* Dump a set of gcov objects. */
243extern void __gcov_dump_one (struct gcov_root *) ATTRIBUTE_HIDDEN;
244
40d6b753
RX
245/* Register a new object file module. */
246extern void __gcov_init (struct gcov_info *) ATTRIBUTE_HIDDEN;
247
8c9434c2
ML
248/* GCOV exit function registered via a static destructor. */
249extern void __gcov_exit (void) ATTRIBUTE_HIDDEN;
250
b20ee094
NS
251/* Function to reset all counters to 0. Both externally visible (and
252 overridable) and internal version. */
b20ee094 253extern void __gcov_reset_int (void) ATTRIBUTE_HIDDEN;
40d6b753 254
cadb2b96 255/* User function to enable early write of profile information so far. */
cadb2b96 256extern void __gcov_dump_int (void) ATTRIBUTE_HIDDEN;
40d6b753
RX
257
258/* The merge function that just sums the counters. */
259extern void __gcov_merge_add (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
260
261/* The merge function to select the minimum valid counter value. */
262extern void __gcov_merge_time_profile (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
263
264/* The merge function to choose the most common value. */
265extern void __gcov_merge_single (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
266
40d6b753
RX
267/* The merge function that just ors the counters together. */
268extern void __gcov_merge_ior (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
269
afe0c5ee
RX
270/* The merge function is used for topn indirect call counters. */
271extern void __gcov_merge_icall_topn (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
272
40d6b753
RX
273/* The profiler functions. */
274extern void __gcov_interval_profiler (gcov_type *, gcov_type, int, unsigned);
a266236e
ML
275extern void __gcov_interval_profiler_atomic (gcov_type *, gcov_type, int,
276 unsigned);
40d6b753 277extern void __gcov_pow2_profiler (gcov_type *, gcov_type);
a266236e 278extern void __gcov_pow2_profiler_atomic (gcov_type *, gcov_type);
40d6b753 279extern void __gcov_one_value_profiler (gcov_type *, gcov_type);
a266236e 280extern void __gcov_one_value_profiler_atomic (gcov_type *, gcov_type);
756721ba 281extern void __gcov_indirect_call_profiler_v3 (gcov_type, void *);
40d6b753 282extern void __gcov_time_profiler (gcov_type *);
a266236e 283extern void __gcov_time_profiler_atomic (gcov_type *);
40d6b753 284extern void __gcov_average_profiler (gcov_type *, gcov_type);
a266236e 285extern void __gcov_average_profiler_atomic (gcov_type *, gcov_type);
40d6b753 286extern void __gcov_ior_profiler (gcov_type *, gcov_type);
a266236e 287extern void __gcov_ior_profiler_atomic (gcov_type *, gcov_type);
afe0c5ee
RX
288extern void __gcov_indirect_call_topn_profiler (gcov_type, void *);
289extern void gcov_sort_n_vals (gcov_type *, int);
40d6b753
RX
290
291#ifndef inhibit_libc
292/* The wrappers around some library functions.. */
293extern pid_t __gcov_fork (void) ATTRIBUTE_HIDDEN;
294extern int __gcov_execl (const char *, char *, ...) ATTRIBUTE_HIDDEN;
295extern int __gcov_execlp (const char *, char *, ...) ATTRIBUTE_HIDDEN;
296extern int __gcov_execle (const char *, char *, ...) ATTRIBUTE_HIDDEN;
297extern int __gcov_execv (const char *, char *const []) ATTRIBUTE_HIDDEN;
298extern int __gcov_execvp (const char *, char *const []) ATTRIBUTE_HIDDEN;
299extern int __gcov_execve (const char *, char *const [], char *const [])
300 ATTRIBUTE_HIDDEN;
301
302/* Functions that only available in libgcov. */
303GCOV_LINKAGE int gcov_open (const char */*name*/) ATTRIBUTE_HIDDEN;
304GCOV_LINKAGE void gcov_write_counter (gcov_type) ATTRIBUTE_HIDDEN;
305GCOV_LINKAGE void gcov_write_tag_length (gcov_unsigned_t, gcov_unsigned_t)
306 ATTRIBUTE_HIDDEN;
307GCOV_LINKAGE void gcov_write_summary (gcov_unsigned_t /*tag*/,
308 const struct gcov_summary *)
309 ATTRIBUTE_HIDDEN;
310GCOV_LINKAGE void gcov_seek (gcov_position_t /*position*/) ATTRIBUTE_HIDDEN;
19926161 311GCOV_LINKAGE void gcov_rewrite (void) ATTRIBUTE_HIDDEN;
40d6b753 312
c77556a5
RX
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
318static inline gcov_type
319gcov_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
337static inline gcov_type
338gcov_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
40d6b753
RX
353#endif /* !inhibit_libc */
354
355#endif /* GCC_LIBGCOV_H */
This page took 0.60046 seconds and 5 git commands to generate.