1 // SPDX-License-Identifier: GPL-2.0
3 * This code provides functions to handle gcc's profiling data format
4 * introduced with gcc 3.4. Future versions of gcc may change the gcov
5 * format (as happened before), so all format-specific information needs
6 * to be kept modular and easily exchangeable.
8 * This file is based on gcc-internal definitions. Functions and data
9 * structures are defined to be compatible with gcc counterparts.
10 * For a better understanding, refer to gcc source: gcc/gcov-io.h.
12 * Copyright IBM Corp. 2009
13 * Author(s): Peter Oberparleiter <oberpar@linux.vnet.ibm.com>
15 * Uses gcc-internal data definitions.
18 #include <linux/errno.h>
19 #include <linux/slab.h>
20 #include <linux/string.h>
21 #include <linux/seq_file.h>
22 #include <linux/vmalloc.h>
25 #define GCOV_COUNTERS 5
27 static struct gcov_info
*gcov_info_head
;
30 * struct gcov_fn_info - profiling meta data per function
31 * @ident: object file-unique function identifier
32 * @checksum: function checksum
33 * @n_ctrs: number of values per counter type belonging to this function
35 * This data is generated by gcc during compilation and doesn't change
40 unsigned int checksum
;
41 unsigned int n_ctrs
[0];
45 * struct gcov_ctr_info - profiling data per counter type
46 * @num: number of counter values for this type
47 * @values: array of counter values for this type
48 * @merge: merge function for counter values of this type (unused)
50 * This data is generated by gcc during compilation and doesn't change
51 * at run-time with the exception of the values array.
53 struct gcov_ctr_info
{
56 void (*merge
)(gcov_type
*, unsigned int);
60 * struct gcov_info - profiling data per object file
61 * @version: gcov version magic indicating the gcc version used for compilation
62 * @next: list head for a singly-linked list
64 * @filename: name of the associated gcov data file
65 * @n_functions: number of instrumented functions
66 * @functions: function data
67 * @ctr_mask: mask specifying which counter types are active
68 * @counts: counter data per counter type
70 * This data is generated by gcc during compilation and doesn't change
71 * at run-time with the exception of the next pointer.
75 struct gcov_info
*next
;
78 unsigned int n_functions
;
79 const struct gcov_fn_info
*functions
;
80 unsigned int ctr_mask
;
81 struct gcov_ctr_info counts
[0];
85 * gcov_info_filename - return info filename
86 * @info: profiling data set
88 const char *gcov_info_filename(struct gcov_info
*info
)
90 return info
->filename
;
94 * gcov_info_version - return info version
95 * @info: profiling data set
97 unsigned int gcov_info_version(struct gcov_info
*info
)
103 * gcov_info_next - return next profiling data set
104 * @info: profiling data set
106 * Returns next gcov_info following @info or first gcov_info in the chain if
109 struct gcov_info
*gcov_info_next(struct gcov_info
*info
)
112 return gcov_info_head
;
118 * gcov_info_link - link/add profiling data set to the list
119 * @info: profiling data set
121 void gcov_info_link(struct gcov_info
*info
)
123 info
->next
= gcov_info_head
;
124 gcov_info_head
= info
;
128 * gcov_info_unlink - unlink/remove profiling data set from the list
129 * @prev: previous profiling data set
130 * @info: profiling data set
132 void gcov_info_unlink(struct gcov_info
*prev
, struct gcov_info
*info
)
135 prev
->next
= info
->next
;
137 gcov_info_head
= info
->next
;
141 * gcov_info_within_module - check if a profiling data set belongs to a module
142 * @info: profiling data set
145 * Returns true if profiling data belongs module, false otherwise.
147 bool gcov_info_within_module(struct gcov_info
*info
, struct module
*mod
)
149 return within_module((unsigned long)info
, mod
);
152 /* Symbolic links to be created for each profiling data file. */
153 const struct gcov_link gcov_link
[] = {
154 { OBJ_TREE
, "gcno" }, /* Link to .gcno file in $(objtree). */
159 * Determine whether a counter is active. Based on gcc magic. Doesn't change
162 static int counter_active(struct gcov_info
*info
, unsigned int type
)
164 return (1 << type
) & info
->ctr_mask
;
167 /* Determine number of active counters. Based on gcc magic. */
168 static unsigned int num_counter_active(struct gcov_info
*info
)
171 unsigned int result
= 0;
173 for (i
= 0; i
< GCOV_COUNTERS
; i
++) {
174 if (counter_active(info
, i
))
181 * gcov_info_reset - reset profiling data to zero
182 * @info: profiling data set
184 void gcov_info_reset(struct gcov_info
*info
)
186 unsigned int active
= num_counter_active(info
);
189 for (i
= 0; i
< active
; i
++) {
190 memset(info
->counts
[i
].values
, 0,
191 info
->counts
[i
].num
* sizeof(gcov_type
));
196 * gcov_info_is_compatible - check if profiling data can be added
197 * @info1: first profiling data set
198 * @info2: second profiling data set
200 * Returns non-zero if profiling data can be added, zero otherwise.
202 int gcov_info_is_compatible(struct gcov_info
*info1
, struct gcov_info
*info2
)
204 return (info1
->stamp
== info2
->stamp
);
208 * gcov_info_add - add up profiling data
209 * @dest: profiling data set to which data is added
210 * @source: profiling data set which is added
212 * Adds profiling counts of @source to @dest.
214 void gcov_info_add(struct gcov_info
*dest
, struct gcov_info
*source
)
219 for (i
= 0; i
< num_counter_active(dest
); i
++) {
220 for (j
= 0; j
< dest
->counts
[i
].num
; j
++) {
221 dest
->counts
[i
].values
[j
] +=
222 source
->counts
[i
].values
[j
];
227 /* Get size of function info entry. Based on gcc magic. */
228 static size_t get_fn_size(struct gcov_info
*info
)
232 size
= sizeof(struct gcov_fn_info
) + num_counter_active(info
) *
233 sizeof(unsigned int);
234 if (__alignof__(struct gcov_fn_info
) > sizeof(unsigned int))
235 size
= ALIGN(size
, __alignof__(struct gcov_fn_info
));
239 /* Get address of function info entry. Based on gcc magic. */
240 static struct gcov_fn_info
*get_fn_info(struct gcov_info
*info
, unsigned int fn
)
242 return (struct gcov_fn_info
*)
243 ((char *) info
->functions
+ fn
* get_fn_size(info
));
247 * gcov_info_dup - duplicate profiling data set
248 * @info: profiling data set to duplicate
250 * Return newly allocated duplicate on success, %NULL on error.
252 struct gcov_info
*gcov_info_dup(struct gcov_info
*info
)
254 struct gcov_info
*dup
;
258 /* Duplicate gcov_info. */
259 active
= num_counter_active(info
);
260 dup
= kzalloc(struct_size(dup
, counts
, active
), GFP_KERNEL
);
263 dup
->version
= info
->version
;
264 dup
->stamp
= info
->stamp
;
265 dup
->n_functions
= info
->n_functions
;
266 dup
->ctr_mask
= info
->ctr_mask
;
267 /* Duplicate filename. */
268 dup
->filename
= kstrdup(info
->filename
, GFP_KERNEL
);
271 /* Duplicate table of functions. */
272 dup
->functions
= kmemdup(info
->functions
, info
->n_functions
*
273 get_fn_size(info
), GFP_KERNEL
);
276 /* Duplicate counter arrays. */
277 for (i
= 0; i
< active
; i
++) {
278 struct gcov_ctr_info
*ctr
= &info
->counts
[i
];
279 size_t size
= ctr
->num
* sizeof(gcov_type
);
281 dup
->counts
[i
].num
= ctr
->num
;
282 dup
->counts
[i
].merge
= ctr
->merge
;
283 dup
->counts
[i
].values
= vmalloc(size
);
284 if (!dup
->counts
[i
].values
)
286 memcpy(dup
->counts
[i
].values
, ctr
->values
, size
);
296 * gcov_info_free - release memory for profiling data set duplicate
297 * @info: profiling data set duplicate to free
299 void gcov_info_free(struct gcov_info
*info
)
301 unsigned int active
= num_counter_active(info
);
304 for (i
= 0; i
< active
; i
++)
305 vfree(info
->counts
[i
].values
);
306 kfree(info
->functions
);
307 kfree(info
->filename
);
312 * struct type_info - iterator helper array
313 * @ctr_type: counter type
314 * @offset: index of the first value of the current function for this type
316 * This array is needed to convert the in-memory data format into the in-file
320 * for each counter type
326 * for each counter type
329 * See gcc source gcc/gcov-io.h for more information on data organization.
337 * struct gcov_iterator - specifies current file position in logical records
338 * @info: associated profiling data
339 * @record: record type
340 * @function: function number
341 * @type: counter type
342 * @count: index into values array
343 * @num_types: number of counter types
344 * @type_info: helper array to get values-array offset for current function
346 struct gcov_iterator
{
347 struct gcov_info
*info
;
350 unsigned int function
;
355 struct type_info type_info
[0];
358 static struct gcov_fn_info
*get_func(struct gcov_iterator
*iter
)
360 return get_fn_info(iter
->info
, iter
->function
);
363 static struct type_info
*get_type(struct gcov_iterator
*iter
)
365 return &iter
->type_info
[iter
->type
];
369 * gcov_iter_new - allocate and initialize profiling data iterator
370 * @info: profiling data set to be iterated
372 * Return file iterator on success, %NULL otherwise.
374 struct gcov_iterator
*gcov_iter_new(struct gcov_info
*info
)
376 struct gcov_iterator
*iter
;
378 iter
= kzalloc(struct_size(iter
, type_info
, num_counter_active(info
)),
387 * gcov_iter_free - release memory for iterator
388 * @iter: file iterator to free
390 void gcov_iter_free(struct gcov_iterator
*iter
)
396 * gcov_iter_get_info - return profiling data set for given file iterator
397 * @iter: file iterator
399 struct gcov_info
*gcov_iter_get_info(struct gcov_iterator
*iter
)
405 * gcov_iter_start - reset file iterator to starting position
406 * @iter: file iterator
408 void gcov_iter_start(struct gcov_iterator
*iter
)
417 for (i
= 0; i
< GCOV_COUNTERS
; i
++) {
418 if (counter_active(iter
->info
, i
)) {
419 iter
->type_info
[iter
->num_types
].ctr_type
= i
;
420 iter
->type_info
[iter
->num_types
++].offset
= 0;
425 /* Mapping of logical record number to actual file content. */
426 #define RECORD_FILE_MAGIC 0
427 #define RECORD_GCOV_VERSION 1
428 #define RECORD_TIME_STAMP 2
429 #define RECORD_FUNCTION_TAG 3
430 #define RECORD_FUNCTON_TAG_LEN 4
431 #define RECORD_FUNCTION_IDENT 5
432 #define RECORD_FUNCTION_CHECK 6
433 #define RECORD_COUNT_TAG 7
434 #define RECORD_COUNT_LEN 8
435 #define RECORD_COUNT 9
438 * gcov_iter_next - advance file iterator to next logical record
439 * @iter: file iterator
441 * Return zero if new position is valid, non-zero if iterator has reached end.
443 int gcov_iter_next(struct gcov_iterator
*iter
)
445 switch (iter
->record
) {
446 case RECORD_FILE_MAGIC
:
447 case RECORD_GCOV_VERSION
:
448 case RECORD_FUNCTION_TAG
:
449 case RECORD_FUNCTON_TAG_LEN
:
450 case RECORD_FUNCTION_IDENT
:
451 case RECORD_COUNT_TAG
:
452 /* Advance to next record */
456 /* Advance to next count */
459 case RECORD_COUNT_LEN
:
460 if (iter
->count
< get_func(iter
)->n_ctrs
[iter
->type
]) {
464 /* Advance to next counter type */
465 get_type(iter
)->offset
+= iter
->count
;
469 case RECORD_FUNCTION_CHECK
:
470 if (iter
->type
< iter
->num_types
) {
474 /* Advance to next function */
478 case RECORD_TIME_STAMP
:
479 if (iter
->function
< iter
->info
->n_functions
)
486 if (iter
->record
== -1)
493 * seq_write_gcov_u32 - write 32 bit number in gcov format to seq_file
494 * @seq: seq_file handle
495 * @v: value to be stored
497 * Number format defined by gcc: numbers are recorded in the 32 bit
498 * unsigned binary form of the endianness of the machine generating the
501 static int seq_write_gcov_u32(struct seq_file
*seq
, u32 v
)
503 return seq_write(seq
, &v
, sizeof(v
));
507 * seq_write_gcov_u64 - write 64 bit number in gcov format to seq_file
508 * @seq: seq_file handle
509 * @v: value to be stored
511 * Number format defined by gcc: numbers are recorded in the 32 bit
512 * unsigned binary form of the endianness of the machine generating the
513 * file. 64 bit numbers are stored as two 32 bit numbers, the low part
516 static int seq_write_gcov_u64(struct seq_file
*seq
, u64 v
)
520 data
[0] = (v
& 0xffffffffUL
);
522 return seq_write(seq
, data
, sizeof(data
));
526 * gcov_iter_write - write data for current pos to seq_file
527 * @iter: file iterator
528 * @seq: seq_file handle
530 * Return zero on success, non-zero otherwise.
532 int gcov_iter_write(struct gcov_iterator
*iter
, struct seq_file
*seq
)
536 switch (iter
->record
) {
537 case RECORD_FILE_MAGIC
:
538 rc
= seq_write_gcov_u32(seq
, GCOV_DATA_MAGIC
);
540 case RECORD_GCOV_VERSION
:
541 rc
= seq_write_gcov_u32(seq
, iter
->info
->version
);
543 case RECORD_TIME_STAMP
:
544 rc
= seq_write_gcov_u32(seq
, iter
->info
->stamp
);
546 case RECORD_FUNCTION_TAG
:
547 rc
= seq_write_gcov_u32(seq
, GCOV_TAG_FUNCTION
);
549 case RECORD_FUNCTON_TAG_LEN
:
550 rc
= seq_write_gcov_u32(seq
, 2);
552 case RECORD_FUNCTION_IDENT
:
553 rc
= seq_write_gcov_u32(seq
, get_func(iter
)->ident
);
555 case RECORD_FUNCTION_CHECK
:
556 rc
= seq_write_gcov_u32(seq
, get_func(iter
)->checksum
);
558 case RECORD_COUNT_TAG
:
559 rc
= seq_write_gcov_u32(seq
,
560 GCOV_TAG_FOR_COUNTER(get_type(iter
)->ctr_type
));
562 case RECORD_COUNT_LEN
:
563 rc
= seq_write_gcov_u32(seq
,
564 get_func(iter
)->n_ctrs
[iter
->type
] * 2);
567 rc
= seq_write_gcov_u64(seq
,
568 iter
->info
->counts
[iter
->type
].
569 values
[iter
->count
+ get_type(iter
)->offset
]);