1*e4b17023SJohn Marino /* File format for coverage information
2*e4b17023SJohn Marino Copyright (C) 1996, 1997, 1998, 2000, 2002,
3*e4b17023SJohn Marino 2003, 2004, 2005, 2008, 2009 Free Software Foundation, Inc.
4*e4b17023SJohn Marino Contributed by Bob Manson <manson@cygnus.com>.
5*e4b17023SJohn Marino Completely remangled by Nathan Sidwell <nathan@codesourcery.com>.
6*e4b17023SJohn Marino
7*e4b17023SJohn Marino This file is part of GCC.
8*e4b17023SJohn Marino
9*e4b17023SJohn Marino GCC is free software; you can redistribute it and/or modify it under
10*e4b17023SJohn Marino the terms of the GNU General Public License as published by the Free
11*e4b17023SJohn Marino Software Foundation; either version 3, or (at your option) any later
12*e4b17023SJohn Marino version.
13*e4b17023SJohn Marino
14*e4b17023SJohn Marino GCC is distributed in the hope that it will be useful, but WITHOUT ANY
15*e4b17023SJohn Marino WARRANTY; without even the implied warranty of MERCHANTABILITY or
16*e4b17023SJohn Marino FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17*e4b17023SJohn Marino for more details.
18*e4b17023SJohn Marino
19*e4b17023SJohn Marino Under Section 7 of GPL version 3, you are granted additional
20*e4b17023SJohn Marino permissions described in the GCC Runtime Library Exception, version
21*e4b17023SJohn Marino 3.1, as published by the Free Software Foundation.
22*e4b17023SJohn Marino
23*e4b17023SJohn Marino You should have received a copy of the GNU General Public License and
24*e4b17023SJohn Marino a copy of the GCC Runtime Library Exception along with this program;
25*e4b17023SJohn Marino see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
26*e4b17023SJohn Marino <http://www.gnu.org/licenses/>. */
27*e4b17023SJohn Marino
28*e4b17023SJohn Marino
29*e4b17023SJohn Marino /* Coverage information is held in two files. A notes file, which is
30*e4b17023SJohn Marino generated by the compiler, and a data file, which is generated by
31*e4b17023SJohn Marino the program under test. Both files use a similar structure. We do
32*e4b17023SJohn Marino not attempt to make these files backwards compatible with previous
33*e4b17023SJohn Marino versions, as you only need coverage information when developing a
34*e4b17023SJohn Marino program. We do hold version information, so that mismatches can be
35*e4b17023SJohn Marino detected, and we use a format that allows tools to skip information
36*e4b17023SJohn Marino they do not understand or are not interested in.
37*e4b17023SJohn Marino
38*e4b17023SJohn Marino Numbers are recorded in the 32 bit unsigned binary form of the
39*e4b17023SJohn Marino endianness of the machine generating the file. 64 bit numbers are
40*e4b17023SJohn Marino stored as two 32 bit numbers, the low part first. Strings are
41*e4b17023SJohn Marino padded with 1 to 4 NUL bytes, to bring the length up to a multiple
42*e4b17023SJohn Marino of 4. The number of 4 bytes is stored, followed by the padded
43*e4b17023SJohn Marino string. Zero length and NULL strings are simply stored as a length
44*e4b17023SJohn Marino of zero (they have no trailing NUL or padding).
45*e4b17023SJohn Marino
46*e4b17023SJohn Marino int32: byte3 byte2 byte1 byte0 | byte0 byte1 byte2 byte3
47*e4b17023SJohn Marino int64: int32:low int32:high
48*e4b17023SJohn Marino string: int32:0 | int32:length char* char:0 padding
49*e4b17023SJohn Marino padding: | char:0 | char:0 char:0 | char:0 char:0 char:0
50*e4b17023SJohn Marino item: int32 | int64 | string
51*e4b17023SJohn Marino
52*e4b17023SJohn Marino The basic format of the files is
53*e4b17023SJohn Marino
54*e4b17023SJohn Marino file : int32:magic int32:version int32:stamp record*
55*e4b17023SJohn Marino
56*e4b17023SJohn Marino The magic ident is different for the notes and the data files. The
57*e4b17023SJohn Marino magic ident is used to determine the endianness of the file, when
58*e4b17023SJohn Marino reading. The version is the same for both files and is derived
59*e4b17023SJohn Marino from gcc's version number. The stamp value is used to synchronize
60*e4b17023SJohn Marino note and data files and to synchronize merging within a data
61*e4b17023SJohn Marino file. It need not be an absolute time stamp, merely a ticker that
62*e4b17023SJohn Marino increments fast enough and cycles slow enough to distinguish
63*e4b17023SJohn Marino different compile/run/compile cycles.
64*e4b17023SJohn Marino
65*e4b17023SJohn Marino Although the ident and version are formally 32 bit numbers, they
66*e4b17023SJohn Marino are derived from 4 character ASCII strings. The version number
67*e4b17023SJohn Marino consists of the single character major version number, a two
68*e4b17023SJohn Marino character minor version number (leading zero for versions less than
69*e4b17023SJohn Marino 10), and a single character indicating the status of the release.
70*e4b17023SJohn Marino That will be 'e' experimental, 'p' prerelease and 'r' for release.
71*e4b17023SJohn Marino Because, by good fortune, these are in alphabetical order, string
72*e4b17023SJohn Marino collating can be used to compare version strings. Be aware that
73*e4b17023SJohn Marino the 'e' designation will (naturally) be unstable and might be
74*e4b17023SJohn Marino incompatible with itself. For gcc 3.4 experimental, it would be
75*e4b17023SJohn Marino '304e' (0x33303465). When the major version reaches 10, the
76*e4b17023SJohn Marino letters A-Z will be used. Assuming minor increments releases every
77*e4b17023SJohn Marino 6 months, we have to make a major increment every 50 years.
78*e4b17023SJohn Marino Assuming major increments releases every 5 years, we're ok for the
79*e4b17023SJohn Marino next 155 years -- good enough for me.
80*e4b17023SJohn Marino
81*e4b17023SJohn Marino A record has a tag, length and variable amount of data.
82*e4b17023SJohn Marino
83*e4b17023SJohn Marino record: header data
84*e4b17023SJohn Marino header: int32:tag int32:length
85*e4b17023SJohn Marino data: item*
86*e4b17023SJohn Marino
87*e4b17023SJohn Marino Records are not nested, but there is a record hierarchy. Tag
88*e4b17023SJohn Marino numbers reflect this hierarchy. Tags are unique across note and
89*e4b17023SJohn Marino data files. Some record types have a varying amount of data. The
90*e4b17023SJohn Marino LENGTH is the number of 4bytes that follow and is usually used to
91*e4b17023SJohn Marino determine how much data. The tag value is split into 4 8-bit
92*e4b17023SJohn Marino fields, one for each of four possible levels. The most significant
93*e4b17023SJohn Marino is allocated first. Unused levels are zero. Active levels are
94*e4b17023SJohn Marino odd-valued, so that the LSB of the level is one. A sub-level
95*e4b17023SJohn Marino incorporates the values of its superlevels. This formatting allows
96*e4b17023SJohn Marino you to determine the tag hierarchy, without understanding the tags
97*e4b17023SJohn Marino themselves, and is similar to the standard section numbering used
98*e4b17023SJohn Marino in technical documents. Level values [1..3f] are used for common
99*e4b17023SJohn Marino tags, values [41..9f] for the notes file and [a1..ff] for the data
100*e4b17023SJohn Marino file.
101*e4b17023SJohn Marino
102*e4b17023SJohn Marino The basic block graph file contains the following records
103*e4b17023SJohn Marino note: unit function-graph*
104*e4b17023SJohn Marino unit: header int32:checksum string:source
105*e4b17023SJohn Marino function-graph: announce_function basic_blocks {arcs | lines}*
106*e4b17023SJohn Marino announce_function: header int32:ident
107*e4b17023SJohn Marino int32:lineno_checksum int32:cfg_checksum
108*e4b17023SJohn Marino string:name string:source int32:lineno
109*e4b17023SJohn Marino basic_block: header int32:flags*
110*e4b17023SJohn Marino arcs: header int32:block_no arc*
111*e4b17023SJohn Marino arc: int32:dest_block int32:flags
112*e4b17023SJohn Marino lines: header int32:block_no line*
113*e4b17023SJohn Marino int32:0 string:NULL
114*e4b17023SJohn Marino line: int32:line_no | int32:0 string:filename
115*e4b17023SJohn Marino
116*e4b17023SJohn Marino The BASIC_BLOCK record holds per-bb flags. The number of blocks
117*e4b17023SJohn Marino can be inferred from its data length. There is one ARCS record per
118*e4b17023SJohn Marino basic block. The number of arcs from a bb is implicit from the
119*e4b17023SJohn Marino data length. It enumerates the destination bb and per-arc flags.
120*e4b17023SJohn Marino There is one LINES record per basic block, it enumerates the source
121*e4b17023SJohn Marino lines which belong to that basic block. Source file names are
122*e4b17023SJohn Marino introduced by a line number of 0, following lines are from the new
123*e4b17023SJohn Marino source file. The initial source file for the function is NULL, but
124*e4b17023SJohn Marino the current source file should be remembered from one LINES record
125*e4b17023SJohn Marino to the next. The end of a block is indicated by an empty filename
126*e4b17023SJohn Marino - this does not reset the current source file. Note there is no
127*e4b17023SJohn Marino ordering of the ARCS and LINES records: they may be in any order,
128*e4b17023SJohn Marino interleaved in any manner. The current filename follows the order
129*e4b17023SJohn Marino the LINES records are stored in the file, *not* the ordering of the
130*e4b17023SJohn Marino blocks they are for.
131*e4b17023SJohn Marino
132*e4b17023SJohn Marino The data file contains the following records.
133*e4b17023SJohn Marino data: {unit summary:object summary:program* function-data*}*
134*e4b17023SJohn Marino unit: header int32:checksum
135*e4b17023SJohn Marino function-data: announce_function present counts
136*e4b17023SJohn Marino announce_function: header int32:ident
137*e4b17023SJohn Marino int32:lineno_checksum int32:cfg_checksum
138*e4b17023SJohn Marino present: header int32:present
139*e4b17023SJohn Marino counts: header int64:count*
140*e4b17023SJohn Marino summary: int32:checksum {count-summary}GCOV_COUNTERS_SUMMABLE
141*e4b17023SJohn Marino count-summary: int32:num int32:runs int64:sum
142*e4b17023SJohn Marino int64:max int64:sum_max
143*e4b17023SJohn Marino
144*e4b17023SJohn Marino The ANNOUNCE_FUNCTION record is the same as that in the note file,
145*e4b17023SJohn Marino but without the source location. The COUNTS gives the
146*e4b17023SJohn Marino counter values for instrumented features. The about the whole
147*e4b17023SJohn Marino program. The checksum is used for whole program summaries, and
148*e4b17023SJohn Marino disambiguates different programs which include the same
149*e4b17023SJohn Marino instrumented object file. There may be several program summaries,
150*e4b17023SJohn Marino each with a unique checksum. The object summary's checksum is
151*e4b17023SJohn Marino zero. Note that the data file might contain information from
152*e4b17023SJohn Marino several runs concatenated, or the data might be merged.
153*e4b17023SJohn Marino
154*e4b17023SJohn Marino This file is included by both the compiler, gcov tools and the
155*e4b17023SJohn Marino runtime support library libgcov. IN_LIBGCOV and IN_GCOV are used to
156*e4b17023SJohn Marino distinguish which case is which. If IN_LIBGCOV is nonzero,
157*e4b17023SJohn Marino libgcov is being built. If IN_GCOV is nonzero, the gcov tools are
158*e4b17023SJohn Marino being built. Otherwise the compiler is being built. IN_GCOV may be
159*e4b17023SJohn Marino positive or negative. If positive, we are compiling a tool that
160*e4b17023SJohn Marino requires additional functions (see the code for knowledge of what
161*e4b17023SJohn Marino those functions are). */
162*e4b17023SJohn Marino
163*e4b17023SJohn Marino #ifndef GCC_GCOV_IO_H
164*e4b17023SJohn Marino #define GCC_GCOV_IO_H
165*e4b17023SJohn Marino
166*e4b17023SJohn Marino #if IN_LIBGCOV
167*e4b17023SJohn Marino /* About the target */
168*e4b17023SJohn Marino
169*e4b17023SJohn Marino #if BITS_PER_UNIT == 8
170*e4b17023SJohn Marino typedef unsigned gcov_unsigned_t __attribute__ ((mode (SI)));
171*e4b17023SJohn Marino typedef unsigned gcov_position_t __attribute__ ((mode (SI)));
172*e4b17023SJohn Marino #if LONG_LONG_TYPE_SIZE > 32
173*e4b17023SJohn Marino typedef signed gcov_type __attribute__ ((mode (DI)));
174*e4b17023SJohn Marino #else
175*e4b17023SJohn Marino typedef signed gcov_type __attribute__ ((mode (SI)));
176*e4b17023SJohn Marino #endif
177*e4b17023SJohn Marino #else
178*e4b17023SJohn Marino #if BITS_PER_UNIT == 16
179*e4b17023SJohn Marino typedef unsigned gcov_unsigned_t __attribute__ ((mode (HI)));
180*e4b17023SJohn Marino typedef unsigned gcov_position_t __attribute__ ((mode (HI)));
181*e4b17023SJohn Marino #if LONG_LONG_TYPE_SIZE > 32
182*e4b17023SJohn Marino typedef signed gcov_type __attribute__ ((mode (SI)));
183*e4b17023SJohn Marino #else
184*e4b17023SJohn Marino typedef signed gcov_type __attribute__ ((mode (HI)));
185*e4b17023SJohn Marino #endif
186*e4b17023SJohn Marino #else
187*e4b17023SJohn Marino typedef unsigned gcov_unsigned_t __attribute__ ((mode (QI)));
188*e4b17023SJohn Marino typedef unsigned gcov_position_t __attribute__ ((mode (QI)));
189*e4b17023SJohn Marino #if LONG_LONG_TYPE_SIZE > 32
190*e4b17023SJohn Marino typedef signed gcov_type __attribute__ ((mode (HI)));
191*e4b17023SJohn Marino #else
192*e4b17023SJohn Marino typedef signed gcov_type __attribute__ ((mode (QI)));
193*e4b17023SJohn Marino #endif
194*e4b17023SJohn Marino #endif
195*e4b17023SJohn Marino #endif
196*e4b17023SJohn Marino
197*e4b17023SJohn Marino
198*e4b17023SJohn Marino #if defined (TARGET_POSIX_IO)
199*e4b17023SJohn Marino #define GCOV_LOCKED 1
200*e4b17023SJohn Marino #else
201*e4b17023SJohn Marino #define GCOV_LOCKED 0
202*e4b17023SJohn Marino #endif
203*e4b17023SJohn Marino
204*e4b17023SJohn Marino #else /* !IN_LIBGCOV */
205*e4b17023SJohn Marino /* About the host */
206*e4b17023SJohn Marino
207*e4b17023SJohn Marino typedef unsigned gcov_unsigned_t;
208*e4b17023SJohn Marino typedef unsigned gcov_position_t;
209*e4b17023SJohn Marino /* gcov_type is typedef'd elsewhere for the compiler */
210*e4b17023SJohn Marino #if IN_GCOV
211*e4b17023SJohn Marino #define GCOV_LINKAGE static
212*e4b17023SJohn Marino typedef HOST_WIDEST_INT gcov_type;
213*e4b17023SJohn Marino #if IN_GCOV > 0
214*e4b17023SJohn Marino #include <sys/types.h>
215*e4b17023SJohn Marino #endif
216*e4b17023SJohn Marino #else /*!IN_GCOV */
217*e4b17023SJohn Marino #define GCOV_TYPE_SIZE (LONG_LONG_TYPE_SIZE > 32 ? 64 : 32)
218*e4b17023SJohn Marino #endif
219*e4b17023SJohn Marino
220*e4b17023SJohn Marino #if defined (HOST_HAS_F_SETLKW)
221*e4b17023SJohn Marino #define GCOV_LOCKED 1
222*e4b17023SJohn Marino #else
223*e4b17023SJohn Marino #define GCOV_LOCKED 0
224*e4b17023SJohn Marino #endif
225*e4b17023SJohn Marino
226*e4b17023SJohn Marino #endif /* !IN_LIBGCOV */
227*e4b17023SJohn Marino
228*e4b17023SJohn Marino /* In gcov we want function linkage to be static. In the compiler we want
229*e4b17023SJohn Marino it extern, so that they can be accessed from elsewhere. In libgcov we
230*e4b17023SJohn Marino need these functions to be extern, so prefix them with __gcov. In
231*e4b17023SJohn Marino libgcov they must also be hidden so that the instance in the executable
232*e4b17023SJohn Marino is not also used in a DSO. */
233*e4b17023SJohn Marino #if IN_LIBGCOV
234*e4b17023SJohn Marino
235*e4b17023SJohn Marino #include "tconfig.h"
236*e4b17023SJohn Marino
237*e4b17023SJohn Marino #define gcov_var __gcov_var
238*e4b17023SJohn Marino #define gcov_open __gcov_open
239*e4b17023SJohn Marino #define gcov_close __gcov_close
240*e4b17023SJohn Marino #define gcov_write_tag_length __gcov_write_tag_length
241*e4b17023SJohn Marino #define gcov_position __gcov_position
242*e4b17023SJohn Marino #define gcov_seek __gcov_seek
243*e4b17023SJohn Marino #define gcov_rewrite __gcov_rewrite
244*e4b17023SJohn Marino #define gcov_is_error __gcov_is_error
245*e4b17023SJohn Marino #define gcov_write_unsigned __gcov_write_unsigned
246*e4b17023SJohn Marino #define gcov_write_counter __gcov_write_counter
247*e4b17023SJohn Marino #define gcov_write_summary __gcov_write_summary
248*e4b17023SJohn Marino #define gcov_read_unsigned __gcov_read_unsigned
249*e4b17023SJohn Marino #define gcov_read_counter __gcov_read_counter
250*e4b17023SJohn Marino #define gcov_read_summary __gcov_read_summary
251*e4b17023SJohn Marino
252*e4b17023SJohn Marino /* Poison these, so they don't accidentally slip in. */
253*e4b17023SJohn Marino #pragma GCC poison gcov_write_string gcov_write_tag gcov_write_length
254*e4b17023SJohn Marino #pragma GCC poison gcov_read_string gcov_sync gcov_time gcov_magic
255*e4b17023SJohn Marino
256*e4b17023SJohn Marino #ifdef HAVE_GAS_HIDDEN
257*e4b17023SJohn Marino #define ATTRIBUTE_HIDDEN __attribute__ ((__visibility__ ("hidden")))
258*e4b17023SJohn Marino #else
259*e4b17023SJohn Marino #define ATTRIBUTE_HIDDEN
260*e4b17023SJohn Marino #endif
261*e4b17023SJohn Marino
262*e4b17023SJohn Marino #else
263*e4b17023SJohn Marino
264*e4b17023SJohn Marino #define ATTRIBUTE_HIDDEN
265*e4b17023SJohn Marino
266*e4b17023SJohn Marino #endif
267*e4b17023SJohn Marino
268*e4b17023SJohn Marino #ifndef GCOV_LINKAGE
269*e4b17023SJohn Marino #define GCOV_LINKAGE extern
270*e4b17023SJohn Marino #endif
271*e4b17023SJohn Marino
272*e4b17023SJohn Marino /* File suffixes. */
273*e4b17023SJohn Marino #define GCOV_DATA_SUFFIX ".gcda"
274*e4b17023SJohn Marino #define GCOV_NOTE_SUFFIX ".gcno"
275*e4b17023SJohn Marino
276*e4b17023SJohn Marino /* File magic. Must not be palindromes. */
277*e4b17023SJohn Marino #define GCOV_DATA_MAGIC ((gcov_unsigned_t)0x67636461) /* "gcda" */
278*e4b17023SJohn Marino #define GCOV_NOTE_MAGIC ((gcov_unsigned_t)0x67636e6f) /* "gcno" */
279*e4b17023SJohn Marino
280*e4b17023SJohn Marino /* gcov-iov.h is automatically generated by the makefile from
281*e4b17023SJohn Marino version.c, it looks like
282*e4b17023SJohn Marino #define GCOV_VERSION ((gcov_unsigned_t)0x89abcdef)
283*e4b17023SJohn Marino */
284*e4b17023SJohn Marino #include "gcov-iov.h"
285*e4b17023SJohn Marino
286*e4b17023SJohn Marino /* Convert a magic or version number to a 4 character string. */
287*e4b17023SJohn Marino #define GCOV_UNSIGNED2STRING(ARRAY,VALUE) \
288*e4b17023SJohn Marino ((ARRAY)[0] = (char)((VALUE) >> 24), \
289*e4b17023SJohn Marino (ARRAY)[1] = (char)((VALUE) >> 16), \
290*e4b17023SJohn Marino (ARRAY)[2] = (char)((VALUE) >> 8), \
291*e4b17023SJohn Marino (ARRAY)[3] = (char)((VALUE) >> 0))
292*e4b17023SJohn Marino
293*e4b17023SJohn Marino /* The record tags. Values [1..3f] are for tags which may be in either
294*e4b17023SJohn Marino file. Values [41..9f] for those in the note file and [a1..ff] for
295*e4b17023SJohn Marino the data file. The tag value zero is used as an explicit end of
296*e4b17023SJohn Marino file marker -- it is not required to be present. */
297*e4b17023SJohn Marino
298*e4b17023SJohn Marino #define GCOV_TAG_FUNCTION ((gcov_unsigned_t)0x01000000)
299*e4b17023SJohn Marino #define GCOV_TAG_FUNCTION_LENGTH (3)
300*e4b17023SJohn Marino #define GCOV_TAG_BLOCKS ((gcov_unsigned_t)0x01410000)
301*e4b17023SJohn Marino #define GCOV_TAG_BLOCKS_LENGTH(NUM) (NUM)
302*e4b17023SJohn Marino #define GCOV_TAG_BLOCKS_NUM(LENGTH) (LENGTH)
303*e4b17023SJohn Marino #define GCOV_TAG_ARCS ((gcov_unsigned_t)0x01430000)
304*e4b17023SJohn Marino #define GCOV_TAG_ARCS_LENGTH(NUM) (1 + (NUM) * 2)
305*e4b17023SJohn Marino #define GCOV_TAG_ARCS_NUM(LENGTH) (((LENGTH) - 1) / 2)
306*e4b17023SJohn Marino #define GCOV_TAG_LINES ((gcov_unsigned_t)0x01450000)
307*e4b17023SJohn Marino #define GCOV_TAG_COUNTER_BASE ((gcov_unsigned_t)0x01a10000)
308*e4b17023SJohn Marino #define GCOV_TAG_COUNTER_LENGTH(NUM) ((NUM) * 2)
309*e4b17023SJohn Marino #define GCOV_TAG_COUNTER_NUM(LENGTH) ((LENGTH) / 2)
310*e4b17023SJohn Marino #define GCOV_TAG_OBJECT_SUMMARY ((gcov_unsigned_t)0xa1000000) /* Obsolete */
311*e4b17023SJohn Marino #define GCOV_TAG_PROGRAM_SUMMARY ((gcov_unsigned_t)0xa3000000)
312*e4b17023SJohn Marino #define GCOV_TAG_SUMMARY_LENGTH \
313*e4b17023SJohn Marino (1 + GCOV_COUNTERS_SUMMABLE * (2 + 3 * 2))
314*e4b17023SJohn Marino
315*e4b17023SJohn Marino /* Counters that are collected. */
316*e4b17023SJohn Marino #define GCOV_COUNTER_ARCS 0 /* Arc transitions. */
317*e4b17023SJohn Marino #define GCOV_COUNTERS_SUMMABLE 1 /* Counters which can be
318*e4b17023SJohn Marino summaried. */
319*e4b17023SJohn Marino #define GCOV_FIRST_VALUE_COUNTER 1 /* The first of counters used for value
320*e4b17023SJohn Marino profiling. They must form a consecutive
321*e4b17023SJohn Marino interval and their order must match
322*e4b17023SJohn Marino the order of HIST_TYPEs in
323*e4b17023SJohn Marino value-prof.h. */
324*e4b17023SJohn Marino #define GCOV_COUNTER_V_INTERVAL 1 /* Histogram of value inside an interval. */
325*e4b17023SJohn Marino #define GCOV_COUNTER_V_POW2 2 /* Histogram of exact power2 logarithm
326*e4b17023SJohn Marino of a value. */
327*e4b17023SJohn Marino #define GCOV_COUNTER_V_SINGLE 3 /* The most common value of expression. */
328*e4b17023SJohn Marino #define GCOV_COUNTER_V_DELTA 4 /* The most common difference between
329*e4b17023SJohn Marino consecutive values of expression. */
330*e4b17023SJohn Marino
331*e4b17023SJohn Marino #define GCOV_COUNTER_V_INDIR 5 /* The most common indirect address */
332*e4b17023SJohn Marino #define GCOV_COUNTER_AVERAGE 6 /* Compute average value passed to the
333*e4b17023SJohn Marino counter. */
334*e4b17023SJohn Marino #define GCOV_COUNTER_IOR 7 /* IOR of the all values passed to
335*e4b17023SJohn Marino counter. */
336*e4b17023SJohn Marino #define GCOV_LAST_VALUE_COUNTER 7 /* The last of counters used for value
337*e4b17023SJohn Marino profiling. */
338*e4b17023SJohn Marino #define GCOV_COUNTERS 8
339*e4b17023SJohn Marino
340*e4b17023SJohn Marino /* Number of counters used for value profiling. */
341*e4b17023SJohn Marino #define GCOV_N_VALUE_COUNTERS \
342*e4b17023SJohn Marino (GCOV_LAST_VALUE_COUNTER - GCOV_FIRST_VALUE_COUNTER + 1)
343*e4b17023SJohn Marino
344*e4b17023SJohn Marino /* A list of human readable names of the counters */
345*e4b17023SJohn Marino #define GCOV_COUNTER_NAMES {"arcs", "interval", "pow2", "single", \
346*e4b17023SJohn Marino "delta", "indirect_call", "average", "ior"}
347*e4b17023SJohn Marino
348*e4b17023SJohn Marino /* Names of merge functions for counters. */
349*e4b17023SJohn Marino #define GCOV_MERGE_FUNCTIONS {"__gcov_merge_add", \
350*e4b17023SJohn Marino "__gcov_merge_add", \
351*e4b17023SJohn Marino "__gcov_merge_add", \
352*e4b17023SJohn Marino "__gcov_merge_single", \
353*e4b17023SJohn Marino "__gcov_merge_delta", \
354*e4b17023SJohn Marino "__gcov_merge_single", \
355*e4b17023SJohn Marino "__gcov_merge_add", \
356*e4b17023SJohn Marino "__gcov_merge_ior"}
357*e4b17023SJohn Marino
358*e4b17023SJohn Marino /* Convert a counter index to a tag. */
359*e4b17023SJohn Marino #define GCOV_TAG_FOR_COUNTER(COUNT) \
360*e4b17023SJohn Marino (GCOV_TAG_COUNTER_BASE + ((gcov_unsigned_t)(COUNT) << 17))
361*e4b17023SJohn Marino /* Convert a tag to a counter. */
362*e4b17023SJohn Marino #define GCOV_COUNTER_FOR_TAG(TAG) \
363*e4b17023SJohn Marino ((unsigned)(((TAG) - GCOV_TAG_COUNTER_BASE) >> 17))
364*e4b17023SJohn Marino /* Check whether a tag is a counter tag. */
365*e4b17023SJohn Marino #define GCOV_TAG_IS_COUNTER(TAG) \
366*e4b17023SJohn Marino (!((TAG) & 0xFFFF) && GCOV_COUNTER_FOR_TAG (TAG) < GCOV_COUNTERS)
367*e4b17023SJohn Marino
368*e4b17023SJohn Marino /* The tag level mask has 1's in the position of the inner levels, &
369*e4b17023SJohn Marino the lsb of the current level, and zero on the current and outer
370*e4b17023SJohn Marino levels. */
371*e4b17023SJohn Marino #define GCOV_TAG_MASK(TAG) (((TAG) - 1) ^ (TAG))
372*e4b17023SJohn Marino
373*e4b17023SJohn Marino /* Return nonzero if SUB is an immediate subtag of TAG. */
374*e4b17023SJohn Marino #define GCOV_TAG_IS_SUBTAG(TAG,SUB) \
375*e4b17023SJohn Marino (GCOV_TAG_MASK (TAG) >> 8 == GCOV_TAG_MASK (SUB) \
376*e4b17023SJohn Marino && !(((SUB) ^ (TAG)) & ~GCOV_TAG_MASK(TAG)))
377*e4b17023SJohn Marino
378*e4b17023SJohn Marino /* Return nonzero if SUB is at a sublevel to TAG. */
379*e4b17023SJohn Marino #define GCOV_TAG_IS_SUBLEVEL(TAG,SUB) \
380*e4b17023SJohn Marino (GCOV_TAG_MASK (TAG) > GCOV_TAG_MASK (SUB))
381*e4b17023SJohn Marino
382*e4b17023SJohn Marino /* Basic block flags. */
383*e4b17023SJohn Marino #define GCOV_BLOCK_UNEXPECTED (1 << 1)
384*e4b17023SJohn Marino
385*e4b17023SJohn Marino /* Arc flags. */
386*e4b17023SJohn Marino #define GCOV_ARC_ON_TREE (1 << 0)
387*e4b17023SJohn Marino #define GCOV_ARC_FAKE (1 << 1)
388*e4b17023SJohn Marino #define GCOV_ARC_FALLTHROUGH (1 << 2)
389*e4b17023SJohn Marino
390*e4b17023SJohn Marino /* Structured records. */
391*e4b17023SJohn Marino
392*e4b17023SJohn Marino /* Cumulative counter data. */
393*e4b17023SJohn Marino struct gcov_ctr_summary
394*e4b17023SJohn Marino {
395*e4b17023SJohn Marino gcov_unsigned_t num; /* number of counters. */
396*e4b17023SJohn Marino gcov_unsigned_t runs; /* number of program runs */
397*e4b17023SJohn Marino gcov_type sum_all; /* sum of all counters accumulated. */
398*e4b17023SJohn Marino gcov_type run_max; /* maximum value on a single run. */
399*e4b17023SJohn Marino gcov_type sum_max; /* sum of individual run max values. */
400*e4b17023SJohn Marino };
401*e4b17023SJohn Marino
402*e4b17023SJohn Marino /* Object & program summary record. */
403*e4b17023SJohn Marino struct gcov_summary
404*e4b17023SJohn Marino {
405*e4b17023SJohn Marino gcov_unsigned_t checksum; /* checksum of program */
406*e4b17023SJohn Marino struct gcov_ctr_summary ctrs[GCOV_COUNTERS_SUMMABLE];
407*e4b17023SJohn Marino };
408*e4b17023SJohn Marino
409*e4b17023SJohn Marino /* Structures embedded in coveraged program. The structures generated
410*e4b17023SJohn Marino by write_profile must match these. */
411*e4b17023SJohn Marino
412*e4b17023SJohn Marino #if IN_LIBGCOV
413*e4b17023SJohn Marino /* Information about counters for a single function. */
414*e4b17023SJohn Marino struct gcov_ctr_info
415*e4b17023SJohn Marino {
416*e4b17023SJohn Marino gcov_unsigned_t num; /* number of counters. */
417*e4b17023SJohn Marino gcov_type *values; /* their values. */
418*e4b17023SJohn Marino };
419*e4b17023SJohn Marino
420*e4b17023SJohn Marino /* Information about a single function. This uses the trailing array
421*e4b17023SJohn Marino idiom. The number of counters is determined from the merge pointer
422*e4b17023SJohn Marino array in gcov_info. The key is used to detect which of a set of
423*e4b17023SJohn Marino comdat functions was selected -- it points to the gcov_info object
424*e4b17023SJohn Marino of the object file containing the selected comdat function. */
425*e4b17023SJohn Marino
426*e4b17023SJohn Marino struct gcov_fn_info
427*e4b17023SJohn Marino {
428*e4b17023SJohn Marino const struct gcov_info *key; /* comdat key */
429*e4b17023SJohn Marino gcov_unsigned_t ident; /* unique ident of function */
430*e4b17023SJohn Marino gcov_unsigned_t lineno_checksum; /* function lineo_checksum */
431*e4b17023SJohn Marino gcov_unsigned_t cfg_checksum; /* function cfg checksum */
432*e4b17023SJohn Marino struct gcov_ctr_info ctrs[0]; /* instrumented counters */
433*e4b17023SJohn Marino };
434*e4b17023SJohn Marino
435*e4b17023SJohn Marino /* Type of function used to merge counters. */
436*e4b17023SJohn Marino typedef void (*gcov_merge_fn) (gcov_type *, gcov_unsigned_t);
437*e4b17023SJohn Marino
438*e4b17023SJohn Marino /* Information about a single object file. */
439*e4b17023SJohn Marino struct gcov_info
440*e4b17023SJohn Marino {
441*e4b17023SJohn Marino gcov_unsigned_t version; /* expected version number */
442*e4b17023SJohn Marino struct gcov_info *next; /* link to next, used by libgcov */
443*e4b17023SJohn Marino
444*e4b17023SJohn Marino gcov_unsigned_t stamp; /* uniquifying time stamp */
445*e4b17023SJohn Marino const char *filename; /* output file name */
446*e4b17023SJohn Marino
447*e4b17023SJohn Marino gcov_merge_fn merge[GCOV_COUNTERS]; /* merge functions (null for
448*e4b17023SJohn Marino unused) */
449*e4b17023SJohn Marino
450*e4b17023SJohn Marino unsigned n_functions; /* number of functions */
451*e4b17023SJohn Marino const struct gcov_fn_info *const *functions; /* pointer to pointers
452*e4b17023SJohn Marino to function information */
453*e4b17023SJohn Marino };
454*e4b17023SJohn Marino
455*e4b17023SJohn Marino /* Register a new object file module. */
456*e4b17023SJohn Marino extern void __gcov_init (struct gcov_info *) ATTRIBUTE_HIDDEN;
457*e4b17023SJohn Marino
458*e4b17023SJohn Marino /* Called before fork, to avoid double counting. */
459*e4b17023SJohn Marino extern void __gcov_flush (void) ATTRIBUTE_HIDDEN;
460*e4b17023SJohn Marino
461*e4b17023SJohn Marino /* The merge function that just sums the counters. */
462*e4b17023SJohn Marino extern void __gcov_merge_add (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
463*e4b17023SJohn Marino
464*e4b17023SJohn Marino /* The merge function to choose the most common value. */
465*e4b17023SJohn Marino extern void __gcov_merge_single (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
466*e4b17023SJohn Marino
467*e4b17023SJohn Marino /* The merge function to choose the most common difference between
468*e4b17023SJohn Marino consecutive values. */
469*e4b17023SJohn Marino extern void __gcov_merge_delta (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
470*e4b17023SJohn Marino
471*e4b17023SJohn Marino /* The merge function that just ors the counters together. */
472*e4b17023SJohn Marino extern void __gcov_merge_ior (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
473*e4b17023SJohn Marino
474*e4b17023SJohn Marino /* The profiler functions. */
475*e4b17023SJohn Marino extern void __gcov_interval_profiler (gcov_type *, gcov_type, int, unsigned);
476*e4b17023SJohn Marino extern void __gcov_pow2_profiler (gcov_type *, gcov_type);
477*e4b17023SJohn Marino extern void __gcov_one_value_profiler (gcov_type *, gcov_type);
478*e4b17023SJohn Marino extern void __gcov_indirect_call_profiler (gcov_type *, gcov_type, void *, void *);
479*e4b17023SJohn Marino extern void __gcov_average_profiler (gcov_type *, gcov_type);
480*e4b17023SJohn Marino extern void __gcov_ior_profiler (gcov_type *, gcov_type);
481*e4b17023SJohn Marino
482*e4b17023SJohn Marino #ifndef inhibit_libc
483*e4b17023SJohn Marino /* The wrappers around some library functions.. */
484*e4b17023SJohn Marino extern pid_t __gcov_fork (void) ATTRIBUTE_HIDDEN;
485*e4b17023SJohn Marino extern int __gcov_execl (const char *, char *, ...) ATTRIBUTE_HIDDEN;
486*e4b17023SJohn Marino extern int __gcov_execlp (const char *, char *, ...) ATTRIBUTE_HIDDEN;
487*e4b17023SJohn Marino extern int __gcov_execle (const char *, char *, ...) ATTRIBUTE_HIDDEN;
488*e4b17023SJohn Marino extern int __gcov_execv (const char *, char *const []) ATTRIBUTE_HIDDEN;
489*e4b17023SJohn Marino extern int __gcov_execvp (const char *, char *const []) ATTRIBUTE_HIDDEN;
490*e4b17023SJohn Marino extern int __gcov_execve (const char *, char *const [], char *const [])
491*e4b17023SJohn Marino ATTRIBUTE_HIDDEN;
492*e4b17023SJohn Marino #endif
493*e4b17023SJohn Marino
494*e4b17023SJohn Marino #endif /* IN_LIBGCOV */
495*e4b17023SJohn Marino
496*e4b17023SJohn Marino #if IN_LIBGCOV >= 0
497*e4b17023SJohn Marino
498*e4b17023SJohn Marino /* Optimum number of gcov_unsigned_t's read from or written to disk. */
499*e4b17023SJohn Marino #define GCOV_BLOCK_SIZE (1 << 10)
500*e4b17023SJohn Marino
501*e4b17023SJohn Marino GCOV_LINKAGE struct gcov_var
502*e4b17023SJohn Marino {
503*e4b17023SJohn Marino FILE *file;
504*e4b17023SJohn Marino gcov_position_t start; /* Position of first byte of block */
505*e4b17023SJohn Marino unsigned offset; /* Read/write position within the block. */
506*e4b17023SJohn Marino unsigned length; /* Read limit in the block. */
507*e4b17023SJohn Marino unsigned overread; /* Number of words overread. */
508*e4b17023SJohn Marino int error; /* < 0 overflow, > 0 disk error. */
509*e4b17023SJohn Marino int mode; /* < 0 writing, > 0 reading */
510*e4b17023SJohn Marino #if IN_LIBGCOV
511*e4b17023SJohn Marino /* Holds one block plus 4 bytes, thus all coverage reads & writes
512*e4b17023SJohn Marino fit within this buffer and we always can transfer GCOV_BLOCK_SIZE
513*e4b17023SJohn Marino to and from the disk. libgcov never backtracks and only writes 4
514*e4b17023SJohn Marino or 8 byte objects. */
515*e4b17023SJohn Marino gcov_unsigned_t buffer[GCOV_BLOCK_SIZE + 1];
516*e4b17023SJohn Marino #else
517*e4b17023SJohn Marino int endian; /* Swap endianness. */
518*e4b17023SJohn Marino /* Holds a variable length block, as the compiler can write
519*e4b17023SJohn Marino strings and needs to backtrack. */
520*e4b17023SJohn Marino size_t alloc;
521*e4b17023SJohn Marino gcov_unsigned_t *buffer;
522*e4b17023SJohn Marino #endif
523*e4b17023SJohn Marino } gcov_var ATTRIBUTE_HIDDEN;
524*e4b17023SJohn Marino
525*e4b17023SJohn Marino /* Functions for reading and writing gcov files. In libgcov you can
526*e4b17023SJohn Marino open the file for reading then writing. Elsewhere you can open the
527*e4b17023SJohn Marino file either for reading or for writing. When reading a file you may
528*e4b17023SJohn Marino use the gcov_read_* functions, gcov_sync, gcov_position, &
529*e4b17023SJohn Marino gcov_error. When writing a file you may use the gcov_write
530*e4b17023SJohn Marino functions, gcov_seek & gcov_error. When a file is to be rewritten
531*e4b17023SJohn Marino you use the functions for reading, then gcov_rewrite then the
532*e4b17023SJohn Marino functions for writing. Your file may become corrupted if you break
533*e4b17023SJohn Marino these invariants. */
534*e4b17023SJohn Marino #if IN_LIBGCOV
535*e4b17023SJohn Marino GCOV_LINKAGE int gcov_open (const char */*name*/) ATTRIBUTE_HIDDEN;
536*e4b17023SJohn Marino #else
537*e4b17023SJohn Marino GCOV_LINKAGE int gcov_open (const char */*name*/, int /*direction*/);
538*e4b17023SJohn Marino GCOV_LINKAGE int gcov_magic (gcov_unsigned_t, gcov_unsigned_t);
539*e4b17023SJohn Marino #endif
540*e4b17023SJohn Marino GCOV_LINKAGE int gcov_close (void) ATTRIBUTE_HIDDEN;
541*e4b17023SJohn Marino
542*e4b17023SJohn Marino /* Available everywhere. */
543*e4b17023SJohn Marino static gcov_position_t gcov_position (void);
544*e4b17023SJohn Marino static int gcov_is_error (void);
545*e4b17023SJohn Marino
546*e4b17023SJohn Marino GCOV_LINKAGE gcov_unsigned_t gcov_read_unsigned (void) ATTRIBUTE_HIDDEN;
547*e4b17023SJohn Marino GCOV_LINKAGE gcov_type gcov_read_counter (void) ATTRIBUTE_HIDDEN;
548*e4b17023SJohn Marino GCOV_LINKAGE void gcov_read_summary (struct gcov_summary *) ATTRIBUTE_HIDDEN;
549*e4b17023SJohn Marino
550*e4b17023SJohn Marino #if IN_LIBGCOV
551*e4b17023SJohn Marino /* Available only in libgcov */
552*e4b17023SJohn Marino GCOV_LINKAGE void gcov_write_counter (gcov_type) ATTRIBUTE_HIDDEN;
553*e4b17023SJohn Marino GCOV_LINKAGE void gcov_write_tag_length (gcov_unsigned_t, gcov_unsigned_t)
554*e4b17023SJohn Marino ATTRIBUTE_HIDDEN;
555*e4b17023SJohn Marino GCOV_LINKAGE void gcov_write_summary (gcov_unsigned_t /*tag*/,
556*e4b17023SJohn Marino const struct gcov_summary *)
557*e4b17023SJohn Marino ATTRIBUTE_HIDDEN;
558*e4b17023SJohn Marino static void gcov_rewrite (void);
559*e4b17023SJohn Marino GCOV_LINKAGE void gcov_seek (gcov_position_t /*position*/) ATTRIBUTE_HIDDEN;
560*e4b17023SJohn Marino #else
561*e4b17023SJohn Marino /* Available outside libgcov */
562*e4b17023SJohn Marino GCOV_LINKAGE const char *gcov_read_string (void);
563*e4b17023SJohn Marino GCOV_LINKAGE void gcov_sync (gcov_position_t /*base*/,
564*e4b17023SJohn Marino gcov_unsigned_t /*length */);
565*e4b17023SJohn Marino #endif
566*e4b17023SJohn Marino
567*e4b17023SJohn Marino #if !IN_GCOV
568*e4b17023SJohn Marino /* Available outside gcov */
569*e4b17023SJohn Marino GCOV_LINKAGE void gcov_write_unsigned (gcov_unsigned_t) ATTRIBUTE_HIDDEN;
570*e4b17023SJohn Marino #endif
571*e4b17023SJohn Marino
572*e4b17023SJohn Marino #if !IN_GCOV && !IN_LIBGCOV
573*e4b17023SJohn Marino /* Available only in compiler */
574*e4b17023SJohn Marino GCOV_LINKAGE void gcov_write_string (const char *);
575*e4b17023SJohn Marino GCOV_LINKAGE gcov_position_t gcov_write_tag (gcov_unsigned_t);
576*e4b17023SJohn Marino GCOV_LINKAGE void gcov_write_length (gcov_position_t /*position*/);
577*e4b17023SJohn Marino #endif
578*e4b17023SJohn Marino
579*e4b17023SJohn Marino #if IN_GCOV > 0
580*e4b17023SJohn Marino /* Available in gcov */
581*e4b17023SJohn Marino GCOV_LINKAGE time_t gcov_time (void);
582*e4b17023SJohn Marino #endif
583*e4b17023SJohn Marino
584*e4b17023SJohn Marino /* Save the current position in the gcov file. */
585*e4b17023SJohn Marino
586*e4b17023SJohn Marino static inline gcov_position_t
gcov_position(void)587*e4b17023SJohn Marino gcov_position (void)
588*e4b17023SJohn Marino {
589*e4b17023SJohn Marino gcc_assert (gcov_var.mode > 0);
590*e4b17023SJohn Marino return gcov_var.start + gcov_var.offset;
591*e4b17023SJohn Marino }
592*e4b17023SJohn Marino
593*e4b17023SJohn Marino /* Return nonzero if the error flag is set. */
594*e4b17023SJohn Marino
595*e4b17023SJohn Marino static inline int
gcov_is_error(void)596*e4b17023SJohn Marino gcov_is_error (void)
597*e4b17023SJohn Marino {
598*e4b17023SJohn Marino return gcov_var.file ? gcov_var.error : 1;
599*e4b17023SJohn Marino }
600*e4b17023SJohn Marino
601*e4b17023SJohn Marino #if IN_LIBGCOV
602*e4b17023SJohn Marino /* Move to beginning of file and initialize for writing. */
603*e4b17023SJohn Marino
604*e4b17023SJohn Marino static inline void
gcov_rewrite(void)605*e4b17023SJohn Marino gcov_rewrite (void)
606*e4b17023SJohn Marino {
607*e4b17023SJohn Marino gcc_assert (gcov_var.mode > 0);
608*e4b17023SJohn Marino gcov_var.mode = -1;
609*e4b17023SJohn Marino gcov_var.start = 0;
610*e4b17023SJohn Marino gcov_var.offset = 0;
611*e4b17023SJohn Marino fseek (gcov_var.file, 0L, SEEK_SET);
612*e4b17023SJohn Marino }
613*e4b17023SJohn Marino #endif
614*e4b17023SJohn Marino
615*e4b17023SJohn Marino #endif /* IN_LIBGCOV >= 0 */
616*e4b17023SJohn Marino
617*e4b17023SJohn Marino #endif /* GCC_GCOV_IO_H */
618