1 /* Routines required for instrumenting a program. */
2 /* Compile this one with gcc. */
3 /* Copyright (C) 1989-2021 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 Under Section 7 of GPL version 3, you are granted additional
18 permissions described in the GCC Runtime Library Exception, version
19 3.1, as published by the Free Software Foundation.
21 You should have received a copy of the GNU General Public License and
22 a copy of the GCC Runtime Library Exception along with this program;
23 see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24 <http://www.gnu.org/licenses/>. */
29 /* Return 1, if all counter values are zero, otherwise 0. */
32 are_all_counters_zero (const struct gcov_ctr_info
*ci_ptr
)
34 for (unsigned i
= 0; i
< ci_ptr
->num
; i
++)
35 if (ci_ptr
->values
[i
] != 0)
41 #if defined(inhibit_libc)
42 /* If libc and its header files are not available, provide dummy functions. */
45 void __gcov_init (struct gcov_info
*p
__attribute__ ((unused
))) {}
48 #else /* inhibit_libc */
54 #elif GCOV_LOCKED_WITH_LOCKING
56 #include <sys/locking.h>
64 #endif /* inhibit_libc */
66 #if defined(L_gcov) && !defined(inhibit_libc)
70 #if defined(L_gcov_info_to_gcda) && !IN_GCOV_TOOL
71 #define NEED_L_GCOV_INFO_TO_GCDA
75 /* A utility function for outputting errors. */
76 static int gcov_error (const char *, ...);
79 static void gcov_error_exit (void);
84 #define GCOV_PROF_PREFIX "libgcov profiling error:%s:"
88 struct gcov_fn_buffer
*next
;
90 struct gcov_fn_info info
;
91 /* note gcov_fn_info ends in a trailing array. */
94 struct gcov_summary_buffer
96 struct gcov_summary_buffer
*next
;
97 struct gcov_summary summary
;
100 /* A struct that bundles all the related information about the
105 char *filename
; /* filename buffer */
106 int strip
; /* leading chars to strip from filename */
107 char *prefix
; /* prefix string */
110 static struct gcov_fn_buffer
*
111 free_fn_data (const struct gcov_info
*gi_ptr
, struct gcov_fn_buffer
*buffer
,
114 struct gcov_fn_buffer
*next
;
115 unsigned ix
, n_ctr
= 0;
121 for (ix
= 0; ix
!= limit
; ix
++)
122 if (gi_ptr
->merge
[ix
])
123 free (buffer
->info
.ctrs
[n_ctr
++].values
);
128 static struct gcov_fn_buffer
**
129 buffer_fn_data (const char *filename
, const struct gcov_info
*gi_ptr
,
130 struct gcov_fn_buffer
**end_ptr
, unsigned fn_ix
)
132 unsigned n_ctrs
= 0, ix
= 0;
133 struct gcov_fn_buffer
*fn_buffer
;
136 for (ix
= GCOV_COUNTERS
; ix
--;)
137 if (gi_ptr
->merge
[ix
])
140 len
= sizeof (*fn_buffer
) + sizeof (fn_buffer
->info
.ctrs
[0]) * n_ctrs
;
141 fn_buffer
= (struct gcov_fn_buffer
*) xmalloc (len
);
147 fn_buffer
->fn_ix
= fn_ix
;
148 fn_buffer
->info
.ident
= gcov_read_unsigned ();
149 fn_buffer
->info
.lineno_checksum
= gcov_read_unsigned ();
150 fn_buffer
->info
.cfg_checksum
= gcov_read_unsigned ();
152 for (n_ctrs
= ix
= 0; ix
!= GCOV_COUNTERS
; ix
++)
154 gcov_unsigned_t length
;
157 if (!gi_ptr
->merge
[ix
])
160 if (gcov_read_unsigned () != GCOV_TAG_FOR_COUNTER (ix
))
166 length
= GCOV_TAG_COUNTER_NUM (gcov_read_unsigned ());
167 len
= length
* sizeof (gcov_type
);
168 values
= (gcov_type
*) xmalloc (len
);
172 fn_buffer
->info
.ctrs
[n_ctrs
].num
= length
;
173 fn_buffer
->info
.ctrs
[n_ctrs
].values
= values
;
176 *values
++ = gcov_read_counter ();
180 *end_ptr
= fn_buffer
;
181 return &fn_buffer
->next
;
184 gcov_error (GCOV_PROF_PREFIX
"Function %u %s %u \n", filename
, fn_ix
,
185 len
? "cannot allocate" : "counter mismatch", len
? len
: ix
);
187 return (struct gcov_fn_buffer
**)free_fn_data (gi_ptr
, fn_buffer
, ix
);
190 /* Convert VERSION into a string description and return the it.
191 BUFFER is used for storage of the string. The code should be
192 aligned wit gcov-iov.c. */
195 gcov_version_string (char *buffer
, char version
[4])
197 if (version
[0] < 'A' || version
[0] > 'Z'
198 || version
[1] < '0' || version
[1] > '9'
199 || version
[2] < '0' || version
[2] > '9')
200 sprintf (buffer
, "(unknown)");
203 unsigned major
= 10 * (version
[0] - 'A') + (version
[1] - '0');
204 unsigned minor
= version
[2] - '0';
205 sprintf (buffer
, "%u.%u (%s)", major
, minor
,
206 version
[3] == '*' ? "release" : "experimental");
211 /* Check if VERSION of the info block PTR matches libgcov one.
212 Return 1 on success, or zero in case of versions mismatch.
213 If FILENAME is not NULL, its value used for reporting purposes
214 instead of value from the info block. */
217 gcov_version (struct gcov_info
*ptr
, gcov_unsigned_t version
,
218 const char *filename
)
220 if (version
!= GCOV_VERSION
)
223 char ver_string
[128], expected_string
[128];
225 GCOV_UNSIGNED2STRING (v
, version
);
226 GCOV_UNSIGNED2STRING (e
, GCOV_VERSION
);
228 gcov_error (GCOV_PROF_PREFIX
"Version mismatch - expected %s (%.4s) "
230 filename
? filename
: ptr
->filename
,
231 gcov_version_string (expected_string
, e
), e
,
232 gcov_version_string (ver_string
, v
), v
);
238 /* buffer for the fn_data from another program. */
239 static struct gcov_fn_buffer
*fn_buffer
;
241 /* Including system dependent components. */
242 #include "libgcov-driver-system.c"
244 /* This function merges counters in GI_PTR to an existing gcda file.
246 Return -1 on error. In this case, caller will goto read_fatal. */
249 merge_one_data (const char *filename
,
250 struct gcov_info
*gi_ptr
,
251 struct gcov_summary
*summary
)
253 gcov_unsigned_t tag
, length
;
257 struct gcov_fn_buffer
**fn_tail
= &fn_buffer
;
259 length
= gcov_read_unsigned ();
260 if (!gcov_version (gi_ptr
, length
, filename
))
263 length
= gcov_read_unsigned ();
264 if (length
!= gi_ptr
->stamp
)
266 /* Read from a different compilation. Overwrite the file. */
267 gcov_error (GCOV_PROF_PREFIX
"overwriting an existing profile data "
268 "with a different timestamp\n", filename
);
272 tag
= gcov_read_unsigned ();
273 if (tag
!= GCOV_TAG_OBJECT_SUMMARY
)
275 length
= gcov_read_unsigned ();
276 gcc_assert (length
> 0);
277 gcov_read_summary (summary
);
279 tag
= gcov_read_unsigned ();
280 /* Merge execution counts for each function. */
281 for (f_ix
= 0; (unsigned)f_ix
!= gi_ptr
->n_functions
;
282 f_ix
++, tag
= gcov_read_unsigned ())
284 const struct gcov_ctr_info
*ci_ptr
;
285 const struct gcov_fn_info
*gfi_ptr
= gi_ptr
->functions
[f_ix
];
287 if (tag
!= GCOV_TAG_FUNCTION
)
290 length
= gcov_read_unsigned ();
292 /* This function did not appear in the other program.
293 We have nothing to merge. */
296 if (length
!= GCOV_TAG_FUNCTION_LENGTH
)
299 if (!gfi_ptr
|| gfi_ptr
->key
!= gi_ptr
)
301 /* This function appears in the other program. We
302 need to buffer the information in order to write
303 it back out -- we'll be inserting data before
304 this point, so cannot simply keep the data in the
306 fn_tail
= buffer_fn_data (filename
, gi_ptr
, fn_tail
, f_ix
);
312 length
= gcov_read_unsigned ();
313 if (length
!= gfi_ptr
->ident
)
316 length
= gcov_read_unsigned ();
317 if (length
!= gfi_ptr
->lineno_checksum
)
320 length
= gcov_read_unsigned ();
321 if (length
!= gfi_ptr
->cfg_checksum
)
324 ci_ptr
= gfi_ptr
->ctrs
;
325 for (t_ix
= 0; t_ix
< GCOV_COUNTERS
; t_ix
++)
327 gcov_merge_fn merge
= gi_ptr
->merge
[t_ix
];
332 tag
= gcov_read_unsigned ();
333 int read_length
= (int)gcov_read_unsigned ();
334 length
= abs (read_length
);
335 if (tag
!= GCOV_TAG_FOR_COUNTER (t_ix
)
336 || (length
!= GCOV_TAG_COUNTER_LENGTH (ci_ptr
->num
)
337 && t_ix
!= GCOV_COUNTER_V_TOPN
338 && t_ix
!= GCOV_COUNTER_V_INDIR
))
340 /* Merging with all zero counters does not make sense. */
342 (*merge
) (ci_ptr
->values
, ci_ptr
->num
);
345 if ((error
= gcov_is_error ()))
352 gcov_error (GCOV_PROF_PREFIX
"Merge mismatch for %s %u\n",
353 filename
, f_ix
>= 0 ? "function" : "summary",
354 f_ix
< 0 ? -1 - f_ix
: f_ix
);
360 gcov_error (GCOV_PROF_PREFIX
"%s merging\n", filename
,
361 error
< 0 ? "Overflow": "Error");
365 /* Write the DATA of LENGTH characters to the gcov file. */
368 gcov_dump_handler (const void *data
,
370 void *arg ATTRIBUTE_UNUSED
)
372 gcov_write (data
, length
);
375 /* Allocate SIZE characters and return the address of the allocated memory. */
378 gcov_allocate_handler (unsigned size
, void *arg ATTRIBUTE_UNUSED
)
380 return xmalloc (size
);
382 #endif /* NEED_L_GCOV */
384 #if defined(NEED_L_GCOV) || defined(NEED_L_GCOV_INFO_TO_GCDA)
385 /* Dump the WORD using the DUMP handler called with ARG. */
388 dump_unsigned (gcov_unsigned_t word
,
389 void (*dump_fn
) (const void *, unsigned, void *),
392 (*dump_fn
) (&word
, sizeof (word
), arg
);
395 /* Dump the COUNTER using the DUMP handler called with ARG. */
398 dump_counter (gcov_type counter
,
399 void (*dump_fn
) (const void *, unsigned, void *),
402 dump_unsigned ((gcov_unsigned_t
)counter
, dump_fn
, arg
);
404 if (sizeof (counter
) > sizeof (gcov_unsigned_t
))
405 dump_unsigned ((gcov_unsigned_t
)(counter
>> 32), dump_fn
, arg
);
407 dump_unsigned (0, dump_fn
, arg
);
410 #define MAX(X,Y) ((X) > (Y) ? (X) : (Y))
412 /* Store all TOP N counters where each has a dynamic length. */
415 write_topn_counters (const struct gcov_ctr_info
*ci_ptr
,
417 gcov_unsigned_t n_counts
,
418 void (*dump_fn
) (const void *, unsigned, void *),
419 void *(*allocate_fn
)(unsigned, void *),
422 unsigned counters
= n_counts
/ GCOV_TOPN_MEM_COUNTERS
;
423 gcc_assert (n_counts
% GCOV_TOPN_MEM_COUNTERS
== 0);
425 /* It can happen in a multi-threaded environment that number of counters is
426 different from the size of the corresponding linked lists. */
427 #define LIST_SIZE_MIN_LENGTH 4 * 1024
429 static unsigned *list_sizes
= NULL
;
430 static unsigned list_size_length
= 0;
432 if (list_sizes
== NULL
|| counters
> list_size_length
)
434 list_size_length
= MAX (LIST_SIZE_MIN_LENGTH
, 2 * counters
);
435 #if !defined(inhibit_libc) && HAVE_SYS_MMAN_H
437 = (unsigned *)malloc_mmap (list_size_length
* sizeof (unsigned));
440 /* Malloc fallback. */
441 if (list_sizes
== NULL
)
443 (unsigned *)(*allocate_fn
) (list_size_length
* sizeof (unsigned),
447 unsigned pair_total
= 0;
449 for (unsigned i
= 0; i
< counters
; i
++)
451 gcov_type start
= ci_ptr
->values
[GCOV_TOPN_MEM_COUNTERS
* i
+ 2];
454 for (struct gcov_kvp
*node
= (struct gcov_kvp
*)(__INTPTR_TYPE__
)start
;
455 node
!= NULL
; node
= node
->next
)
459 list_sizes
[i
] = sizes
;
462 unsigned disk_size
= GCOV_TOPN_DISK_COUNTERS
* counters
+ 2 * pair_total
;
463 dump_unsigned (GCOV_TAG_FOR_COUNTER (t_ix
), dump_fn
, arg
),
464 dump_unsigned (GCOV_TAG_COUNTER_LENGTH (disk_size
), dump_fn
, arg
);
466 for (unsigned i
= 0; i
< counters
; i
++)
468 dump_counter (ci_ptr
->values
[GCOV_TOPN_MEM_COUNTERS
* i
], dump_fn
, arg
);
469 dump_counter (list_sizes
[i
], dump_fn
, arg
);
470 gcov_type start
= ci_ptr
->values
[GCOV_TOPN_MEM_COUNTERS
* i
+ 2];
473 for (struct gcov_kvp
*node
= (struct gcov_kvp
*)(__INTPTR_TYPE__
)start
;
474 j
< list_sizes
[i
]; node
= node
->next
, j
++)
476 dump_counter (node
->value
, dump_fn
, arg
);
477 dump_counter (node
->count
, dump_fn
, arg
);
482 /* Write counters in GI_PTR and the summary in PRG to a gcda file. In
483 the case of appending to an existing file, SUMMARY_POS will be non-zero.
484 We will write the file starting from SUMMAY_POS. */
487 write_one_data (const struct gcov_info
*gi_ptr
,
488 const struct gcov_summary
*prg_p ATTRIBUTE_UNUSED
,
489 void (*dump_fn
) (const void *, unsigned, void *),
490 void *(*allocate_fn
) (unsigned, void *),
495 dump_unsigned (GCOV_DATA_MAGIC
, dump_fn
, arg
);
496 dump_unsigned (GCOV_VERSION
, dump_fn
, arg
);
497 dump_unsigned (gi_ptr
->stamp
, dump_fn
, arg
);
500 /* Generate whole program statistics. */
501 gcov_write_summary (GCOV_TAG_OBJECT_SUMMARY
, prg_p
);
504 /* Write execution counts for each function. */
505 for (f_ix
= 0; f_ix
!= gi_ptr
->n_functions
; f_ix
++)
508 unsigned buffered
= 0;
510 const struct gcov_fn_info
*gfi_ptr
;
511 const struct gcov_ctr_info
*ci_ptr
;
512 gcov_unsigned_t length
;
516 if (fn_buffer
&& fn_buffer
->fn_ix
== f_ix
)
518 /* Buffered data from another program. */
520 gfi_ptr
= &fn_buffer
->info
;
521 length
= GCOV_TAG_FUNCTION_LENGTH
;
526 gfi_ptr
= gi_ptr
->functions
[f_ix
];
527 if (gfi_ptr
&& gfi_ptr
->key
== gi_ptr
)
528 length
= GCOV_TAG_FUNCTION_LENGTH
;
533 dump_unsigned (GCOV_TAG_FUNCTION
, dump_fn
, arg
);
534 dump_unsigned (length
, dump_fn
, arg
);
538 dump_unsigned (gfi_ptr
->ident
, dump_fn
, arg
);
539 dump_unsigned (gfi_ptr
->lineno_checksum
, dump_fn
, arg
);
540 dump_unsigned (gfi_ptr
->cfg_checksum
, dump_fn
, arg
);
542 ci_ptr
= gfi_ptr
->ctrs
;
543 for (t_ix
= 0; t_ix
< GCOV_COUNTERS
; t_ix
++)
545 gcov_position_t n_counts
;
547 if (!gi_ptr
->merge
[t_ix
])
550 n_counts
= ci_ptr
->num
;
552 if (t_ix
== GCOV_COUNTER_V_TOPN
|| t_ix
== GCOV_COUNTER_V_INDIR
)
553 write_topn_counters (ci_ptr
, t_ix
, n_counts
, dump_fn
, allocate_fn
,
557 dump_unsigned (GCOV_TAG_FOR_COUNTER (t_ix
), dump_fn
, arg
);
558 if (are_all_counters_zero (ci_ptr
))
559 /* Do not stream when all counters are zero. */
560 dump_unsigned (GCOV_TAG_COUNTER_LENGTH (-n_counts
),
564 dump_unsigned (GCOV_TAG_COUNTER_LENGTH (n_counts
),
566 for (unsigned i
= 0; i
< n_counts
; i
++)
567 dump_counter (ci_ptr
->values
[i
], dump_fn
, arg
);
575 fn_buffer
= free_fn_data (gi_ptr
, fn_buffer
, GCOV_COUNTERS
);
579 dump_unsigned (0, dump_fn
, arg
);
581 #endif /* NEED_L_GCOV || NEED_L_GCOV_INFO_TO_GCDA */
584 /* Dump the coverage counts for one gcov_info object. We merge with existing
585 counts when possible, to avoid growing the .da files ad infinitum. We use
586 this program's checksum to make sure we only accumulate whole program
587 statistics to the correct summary. An object file might be embedded
588 in two separate programs, and we must keep the two program
589 summaries separate. */
592 dump_one_gcov (struct gcov_info
*gi_ptr
, struct gcov_filename
*gf
,
593 unsigned run_counted ATTRIBUTE_UNUSED
,
594 gcov_type run_max ATTRIBUTE_UNUSED
)
596 struct gcov_summary summary
= {};
601 error
= gcov_exit_open_gcda_file (gi_ptr
, gf
);
605 tag
= gcov_read_unsigned ();
608 /* Merge data from file. */
609 if (tag
!= GCOV_DATA_MAGIC
)
611 gcov_error (GCOV_PROF_PREFIX
"Not a gcov data file\n",
615 error
= merge_one_data (gf
->filename
, gi_ptr
, &summary
);
626 summary
.sum_max
+= run_max
;
629 summary
= gi_ptr
->summary
;
632 write_one_data (gi_ptr
, &summary
, gcov_dump_handler
, gcov_allocate_handler
,
638 fn_buffer
= free_fn_data (gi_ptr
, fn_buffer
, GCOV_COUNTERS
);
640 if ((error
= gcov_close ()))
641 gcov_error ((error
< 0 ? GCOV_PROF_PREFIX
"Overflow writing\n"
642 : GCOV_PROF_PREFIX
"Error writing\n"), gf
->filename
);
646 /* Dump all the coverage counts for the program. It first computes program
647 summary and then traverses gcov_list list and dumps the gcov_info
648 objects one by one. */
654 gcov_do_dump (struct gcov_info
*list
, int run_counted
)
656 struct gcov_info
*gi_ptr
;
657 struct gcov_filename gf
;
659 /* Compute run_max of this program run. */
660 gcov_type run_max
= 0;
661 for (gi_ptr
= list
; gi_ptr
; gi_ptr
= gi_ptr
->next
)
662 for (unsigned f_ix
= 0; (unsigned)f_ix
!= gi_ptr
->n_functions
; f_ix
++)
664 const struct gcov_ctr_info
*cinfo
665 = &gi_ptr
->functions
[f_ix
]->ctrs
[GCOV_COUNTER_ARCS
];
667 for (unsigned i
= 0; i
< cinfo
->num
; i
++)
668 if (run_max
< cinfo
->values
[i
])
669 run_max
= cinfo
->values
[i
];
672 allocate_filename_struct (&gf
);
674 /* Now merge each file. */
675 for (gi_ptr
= list
; gi_ptr
; gi_ptr
= gi_ptr
->next
)
677 dump_one_gcov (gi_ptr
, &gf
, run_counted
, run_max
);
686 __attribute__ ((unused
))
687 gcov_get_filename (struct gcov_info
*list
)
689 return list
->filename
;
695 __gcov_dump_one (struct gcov_root
*root
)
700 gcov_do_dump (root
->list
, root
->run_counted
);
703 root
->run_counted
= 1;
706 /* Per-dynamic-object gcov state. */
707 struct gcov_root __gcov_root
;
709 /* Exactly one of these will be live in the process image. */
710 struct gcov_master __gcov_master
=
713 /* Dynamic pool for gcov_kvp structures. */
714 struct gcov_kvp
*__gcov_kvp_dynamic_pool
;
716 /* Index into __gcov_kvp_dynamic_pool array. */
717 unsigned __gcov_kvp_dynamic_pool_index
;
719 /* Size of _gcov_kvp_dynamic_pool array. */
720 unsigned __gcov_kvp_dynamic_pool_size
;
725 __gcov_dump_one (&__gcov_root
);
726 if (__gcov_root
.next
)
727 __gcov_root
.next
->prev
= __gcov_root
.prev
;
728 if (__gcov_root
.prev
)
729 __gcov_root
.prev
->next
= __gcov_root
.next
;
731 __gcov_master
.root
= __gcov_root
.next
;
736 /* Add a new object file onto the bb chain. Invoked automatically
737 when running an object file's global ctors. */
740 __gcov_init (struct gcov_info
*info
)
742 if (!info
->version
|| !info
->n_functions
)
744 if (gcov_version (info
, info
->version
, 0))
746 if (!__gcov_root
.list
)
748 /* Add to master list and at exit function. */
749 if (gcov_version (NULL
, __gcov_master
.version
, "<master>"))
751 __gcov_root
.next
= __gcov_master
.root
;
752 if (__gcov_master
.root
)
753 __gcov_master
.root
->prev
= &__gcov_root
;
754 __gcov_master
.root
= &__gcov_root
;
758 info
->next
= __gcov_root
.list
;
759 __gcov_root
.list
= info
;
762 #endif /* !IN_GCOV_TOOL */
763 #endif /* NEED_L_GCOV */
765 #ifdef NEED_L_GCOV_INFO_TO_GCDA
766 /* Convert the gcov info to a gcda data stream. It is intended for
767 free-standing environments which do not support the C library file I/O. */
770 __gcov_info_to_gcda (const struct gcov_info
*gi_ptr
,
771 void (*filename_fn
) (const char *, void *),
772 void (*dump_fn
) (const void *, unsigned, void *),
773 void *(*allocate_fn
) (unsigned, void *),
776 (*filename_fn
) (gi_ptr
->filename
, arg
);
777 write_one_data (gi_ptr
, NULL
, dump_fn
, allocate_fn
, arg
);
779 #endif /* NEED_L_GCOV_INFO_TO_GCDA */