#include "gcov-iov.h"
Go to the source code of this file.
Data Structures | |
| struct | gcov_bucket_type |
| struct | gcov_ctr_summary |
| struct | gcov_summary |
| struct | gcov_var |
| struct | gcov_working_set_info |
Macros | |
| #define | GCOV_TYPE_SIZE (LONG_LONG_TYPE_SIZE > 32 ? 64 : 32) |
| #define | GCOV_LOCKED 0 |
| #define | ATTRIBUTE_HIDDEN |
| #define | GCOV_LINKAGE extern |
| #define | GCOV_DATA_SUFFIX ".gcda" |
| #define | GCOV_NOTE_SUFFIX ".gcno" |
| #define | GCOV_DATA_MAGIC ((gcov_unsigned_t)0x67636461) /* "gcda" */ |
| #define | GCOV_NOTE_MAGIC ((gcov_unsigned_t)0x67636e6f) /* "gcno" */ |
| #define | GCOV_UNSIGNED2STRING(ARRAY, VALUE) |
| #define | GCOV_TAG_FUNCTION ((gcov_unsigned_t)0x01000000) |
| #define | GCOV_TAG_FUNCTION_LENGTH (3) |
| #define | GCOV_TAG_BLOCKS ((gcov_unsigned_t)0x01410000) |
| #define | GCOV_TAG_BLOCKS_LENGTH(NUM) (NUM) |
| #define | GCOV_TAG_BLOCKS_NUM(LENGTH) (LENGTH) |
| #define | GCOV_TAG_ARCS ((gcov_unsigned_t)0x01430000) |
| #define | GCOV_TAG_ARCS_LENGTH(NUM) (1 + (NUM) * 2) |
| #define | GCOV_TAG_ARCS_NUM(LENGTH) (((LENGTH) - 1) / 2) |
| #define | GCOV_TAG_LINES ((gcov_unsigned_t)0x01450000) |
| #define | GCOV_TAG_COUNTER_BASE ((gcov_unsigned_t)0x01a10000) |
| #define | GCOV_TAG_COUNTER_LENGTH(NUM) ((NUM) * 2) |
| #define | GCOV_TAG_COUNTER_NUM(LENGTH) ((LENGTH) / 2) |
| #define | GCOV_TAG_OBJECT_SUMMARY ((gcov_unsigned_t)0xa1000000) /* Obsolete */ |
| #define | GCOV_TAG_PROGRAM_SUMMARY ((gcov_unsigned_t)0xa3000000) |
| #define | GCOV_TAG_SUMMARY_LENGTH(NUM) (1 + GCOV_COUNTERS_SUMMABLE * (10 + 3 * 2) + (NUM) * 5) |
| #define | GCOV_COUNTER_ARCS 0 /* Arc transitions. */ |
| #define | GCOV_COUNTERS_SUMMABLE |
| #define | GCOV_FIRST_VALUE_COUNTER |
| #define | GCOV_COUNTER_V_INTERVAL 1 /* Histogram of value inside an interval. */ |
| #define | GCOV_COUNTER_V_POW2 |
| #define | GCOV_COUNTER_V_SINGLE 3 /* The most common value of expression. */ |
| #define | GCOV_COUNTER_V_DELTA |
| #define | GCOV_COUNTER_V_INDIR 5 /* The most common indirect address */ |
| #define | GCOV_COUNTER_AVERAGE |
| #define | GCOV_COUNTER_IOR |
| #define | GCOV_LAST_VALUE_COUNTER |
| #define | GCOV_COUNTERS 8 |
| #define | GCOV_N_VALUE_COUNTERS (GCOV_LAST_VALUE_COUNTER - GCOV_FIRST_VALUE_COUNTER + 1) |
| #define | GCOV_COUNTER_NAMES |
| #define | GCOV_MERGE_FUNCTIONS |
| #define | GCOV_TAG_FOR_COUNTER(COUNT) (GCOV_TAG_COUNTER_BASE + ((gcov_unsigned_t)(COUNT) << 17)) |
| #define | GCOV_COUNTER_FOR_TAG(TAG) ((unsigned)(((TAG) - GCOV_TAG_COUNTER_BASE) >> 17)) |
| #define | GCOV_TAG_IS_COUNTER(TAG) (!((TAG) & 0xFFFF) && GCOV_COUNTER_FOR_TAG (TAG) < GCOV_COUNTERS) |
| #define | GCOV_TAG_MASK(TAG) (((TAG) - 1) ^ (TAG)) |
| #define | GCOV_TAG_IS_SUBTAG(TAG, SUB) |
| #define | GCOV_TAG_IS_SUBLEVEL(TAG, SUB) (GCOV_TAG_MASK (TAG) > GCOV_TAG_MASK (SUB)) |
| #define | GCOV_BLOCK_UNEXPECTED (1 << 1) |
| #define | GCOV_ARC_ON_TREE (1 << 0) |
| #define | GCOV_ARC_FAKE (1 << 1) |
| #define | GCOV_ARC_FALLTHROUGH (1 << 2) |
| #define | GCOV_HISTOGRAM_SIZE 252 |
| #define | GCOV_HISTOGRAM_BITVECTOR_SIZE (GCOV_HISTOGRAM_SIZE + 31) / 32 |
| #define | GCOV_BLOCK_SIZE (1 << 10) |
| #define | NUM_GCOV_WORKING_SETS 128 |
Typedefs | |
| typedef unsigned | gcov_unsigned_t |
| typedef unsigned | gcov_position_t |
| typedef struct gcov_working_set_info | gcov_working_set_t |
Functions | |
| GCOV_LINKAGE int | gcov_open (const char *, int) |
| GCOV_LINKAGE int | gcov_magic (gcov_unsigned_t, gcov_unsigned_t) |
| GCOV_LINKAGE int | gcov_close (void) ATTRIBUTE_HIDDEN |
| static gcov_position_t | gcov_position (void) |
| static int | gcov_is_error (void) |
| GCOV_LINKAGE gcov_unsigned_t | gcov_read_unsigned (void) ATTRIBUTE_HIDDEN |
| GCOV_LINKAGE gcov_type | gcov_read_counter (void) ATTRIBUTE_HIDDEN |
| GCOV_LINKAGE void | gcov_read_summary (struct gcov_summary *) ATTRIBUTE_HIDDEN |
| GCOV_LINKAGE const char * | gcov_read_string (void) |
| GCOV_LINKAGE void | gcov_sync (gcov_position_t, gcov_unsigned_t) |
| GCOV_LINKAGE void | gcov_write_unsigned (gcov_unsigned_t) ATTRIBUTE_HIDDEN |
| GCOV_LINKAGE unsigned | gcov_histo_index (gcov_type value) |
| GCOV_LINKAGE void | gcov_write_string (const char *) |
| GCOV_LINKAGE gcov_position_t | gcov_write_tag (gcov_unsigned_t) |
| GCOV_LINKAGE void | gcov_write_length (gcov_position_t) |
| GCOV_LINKAGE void | compute_working_sets (const struct gcov_ctr_summary *summary, gcov_working_set_t *gcov_working_sets) |
Variables | |
| GCOV_LINKAGE struct gcov_var | ATTRIBUTE_HIDDEN |
Macro Definition Documentation
| #define ATTRIBUTE_HIDDEN |
In gcov we want function linkage to be static. In the compiler we want it extern, so that they can be accessed from elsewhere. In libgcov we need these functions to be extern, so prefix them with __gcov. In libgcov they must also be hidden so that the instance in the executable is not also used in a DSO.
| #define GCOV_ARC_FAKE (1 << 1) |
Referenced by read_graph_file().
| #define GCOV_ARC_FALLTHROUGH (1 << 2) |
Referenced by read_graph_file().
| #define GCOV_ARC_ON_TREE (1 << 0) |
Arc flags.
Referenced by read_graph_file().
| #define GCOV_BLOCK_SIZE (1 << 10) |
Structures embedded in coveraged program. The structures generated by write_profile must match these. Optimum number of gcov_unsigned_t's read from or written to disk.
| #define GCOV_BLOCK_UNEXPECTED (1 << 1) |
Basic block flags.
| #define GCOV_COUNTER_ARCS 0 /* Arc transitions. */ |
Counters that are collected.
| #define GCOV_COUNTER_AVERAGE |
| #define GCOV_COUNTER_FOR_TAG | ( | TAG | ) | ((unsigned)(((TAG) - GCOV_TAG_COUNTER_BASE) >> 17)) |
Convert a tag to a counter.
| #define GCOV_COUNTER_IOR |
| #define GCOV_COUNTER_NAMES |
A list of human readable names of the counters
| #define GCOV_COUNTER_V_DELTA |
| #define GCOV_COUNTER_V_INDIR 5 /* The most common indirect address */ |
| #define GCOV_COUNTER_V_INTERVAL 1 /* Histogram of value inside an interval. */ |
| #define GCOV_COUNTER_V_POW2 |
| #define GCOV_COUNTER_V_SINGLE 3 /* The most common value of expression. */ |
| #define GCOV_COUNTERS 8 |
| #define GCOV_COUNTERS_SUMMABLE |
| #define GCOV_DATA_MAGIC ((gcov_unsigned_t)0x67636461) /* "gcda" */ |
File magic. Must not be palindromes.
| #define GCOV_DATA_SUFFIX ".gcda" |
File suffixes.
| #define GCOV_FIRST_VALUE_COUNTER |
| #define GCOV_HISTOGRAM_BITVECTOR_SIZE (GCOV_HISTOGRAM_SIZE + 31) / 32 |
How many unsigned ints are required to hold a bit vector of non-zero histogram entries when the histogram is written to the gcov file. This is essentially a ceiling divide by 32 bits.
| #define GCOV_HISTOGRAM_SIZE 252 |
For a log2 scale histogram with each range split into 4 linear sub-ranges, there will be at most 64 (max gcov_type bit size) - 1 log2 ranges since the lowest 2 log2 values share the lowest 4 linear sub-range (values 0 - 3). This is 252 total entries (63*4).
| #define GCOV_LAST_VALUE_COUNTER |
| #define GCOV_LINKAGE extern |
| #define GCOV_LOCKED 0 |
| #define GCOV_MERGE_FUNCTIONS |
Names of merge functions for counters.
| #define GCOV_N_VALUE_COUNTERS (GCOV_LAST_VALUE_COUNTER - GCOV_FIRST_VALUE_COUNTER + 1) |
Number of counters used for value profiling.
| #define GCOV_NOTE_MAGIC ((gcov_unsigned_t)0x67636e6f) /* "gcno" */ |
Referenced by coverage_obj_fn().
| #define GCOV_NOTE_SUFFIX ".gcno" |
Referenced by coverage_obj_fn().
| #define GCOV_TAG_ARCS ((gcov_unsigned_t)0x01430000) |
| #define GCOV_TAG_ARCS_LENGTH | ( | NUM | ) | (1 + (NUM) * 2) |
| #define GCOV_TAG_ARCS_NUM | ( | LENGTH | ) | (((LENGTH) - 1) / 2) |
| #define GCOV_TAG_BLOCKS ((gcov_unsigned_t)0x01410000) |
| #define GCOV_TAG_BLOCKS_LENGTH | ( | NUM | ) | (NUM) |
| #define GCOV_TAG_BLOCKS_NUM | ( | LENGTH | ) | (LENGTH) |
| #define GCOV_TAG_COUNTER_BASE ((gcov_unsigned_t)0x01a10000) |
| #define GCOV_TAG_COUNTER_LENGTH | ( | NUM | ) | ((NUM) * 2) |
| #define GCOV_TAG_COUNTER_NUM | ( | LENGTH | ) | ((LENGTH) / 2) |
| #define GCOV_TAG_FOR_COUNTER | ( | COUNT | ) | (GCOV_TAG_COUNTER_BASE + ((gcov_unsigned_t)(COUNT) << 17)) |
Convert a counter index to a tag.
| #define GCOV_TAG_FUNCTION ((gcov_unsigned_t)0x01000000) |
The record tags. Values [1..3f] are for tags which may be in either file. Values [41..9f] for those in the note file and [a1..ff] for the data file. The tag value zero is used as an explicit end of file marker – it is not required to be present.
| #define GCOV_TAG_FUNCTION_LENGTH (3) |
| #define GCOV_TAG_IS_COUNTER | ( | TAG | ) | (!((TAG) & 0xFFFF) && GCOV_COUNTER_FOR_TAG (TAG) < GCOV_COUNTERS) |
Check whether a tag is a counter tag.
| #define GCOV_TAG_IS_SUBLEVEL | ( | TAG, | |
| SUB | |||
| ) | (GCOV_TAG_MASK (TAG) > GCOV_TAG_MASK (SUB)) |
Return nonzero if SUB is at a sublevel to TAG.
| #define GCOV_TAG_IS_SUBTAG | ( | TAG, | |
| SUB | |||
| ) |
Return nonzero if SUB is an immediate subtag of TAG.
| #define GCOV_TAG_LINES ((gcov_unsigned_t)0x01450000) |
| #define GCOV_TAG_MASK | ( | TAG | ) | (((TAG) - 1) ^ (TAG)) |
The tag level mask has 1's in the position of the inner levels, & the lsb of the current level, and zero on the current and outer levels.
| #define GCOV_TAG_OBJECT_SUMMARY ((gcov_unsigned_t)0xa1000000) /* Obsolete */ |
| #define GCOV_TAG_PROGRAM_SUMMARY ((gcov_unsigned_t)0xa3000000) |
| #define GCOV_TAG_SUMMARY_LENGTH | ( | NUM | ) | (1 + GCOV_COUNTERS_SUMMABLE * (10 + 3 * 2) + (NUM) * 5) |
| #define GCOV_TYPE_SIZE (LONG_LONG_TYPE_SIZE > 32 ? 64 : 32) |
gcov_type is typedef'd elsewhere for the compiler
IN_GCOV
| #define GCOV_UNSIGNED2STRING | ( | ARRAY, | |
| VALUE | |||
| ) |
gcov-iov.h is automatically generated by the makefile from version.c, it looks like #define GCOV_VERSION ((gcov_unsigned_t)0x89abcdef) Convert a magic or version number to a 4 character string.
| #define NUM_GCOV_WORKING_SETS 128 |
Available in gcov-dump and the compiler. Number of data points in the working set summary array. Using 128 provides information for at least every 1% increment of the total profile size. The last entry is hardwired to 99.9% of the total.
Typedef Documentation
| typedef unsigned gcov_position_t |
| typedef unsigned gcov_unsigned_t |
File format for coverage information Copyright (C) 1996-2013 Free Software Foundation, Inc. Contributed by Bob Manson manson@cygnus.com. Completely remangled by Nathan Sidwell nathan@codesourcery.com.
This file is part of GCC.
GCC is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.
GCC is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
Under Section 7 of GPL version 3, you are granted additional permissions described in the GCC Runtime Library Exception, version 3.1, as published by the Free Software Foundation.
You should have received a copy of the GNU General Public License and a copy of the GCC Runtime Library Exception along with this program; see the files COPYING3 and COPYING.RUNTIME respectively. If not, see http://www.gnu.org/licenses/. Coverage information is held in two files. A notes file, which is generated by the compiler, and a data file, which is generated by the program under test. Both files use a similar structure. We do not attempt to make these files backwards compatible with previous versions, as you only need coverage information when developing a program. We do hold version information, so that mismatches can be detected, and we use a format that allows tools to skip information they do not understand or are not interested in.
Numbers are recorded in the 32 bit unsigned binary form of the endianness of the machine generating the file. 64 bit numbers are stored as two 32 bit numbers, the low part first. Strings are padded with 1 to 4 NUL bytes, to bring the length up to a multiple of 4. The number of 4 bytes is stored, followed by the padded string. Zero length and NULL strings are simply stored as a length of zero (they have no trailing NUL or padding).
int32: byte3 byte2 byte1 byte0 | byte0 byte1 byte2 byte3 int64: int32:low int32:high string: int32:0 | int32:length char* char:0 padding padding: | char:0 | char:0 char:0 | char:0 char:0 char:0 item: int32 | int64 | string
The basic format of the files is
file : int32:magic int32:version int32:stamp record*
The magic ident is different for the notes and the data files. The magic ident is used to determine the endianness of the file, when reading. The version is the same for both files and is derived from gcc's version number. The stamp value is used to synchronize note and data files and to synchronize merging within a data file. It need not be an absolute time stamp, merely a ticker that increments fast enough and cycles slow enough to distinguish different compile/run/compile cycles.
Although the ident and version are formally 32 bit numbers, they are derived from 4 character ASCII strings. The version number consists of the single character major version number, a two character minor version number (leading zero for versions less than 10), and a single character indicating the status of the release. That will be 'e' experimental, 'p' prerelease and 'r' for release. Because, by good fortune, these are in alphabetical order, string collating can be used to compare version strings. Be aware that the 'e' designation will (naturally) be unstable and might be incompatible with itself. For gcc 3.4 experimental, it would be '304e' (0x33303465). When the major version reaches 10, the letters A-Z will be used. Assuming minor increments releases every 6 months, we have to make a major increment every 50 years. Assuming major increments releases every 5 years, we're ok for the next 155 years – good enough for me.
A record has a tag, length and variable amount of data.
record: header data header: int32:tag int32:length data: item*
Records are not nested, but there is a record hierarchy. Tag numbers reflect this hierarchy. Tags are unique across note and data files. Some record types have a varying amount of data. The LENGTH is the number of 4bytes that follow and is usually used to determine how much data. The tag value is split into 4 8-bit fields, one for each of four possible levels. The most significant is allocated first. Unused levels are zero. Active levels are odd-valued, so that the LSB of the level is one. A sub-level incorporates the values of its superlevels. This formatting allows you to determine the tag hierarchy, without understanding the tags themselves, and is similar to the standard section numbering used in technical documents. Level values [1..3f] are used for common tags, values [41..9f] for the notes file and [a1..ff] for the data file.
The notes file contains the following records note: unit function-graph* unit: header int32:checksum string:source function-graph: announce_function basic_blocks {arcs | lines}* announce_function: header int32:ident int32:lineno_checksum int32:cfg_checksum string:name string:source int32:lineno basic_block: header int32:flags* arcs: header int32:block_no arc* arc: int32:dest_block int32:flags lines: header int32:block_no line* int32:0 string:NULL line: int32:line_no | int32:0 string:filename
The BASIC_BLOCK record holds per-bb flags. The number of blocks can be inferred from its data length. There is one ARCS record per basic block. The number of arcs from a bb is implicit from the data length. It enumerates the destination bb and per-arc flags. There is one LINES record per basic block, it enumerates the source lines which belong to that basic block. Source file names are introduced by a line number of 0, following lines are from the new source file. The initial source file for the function is NULL, but the current source file should be remembered from one LINES record to the next. The end of a block is indicated by an empty filename
- this does not reset the current source file. Note there is no ordering of the ARCS and LINES records: they may be in any order, interleaved in any manner. The current filename follows the order the LINES records are stored in the file, not the ordering of the blocks they are for.
The data file contains the following records. data: {unit summary:object summary:program* function-data*}* unit: header int32:checksum function-data: announce_function present counts announce_function: header int32:ident int32:lineno_checksum int32:cfg_checksum present: header int32:present counts: header int64:count* summary: int32:checksum {count-summary}GCOV_COUNTERS_SUMMABLE count-summary: int32:num int32:runs int64:sum int64:max int64:sum_max histogram histogram: {int32:bitvector}8 histogram-buckets* histogram-buckets: int32:num int64:min int64:sum
The ANNOUNCE_FUNCTION record is the same as that in the note file, but without the source location. The COUNTS gives the counter values for instrumented features. The about the whole program. The checksum is used for whole program summaries, and disambiguates different programs which include the same instrumented object file. There may be several program summaries, each with a unique checksum. The object summary's checksum is zero. Note that the data file might contain information from several runs concatenated, or the data might be merged.
This file is included by both the compiler, gcov tools and the runtime support library libgcov. IN_LIBGCOV and IN_GCOV are used to distinguish which case is which. If IN_LIBGCOV is nonzero, libgcov is being built. If IN_GCOV is nonzero, the gcov tools are being built. Otherwise the compiler is being built. IN_GCOV may be positive or negative. If positive, we are compiling a tool that requires additional functions (see the code for knowledge of what those functions are). About the host
| typedef struct gcov_working_set_info gcov_working_set_t |
Working set size statistics for a given percentage of the entire profile (sum_all from the counter summary).
Function Documentation
| GCOV_LINKAGE void compute_working_sets | ( | const struct gcov_ctr_summary * | summary, |
| gcov_working_set_t * | gcov_working_sets | ||
| ) |
| GCOV_LINKAGE int gcov_close | ( | void | ) |
| GCOV_LINKAGE unsigned gcov_histo_index | ( | gcov_type | value | ) |
Available only in compiler
|
inlinestatic |
Return nonzero if the error flag is set.
| GCOV_LINKAGE int gcov_magic | ( | gcov_unsigned_t | , |
| gcov_unsigned_t | |||
| ) |
| GCOV_LINKAGE int gcov_open | ( | const char * | , |
| int | |||
| ) |
Functions for reading and writing gcov files. In libgcov you can open the file for reading then writing. Elsewhere you can open the file either for reading or for writing. When reading a file you may use the gcov_read_* functions, gcov_sync, gcov_position, & gcov_error. When writing a file you may use the gcov_write functions, gcov_seek & gcov_error. When a file is to be rewritten you use the functions for reading, then gcov_rewrite then the functions for writing. Your file may become corrupted if you break these invariants.
Referenced by coverage_obj_fn().
|
inlinestatic |
| GCOV_LINKAGE gcov_type gcov_read_counter | ( | void | ) |
| GCOV_LINKAGE const char* gcov_read_string | ( | void | ) |
Available outside libgcov
Referenced by tag_lines().
| GCOV_LINKAGE void gcov_read_summary | ( | struct gcov_summary * | ) |
| GCOV_LINKAGE gcov_unsigned_t gcov_read_unsigned | ( | void | ) |
Referenced by read_graph_file(), and tag_lines().
| GCOV_LINKAGE void gcov_sync | ( | gcov_position_t | , |
| gcov_unsigned_t | |||
| ) |
| GCOV_LINKAGE void gcov_write_length | ( | gcov_position_t | ) |
| GCOV_LINKAGE void gcov_write_string | ( | const char * | ) |
| GCOV_LINKAGE gcov_position_t gcov_write_tag | ( | gcov_unsigned_t | ) |
| GCOV_LINKAGE void gcov_write_unsigned | ( | gcov_unsigned_t | ) |
Available outside gcov
Referenced by coverage_obj_fn().
Variable Documentation
| GCOV_LINKAGE struct gcov_var ATTRIBUTE_HIDDEN |
