1 /* File format for coverage information
2 Copyright (C) 1996, 1997, 1998, 2000, 2002, 2003, 2004, 2005
3 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, 51 Franklin Street, Fifth Floor, 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_words (unsigned);
31 static const gcov_unsigned_t *gcov_read_words (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)
70 s_flock.l_type = F_WRLCK;
71 s_flock.l_whence = SEEK_SET;
73 s_flock.l_len = 0; /* Until EOF. */
74 s_flock.l_pid = getpid ();
77 gcc_assert (!gcov_var.file);
79 gcov_var.offset = gcov_var.length = 0;
80 gcov_var.overread = -1u;
87 fd = open (name, O_RDWR);
89 fd = open (name, O_RDWR | O_CREAT, 0666);
93 while (fcntl (fd, F_SETLKW, &s_flock) && errno == EINTR)
96 gcov_var.file = fdopen (fd, "r+b");
109 if (fstat (fd, &st) < 0)
111 fclose (gcov_var.file);
118 gcov_var.mode = mode * 2 + 1;
121 gcov_var.mode = mode * 2 + 1;
124 gcov_var.file = fopen (name, "r+b");
129 gcov_var.file = fopen (name, "w+b");
131 gcov_var.mode = mode * 2 + 1;
137 setbuf (gcov_var.file, (char *)0);
142 /* Close the current gcov file. Flushes data to disk. Returns nonzero
143 on failure or error flag set. */
151 if (gcov_var.offset && gcov_var.mode < 0)
152 gcov_write_block (gcov_var.offset);
154 fclose (gcov_var.file);
159 free (gcov_var.buffer);
164 return gcov_var.error;
168 /* Check if MAGIC is EXPECTED. Use it to determine endianness of the
169 file. Returns +1 for same endian, -1 for other endian and zero for
173 gcov_magic (gcov_unsigned_t magic, gcov_unsigned_t expected)
175 if (magic == expected)
177 magic = (magic >> 16) | (magic << 16);
178 magic = ((magic & 0xff00ff) << 8) | ((magic >> 8) & 0xff00ff);
179 if (magic == expected)
190 gcov_allocate (unsigned length)
192 size_t new_size = gcov_var.alloc;
195 new_size = GCOV_BLOCK_SIZE;
199 gcov_var.alloc = new_size;
200 gcov_var.buffer = xrealloc (gcov_var.buffer, new_size << 2);
205 /* Write out the current block, if needs be. */
208 gcov_write_block (unsigned size)
210 if (fwrite (gcov_var.buffer, size << 2, 1, gcov_var.file) != 1)
212 gcov_var.start += size;
213 gcov_var.offset -= size;
216 /* Allocate space to write BYTES bytes to the gcov file. Return a
217 pointer to those bytes, or NULL on failure. */
219 static gcov_unsigned_t *
220 gcov_write_words (unsigned words)
222 gcov_unsigned_t *result;
224 gcc_assert (gcov_var.mode < 0);
226 if (gcov_var.offset >= GCOV_BLOCK_SIZE)
228 gcov_write_block (GCOV_BLOCK_SIZE);
231 gcc_assert (gcov_var.offset == 1);
232 memcpy (gcov_var.buffer, gcov_var.buffer + GCOV_BLOCK_SIZE, 4);
236 if (gcov_var.offset + words > gcov_var.alloc)
237 gcov_allocate (gcov_var.offset + words);
239 result = &gcov_var.buffer[gcov_var.offset];
240 gcov_var.offset += words;
245 /* Write unsigned VALUE to coverage file. Sets error flag
249 gcov_write_unsigned (gcov_unsigned_t value)
251 gcov_unsigned_t *buffer = gcov_write_words (1);
256 /* Write counter VALUE to coverage file. Sets error flag
261 gcov_write_counter (gcov_type value)
263 gcov_unsigned_t *buffer = gcov_write_words (2);
265 buffer[0] = (gcov_unsigned_t) value;
266 if (sizeof (value) > sizeof (gcov_unsigned_t))
267 buffer[1] = (gcov_unsigned_t) (value >> 32);
271 #endif /* IN_LIBGCOV */
274 /* Write STRING to coverage file. Sets error flag on file
275 error, overflow flag on overflow */
278 gcov_write_string (const char *string)
282 gcov_unsigned_t *buffer;
286 length = strlen (string);
287 alloc = (length + 4) >> 2;
290 buffer = gcov_write_words (1 + alloc);
294 memcpy (&buffer[1], string, length);
299 /* Write a tag TAG and reserve space for the record length. Return a
300 value to be used for gcov_write_length. */
302 GCOV_LINKAGE gcov_position_t
303 gcov_write_tag (gcov_unsigned_t tag)
305 gcov_position_t result = gcov_var.start + gcov_var.offset;
306 gcov_unsigned_t *buffer = gcov_write_words (2);
314 /* Write a record length using POSITION, which was returned by
315 gcov_write_tag. The current file position is the end of the
316 record, and is restored before returning. Returns nonzero on
320 gcov_write_length (gcov_position_t position)
323 gcov_unsigned_t length;
324 gcov_unsigned_t *buffer;
326 gcc_assert (gcov_var.mode < 0);
327 gcc_assert (position + 2 <= gcov_var.start + gcov_var.offset);
328 gcc_assert (position >= gcov_var.start);
329 offset = position - gcov_var.start;
330 length = gcov_var.offset - offset - 2;
331 buffer = (gcov_unsigned_t *) &gcov_var.buffer[offset];
333 if (gcov_var.offset >= GCOV_BLOCK_SIZE)
334 gcov_write_block (gcov_var.offset);
337 #else /* IN_LIBGCOV */
339 /* Write a tag TAG and length LENGTH. */
342 gcov_write_tag_length (gcov_unsigned_t tag, gcov_unsigned_t length)
344 gcov_unsigned_t *buffer = gcov_write_words (2);
350 /* Write a summary structure to the gcov file. Return nonzero on
354 gcov_write_summary (gcov_unsigned_t tag, const struct gcov_summary *summary)
357 const struct gcov_ctr_summary *csum;
359 gcov_write_tag_length (tag, GCOV_TAG_SUMMARY_LENGTH);
360 gcov_write_unsigned (summary->checksum);
361 for (csum = summary->ctrs, ix = GCOV_COUNTERS_SUMMABLE; ix--; csum++)
363 gcov_write_unsigned (csum->num);
364 gcov_write_unsigned (csum->runs);
365 gcov_write_counter (csum->sum_all);
366 gcov_write_counter (csum->run_max);
367 gcov_write_counter (csum->sum_max);
370 #endif /* IN_LIBGCOV */
374 /* Return a pointer to read BYTES bytes from the gcov file. Returns
375 NULL on failure (read past EOF). */
377 static const gcov_unsigned_t *
378 gcov_read_words (unsigned words)
380 const gcov_unsigned_t *result;
381 unsigned excess = gcov_var.length - gcov_var.offset;
383 gcc_assert (gcov_var.mode > 0);
386 gcov_var.start += gcov_var.offset;
390 gcc_assert (excess == 1);
391 memcpy (gcov_var.buffer, gcov_var.buffer + gcov_var.offset, 4);
394 memmove (gcov_var.buffer, gcov_var.buffer + gcov_var.offset, excess * 4);
397 gcov_var.length = excess;
399 gcc_assert (!gcov_var.length || gcov_var.length == 1);
400 excess = GCOV_BLOCK_SIZE;
402 if (gcov_var.length + words > gcov_var.alloc)
403 gcov_allocate (gcov_var.length + words);
404 excess = gcov_var.alloc - gcov_var.length;
406 excess = fread (gcov_var.buffer + gcov_var.length,
407 1, excess << 2, gcov_var.file) >> 2;
408 gcov_var.length += excess;
409 if (gcov_var.length < words)
411 gcov_var.overread += words - gcov_var.length;
416 result = &gcov_var.buffer[gcov_var.offset];
417 gcov_var.offset += words;
421 /* Read unsigned value from a coverage file. Sets error flag on file
422 error, overflow flag on overflow */
424 GCOV_LINKAGE gcov_unsigned_t
425 gcov_read_unsigned (void)
427 gcov_unsigned_t value;
428 const gcov_unsigned_t *buffer = gcov_read_words (1);
432 value = from_file (buffer[0]);
436 /* Read counter value from a coverage file. Sets error flag on file
437 error, overflow flag on overflow */
439 GCOV_LINKAGE gcov_type
440 gcov_read_counter (void)
443 const gcov_unsigned_t *buffer = gcov_read_words (2);
447 value = from_file (buffer[0]);
448 if (sizeof (value) > sizeof (gcov_unsigned_t))
449 value |= ((gcov_type) from_file (buffer[1])) << 32;
456 /* Read string from coverage file. Returns a pointer to a static
457 buffer, or NULL on empty string. You must copy the string before
458 calling another gcov function. */
461 GCOV_LINKAGE const char *
462 gcov_read_string (void)
464 unsigned length = gcov_read_unsigned ();
469 return (const char *) gcov_read_words (length);
474 gcov_read_summary (struct gcov_summary *summary)
477 struct gcov_ctr_summary *csum;
479 summary->checksum = gcov_read_unsigned ();
480 for (csum = summary->ctrs, ix = GCOV_COUNTERS_SUMMABLE; ix--; csum++)
482 csum->num = gcov_read_unsigned ();
483 csum->runs = gcov_read_unsigned ();
484 csum->sum_all = gcov_read_counter ();
485 csum->run_max = gcov_read_counter ();
486 csum->sum_max = gcov_read_counter ();
491 /* Reset to a known position. BASE should have been obtained from
492 gcov_position, LENGTH should be a record length. */
495 gcov_sync (gcov_position_t base, gcov_unsigned_t length)
497 gcc_assert (gcov_var.mode > 0);
499 if (base - gcov_var.start <= gcov_var.length)
500 gcov_var.offset = base - gcov_var.start;
503 gcov_var.offset = gcov_var.length = 0;
504 fseek (gcov_var.file, base << 2, SEEK_SET);
505 gcov_var.start = ftell (gcov_var.file) >> 2;
511 /* Move to the a set position in a gcov file. */
514 gcov_seek (gcov_position_t base)
516 gcc_assert (gcov_var.mode < 0);
518 gcov_write_block (gcov_var.offset);
519 fseek (gcov_var.file, base << 2, SEEK_SET);
520 gcov_var.start = ftell (gcov_var.file) >> 2;
525 /* Return the modification time of the current gcov file. */
532 if (fstat (fileno (gcov_var.file), &status))
535 return status.st_mtime;