/* File format for coverage information
- Copyright (C) 1996, 1997, 1998, 2000, 2002 Free Software Foundation, Inc.
+ Copyright (C) 1996, 1997, 1998, 2000, 2002,
+ 2003, 2004 Free Software Foundation, Inc.
Contributed by Bob Manson <manson@cygnus.com>.
Completely remangled by Nathan Sidwell <nathan@codesourcery.com>.
Software Foundation, 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA. */
-/* Coverage information is held in two files. A basic block graph
- file, which is generated by the compiler, and a counter 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 big endian unsigned binary form. Either in
- 32 or 64 bits. Strings are stored with a length count and NUL
- terminator, and 0 to 3 bytes of zero padding up to the next 4 byte
- boundary. 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
- int64: byte7 byte6 byte5 byte4 byte3 byte2 byte1 byte0
+/* As a special exception, if you link this library with other files,
+ some of which are compiled with GCC, to produce an executable,
+ this library does not by itself cause the resulting executable
+ to be covered by the GNU General Public License.
+ This exception does not however invalidate any other reasons why
+ the executable file might be covered by the GNU General Public License. */
+
+/* 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 record*
-
- The magic ident is different for the bbg and the counter files.
- The version is the same for both files and is derived from gcc's
- version number. 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, and because numbers are stored big endian, numeric
- comparison can be used when it is read as a 32 bit value. Be aware
- that the 'e' designation will (naturally) be unstable and might be
+ 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.
+ '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.
data: item*
Records are not nested, but there is a record hierarchy. Tag
- numbers reflect this hierarchy. Tags are unique across bbg and da
- files. Some record types have a varying amount of data. The LENGTH
- 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 heirarchy, 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 graph
- file and [a1..ff] for the counter file.
+ 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 basic block graph file contains the following records
- bbg: function-graph*
+ note: unit function-graph*
+ unit: header int32:checksum string:source
function-graph: announce_function basic_blocks {arcs | lines}*
- announce_function: header string:name int32:checksum
- string:source int32:lineno
+ announce_function: header int32:ident int32:checksum
+ string:name string:source int32:lineno
basic_block: header int32:flags*
arcs: header int32:block_no arc*
arc: int32:dest_block int32:flags
blocks they are for.
The data file contains the following records.
- da: {function-data* summary:object summary:program*}*
+ data: {unit function-data* summary:object summary:program*}*
+ unit: header int32:checksum
function-data: announce_function arc_counts
- announce_function: header string:name int32:checksum
+ announce_function: header int32:ident int32:checksum
arc_counts: header int64:count*
- summary: in32:checksum int32:runs int32:arcs int64:sum int64:max \
- int64:max_sum int64:sum_max
-
- The ANNOUNCE_FUNCTION record is the same as that in the BBG file,
- but without the source location.
- The ARC_COUNTS gives the counter values for those arcs that are
- instrumented. The SUMMARY records give information about the whole
- object file and 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 checkum is zero. Note that the da file might contain
- information from several runs concatenated, or the data might be
- merged.
+ summary: int32:checksum {count-summary}GCOV_COUNTERS
+ count-summary: int32:num int32:runs int64:sum
+ int64:max int64:sum_max
+
+ The ANNOUNCE_FUNCTION record is the same as that in the note file,
+ but without the source location. The ARC_COUNTS gives the counter
+ values for those arcs that are instrumented. The SUMMARY records
+ give information about the whole object file and 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 non-zero,
- libgcov is being built. If IN_GCOV is non-zero, the gcov tools are
+ 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
#define GCC_GCOV_IO_H
#if IN_LIBGCOV
-#if LONG_TYPE_SIZE == GCOV_TYPE_SIZE
-typedef long gcov_type;
+/* About the target */
+
+#if BITS_PER_UNIT == 8
+typedef unsigned gcov_unsigned_t __attribute__ ((mode (SI)));
+typedef unsigned gcov_position_t __attribute__ ((mode (SI)));
+#if LONG_LONG_TYPE_SIZE > 32
+typedef signed gcov_type __attribute__ ((mode (DI)));
#else
-typedef long long gcov_type;
+typedef signed gcov_type __attribute__ ((mode (SI)));
#endif
-#endif /* IN_LIBGCOV */
+#else
+#if BITS_PER_UNIT == 16
+typedef unsigned gcov_unsigned_t __attribute__ ((mode (HI)));
+typedef unsigned gcov_position_t __attribute__ ((mode (HI)));
+#if LONG_LONG_TYPE_SIZE > 32
+typedef signed gcov_type __attribute__ ((mode (SI)));
+#else
+typedef signed gcov_type __attribute__ ((mode (HI)));
+#endif
+#else
+typedef unsigned gcov_unsigned_t __attribute__ ((mode (QI)));
+typedef unsigned gcov_position_t __attribute__ ((mode (QI)));
+#if LONG_LONG_TYPE_SIZE > 32
+typedef signed gcov_type __attribute__ ((mode (HI)));
+#else
+typedef signed gcov_type __attribute__ ((mode (QI)));
+#endif
+#endif
+#endif
+
+
+#if defined (TARGET_HAS_F_SETLKW)
+#define GCOV_LOCKED 1
+#else
+#define GCOV_LOCKED 0
+#endif
+
+#else /* !IN_LIBGCOV */
+/* About the host */
+
+typedef unsigned gcov_unsigned_t;
+typedef unsigned gcov_position_t;
+/* gcov_type is typedef'd elsewhere for the compiler */
#if IN_GCOV
+#define GCOV_LINKAGE static
typedef HOST_WIDEST_INT gcov_type;
#if IN_GCOV > 0
#include <sys/types.h>
#endif
+#else /*!IN_GCOV */
+#if LONG_LONG_TYPE_SIZE > 32
+#define GCOV_TYPE_NODE intDI_type_node
+#else
+#define GCOV_TYPE_NODE intSI_type_node
+#endif
+#endif
+
+#if defined (HOST_HAS_F_SETLKW)
+#define GCOV_LOCKED 1
+#else
+#define GCOV_LOCKED 0
+#endif
+
+#endif /* !IN_LIBGCOV */
+
+/* In gcov we want function linkage to be static. In libgcov we need
+ these functions to be extern, so prefix them with __gcov. In the
+ compiler we want it extern, so that they can be accessed from
+ elsewhere. */
+#if IN_LIBGCOV
+#define gcov_var __gcov_var
+#define gcov_open __gcov_open
+#define gcov_close __gcov_close
+#define gcov_write_tag_length __gcov_write_tag_length
+#define gcov_position __gcov_position
+#define gcov_seek __gcov_seek
+#define gcov_rewrite __gcov_rewrite
+#define gcov_is_error __gcov_is_error
+#define gcov_write_unsigned __gcov_write_unsigned
+#define gcov_write_counter __gcov_write_counter
+#define gcov_write_summary __gcov_write_summary
+#define gcov_read_unsigned __gcov_read_unsigned
+#define gcov_read_counter __gcov_read_counter
+#define gcov_read_summary __gcov_read_summary
+
+/* Poison these, so they don't accidentally slip in. */
+#pragma GCC poison gcov_write_string gcov_write_tag gcov_write_length
+#pragma GCC poison gcov_read_string gcov_sync gcov_time gcov_magic
+
+#endif
+
+#ifndef GCOV_LINKAGE
+#define GCOV_LINKAGE extern
#endif
/* File suffixes. */
-#define GCOV_DATA_SUFFIX ".da"
-#define GCOV_GRAPH_SUFFIX ".bbg"
+#define GCOV_DATA_SUFFIX ".gcda"
+#define GCOV_NOTE_SUFFIX ".gcno"
-/* File magic. */
-#define GCOV_DATA_MAGIC 0x67636f76 /* "gcov" */
-#define GCOV_GRAPH_MAGIC 0x67626267 /* "gbbg" */
+/* File magic. Must not be palindromes. */
+#define GCOV_DATA_MAGIC ((gcov_unsigned_t)0x67636461) /* "gcda" */
+#define GCOV_NOTE_MAGIC ((gcov_unsigned_t)0x67636e6f) /* "gcno" */
/* gcov-iov.h is automatically generated by the makefile from
version.c, it looks like
- #define GCOV_VERSION ((unsigned)0x89abcdef)
+ #define GCOV_VERSION ((gcov_unsigned_t)0x89abcdef)
*/
#include "gcov-iov.h"
+/* Convert a magic or version number to a 4 character string. */
+#define GCOV_UNSIGNED2STRING(ARRAY,VALUE) \
+ ((ARRAY)[0] = (char)((VALUE) >> 24), \
+ (ARRAY)[1] = (char)((VALUE) >> 16), \
+ (ARRAY)[2] = (char)((VALUE) >> 8), \
+ (ARRAY)[3] = (char)((VALUE) >> 0))
+
/* The record tags. Values [1..3f] are for tags which may be in either
- file. Values [41..9f] for those in the bbg file and [a1..ff] for
- the data file. */
-
-#define GCOV_TAG_FUNCTION ((unsigned)0x01000000)
-#define GCOV_TAG_BLOCKS ((unsigned)0x01410000)
-#define GCOV_TAG_ARCS ((unsigned)0x01430000)
-#define GCOV_TAG_LINES ((unsigned)0x01450000)
-#define GCOV_TAG_ARC_COUNTS ((unsigned)0x01a10000)
-#define GCOV_TAG_OBJECT_SUMMARY ((unsigned)0xa1000000)
-#define GCOV_TAG_PROGRAM_SUMMARY ((unsigned)0xa3000000)
-#define GCOV_TAG_PLACEHOLDER_SUMMARY ((unsigned)0xa5000000)
-#define GCOV_TAG_INCORRECT_SUMMARY ((unsigned)0xa7000000)
+ 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 ((gcov_unsigned_t)0x01000000)
+#define GCOV_TAG_FUNCTION_LENGTH (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_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)
+#define GCOV_TAG_PROGRAM_SUMMARY ((gcov_unsigned_t)0xa3000000)
+#define GCOV_TAG_SUMMARY_LENGTH \
+ (1 + GCOV_COUNTERS_SUMMABLE * (2 + 3 * 2))
+
+/* Counters that are collected. */
+#define GCOV_COUNTER_ARCS 0 /* Arc transitions. */
+#define GCOV_COUNTERS_SUMMABLE 1 /* Counters which can be
+ summaried. */
+#define GCOV_FIRST_VALUE_COUNTER 1 /* The first of counters used for value
+ profiling. They must form a consecutive
+ interval and their order must match
+ the order of HIST_TYPEs in
+ value-prof.h. */
+#define GCOV_COUNTER_V_INTERVAL 1 /* Histogram of value inside an interval. */
+#define GCOV_COUNTER_V_POW2 2 /* Histogram of exact power2 logarithm
+ of a value. */
+#define GCOV_COUNTER_V_SINGLE 3 /* The most common value of expression. */
+#define GCOV_COUNTER_V_DELTA 4 /* The most common difference between
+ consecutive values of expression. */
+#define GCOV_LAST_VALUE_COUNTER 4 /* The last of counters used for value
+ profiling. */
+#define GCOV_COUNTERS 5
+
+/* Number of counters used for value profiling. */
+#define GCOV_N_VALUE_COUNTERS \
+ (GCOV_LAST_VALUE_COUNTER - GCOV_FIRST_VALUE_COUNTER + 1)
+
+ /* A list of human readable names of the counters */
+#define GCOV_COUNTER_NAMES {"arcs", "interval", "pow2", "single", "delta"}
+
+ /* Names of merge functions for counters. */
+#define GCOV_MERGE_FUNCTIONS {"__gcov_merge_add", \
+ "__gcov_merge_add", \
+ "__gcov_merge_add", \
+ "__gcov_merge_single", \
+ "__gcov_merge_delta"}
+
+/* Convert a counter index to a tag. */
+#define GCOV_TAG_FOR_COUNTER(COUNT) \
+ (GCOV_TAG_COUNTER_BASE + ((gcov_unsigned_t)(COUNT) << 17))
+/* Convert a tag to a counter. */
+#define GCOV_COUNTER_FOR_TAG(TAG) \
+ ((unsigned)(((TAG) - GCOV_TAG_COUNTER_BASE) >> 17))
+/* Check whether a tag is a counter tag. */
+#define GCOV_TAG_IS_COUNTER(TAG) \
+ (!((TAG) & 0xFFFF) && GCOV_COUNTER_FOR_TAG (TAG) < GCOV_COUNTERS)
/* 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
/* Structured records. */
+/* Cumulative counter data. */
+struct gcov_ctr_summary
+{
+ gcov_unsigned_t num; /* number of counters. */
+ gcov_unsigned_t runs; /* number of program runs */
+ gcov_type sum_all; /* sum of all counters accumulated. */
+ gcov_type run_max; /* maximum value on a single run. */
+ gcov_type sum_max; /* sum of individual run max values. */
+};
+
/* Object & program summary record. */
struct gcov_summary
{
- unsigned checksum; /* checksum of program */
- unsigned runs; /* number of program runs */
- unsigned arcs; /* number of instrumented arcs */
- gcov_type arc_sum; /* sum of all arc counters */
- gcov_type arc_max_one; /* max counter on any one run */
- gcov_type arc_max_sum; /* maximum arc_sum */
- gcov_type arc_sum_max; /* sum of max_one */
+ gcov_unsigned_t checksum; /* checksum of program */
+ struct gcov_ctr_summary ctrs[GCOV_COUNTERS_SUMMABLE];
};
/* Structures embedded in coveraged program. The structures generated
by write_profile must match these. */
-/* Information about section of counters for a function. */
-struct counter_section
-{
- unsigned tag; /* Tag of the section. */
- unsigned n_counters; /* Number of counters in the section. */
-};
-
#if IN_LIBGCOV
-/* Information about section of counters for an object file. */
-struct counter_section_data
+/* Information about a single function. This uses the trailing array
+ idiom. The number of counters is determined from the counter_mask
+ in gcov_info. We hold an array of function info, so have to
+ explicitly calculate the correct array stride. */
+struct gcov_fn_info
{
- unsigned tag; /* Tag of the section. */
- unsigned n_counters; /* Number of counters in the section. */
- gcov_type *counters; /* The data. */
+ gcov_unsigned_t ident; /* unique ident of function */
+ gcov_unsigned_t checksum; /* function checksum */
+ unsigned n_ctrs[0]; /* instrumented counters */
};
-/* Information about a single function. */
-struct function_info
+/* Type of function used to merge counters. */
+typedef void (*gcov_merge_fn) (gcov_type *, gcov_unsigned_t);
+
+/* Information about counters. */
+struct gcov_ctr_info
{
- const char *name; /* (mangled) name of function */
- unsigned checksum; /* function checksum */
- unsigned n_counter_sections; /* Number of types of counters */
- const struct counter_section *counter_sections;
- /* The section descriptions */
+ gcov_unsigned_t num; /* number of counters. */
+ gcov_type *values; /* their values. */
+ gcov_merge_fn merge; /* The function used to merge them. */
};
/* Information about a single object file. */
struct gcov_info
{
- unsigned long version; /* expected version number */
- struct gcov_info *next; /* link to next, used by libgcc */
+ gcov_unsigned_t version; /* expected version number */
+ struct gcov_info *next; /* link to next, used by libgcov */
+ gcov_unsigned_t stamp; /* uniquifying time stamp */
const char *filename; /* output file name */
- long wkspc; /* libgcc workspace */
-
- unsigned n_functions; /* number of functions */
- const struct function_info *functions; /* table of functions */
-
- unsigned n_counter_sections; /* Number of types of counters */
- const struct counter_section_data *counter_sections;
- /* The data to be put into the sections. */
+
+ unsigned n_functions; /* number of functions */
+ const struct gcov_fn_info *functions; /* table of functions */
+
+ unsigned ctr_mask; /* mask of counters instrumented. */
+ struct gcov_ctr_info counts[0]; /* count data. The number of bits
+ set in the ctr_mask field
+ determines how big this array
+ is. */
};
/* Register a new object file module. */
/* Called before fork, to avoid double counting. */
extern void __gcov_flush (void);
-/* Since this file is used in both host and target files, and we don't
- include ansidecl.h in target files, provide some necessary macros. */
-#ifndef ATTRIBUTE_UNUSED
-# define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
+/* The merge function that just sums the counters. */
+extern void __gcov_merge_add (gcov_type *, unsigned);
+
+/* The merge function to choose the most common value. */
+extern void __gcov_merge_single (gcov_type *, unsigned);
+
+/* The merge function to choose the most common difference between
+ consecutive values. */
+extern void __gcov_merge_delta (gcov_type *, unsigned);
+
+#ifndef inhibit_libc
+/* The wrappers around some library functions.. */
+extern pid_t __gcov_fork (void);
+extern int __gcov_execl (const char *, const char *, ...);
+extern int __gcov_execlp (const char *, const char *, ...);
+extern int __gcov_execle (const char *, const char *, ...);
+extern int __gcov_execv (const char *, char *const []);
+extern int __gcov_execvp (const char *, char *const []);
+extern int __gcov_execve (const char *, char *const [], char *const []);
#endif
#endif /* IN_LIBGCOV */
-/* Because small reads and writes, interspersed with seeks cause lots
- of disk activity, we buffer the entire count files. */
+#if IN_LIBGCOV >= 0
-static struct gcov_var
+/* Optimum number of gcov_unsigned_t's read from or written to disk. */
+#define GCOV_BLOCK_SIZE (1 << 10)
+
+GCOV_LINKAGE struct gcov_var
{
FILE *file;
- size_t position;
- size_t length;
+ gcov_position_t start; /* Position of first byte of block */
+ unsigned offset; /* Read/write position within the block. */
+ unsigned length; /* Read limit in the block. */
+ unsigned overread; /* Number of words overread. */
+ int error; /* < 0 overflow, > 0 disk error. */
+ int mode; /* < 0 writing, > 0 reading */
+#if IN_LIBGCOV
+ /* Holds one block plus 4 bytes, thus all coverage reads & writes
+ fit within this buffer and we always can transfer GCOV_BLOCK_SIZE
+ to and from the disk. libgcov never backtracks and only writes 4
+ or 8 byte objects. */
+ gcov_unsigned_t buffer[GCOV_BLOCK_SIZE + 1];
+#else
+ int endian; /* Swap endianness. */
+ /* Holds a variable length block, as the compiler can write
+ strings and needs to backtrack. */
size_t alloc;
- unsigned modified;
- int error;
- unsigned char *buffer;
+ gcov_unsigned_t *buffer;
+#endif
} gcov_var;
-/* Functions for reading and writing gcov files. */
-static int gcov_open (const char */*name*/, int /*truncate*/);
-static int gcov_close (void);
-#if !IN_GCOV
-static unsigned char *gcov_write_bytes (unsigned);
-static void gcov_write_unsigned (unsigned);
-#if IN_LIBGCOV
-static void gcov_write_counter (gcov_type);
-#endif
-static void gcov_write_string (const char *);
-static unsigned long gcov_write_tag (unsigned);
-static void gcov_write_length (unsigned long /*position*/);
+/* 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. */
#if IN_LIBGCOV
-static void gcov_write_summary (unsigned, const struct gcov_summary *);
-#endif
-#endif /* !IN_GCOV */
-static const unsigned char *gcov_read_bytes (unsigned);
-static unsigned gcov_read_unsigned (void);
-static gcov_type gcov_read_counter (void);
-static const char *gcov_read_string (void);
-static void gcov_read_summary (struct gcov_summary *);
-
-static unsigned long gcov_position (void);
-static void gcov_seek (unsigned long /*base*/, unsigned /*length */);
-static unsigned long gcov_seek_end (void);
-static int gcov_is_eof (void);
-static int gcov_is_error (void);
-#if IN_GCOV > 0
-static time_t gcov_time (void);
+GCOV_LINKAGE int gcov_open (const char */*name*/);
+#else
+GCOV_LINKAGE int gcov_open (const char */*name*/, int /*direction*/);
+GCOV_LINKAGE int gcov_magic (gcov_unsigned_t, gcov_unsigned_t);
#endif
+GCOV_LINKAGE int gcov_close (void);
-/* Open a gcov file. NAME is the name of the file to open and MODE
- indicates whether a new file should be created, or an existing file
- opened for modification. If MODE is >= 0 an existing file will be
- opened, if possible, and if MODE is <= 0, a new file will be
- created. Use MODE=0 to attempt to reopen an existing file and then
- fall back on creating a new one. Return zero on failure, >0 on
- opening an existing file and <0 on creating a new one. */
+/* Available everywhere. */
+static gcov_position_t gcov_position (void);
+static int gcov_is_error (void);
-static int
-gcov_open (const char *name, int mode)
-{
- int result = 1;
- size_t alloc = 1024;
-#if defined (TARGET_HAS_F_SETLKW) && IN_LIBGCOV
- struct flock s_flock;
-
- s_flock.l_type = F_WRLCK;
- s_flock.l_whence = SEEK_SET;
- s_flock.l_start = 0;
- s_flock.l_len = 0; /* Until EOF. */
- s_flock.l_pid = getpid ();
-#endif
-
- if (gcov_var.file)
- abort ();
- gcov_var.position = gcov_var.length = 0;
- gcov_var.error = gcov_var.modified = 0;
- if (mode >= 0)
- gcov_var.file = fopen (name, "r+b");
- if (!gcov_var.file && mode <= 0)
- {
- result = -1;
- gcov_var.file = fopen (name, "w+b");
- }
- if (!gcov_var.file)
- return 0;
-
-#if defined (TARGET_HAS_F_SETLKW) && IN_LIBGCOV
- while (fcntl (fileno (gcov_var.file), F_SETLKW, &s_flock)
- && errno == EINTR)
- continue;
-#endif
+GCOV_LINKAGE gcov_unsigned_t gcov_read_unsigned (void);
+GCOV_LINKAGE gcov_type gcov_read_counter (void);
+GCOV_LINKAGE void gcov_read_summary (struct gcov_summary *);
- if (result >= 0)
- {
- if (fseek (gcov_var.file, 0, SEEK_END))
- {
- fclose (gcov_var.file);
- gcov_var.file = 0;
- return 0;
- }
- gcov_var.length = ftell (gcov_var.file);
- fseek (gcov_var.file, 0, SEEK_SET);
- alloc += gcov_var.length;
- }
- if (alloc > gcov_var.alloc)
- {
- if (gcov_var.buffer)
- free (gcov_var.buffer);
- gcov_var.alloc = alloc;
#if IN_LIBGCOV
- gcov_var.buffer = malloc (gcov_var.alloc);
- if (!gcov_var.buffer)
- {
- fclose (gcov_var.file);
- gcov_var.file = 0;
- gcov_var.length = 0;
- gcov_var.alloc = 0;
- return 0;
- }
+/* Available only in libgcov */
+GCOV_LINKAGE void gcov_write_counter (gcov_type);
+GCOV_LINKAGE void gcov_write_tag_length (gcov_unsigned_t, gcov_unsigned_t);
+GCOV_LINKAGE void gcov_write_summary (gcov_unsigned_t /*tag*/,
+ const struct gcov_summary *);
+static void gcov_rewrite (void);
+GCOV_LINKAGE void gcov_seek (gcov_position_t /*position*/);
#else
- gcov_var.buffer = xmalloc (gcov_var.alloc);
-#endif
- }
- if (result >= 0
- && fread (gcov_var.buffer, gcov_var.length, 1, gcov_var.file) != 1)
- {
- fclose (gcov_var.file);
- gcov_var.file = 0;
- gcov_var.length = 0;
- return 0;
- }
- return result;
-}
-
-/* Close the current gcov file. Flushes data to disk. Returns nonzero
- on failure or error flag set. */
-
-static int
-gcov_close ()
-{
- int result = 0;
-
- if (gcov_var.file)
- {
- if (gcov_var.modified
- && (fseek (gcov_var.file, 0, SEEK_SET)
- || fwrite (gcov_var.buffer, gcov_var.length,
- 1, gcov_var.file) != 1))
- result = 1;
- fclose (gcov_var.file);
- gcov_var.file = 0;
- gcov_var.length = 0;
- }
-#if !IN_LIBGCOV
- free (gcov_var.buffer);
- gcov_var.alloc = 0;
- gcov_var.buffer = 0;
+/* Available outside libgcov */
+GCOV_LINKAGE const char *gcov_read_string (void);
+GCOV_LINKAGE void gcov_sync (gcov_position_t /*base*/,
+ gcov_unsigned_t /*length */);
#endif
- return result ? 1 : gcov_var.error;
-}
#if !IN_GCOV
-/* Allocate space to write BYTES bytes to the gcov file. Return a
- pointer to those bytes, or NULL on failure. */
+/* Available outside gcov */
+GCOV_LINKAGE void gcov_write_unsigned (gcov_unsigned_t);
+#endif
-static unsigned char *
-gcov_write_bytes (unsigned bytes)
-{
- char unsigned *result;
+#if !IN_GCOV && !IN_LIBGCOV
+/* Available only in compiler */
+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 /*position*/);
+#endif
- if (gcov_var.position + bytes > gcov_var.alloc)
- {
- size_t new_size = (gcov_var.alloc + bytes) * 3 / 2;
+#if IN_GCOV > 0
+/* Available in gcov */
+GCOV_LINKAGE time_t gcov_time (void);
+#endif
- if (!gcov_var.buffer)
- return 0;
+/* Make sure the library is used correctly. */
#if IN_LIBGCOV
- result = realloc (gcov_var.buffer, new_size);
- if (!result)
- {
- free (gcov_var.buffer);
- gcov_var.buffer = 0;
- gcov_var.alloc = 0;
- gcov_var.position = gcov_var.length = 0;
- gcov_var.error = 1;
- return 0;
- }
+#if ENABLE_CHECKING
+#define GCOV_CHECK(EXPR) (!(EXPR) ? abort (), 0 : 0)
#else
- result = xrealloc (gcov_var.buffer, new_size);
+/* Include EXPR, so that unused variable warnings do not occur. */
+#define GCOV_CHECK(EXPR) ((void)(0 && (EXPR)))
#endif
- gcov_var.alloc = new_size;
- gcov_var.buffer = result;
- }
-
- result = &gcov_var.buffer[gcov_var.position];
- gcov_var.position += bytes;
- gcov_var.modified = 1;
- if (gcov_var.position > gcov_var.length)
- gcov_var.length = gcov_var.position;
- return result;
-}
-
-/* Write unsigned VALUE to coverage file. Sets error flag
- appropriately. */
-
-static void
-gcov_write_unsigned (unsigned value)
-{
- unsigned char *buffer = gcov_write_bytes (4);
- unsigned ix;
-
- if (!buffer)
- return;
- for (ix = 4; ix--; )
- {
- buffer[ix] = value;
- value >>= 8;
- }
- if (sizeof (value) > 4 && value)
- gcov_var.error = -1;
-
- return;
-}
-
-/* Write counter VALUE to coverage file. Sets error flag
- appropriately. */
-
-#if IN_LIBGCOV
-static void
-gcov_write_counter (gcov_type value)
-{
- unsigned char *buffer = gcov_write_bytes (8);
- unsigned ix;
-
- if (!buffer)
- return;
- for (ix = 8; ix--; )
- {
- buffer[ix] = value;
- value >>= 8;
- }
- if ((sizeof (value) > 8 && value) || value < 0)
- gcov_var.error = -1;
- return;
-}
-#endif /* IN_LIBGCOV */
-
-/* Write STRING to coverage file. Sets error flag on file
- error, overflow flag on overflow */
-
-static void
-gcov_write_string (const char *string)
-{
- unsigned length = 0;
- unsigned pad = 0;
- unsigned rem = 0;
- unsigned char *buffer;
-
- if (string)
- {
- length = strlen (string);
- rem = 4 - (length & 3);
- }
-
- buffer = gcov_write_bytes (4 + length + rem);
- if (buffer)
- {
- unsigned ix;
- unsigned value = length;
-
- for (ix = 4; ix--; )
- {
- buffer[ix] = value;
- value >>= 8;
- }
- memcpy (buffer + 4, string, length);
- memcpy (buffer + 4 + length, &pad, rem);
- }
-}
-
-/* Write a tag TAG and reserve space for the record length. Return a
- value to be used for gcov_write_length. */
-
-static unsigned long
-gcov_write_tag (unsigned tag)
-{
- unsigned long result = gcov_var.position;
- unsigned char *buffer = gcov_write_bytes (8);
- unsigned ix;
-
- if (!buffer)
- return 0;
- for (ix = 4; ix--; )
- {
- buffer[ix] = tag;
- tag >>= 8;
- }
- memset (buffer + 4, 0, 4);
- return result;
-}
-
-/* Write a record length using POSITION, which was returned by
- gcov_write_tag. The current file position is the end of the
- record, and is restored before returning. Returns nonzero on
- overflow. */
-
-static void
-gcov_write_length (unsigned long position)
-{
- if (position)
- {
- unsigned length = gcov_var.position - position - 8;
- unsigned char *buffer = &gcov_var.buffer[position + 4];
- unsigned ix;
-
- for (ix = 4; ix--; )
- {
- buffer[ix] = length;
- length >>= 8;
- }
- }
-}
-
-#if IN_LIBGCOV
-/* Write a summary structure to the gcov file. Return non-zero on
- overflow. */
-
-static void
-gcov_write_summary (unsigned tag, const struct gcov_summary *summary)
-{
- unsigned long base;
-
- base = gcov_write_tag (tag);
- gcov_write_unsigned (summary->checksum);
- gcov_write_unsigned (summary->runs);
- gcov_write_unsigned (summary->arcs);
- gcov_write_counter (summary->arc_sum);
- gcov_write_counter (summary->arc_max_one);
- gcov_write_counter (summary->arc_max_sum);
- gcov_write_counter (summary->arc_sum_max);
- gcov_write_length (base);
-}
-#endif /* IN_LIBGCOV */
-
-#endif /*!IN_GCOV */
-
-/* Return a pointer to read BYTES bytes from the gcov file. Returns
- NULL on failure (read past EOF). */
-
-static const unsigned char *
-gcov_read_bytes (unsigned bytes)
-{
- const unsigned char *result;
-
- if (gcov_var.position + bytes > gcov_var.length)
- {
- gcov_var.error = 1;
- return 0;
- }
-
- result = &gcov_var.buffer[gcov_var.position];
- gcov_var.position += bytes;
- return result;
-}
-
-/* Read unsigned value from a coverage file. Sets error flag on file
- error, overflow flag on overflow */
-
-static unsigned
-gcov_read_unsigned ()
-{
- unsigned value = 0;
- unsigned ix;
- const unsigned char *buffer = gcov_read_bytes (4);
-
- if (!buffer)
- return 0;
- for (ix = sizeof (value); ix < 4; ix++)
- if (buffer[ix])
- gcov_var.error = -1;
- for (ix = 0; ix != 4; ix++)
- {
- value <<= 8;
- value |= buffer[ix];
- }
- return value;
-}
-
-/* Read counter value from a coverage file. Sets error flag on file
- error, overflow flag on overflow */
-
-static gcov_type
-gcov_read_counter ()
-{
- gcov_type value = 0;
- unsigned ix;
- const unsigned char *buffer = gcov_read_bytes (8);
-
- if (!buffer)
- return 0;
- for (ix = sizeof (value); ix < 8; ix++)
- if (buffer[ix])
- gcov_var.error = -1;
- for (ix = 0; ix != 8; ix++)
- {
- value <<= 8;
- value |= buffer[ix];
- }
- if (value < 0)
- gcov_var.error = -1;
- return value;
-}
-
-/* Read string from coverage file. Returns a pointer to a static
- buffer, or NULL on empty string. You must copy the string before
- calling another gcov function. */
-
-static const char *
-gcov_read_string ()
-{
- unsigned length = gcov_read_unsigned ();
-
- if (!length)
- return 0;
-
- length += 4 - (length & 3);
- return (const char *) gcov_read_bytes (length);
-}
-
-#define GCOV_SUMMARY_LENGTH 44
-static void
-gcov_read_summary (struct gcov_summary *summary)
-{
- summary->checksum = gcov_read_unsigned ();
- summary->runs = gcov_read_unsigned ();
- summary->arcs = gcov_read_unsigned ();
- summary->arc_sum = gcov_read_counter ();
- summary->arc_max_one = gcov_read_counter ();
- summary->arc_max_sum = gcov_read_counter ();
- summary->arc_sum_max = gcov_read_counter ();
-}
+#else
+#define GCOV_CHECK(EXPR) gcc_assert (EXPR)
+#endif
+#define GCOV_CHECK_READING() GCOV_CHECK(gcov_var.mode > 0)
+#define GCOV_CHECK_WRITING() GCOV_CHECK(gcov_var.mode < 0)
/* Save the current position in the gcov file. */
-static inline unsigned long
+static inline gcov_position_t
gcov_position (void)
{
- return gcov_var.position;
-}
-
-/* Reset to a known position. BASE should have been obtained from
- gcov_save_position, LENGTH should be a record length, or zero. */
-
-static inline void
-gcov_seek (unsigned long base, unsigned length)
-{
- if (gcov_var.buffer)
- {
- base += length;
- if (gcov_var.length < base)
- {
- gcov_var.error = 1;
- base = gcov_var.length;
- }
- gcov_var.position = base;
- }
+ GCOV_CHECK_READING ();
+ return gcov_var.start + gcov_var.offset;
}
-/* Move to the end of the gcov file. */
-
-static inline unsigned long
-gcov_seek_end ()
-{
- gcov_var.position = gcov_var.length;
- return gcov_var.position;
-}
-
-/* Tests whether we have reached end of .da file. */
+/* Return nonzero if the error flag is set. */
static inline int
-gcov_is_eof ()
+gcov_is_error (void)
{
- return gcov_var.position == gcov_var.length;
+ return gcov_var.file ? gcov_var.error : 1;
}
-/* Return non-zero if the error flag is set. */
+#if IN_LIBGCOV
+/* Move to beginning of file and initialize for writing. */
-static inline int
-gcov_is_error ()
+static inline void
+gcov_rewrite (void)
{
- return gcov_var.file ? gcov_var.error : 1;
+ GCOV_CHECK_READING ();
+ gcov_var.mode = -1;
+ gcov_var.start = 0;
+ gcov_var.offset = 0;
+ fseek (gcov_var.file, 0L, SEEK_SET);
}
+#endif
-#if IN_GCOV > 0
-/* Return the modification time of the current gcov file. */
+#endif /* IN_LIBGCOV >= 0 */
-static time_t
-gcov_time ()
-{
- struct stat status;
-
- if (fstat (fileno (gcov_var.file), &status))
- return 0;
- else
- return status.st_mtime;
-}
-#endif /* IN_GCOV */
#endif /* GCC_GCOV_IO_H */
OSDN Git Service
