kernel/gcov/gcc_4_7.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *  This code provides functions to handle gcc's profiling data format
   4  *  introduced with gcc 4.7.
   5  *
   6  *  This file is based heavily on gcc_3_4.c file.
   7  *
   8  *  For a better understanding, refer to gcc source:
   9  *  gcc/gcov-io.h
  10  *  libgcc/libgcov.c
  11  *
  12  *  Uses gcc-internal data definitions.
  13  */
  14
  15 #include <linux/errno.h>
  16 #include <linux/slab.h>
  17 #include <linux/string.h>
  18 #include <linux/seq_file.h>
  19 #include <linux/vmalloc.h>
  20 #include "gcov.h"
  21
  22 #if (__GNUC__ >= 10)
  23 #define GCOV_COUNTERS                   8
  24 #elif (__GNUC__ >= 7)
  25 #define GCOV_COUNTERS                   9
  26 #elif (__GNUC__ > 5) || (__GNUC__ == 5 && __GNUC_MINOR__ >= 1)
  27 #define GCOV_COUNTERS                   10
  28 #elif __GNUC__ == 4 && __GNUC_MINOR__ >= 9
  29 #define GCOV_COUNTERS                   9
  30 #else
  31 #define GCOV_COUNTERS                   8
  32 #endif
  33
  34 #define GCOV_TAG_FUNCTION_LENGTH        3
  35
  36 /* Since GCC 12.1 sizes are in BYTES and not in WORDS (4B). */
  37 #if (__GNUC__ >= 12)
  38 #define GCOV_UNIT_SIZE                          4
  39 #else
  40 #define GCOV_UNIT_SIZE                          1
  41 #endif
  42
  43 static struct gcov_info *gcov_info_head;
  44
  45 /**
  46  * struct gcov_ctr_info - information about counters for a single function
  47  * @num: number of counter values for this type
  48  * @values: array of counter values for this type
  49  *
  50  * This data is generated by gcc during compilation and doesn't change
  51  * at run-time with the exception of the values array.
  52  */
  53 struct gcov_ctr_info {
  54         unsigned int num;
  55         gcov_type *values;
  56 };
  57
  58 /**
  59  * struct gcov_fn_info - profiling meta data per function
  60  * @key: comdat key
  61  * @ident: unique ident of function
  62  * @lineno_checksum: function lineo_checksum
  63  * @cfg_checksum: function cfg checksum
  64  * @ctrs: instrumented counters
  65  *
  66  * This data is generated by gcc during compilation and doesn't change
  67  * at run-time.
  68  *
  69  * Information about a single function.  This uses the trailing array
  70  * idiom. The number of counters is determined from the merge pointer
  71  * array in gcov_info.  The key is used to detect which of a set of
  72  * comdat functions was selected -- it points to the gcov_info object
  73  * of the object file containing the selected comdat function.
  74  */
  75 struct gcov_fn_info {
  76         const struct gcov_info *key;
  77         unsigned int ident;
  78         unsigned int lineno_checksum;
  79         unsigned int cfg_checksum;
  80         struct gcov_ctr_info ctrs[0];
  81 };
  82
  83 /**
  84  * struct gcov_info - profiling data per object file
  85  * @version: gcov version magic indicating the gcc version used for compilation
  86  * @next: list head for a singly-linked list
  87  * @stamp: uniquifying time stamp
  88  * @checksum: unique object checksum
  89  * @filename: name of the associated gcov data file
  90  * @merge: merge functions (null for unused counter type)
  91  * @n_functions: number of instrumented functions
  92  * @functions: pointer to pointers to function information
  93  *
  94  * This data is generated by gcc during compilation and doesn't change
  95  * at run-time with the exception of the next pointer.
  96  */
  97 struct gcov_info {
  98         unsigned int version;
  99         struct gcov_info *next;
 100         unsigned int stamp;
 101  /* Since GCC 12.1 a checksum field is added. */
 102 #if (__GNUC__ >= 12)
 103         unsigned int checksum;
 104 #endif
 105         const char *filename;
 106         void (*merge[GCOV_COUNTERS])(gcov_type *, unsigned int);
 107         unsigned int n_functions;
 108         struct gcov_fn_info **functions;
 109 };
 110
 111 /**
 112  * gcov_info_filename - return info filename
 113  * @info: profiling data set
 114  */
 115 const char *gcov_info_filename(struct gcov_info *info)
 116 {
 117         return info->filename;
 118 }
 119
 120 /**
 121  * gcov_info_version - return info version
 122  * @info: profiling data set
 123  */
 124 unsigned int gcov_info_version(struct gcov_info *info)
 125 {
 126         return info->version;
 127 }
 128
 129 /**
 130  * gcov_info_next - return next profiling data set
 131  * @info: profiling data set
 132  *
 133  * Returns next gcov_info following @info or first gcov_info in the chain if
 134  * @info is %NULL.
 135  */
 136 struct gcov_info *gcov_info_next(struct gcov_info *info)
 137 {
 138         if (!info)
 139                 return gcov_info_head;
 140
 141         return info->next;
 142 }
 143
 144 /**
 145  * gcov_info_link - link/add profiling data set to the list
 146  * @info: profiling data set
 147  */
 148 void gcov_info_link(struct gcov_info *info)
 149 {
 150         info->next = gcov_info_head;
 151         gcov_info_head = info;
 152 }
 153
 154 /**
 155  * gcov_info_unlink - unlink/remove profiling data set from the list
 156  * @prev: previous profiling data set
 157  * @info: profiling data set
 158  */
 159 void gcov_info_unlink(struct gcov_info *prev, struct gcov_info *info)
 160 {
 161         if (prev)
 162                 prev->next = info->next;
 163         else
 164                 gcov_info_head = info->next;
 165 }
 166
 167 /* Symbolic links to be created for each profiling data file. */
 168 const struct gcov_link gcov_link[] = {
 169         { OBJ_TREE, "gcno" },   /* Link to .gcno file in $(objtree). */
 170         { 0, NULL},
 171 };
 172
 173 /*
 174  * Determine whether a counter is active. Doesn't change at run-time.
 175  */
 176 static int counter_active(struct gcov_info *info, unsigned int type)
 177 {
 178         return info->merge[type] ? 1 : 0;
 179 }
 180
 181 /* Determine number of active counters. Based on gcc magic. */
 182 static unsigned int num_counter_active(struct gcov_info *info)
 183 {
 184         unsigned int i;
 185         unsigned int result = 0;
 186
 187         for (i = 0; i < GCOV_COUNTERS; i++) {
 188                 if (counter_active(info, i))
 189                         result++;
 190         }
 191         return result;
 192 }
 193
 194 /**
 195  * gcov_info_reset - reset profiling data to zero
 196  * @info: profiling data set
 197  */
 198 void gcov_info_reset(struct gcov_info *info)
 199 {
 200         struct gcov_ctr_info *ci_ptr;
 201         unsigned int fi_idx;
 202         unsigned int ct_idx;
 203
 204         for (fi_idx = 0; fi_idx < info->n_functions; fi_idx++) {
 205                 ci_ptr = info->functions[fi_idx]->ctrs;
 206
 207                 for (ct_idx = 0; ct_idx < GCOV_COUNTERS; ct_idx++) {
 208                         if (!counter_active(info, ct_idx))
 209                                 continue;
 210
 211                         memset(ci_ptr->values, 0,
 212                                         sizeof(gcov_type) * ci_ptr->num);
 213                         ci_ptr++;
 214                 }
 215         }
 216 }
 217
 218 /**
 219  * gcov_info_is_compatible - check if profiling data can be added
 220  * @info1: first profiling data set
 221  * @info2: second profiling data set
 222  *
 223  * Returns non-zero if profiling data can be added, zero otherwise.
 224  */
 225 int gcov_info_is_compatible(struct gcov_info *info1, struct gcov_info *info2)
 226 {
 227         return (info1->stamp == info2->stamp);
 228 }
 229
 230 /**
 231  * gcov_info_add - add up profiling data
 232  * @dest: profiling data set to which data is added
 233  * @source: profiling data set which is added
 234  *
 235  * Adds profiling counts of @source to @dest.
 236  */
 237 void gcov_info_add(struct gcov_info *dst, struct gcov_info *src)
 238 {
 239         struct gcov_ctr_info *dci_ptr;
 240         struct gcov_ctr_info *sci_ptr;
 241         unsigned int fi_idx;
 242         unsigned int ct_idx;
 243         unsigned int val_idx;
 244
 245         for (fi_idx = 0; fi_idx < src->n_functions; fi_idx++) {
 246                 dci_ptr = dst->functions[fi_idx]->ctrs;
 247                 sci_ptr = src->functions[fi_idx]->ctrs;
 248
 249                 for (ct_idx = 0; ct_idx < GCOV_COUNTERS; ct_idx++) {
 250                         if (!counter_active(src, ct_idx))
 251                                 continue;
 252
 253                         for (val_idx = 0; val_idx < sci_ptr->num; val_idx++)
 254                                 dci_ptr->values[val_idx] +=
 255                                         sci_ptr->values[val_idx];
 256
 257                         dci_ptr++;
 258                         sci_ptr++;
 259                 }
 260         }
 261 }
 262
 263 /**
 264  * gcov_info_dup - duplicate profiling data set
 265  * @info: profiling data set to duplicate
 266  *
 267  * Return newly allocated duplicate on success, %NULL on error.
 268  */
 269 struct gcov_info *gcov_info_dup(struct gcov_info *info)
 270 {
 271         struct gcov_info *dup;
 272         struct gcov_ctr_info *dci_ptr; /* dst counter info */
 273         struct gcov_ctr_info *sci_ptr; /* src counter info */
 274         unsigned int active;
 275         unsigned int fi_idx; /* function info idx */
 276         unsigned int ct_idx; /* counter type idx */
 277         size_t fi_size; /* function info size */
 278         size_t cv_size; /* counter values size */
 279
 280         dup = kmemdup(info, sizeof(*dup), GFP_KERNEL);
 281         if (!dup)
 282                 return NULL;
 283
 284         dup->next = NULL;
 285         dup->filename = NULL;
 286         dup->functions = NULL;
 287
 288         dup->filename = kstrdup(info->filename, GFP_KERNEL);
 289         if (!dup->filename)
 290                 goto err_free;
 291
 292         dup->functions = kcalloc(info->n_functions,
 293                                  sizeof(struct gcov_fn_info *), GFP_KERNEL);
 294         if (!dup->functions)
 295                 goto err_free;
 296
 297         active = num_counter_active(info);
 298         fi_size = sizeof(struct gcov_fn_info);
 299         fi_size += sizeof(struct gcov_ctr_info) * active;
 300
 301         for (fi_idx = 0; fi_idx < info->n_functions; fi_idx++) {
 302                 dup->functions[fi_idx] = kzalloc(fi_size, GFP_KERNEL);
 303                 if (!dup->functions[fi_idx])
 304                         goto err_free;
 305
 306                 *(dup->functions[fi_idx]) = *(info->functions[fi_idx]);
 307
 308                 sci_ptr = info->functions[fi_idx]->ctrs;
 309                 dci_ptr = dup->functions[fi_idx]->ctrs;
 310
 311                 for (ct_idx = 0; ct_idx < active; ct_idx++) {
 312
 313                         cv_size = sizeof(gcov_type) * sci_ptr->num;
 314
 315                         dci_ptr->values = vmalloc(cv_size);
 316
 317                         if (!dci_ptr->values)
 318                                 goto err_free;
 319
 320                         dci_ptr->num = sci_ptr->num;
 321                         memcpy(dci_ptr->values, sci_ptr->values, cv_size);
 322
 323                         sci_ptr++;
 324                         dci_ptr++;
 325                 }
 326         }
 327
 328         return dup;
 329 err_free:
 330         gcov_info_free(dup);
 331         return NULL;
 332 }
 333
 334 /**
 335  * gcov_info_free - release memory for profiling data set duplicate
 336  * @info: profiling data set duplicate to free
 337  */
 338 void gcov_info_free(struct gcov_info *info)
 339 {
 340         unsigned int active;
 341         unsigned int fi_idx;
 342         unsigned int ct_idx;
 343         struct gcov_ctr_info *ci_ptr;
 344
 345         if (!info->functions)
 346                 goto free_info;
 347
 348         active = num_counter_active(info);
 349
 350         for (fi_idx = 0; fi_idx < info->n_functions; fi_idx++) {
 351                 if (!info->functions[fi_idx])
 352                         continue;
 353
 354                 ci_ptr = info->functions[fi_idx]->ctrs;
 355
 356                 for (ct_idx = 0; ct_idx < active; ct_idx++, ci_ptr++)
 357                         vfree(ci_ptr->values);
 358
 359                 kfree(info->functions[fi_idx]);
 360         }
 361
 362 free_info:
 363         kfree(info->functions);
 364         kfree(info->filename);
 365         kfree(info);
 366 }
 367
 368 #define ITER_STRIDE     PAGE_SIZE
 369
 370 /**
 371  * struct gcov_iterator - specifies current file position in logical records
 372  * @info: associated profiling data
 373  * @buffer: buffer containing file data
 374  * @size: size of buffer
 375  * @pos: current position in file
 376  */
 377 struct gcov_iterator {
 378         struct gcov_info *info;
 379         void *buffer;
 380         size_t size;
 381         loff_t pos;
 382 };
 383
 384 /**
 385  * store_gcov_u32 - store 32 bit number in gcov format to buffer
 386  * @buffer: target buffer or NULL
 387  * @off: offset into the buffer
 388  * @v: value to be stored
 389  *
 390  * Number format defined by gcc: numbers are recorded in the 32 bit
 391  * unsigned binary form of the endianness of the machine generating the
 392  * file. Returns the number of bytes stored. If @buffer is %NULL, doesn't
 393  * store anything.
 394  */
 395 static size_t store_gcov_u32(void *buffer, size_t off, u32 v)
 396 {
 397         u32 *data;
 398
 399         if (buffer) {
 400                 data = buffer + off;
 401                 *data = v;
 402         }
 403
 404         return sizeof(*data);
 405 }
 406
 407 /**
 408  * store_gcov_u64 - store 64 bit number in gcov format to buffer
 409  * @buffer: target buffer or NULL
 410  * @off: offset into the buffer
 411  * @v: value to be stored
 412  *
 413  * Number format defined by gcc: numbers are recorded in the 32 bit
 414  * unsigned binary form of the endianness of the machine generating the
 415  * file. 64 bit numbers are stored as two 32 bit numbers, the low part
 416  * first. Returns the number of bytes stored. If @buffer is %NULL, doesn't store
 417  * anything.
 418  */
 419 static size_t store_gcov_u64(void *buffer, size_t off, u64 v)
 420 {
 421         u32 *data;
 422
 423         if (buffer) {
 424                 data = buffer + off;
 425
 426                 data[0] = (v & 0xffffffffUL);
 427                 data[1] = (v >> 32);
 428         }
 429
 430         return sizeof(*data) * 2;
 431 }
 432
 433 /**
 434  * convert_to_gcda - convert profiling data set to gcda file format
 435  * @buffer: the buffer to store file data or %NULL if no data should be stored
 436  * @info: profiling data set to be converted
 437  *
 438  * Returns the number of bytes that were/would have been stored into the buffer.
 439  */
 440 static size_t convert_to_gcda(char *buffer, struct gcov_info *info)
 441 {
 442         struct gcov_fn_info *fi_ptr;
 443         struct gcov_ctr_info *ci_ptr;
 444         unsigned int fi_idx;
 445         unsigned int ct_idx;
 446         unsigned int cv_idx;
 447         size_t pos = 0;
 448
 449         /* File header. */
 450         pos += store_gcov_u32(buffer, pos, GCOV_DATA_MAGIC);
 451         pos += store_gcov_u32(buffer, pos, info->version);
 452         pos += store_gcov_u32(buffer, pos, info->stamp);
 453
 454 #if (__GNUC__ >= 12)
 455         /* Use zero as checksum of the compilation unit. */
 456         pos += store_gcov_u32(buffer, pos, 0);
 457 #endif
 458
 459         for (fi_idx = 0; fi_idx < info->n_functions; fi_idx++) {
 460                 fi_ptr = info->functions[fi_idx];
 461
 462                 /* Function record. */
 463                 pos += store_gcov_u32(buffer, pos, GCOV_TAG_FUNCTION);
 464                 pos += store_gcov_u32(buffer, pos,
 465                         GCOV_TAG_FUNCTION_LENGTH * GCOV_UNIT_SIZE);
 466                 pos += store_gcov_u32(buffer, pos, fi_ptr->ident);
 467                 pos += store_gcov_u32(buffer, pos, fi_ptr->lineno_checksum);
 468                 pos += store_gcov_u32(buffer, pos, fi_ptr->cfg_checksum);
 469
 470                 ci_ptr = fi_ptr->ctrs;
 471
 472                 for (ct_idx = 0; ct_idx < GCOV_COUNTERS; ct_idx++) {
 473                         if (!counter_active(info, ct_idx))
 474                                 continue;
 475
 476                         /* Counter record. */
 477                         pos += store_gcov_u32(buffer, pos,
 478                                               GCOV_TAG_FOR_COUNTER(ct_idx));
 479                         pos += store_gcov_u32(buffer, pos,
 480                                 ci_ptr->num * 2 * GCOV_UNIT_SIZE);
 481
 482                         for (cv_idx = 0; cv_idx < ci_ptr->num; cv_idx++) {
 483                                 pos += store_gcov_u64(buffer, pos,
 484                                                       ci_ptr->values[cv_idx]);
 485                         }
 486
 487                         ci_ptr++;
 488                 }
 489         }
 490
 491         return pos;
 492 }
 493
 494 /**
 495  * gcov_iter_new - allocate and initialize profiling data iterator
 496  * @info: profiling data set to be iterated
 497  *
 498  * Return file iterator on success, %NULL otherwise.
 499  */
 500 struct gcov_iterator *gcov_iter_new(struct gcov_info *info)
 501 {
 502         struct gcov_iterator *iter;
 503
 504         iter = kzalloc(sizeof(struct gcov_iterator), GFP_KERNEL);
 505         if (!iter)
 506                 goto err_free;
 507
 508         iter->info = info;
 509         /* Dry-run to get the actual buffer size. */
 510         iter->size = convert_to_gcda(NULL, info);
 511         iter->buffer = vmalloc(iter->size);
 512         if (!iter->buffer)
 513                 goto err_free;
 514
 515         convert_to_gcda(iter->buffer, info);
 516
 517         return iter;
 518
 519 err_free:
 520         kfree(iter);
 521         return NULL;
 522 }
 523
 524
 525 /**
 526  * gcov_iter_get_info - return profiling data set for given file iterator
 527  * @iter: file iterator
 528  */
 529 void gcov_iter_free(struct gcov_iterator *iter)
 530 {
 531         vfree(iter->buffer);
 532         kfree(iter);
 533 }
 534
 535 /**
 536  * gcov_iter_get_info - return profiling data set for given file iterator
 537  * @iter: file iterator
 538  */
 539 struct gcov_info *gcov_iter_get_info(struct gcov_iterator *iter)
 540 {
 541         return iter->info;
 542 }
 543
 544 /**
 545  * gcov_iter_start - reset file iterator to starting position
 546  * @iter: file iterator
 547  */
 548 void gcov_iter_start(struct gcov_iterator *iter)
 549 {
 550         iter->pos = 0;
 551 }
 552
 553 /**
 554  * gcov_iter_next - advance file iterator to next logical record
 555  * @iter: file iterator
 556  *
 557  * Return zero if new position is valid, non-zero if iterator has reached end.
 558  */
 559 int gcov_iter_next(struct gcov_iterator *iter)
 560 {
 561         if (iter->pos < iter->size)
 562                 iter->pos += ITER_STRIDE;
 563
 564         if (iter->pos >= iter->size)
 565                 return -EINVAL;
 566
 567         return 0;
 568 }
 569
 570 /**
 571  * gcov_iter_write - write data for current pos to seq_file
 572  * @iter: file iterator
 573  * @seq: seq_file handle
 574  *
 575  * Return zero on success, non-zero otherwise.
 576  */
 577 int gcov_iter_write(struct gcov_iterator *iter, struct seq_file *seq)
 578 {
 579         size_t len;
 580
 581         if (iter->pos >= iter->size)
 582                 return -EINVAL;
 583
 584         len = ITER_STRIDE;
 585         if (iter->pos + len > iter->size)
 586                 len = iter->size - iter->pos;
 587
 588         seq_write(seq, iter->buffer + iter->pos, len);
 589
 590         return 0;
 591 }