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 *log_cat_name[LOGC_COUNT - LOGC_NONE] = {
  17         "none",
  18         "arch",
  19         "board",
  20         "core",
  21         "driver-model",
  22         "device-tree",
  23         "efi",
  24 };
  25
  26 static const char *log_level_name[LOGL_COUNT] = {
  27         "EMERG",
  28         "ALERT",
  29         "CRIT",
  30         "ERR",
  31         "WARNING",
  32         "NOTICE",
  33         "INFO",
  34         "DEBUG",
  35         "CONTENT",
  36         "IO",
  37 };
  38
  39 const char *log_get_cat_name(enum log_category_t cat)
  40 {
  41         const char *name;
  42
  43         if (cat < 0 || cat >= LOGC_COUNT)
  44                 return "<invalid>";
  45         if (cat >= LOGC_NONE)
  46                 return log_cat_name[cat - LOGC_NONE];
  47
  48 #if CONFIG_IS_ENABLED(DM)
  49         name = uclass_get_name((enum uclass_id)cat);
  50 #else
  51         name = NULL;
  52 #endif
  53
  54         return name ? name : "<missing>";
  55 }
  56
  57 enum log_category_t log_get_cat_by_name(const char *name)
  58 {
  59         enum uclass_id id;
  60         int i;
  61
  62         for (i = LOGC_NONE; i < LOGC_COUNT; i++)
  63                 if (!strcmp(name, log_cat_name[i - LOGC_NONE]))
  64                         return i;
  65         id = uclass_get_by_name(name);
  66         if (id != UCLASS_INVALID)
  67                 return (enum log_category_t)id;
  68
  69         return LOGC_NONE;
  70 }
  71
  72 const char *log_get_level_name(enum log_level_t level)
  73 {
  74         if (level >= LOGL_COUNT)
  75                 return "INVALID";
  76         return log_level_name[level];
  77 }
  78
  79 enum log_level_t log_get_level_by_name(const char *name)
  80 {
  81         int i;
  82
  83         for (i = 0; i < LOGL_COUNT; i++) {
  84                 if (!strcasecmp(log_level_name[i], name))
  85                         return i;
  86         }
  87
  88         return LOGL_NONE;
  89 }
  90
  91 static struct log_device *log_device_find_by_name(const char *drv_name)
  92 {
  93         struct log_device *ldev;
  94
  95         list_for_each_entry(ldev, &gd->log_head, sibling_node) {
  96                 if (!strcmp(drv_name, ldev->drv->name))
  97                         return ldev;
  98         }
  99
 100         return NULL;
 101 }
 102
 103 /**
 104  * log_has_cat() - check if a log category exists within a list
 105  *
 106  * @cat_list: List of categories to check, at most LOGF_MAX_CATEGORIES entries
 107  *      long, terminated by LC_END if fewer
 108  * @cat: Category to search for
 109  * @return true if @cat is in @cat_list, else false
 110  */
 111 static bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat)
 112 {
 113         int i;
 114
 115         for (i = 0; i < LOGF_MAX_CATEGORIES && cat_list[i] != LOGC_END; i++) {
 116                 if (cat_list[i] == cat)
 117                         return true;
 118         }
 119
 120         return false;
 121 }
 122
 123 /**
 124  * log_has_file() - check if a file is with a list
 125  *
 126  * @file_list: List of files to check, separated by comma
 127  * @file: File to check for. This string is matched against the end of each
 128  *      file in the list, i.e. ignoring any preceding path. The list is
 129  *      intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
 130  * @return true if @file is in @file_list, else false
 131  */
 132 static bool log_has_file(const char *file_list, const char *file)
 133 {
 134         int file_len = strlen(file);
 135         const char *s, *p;
 136         int substr_len;
 137
 138         for (s = file_list; *s; s = p + (*p != '\0')) {
 139                 p = strchrnul(s, ',');
 140                 substr_len = p - s;
 141                 if (file_len >= substr_len &&
 142                     !strncmp(file + file_len - substr_len, s, substr_len))
 143                         return true;
 144         }
 145
 146         return false;
 147 }
 148
 149 /**
 150  * log_passes_filters() - check if a log record passes the filters for a device
 151  *
 152  * @ldev: Log device to check
 153  * @rec: Log record to check
 154  * @return true if @rec is not blocked by the filters in @ldev, false if it is
 155  */
 156 static bool log_passes_filters(struct log_device *ldev, struct log_rec *rec)
 157 {
 158         struct log_filter *filt;
 159
 160         /* If there are no filters, filter on the default log level */
 161         if (list_empty(&ldev->filter_head)) {
 162                 if (rec->level > gd->default_log_level)
 163                         return false;
 164                 return true;
 165         }
 166
 167         list_for_each_entry(filt, &ldev->filter_head, sibling_node) {
 168                 if (rec->level > filt->max_level)
 169                         continue;
 170                 if ((filt->flags & LOGFF_HAS_CAT) &&
 171                     !log_has_cat(filt->cat_list, rec->cat))
 172                         continue;
 173                 if (filt->file_list &&
 174                     !log_has_file(filt->file_list, rec->file))
 175                         continue;
 176                 return true;
 177         }
 178
 179         return false;
 180 }
 181
 182 /**
 183  * log_dispatch() - Send a log record to all log devices for processing
 184  *
 185  * The log record is sent to each log device in turn, skipping those which have
 186  * filters which block the record
 187  *
 188  * @rec: Log record to dispatch
 189  * @return 0 (meaning success)
 190  */
 191 static int log_dispatch(struct log_rec *rec)
 192 {
 193         struct log_device *ldev;
 194         static int processing_msg;
 195
 196         /*
 197          * When a log driver writes messages (e.g. via the network stack) this
 198          * may result in further generated messages. We cannot process them here
 199          * as this might result in infinite recursion.
 200          */
 201         if (processing_msg)
 202                 return 0;
 203
 204         /* Emit message */
 205         processing_msg = 1;
 206         list_for_each_entry(ldev, &gd->log_head, sibling_node) {
 207                 if (log_passes_filters(ldev, rec))
 208                         ldev->drv->emit(ldev, rec);
 209         }
 210         processing_msg = 0;
 211         return 0;
 212 }
 213
 214 int _log(enum log_category_t cat, enum log_level_t level, const char *file,
 215          int line, const char *func, const char *fmt, ...)
 216 {
 217         char buf[CONFIG_SYS_CBSIZE];
 218         struct log_rec rec;
 219         va_list args;
 220
 221         rec.cat = cat;
 222         rec.level = level;
 223         rec.file = file;
 224         rec.line = line;
 225         rec.func = func;
 226         va_start(args, fmt);
 227         vsnprintf(buf, sizeof(buf), fmt, args);
 228         va_end(args);
 229         rec.msg = buf;
 230         if (!gd || !(gd->flags & GD_FLG_LOG_READY)) {
 231                 if (gd)
 232                         gd->log_drop_count++;
 233                 return -ENOSYS;
 234         }
 235         log_dispatch(&rec);
 236
 237         return 0;
 238 }
 239
 240 int log_add_filter(const char *drv_name, enum log_category_t cat_list[],
 241                    enum log_level_t max_level, const char *file_list)
 242 {
 243         struct log_filter *filt;
 244         struct log_device *ldev;
 245         int ret;
 246         int i;
 247
 248         ldev = log_device_find_by_name(drv_name);
 249         if (!ldev)
 250                 return -ENOENT;
 251         filt = calloc(1, sizeof(*filt));
 252         if (!filt)
 253                 return -ENOMEM;
 254
 255         if (cat_list) {
 256                 filt->flags |= LOGFF_HAS_CAT;
 257                 for (i = 0; ; i++) {
 258                         if (i == ARRAY_SIZE(filt->cat_list)) {
 259                                 ret = -ENOSPC;
 260                                 goto err;
 261                         }
 262                         filt->cat_list[i] = cat_list[i];
 263                         if (cat_list[i] == LOGC_END)
 264                                 break;
 265                 }
 266         }
 267         filt->max_level = max_level;
 268         if (file_list) {
 269                 filt->file_list = strdup(file_list);
 270                 if (!filt->file_list) {
 271                         ret = ENOMEM;
 272                         goto err;
 273                 }
 274         }
 275         filt->filter_num = ldev->next_filter_num++;
 276         list_add_tail(&filt->sibling_node, &ldev->filter_head);
 277
 278         return filt->filter_num;
 279
 280 err:
 281         free(filt);
 282         return ret;
 283 }
 284
 285 int log_remove_filter(const char *drv_name, int filter_num)
 286 {
 287         struct log_filter *filt;
 288         struct log_device *ldev;
 289
 290         ldev = log_device_find_by_name(drv_name);
 291         if (!ldev)
 292                 return -ENOENT;
 293
 294         list_for_each_entry(filt, &ldev->filter_head, sibling_node) {
 295                 if (filt->filter_num == filter_num) {
 296                         list_del(&filt->sibling_node);
 297                         free(filt);
 298
 299                         return 0;
 300                 }
 301         }
 302
 303         return -ENOENT;
 304 }
 305
 306 int log_init(void)
 307 {
 308         struct log_driver *drv = ll_entry_start(struct log_driver, log_driver);
 309         const int count = ll_entry_count(struct log_driver, log_driver);
 310         struct log_driver *end = drv + count;
 311
 312         /*
 313          * We cannot add runtime data to the driver since it is likely stored
 314          * in rodata. Instead, set up a 'device' corresponding to each driver.
 315          * We only support having a single device.
 316          */
 317         INIT_LIST_HEAD((struct list_head *)&gd->log_head);
 318         while (drv < end) {
 319                 struct log_device *ldev;
 320
 321                 ldev = calloc(1, sizeof(*ldev));
 322                 if (!ldev) {
 323                         debug("%s: Cannot allocate memory\n", __func__);
 324                         return -ENOMEM;
 325                 }
 326                 INIT_LIST_HEAD(&ldev->filter_head);
 327                 ldev->drv = drv;
 328                 list_add_tail(&ldev->sibling_node,
 329                               (struct list_head *)&gd->log_head);
 330                 drv++;
 331         }
 332         gd->flags |= GD_FLG_LOG_READY;
 333         if (!gd->default_log_level)
 334                 gd->default_log_level = CONFIG_LOG_DEFAULT_LEVEL;
 335         gd->log_fmt = log_get_default_format();
 336
 337         return 0;
 338 }