gcov-io.h 23.1 KB
Newer Older
1
/* File format for coverage information
2
   Copyright (C) 1996, 1997, 1998, 2000, 2002,
3
   2003, 2004, 2005, 2008, 2009 Free Software Foundation, Inc.
Doug Evans committed
4
   Contributed by Bob Manson <manson@cygnus.com>.
5
   Completely remangled by Nathan Sidwell <nathan@codesourcery.com>.
Doug Evans committed
6

7
This file is part of GCC.
Doug Evans committed
8

9 10
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
11
Software Foundation; either version 3, or (at your option) any later
12
version.
Doug Evans committed
13

14 15 16 17
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.
Doug Evans committed
18

19 20 21 22 23 24 25 26 27
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/>.  */

28

29
/* Coverage information is held in two files.  A notes file, which is
30 31 32 33 34 35 36
   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.
37 38 39 40

   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
41 42
   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
43 44
   string. Zero length and NULL strings are simply stored as a length
   of zero (they have no trailing NUL or padding).
45 46 47

   	int32:  byte3 byte2 byte1 byte0 | byte0 byte1 byte2 byte3
	int64:  int32:low int32:high
48 49 50 51 52 53
	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

54
   	file : int32:magic int32:version int32:stamp record*
55

56 57 58 59 60 61 62 63
   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.
64
   
65 66 67 68 69 70 71 72 73
   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
74
   incompatible with itself.  For gcc 3.4 experimental, it would be
75 76 77 78 79
   '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.
80 81 82 83 84 85 86 87

   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
88 89
   numbers reflect this hierarchy.  Tags are unique across note and
   data files.  Some record types have a varying amount of data.  The
90 91 92 93 94 95 96 97 98 99 100
   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.
101 102

   The basic block graph file contains the following records
103
   	note: unit function-graph*
104
	unit: header int32:checksum string:source
105
	function-graph: announce_function basic_blocks {arcs | lines}*
106 107
	announce_function: header int32:ident int32:checksum
		string:name string:source int32:lineno
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
	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.
132
        data: {unit function-data* summary:object summary:program*}*
133
	unit: header int32:checksum
134
        function-data:	announce_function arc_counts
135
	announce_function: header int32:ident int32:checksum
136
	arc_counts: header int64:count*
137 138 139
	summary: int32:checksum {count-summary}GCOV_COUNTERS
	count-summary:	int32:num int32:runs int64:sum
			int64:max int64:sum_max
140

141 142 143 144 145 146 147
   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,
148
   each with a unique checksum.  The object summary's checksum is zero.
149 150
   Note that the data file might contain information from several runs
   concatenated, or the data might be merged.
151 152

   This file is included by both the compiler, gcov tools and the
153
   runtime support library libgcov. IN_LIBGCOV and IN_GCOV are used to
154 155
   distinguish which case is which.  If IN_LIBGCOV is nonzero,
   libgcov is being built. If IN_GCOV is nonzero, the gcov tools are
156 157 158 159
   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).  */
160

161 162
#ifndef GCC_GCOV_IO_H
#define GCC_GCOV_IO_H
Doug Evans committed
163

164
#if IN_LIBGCOV
165 166
/* About the target */

167
#if BITS_PER_UNIT == 8
168 169 170 171
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)));
172
#else
173
typedef signed gcov_type __attribute__ ((mode (SI)));
174
#endif
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
#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

195

196
#if defined (TARGET_POSIX_IO)
197 198 199 200
#define GCOV_LOCKED 1
#else
#define GCOV_LOCKED 0
#endif
201

202
#else /* !IN_LIBGCOV */
203 204 205 206 207
/* About the host */

typedef unsigned gcov_unsigned_t;
typedef unsigned gcov_position_t;
/* gcov_type is typedef'd elsewhere for the compiler */
208
#if IN_GCOV
209
#define GCOV_LINKAGE static
210 211 212 213
typedef HOST_WIDEST_INT gcov_type;
#if IN_GCOV > 0
#include <sys/types.h>
#endif
214
#else /*!IN_GCOV */
215
#define GCOV_TYPE_SIZE (LONG_LONG_TYPE_SIZE > 32 ? 64 : 32)
216
#endif
217 218 219 220 221 222 223

#if defined (HOST_HAS_F_SETLKW)
#define GCOV_LOCKED 1
#else
#define GCOV_LOCKED 0
#endif

224
#endif /* !IN_LIBGCOV */
225

226 227 228 229 230
/* 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.  */
231
#if IN_LIBGCOV
232

233
#include "tconfig.h"
234

235 236 237
#define gcov_var __gcov_var
#define gcov_open __gcov_open
#define gcov_close __gcov_close
238 239 240 241 242
#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
243 244 245 246 247 248
#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
249

250
/* Poison these, so they don't accidentally slip in.  */
251
#pragma GCC poison gcov_write_string gcov_write_tag gcov_write_length
252
#pragma GCC poison gcov_read_string gcov_sync gcov_time gcov_magic
253

254 255 256 257 258 259 260 261 262 263
#ifdef HAVE_GAS_HIDDEN
#define ATTRIBUTE_HIDDEN  __attribute__ ((__visibility__ ("hidden")))
#else
#define ATTRIBUTE_HIDDEN
#endif

#else

#define ATTRIBUTE_HIDDEN

264
#endif
265

266 267 268
#ifndef GCOV_LINKAGE
#define GCOV_LINKAGE extern
#endif
269

270
/* File suffixes.  */
271 272
#define GCOV_DATA_SUFFIX ".gcda"
#define GCOV_NOTE_SUFFIX ".gcno"
273

274 275 276
/* File magic. Must not be palindromes.  */
#define GCOV_DATA_MAGIC ((gcov_unsigned_t)0x67636461) /* "gcda" */
#define GCOV_NOTE_MAGIC ((gcov_unsigned_t)0x67636e6f) /* "gcno" */
277 278 279

/* gcov-iov.h is automatically generated by the makefile from
   version.c, it looks like
280
   	#define GCOV_VERSION ((gcov_unsigned_t)0x89abcdef)
281 282 283
*/
#include "gcov-iov.h"

284 285 286 287 288 289 290
/* 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))

291
/* The record tags.  Values [1..3f] are for tags which may be in either
292
   file.  Values [41..9f] for those in the note file and [a1..ff] for
293 294
   the data file.  The tag value zero is used as an explicit end of
   file marker -- it is not required to be present.  */
295

296
#define GCOV_TAG_FUNCTION	 ((gcov_unsigned_t)0x01000000)
297
#define GCOV_TAG_FUNCTION_LENGTH (2)
298
#define GCOV_TAG_BLOCKS		 ((gcov_unsigned_t)0x01410000)
299 300
#define GCOV_TAG_BLOCKS_LENGTH(NUM) (NUM)
#define GCOV_TAG_BLOCKS_NUM(LENGTH) (LENGTH)
301
#define GCOV_TAG_ARCS		 ((gcov_unsigned_t)0x01430000)
302 303
#define GCOV_TAG_ARCS_LENGTH(NUM)  (1 + (NUM) * 2)
#define GCOV_TAG_ARCS_NUM(LENGTH)  (((LENGTH) - 1) / 2)
304 305
#define GCOV_TAG_LINES		 ((gcov_unsigned_t)0x01450000)
#define GCOV_TAG_COUNTER_BASE 	 ((gcov_unsigned_t)0x01a10000)
306 307
#define GCOV_TAG_COUNTER_LENGTH(NUM) ((NUM) * 2)
#define GCOV_TAG_COUNTER_NUM(LENGTH) ((LENGTH) / 2)
308 309 310
#define GCOV_TAG_OBJECT_SUMMARY  ((gcov_unsigned_t)0xa1000000)
#define GCOV_TAG_PROGRAM_SUMMARY ((gcov_unsigned_t)0xa3000000)
#define GCOV_TAG_SUMMARY_LENGTH  \
311
	(1 + GCOV_COUNTERS_SUMMABLE * (2 + 3 * 2))
312 313 314

/* Counters that are collected.  */
#define GCOV_COUNTER_ARCS 	0  /* Arc transitions.  */
315
#define GCOV_COUNTERS_SUMMABLE	1  /* Counters which can be
316
				      summaried.  */
317 318 319 320 321
#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.  */
Zdenek Dvorak committed
322 323 324 325 326 327
#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.  */
328 329

#define GCOV_COUNTER_V_INDIR	5  /* The most common indirect address */
330 331 332 333
#define GCOV_COUNTER_AVERAGE	6  /* Compute average value passed to the
				      counter.  */
#define GCOV_COUNTER_IOR	7  /* IOR of the all values passed to
				      counter.  */
334
#define GCOV_LAST_VALUE_COUNTER 7  /* The last of counters used for value
335
				      profiling.  */
336
#define GCOV_COUNTERS		8
337 338 339 340

/* Number of counters used for value profiling.  */
#define GCOV_N_VALUE_COUNTERS \
  (GCOV_LAST_VALUE_COUNTER - GCOV_FIRST_VALUE_COUNTER + 1)
Zdenek Dvorak committed
341 342
  
  /* A list of human readable names of the counters */
343 344
#define GCOV_COUNTER_NAMES	{"arcs", "interval", "pow2", "single", \
				 "delta","indirect_call", "average", "ior"}
Zdenek Dvorak committed
345 346 347 348 349 350
  
  /* Names of merge functions for counters.  */
#define GCOV_MERGE_FUNCTIONS	{"__gcov_merge_add",	\
				 "__gcov_merge_add",	\
				 "__gcov_merge_add",	\
				 "__gcov_merge_single",	\
351
				 "__gcov_merge_delta",  \
352 353 354
				 "__gcov_merge_single", \
				 "__gcov_merge_add",	\
				 "__gcov_merge_ior"}
Zdenek Dvorak committed
355
  
356
/* Convert a counter index to a tag.  */
357
#define GCOV_TAG_FOR_COUNTER(COUNT)				\
358
	(GCOV_TAG_COUNTER_BASE + ((gcov_unsigned_t)(COUNT) << 17))
359 360
/* Convert a tag to a counter.  */
#define GCOV_COUNTER_FOR_TAG(TAG)					\
361
	((unsigned)(((TAG) - GCOV_TAG_COUNTER_BASE) >> 17))
362 363 364
/* Check whether a tag is a counter tag.  */
#define GCOV_TAG_IS_COUNTER(TAG)				\
	(!((TAG) & 0xFFFF) && GCOV_COUNTER_FOR_TAG (TAG) < GCOV_COUNTERS)
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380

/* 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_MASK(TAG) (((TAG) - 1) ^ (TAG))

/* Return nonzero if SUB is an immediate subtag of TAG.  */
#define GCOV_TAG_IS_SUBTAG(TAG,SUB)				\
	(GCOV_TAG_MASK (TAG) >> 8 == GCOV_TAG_MASK (SUB) 	\
	 && !(((SUB) ^ (TAG)) & ~GCOV_TAG_MASK(TAG)))

/* Return nonzero if SUB is at a sublevel to TAG.  */
#define GCOV_TAG_IS_SUBLEVEL(TAG,SUB)				\
     	(GCOV_TAG_MASK (TAG) > GCOV_TAG_MASK (SUB))

/* Basic block flags.  */
381
#define GCOV_BLOCK_UNEXPECTED	(1 << 1)
382 383 384 385 386 387 388 389

/* Arc flags.  */
#define GCOV_ARC_ON_TREE 	(1 << 0)
#define GCOV_ARC_FAKE		(1 << 1)
#define GCOV_ARC_FALLTHROUGH	(1 << 2)

/* Structured records.  */

390
/* Cumulative counter data.  */
391 392
struct gcov_ctr_summary
{
393 394
  gcov_unsigned_t num;		/* number of counters.  */
  gcov_unsigned_t runs;		/* number of program runs */
395
  gcov_type sum_all;		/* sum of all counters accumulated.  */
396
  gcov_type run_max;		/* maximum value on a single run.  */
397
  gcov_type sum_max;    	/* sum of individual run max values.  */
398 399
};

400 401
/* Object & program summary record.  */
struct gcov_summary
Doug Evans committed
402
{
403 404
  gcov_unsigned_t checksum;	/* checksum of program */
  struct gcov_ctr_summary ctrs[GCOV_COUNTERS_SUMMABLE];
405 406 407 408 409
};

/* Structures embedded in coveraged program.  The structures generated
   by write_profile must match these.  */

410
#if IN_LIBGCOV
411 412 413 414 415
/* 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
416
{
417 418
  gcov_unsigned_t ident;	/* unique ident of function */
  gcov_unsigned_t checksum;	/* function checksum */
419
  unsigned n_ctrs[0];		/* instrumented counters */
420 421
};

422
/* Type of function used to merge counters.  */
423
typedef void (*gcov_merge_fn) (gcov_type *, gcov_unsigned_t);
424

425 426
/* Information about counters.  */
struct gcov_ctr_info
427
{
428 429 430
  gcov_unsigned_t num;		/* number of counters.  */
  gcov_type *values;		/* their values.  */
  gcov_merge_fn merge;  	/* The function used to merge them.  */
431
};
432

433 434
/* Information about a single object file.  */
struct gcov_info
Doug Evans committed
435
{
436
  gcov_unsigned_t version;	/* expected version number */
437
  struct gcov_info *next;	/* link to next, used by libgcov */
438

439
  gcov_unsigned_t stamp;	/* uniquifying time stamp */
440
  const char *filename;		/* output file name */
441
  
442
  unsigned n_functions;		/* number of functions */
443
  const struct gcov_fn_info *functions; /* table of functions */
444

445
  unsigned ctr_mask;		/* mask of counters instrumented.  */
446 447 448 449
  struct gcov_ctr_info counts[0]; /* count data. The number of bits
				     set in the ctr_mask field
				     determines how big this array
				     is.  */
450 451 452
};

/* Register a new object file module.  */
453
extern void __gcov_init (struct gcov_info *) ATTRIBUTE_HIDDEN;
454 455

/* Called before fork, to avoid double counting.  */
456
extern void __gcov_flush (void) ATTRIBUTE_HIDDEN;
457

458
/* The merge function that just sums the counters.  */
459
extern void __gcov_merge_add (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
Zdenek Dvorak committed
460

461
/* The merge function to choose the most common value.  */
462
extern void __gcov_merge_single (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
Zdenek Dvorak committed
463

464 465
/* The merge function to choose the most common difference between
   consecutive values.  */
466
extern void __gcov_merge_delta (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;
467

468 469 470
/* The merge function that just ors the counters together.  */
extern void __gcov_merge_ior (gcov_type *, unsigned) ATTRIBUTE_HIDDEN;

471 472 473 474
/* The profiler functions.  */
extern void __gcov_interval_profiler (gcov_type *, gcov_type, int, unsigned); 
extern void __gcov_pow2_profiler (gcov_type *, gcov_type);
extern void __gcov_one_value_profiler (gcov_type *, gcov_type);
475 476 477
extern void __gcov_indirect_call_profiler (gcov_type *, gcov_type, void *, void *);
extern void __gcov_average_profiler (gcov_type *, gcov_type);
extern void __gcov_ior_profiler (gcov_type *, gcov_type);
478

479
#ifndef inhibit_libc
480
/* The wrappers around some library functions..  */
481
extern pid_t __gcov_fork (void) ATTRIBUTE_HIDDEN;
482 483 484
extern int __gcov_execl (const char *, char *, ...) ATTRIBUTE_HIDDEN;
extern int __gcov_execlp (const char *, char *, ...) ATTRIBUTE_HIDDEN;
extern int __gcov_execle (const char *, char *, ...) ATTRIBUTE_HIDDEN;
485 486 487 488
extern int __gcov_execv (const char *, char *const []) ATTRIBUTE_HIDDEN;
extern int __gcov_execvp (const char *, char *const []) ATTRIBUTE_HIDDEN;
extern int __gcov_execve (const char *, char  *const [], char *const [])
  ATTRIBUTE_HIDDEN;
489
#endif
490

491 492
#endif /* IN_LIBGCOV */

493 494
#if IN_LIBGCOV >= 0

495 496
/* Optimum number of gcov_unsigned_t's read from or written to disk.  */
#define GCOV_BLOCK_SIZE (1 << 10)
497

498
GCOV_LINKAGE struct gcov_var
499 500
{
  FILE *file;
501
  gcov_position_t start;	/* Position of first byte of block */
502 503
  unsigned offset;		/* Read/write position within the block.  */
  unsigned length;		/* Read limit in the block.  */
504
  unsigned overread;		/* Number of words overread.  */
505 506 507 508 509 510 511
  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.  */
512
  gcov_unsigned_t buffer[GCOV_BLOCK_SIZE + 1];
513
#else
514
  int endian;			/* Swap endianness.  */
515 516
  /* Holds a variable length block, as the compiler can write
     strings and needs to backtrack.  */
517
  size_t alloc;
518
  gcov_unsigned_t *buffer;
519
#endif
520
} gcov_var ATTRIBUTE_HIDDEN;
521

522 523 524 525 526 527 528 529
/* 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
530
   these invariants.  */
531
#if IN_LIBGCOV
532
GCOV_LINKAGE int gcov_open (const char */*name*/) ATTRIBUTE_HIDDEN;
533 534 535 536
#else
GCOV_LINKAGE int gcov_open (const char */*name*/, int /*direction*/);
GCOV_LINKAGE int gcov_magic (gcov_unsigned_t, gcov_unsigned_t);
#endif
537
GCOV_LINKAGE int gcov_close (void) ATTRIBUTE_HIDDEN;
538 539 540 541 542

/* Available everywhere.  */
static gcov_position_t gcov_position (void);
static int gcov_is_error (void);

543 544 545
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;
546

547
#if IN_LIBGCOV
548
/* Available only in libgcov */
549 550 551
GCOV_LINKAGE void gcov_write_counter (gcov_type) ATTRIBUTE_HIDDEN;
GCOV_LINKAGE void gcov_write_tag_length (gcov_unsigned_t, gcov_unsigned_t)
    ATTRIBUTE_HIDDEN;
552
GCOV_LINKAGE void gcov_write_summary (gcov_unsigned_t /*tag*/,
553 554
				      const struct gcov_summary *)
    ATTRIBUTE_HIDDEN;
555
static void gcov_rewrite (void);
556
GCOV_LINKAGE void gcov_seek (gcov_position_t /*position*/) ATTRIBUTE_HIDDEN;
557 558
#else
/* Available outside libgcov */
559
GCOV_LINKAGE const char *gcov_read_string (void);
560 561
GCOV_LINKAGE void gcov_sync (gcov_position_t /*base*/,
			     gcov_unsigned_t /*length */);
562
#endif
563 564 565

#if !IN_GCOV
/* Available outside gcov */
566
GCOV_LINKAGE void gcov_write_unsigned (gcov_unsigned_t) ATTRIBUTE_HIDDEN;
567 568 569 570 571 572 573 574 575
#endif

#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

576
#if IN_GCOV > 0
577
/* Available in gcov */
578
GCOV_LINKAGE time_t gcov_time (void);
579
#endif
580

581
/* Save the current position in the gcov file.  */
582

583
static inline gcov_position_t
584
gcov_position (void)
585
{
586
  gcc_assert (gcov_var.mode > 0);
587
  return gcov_var.start + gcov_var.offset;
588 589
}

590
/* Return nonzero if the error flag is set.  */
591

592
static inline int
593
gcov_is_error (void)
594
{
595
  return gcov_var.file ? gcov_var.error : 1;
596 597
}

598
#if IN_LIBGCOV
599
/* Move to beginning of file and initialize for writing.  */
600 601 602 603

static inline void
gcov_rewrite (void)
{
604
  gcc_assert (gcov_var.mode > 0);
605 606 607 608
  gcov_var.mode = -1;
  gcov_var.start = 0;
  gcov_var.offset = 0;
  fseek (gcov_var.file, 0L, SEEK_SET);
609
}
610
#endif
611

612 613
#endif /* IN_LIBGCOV >= 0 */

614
#endif /* GCC_GCOV_IO_H */