OSDN Git Service

Daily bump.
[pf3gnuchains/gcc-fork.git] / gcc / gcov-io.h
index 999d07e..eaa23ad 100644 (file)
@@ -1,6 +1,6 @@
 /* File format for coverage information
    Copyright (C) 1996, 1997, 1998, 2000, 2002,
-   2003 Free Software Foundation, Inc.
+   2003, 2004 Free Software Foundation, Inc.
    Contributed by Bob Manson <manson@cygnus.com>.
    Completely remangled by Nathan Sidwell <nathan@codesourcery.com>.
 
@@ -28,24 +28,25 @@ Software Foundation, 59 Temple Place - Suite 330, Boston, MA
    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 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
+/* 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
@@ -54,31 +55,30 @@ Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 
        file : int32:magic int32:version int32:stamp 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. The stamp value is used to synchronize bbg and
-   counter files and to synchronize merging within a counter 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.
+   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, 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
+   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.
 
@@ -87,21 +87,22 @@ Software Foundation, 59 Temple Place - Suite 330, Boston, MA
        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 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 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:  unit function-graph*
+       note: unit function-graph*
        unit: header int32:checksum string:source
        function-graph: announce_function basic_blocks {arcs | lines}*
        announce_function: header int32:ident int32:checksum
@@ -130,7 +131,7 @@ Software Foundation, 59 Temple Place - Suite 330, Boston, MA
    blocks they are for.
 
    The data file contains the following records.
-        da: {unit 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 int32:ident int32:checksum
@@ -139,17 +140,16 @@ Software Foundation, 59 Temple Place - Suite 330, Boston, MA
        count-summary:  int32:num int32:runs int64:sum
                        int64:max 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.
+   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
@@ -166,6 +166,7 @@ Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 #if IN_LIBGCOV
 /* 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
@@ -173,6 +174,26 @@ typedef signed gcov_type __attribute__ ((mode (DI)));
 #else
 typedef signed gcov_type __attribute__ ((mode (SI)));
 #endif
+#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
@@ -221,7 +242,6 @@ typedef HOST_WIDEST_INT gcov_type;
 #define gcov_seek __gcov_seek
 #define gcov_rewrite __gcov_rewrite
 #define gcov_is_error __gcov_is_error
-#define gcov_is_eof __gcov_is_eof
 #define gcov_write_unsigned __gcov_write_unsigned
 #define gcov_write_counter __gcov_write_counter
 #define gcov_write_summary __gcov_write_summary
@@ -231,7 +251,7 @@ typedef HOST_WIDEST_INT gcov_type;
 
 /* 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
+#pragma GCC poison gcov_read_string gcov_sync gcov_time gcov_magic
 
 #endif
 
@@ -240,48 +260,70 @@ typedef HOST_WIDEST_INT gcov_type;
 #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.  */
+   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 * 4)
+#define GCOV_TAG_FUNCTION_LENGTH (2)
 #define GCOV_TAG_BLOCKS                 ((gcov_unsigned_t)0x01410000)
-#define GCOV_TAG_BLOCKS_LENGTH(NUM) ((NUM) * 4)
+#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 * 4 + (NUM) * (2 * 4))
+#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) * 8)
+#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 * 4 + GCOV_COUNTERS_SUMMABLE * (2 * 4 + 3 * 8))
+       (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"}
@@ -374,7 +416,7 @@ struct gcov_ctr_info
 struct gcov_info
 {
   gcov_unsigned_t version;     /* expected version number */
-  struct gcov_info *next;      /* link to next, used by libgcc */
+  struct gcov_info *next;      /* link to next, used by libgcov */
 
   gcov_unsigned_t stamp;       /* uniquifying time stamp */
   const char *filename;                /* output file name */
@@ -398,18 +440,30 @@ extern void __gcov_flush (void);
 /* The merge function that just sums the counters.  */
 extern void __gcov_merge_add (gcov_type *, unsigned);
 
-/* The merge function to choose the most often value.  */
+/* The merge function to choose the most common value.  */
 extern void __gcov_merge_single (gcov_type *, unsigned);
 
-/* The merge function to choose the most often difference between consecutive
-   values.  */
+/* 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 */
 
 #if IN_LIBGCOV >= 0
 
-/* Optimum size read from or written to disk.  */
-#define GCOV_BLOCK_SIZE (1 << 12)
+/* Optimum number of gcov_unsigned_t's read from or written to disk.  */
+#define GCOV_BLOCK_SIZE (1 << 10)
 
 GCOV_LINKAGE struct gcov_var
 {
@@ -417,7 +471,7 @@ GCOV_LINKAGE struct gcov_var
   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 bytes overread.  */
+  unsigned overread;           /* Number of words overread.  */
   int error;                   /* < 0 overflow, > 0 disk error.  */
   int mode;                    /* < 0 writing, > 0 reading */
 #if IN_LIBGCOV
@@ -425,30 +479,36 @@ GCOV_LINKAGE struct gcov_var
      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.  */
-  unsigned char buffer[GCOV_BLOCK_SIZE + 4];
+  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 char *buffer;
+  gcov_unsigned_t *buffer;
 #endif
 } gcov_var;
 
-/* Functions for reading and writing gcov files. You can open a file
-   for (1) reading or (2) writing or (3) reading then rewriting. 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.  */
-GCOV_LINKAGE int gcov_open (const char */*name*/, int /*truncate*/);
+/* 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
+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);
 
 /* Available everywhere.  */
 static gcov_position_t gcov_position (void);
 static int gcov_is_error (void);
-static int gcov_is_eof (void);
 
 GCOV_LINKAGE gcov_unsigned_t gcov_read_unsigned (void);
 GCOV_LINKAGE gcov_type gcov_read_counter (void);
@@ -460,7 +520,6 @@ 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_truncate (void);
 static void gcov_rewrite (void);
 GCOV_LINKAGE void gcov_seek (gcov_position_t /*position*/);
 #else
@@ -488,10 +547,15 @@ GCOV_LINKAGE time_t gcov_time (void);
 #endif
 
 /* Make sure the library is used correctly.  */
+#if IN_LIBGCOV
 #if ENABLE_CHECKING
-#define GCOV_CHECK(expr) ((expr) ? (void)0 : (void)abort ())
+#define GCOV_CHECK(EXPR) (!(EXPR) ? abort (), 0 : 0)
+#else
+/* Include EXPR, so that unused variable warnings do not occur.  */
+#define GCOV_CHECK(EXPR) ((void)(0 && (EXPR)))
+#endif
 #else
-#define GCOV_CHECK(expr)
+#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)
@@ -505,14 +569,6 @@ gcov_position (void)
   return gcov_var.start + gcov_var.offset;
 }
 
-/* Return nonzero if we read to end of file.  */
-
-static inline int
-gcov_is_eof (void)
-{
-  return !gcov_var.overread;
-}
-
 /* Return nonzero if the error flag is set.  */
 
 static inline int
@@ -533,12 +589,6 @@ gcov_rewrite (void)
   gcov_var.offset = 0;
   fseek (gcov_var.file, 0L, SEEK_SET);
 }
-
-static inline void
-gcov_truncate (void)
-{
-  ftruncate (fileno (gcov_var.file), 0L);
-}
 #endif
 
 #endif /* IN_LIBGCOV >= 0 */