1 /* File format for coverage information
2 Copyright (C) 1996, 1997, 1998, 2000, 2002,
3 2003 Free Software Foundation, Inc.
4 Contributed by Bob Manson <manson@cygnus.com>.
5 Completely remangled by Nathan Sidwell <nathan@codesourcery.com>.
7 This file is part of GCC.
9 GCC is free software; you can redistribute it and/or modify it under
10 the terms of the GNU General Public License as published by the Free
11 Software Foundation; either version 2, or (at your option) any later
14 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
15 WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19 You should have received a copy of the GNU General Public License
20 along with GCC; see the file COPYING. If not, write to the Free
21 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
24 /* Routines declared in gcov-io.h. This file should be #included by
25 another source file, after having #included gcov-io.h. */
28 static void gcov_write_block (unsigned);
29 static gcov_unsigned_t *gcov_write_bytes (unsigned);
31 static const gcov_unsigned_t *gcov_read_bytes (unsigned);
33 static void gcov_allocate (unsigned);
36 static inline gcov_unsigned_t from_file (gcov_unsigned_t value)
41 value = (value >> 16) | (value << 16);
42 value = ((value & 0xff00ff) << 8) | ((value >> 8) & 0xff00ff);
48 /* Open a gcov file. NAME is the name of the file to open and MODE
49 indicates whether a new file should be created, or an existing file
50 opened for modification. If MODE is >= 0 an existing file will be
51 opened, if possible, and if MODE is <= 0, a new file will be
52 created. Use MODE=0 to attempt to reopen an existing file and then
53 fall back on creating a new one. Return zero on failure, >0 on
54 opening an existing file and <0 on creating a new one. */
58 gcov_open (const char *name)
60 gcov_open (const char *name, int mode)
69 s_flock.l_type = F_WRLCK;
70 s_flock.l_whence = SEEK_SET;
72 s_flock.l_len = 0; /* Until EOF. */
73 s_flock.l_pid = getpid ();
79 gcov_var.offset = gcov_var.length = 0;
80 gcov_var.overread = -4u;
86 gcov_var.file = fopen (name, "r+b");
91 gcov_var.file = fopen (name, "w+b");
93 gcov_var.mode = mode * 2 + 1;
98 setbuf (gcov_var.file, (char *)0);
101 while (fcntl (fileno (gcov_var.file), F_SETLKW, &s_flock)
109 /* Close the current gcov file. Flushes data to disk. Returns nonzero
110 on failure or error flag set. */
118 if (gcov_var.offset && gcov_var.mode < 0)
119 gcov_write_block (gcov_var.offset);
121 fclose (gcov_var.file);
126 free (gcov_var.buffer);
131 return gcov_var.error;
135 /* Check if MAGIC is EXPECTED. Use it to determine endianness of the
136 file. Returns +1 for same endian, -1 for other endian and zero for
140 gcov_magic (gcov_unsigned_t magic, gcov_unsigned_t expected)
142 if (magic == expected)
144 magic = (magic >> 16) | (magic << 16);
145 magic = ((magic & 0xff00ff) << 8) | ((magic >> 8) & 0xff00ff);
146 if (magic == expected)
157 gcov_allocate (unsigned length)
159 size_t new_size = gcov_var.alloc;
162 new_size = GCOV_BLOCK_SIZE;
166 gcov_var.alloc = new_size;
167 gcov_var.buffer = xrealloc (gcov_var.buffer, new_size);
172 /* Write out the current block, if needs be. */
175 gcov_write_block (unsigned size)
177 if (fwrite (gcov_var.buffer, size, 1, gcov_var.file) != 1)
179 gcov_var.start += size;
180 gcov_var.offset -= size;
183 /* Allocate space to write BYTES bytes to the gcov file. Return a
184 pointer to those bytes, or NULL on failure. */
186 static gcov_unsigned_t *
187 gcov_write_bytes (unsigned bytes)
189 gcov_unsigned_t *result;
191 GCOV_CHECK_WRITING ();
192 GCOV_CHECK (!(bytes & 3));
194 if (gcov_var.offset >= GCOV_BLOCK_SIZE)
196 gcov_write_block (GCOV_BLOCK_SIZE);
199 GCOV_CHECK (gcov_var.offset == 4);
200 memcpy (gcov_var.buffer, gcov_var.buffer + GCOV_BLOCK_SIZE, 4);
204 if (gcov_var.offset + bytes > gcov_var.alloc)
205 gcov_allocate (gcov_var.offset + bytes);
207 result = (gcov_unsigned_t *)&gcov_var.buffer[gcov_var.offset];
208 gcov_var.offset += bytes;
213 /* Write unsigned VALUE to coverage file. Sets error flag
217 gcov_write_unsigned (gcov_unsigned_t value)
219 gcov_unsigned_t *buffer = gcov_write_bytes (4);
224 /* Write counter VALUE to coverage file. Sets error flag
229 gcov_write_counter (gcov_type value)
231 gcov_unsigned_t *buffer = gcov_write_bytes (8);
233 buffer[0] = (gcov_unsigned_t) value;
234 if (sizeof (value) > sizeof (gcov_unsigned_t))
235 buffer[1] = (gcov_unsigned_t) (value >> 32);
242 #endif /* IN_LIBGCOV */
245 /* Write STRING to coverage file. Sets error flag on file
246 error, overflow flag on overflow */
249 gcov_write_string (const char *string)
253 gcov_unsigned_t *buffer;
257 length = strlen (string);
258 alloc = (length + 4) >> 2;
261 buffer = gcov_write_bytes (4 + alloc * 4);
265 memcpy (&buffer[1], string, length);
270 /* Write a tag TAG and reserve space for the record length. Return a
271 value to be used for gcov_write_length. */
273 GCOV_LINKAGE gcov_position_t
274 gcov_write_tag (gcov_unsigned_t tag)
276 gcov_position_t result = gcov_var.start + gcov_var.offset;
277 gcov_unsigned_t *buffer = gcov_write_bytes (8);
285 /* Write a record length using POSITION, which was returned by
286 gcov_write_tag. The current file position is the end of the
287 record, and is restored before returning. Returns nonzero on
291 gcov_write_length (gcov_position_t position)
294 gcov_unsigned_t length;
295 gcov_unsigned_t *buffer;
297 GCOV_CHECK_WRITING ();
298 GCOV_CHECK (position + 8 <= gcov_var.start + gcov_var.offset);
299 GCOV_CHECK (position >= gcov_var.start);
300 offset = position - gcov_var.start;
301 length = gcov_var.offset - offset - 8;
302 buffer = (gcov_unsigned_t *) &gcov_var.buffer[offset];
304 if (gcov_var.offset >= GCOV_BLOCK_SIZE)
305 gcov_write_block (gcov_var.offset);
308 #else /* IN_LIBGCOV */
310 /* Write a tag TAG and length LENGTH. */
313 gcov_write_tag_length (gcov_unsigned_t tag, gcov_unsigned_t length)
315 gcov_unsigned_t *buffer = gcov_write_bytes (8);
321 /* Write a summary structure to the gcov file. Return nonzero on
325 gcov_write_summary (gcov_unsigned_t tag, const struct gcov_summary *summary)
328 const struct gcov_ctr_summary *csum;
330 gcov_write_tag_length (tag, GCOV_TAG_SUMMARY_LENGTH);
331 gcov_write_unsigned (summary->checksum);
332 for (csum = summary->ctrs, ix = GCOV_COUNTERS_SUMMABLE; ix--; csum++)
334 gcov_write_unsigned (csum->num);
335 gcov_write_unsigned (csum->runs);
336 gcov_write_counter (csum->sum_all);
337 gcov_write_counter (csum->run_max);
338 gcov_write_counter (csum->sum_max);
341 #endif /* IN_LIBGCOV */
345 /* Return a pointer to read BYTES bytes from the gcov file. Returns
346 NULL on failure (read past EOF). */
348 static const gcov_unsigned_t *
349 gcov_read_bytes (unsigned bytes)
351 const gcov_unsigned_t *result;
352 unsigned excess = gcov_var.length - gcov_var.offset;
354 GCOV_CHECK_READING ();
355 GCOV_CHECK (!(bytes & 3));
358 gcov_var.start += gcov_var.offset;
362 GCOV_CHECK (excess == 4);
363 memcpy (gcov_var.buffer, gcov_var.buffer + gcov_var.offset, 4);
366 memmove (gcov_var.buffer, gcov_var.buffer + gcov_var.offset, excess);
369 gcov_var.length = excess;
371 GCOV_CHECK (!gcov_var.length || gcov_var.length == 4);
372 excess = GCOV_BLOCK_SIZE;
374 if (gcov_var.length + bytes > gcov_var.alloc)
375 gcov_allocate (gcov_var.length + bytes);
376 excess = gcov_var.alloc - gcov_var.length;
378 excess = fread (gcov_var.buffer + gcov_var.length,
379 1, excess, gcov_var.file);
380 gcov_var.length += excess;
381 if (gcov_var.length < bytes)
383 gcov_var.overread += bytes - gcov_var.length;
388 result = (gcov_unsigned_t *)&gcov_var.buffer[gcov_var.offset];
389 gcov_var.offset += bytes;
393 /* Read unsigned value from a coverage file. Sets error flag on file
394 error, overflow flag on overflow */
396 GCOV_LINKAGE gcov_unsigned_t
397 gcov_read_unsigned (void)
399 gcov_unsigned_t value;
400 const gcov_unsigned_t *buffer = gcov_read_bytes (4);
404 value = from_file (buffer[0]);
408 /* Read counter value from a coverage file. Sets error flag on file
409 error, overflow flag on overflow */
411 GCOV_LINKAGE gcov_type
412 gcov_read_counter (void)
415 const gcov_unsigned_t *buffer = gcov_read_bytes (8);
419 value = from_file (buffer[0]);
420 if (sizeof (value) > sizeof (gcov_unsigned_t))
421 value |= ((gcov_type) from_file (buffer[1])) << 32;
430 /* Read string from coverage file. Returns a pointer to a static
431 buffer, or NULL on empty string. You must copy the string before
432 calling another gcov function. */
435 GCOV_LINKAGE const char *
436 gcov_read_string (void)
438 unsigned length = gcov_read_unsigned ();
443 return (const char *) gcov_read_bytes (length);
448 gcov_read_summary (struct gcov_summary *summary)
451 struct gcov_ctr_summary *csum;
453 summary->checksum = gcov_read_unsigned ();
454 for (csum = summary->ctrs, ix = GCOV_COUNTERS_SUMMABLE; ix--; csum++)
456 csum->num = gcov_read_unsigned ();
457 csum->runs = gcov_read_unsigned ();
458 csum->sum_all = gcov_read_counter ();
459 csum->run_max = gcov_read_counter ();
460 csum->sum_max = gcov_read_counter ();
465 /* Reset to a known position. BASE should have been obtained from
466 gcov_position, LENGTH should be a record length. */
469 gcov_sync (gcov_position_t base, gcov_unsigned_t length)
471 GCOV_CHECK_READING ();
473 if (base - gcov_var.start <= gcov_var.length)
474 gcov_var.offset = base - gcov_var.start;
477 gcov_var.offset = gcov_var.length = 0;
478 fseek (gcov_var.file, base, SEEK_SET);
479 gcov_var.start = ftell (gcov_var.file);
485 /* Move to the a set position in a gcov file. BASE is zero to move to
486 the end, and nonzero to move to that position. */
489 gcov_seek (gcov_position_t base)
491 GCOV_CHECK_WRITING ();
493 gcov_write_block (gcov_var.offset);
494 fseek (gcov_var.file, base, base ? SEEK_SET : SEEK_END);
495 gcov_var.start = ftell (gcov_var.file);
500 /* Return the modification time of the current gcov file. */
507 if (fstat (fileno (gcov_var.file), &status))
510 return status.st_mtime;