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 #define GCOV_COUNTERS 8
22 #define GCOV_TAG_FUNCTION_LENGTH 3
24 static struct gcov_info
*gcov_info_head
;
27 * struct gcov_ctr_info - information about counters for a single function
28 * @num: number of counter values for this type
29 * @values: array of counter values for this type
31 * This data is generated by gcc during compilation and doesn't change
32 * at run-time with the exception of the values array.
34 struct gcov_ctr_info
{
40 * struct gcov_fn_info - profiling meta data per function
42 * @ident: unique ident of function
43 * @lineno_checksum: function lineo_checksum
44 * @cfg_checksum: function cfg checksum
45 * @ctrs: instrumented counters
47 * This data is generated by gcc during compilation and doesn't change
50 * Information about a single function. This uses the trailing array
51 * idiom. The number of counters is determined from the merge pointer
52 * array in gcov_info. The key is used to detect which of a set of
53 * comdat functions was selected -- it points to the gcov_info object
54 * of the object file containing the selected comdat function.
57 const struct gcov_info
*key
;
59 unsigned int lineno_checksum
;
60 unsigned int cfg_checksum
;
61 struct gcov_ctr_info ctrs
[0];
65 * struct gcov_info - profiling data per object file
66 * @version: gcov version magic indicating the gcc version used for compilation
67 * @next: list head for a singly-linked list
68 * @stamp: uniquifying time stamp
69 * @filename: name of the associated gcov data file
70 * @merge: merge functions (null for unused counter type)
71 * @n_functions: number of instrumented functions
72 * @functions: pointer to pointers to function information
74 * This data is generated by gcc during compilation and doesn't change
75 * at run-time with the exception of the next pointer.
79 struct gcov_info
*next
;
82 void (*merge
[GCOV_COUNTERS
])(gcov_type
*, unsigned int);
83 unsigned int n_functions
;
84 struct gcov_fn_info
**functions
;
88 * gcov_info_filename - return info filename
89 * @info: profiling data set
91 const char *gcov_info_filename(struct gcov_info
*info
)
93 return info
->filename
;
97 * gcov_info_version - return info version
98 * @info: profiling data set
100 unsigned int gcov_info_version(struct gcov_info
*info
)
102 return info
->version
;
106 * gcov_info_next - return next profiling data set
107 * @info: profiling data set
109 * Returns next gcov_info following @info or first gcov_info in the chain if
112 struct gcov_info
*gcov_info_next(struct gcov_info
*info
)
115 return gcov_info_head
;
121 * gcov_info_link - link/add profiling data set to the list
122 * @info: profiling data set
124 void gcov_info_link(struct gcov_info
*info
)
126 info
->next
= gcov_info_head
;
127 gcov_info_head
= info
;
131 * gcov_info_unlink - unlink/remove profiling data set from the list
132 * @prev: previous profiling data set
133 * @info: profiling data set
135 void gcov_info_unlink(struct gcov_info
*prev
, struct gcov_info
*info
)
138 prev
->next
= info
->next
;
140 gcov_info_head
= info
->next
;
143 /* Symbolic links to be created for each profiling data file. */
144 const struct gcov_link gcov_link
[] = {
145 { OBJ_TREE
, "gcno" }, /* Link to .gcno file in $(objtree). */
150 * Determine whether a counter is active. Doesn't change at run-time.
152 static int counter_active(struct gcov_info
*info
, unsigned int type
)
154 return info
->merge
[type
] ? 1 : 0;
157 /* Determine number of active counters. Based on gcc magic. */
158 static unsigned int num_counter_active(struct gcov_info
*info
)
161 unsigned int result
= 0;
163 for (i
= 0; i
< GCOV_COUNTERS
; i
++) {
164 if (counter_active(info
, i
))
171 * gcov_info_reset - reset profiling data to zero
172 * @info: profiling data set
174 void gcov_info_reset(struct gcov_info
*info
)
176 struct gcov_ctr_info
*ci_ptr
;
180 for (fi_idx
= 0; fi_idx
< info
->n_functions
; fi_idx
++) {
181 ci_ptr
= info
->functions
[fi_idx
]->ctrs
;
183 for (ct_idx
= 0; ct_idx
< GCOV_COUNTERS
; ct_idx
++) {
184 if (!counter_active(info
, ct_idx
))
187 memset(ci_ptr
->values
, 0,
188 sizeof(gcov_type
) * ci_ptr
->num
);
195 * gcov_info_is_compatible - check if profiling data can be added
196 * @info1: first profiling data set
197 * @info2: second profiling data set
199 * Returns non-zero if profiling data can be added, zero otherwise.
201 int gcov_info_is_compatible(struct gcov_info
*info1
, struct gcov_info
*info2
)
203 return (info1
->stamp
== info2
->stamp
);
207 * gcov_info_add - add up profiling data
208 * @dest: profiling data set to which data is added
209 * @source: profiling data set which is added
211 * Adds profiling counts of @source to @dest.
213 void gcov_info_add(struct gcov_info
*dst
, struct gcov_info
*src
)
215 struct gcov_ctr_info
*dci_ptr
;
216 struct gcov_ctr_info
*sci_ptr
;
219 unsigned int val_idx
;
221 for (fi_idx
= 0; fi_idx
< src
->n_functions
; fi_idx
++) {
222 dci_ptr
= dst
->functions
[fi_idx
]->ctrs
;
223 sci_ptr
= src
->functions
[fi_idx
]->ctrs
;
225 for (ct_idx
= 0; ct_idx
< GCOV_COUNTERS
; ct_idx
++) {
226 if (!counter_active(src
, ct_idx
))
229 for (val_idx
= 0; val_idx
< sci_ptr
->num
; val_idx
++)
230 dci_ptr
->values
[val_idx
] +=
231 sci_ptr
->values
[val_idx
];
240 * gcov_info_dup - duplicate profiling data set
241 * @info: profiling data set to duplicate
243 * Return newly allocated duplicate on success, %NULL on error.
245 struct gcov_info
*gcov_info_dup(struct gcov_info
*info
)
247 struct gcov_info
*dup
;
248 struct gcov_ctr_info
*dci_ptr
; /* dst counter info */
249 struct gcov_ctr_info
*sci_ptr
; /* src counter info */
251 unsigned int fi_idx
; /* function info idx */
252 unsigned int ct_idx
; /* counter type idx */
253 size_t fi_size
; /* function info size */
254 size_t cv_size
; /* counter values size */
256 dup
= kmemdup(info
, sizeof(*dup
), GFP_KERNEL
);
261 dup
->filename
= NULL
;
262 dup
->functions
= NULL
;
264 dup
->filename
= kstrdup(info
->filename
, GFP_KERNEL
);
268 dup
->functions
= kcalloc(info
->n_functions
,
269 sizeof(struct gcov_fn_info
*), GFP_KERNEL
);
273 active
= num_counter_active(info
);
274 fi_size
= sizeof(struct gcov_fn_info
);
275 fi_size
+= sizeof(struct gcov_ctr_info
) * active
;
277 for (fi_idx
= 0; fi_idx
< info
->n_functions
; fi_idx
++) {
278 dup
->functions
[fi_idx
] = kzalloc(fi_size
, GFP_KERNEL
);
279 if (!dup
->functions
[fi_idx
])
282 *(dup
->functions
[fi_idx
]) = *(info
->functions
[fi_idx
]);
284 sci_ptr
= info
->functions
[fi_idx
]->ctrs
;
285 dci_ptr
= dup
->functions
[fi_idx
]->ctrs
;
287 for (ct_idx
= 0; ct_idx
< active
; ct_idx
++) {
289 cv_size
= sizeof(gcov_type
) * sci_ptr
->num
;
291 dci_ptr
->values
= vmalloc(cv_size
);
293 if (!dci_ptr
->values
)
296 dci_ptr
->num
= sci_ptr
->num
;
297 memcpy(dci_ptr
->values
, sci_ptr
->values
, cv_size
);
311 * gcov_info_free - release memory for profiling data set duplicate
312 * @info: profiling data set duplicate to free
314 void gcov_info_free(struct gcov_info
*info
)
319 struct gcov_ctr_info
*ci_ptr
;
321 if (!info
->functions
)
324 active
= num_counter_active(info
);
326 for (fi_idx
= 0; fi_idx
< info
->n_functions
; fi_idx
++) {
327 if (!info
->functions
[fi_idx
])
330 ci_ptr
= info
->functions
[fi_idx
]->ctrs
;
332 for (ct_idx
= 0; ct_idx
< active
; ct_idx
++, ci_ptr
++)
333 vfree(ci_ptr
->values
);
335 kfree(info
->functions
[fi_idx
]);
339 kfree(info
->functions
);
340 kfree(info
->filename
);
344 #define ITER_STRIDE PAGE_SIZE
347 * struct gcov_iterator - specifies current file position in logical records
348 * @info: associated profiling data
349 * @buffer: buffer containing file data
350 * @size: size of buffer
351 * @pos: current position in file
353 struct gcov_iterator
{
354 struct gcov_info
*info
;
361 * store_gcov_u32 - store 32 bit number in gcov format to buffer
362 * @buffer: target buffer or NULL
363 * @off: offset into the buffer
364 * @v: value to be stored
366 * Number format defined by gcc: numbers are recorded in the 32 bit
367 * unsigned binary form of the endianness of the machine generating the
368 * file. Returns the number of bytes stored. If @buffer is %NULL, doesn't
371 static size_t store_gcov_u32(void *buffer
, size_t off
, u32 v
)
380 return sizeof(*data
);
384 * store_gcov_u64 - store 64 bit number in gcov format to buffer
385 * @buffer: target buffer or NULL
386 * @off: offset into the buffer
387 * @v: value to be stored
389 * Number format defined by gcc: numbers are recorded in the 32 bit
390 * unsigned binary form of the endianness of the machine generating the
391 * file. 64 bit numbers are stored as two 32 bit numbers, the low part
392 * first. Returns the number of bytes stored. If @buffer is %NULL, doesn't store
395 static size_t store_gcov_u64(void *buffer
, size_t off
, u64 v
)
402 data
[0] = (v
& 0xffffffffUL
);
406 return sizeof(*data
) * 2;
410 * convert_to_gcda - convert profiling data set to gcda file format
411 * @buffer: the buffer to store file data or %NULL if no data should be stored
412 * @info: profiling data set to be converted
414 * Returns the number of bytes that were/would have been stored into the buffer.
416 static size_t convert_to_gcda(char *buffer
, struct gcov_info
*info
)
418 struct gcov_fn_info
*fi_ptr
;
419 struct gcov_ctr_info
*ci_ptr
;
426 pos
+= store_gcov_u32(buffer
, pos
, GCOV_DATA_MAGIC
);
427 pos
+= store_gcov_u32(buffer
, pos
, info
->version
);
428 pos
+= store_gcov_u32(buffer
, pos
, info
->stamp
);
430 for (fi_idx
= 0; fi_idx
< info
->n_functions
; fi_idx
++) {
431 fi_ptr
= info
->functions
[fi_idx
];
433 /* Function record. */
434 pos
+= store_gcov_u32(buffer
, pos
, GCOV_TAG_FUNCTION
);
435 pos
+= store_gcov_u32(buffer
, pos
, GCOV_TAG_FUNCTION_LENGTH
);
436 pos
+= store_gcov_u32(buffer
, pos
, fi_ptr
->ident
);
437 pos
+= store_gcov_u32(buffer
, pos
, fi_ptr
->lineno_checksum
);
438 pos
+= store_gcov_u32(buffer
, pos
, fi_ptr
->cfg_checksum
);
440 ci_ptr
= fi_ptr
->ctrs
;
442 for (ct_idx
= 0; ct_idx
< GCOV_COUNTERS
; ct_idx
++) {
443 if (!counter_active(info
, ct_idx
))
446 /* Counter record. */
447 pos
+= store_gcov_u32(buffer
, pos
,
448 GCOV_TAG_FOR_COUNTER(ct_idx
));
449 pos
+= store_gcov_u32(buffer
, pos
, ci_ptr
->num
* 2);
451 for (cv_idx
= 0; cv_idx
< ci_ptr
->num
; cv_idx
++) {
452 pos
+= store_gcov_u64(buffer
, pos
,
453 ci_ptr
->values
[cv_idx
]);
464 * gcov_iter_new - allocate and initialize profiling data iterator
465 * @info: profiling data set to be iterated
467 * Return file iterator on success, %NULL otherwise.
469 struct gcov_iterator
*gcov_iter_new(struct gcov_info
*info
)
471 struct gcov_iterator
*iter
;
473 iter
= kzalloc(sizeof(struct gcov_iterator
), GFP_KERNEL
);
478 /* Dry-run to get the actual buffer size. */
479 iter
->size
= convert_to_gcda(NULL
, info
);
480 iter
->buffer
= vmalloc(iter
->size
);
484 convert_to_gcda(iter
->buffer
, info
);
495 * gcov_iter_get_info - return profiling data set for given file iterator
496 * @iter: file iterator
498 void gcov_iter_free(struct gcov_iterator
*iter
)
505 * gcov_iter_get_info - return profiling data set for given file iterator
506 * @iter: file iterator
508 struct gcov_info
*gcov_iter_get_info(struct gcov_iterator
*iter
)
514 * gcov_iter_start - reset file iterator to starting position
515 * @iter: file iterator
517 void gcov_iter_start(struct gcov_iterator
*iter
)
523 * gcov_iter_next - advance file iterator to next logical record
524 * @iter: file iterator
526 * Return zero if new position is valid, non-zero if iterator has reached end.
528 int gcov_iter_next(struct gcov_iterator
*iter
)
530 if (iter
->pos
< iter
->size
)
531 iter
->pos
+= ITER_STRIDE
;
533 if (iter
->pos
>= iter
->size
)
540 * gcov_iter_write - write data for current pos to seq_file
541 * @iter: file iterator
542 * @seq: seq_file handle
544 * Return zero on success, non-zero otherwise.
546 int gcov_iter_write(struct gcov_iterator
*iter
, struct seq_file
*seq
)
550 if (iter
->pos
>= iter
->size
)
554 if (iter
->pos
+ len
> iter
->size
)
555 len
= iter
->size
- iter
->pos
;
557 seq_write(seq
, iter
->buffer
+ iter
->pos
, len
);