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 static 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 /**
 115  * log_has_cat() - check if a log category exists within a list
 116  *
 117  * @cat_list: List of categories to check, at most LOGF_MAX_CATEGORIES entries
 118  *      long, terminated by LC_END if fewer
 119  * @cat: Category to search for
 120  * @return true if @cat is in @cat_list, else false
 121  */
 122 static bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat)
 123 {
 124         int i;
 125
 126         for (i = 0; i < LOGF_MAX_CATEGORIES && cat_list[i] != LOGC_END; i++) {
 127                 if (cat_list[i] == cat)
 128                         return true;
 129         }
 130
 131         return false;
 132 }
 133
 134 /**
 135  * log_has_file() - check if a file is with a list
 136  *
 137  * @file_list: List of files to check, separated by comma
 138  * @file: File to check for. This string is matched against the end of each
 139  *      file in the list, i.e. ignoring any preceding path. The list is
 140  *      intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
 141  * @return true if @file is in @file_list, else false
 142  */
 143 static bool log_has_file(const char *file_list, const char *file)
 144 {
 145         int file_len = strlen(file);
 146         const char *s, *p;
 147         int substr_len;
 148
 149         for (s = file_list; *s; s = p + (*p != '\0')) {
 150                 p = strchrnul(s, ',');
 151                 substr_len = p - s;
 152                 if (file_len >= substr_len &&
 153                     !strncmp(file + file_len - substr_len, s, substr_len))
 154                         return true;
 155         }
 156
 157         return false;
 158 }
 159
 160 /**
 161  * log_passes_filters() - check if a log record passes the filters for a device
 162  *
 163  * @ldev: Log device to check
 164  * @rec: Log record to check
 165  * @return true if @rec is not blocked by the filters in @ldev, false if it is
 166  */
 167 static bool log_passes_filters(struct log_device *ldev, struct log_rec *rec)
 168 {
 169         struct log_filter *filt;
 170
 171         if (rec->force_debug)
 172                 return true;
 173
 174         /* If there are no filters, filter on the default log level */
 175         if (list_empty(&ldev->filter_head)) {
 176                 if (rec->level > gd->default_log_level)
 177                         return false;
 178                 return true;
 179         }
 180
 181         list_for_each_entry(filt, &ldev->filter_head, sibling_node) {
 182                 if (rec->level > filt->max_level)
 183                         continue;
 184                 if ((filt->flags & LOGFF_HAS_CAT) &&
 185                     !log_has_cat(filt->cat_list, rec->cat))
 186                         continue;
 187                 if (filt->file_list &&
 188                     !log_has_file(filt->file_list, rec->file))
 189                         continue;
 190                 return true;
 191         }
 192
 193         return false;
 194 }
 195
 196 /**
 197  * log_dispatch() - Send a log record to all log devices for processing
 198  *
 199  * The log record is sent to each log device in turn, skipping those which have
 200  * filters which block the record.
 201  *
 202  * All log messages created while processing log record @rec are ignored.
 203  *
 204  * @rec:        log record to dispatch
 205  * Return:      0 msg sent, 1 msg not sent while already dispatching another msg
 206  */
 207 static int log_dispatch(struct log_rec *rec)
 208 {
 209         struct log_device *ldev;
 210
 211         /*
 212          * When a log driver writes messages (e.g. via the network stack) this
 213          * may result in further generated messages. We cannot process them here
 214          * as this might result in infinite recursion.
 215          */
 216         if (gd->processing_msg)
 217                 return 1;
 218
 219         /* Emit message */
 220         gd->processing_msg = true;
 221         list_for_each_entry(ldev, &gd->log_head, sibling_node) {
 222                 if ((ldev->flags & LOGDF_ENABLE) &&
 223                     log_passes_filters(ldev, rec))
 224                         ldev->drv->emit(ldev, rec);
 225         }
 226         gd->processing_msg = false;
 227         return 0;
 228 }
 229
 230 int _log(enum log_category_t cat, enum log_level_t level, const char *file,
 231          int line, const char *func, const char *fmt, ...)
 232 {
 233         char buf[CONFIG_SYS_CBSIZE];
 234         struct log_rec rec;
 235         va_list args;
 236
 237         /* Check for message continuation */
 238         if (cat == LOGC_CONT)
 239                 cat = gd->logc_prev;
 240         if (level == LOGL_CONT)
 241                 level = gd->logl_prev;
 242
 243         rec.cat = cat;
 244         rec.level = level & LOGL_LEVEL_MASK;
 245         rec.force_debug = level & LOGL_FORCE_DEBUG;
 246         rec.file = file;
 247         rec.line = line;
 248         rec.func = func;
 249         va_start(args, fmt);
 250         vsnprintf(buf, sizeof(buf), fmt, args);
 251         va_end(args);
 252         rec.msg = buf;
 253         if (!gd || !(gd->flags & GD_FLG_LOG_READY)) {
 254                 if (gd)
 255                         gd->log_drop_count++;
 256                 return -ENOSYS;
 257         }
 258         if (!log_dispatch(&rec)) {
 259                 gd->logc_prev = cat;
 260                 gd->logl_prev = level;
 261         }
 262
 263         return 0;
 264 }
 265
 266 int log_add_filter(const char *drv_name, enum log_category_t cat_list[],
 267                    enum log_level_t max_level, const char *file_list)
 268 {
 269         struct log_filter *filt;
 270         struct log_device *ldev;
 271         int ret;
 272         int i;
 273
 274         ldev = log_device_find_by_name(drv_name);
 275         if (!ldev)
 276                 return -ENOENT;
 277         filt = calloc(1, sizeof(*filt));
 278         if (!filt)
 279                 return -ENOMEM;
 280
 281         if (cat_list) {
 282                 filt->flags |= LOGFF_HAS_CAT;
 283                 for (i = 0; ; i++) {
 284                         if (i == ARRAY_SIZE(filt->cat_list)) {
 285                                 ret = -ENOSPC;
 286                                 goto err;
 287                         }
 288                         filt->cat_list[i] = cat_list[i];
 289                         if (cat_list[i] == LOGC_END)
 290                                 break;
 291                 }
 292         }
 293         filt->max_level = max_level;
 294         if (file_list) {
 295                 filt->file_list = strdup(file_list);
 296                 if (!filt->file_list) {
 297                         ret = -ENOMEM;
 298                         goto err;
 299                 }
 300         }
 301         filt->filter_num = ldev->next_filter_num++;
 302         list_add_tail(&filt->sibling_node, &ldev->filter_head);
 303
 304         return filt->filter_num;
 305
 306 err:
 307         free(filt);
 308         return ret;
 309 }
 310
 311 int log_remove_filter(const char *drv_name, int filter_num)
 312 {
 313         struct log_filter *filt;
 314         struct log_device *ldev;
 315
 316         ldev = log_device_find_by_name(drv_name);
 317         if (!ldev)
 318                 return -ENOENT;
 319
 320         list_for_each_entry(filt, &ldev->filter_head, sibling_node) {
 321                 if (filt->filter_num == filter_num) {
 322                         list_del(&filt->sibling_node);
 323                         free(filt);
 324
 325                         return 0;
 326                 }
 327         }
 328
 329         return -ENOENT;
 330 }
 331
 332 /**
 333  * log_find_device_by_drv() - Find a device by its driver
 334  *
 335  * @drv: Log driver
 336  * @return Device associated with that driver, or NULL if not found
 337  */
 338 static struct log_device *log_find_device_by_drv(struct log_driver *drv)
 339 {
 340         struct log_device *ldev;
 341
 342         list_for_each_entry(ldev, &gd->log_head, sibling_node) {
 343                 if (ldev->drv == drv)
 344                         return ldev;
 345         }
 346         /*
 347          * It is quite hard to pass an invalid driver since passing an unknown
 348          * LOG_GET_DRIVER(xxx) would normally produce a compilation error. But
 349          * it is possible to pass NULL, for example, so this
 350          */
 351
 352         return NULL;
 353 }
 354
 355 int log_device_set_enable(struct log_driver *drv, bool enable)
 356 {
 357         struct log_device *ldev;
 358
 359         ldev = log_find_device_by_drv(drv);
 360         if (!ldev)
 361                 return -ENOENT;
 362         if (enable)
 363                 ldev->flags |= LOGDF_ENABLE;
 364         else
 365                 ldev->flags &= ~LOGDF_ENABLE;
 366
 367         return 0;
 368 }
 369
 370 int log_init(void)
 371 {
 372         struct log_driver *drv = ll_entry_start(struct log_driver, log_driver);
 373         const int count = ll_entry_count(struct log_driver, log_driver);
 374         struct log_driver *end = drv + count;
 375
 376         /*
 377          * We cannot add runtime data to the driver since it is likely stored
 378          * in rodata. Instead, set up a 'device' corresponding to each driver.
 379          * We only support having a single device.
 380          */
 381         INIT_LIST_HEAD((struct list_head *)&gd->log_head);
 382         while (drv < end) {
 383                 struct log_device *ldev;
 384
 385                 ldev = calloc(1, sizeof(*ldev));
 386                 if (!ldev) {
 387                         debug("%s: Cannot allocate memory\n", __func__);
 388                         return -ENOMEM;
 389                 }
 390                 INIT_LIST_HEAD(&ldev->filter_head);
 391                 ldev->drv = drv;
 392                 ldev->flags = drv->flags;
 393                 list_add_tail(&ldev->sibling_node,
 394                               (struct list_head *)&gd->log_head);
 395                 drv++;
 396         }
 397         gd->flags |= GD_FLG_LOG_READY;
 398         if (!gd->default_log_level)
 399                 gd->default_log_level = CONFIG_LOG_DEFAULT_LEVEL;
 400         gd->log_fmt = log_get_default_format();
 401         gd->logc_prev = LOGC_NONE;
 402         gd->logl_prev = LOGL_INFO;
 403
 404         return 0;
 405 }