PR c++/86342 - -Wdeprecated-copy and system headers.
[official-gcc.git] / gcc / gcov-io.c
blobe07ae76420bf321984023ad5b6449fdd23f95c5d
1 /* File format for coverage information
2 Copyright (C) 1996-2018 Free Software Foundation, Inc.
3 Contributed by Bob Manson <manson@cygnus.com>.
4 Completely remangled by Nathan Sidwell <nathan@codesourcery.com>.
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 3, or (at your option) any later
11 version.
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 for more details.
18 Under Section 7 of GPL version 3, you are granted additional
19 permissions described in the GCC Runtime Library Exception, version
20 3.1, as published by the Free Software Foundation.
22 You should have received a copy of the GNU General Public License and
23 a copy of the GCC Runtime Library Exception along with this program;
24 see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
25 <http://www.gnu.org/licenses/>. */
27 /* Routines declared in gcov-io.h. This file should be #included by
28 another source file, after having #included gcov-io.h. */
30 #if !IN_GCOV
31 static void gcov_write_block (unsigned);
32 static gcov_unsigned_t *gcov_write_words (unsigned);
33 #endif
34 static const gcov_unsigned_t *gcov_read_words (unsigned);
35 #if !IN_LIBGCOV
36 static void gcov_allocate (unsigned);
37 #endif
39 /* Optimum number of gcov_unsigned_t's read from or written to disk. */
40 #define GCOV_BLOCK_SIZE (1 << 10)
42 struct gcov_var
44 FILE *file;
45 gcov_position_t start; /* Position of first byte of block */
46 unsigned offset; /* Read/write position within the block. */
47 unsigned length; /* Read limit in the block. */
48 unsigned overread; /* Number of words overread. */
49 int error; /* < 0 overflow, > 0 disk error. */
50 int mode; /* < 0 writing, > 0 reading */
51 #if IN_LIBGCOV
52 /* Holds one block plus 4 bytes, thus all coverage reads & writes
53 fit within this buffer and we always can transfer GCOV_BLOCK_SIZE
54 to and from the disk. libgcov never backtracks and only writes 4
55 or 8 byte objects. */
56 gcov_unsigned_t buffer[GCOV_BLOCK_SIZE + 1];
57 #else
58 int endian; /* Swap endianness. */
59 /* Holds a variable length block, as the compiler can write
60 strings and needs to backtrack. */
61 size_t alloc;
62 gcov_unsigned_t *buffer;
63 #endif
64 } gcov_var;
66 /* Save the current position in the gcov file. */
67 /* We need to expose this function when compiling for gcov-tool. */
68 #ifndef IN_GCOV_TOOL
69 static inline
70 #endif
71 gcov_position_t
72 gcov_position (void)
74 gcov_nonruntime_assert (gcov_var.mode > 0);
75 return gcov_var.start + gcov_var.offset;
78 /* Return nonzero if the error flag is set. */
79 /* We need to expose this function when compiling for gcov-tool. */
80 #ifndef IN_GCOV_TOOL
81 static inline
82 #endif
83 int
84 gcov_is_error (void)
86 return gcov_var.file ? gcov_var.error : 1;
89 #if IN_LIBGCOV
90 /* Move to beginning of file and initialize for writing. */
91 GCOV_LINKAGE inline void
92 gcov_rewrite (void)
94 gcov_var.mode = -1;
95 gcov_var.start = 0;
96 gcov_var.offset = 0;
97 fseek (gcov_var.file, 0L, SEEK_SET);
99 #endif
101 static inline gcov_unsigned_t from_file (gcov_unsigned_t value)
103 #if !IN_LIBGCOV
104 if (gcov_var.endian)
106 value = (value >> 16) | (value << 16);
107 value = ((value & 0xff00ff) << 8) | ((value >> 8) & 0xff00ff);
109 #endif
110 return value;
113 /* Open a gcov file. NAME is the name of the file to open and MODE
114 indicates whether a new file should be created, or an existing file
115 opened. If MODE is >= 0 an existing file will be opened, if
116 possible, and if MODE is <= 0, a new file will be created. Use
117 MODE=0 to attempt to reopen an existing file and then fall back on
118 creating a new one. If MODE > 0, the file will be opened in
119 read-only mode. Otherwise it will be opened for modification.
120 Return zero on failure, non-zero on success. */
122 GCOV_LINKAGE int
123 #if IN_LIBGCOV
124 gcov_open (const char *name)
125 #else
126 gcov_open (const char *name, int mode)
127 #endif
129 #if IN_LIBGCOV
130 int mode = 0;
131 #endif
132 #if GCOV_LOCKED
133 struct flock s_flock;
134 int fd;
136 s_flock.l_whence = SEEK_SET;
137 s_flock.l_start = 0;
138 s_flock.l_len = 0; /* Until EOF. */
139 s_flock.l_pid = getpid ();
140 #endif
142 gcov_nonruntime_assert (!gcov_var.file);
143 gcov_var.start = 0;
144 gcov_var.offset = gcov_var.length = 0;
145 gcov_var.overread = -1u;
146 gcov_var.error = 0;
147 #if !IN_LIBGCOV
148 gcov_var.endian = 0;
149 #endif
150 #if GCOV_LOCKED
151 if (mode > 0)
153 /* Read-only mode - acquire a read-lock. */
154 s_flock.l_type = F_RDLCK;
155 /* pass mode (ignored) for compatibility */
156 fd = open (name, O_RDONLY, S_IRUSR | S_IWUSR);
158 else
160 /* Write mode - acquire a write-lock. */
161 s_flock.l_type = F_WRLCK;
162 /* Truncate if force new mode. */
163 fd = open (name, O_RDWR | O_CREAT | (mode < 0 ? O_TRUNC : 0), 0666);
165 if (fd < 0)
166 return 0;
168 while (fcntl (fd, F_SETLKW, &s_flock) && errno == EINTR)
169 continue;
171 gcov_var.file = fdopen (fd, (mode > 0) ? "rb" : "r+b");
173 if (!gcov_var.file)
175 close (fd);
176 return 0;
178 #else
179 if (mode >= 0)
180 /* Open an existing file. */
181 gcov_var.file = fopen (name, (mode > 0) ? "rb" : "r+b");
183 if (gcov_var.file)
184 mode = 1;
185 else if (mode <= 0)
186 /* Create a new file. */
187 gcov_var.file = fopen (name, "w+b");
189 if (!gcov_var.file)
190 return 0;
191 #endif
193 gcov_var.mode = mode ? mode : 1;
195 setbuf (gcov_var.file, (char *)0);
197 return 1;
200 /* Close the current gcov file. Flushes data to disk. Returns nonzero
201 on failure or error flag set. */
203 GCOV_LINKAGE int
204 gcov_close (void)
206 if (gcov_var.file)
208 #if !IN_GCOV
209 if (gcov_var.offset && gcov_var.mode < 0)
210 gcov_write_block (gcov_var.offset);
211 #endif
212 fclose (gcov_var.file);
213 gcov_var.file = 0;
214 gcov_var.length = 0;
216 #if !IN_LIBGCOV
217 free (gcov_var.buffer);
218 gcov_var.alloc = 0;
219 gcov_var.buffer = 0;
220 #endif
221 gcov_var.mode = 0;
222 return gcov_var.error;
225 #if !IN_LIBGCOV
226 /* Check if MAGIC is EXPECTED. Use it to determine endianness of the
227 file. Returns +1 for same endian, -1 for other endian and zero for
228 not EXPECTED. */
230 GCOV_LINKAGE int
231 gcov_magic (gcov_unsigned_t magic, gcov_unsigned_t expected)
233 if (magic == expected)
234 return 1;
235 magic = (magic >> 16) | (magic << 16);
236 magic = ((magic & 0xff00ff) << 8) | ((magic >> 8) & 0xff00ff);
237 if (magic == expected)
239 gcov_var.endian = 1;
240 return -1;
242 return 0;
244 #endif
246 #if !IN_LIBGCOV
247 static void
248 gcov_allocate (unsigned length)
250 size_t new_size = gcov_var.alloc;
252 if (!new_size)
253 new_size = GCOV_BLOCK_SIZE;
254 new_size += length;
255 new_size *= 2;
257 gcov_var.alloc = new_size;
258 gcov_var.buffer = XRESIZEVAR (gcov_unsigned_t, gcov_var.buffer, new_size << 2);
260 #endif
262 #if !IN_GCOV
263 /* Write out the current block, if needs be. */
265 static void
266 gcov_write_block (unsigned size)
268 if (fwrite (gcov_var.buffer, size << 2, 1, gcov_var.file) != 1)
269 gcov_var.error = 1;
270 gcov_var.start += size;
271 gcov_var.offset -= size;
274 /* Allocate space to write BYTES bytes to the gcov file. Return a
275 pointer to those bytes, or NULL on failure. */
277 static gcov_unsigned_t *
278 gcov_write_words (unsigned words)
280 gcov_unsigned_t *result;
282 gcov_nonruntime_assert (gcov_var.mode < 0);
283 #if IN_LIBGCOV
284 if (gcov_var.offset >= GCOV_BLOCK_SIZE)
286 gcov_write_block (GCOV_BLOCK_SIZE);
287 if (gcov_var.offset)
289 memcpy (gcov_var.buffer, gcov_var.buffer + GCOV_BLOCK_SIZE, 4);
292 #else
293 if (gcov_var.offset + words > gcov_var.alloc)
294 gcov_allocate (gcov_var.offset + words);
295 #endif
296 result = &gcov_var.buffer[gcov_var.offset];
297 gcov_var.offset += words;
299 return result;
302 /* Write unsigned VALUE to coverage file. Sets error flag
303 appropriately. */
305 GCOV_LINKAGE void
306 gcov_write_unsigned (gcov_unsigned_t value)
308 gcov_unsigned_t *buffer = gcov_write_words (1);
310 buffer[0] = value;
313 /* Write counter VALUE to coverage file. Sets error flag
314 appropriately. */
316 #if IN_LIBGCOV
317 GCOV_LINKAGE void
318 gcov_write_counter (gcov_type value)
320 gcov_unsigned_t *buffer = gcov_write_words (2);
322 buffer[0] = (gcov_unsigned_t) value;
323 if (sizeof (value) > sizeof (gcov_unsigned_t))
324 buffer[1] = (gcov_unsigned_t) (value >> 32);
325 else
326 buffer[1] = 0;
328 #endif /* IN_LIBGCOV */
330 #if !IN_LIBGCOV
331 /* Write STRING to coverage file. Sets error flag on file
332 error, overflow flag on overflow */
334 GCOV_LINKAGE void
335 gcov_write_string (const char *string)
337 unsigned length = 0;
338 unsigned alloc = 0;
339 gcov_unsigned_t *buffer;
341 if (string)
343 length = strlen (string);
344 alloc = (length + 4) >> 2;
347 buffer = gcov_write_words (1 + alloc);
349 buffer[0] = alloc;
351 if (alloc > 0)
353 buffer[alloc] = 0; /* place nul terminators. */
354 memcpy (&buffer[1], string, length);
357 #endif
359 #if !IN_LIBGCOV
360 /* Write FILENAME to coverage file. Sets error flag on file
361 error, overflow flag on overflow */
363 GCOV_LINKAGE void
364 gcov_write_filename (const char *filename)
366 if (profile_abs_path_flag && filename && filename[0]
367 && !(IS_DIR_SEPARATOR (filename[0])
368 #if HAVE_DOS_BASED_FILE_SYSTEM
369 || filename[1] == ':'
370 #endif
373 char *buf = getcwd (NULL, 0);
374 if (buf != NULL && buf[0])
376 size_t len = strlen (buf);
377 buf = (char*)xrealloc (buf, len + strlen (filename) + 2);
378 if (!IS_DIR_SEPARATOR (buf[len - 1]))
379 strcat (buf, "/");
380 strcat (buf, filename);
381 gcov_write_string (buf);
382 free (buf);
383 return;
387 gcov_write_string (filename);
389 #endif
391 #if !IN_LIBGCOV
392 /* Write a tag TAG and reserve space for the record length. Return a
393 value to be used for gcov_write_length. */
395 GCOV_LINKAGE gcov_position_t
396 gcov_write_tag (gcov_unsigned_t tag)
398 gcov_position_t result = gcov_var.start + gcov_var.offset;
399 gcov_unsigned_t *buffer = gcov_write_words (2);
401 buffer[0] = tag;
402 buffer[1] = 0;
404 return result;
407 /* Write a record length using POSITION, which was returned by
408 gcov_write_tag. The current file position is the end of the
409 record, and is restored before returning. Returns nonzero on
410 overflow. */
412 GCOV_LINKAGE void
413 gcov_write_length (gcov_position_t position)
415 unsigned offset;
416 gcov_unsigned_t length;
417 gcov_unsigned_t *buffer;
419 gcov_nonruntime_assert (gcov_var.mode < 0);
420 gcov_nonruntime_assert (position + 2 <= gcov_var.start + gcov_var.offset);
421 gcov_nonruntime_assert (position >= gcov_var.start);
422 offset = position - gcov_var.start;
423 length = gcov_var.offset - offset - 2;
424 buffer = (gcov_unsigned_t *) &gcov_var.buffer[offset];
425 buffer[1] = length;
426 if (gcov_var.offset >= GCOV_BLOCK_SIZE)
427 gcov_write_block (gcov_var.offset);
430 #else /* IN_LIBGCOV */
432 /* Write a tag TAG and length LENGTH. */
434 GCOV_LINKAGE void
435 gcov_write_tag_length (gcov_unsigned_t tag, gcov_unsigned_t length)
437 gcov_unsigned_t *buffer = gcov_write_words (2);
439 buffer[0] = tag;
440 buffer[1] = length;
443 /* Write a summary structure to the gcov file. Return nonzero on
444 overflow. */
446 GCOV_LINKAGE void
447 gcov_write_summary (gcov_unsigned_t tag, const struct gcov_summary *summary)
449 unsigned h_ix, bv_ix, h_cnt = 0;
450 unsigned histo_bitvector[GCOV_HISTOGRAM_BITVECTOR_SIZE];
452 /* Count number of non-zero histogram entries, and fill in a bit vector
453 of non-zero indices. The histogram is only currently computed for arc
454 counters. */
455 for (bv_ix = 0; bv_ix < GCOV_HISTOGRAM_BITVECTOR_SIZE; bv_ix++)
456 histo_bitvector[bv_ix] = 0;
457 for (h_ix = 0; h_ix < GCOV_HISTOGRAM_SIZE; h_ix++)
458 if (summary->histogram[h_ix].num_counters)
460 histo_bitvector[h_ix / 32] |= 1 << (h_ix % 32);
461 h_cnt++;
463 gcov_write_tag_length (tag, GCOV_TAG_SUMMARY_LENGTH (h_cnt));
464 gcov_write_unsigned (summary->checksum);
466 gcov_write_unsigned (summary->num);
467 gcov_write_unsigned (summary->runs);
468 gcov_write_counter (summary->sum_all);
469 gcov_write_counter (summary->run_max);
470 gcov_write_counter (summary->sum_max);
471 for (bv_ix = 0; bv_ix < GCOV_HISTOGRAM_BITVECTOR_SIZE; bv_ix++)
472 gcov_write_unsigned (histo_bitvector[bv_ix]);
473 for (h_ix = 0; h_ix < GCOV_HISTOGRAM_SIZE; h_ix++)
475 if (!summary->histogram[h_ix].num_counters)
476 continue;
477 gcov_write_unsigned (summary->histogram[h_ix].num_counters);
478 gcov_write_counter (summary->histogram[h_ix].min_value);
479 gcov_write_counter (summary->histogram[h_ix].cum_value);
482 #endif /* IN_LIBGCOV */
484 #endif /*!IN_GCOV */
486 /* Return a pointer to read BYTES bytes from the gcov file. Returns
487 NULL on failure (read past EOF). */
489 static const gcov_unsigned_t *
490 gcov_read_words (unsigned words)
492 const gcov_unsigned_t *result;
493 unsigned excess = gcov_var.length - gcov_var.offset;
495 if (gcov_var.mode <= 0)
496 return NULL;
498 if (excess < words)
500 gcov_var.start += gcov_var.offset;
501 if (excess)
503 #if IN_LIBGCOV
504 memcpy (gcov_var.buffer, gcov_var.buffer + gcov_var.offset, 4);
505 #else
506 memmove (gcov_var.buffer, gcov_var.buffer + gcov_var.offset,
507 excess * 4);
508 #endif
510 gcov_var.offset = 0;
511 gcov_var.length = excess;
512 #if IN_LIBGCOV
513 excess = GCOV_BLOCK_SIZE;
514 #else
515 if (gcov_var.length + words > gcov_var.alloc)
516 gcov_allocate (gcov_var.length + words);
517 excess = gcov_var.alloc - gcov_var.length;
518 #endif
519 excess = fread (gcov_var.buffer + gcov_var.length,
520 1, excess << 2, gcov_var.file) >> 2;
521 gcov_var.length += excess;
522 if (gcov_var.length < words)
524 gcov_var.overread += words - gcov_var.length;
525 gcov_var.length = 0;
526 return 0;
529 result = &gcov_var.buffer[gcov_var.offset];
530 gcov_var.offset += words;
531 return result;
534 /* Read unsigned value from a coverage file. Sets error flag on file
535 error, overflow flag on overflow */
537 GCOV_LINKAGE gcov_unsigned_t
538 gcov_read_unsigned (void)
540 gcov_unsigned_t value;
541 const gcov_unsigned_t *buffer = gcov_read_words (1);
543 if (!buffer)
544 return 0;
545 value = from_file (buffer[0]);
546 return value;
549 /* Read counter value from a coverage file. Sets error flag on file
550 error, overflow flag on overflow */
552 GCOV_LINKAGE gcov_type
553 gcov_read_counter (void)
555 gcov_type value;
556 const gcov_unsigned_t *buffer = gcov_read_words (2);
558 if (!buffer)
559 return 0;
560 value = from_file (buffer[0]);
561 if (sizeof (value) > sizeof (gcov_unsigned_t))
562 value |= ((gcov_type) from_file (buffer[1])) << 32;
563 else if (buffer[1])
564 gcov_var.error = -1;
566 return value;
569 /* We need to expose the below function when compiling for gcov-tool. */
571 #if !IN_LIBGCOV || defined (IN_GCOV_TOOL)
572 /* Read string from coverage file. Returns a pointer to a static
573 buffer, or NULL on empty string. You must copy the string before
574 calling another gcov function. */
576 GCOV_LINKAGE const char *
577 gcov_read_string (void)
579 unsigned length = gcov_read_unsigned ();
581 if (!length)
582 return 0;
584 return (const char *) gcov_read_words (length);
586 #endif
588 GCOV_LINKAGE void
589 gcov_read_summary (struct gcov_summary *summary)
591 unsigned h_ix, bv_ix, h_cnt = 0;
592 unsigned histo_bitvector[GCOV_HISTOGRAM_BITVECTOR_SIZE];
593 unsigned cur_bitvector;
595 summary->checksum = gcov_read_unsigned ();
596 summary->num = gcov_read_unsigned ();
597 summary->runs = gcov_read_unsigned ();
598 summary->sum_all = gcov_read_counter ();
599 summary->run_max = gcov_read_counter ();
600 summary->sum_max = gcov_read_counter ();
601 memset (summary->histogram, 0,
602 sizeof (gcov_bucket_type) * GCOV_HISTOGRAM_SIZE);
603 for (bv_ix = 0; bv_ix < GCOV_HISTOGRAM_BITVECTOR_SIZE; bv_ix++)
605 histo_bitvector[bv_ix] = gcov_read_unsigned ();
606 #if IN_LIBGCOV
607 /* When building libgcov we don't include system.h, which includes
608 hwint.h (where popcount_hwi is declared). However, libgcov.a
609 is built by the bootstrapped compiler and therefore the builtins
610 are always available. */
611 h_cnt += __builtin_popcount (histo_bitvector[bv_ix]);
612 #else
613 h_cnt += popcount_hwi (histo_bitvector[bv_ix]);
614 #endif
616 bv_ix = 0;
617 h_ix = 0;
618 cur_bitvector = 0;
619 while (h_cnt--)
621 /* Find the index corresponding to the next entry we will read in.
622 First find the next non-zero bitvector and re-initialize
623 the histogram index accordingly, then right shift and increment
624 the index until we find a set bit. */
625 while (!cur_bitvector)
627 h_ix = bv_ix * 32;
628 if (bv_ix >= GCOV_HISTOGRAM_BITVECTOR_SIZE)
629 gcov_error ("corrupted profile info: summary histogram "
630 "bitvector is corrupt");
631 cur_bitvector = histo_bitvector[bv_ix++];
633 while (!(cur_bitvector & 0x1))
635 h_ix++;
636 cur_bitvector >>= 1;
638 if (h_ix >= GCOV_HISTOGRAM_SIZE)
639 gcov_error ("corrupted profile info: summary histogram "
640 "index is corrupt");
642 summary->histogram[h_ix].num_counters = gcov_read_unsigned ();
643 summary->histogram[h_ix].min_value = gcov_read_counter ();
644 summary->histogram[h_ix].cum_value = gcov_read_counter ();
645 /* Shift off the index we are done with and increment to the
646 corresponding next histogram entry. */
647 cur_bitvector >>= 1;
648 h_ix++;
652 /* We need to expose the below function when compiling for gcov-tool. */
654 #if !IN_LIBGCOV || defined (IN_GCOV_TOOL)
655 /* Reset to a known position. BASE should have been obtained from
656 gcov_position, LENGTH should be a record length. */
658 GCOV_LINKAGE void
659 gcov_sync (gcov_position_t base, gcov_unsigned_t length)
661 gcov_nonruntime_assert (gcov_var.mode > 0);
662 base += length;
663 if (base - gcov_var.start <= gcov_var.length)
664 gcov_var.offset = base - gcov_var.start;
665 else
667 gcov_var.offset = gcov_var.length = 0;
668 fseek (gcov_var.file, base << 2, SEEK_SET);
669 gcov_var.start = ftell (gcov_var.file) >> 2;
672 #endif
674 #if IN_LIBGCOV
675 /* Move to a given position in a gcov file. */
677 GCOV_LINKAGE void
678 gcov_seek (gcov_position_t base)
680 if (gcov_var.offset)
681 gcov_write_block (gcov_var.offset);
682 fseek (gcov_var.file, base << 2, SEEK_SET);
683 gcov_var.start = ftell (gcov_var.file) >> 2;
685 #endif
687 #if IN_GCOV > 0
688 /* Return the modification time of the current gcov file. */
690 GCOV_LINKAGE time_t
691 gcov_time (void)
693 struct stat status;
695 if (fstat (fileno (gcov_var.file), &status))
696 return 0;
697 else
698 return status.st_mtime;
700 #endif /* IN_GCOV */
702 #if !IN_GCOV
703 /* Determine the index into histogram for VALUE. */
705 #if IN_LIBGCOV
706 static unsigned
707 #else
708 GCOV_LINKAGE unsigned
709 #endif
710 gcov_histo_index (gcov_type value)
712 gcov_type_unsigned v = (gcov_type_unsigned)value;
713 unsigned r = 0;
714 unsigned prev2bits = 0;
716 /* Find index into log2 scale histogram, where each of the log2
717 sized buckets is divided into 4 linear sub-buckets for better
718 focus in the higher buckets. */
720 /* Find the place of the most-significant bit set. */
721 if (v > 0)
723 #if IN_LIBGCOV
724 /* When building libgcov we don't include system.h, which includes
725 hwint.h (where floor_log2 is declared). However, libgcov.a
726 is built by the bootstrapped compiler and therefore the builtins
727 are always available. */
728 r = sizeof (long long) * __CHAR_BIT__ - 1 - __builtin_clzll (v);
729 #else
730 /* We use floor_log2 from hwint.c, which takes a HOST_WIDE_INT
731 that is 64 bits and gcov_type_unsigned is 64 bits. */
732 r = floor_log2 (v);
733 #endif
736 /* If at most the 2 least significant bits are set (value is
737 0 - 3) then that value is our index into the lowest set of
738 four buckets. */
739 if (r < 2)
740 return (unsigned)value;
742 gcov_nonruntime_assert (r < 64);
744 /* Find the two next most significant bits to determine which
745 of the four linear sub-buckets to select. */
746 prev2bits = (v >> (r - 2)) & 0x3;
747 /* Finally, compose the final bucket index from the log2 index and
748 the next 2 bits. The minimum r value at this point is 2 since we
749 returned above if r was 2 or more, so the minimum bucket at this
750 point is 4. */
751 return (r - 1) * 4 + prev2bits;
754 /* Merge SRC_HISTO into TGT_HISTO. The counters are assumed to be in
755 the same relative order in both histograms, and are matched up
756 and merged in reverse order. Each counter is assigned an equal portion of
757 its entry's original cumulative counter value when computing the
758 new merged cum_value. */
760 static void gcov_histogram_merge (gcov_bucket_type *tgt_histo,
761 gcov_bucket_type *src_histo)
763 int src_i, tgt_i, tmp_i = 0;
764 unsigned src_num, tgt_num, merge_num;
765 gcov_type src_cum, tgt_cum, merge_src_cum, merge_tgt_cum, merge_cum;
766 gcov_type merge_min;
767 gcov_bucket_type tmp_histo[GCOV_HISTOGRAM_SIZE];
768 int src_done = 0;
770 memset (tmp_histo, 0, sizeof (gcov_bucket_type) * GCOV_HISTOGRAM_SIZE);
772 /* Assume that the counters are in the same relative order in both
773 histograms. Walk the histograms from largest to smallest entry,
774 matching up and combining counters in order. */
775 src_num = 0;
776 src_cum = 0;
777 src_i = GCOV_HISTOGRAM_SIZE - 1;
778 for (tgt_i = GCOV_HISTOGRAM_SIZE - 1; tgt_i >= 0 && !src_done; tgt_i--)
780 tgt_num = tgt_histo[tgt_i].num_counters;
781 tgt_cum = tgt_histo[tgt_i].cum_value;
782 /* Keep going until all of the target histogram's counters at this
783 position have been matched and merged with counters from the
784 source histogram. */
785 while (tgt_num > 0 && !src_done)
787 /* If this is either the first time through this loop or we just
788 exhausted the previous non-zero source histogram entry, look
789 for the next non-zero source histogram entry. */
790 if (!src_num)
792 /* Locate the next non-zero entry. */
793 while (src_i >= 0 && !src_histo[src_i].num_counters)
794 src_i--;
795 /* If source histogram has fewer counters, then just copy over the
796 remaining target counters and quit. */
797 if (src_i < 0)
799 tmp_histo[tgt_i].num_counters += tgt_num;
800 tmp_histo[tgt_i].cum_value += tgt_cum;
801 if (!tmp_histo[tgt_i].min_value ||
802 tgt_histo[tgt_i].min_value < tmp_histo[tgt_i].min_value)
803 tmp_histo[tgt_i].min_value = tgt_histo[tgt_i].min_value;
804 while (--tgt_i >= 0)
806 tmp_histo[tgt_i].num_counters
807 += tgt_histo[tgt_i].num_counters;
808 tmp_histo[tgt_i].cum_value += tgt_histo[tgt_i].cum_value;
809 if (!tmp_histo[tgt_i].min_value ||
810 tgt_histo[tgt_i].min_value
811 < tmp_histo[tgt_i].min_value)
812 tmp_histo[tgt_i].min_value = tgt_histo[tgt_i].min_value;
815 src_done = 1;
816 break;
819 src_num = src_histo[src_i].num_counters;
820 src_cum = src_histo[src_i].cum_value;
823 /* The number of counters to merge on this pass is the minimum
824 of the remaining counters from the current target and source
825 histogram entries. */
826 merge_num = tgt_num;
827 if (src_num < merge_num)
828 merge_num = src_num;
830 /* The merged min_value is the sum of the min_values from target
831 and source. */
832 merge_min = tgt_histo[tgt_i].min_value + src_histo[src_i].min_value;
834 /* Compute the portion of source and target entries' cum_value
835 that will be apportioned to the counters being merged.
836 The total remaining cum_value from each entry is divided
837 equally among the counters from that histogram entry if we
838 are not merging all of them. */
839 merge_src_cum = src_cum;
840 if (merge_num < src_num)
841 merge_src_cum = merge_num * src_cum / src_num;
842 merge_tgt_cum = tgt_cum;
843 if (merge_num < tgt_num)
844 merge_tgt_cum = merge_num * tgt_cum / tgt_num;
845 /* The merged cum_value is the sum of the source and target
846 components. */
847 merge_cum = merge_src_cum + merge_tgt_cum;
849 /* Update the remaining number of counters and cum_value left
850 to be merged from this source and target entry. */
851 src_cum -= merge_src_cum;
852 tgt_cum -= merge_tgt_cum;
853 src_num -= merge_num;
854 tgt_num -= merge_num;
856 /* The merged counters get placed in the new merged histogram
857 at the entry for the merged min_value. */
858 tmp_i = gcov_histo_index (merge_min);
859 gcov_nonruntime_assert (tmp_i < GCOV_HISTOGRAM_SIZE);
860 tmp_histo[tmp_i].num_counters += merge_num;
861 tmp_histo[tmp_i].cum_value += merge_cum;
862 if (!tmp_histo[tmp_i].min_value ||
863 merge_min < tmp_histo[tmp_i].min_value)
864 tmp_histo[tmp_i].min_value = merge_min;
866 /* Ensure the search for the next non-zero src_histo entry starts
867 at the next smallest histogram bucket. */
868 if (!src_num)
869 src_i--;
873 gcov_nonruntime_assert (tgt_i < 0);
875 /* In the case where there were more counters in the source histogram,
876 accumulate the remaining unmerged cumulative counter values. Add
877 those to the smallest non-zero target histogram entry. Otherwise,
878 the total cumulative counter values in the histogram will be smaller
879 than the sum_all stored in the summary, which will complicate
880 computing the working set information from the histogram later on. */
881 if (src_num)
882 src_i--;
883 while (src_i >= 0)
885 src_cum += src_histo[src_i].cum_value;
886 src_i--;
888 /* At this point, tmp_i should be the smallest non-zero entry in the
889 tmp_histo. */
890 gcov_nonruntime_assert (tmp_i >= 0 && tmp_i < GCOV_HISTOGRAM_SIZE
891 && tmp_histo[tmp_i].num_counters > 0);
892 tmp_histo[tmp_i].cum_value += src_cum;
894 /* Finally, copy the merged histogram into tgt_histo. */
895 memcpy (tgt_histo, tmp_histo,
896 sizeof (gcov_bucket_type) * GCOV_HISTOGRAM_SIZE);
898 #endif /* !IN_GCOV */
900 /* This is used by gcov-dump (IN_GCOV == -1) and in the compiler
901 (!IN_GCOV && !IN_LIBGCOV). */
902 #if IN_GCOV <= 0 && !IN_LIBGCOV
903 /* Compute the working set information from the counter histogram in
904 the profile summary. This is an array of information corresponding to a
905 range of percentages of the total execution count (sum_all), and includes
906 the number of counters required to cover that working set percentage and
907 the minimum counter value in that working set. */
909 GCOV_LINKAGE void
910 compute_working_sets (const gcov_summary *summary,
911 gcov_working_set_t *gcov_working_sets)
913 gcov_type working_set_cum_values[NUM_GCOV_WORKING_SETS];
914 gcov_type ws_cum_hotness_incr;
915 gcov_type cum, tmp_cum;
916 const gcov_bucket_type *histo_bucket;
917 unsigned ws_ix, c_num, count;
918 int h_ix;
920 /* Compute the amount of sum_all that the cumulative hotness grows
921 by in each successive working set entry, which depends on the
922 number of working set entries. */
923 ws_cum_hotness_incr = summary->sum_all / NUM_GCOV_WORKING_SETS;
925 /* Next fill in an array of the cumulative hotness values corresponding
926 to each working set summary entry we are going to compute below.
927 Skip 0% statistics, which can be extrapolated from the
928 rest of the summary data. */
929 cum = ws_cum_hotness_incr;
930 for (ws_ix = 0; ws_ix < NUM_GCOV_WORKING_SETS;
931 ws_ix++, cum += ws_cum_hotness_incr)
932 working_set_cum_values[ws_ix] = cum;
933 /* The last summary entry is reserved for (roughly) 99.9% of the
934 working set. Divide by 1024 so it becomes a shift, which gives
935 almost exactly 99.9%. */
936 working_set_cum_values[NUM_GCOV_WORKING_SETS-1]
937 = summary->sum_all - summary->sum_all/1024;
939 /* Next, walk through the histogram in decending order of hotness
940 and compute the statistics for the working set summary array.
941 As histogram entries are accumulated, we check to see which
942 working set entries have had their expected cum_value reached
943 and fill them in, walking the working set entries in increasing
944 size of cum_value. */
945 ws_ix = 0; /* The current entry into the working set array. */
946 cum = 0; /* The current accumulated counter sum. */
947 count = 0; /* The current accumulated count of block counters. */
948 for (h_ix = GCOV_HISTOGRAM_SIZE - 1;
949 h_ix >= 0 && ws_ix < NUM_GCOV_WORKING_SETS; h_ix--)
951 histo_bucket = &summary->histogram[h_ix];
953 /* If we haven't reached the required cumulative counter value for
954 the current working set percentage, simply accumulate this histogram
955 entry into the running sums and continue to the next histogram
956 entry. */
957 if (cum + histo_bucket->cum_value < working_set_cum_values[ws_ix])
959 cum += histo_bucket->cum_value;
960 count += histo_bucket->num_counters;
961 continue;
964 /* If adding the current histogram entry's cumulative counter value
965 causes us to exceed the current working set size, then estimate
966 how many of this histogram entry's counter values are required to
967 reach the working set size, and fill in working set entries
968 as we reach their expected cumulative value. */
969 for (c_num = 0, tmp_cum = cum;
970 c_num < histo_bucket->num_counters && ws_ix < NUM_GCOV_WORKING_SETS;
971 c_num++)
973 count++;
974 /* If we haven't reached the last histogram entry counter, add
975 in the minimum value again. This will underestimate the
976 cumulative sum so far, because many of the counter values in this
977 entry may have been larger than the minimum. We could add in the
978 average value every time, but that would require an expensive
979 divide operation. */
980 if (c_num + 1 < histo_bucket->num_counters)
981 tmp_cum += histo_bucket->min_value;
982 /* If we have reached the last histogram entry counter, then add
983 in the entire cumulative value. */
984 else
985 tmp_cum = cum + histo_bucket->cum_value;
987 /* Next walk through successive working set entries and fill in
988 the statistics for any whose size we have reached by accumulating
989 this histogram counter. */
990 while (ws_ix < NUM_GCOV_WORKING_SETS
991 && tmp_cum >= working_set_cum_values[ws_ix])
993 gcov_working_sets[ws_ix].num_counters = count;
994 gcov_working_sets[ws_ix].min_counter
995 = histo_bucket->min_value;
996 ws_ix++;
999 /* Finally, update the running cumulative value since we were
1000 using a temporary above. */
1001 cum += histo_bucket->cum_value;
1003 gcov_nonruntime_assert (ws_ix == NUM_GCOV_WORKING_SETS);
1005 #endif /* IN_GCOV <= 0 && !IN_LIBGCOV */