common/bootstage.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (c) 2011, Google Inc. All rights reserved.
   4  */
   5
   6
   7 /*
   8  * This module records the progress of boot and arbitrary commands, and
   9  * permits accurate timestamping of each.
  10  */
  11
  12 #include <common.h>
  13 #include <bootstage.h>
  14 #include <hang.h>
  15 #include <log.h>
  16 #include <malloc.h>
  17 #include <sort.h>
  18 #include <spl.h>
  19 #include <linux/compiler.h>
  20 #include <linux/libfdt.h>
  21
  22 DECLARE_GLOBAL_DATA_PTR;
  23
  24 enum {
  25         RECORD_COUNT = CONFIG_VAL(BOOTSTAGE_RECORD_COUNT),
  26 };
  27
  28 struct bootstage_record {
  29         ulong time_us;
  30         uint32_t start_us;
  31         const char *name;
  32         int flags;              /* see enum bootstage_flags */
  33         enum bootstage_id id;
  34 };
  35
  36 struct bootstage_data {
  37         uint rec_count;
  38         uint next_id;
  39         struct bootstage_record record[RECORD_COUNT];
  40 };
  41
  42 enum {
  43         BOOTSTAGE_VERSION       = 0,
  44         BOOTSTAGE_MAGIC         = 0xb00757a3,
  45         BOOTSTAGE_DIGITS        = 9,
  46 };
  47
  48 struct bootstage_hdr {
  49         u32 version;            /* BOOTSTAGE_VERSION */
  50         u32 count;              /* Number of records */
  51         u32 size;               /* Total data size (non-zero if valid) */
  52         u32 magic;              /* Magic number */
  53         u32 next_id;            /* Next ID to use for bootstage */
  54 };
  55
  56 int bootstage_relocate(void)
  57 {
  58         struct bootstage_data *data = gd->bootstage;
  59         int i;
  60         char *ptr;
  61
  62         /* Figure out where to relocate the strings to */
  63         ptr = (char *)(data + 1);
  64
  65         /*
  66          * Duplicate all strings.  They may point to an old location in the
  67          * program .text section that can eventually get trashed.
  68          */
  69         debug("Relocating %d records\n", data->rec_count);
  70         for (i = 0; i < data->rec_count; i++) {
  71                 const char *from = data->record[i].name;
  72
  73                 strcpy(ptr, from);
  74                 data->record[i].name = ptr;
  75                 ptr += strlen(ptr) + 1;
  76         }
  77
  78         return 0;
  79 }
  80
  81 struct bootstage_record *find_id(struct bootstage_data *data,
  82                                  enum bootstage_id id)
  83 {
  84         struct bootstage_record *rec;
  85         struct bootstage_record *end;
  86
  87         for (rec = data->record, end = rec + data->rec_count; rec < end;
  88              rec++) {
  89                 if (rec->id == id)
  90                         return rec;
  91         }
  92
  93         return NULL;
  94 }
  95
  96 struct bootstage_record *ensure_id(struct bootstage_data *data,
  97                                    enum bootstage_id id)
  98 {
  99         struct bootstage_record *rec;
 100
 101         rec = find_id(data, id);
 102         if (!rec && data->rec_count < RECORD_COUNT) {
 103                 rec = &data->record[data->rec_count++];
 104                 rec->id = id;
 105                 return rec;
 106         }
 107
 108         return rec;
 109 }
 110
 111 ulong bootstage_add_record(enum bootstage_id id, const char *name,
 112                            int flags, ulong mark)
 113 {
 114         struct bootstage_data *data = gd->bootstage;
 115         struct bootstage_record *rec;
 116
 117         /*
 118          * initf_bootstage() is called very early during boot but since hang()
 119          * calls bootstage_error() we can be called before bootstage is set up.
 120          * Add a check to avoid this.
 121          */
 122         if (!data)
 123                 return mark;
 124         if (flags & BOOTSTAGEF_ALLOC)
 125                 id = data->next_id++;
 126
 127         /* Only record the first event for each */
 128         rec = find_id(data, id);
 129         if (!rec && data->rec_count < RECORD_COUNT) {
 130                 rec = &data->record[data->rec_count++];
 131                 rec->time_us = mark;
 132                 rec->name = name;
 133                 rec->flags = flags;
 134                 rec->id = id;
 135         }
 136
 137         /* Tell the board about this progress */
 138         show_boot_progress(flags & BOOTSTAGEF_ERROR ? -id : id);
 139
 140         return mark;
 141 }
 142
 143
 144 ulong bootstage_mark(enum bootstage_id id)
 145 {
 146         return bootstage_add_record(id, NULL, 0, timer_get_boot_us());
 147 }
 148
 149 ulong bootstage_error(enum bootstage_id id)
 150 {
 151         return bootstage_add_record(id, NULL, BOOTSTAGEF_ERROR,
 152                                     timer_get_boot_us());
 153 }
 154
 155 ulong bootstage_mark_name(enum bootstage_id id, const char *name)
 156 {
 157         int flags = 0;
 158
 159         if (id == BOOTSTAGE_ID_ALLOC)
 160                 flags = BOOTSTAGEF_ALLOC;
 161
 162         return bootstage_add_record(id, name, flags, timer_get_boot_us());
 163 }
 164
 165 ulong bootstage_mark_code(const char *file, const char *func, int linenum)
 166 {
 167         char *str, *p;
 168         __maybe_unused char *end;
 169         int len = 0;
 170
 171         /* First work out the length we need to allocate */
 172         if (linenum != -1)
 173                 len = 11;
 174         if (func)
 175                 len += strlen(func);
 176         if (file)
 177                 len += strlen(file);
 178
 179         str = malloc(len + 1);
 180         p = str;
 181         end = p + len;
 182         if (file)
 183                 p += snprintf(p, end - p, "%s,", file);
 184         if (linenum != -1)
 185                 p += snprintf(p, end - p, "%d", linenum);
 186         if (func)
 187                 p += snprintf(p, end - p, ": %s", func);
 188
 189         return bootstage_mark_name(BOOTSTAGE_ID_ALLOC, str);
 190 }
 191
 192 uint32_t bootstage_start(enum bootstage_id id, const char *name)
 193 {
 194         struct bootstage_data *data = gd->bootstage;
 195         struct bootstage_record *rec = ensure_id(data, id);
 196         ulong start_us = timer_get_boot_us();
 197
 198         if (rec) {
 199                 rec->start_us = start_us;
 200                 rec->name = name;
 201         }
 202
 203         return start_us;
 204 }
 205
 206 uint32_t bootstage_accum(enum bootstage_id id)
 207 {
 208         struct bootstage_data *data = gd->bootstage;
 209         struct bootstage_record *rec = ensure_id(data, id);
 210         uint32_t duration;
 211
 212         if (!rec)
 213                 return 0;
 214         duration = (uint32_t)timer_get_boot_us() - rec->start_us;
 215         rec->time_us += duration;
 216
 217         return duration;
 218 }
 219
 220 /**
 221  * Get a record name as a printable string
 222  *
 223  * @param buf   Buffer to put name if needed
 224  * @param len   Length of buffer
 225  * @param rec   Boot stage record to get the name from
 226  * @return pointer to name, either from the record or pointing to buf.
 227  */
 228 static const char *get_record_name(char *buf, int len,
 229                                    const struct bootstage_record *rec)
 230 {
 231         if (rec->name)
 232                 return rec->name;
 233         else if (rec->id >= BOOTSTAGE_ID_USER)
 234                 snprintf(buf, len, "user_%d", rec->id - BOOTSTAGE_ID_USER);
 235         else
 236                 snprintf(buf, len, "id=%d", rec->id);
 237
 238         return buf;
 239 }
 240
 241 static uint32_t print_time_record(struct bootstage_record *rec, uint32_t prev)
 242 {
 243         char buf[20];
 244
 245         if (prev == -1U) {
 246                 printf("%11s", "");
 247                 print_grouped_ull(rec->time_us, BOOTSTAGE_DIGITS);
 248         } else {
 249                 print_grouped_ull(rec->time_us, BOOTSTAGE_DIGITS);
 250                 print_grouped_ull(rec->time_us - prev, BOOTSTAGE_DIGITS);
 251         }
 252         printf("  %s\n", get_record_name(buf, sizeof(buf), rec));
 253
 254         return rec->time_us;
 255 }
 256
 257 static int h_compare_record(const void *r1, const void *r2)
 258 {
 259         const struct bootstage_record *rec1 = r1, *rec2 = r2;
 260
 261         return rec1->time_us > rec2->time_us ? 1 : -1;
 262 }
 263
 264 #ifdef CONFIG_OF_LIBFDT
 265 /**
 266  * Add all bootstage timings to a device tree.
 267  *
 268  * @param blob  Device tree blob
 269  * @return 0 on success, != 0 on failure.
 270  */
 271 static int add_bootstages_devicetree(struct fdt_header *blob)
 272 {
 273         struct bootstage_data *data = gd->bootstage;
 274         int bootstage;
 275         char buf[20];
 276         int recnum;
 277         int i;
 278
 279         if (!blob)
 280                 return 0;
 281
 282         /*
 283          * Create the node for bootstage.
 284          * The address of flat device tree is set up by the command bootm.
 285          */
 286         bootstage = fdt_add_subnode(blob, 0, "bootstage");
 287         if (bootstage < 0)
 288                 return -EINVAL;
 289
 290         /*
 291          * Insert the timings to the device tree in the reverse order so
 292          * that they can be printed in the Linux kernel in the right order.
 293          */
 294         for (recnum = data->rec_count - 1, i = 0; recnum >= 0; recnum--, i++) {
 295                 struct bootstage_record *rec = &data->record[recnum];
 296                 int node;
 297
 298                 if (rec->id != BOOTSTAGE_ID_AWAKE && rec->time_us == 0)
 299                         continue;
 300
 301                 node = fdt_add_subnode(blob, bootstage, simple_itoa(i));
 302                 if (node < 0)
 303                         break;
 304
 305                 /* add properties to the node. */
 306                 if (fdt_setprop_string(blob, node, "name",
 307                                        get_record_name(buf, sizeof(buf), rec)))
 308                         return -EINVAL;
 309
 310                 /* Check if this is a 'mark' or 'accum' record */
 311                 if (fdt_setprop_cell(blob, node,
 312                                 rec->start_us ? "accum" : "mark",
 313                                 rec->time_us))
 314                         return -EINVAL;
 315         }
 316
 317         return 0;
 318 }
 319
 320 int bootstage_fdt_add_report(void)
 321 {
 322         if (add_bootstages_devicetree(working_fdt))
 323                 puts("bootstage: Failed to add to device tree\n");
 324
 325         return 0;
 326 }
 327 #endif
 328
 329 void bootstage_report(void)
 330 {
 331         struct bootstage_data *data = gd->bootstage;
 332         struct bootstage_record *rec = data->record;
 333         uint32_t prev;
 334         int i;
 335
 336         printf("Timer summary in microseconds (%d records):\n",
 337                data->rec_count);
 338         printf("%11s%11s  %s\n", "Mark", "Elapsed", "Stage");
 339
 340         prev = print_time_record(rec, 0);
 341
 342         /* Sort records by increasing time */
 343         qsort(data->record, data->rec_count, sizeof(*rec), h_compare_record);
 344
 345         for (i = 1, rec++; i < data->rec_count; i++, rec++) {
 346                 if (rec->id && !rec->start_us)
 347                         prev = print_time_record(rec, prev);
 348         }
 349         if (data->rec_count > RECORD_COUNT)
 350                 printf("Overflowed internal boot id table by %d entries\n"
 351                        "Please increase CONFIG_(SPL_)BOOTSTAGE_RECORD_COUNT\n",
 352                        data->rec_count - RECORD_COUNT);
 353
 354         puts("\nAccumulated time:\n");
 355         for (i = 0, rec = data->record; i < data->rec_count; i++, rec++) {
 356                 if (rec->start_us)
 357                         prev = print_time_record(rec, -1);
 358         }
 359 }
 360
 361 /**
 362  * Append data to a memory buffer
 363  *
 364  * Write data to the buffer if there is space. Whether there is space or not,
 365  * the buffer pointer is incremented.
 366  *
 367  * @param ptrp  Pointer to buffer, updated by this function
 368  * @param end   Pointer to end of buffer
 369  * @param data  Data to write to buffer
 370  * @param size  Size of data
 371  */
 372 static void append_data(char **ptrp, char *end, const void *data, int size)
 373 {
 374         char *ptr = *ptrp;
 375
 376         *ptrp += size;
 377         if (*ptrp > end)
 378                 return;
 379
 380         memcpy(ptr, data, size);
 381 }
 382
 383 int bootstage_stash(void *base, int size)
 384 {
 385         const struct bootstage_data *data = gd->bootstage;
 386         struct bootstage_hdr *hdr = (struct bootstage_hdr *)base;
 387         const struct bootstage_record *rec;
 388         char buf[20];
 389         char *ptr = base, *end = ptr + size;
 390         int i;
 391
 392         if (hdr + 1 > (struct bootstage_hdr *)end) {
 393                 debug("%s: Not enough space for bootstage hdr\n", __func__);
 394                 return -ENOSPC;
 395         }
 396
 397         /* Write an arbitrary version number */
 398         hdr->version = BOOTSTAGE_VERSION;
 399
 400         hdr->count = data->rec_count;
 401         hdr->size = 0;
 402         hdr->magic = BOOTSTAGE_MAGIC;
 403         hdr->next_id = data->next_id;
 404         ptr += sizeof(*hdr);
 405
 406         /* Write the records, silently stopping when we run out of space */
 407         for (rec = data->record, i = 0; i < data->rec_count; i++, rec++)
 408                 append_data(&ptr, end, rec, sizeof(*rec));
 409
 410         /* Write the name strings */
 411         for (rec = data->record, i = 0; i < data->rec_count; i++, rec++) {
 412                 const char *name;
 413
 414                 name = get_record_name(buf, sizeof(buf), rec);
 415                 append_data(&ptr, end, name, strlen(name) + 1);
 416         }
 417
 418         /* Check for buffer overflow */
 419         if (ptr > end) {
 420                 debug("%s: Not enough space for bootstage stash\n", __func__);
 421                 return -ENOSPC;
 422         }
 423
 424         /* Update total data size */
 425         hdr->size = ptr - (char *)base;
 426         debug("Stashed %d records\n", hdr->count);
 427
 428         return 0;
 429 }
 430
 431 int bootstage_unstash(const void *base, int size)
 432 {
 433         const struct bootstage_hdr *hdr = (struct bootstage_hdr *)base;
 434         struct bootstage_data *data = gd->bootstage;
 435         const char *ptr = base, *end = ptr + size;
 436         struct bootstage_record *rec;
 437         uint rec_size;
 438         int i;
 439
 440         if (size == -1)
 441                 end = (char *)(~(uintptr_t)0);
 442
 443         if (hdr + 1 > (struct bootstage_hdr *)end) {
 444                 debug("%s: Not enough space for bootstage hdr\n", __func__);
 445                 return -EPERM;
 446         }
 447
 448         if (hdr->magic != BOOTSTAGE_MAGIC) {
 449                 debug("%s: Invalid bootstage magic\n", __func__);
 450                 return -ENOENT;
 451         }
 452
 453         if (ptr + hdr->size > end) {
 454                 debug("%s: Bootstage data runs past buffer end\n", __func__);
 455                 return -ENOSPC;
 456         }
 457
 458         if (hdr->count * sizeof(*rec) > hdr->size) {
 459                 debug("%s: Bootstage has %d records needing %lu bytes, but "
 460                         "only %d bytes is available\n", __func__, hdr->count,
 461                       (ulong)hdr->count * sizeof(*rec), hdr->size);
 462                 return -ENOSPC;
 463         }
 464
 465         if (hdr->version != BOOTSTAGE_VERSION) {
 466                 debug("%s: Bootstage data version %#0x unrecognised\n",
 467                       __func__, hdr->version);
 468                 return -EINVAL;
 469         }
 470
 471         if (data->rec_count + hdr->count > RECORD_COUNT) {
 472                 debug("%s: Bootstage has %d records, we have space for %d\n"
 473                         "Please increase CONFIG_(SPL_)BOOTSTAGE_RECORD_COUNT\n",
 474                       __func__, hdr->count, RECORD_COUNT - data->rec_count);
 475                 return -ENOSPC;
 476         }
 477
 478         ptr += sizeof(*hdr);
 479
 480         /* Read the records */
 481         rec_size = hdr->count * sizeof(*data->record);
 482         memcpy(data->record + data->rec_count, ptr, rec_size);
 483
 484         /* Read the name strings */
 485         ptr += rec_size;
 486         for (rec = data->record + data->next_id, i = 0; i < hdr->count;
 487              i++, rec++) {
 488                 rec->name = ptr;
 489                 if (spl_phase() == PHASE_SPL)
 490                         rec->name = strdup(ptr);
 491
 492                 /* Assume no data corruption here */
 493                 ptr += strlen(ptr) + 1;
 494         }
 495
 496         /* Mark the records as read */
 497         data->rec_count += hdr->count;
 498         data->next_id = hdr->next_id;
 499         debug("Unstashed %d records\n", hdr->count);
 500
 501         return 0;
 502 }
 503
 504 int bootstage_get_size(void)
 505 {
 506         struct bootstage_data *data = gd->bootstage;
 507         struct bootstage_record *rec;
 508         int size;
 509         int i;
 510
 511         size = sizeof(struct bootstage_data);
 512         for (rec = data->record, i = 0; i < data->rec_count;
 513              i++, rec++)
 514                 size += strlen(rec->name) + 1;
 515
 516         return size;
 517 }
 518
 519 int bootstage_init(bool first)
 520 {
 521         struct bootstage_data *data;
 522         int size = sizeof(struct bootstage_data);
 523
 524         gd->bootstage = (struct bootstage_data *)malloc(size);
 525         if (!gd->bootstage)
 526                 return -ENOMEM;
 527         data = gd->bootstage;
 528         memset(data, '\0', size);
 529         if (first) {
 530                 data->next_id = BOOTSTAGE_ID_USER;
 531                 bootstage_add_record(BOOTSTAGE_ID_AWAKE, "reset", 0, 0);
 532         }
 533
 534         return 0;
 535 }