common/log.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Logging support
   4  *
   5  * Copyright (c) 2017 Google, Inc
   6  * Written by Simon Glass <sjg@chromium.org>
   7  */
   8
   9 #include <common.h>
  10 #include <log.h>
  11 #include <malloc.h>
  12 #include <dm/uclass.h>
  13
  14 DECLARE_GLOBAL_DATA_PTR;
  15
  16 static const char *const log_cat_name[] = {
  17         "none",
  18         "arch",
  19         "board",
  20         "core",
  21         "driver-model",
  22         "device-tree",
  23         "efi",
  24         "alloc",
  25         "sandbox",
  26         "bloblist",
  27         "devres",
  28         "acpi",
  29 };
  30
  31 _Static_assert(ARRAY_SIZE(log_cat_name) == LOGC_COUNT - LOGC_NONE,
  32                "log_cat_name size");
  33
  34 static const char *const log_level_name[] = {
  35         "EMERG",
  36         "ALERT",
  37         "CRIT",
  38         "ERR",
  39         "WARNING",
  40         "NOTICE",
  41         "INFO",
  42         "DEBUG",
  43         "CONTENT",
  44         "IO",
  45 };
  46
  47 _Static_assert(ARRAY_SIZE(log_level_name) == LOGL_COUNT, "log_level_name size");
  48
  49 /* All error responses MUST begin with '<' */
  50 const char *log_get_cat_name(enum log_category_t cat)
  51 {
  52         const char *name;
  53
  54         if (cat < 0 || cat >= LOGC_COUNT)
  55                 return "<invalid>";
  56         if (cat >= LOGC_NONE)
  57                 return log_cat_name[cat - LOGC_NONE];
  58
  59 #if CONFIG_IS_ENABLED(DM)
  60         name = uclass_get_name((enum uclass_id)cat);
  61 #else
  62         name = NULL;
  63 #endif
  64
  65         return name ? name : "<missing>";
  66 }
  67
  68 enum log_category_t log_get_cat_by_name(const char *name)
  69 {
  70         enum uclass_id id;
  71         int i;
  72
  73         for (i = LOGC_NONE; i < LOGC_COUNT; i++)
  74                 if (!strcmp(name, log_cat_name[i - LOGC_NONE]))
  75                         return i;
  76         id = uclass_get_by_name(name);
  77         if (id != UCLASS_INVALID)
  78                 return (enum log_category_t)id;
  79
  80         return LOGC_NONE;
  81 }
  82
  83 const char *log_get_level_name(enum log_level_t level)
  84 {
  85         if (level >= LOGL_COUNT)
  86                 return "INVALID";
  87         return log_level_name[level];
  88 }
  89
  90 enum log_level_t log_get_level_by_name(const char *name)
  91 {
  92         int i;
  93
  94         for (i = 0; i < LOGL_COUNT; i++) {
  95                 if (!strcasecmp(log_level_name[i], name))
  96                         return i;
  97         }
  98
  99         return LOGL_NONE;
 100 }
 101
 102 struct log_device *log_device_find_by_name(const char *drv_name)
 103 {
 104         struct log_device *ldev;
 105
 106         list_for_each_entry(ldev, &gd->log_head, sibling_node) {
 107                 if (!strcmp(drv_name, ldev->drv->name))
 108                         return ldev;
 109         }
 110
 111         return NULL;
 112 }
 113
 114 bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat)
 115 {
 116         int i;
 117
 118         for (i = 0; i < LOGF_MAX_CATEGORIES && cat_list[i] != LOGC_END; i++) {
 119                 if (cat_list[i] == cat)
 120                         return true;
 121         }
 122
 123         return false;
 124 }
 125
 126 bool log_has_file(const char *file_list, const char *file)
 127 {
 128         int file_len = strlen(file);
 129         const char *s, *p;
 130         int substr_len;
 131
 132         for (s = file_list; *s; s = p + (*p != '\0')) {
 133                 p = strchrnul(s, ',');
 134                 substr_len = p - s;
 135                 if (file_len >= substr_len &&
 136                     !strncmp(file + file_len - substr_len, s, substr_len))
 137                         return true;
 138         }
 139
 140         return false;
 141 }
 142
 143 /**
 144  * log_passes_filters() - check if a log record passes the filters for a device
 145  *
 146  * @ldev: Log device to check
 147  * @rec: Log record to check
 148  * @return true if @rec is not blocked by the filters in @ldev, false if it is
 149  */
 150 static bool log_passes_filters(struct log_device *ldev, struct log_rec *rec)
 151 {
 152         struct log_filter *filt;
 153
 154         if (rec->force_debug)
 155                 return true;
 156
 157         /* If there are no filters, filter on the default log level */
 158         if (list_empty(&ldev->filter_head)) {
 159                 if (rec->level > gd->default_log_level)
 160                         return false;
 161                 return true;
 162         }
 163
 164         list_for_each_entry(filt, &ldev->filter_head, sibling_node) {
 165                 if (rec->level > filt->max_level)
 166                         continue;
 167                 if ((filt->flags & LOGFF_HAS_CAT) &&
 168                     !log_has_cat(filt->cat_list, rec->cat))
 169                         continue;
 170                 if (filt->file_list &&
 171                     !log_has_file(filt->file_list, rec->file))
 172                         continue;
 173                 return true;
 174         }
 175
 176         return false;
 177 }
 178
 179 /**
 180  * log_dispatch() - Send a log record to all log devices for processing
 181  *
 182  * The log record is sent to each log device in turn, skipping those which have
 183  * filters which block the record.
 184  *
 185  * All log messages created while processing log record @rec are ignored.
 186  *
 187  * @rec:        log record to dispatch
 188  * Return:      0 msg sent, 1 msg not sent while already dispatching another msg
 189  */
 190 static int log_dispatch(struct log_rec *rec)
 191 {
 192         struct log_device *ldev;
 193
 194         /*
 195          * When a log driver writes messages (e.g. via the network stack) this
 196          * may result in further generated messages. We cannot process them here
 197          * as this might result in infinite recursion.
 198          */
 199         if (gd->processing_msg)
 200                 return 1;
 201
 202         /* Emit message */
 203         gd->processing_msg = true;
 204         list_for_each_entry(ldev, &gd->log_head, sibling_node) {
 205                 if ((ldev->flags & LOGDF_ENABLE) &&
 206                     log_passes_filters(ldev, rec))
 207                         ldev->drv->emit(ldev, rec);
 208         }
 209         gd->processing_msg = false;
 210         return 0;
 211 }
 212
 213 int _log(enum log_category_t cat, enum log_level_t level, const char *file,
 214          int line, const char *func, const char *fmt, ...)
 215 {
 216         char buf[CONFIG_SYS_CBSIZE];
 217         struct log_rec rec;
 218         va_list args;
 219
 220         /* Check for message continuation */
 221         if (cat == LOGC_CONT)
 222                 cat = gd->logc_prev;
 223         if (level == LOGL_CONT)
 224                 level = gd->logl_prev;
 225
 226         rec.cat = cat;
 227         rec.level = level & LOGL_LEVEL_MASK;
 228         rec.force_debug = level & LOGL_FORCE_DEBUG;
 229         rec.file = file;
 230         rec.line = line;
 231         rec.func = func;
 232         va_start(args, fmt);
 233         vsnprintf(buf, sizeof(buf), fmt, args);
 234         va_end(args);
 235         rec.msg = buf;
 236         if (!gd || !(gd->flags & GD_FLG_LOG_READY)) {
 237                 if (gd)
 238                         gd->log_drop_count++;
 239                 return -ENOSYS;
 240         }
 241         if (!log_dispatch(&rec)) {
 242                 gd->logc_prev = cat;
 243                 gd->logl_prev = level;
 244         }
 245
 246         return 0;
 247 }
 248
 249 int log_add_filter(const char *drv_name, enum log_category_t cat_list[],
 250                    enum log_level_t max_level, const char *file_list)
 251 {
 252         struct log_filter *filt;
 253         struct log_device *ldev;
 254         int ret;
 255         int i;
 256
 257         ldev = log_device_find_by_name(drv_name);
 258         if (!ldev)
 259                 return -ENOENT;
 260         filt = calloc(1, sizeof(*filt));
 261         if (!filt)
 262                 return -ENOMEM;
 263
 264         if (cat_list) {
 265                 filt->flags |= LOGFF_HAS_CAT;
 266                 for (i = 0; ; i++) {
 267                         if (i == ARRAY_SIZE(filt->cat_list)) {
 268                                 ret = -ENOSPC;
 269                                 goto err;
 270                         }
 271                         filt->cat_list[i] = cat_list[i];
 272                         if (cat_list[i] == LOGC_END)
 273                                 break;
 274                 }
 275         }
 276         filt->max_level = max_level;
 277         if (file_list) {
 278                 filt->file_list = strdup(file_list);
 279                 if (!filt->file_list) {
 280                         ret = -ENOMEM;
 281                         goto err;
 282                 }
 283         }
 284         filt->filter_num = ldev->next_filter_num++;
 285         list_add_tail(&filt->sibling_node, &ldev->filter_head);
 286
 287         return filt->filter_num;
 288
 289 err:
 290         free(filt);
 291         return ret;
 292 }
 293
 294 int log_remove_filter(const char *drv_name, int filter_num)
 295 {
 296         struct log_filter *filt;
 297         struct log_device *ldev;
 298
 299         ldev = log_device_find_by_name(drv_name);
 300         if (!ldev)
 301                 return -ENOENT;
 302
 303         list_for_each_entry(filt, &ldev->filter_head, sibling_node) {
 304                 if (filt->filter_num == filter_num) {
 305                         list_del(&filt->sibling_node);
 306                         free(filt);
 307
 308                         return 0;
 309                 }
 310         }
 311
 312         return -ENOENT;
 313 }
 314
 315 /**
 316  * log_find_device_by_drv() - Find a device by its driver
 317  *
 318  * @drv: Log driver
 319  * @return Device associated with that driver, or NULL if not found
 320  */
 321 static struct log_device *log_find_device_by_drv(struct log_driver *drv)
 322 {
 323         struct log_device *ldev;
 324
 325         list_for_each_entry(ldev, &gd->log_head, sibling_node) {
 326                 if (ldev->drv == drv)
 327                         return ldev;
 328         }
 329         /*
 330          * It is quite hard to pass an invalid driver since passing an unknown
 331          * LOG_GET_DRIVER(xxx) would normally produce a compilation error. But
 332          * it is possible to pass NULL, for example, so this
 333          */
 334
 335         return NULL;
 336 }
 337
 338 int log_device_set_enable(struct log_driver *drv, bool enable)
 339 {
 340         struct log_device *ldev;
 341
 342         ldev = log_find_device_by_drv(drv);
 343         if (!ldev)
 344                 return -ENOENT;
 345         if (enable)
 346                 ldev->flags |= LOGDF_ENABLE;
 347         else
 348                 ldev->flags &= ~LOGDF_ENABLE;
 349
 350         return 0;
 351 }
 352
 353 int log_init(void)
 354 {
 355         struct log_driver *drv = ll_entry_start(struct log_driver, log_driver);
 356         const int count = ll_entry_count(struct log_driver, log_driver);
 357         struct log_driver *end = drv + count;
 358
 359         /*
 360          * We cannot add runtime data to the driver since it is likely stored
 361          * in rodata. Instead, set up a 'device' corresponding to each driver.
 362          * We only support having a single device.
 363          */
 364         INIT_LIST_HEAD((struct list_head *)&gd->log_head);
 365         while (drv < end) {
 366                 struct log_device *ldev;
 367
 368                 ldev = calloc(1, sizeof(*ldev));
 369                 if (!ldev) {
 370                         debug("%s: Cannot allocate memory\n", __func__);
 371                         return -ENOMEM;
 372                 }
 373                 INIT_LIST_HEAD(&ldev->filter_head);
 374                 ldev->drv = drv;
 375                 ldev->flags = drv->flags;
 376                 list_add_tail(&ldev->sibling_node,
 377                               (struct list_head *)&gd->log_head);
 378                 drv++;
 379         }
 380         gd->flags |= GD_FLG_LOG_READY;
 381         if (!gd->default_log_level)
 382                 gd->default_log_level = CONFIG_LOG_DEFAULT_LEVEL;
 383         gd->log_fmt = log_get_default_format();
 384         gd->logc_prev = LOGC_NONE;
 385         gd->logl_prev = LOGL_INFO;
 386
 387         return 0;
 388 }