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__ == 4 && __GNUC_MINOR__ >= 9
22 #define GCOV_COUNTERS 9
24 #define GCOV_COUNTERS 8
27 #define GCOV_TAG_FUNCTION_LENGTH 3
29 static struct gcov_info
*gcov_info_head
;
32 * struct gcov_ctr_info - information about counters for a single function
33 * @num: number of counter values for this type
34 * @values: array of counter values for this type
36 * This data is generated by gcc during compilation and doesn't change
37 * at run-time with the exception of the values array.
39 struct gcov_ctr_info
{
45 * struct gcov_fn_info - profiling meta data per function
47 * @ident: unique ident of function
48 * @lineno_checksum: function lineo_checksum
49 * @cfg_checksum: function cfg checksum
50 * @ctrs: instrumented counters
52 * This data is generated by gcc during compilation and doesn't change
55 * Information about a single function. This uses the trailing array
56 * idiom. The number of counters is determined from the merge pointer
57 * array in gcov_info. The key is used to detect which of a set of
58 * comdat functions was selected -- it points to the gcov_info object
59 * of the object file containing the selected comdat function.
62 const struct gcov_info
*key
;
64 unsigned int lineno_checksum
;
65 unsigned int cfg_checksum
;
66 struct gcov_ctr_info ctrs
[0];
70 * struct gcov_info - profiling data per object file
71 * @version: gcov version magic indicating the gcc version used for compilation
72 * @next: list head for a singly-linked list
73 * @stamp: uniquifying time stamp
74 * @filename: name of the associated gcov data file
75 * @merge: merge functions (null for unused counter type)
76 * @n_functions: number of instrumented functions
77 * @functions: pointer to pointers to function information
79 * This data is generated by gcc during compilation and doesn't change
80 * at run-time with the exception of the next pointer.
84 struct gcov_info
*next
;
87 void (*merge
[GCOV_COUNTERS
])(gcov_type
*, unsigned int);
88 unsigned int n_functions
;
89 struct gcov_fn_info
**functions
;
93 * gcov_info_filename - return info filename
94 * @info: profiling data set
96 const char *gcov_info_filename(struct gcov_info
*info
)
98 return info
->filename
;
102 * gcov_info_version - return info version
103 * @info: profiling data set
105 unsigned int gcov_info_version(struct gcov_info
*info
)
107 return info
->version
;
111 * gcov_info_next - return next profiling data set
112 * @info: profiling data set
114 * Returns next gcov_info following @info or first gcov_info in the chain if
117 struct gcov_info
*gcov_info_next(struct gcov_info
*info
)
120 return gcov_info_head
;
126 * gcov_info_link - link/add profiling data set to the list
127 * @info: profiling data set
129 void gcov_info_link(struct gcov_info
*info
)
131 info
->next
= gcov_info_head
;
132 gcov_info_head
= info
;
136 * gcov_info_unlink - unlink/remove profiling data set from the list
137 * @prev: previous profiling data set
138 * @info: profiling data set
140 void gcov_info_unlink(struct gcov_info
*prev
, struct gcov_info
*info
)
143 prev
->next
= info
->next
;
145 gcov_info_head
= info
->next
;
148 /* Symbolic links to be created for each profiling data file. */
149 const struct gcov_link gcov_link
[] = {
150 { OBJ_TREE
, "gcno" }, /* Link to .gcno file in $(objtree). */
155 * Determine whether a counter is active. Doesn't change at run-time.
157 static int counter_active(struct gcov_info
*info
, unsigned int type
)
159 return info
->merge
[type
] ? 1 : 0;
162 /* Determine number of active counters. Based on gcc magic. */
163 static unsigned int num_counter_active(struct gcov_info
*info
)
166 unsigned int result
= 0;
168 for (i
= 0; i
< GCOV_COUNTERS
; i
++) {
169 if (counter_active(info
, i
))
176 * gcov_info_reset - reset profiling data to zero
177 * @info: profiling data set
179 void gcov_info_reset(struct gcov_info
*info
)
181 struct gcov_ctr_info
*ci_ptr
;
185 for (fi_idx
= 0; fi_idx
< info
->n_functions
; fi_idx
++) {
186 ci_ptr
= info
->functions
[fi_idx
]->ctrs
;
188 for (ct_idx
= 0; ct_idx
< GCOV_COUNTERS
; ct_idx
++) {
189 if (!counter_active(info
, ct_idx
))
192 memset(ci_ptr
->values
, 0,
193 sizeof(gcov_type
) * ci_ptr
->num
);
200 * gcov_info_is_compatible - check if profiling data can be added
201 * @info1: first profiling data set
202 * @info2: second profiling data set
204 * Returns non-zero if profiling data can be added, zero otherwise.
206 int gcov_info_is_compatible(struct gcov_info
*info1
, struct gcov_info
*info2
)
208 return (info1
->stamp
== info2
->stamp
);
212 * gcov_info_add - add up profiling data
213 * @dest: profiling data set to which data is added
214 * @source: profiling data set which is added
216 * Adds profiling counts of @source to @dest.
218 void gcov_info_add(struct gcov_info
*dst
, struct gcov_info
*src
)
220 struct gcov_ctr_info
*dci_ptr
;
221 struct gcov_ctr_info
*sci_ptr
;
224 unsigned int val_idx
;
226 for (fi_idx
= 0; fi_idx
< src
->n_functions
; fi_idx
++) {
227 dci_ptr
= dst
->functions
[fi_idx
]->ctrs
;
228 sci_ptr
= src
->functions
[fi_idx
]->ctrs
;
230 for (ct_idx
= 0; ct_idx
< GCOV_COUNTERS
; ct_idx
++) {
231 if (!counter_active(src
, ct_idx
))
234 for (val_idx
= 0; val_idx
< sci_ptr
->num
; val_idx
++)
235 dci_ptr
->values
[val_idx
] +=
236 sci_ptr
->values
[val_idx
];
245 * gcov_info_dup - duplicate profiling data set
246 * @info: profiling data set to duplicate
248 * Return newly allocated duplicate on success, %NULL on error.
250 struct gcov_info
*gcov_info_dup(struct gcov_info
*info
)
252 struct gcov_info
*dup
;
253 struct gcov_ctr_info
*dci_ptr
; /* dst counter info */
254 struct gcov_ctr_info
*sci_ptr
; /* src counter info */
256 unsigned int fi_idx
; /* function info idx */
257 unsigned int ct_idx
; /* counter type idx */
258 size_t fi_size
; /* function info size */
259 size_t cv_size
; /* counter values size */
261 dup
= kmemdup(info
, sizeof(*dup
), GFP_KERNEL
);
266 dup
->filename
= NULL
;
267 dup
->functions
= NULL
;
269 dup
->filename
= kstrdup(info
->filename
, GFP_KERNEL
);
273 dup
->functions
= kcalloc(info
->n_functions
,
274 sizeof(struct gcov_fn_info
*), GFP_KERNEL
);
278 active
= num_counter_active(info
);
279 fi_size
= sizeof(struct gcov_fn_info
);
280 fi_size
+= sizeof(struct gcov_ctr_info
) * active
;
282 for (fi_idx
= 0; fi_idx
< info
->n_functions
; fi_idx
++) {
283 dup
->functions
[fi_idx
] = kzalloc(fi_size
, GFP_KERNEL
);
284 if (!dup
->functions
[fi_idx
])
287 *(dup
->functions
[fi_idx
]) = *(info
->functions
[fi_idx
]);
289 sci_ptr
= info
->functions
[fi_idx
]->ctrs
;
290 dci_ptr
= dup
->functions
[fi_idx
]->ctrs
;
292 for (ct_idx
= 0; ct_idx
< active
; ct_idx
++) {
294 cv_size
= sizeof(gcov_type
) * sci_ptr
->num
;
296 dci_ptr
->values
= vmalloc(cv_size
);
298 if (!dci_ptr
->values
)
301 dci_ptr
->num
= sci_ptr
->num
;
302 memcpy(dci_ptr
->values
, sci_ptr
->values
, cv_size
);
316 * gcov_info_free - release memory for profiling data set duplicate
317 * @info: profiling data set duplicate to free
319 void gcov_info_free(struct gcov_info
*info
)
324 struct gcov_ctr_info
*ci_ptr
;
326 if (!info
->functions
)
329 active
= num_counter_active(info
);
331 for (fi_idx
= 0; fi_idx
< info
->n_functions
; fi_idx
++) {
332 if (!info
->functions
[fi_idx
])
335 ci_ptr
= info
->functions
[fi_idx
]->ctrs
;
337 for (ct_idx
= 0; ct_idx
< active
; ct_idx
++, ci_ptr
++)
338 vfree(ci_ptr
->values
);
340 kfree(info
->functions
[fi_idx
]);
344 kfree(info
->functions
);
345 kfree(info
->filename
);
349 #define ITER_STRIDE PAGE_SIZE
352 * struct gcov_iterator - specifies current file position in logical records
353 * @info: associated profiling data
354 * @buffer: buffer containing file data
355 * @size: size of buffer
356 * @pos: current position in file
358 struct gcov_iterator
{
359 struct gcov_info
*info
;
366 * store_gcov_u32 - store 32 bit number in gcov format to buffer
367 * @buffer: target buffer or NULL
368 * @off: offset into the buffer
369 * @v: value to be stored
371 * Number format defined by gcc: numbers are recorded in the 32 bit
372 * unsigned binary form of the endianness of the machine generating the
373 * file. Returns the number of bytes stored. If @buffer is %NULL, doesn't
376 static size_t store_gcov_u32(void *buffer
, size_t off
, u32 v
)
385 return sizeof(*data
);
389 * store_gcov_u64 - store 64 bit number in gcov format to buffer
390 * @buffer: target buffer or NULL
391 * @off: offset into the buffer
392 * @v: value to be stored
394 * Number format defined by gcc: numbers are recorded in the 32 bit
395 * unsigned binary form of the endianness of the machine generating the
396 * file. 64 bit numbers are stored as two 32 bit numbers, the low part
397 * first. Returns the number of bytes stored. If @buffer is %NULL, doesn't store
400 static size_t store_gcov_u64(void *buffer
, size_t off
, u64 v
)
407 data
[0] = (v
& 0xffffffffUL
);
411 return sizeof(*data
) * 2;
415 * convert_to_gcda - convert profiling data set to gcda file format
416 * @buffer: the buffer to store file data or %NULL if no data should be stored
417 * @info: profiling data set to be converted
419 * Returns the number of bytes that were/would have been stored into the buffer.
421 static size_t convert_to_gcda(char *buffer
, struct gcov_info
*info
)
423 struct gcov_fn_info
*fi_ptr
;
424 struct gcov_ctr_info
*ci_ptr
;
431 pos
+= store_gcov_u32(buffer
, pos
, GCOV_DATA_MAGIC
);
432 pos
+= store_gcov_u32(buffer
, pos
, info
->version
);
433 pos
+= store_gcov_u32(buffer
, pos
, info
->stamp
);
435 for (fi_idx
= 0; fi_idx
< info
->n_functions
; fi_idx
++) {
436 fi_ptr
= info
->functions
[fi_idx
];
438 /* Function record. */
439 pos
+= store_gcov_u32(buffer
, pos
, GCOV_TAG_FUNCTION
);
440 pos
+= store_gcov_u32(buffer
, pos
, GCOV_TAG_FUNCTION_LENGTH
);
441 pos
+= store_gcov_u32(buffer
, pos
, fi_ptr
->ident
);
442 pos
+= store_gcov_u32(buffer
, pos
, fi_ptr
->lineno_checksum
);
443 pos
+= store_gcov_u32(buffer
, pos
, fi_ptr
->cfg_checksum
);
445 ci_ptr
= fi_ptr
->ctrs
;
447 for (ct_idx
= 0; ct_idx
< GCOV_COUNTERS
; ct_idx
++) {
448 if (!counter_active(info
, ct_idx
))
451 /* Counter record. */
452 pos
+= store_gcov_u32(buffer
, pos
,
453 GCOV_TAG_FOR_COUNTER(ct_idx
));
454 pos
+= store_gcov_u32(buffer
, pos
, ci_ptr
->num
* 2);
456 for (cv_idx
= 0; cv_idx
< ci_ptr
->num
; cv_idx
++) {
457 pos
+= store_gcov_u64(buffer
, pos
,
458 ci_ptr
->values
[cv_idx
]);
469 * gcov_iter_new - allocate and initialize profiling data iterator
470 * @info: profiling data set to be iterated
472 * Return file iterator on success, %NULL otherwise.
474 struct gcov_iterator
*gcov_iter_new(struct gcov_info
*info
)
476 struct gcov_iterator
*iter
;
478 iter
= kzalloc(sizeof(struct gcov_iterator
), GFP_KERNEL
);
483 /* Dry-run to get the actual buffer size. */
484 iter
->size
= convert_to_gcda(NULL
, info
);
485 iter
->buffer
= vmalloc(iter
->size
);
489 convert_to_gcda(iter
->buffer
, info
);
500 * gcov_iter_get_info - return profiling data set for given file iterator
501 * @iter: file iterator
503 void gcov_iter_free(struct gcov_iterator
*iter
)
510 * gcov_iter_get_info - return profiling data set for given file iterator
511 * @iter: file iterator
513 struct gcov_info
*gcov_iter_get_info(struct gcov_iterator
*iter
)
519 * gcov_iter_start - reset file iterator to starting position
520 * @iter: file iterator
522 void gcov_iter_start(struct gcov_iterator
*iter
)
528 * gcov_iter_next - advance file iterator to next logical record
529 * @iter: file iterator
531 * Return zero if new position is valid, non-zero if iterator has reached end.
533 int gcov_iter_next(struct gcov_iterator
*iter
)
535 if (iter
->pos
< iter
->size
)
536 iter
->pos
+= ITER_STRIDE
;
538 if (iter
->pos
>= iter
->size
)
545 * gcov_iter_write - write data for current pos to seq_file
546 * @iter: file iterator
547 * @seq: seq_file handle
549 * Return zero on success, non-zero otherwise.
551 int gcov_iter_write(struct gcov_iterator
*iter
, struct seq_file
*seq
)
555 if (iter
->pos
>= iter
->size
)
559 if (iter
->pos
+ len
> iter
->size
)
560 len
= iter
->size
- iter
->pos
;
562 seq_write(seq
, iter
->buffer
+ iter
->pos
, len
);