2016-11-10 Vladimir Makarov <vmakarov@redhat.com>
[official-gcc.git] / gcc / gcov-io.c
blob731c2cf07dfe913de6524011cf17f1b82fdb8080
1 /* File format for coverage information
2 Copyright (C) 1996-2016 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;
350 buffer[alloc] = 0;
351 memcpy (&buffer[1], string, length);
353 #endif
355 #if !IN_LIBGCOV
356 /* Write a tag TAG and reserve space for the record length. Return a
357 value to be used for gcov_write_length. */
359 GCOV_LINKAGE gcov_position_t
360 gcov_write_tag (gcov_unsigned_t tag)
362 gcov_position_t result = gcov_var.start + gcov_var.offset;
363 gcov_unsigned_t *buffer = gcov_write_words (2);
365 buffer[0] = tag;
366 buffer[1] = 0;
368 return result;
371 /* Write a record length using POSITION, which was returned by
372 gcov_write_tag. The current file position is the end of the
373 record, and is restored before returning. Returns nonzero on
374 overflow. */
376 GCOV_LINKAGE void
377 gcov_write_length (gcov_position_t position)
379 unsigned offset;
380 gcov_unsigned_t length;
381 gcov_unsigned_t *buffer;
383 gcov_nonruntime_assert (gcov_var.mode < 0);
384 gcov_nonruntime_assert (position + 2 <= gcov_var.start + gcov_var.offset);
385 gcov_nonruntime_assert (position >= gcov_var.start);
386 offset = position - gcov_var.start;
387 length = gcov_var.offset - offset - 2;
388 buffer = (gcov_unsigned_t *) &gcov_var.buffer[offset];
389 buffer[1] = length;
390 if (gcov_var.offset >= GCOV_BLOCK_SIZE)
391 gcov_write_block (gcov_var.offset);
394 #else /* IN_LIBGCOV */
396 /* Write a tag TAG and length LENGTH. */
398 GCOV_LINKAGE void
399 gcov_write_tag_length (gcov_unsigned_t tag, gcov_unsigned_t length)
401 gcov_unsigned_t *buffer = gcov_write_words (2);
403 buffer[0] = tag;
404 buffer[1] = length;
407 /* Write a summary structure to the gcov file. Return nonzero on
408 overflow. */
410 GCOV_LINKAGE void
411 gcov_write_summary (gcov_unsigned_t tag, const struct gcov_summary *summary)
413 unsigned ix, h_ix, bv_ix, h_cnt = 0;
414 const struct gcov_ctr_summary *csum;
415 unsigned histo_bitvector[GCOV_HISTOGRAM_BITVECTOR_SIZE];
417 /* Count number of non-zero histogram entries, and fill in a bit vector
418 of non-zero indices. The histogram is only currently computed for arc
419 counters. */
420 for (bv_ix = 0; bv_ix < GCOV_HISTOGRAM_BITVECTOR_SIZE; bv_ix++)
421 histo_bitvector[bv_ix] = 0;
422 csum = &summary->ctrs[GCOV_COUNTER_ARCS];
423 for (h_ix = 0; h_ix < GCOV_HISTOGRAM_SIZE; h_ix++)
425 if (csum->histogram[h_ix].num_counters > 0)
427 histo_bitvector[h_ix / 32] |= 1 << (h_ix % 32);
428 h_cnt++;
431 gcov_write_tag_length (tag, GCOV_TAG_SUMMARY_LENGTH (h_cnt));
432 gcov_write_unsigned (summary->checksum);
433 for (csum = summary->ctrs, ix = GCOV_COUNTERS_SUMMABLE; ix--; csum++)
435 gcov_write_unsigned (csum->num);
436 gcov_write_unsigned (csum->runs);
437 gcov_write_counter (csum->sum_all);
438 gcov_write_counter (csum->run_max);
439 gcov_write_counter (csum->sum_max);
440 if (ix != GCOV_COUNTER_ARCS)
442 for (bv_ix = 0; bv_ix < GCOV_HISTOGRAM_BITVECTOR_SIZE; bv_ix++)
443 gcov_write_unsigned (0);
444 continue;
446 for (bv_ix = 0; bv_ix < GCOV_HISTOGRAM_BITVECTOR_SIZE; bv_ix++)
447 gcov_write_unsigned (histo_bitvector[bv_ix]);
448 for (h_ix = 0; h_ix < GCOV_HISTOGRAM_SIZE; h_ix++)
450 if (!csum->histogram[h_ix].num_counters)
451 continue;
452 gcov_write_unsigned (csum->histogram[h_ix].num_counters);
453 gcov_write_counter (csum->histogram[h_ix].min_value);
454 gcov_write_counter (csum->histogram[h_ix].cum_value);
458 #endif /* IN_LIBGCOV */
460 #endif /*!IN_GCOV */
462 /* Return a pointer to read BYTES bytes from the gcov file. Returns
463 NULL on failure (read past EOF). */
465 static const gcov_unsigned_t *
466 gcov_read_words (unsigned words)
468 const gcov_unsigned_t *result;
469 unsigned excess = gcov_var.length - gcov_var.offset;
471 if (gcov_var.mode <= 0)
472 return NULL;
474 if (excess < words)
476 gcov_var.start += gcov_var.offset;
477 if (excess)
479 #if IN_LIBGCOV
480 memcpy (gcov_var.buffer, gcov_var.buffer + gcov_var.offset, 4);
481 #else
482 memmove (gcov_var.buffer, gcov_var.buffer + gcov_var.offset,
483 excess * 4);
484 #endif
486 gcov_var.offset = 0;
487 gcov_var.length = excess;
488 #if IN_LIBGCOV
489 excess = GCOV_BLOCK_SIZE;
490 #else
491 if (gcov_var.length + words > gcov_var.alloc)
492 gcov_allocate (gcov_var.length + words);
493 excess = gcov_var.alloc - gcov_var.length;
494 #endif
495 excess = fread (gcov_var.buffer + gcov_var.length,
496 1, excess << 2, gcov_var.file) >> 2;
497 gcov_var.length += excess;
498 if (gcov_var.length < words)
500 gcov_var.overread += words - gcov_var.length;
501 gcov_var.length = 0;
502 return 0;
505 result = &gcov_var.buffer[gcov_var.offset];
506 gcov_var.offset += words;
507 return result;
510 /* Read unsigned value from a coverage file. Sets error flag on file
511 error, overflow flag on overflow */
513 GCOV_LINKAGE gcov_unsigned_t
514 gcov_read_unsigned (void)
516 gcov_unsigned_t value;
517 const gcov_unsigned_t *buffer = gcov_read_words (1);
519 if (!buffer)
520 return 0;
521 value = from_file (buffer[0]);
522 return value;
525 /* Read counter value from a coverage file. Sets error flag on file
526 error, overflow flag on overflow */
528 GCOV_LINKAGE gcov_type
529 gcov_read_counter (void)
531 gcov_type value;
532 const gcov_unsigned_t *buffer = gcov_read_words (2);
534 if (!buffer)
535 return 0;
536 value = from_file (buffer[0]);
537 if (sizeof (value) > sizeof (gcov_unsigned_t))
538 value |= ((gcov_type) from_file (buffer[1])) << 32;
539 else if (buffer[1])
540 gcov_var.error = -1;
542 return value;
545 /* We need to expose the below function when compiling for gcov-tool. */
547 #if !IN_LIBGCOV || defined (IN_GCOV_TOOL)
548 /* Read string from coverage file. Returns a pointer to a static
549 buffer, or NULL on empty string. You must copy the string before
550 calling another gcov function. */
552 GCOV_LINKAGE const char *
553 gcov_read_string (void)
555 unsigned length = gcov_read_unsigned ();
557 if (!length)
558 return 0;
560 return (const char *) gcov_read_words (length);
562 #endif
564 GCOV_LINKAGE void
565 gcov_read_summary (struct gcov_summary *summary)
567 unsigned ix, h_ix, bv_ix, h_cnt = 0;
568 struct gcov_ctr_summary *csum;
569 unsigned histo_bitvector[GCOV_HISTOGRAM_BITVECTOR_SIZE];
570 unsigned cur_bitvector;
572 summary->checksum = gcov_read_unsigned ();
573 for (csum = summary->ctrs, ix = GCOV_COUNTERS_SUMMABLE; ix--; csum++)
575 csum->num = gcov_read_unsigned ();
576 csum->runs = gcov_read_unsigned ();
577 csum->sum_all = gcov_read_counter ();
578 csum->run_max = gcov_read_counter ();
579 csum->sum_max = gcov_read_counter ();
580 memset (csum->histogram, 0,
581 sizeof (gcov_bucket_type) * GCOV_HISTOGRAM_SIZE);
582 for (bv_ix = 0; bv_ix < GCOV_HISTOGRAM_BITVECTOR_SIZE; bv_ix++)
584 histo_bitvector[bv_ix] = gcov_read_unsigned ();
585 #if IN_LIBGCOV
586 /* When building libgcov we don't include system.h, which includes
587 hwint.h (where popcount_hwi is declared). However, libgcov.a
588 is built by the bootstrapped compiler and therefore the builtins
589 are always available. */
590 h_cnt += __builtin_popcount (histo_bitvector[bv_ix]);
591 #else
592 h_cnt += popcount_hwi (histo_bitvector[bv_ix]);
593 #endif
595 bv_ix = 0;
596 h_ix = 0;
597 cur_bitvector = 0;
598 while (h_cnt--)
600 /* Find the index corresponding to the next entry we will read in.
601 First find the next non-zero bitvector and re-initialize
602 the histogram index accordingly, then right shift and increment
603 the index until we find a set bit. */
604 while (!cur_bitvector)
606 h_ix = bv_ix * 32;
607 if (bv_ix >= GCOV_HISTOGRAM_BITVECTOR_SIZE)
608 gcov_error ("corrupted profile info: summary histogram "
609 "bitvector is corrupt");
610 cur_bitvector = histo_bitvector[bv_ix++];
612 while (!(cur_bitvector & 0x1))
614 h_ix++;
615 cur_bitvector >>= 1;
617 if (h_ix >= GCOV_HISTOGRAM_SIZE)
618 gcov_error ("corrupted profile info: summary histogram "
619 "index is corrupt");
621 csum->histogram[h_ix].num_counters = gcov_read_unsigned ();
622 csum->histogram[h_ix].min_value = gcov_read_counter ();
623 csum->histogram[h_ix].cum_value = gcov_read_counter ();
624 /* Shift off the index we are done with and increment to the
625 corresponding next histogram entry. */
626 cur_bitvector >>= 1;
627 h_ix++;
632 /* We need to expose the below function when compiling for gcov-tool. */
634 #if !IN_LIBGCOV || defined (IN_GCOV_TOOL)
635 /* Reset to a known position. BASE should have been obtained from
636 gcov_position, LENGTH should be a record length. */
638 GCOV_LINKAGE void
639 gcov_sync (gcov_position_t base, gcov_unsigned_t length)
641 gcov_nonruntime_assert (gcov_var.mode > 0);
642 base += length;
643 if (base - gcov_var.start <= gcov_var.length)
644 gcov_var.offset = base - gcov_var.start;
645 else
647 gcov_var.offset = gcov_var.length = 0;
648 fseek (gcov_var.file, base << 2, SEEK_SET);
649 gcov_var.start = ftell (gcov_var.file) >> 2;
652 #endif
654 #if IN_LIBGCOV
655 /* Move to a given position in a gcov file. */
657 GCOV_LINKAGE void
658 gcov_seek (gcov_position_t base)
660 if (gcov_var.offset)
661 gcov_write_block (gcov_var.offset);
662 fseek (gcov_var.file, base << 2, SEEK_SET);
663 gcov_var.start = ftell (gcov_var.file) >> 2;
665 #endif
667 #if IN_GCOV > 0
668 /* Return the modification time of the current gcov file. */
670 GCOV_LINKAGE time_t
671 gcov_time (void)
673 struct stat status;
675 if (fstat (fileno (gcov_var.file), &status))
676 return 0;
677 else
678 return status.st_mtime;
680 #endif /* IN_GCOV */
682 #if !IN_GCOV
683 /* Determine the index into histogram for VALUE. */
685 #if IN_LIBGCOV
686 static unsigned
687 #else
688 GCOV_LINKAGE unsigned
689 #endif
690 gcov_histo_index (gcov_type value)
692 gcov_type_unsigned v = (gcov_type_unsigned)value;
693 unsigned r = 0;
694 unsigned prev2bits = 0;
696 /* Find index into log2 scale histogram, where each of the log2
697 sized buckets is divided into 4 linear sub-buckets for better
698 focus in the higher buckets. */
700 /* Find the place of the most-significant bit set. */
701 if (v > 0)
703 #if IN_LIBGCOV
704 /* When building libgcov we don't include system.h, which includes
705 hwint.h (where floor_log2 is declared). However, libgcov.a
706 is built by the bootstrapped compiler and therefore the builtins
707 are always available. */
708 r = sizeof (long long) * __CHAR_BIT__ - 1 - __builtin_clzll (v);
709 #else
710 /* We use floor_log2 from hwint.c, which takes a HOST_WIDE_INT
711 that is 64 bits and gcov_type_unsigned is 64 bits. */
712 r = floor_log2 (v);
713 #endif
716 /* If at most the 2 least significant bits are set (value is
717 0 - 3) then that value is our index into the lowest set of
718 four buckets. */
719 if (r < 2)
720 return (unsigned)value;
722 gcov_nonruntime_assert (r < 64);
724 /* Find the two next most significant bits to determine which
725 of the four linear sub-buckets to select. */
726 prev2bits = (v >> (r - 2)) & 0x3;
727 /* Finally, compose the final bucket index from the log2 index and
728 the next 2 bits. The minimum r value at this point is 2 since we
729 returned above if r was 2 or more, so the minimum bucket at this
730 point is 4. */
731 return (r - 1) * 4 + prev2bits;
734 /* Merge SRC_HISTO into TGT_HISTO. The counters are assumed to be in
735 the same relative order in both histograms, and are matched up
736 and merged in reverse order. Each counter is assigned an equal portion of
737 its entry's original cumulative counter value when computing the
738 new merged cum_value. */
740 static void gcov_histogram_merge (gcov_bucket_type *tgt_histo,
741 gcov_bucket_type *src_histo)
743 int src_i, tgt_i, tmp_i = 0;
744 unsigned src_num, tgt_num, merge_num;
745 gcov_type src_cum, tgt_cum, merge_src_cum, merge_tgt_cum, merge_cum;
746 gcov_type merge_min;
747 gcov_bucket_type tmp_histo[GCOV_HISTOGRAM_SIZE];
748 int src_done = 0;
750 memset (tmp_histo, 0, sizeof (gcov_bucket_type) * GCOV_HISTOGRAM_SIZE);
752 /* Assume that the counters are in the same relative order in both
753 histograms. Walk the histograms from largest to smallest entry,
754 matching up and combining counters in order. */
755 src_num = 0;
756 src_cum = 0;
757 src_i = GCOV_HISTOGRAM_SIZE - 1;
758 for (tgt_i = GCOV_HISTOGRAM_SIZE - 1; tgt_i >= 0 && !src_done; tgt_i--)
760 tgt_num = tgt_histo[tgt_i].num_counters;
761 tgt_cum = tgt_histo[tgt_i].cum_value;
762 /* Keep going until all of the target histogram's counters at this
763 position have been matched and merged with counters from the
764 source histogram. */
765 while (tgt_num > 0 && !src_done)
767 /* If this is either the first time through this loop or we just
768 exhausted the previous non-zero source histogram entry, look
769 for the next non-zero source histogram entry. */
770 if (!src_num)
772 /* Locate the next non-zero entry. */
773 while (src_i >= 0 && !src_histo[src_i].num_counters)
774 src_i--;
775 /* If source histogram has fewer counters, then just copy over the
776 remaining target counters and quit. */
777 if (src_i < 0)
779 tmp_histo[tgt_i].num_counters += tgt_num;
780 tmp_histo[tgt_i].cum_value += tgt_cum;
781 if (!tmp_histo[tgt_i].min_value ||
782 tgt_histo[tgt_i].min_value < tmp_histo[tgt_i].min_value)
783 tmp_histo[tgt_i].min_value = tgt_histo[tgt_i].min_value;
784 while (--tgt_i >= 0)
786 tmp_histo[tgt_i].num_counters
787 += tgt_histo[tgt_i].num_counters;
788 tmp_histo[tgt_i].cum_value += tgt_histo[tgt_i].cum_value;
789 if (!tmp_histo[tgt_i].min_value ||
790 tgt_histo[tgt_i].min_value
791 < tmp_histo[tgt_i].min_value)
792 tmp_histo[tgt_i].min_value = tgt_histo[tgt_i].min_value;
795 src_done = 1;
796 break;
799 src_num = src_histo[src_i].num_counters;
800 src_cum = src_histo[src_i].cum_value;
803 /* The number of counters to merge on this pass is the minimum
804 of the remaining counters from the current target and source
805 histogram entries. */
806 merge_num = tgt_num;
807 if (src_num < merge_num)
808 merge_num = src_num;
810 /* The merged min_value is the sum of the min_values from target
811 and source. */
812 merge_min = tgt_histo[tgt_i].min_value + src_histo[src_i].min_value;
814 /* Compute the portion of source and target entries' cum_value
815 that will be apportioned to the counters being merged.
816 The total remaining cum_value from each entry is divided
817 equally among the counters from that histogram entry if we
818 are not merging all of them. */
819 merge_src_cum = src_cum;
820 if (merge_num < src_num)
821 merge_src_cum = merge_num * src_cum / src_num;
822 merge_tgt_cum = tgt_cum;
823 if (merge_num < tgt_num)
824 merge_tgt_cum = merge_num * tgt_cum / tgt_num;
825 /* The merged cum_value is the sum of the source and target
826 components. */
827 merge_cum = merge_src_cum + merge_tgt_cum;
829 /* Update the remaining number of counters and cum_value left
830 to be merged from this source and target entry. */
831 src_cum -= merge_src_cum;
832 tgt_cum -= merge_tgt_cum;
833 src_num -= merge_num;
834 tgt_num -= merge_num;
836 /* The merged counters get placed in the new merged histogram
837 at the entry for the merged min_value. */
838 tmp_i = gcov_histo_index (merge_min);
839 gcov_nonruntime_assert (tmp_i < GCOV_HISTOGRAM_SIZE);
840 tmp_histo[tmp_i].num_counters += merge_num;
841 tmp_histo[tmp_i].cum_value += merge_cum;
842 if (!tmp_histo[tmp_i].min_value ||
843 merge_min < tmp_histo[tmp_i].min_value)
844 tmp_histo[tmp_i].min_value = merge_min;
846 /* Ensure the search for the next non-zero src_histo entry starts
847 at the next smallest histogram bucket. */
848 if (!src_num)
849 src_i--;
853 gcov_nonruntime_assert (tgt_i < 0);
855 /* In the case where there were more counters in the source histogram,
856 accumulate the remaining unmerged cumulative counter values. Add
857 those to the smallest non-zero target histogram entry. Otherwise,
858 the total cumulative counter values in the histogram will be smaller
859 than the sum_all stored in the summary, which will complicate
860 computing the working set information from the histogram later on. */
861 if (src_num)
862 src_i--;
863 while (src_i >= 0)
865 src_cum += src_histo[src_i].cum_value;
866 src_i--;
868 /* At this point, tmp_i should be the smallest non-zero entry in the
869 tmp_histo. */
870 gcov_nonruntime_assert (tmp_i >= 0 && tmp_i < GCOV_HISTOGRAM_SIZE
871 && tmp_histo[tmp_i].num_counters > 0);
872 tmp_histo[tmp_i].cum_value += src_cum;
874 /* Finally, copy the merged histogram into tgt_histo. */
875 memcpy (tgt_histo, tmp_histo,
876 sizeof (gcov_bucket_type) * GCOV_HISTOGRAM_SIZE);
878 #endif /* !IN_GCOV */
880 /* This is used by gcov-dump (IN_GCOV == -1) and in the compiler
881 (!IN_GCOV && !IN_LIBGCOV). */
882 #if IN_GCOV <= 0 && !IN_LIBGCOV
883 /* Compute the working set information from the counter histogram in
884 the profile summary. This is an array of information corresponding to a
885 range of percentages of the total execution count (sum_all), and includes
886 the number of counters required to cover that working set percentage and
887 the minimum counter value in that working set. */
889 GCOV_LINKAGE void
890 compute_working_sets (const struct gcov_ctr_summary *summary,
891 gcov_working_set_t *gcov_working_sets)
893 gcov_type working_set_cum_values[NUM_GCOV_WORKING_SETS];
894 gcov_type ws_cum_hotness_incr;
895 gcov_type cum, tmp_cum;
896 const gcov_bucket_type *histo_bucket;
897 unsigned ws_ix, c_num, count;
898 int h_ix;
900 /* Compute the amount of sum_all that the cumulative hotness grows
901 by in each successive working set entry, which depends on the
902 number of working set entries. */
903 ws_cum_hotness_incr = summary->sum_all / NUM_GCOV_WORKING_SETS;
905 /* Next fill in an array of the cumulative hotness values corresponding
906 to each working set summary entry we are going to compute below.
907 Skip 0% statistics, which can be extrapolated from the
908 rest of the summary data. */
909 cum = ws_cum_hotness_incr;
910 for (ws_ix = 0; ws_ix < NUM_GCOV_WORKING_SETS;
911 ws_ix++, cum += ws_cum_hotness_incr)
912 working_set_cum_values[ws_ix] = cum;
913 /* The last summary entry is reserved for (roughly) 99.9% of the
914 working set. Divide by 1024 so it becomes a shift, which gives
915 almost exactly 99.9%. */
916 working_set_cum_values[NUM_GCOV_WORKING_SETS-1]
917 = summary->sum_all - summary->sum_all/1024;
919 /* Next, walk through the histogram in decending order of hotness
920 and compute the statistics for the working set summary array.
921 As histogram entries are accumulated, we check to see which
922 working set entries have had their expected cum_value reached
923 and fill them in, walking the working set entries in increasing
924 size of cum_value. */
925 ws_ix = 0; /* The current entry into the working set array. */
926 cum = 0; /* The current accumulated counter sum. */
927 count = 0; /* The current accumulated count of block counters. */
928 for (h_ix = GCOV_HISTOGRAM_SIZE - 1;
929 h_ix >= 0 && ws_ix < NUM_GCOV_WORKING_SETS; h_ix--)
931 histo_bucket = &summary->histogram[h_ix];
933 /* If we haven't reached the required cumulative counter value for
934 the current working set percentage, simply accumulate this histogram
935 entry into the running sums and continue to the next histogram
936 entry. */
937 if (cum + histo_bucket->cum_value < working_set_cum_values[ws_ix])
939 cum += histo_bucket->cum_value;
940 count += histo_bucket->num_counters;
941 continue;
944 /* If adding the current histogram entry's cumulative counter value
945 causes us to exceed the current working set size, then estimate
946 how many of this histogram entry's counter values are required to
947 reach the working set size, and fill in working set entries
948 as we reach their expected cumulative value. */
949 for (c_num = 0, tmp_cum = cum;
950 c_num < histo_bucket->num_counters && ws_ix < NUM_GCOV_WORKING_SETS;
951 c_num++)
953 count++;
954 /* If we haven't reached the last histogram entry counter, add
955 in the minimum value again. This will underestimate the
956 cumulative sum so far, because many of the counter values in this
957 entry may have been larger than the minimum. We could add in the
958 average value every time, but that would require an expensive
959 divide operation. */
960 if (c_num + 1 < histo_bucket->num_counters)
961 tmp_cum += histo_bucket->min_value;
962 /* If we have reached the last histogram entry counter, then add
963 in the entire cumulative value. */
964 else
965 tmp_cum = cum + histo_bucket->cum_value;
967 /* Next walk through successive working set entries and fill in
968 the statistics for any whose size we have reached by accumulating
969 this histogram counter. */
970 while (ws_ix < NUM_GCOV_WORKING_SETS
971 && tmp_cum >= working_set_cum_values[ws_ix])
973 gcov_working_sets[ws_ix].num_counters = count;
974 gcov_working_sets[ws_ix].min_counter
975 = histo_bucket->min_value;
976 ws_ix++;
979 /* Finally, update the running cumulative value since we were
980 using a temporary above. */
981 cum += histo_bucket->cum_value;
983 gcov_nonruntime_assert (ws_ix == NUM_GCOV_WORKING_SETS);
985 #endif /* IN_GCOV <= 0 && !IN_LIBGCOV */