2 * This code provides functions to handle gcc's profiling data format
3 * introduced with gcc 4.7.
5 * This file is based heavily on gcc_3_4.c file.
7 * For a better understanding, refer to gcc source:
11 * Uses gcc-internal data definitions.
14 #include <linux/errno.h>
15 #include <linux/slab.h>
16 #include <linux/string.h>
17 #include <linux/seq_file.h>
18 #include <linux/vmalloc.h>
21 #if (__GNUC__ > 5) || (__GNUC__ == 5 && __GNUC_MINOR__ >= 1)
22 #define GCOV_COUNTERS 10
23 #elif __GNUC__ == 4 && __GNUC_MINOR__ >= 9
24 #define GCOV_COUNTERS 9
26 #define GCOV_COUNTERS 8
29 #define GCOV_TAG_FUNCTION_LENGTH 3
31 static struct gcov_info
*gcov_info_head
;
34 * struct gcov_ctr_info - information about counters for a single function
35 * @num: number of counter values for this type
36 * @values: array of counter values for this type
38 * This data is generated by gcc during compilation and doesn't change
39 * at run-time with the exception of the values array.
41 struct gcov_ctr_info
{
47 * struct gcov_fn_info - profiling meta data per function
49 * @ident: unique ident of function
50 * @lineno_checksum: function lineo_checksum
51 * @cfg_checksum: function cfg checksum
52 * @ctrs: instrumented counters
54 * This data is generated by gcc during compilation and doesn't change
57 * Information about a single function. This uses the trailing array
58 * idiom. The number of counters is determined from the merge pointer
59 * array in gcov_info. The key is used to detect which of a set of
60 * comdat functions was selected -- it points to the gcov_info object
61 * of the object file containing the selected comdat function.
64 const struct gcov_info
*key
;
66 unsigned int lineno_checksum
;
67 unsigned int cfg_checksum
;
68 struct gcov_ctr_info ctrs
[0];
72 * struct gcov_info - profiling data per object file
73 * @version: gcov version magic indicating the gcc version used for compilation
74 * @next: list head for a singly-linked list
75 * @stamp: uniquifying time stamp
76 * @filename: name of the associated gcov data file
77 * @merge: merge functions (null for unused counter type)
78 * @n_functions: number of instrumented functions
79 * @functions: pointer to pointers to function information
81 * This data is generated by gcc during compilation and doesn't change
82 * at run-time with the exception of the next pointer.
86 struct gcov_info
*next
;
89 void (*merge
[GCOV_COUNTERS
])(gcov_type
*, unsigned int);
90 unsigned int n_functions
;
91 struct gcov_fn_info
**functions
;
95 * gcov_info_filename - return info filename
96 * @info: profiling data set
98 const char *gcov_info_filename(struct gcov_info
*info
)
100 return info
->filename
;
104 * gcov_info_version - return info version
105 * @info: profiling data set
107 unsigned int gcov_info_version(struct gcov_info
*info
)
109 return info
->version
;
113 * gcov_info_next - return next profiling data set
114 * @info: profiling data set
116 * Returns next gcov_info following @info or first gcov_info in the chain if
119 struct gcov_info
*gcov_info_next(struct gcov_info
*info
)
122 return gcov_info_head
;
128 * gcov_info_link - link/add profiling data set to the list
129 * @info: profiling data set
131 void gcov_info_link(struct gcov_info
*info
)
133 info
->next
= gcov_info_head
;
134 gcov_info_head
= info
;
138 * gcov_info_unlink - unlink/remove profiling data set from the list
139 * @prev: previous profiling data set
140 * @info: profiling data set
142 void gcov_info_unlink(struct gcov_info
*prev
, struct gcov_info
*info
)
145 prev
->next
= info
->next
;
147 gcov_info_head
= info
->next
;
150 /* Symbolic links to be created for each profiling data file. */
151 const struct gcov_link gcov_link
[] = {
152 { OBJ_TREE
, "gcno" }, /* Link to .gcno file in $(objtree). */
157 * Determine whether a counter is active. Doesn't change at run-time.
159 static int counter_active(struct gcov_info
*info
, unsigned int type
)
161 return info
->merge
[type
] ? 1 : 0;
164 /* Determine number of active counters. Based on gcc magic. */
165 static unsigned int num_counter_active(struct gcov_info
*info
)
168 unsigned int result
= 0;
170 for (i
= 0; i
< GCOV_COUNTERS
; i
++) {
171 if (counter_active(info
, i
))
178 * gcov_info_reset - reset profiling data to zero
179 * @info: profiling data set
181 void gcov_info_reset(struct gcov_info
*info
)
183 struct gcov_ctr_info
*ci_ptr
;
187 for (fi_idx
= 0; fi_idx
< info
->n_functions
; fi_idx
++) {
188 ci_ptr
= info
->functions
[fi_idx
]->ctrs
;
190 for (ct_idx
= 0; ct_idx
< GCOV_COUNTERS
; ct_idx
++) {
191 if (!counter_active(info
, ct_idx
))
194 memset(ci_ptr
->values
, 0,
195 sizeof(gcov_type
) * ci_ptr
->num
);
202 * gcov_info_is_compatible - check if profiling data can be added
203 * @info1: first profiling data set
204 * @info2: second profiling data set
206 * Returns non-zero if profiling data can be added, zero otherwise.
208 int gcov_info_is_compatible(struct gcov_info
*info1
, struct gcov_info
*info2
)
210 return (info1
->stamp
== info2
->stamp
);
214 * gcov_info_add - add up profiling data
215 * @dest: profiling data set to which data is added
216 * @source: profiling data set which is added
218 * Adds profiling counts of @source to @dest.
220 void gcov_info_add(struct gcov_info
*dst
, struct gcov_info
*src
)
222 struct gcov_ctr_info
*dci_ptr
;
223 struct gcov_ctr_info
*sci_ptr
;
226 unsigned int val_idx
;
228 for (fi_idx
= 0; fi_idx
< src
->n_functions
; fi_idx
++) {
229 dci_ptr
= dst
->functions
[fi_idx
]->ctrs
;
230 sci_ptr
= src
->functions
[fi_idx
]->ctrs
;
232 for (ct_idx
= 0; ct_idx
< GCOV_COUNTERS
; ct_idx
++) {
233 if (!counter_active(src
, ct_idx
))
236 for (val_idx
= 0; val_idx
< sci_ptr
->num
; val_idx
++)
237 dci_ptr
->values
[val_idx
] +=
238 sci_ptr
->values
[val_idx
];
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
;
255 struct gcov_ctr_info
*dci_ptr
; /* dst counter info */
256 struct gcov_ctr_info
*sci_ptr
; /* src counter info */
258 unsigned int fi_idx
; /* function info idx */
259 unsigned int ct_idx
; /* counter type idx */
260 size_t fi_size
; /* function info size */
261 size_t cv_size
; /* counter values size */
263 dup
= kmemdup(info
, sizeof(*dup
), GFP_KERNEL
);
268 dup
->filename
= NULL
;
269 dup
->functions
= NULL
;
271 dup
->filename
= kstrdup(info
->filename
, GFP_KERNEL
);
275 dup
->functions
= kcalloc(info
->n_functions
,
276 sizeof(struct gcov_fn_info
*), GFP_KERNEL
);
280 active
= num_counter_active(info
);
281 fi_size
= sizeof(struct gcov_fn_info
);
282 fi_size
+= sizeof(struct gcov_ctr_info
) * active
;
284 for (fi_idx
= 0; fi_idx
< info
->n_functions
; fi_idx
++) {
285 dup
->functions
[fi_idx
] = kzalloc(fi_size
, GFP_KERNEL
);
286 if (!dup
->functions
[fi_idx
])
289 *(dup
->functions
[fi_idx
]) = *(info
->functions
[fi_idx
]);
291 sci_ptr
= info
->functions
[fi_idx
]->ctrs
;
292 dci_ptr
= dup
->functions
[fi_idx
]->ctrs
;
294 for (ct_idx
= 0; ct_idx
< active
; ct_idx
++) {
296 cv_size
= sizeof(gcov_type
) * sci_ptr
->num
;
298 dci_ptr
->values
= vmalloc(cv_size
);
300 if (!dci_ptr
->values
)
303 dci_ptr
->num
= sci_ptr
->num
;
304 memcpy(dci_ptr
->values
, sci_ptr
->values
, cv_size
);
318 * gcov_info_free - release memory for profiling data set duplicate
319 * @info: profiling data set duplicate to free
321 void gcov_info_free(struct gcov_info
*info
)
326 struct gcov_ctr_info
*ci_ptr
;
328 if (!info
->functions
)
331 active
= num_counter_active(info
);
333 for (fi_idx
= 0; fi_idx
< info
->n_functions
; fi_idx
++) {
334 if (!info
->functions
[fi_idx
])
337 ci_ptr
= info
->functions
[fi_idx
]->ctrs
;
339 for (ct_idx
= 0; ct_idx
< active
; ct_idx
++, ci_ptr
++)
340 vfree(ci_ptr
->values
);
342 kfree(info
->functions
[fi_idx
]);
346 kfree(info
->functions
);
347 kfree(info
->filename
);
351 #define ITER_STRIDE PAGE_SIZE
354 * struct gcov_iterator - specifies current file position in logical records
355 * @info: associated profiling data
356 * @buffer: buffer containing file data
357 * @size: size of buffer
358 * @pos: current position in file
360 struct gcov_iterator
{
361 struct gcov_info
*info
;
368 * store_gcov_u32 - store 32 bit number in gcov format to buffer
369 * @buffer: target buffer or NULL
370 * @off: offset into the buffer
371 * @v: value to be stored
373 * Number format defined by gcc: numbers are recorded in the 32 bit
374 * unsigned binary form of the endianness of the machine generating the
375 * file. Returns the number of bytes stored. If @buffer is %NULL, doesn't
378 static size_t store_gcov_u32(void *buffer
, size_t off
, u32 v
)
387 return sizeof(*data
);
391 * store_gcov_u64 - store 64 bit number in gcov format to buffer
392 * @buffer: target buffer or NULL
393 * @off: offset into the buffer
394 * @v: value to be stored
396 * Number format defined by gcc: numbers are recorded in the 32 bit
397 * unsigned binary form of the endianness of the machine generating the
398 * file. 64 bit numbers are stored as two 32 bit numbers, the low part
399 * first. Returns the number of bytes stored. If @buffer is %NULL, doesn't store
402 static size_t store_gcov_u64(void *buffer
, size_t off
, u64 v
)
409 data
[0] = (v
& 0xffffffffUL
);
413 return sizeof(*data
) * 2;
417 * convert_to_gcda - convert profiling data set to gcda file format
418 * @buffer: the buffer to store file data or %NULL if no data should be stored
419 * @info: profiling data set to be converted
421 * Returns the number of bytes that were/would have been stored into the buffer.
423 static size_t convert_to_gcda(char *buffer
, struct gcov_info
*info
)
425 struct gcov_fn_info
*fi_ptr
;
426 struct gcov_ctr_info
*ci_ptr
;
433 pos
+= store_gcov_u32(buffer
, pos
, GCOV_DATA_MAGIC
);
434 pos
+= store_gcov_u32(buffer
, pos
, info
->version
);
435 pos
+= store_gcov_u32(buffer
, pos
, info
->stamp
);
437 for (fi_idx
= 0; fi_idx
< info
->n_functions
; fi_idx
++) {
438 fi_ptr
= info
->functions
[fi_idx
];
440 /* Function record. */
441 pos
+= store_gcov_u32(buffer
, pos
, GCOV_TAG_FUNCTION
);
442 pos
+= store_gcov_u32(buffer
, pos
, GCOV_TAG_FUNCTION_LENGTH
);
443 pos
+= store_gcov_u32(buffer
, pos
, fi_ptr
->ident
);
444 pos
+= store_gcov_u32(buffer
, pos
, fi_ptr
->lineno_checksum
);
445 pos
+= store_gcov_u32(buffer
, pos
, fi_ptr
->cfg_checksum
);
447 ci_ptr
= fi_ptr
->ctrs
;
449 for (ct_idx
= 0; ct_idx
< GCOV_COUNTERS
; ct_idx
++) {
450 if (!counter_active(info
, ct_idx
))
453 /* Counter record. */
454 pos
+= store_gcov_u32(buffer
, pos
,
455 GCOV_TAG_FOR_COUNTER(ct_idx
));
456 pos
+= store_gcov_u32(buffer
, pos
, ci_ptr
->num
* 2);
458 for (cv_idx
= 0; cv_idx
< ci_ptr
->num
; cv_idx
++) {
459 pos
+= store_gcov_u64(buffer
, pos
,
460 ci_ptr
->values
[cv_idx
]);
471 * gcov_iter_new - allocate and initialize profiling data iterator
472 * @info: profiling data set to be iterated
474 * Return file iterator on success, %NULL otherwise.
476 struct gcov_iterator
*gcov_iter_new(struct gcov_info
*info
)
478 struct gcov_iterator
*iter
;
480 iter
= kzalloc(sizeof(struct gcov_iterator
), GFP_KERNEL
);
485 /* Dry-run to get the actual buffer size. */
486 iter
->size
= convert_to_gcda(NULL
, info
);
487 iter
->buffer
= vmalloc(iter
->size
);
491 convert_to_gcda(iter
->buffer
, info
);
502 * gcov_iter_get_info - return profiling data set for given file iterator
503 * @iter: file iterator
505 void gcov_iter_free(struct gcov_iterator
*iter
)
512 * gcov_iter_get_info - return profiling data set for given file iterator
513 * @iter: file iterator
515 struct gcov_info
*gcov_iter_get_info(struct gcov_iterator
*iter
)
521 * gcov_iter_start - reset file iterator to starting position
522 * @iter: file iterator
524 void gcov_iter_start(struct gcov_iterator
*iter
)
530 * gcov_iter_next - advance file iterator to next logical record
531 * @iter: file iterator
533 * Return zero if new position is valid, non-zero if iterator has reached end.
535 int gcov_iter_next(struct gcov_iterator
*iter
)
537 if (iter
->pos
< iter
->size
)
538 iter
->pos
+= ITER_STRIDE
;
540 if (iter
->pos
>= iter
->size
)
547 * gcov_iter_write - write data for current pos to seq_file
548 * @iter: file iterator
549 * @seq: seq_file handle
551 * Return zero on success, non-zero otherwise.
553 int gcov_iter_write(struct gcov_iterator
*iter
, struct seq_file
*seq
)
557 if (iter
->pos
>= iter
->size
)
561 if (iter
->pos
+ len
> iter
->size
)
562 len
= iter
->size
- iter
->pos
;
564 seq_write(seq
, iter
->buffer
+ iter
->pos
, len
);