include/log.h

   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 #ifndef __LOG_H
  10 #define __LOG_H
  11
  12 #include <dm/uclass-id.h>
  13 #include <linux/list.h>
  14
  15 /** Log levels supported, ranging from most to least important */
  16 enum log_level_t {
  17         LOGL_EMERG = 0,         /* U-Boot is unstable */
  18         LOGL_ALERT,             /* Action must be taken immediately */
  19         LOGL_CRIT,              /* Critical conditions */
  20         LOGL_ERR,               /* Error that prevents something from working */
  21         LOGL_WARNING,           /* Warning may prevent optimial operation */
  22         LOGL_NOTICE,            /* Normal but significant condition, printf() */
  23         LOGL_INFO,              /* General information message */
  24         LOGL_DEBUG,             /* Basic debug-level message */
  25         LOGL_DEBUG_CONTENT,     /* Debug message showing full message content */
  26         LOGL_DEBUG_IO,          /* Debug message showing hardware I/O access */
  27
  28         LOGL_COUNT,
  29         LOGL_NONE,
  30
  31         LOGL_FIRST = LOGL_EMERG,
  32         LOGL_MAX = LOGL_DEBUG_IO,
  33 };
  34
  35 /**
  36  * Log categories supported. Most of these correspond to uclasses (i.e.
  37  * enum uclass_id) but there are also some more generic categories
  38  */
  39 enum log_category_t {
  40         LOGC_FIRST = 0, /* First part mirrors UCLASS_... */
  41
  42         LOGC_NONE = UCLASS_COUNT,       /* First number is after all uclasses */
  43         LOGC_ARCH,      /* Related to arch-specific code */
  44         LOGC_BOARD,     /* Related to board-specific code */
  45         LOGC_CORE,      /* Related to core features (non-driver-model) */
  46         LOGC_DM,        /* Core driver-model */
  47         LOGC_DT,        /* Device-tree */
  48         LOGC_EFI,       /* EFI implementation */
  49         LOGC_ALLOC,     /* Memory allocation */
  50         LOGC_SANDBOX,   /* Related to the sandbox board */
  51         LOGC_BLOBLIST,  /* Bloblist */
  52         LOGC_DEVRES,    /* Device resources (devres_... functions) */
  53
  54         LOGC_COUNT,     /* Number of log categories */
  55         LOGC_END,       /* Sentinel value for a list of log categories */
  56 };
  57
  58 /* Helper to cast a uclass ID to a log category */
  59 static inline int log_uc_cat(enum uclass_id id)
  60 {
  61         return (enum log_category_t)id;
  62 }
  63
  64 /**
  65  * _log() - Internal function to emit a new log record
  66  *
  67  * @cat: Category of log record (indicating which subsystem generated it)
  68  * @level: Level of log record (indicating its severity)
  69  * @file: File name of file where log record was generated
  70  * @line: Line number in file where log record was generated
  71  * @func: Function where log record was generated
  72  * @fmt: printf() format string for log record
  73  * @...: Optional parameters, according to the format string @fmt
  74  * @return 0 if log record was emitted, -ve on error
  75  */
  76 int _log(enum log_category_t cat, enum log_level_t level, const char *file,
  77          int line, const char *func, const char *fmt, ...)
  78                 __attribute__ ((format (__printf__, 6, 7)));
  79
  80 static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
  81                            const char *file, int line, const char *func,
  82                            const char *fmt, ...)
  83                 __attribute__ ((format (__printf__, 6, 7)));
  84
  85 static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
  86                            const char *file, int line, const char *func,
  87                            const char *fmt, ...)
  88 {
  89         return 0;
  90 }
  91
  92 /* Define this at the top of a file to add a prefix to debug messages */
  93 #ifndef pr_fmt
  94 #define pr_fmt(fmt) fmt
  95 #endif
  96
  97 /* Use a default category if this file does not supply one */
  98 #ifndef LOG_CATEGORY
  99 #define LOG_CATEGORY LOGC_NONE
 100 #endif
 101
 102 /*
 103  * This header may be including when CONFIG_LOG is disabled, in which case
 104  * CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
 105  */
 106 #if CONFIG_IS_ENABLED(LOG)
 107 #define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
 108 #define log_err(_fmt...)        log(LOG_CATEGORY, LOGL_ERR, ##_fmt)
 109 #define log_warning(_fmt...)    log(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
 110 #define log_notice(_fmt...)     log(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
 111 #define log_info(_fmt...)       log(LOG_CATEGORY, LOGL_INFO, ##_fmt)
 112 #define log_debug(_fmt...)      log(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
 113 #define log_content(_fmt...)    log(LOG_CATEGORY, LOGL_DEBUG_CONTENT, ##_fmt)
 114 #define log_io(_fmt...)         log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
 115 #else
 116 #define _LOG_MAX_LEVEL LOGL_INFO
 117 #define log_err(_fmt...)        log_nop(LOG_CATEGORY, LOGL_ERR, ##_fmt)
 118 #define log_warning(_fmt...)    log_nop(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
 119 #define log_notice(_fmt...)     log_nop(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
 120 #define log_info(_fmt...)       log_nop(LOG_CATEGORY, LOGL_INFO, ##_fmt)
 121 #define log_debug(_fmt...)      log_nop(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
 122 #define log_content(_fmt...)    log_nop(LOG_CATEGORY, \
 123                                         LOGL_DEBUG_CONTENT, ##_fmt)
 124 #define log_io(_fmt...)         log_nop(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
 125 #endif
 126
 127 #if CONFIG_IS_ENABLED(LOG)
 128 #ifdef LOG_DEBUG
 129 #define _LOG_DEBUG      1
 130 #else
 131 #define _LOG_DEBUG      0
 132 #endif
 133
 134 /* Emit a log record if the level is less that the maximum */
 135 #define log(_cat, _level, _fmt, _args...) ({ \
 136         int _l = _level; \
 137         if (CONFIG_IS_ENABLED(LOG) && (_l <= _LOG_MAX_LEVEL || _LOG_DEBUG)) \
 138                 _log((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
 139                       __func__, \
 140                       pr_fmt(_fmt), ##_args); \
 141         })
 142 #else
 143 #define log(_cat, _level, _fmt, _args...)
 144 #endif
 145
 146 #define log_nop(_cat, _level, _fmt, _args...) ({ \
 147         int _l = _level; \
 148         _log_nop((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
 149                       __func__, pr_fmt(_fmt), ##_args); \
 150 })
 151
 152 #ifdef DEBUG
 153 #define _DEBUG  1
 154 #else
 155 #define _DEBUG  0
 156 #endif
 157
 158 #ifdef CONFIG_SPL_BUILD
 159 #define _SPL_BUILD      1
 160 #else
 161 #define _SPL_BUILD      0
 162 #endif
 163
 164 #if !_DEBUG && CONFIG_IS_ENABLED(LOG)
 165
 166 #define debug_cond(cond, fmt, args...)                  \
 167         do {                                            \
 168                 if (1)                                  \
 169                         log(LOG_CATEGORY, LOGL_DEBUG, fmt, ##args); \
 170         } while (0)
 171
 172 #else /* _DEBUG */
 173
 174 /*
 175  * Output a debug text when condition "cond" is met. The "cond" should be
 176  * computed by a preprocessor in the best case, allowing for the best
 177  * optimization.
 178  */
 179 #define debug_cond(cond, fmt, args...)                  \
 180         do {                                            \
 181                 if (cond)                               \
 182                         printf(pr_fmt(fmt), ##args);    \
 183         } while (0)
 184
 185 #endif /* _DEBUG */
 186
 187 /* Show a message if DEBUG is defined in a file */
 188 #define debug(fmt, args...)                     \
 189         debug_cond(_DEBUG, fmt, ##args)
 190
 191 /* Show a message if not in SPL */
 192 #define warn_non_spl(fmt, args...)                      \
 193         debug_cond(!_SPL_BUILD, fmt, ##args)
 194
 195 /*
 196  * An assertion is run-time check done in debug mode only. If DEBUG is not
 197  * defined then it is skipped. If DEBUG is defined and the assertion fails,
 198  * then it calls panic*( which may or may not reset/halt U-Boot (see
 199  * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
 200  * before release, and after release it is hoped that they don't matter. But
 201  * in any case these failing assertions cannot be fixed with a reset (which
 202  * may just do the same assertion again).
 203  */
 204 void __assert_fail(const char *assertion, const char *file, unsigned int line,
 205                    const char *function);
 206
 207 /**
 208  * assert() - assert expression is true
 209  *
 210  * If the expression x evaluates to false and _DEBUG evaluates to true, a panic
 211  * message is written and the system stalls. The value of _DEBUG is set to true
 212  * if DEBUG is defined before including common.h.
 213  *
 214  * The expression x is always executed irrespective of the value of _DEBUG.
 215  *
 216  * @x:          expression to test
 217  */
 218 #define assert(x) \
 219         ({ if (!(x) && _DEBUG) \
 220                 __assert_fail(#x, __FILE__, __LINE__, __func__); })
 221
 222 /*
 223  * This one actually gets compiled in even without DEBUG. It doesn't include the
 224  * full pathname as it may be huge. Only use this when the user should be
 225  * warning, similar to BUG_ON() in linux.
 226  *
 227  * @return true if assertion succeeded (condition is true), else false
 228  */
 229 #define assert_noisy(x) \
 230         ({ bool _val = (x); \
 231         if (!_val) \
 232                 __assert_fail(#x, "?", __LINE__, __func__); \
 233         _val; \
 234         })
 235
 236 #if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
 237 /*
 238  * Log an error return value, possibly with a message. Usage:
 239  *
 240  *      return log_ret(fred_call());
 241  *
 242  * or:
 243  *
 244  *      return log_msg_ret("fred failed", fred_call());
 245  */
 246 #define log_ret(_ret) ({ \
 247         int __ret = (_ret); \
 248         if (__ret < 0) \
 249                 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
 250         __ret; \
 251         })
 252 #define log_msg_ret(_msg, _ret) ({ \
 253         int __ret = (_ret); \
 254         if (__ret < 0) \
 255                 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
 256                     __ret); \
 257         __ret; \
 258         })
 259 #else
 260 /* Non-logging versions of the above which just return the error code */
 261 #define log_ret(_ret) (_ret)
 262 #define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
 263 #endif
 264
 265 /**
 266  * struct log_rec - a single log record
 267  *
 268  * Holds information about a single record in the log
 269  *
 270  * Members marked as 'not allocated' are stored as pointers and the caller is
 271  * responsible for making sure that the data pointed to is not overwritten.
 272  * Memebers marked as 'allocated' are allocated (e.g. via strdup()) by the log
 273  * system.
 274  *
 275  * @cat: Category, representing a uclass or part of U-Boot
 276  * @level: Severity level, less severe is higher
 277  * @file: Name of file where the log record was generated (not allocated)
 278  * @line: Line number where the log record was generated
 279  * @func: Function where the log record was generated (not allocated)
 280  * @msg: Log message (allocated)
 281  */
 282 struct log_rec {
 283         enum log_category_t cat;
 284         enum log_level_t level;
 285         const char *file;
 286         int line;
 287         const char *func;
 288         const char *msg;
 289 };
 290
 291 struct log_device;
 292
 293 /**
 294  * struct log_driver - a driver which accepts and processes log records
 295  *
 296  * @name: Name of driver
 297  */
 298 struct log_driver {
 299         const char *name;
 300         /**
 301          * emit() - emit a log record
 302          *
 303          * Called by the log system to pass a log record to a particular driver
 304          * for processing. The filter is checked before calling this function.
 305          */
 306         int (*emit)(struct log_device *ldev, struct log_rec *rec);
 307 };
 308
 309 /**
 310  * struct log_device - an instance of a log driver
 311  *
 312  * Since drivers are set up at build-time we need to have a separate device for
 313  * the run-time aspects of drivers (currently just a list of filters to apply
 314  * to records send to this device).
 315  *
 316  * @next_filter_num: Seqence number of next filter filter added (0=no filters
 317  *      yet). This increments with each new filter on the device, but never
 318  *      decrements
 319  * @drv: Pointer to driver for this device
 320  * @filter_head: List of filters for this device
 321  * @sibling_node: Next device in the list of all devices
 322  */
 323 struct log_device {
 324         int next_filter_num;
 325         struct log_driver *drv;
 326         struct list_head filter_head;
 327         struct list_head sibling_node;
 328 };
 329
 330 enum {
 331         LOGF_MAX_CATEGORIES = 5,        /* maximum categories per filter */
 332 };
 333
 334 enum log_filter_flags {
 335         LOGFF_HAS_CAT           = 1 << 0,       /* Filter has a category list */
 336 };
 337
 338 /**
 339  * struct log_filter - criterial to filter out log messages
 340  *
 341  * @filter_num: Sequence number of this filter.  This is returned when adding a
 342  *      new filter, and must be provided when removing a previously added
 343  *      filter.
 344  * @flags: Flags for this filter (LOGFF_...)
 345  * @cat_list: List of categories to allow (terminated by LOGC_none). If empty
 346  *      then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
 347  *      can be provided
 348  * @max_level: Maximum log level to allow
 349  * @file_list: List of files to allow, separated by comma. If NULL then all
 350  *      files are permitted
 351  * @sibling_node: Next filter in the list of filters for this log device
 352  */
 353 struct log_filter {
 354         int filter_num;
 355         int flags;
 356         enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
 357         enum log_level_t max_level;
 358         const char *file_list;
 359         struct list_head sibling_node;
 360 };
 361
 362 #define LOG_DRIVER(_name) \
 363         ll_entry_declare(struct log_driver, _name, log_driver)
 364
 365 /**
 366  * log_get_cat_name() - Get the name of a category
 367  *
 368  * @cat: Category to look up
 369  * @return category name (which may be a uclass driver name) if found, or
 370  *       "<invalid>" if invalid, or "<missing>" if not found
 371  */
 372 const char *log_get_cat_name(enum log_category_t cat);
 373
 374 /**
 375  * log_get_cat_by_name() - Look up a category by name
 376  *
 377  * @name: Name to look up
 378  * @return category ID, or LOGC_NONE if not found
 379  */
 380 enum log_category_t log_get_cat_by_name(const char *name);
 381
 382 /**
 383  * log_get_level_name() - Get the name of a log level
 384  *
 385  * @level: Log level to look up
 386  * @return log level name (in ALL CAPS)
 387  */
 388 const char *log_get_level_name(enum log_level_t level);
 389
 390 /**
 391  * log_get_level_by_name() - Look up a log level by name
 392  *
 393  * @name: Name to look up
 394  * @return log level ID, or LOGL_NONE if not found
 395  */
 396 enum log_level_t log_get_level_by_name(const char *name);
 397
 398 /* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
 399 enum log_fmt {
 400         LOGF_CAT        = 0,
 401         LOGF_LEVEL,
 402         LOGF_FILE,
 403         LOGF_LINE,
 404         LOGF_FUNC,
 405         LOGF_MSG,
 406
 407         LOGF_COUNT,
 408         LOGF_DEFAULT = (1 << LOGF_FUNC) | (1 << LOGF_MSG),
 409         LOGF_ALL = 0x3f,
 410 };
 411
 412 /* Handle the 'log test' command */
 413 int do_log_test(cmd_tbl_t *cmdtp, int flag, int argc, char *const argv[]);
 414
 415 /**
 416  * log_add_filter() - Add a new filter to a log device
 417  *
 418  * @drv_name: Driver name to add the filter to (since each driver only has a
 419  *      single device)
 420  * @cat_list: List of categories to allow (terminated by LOGC_none). If empty
 421  *      then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
 422  *      can be provided
 423  * @max_level: Maximum log level to allow
 424  * @file_list: List of files to allow, separated by comma. If NULL then all
 425  *      files are permitted
 426  * @return the sequence number of the new filter (>=0) if the filter was added,
 427  *      or a -ve value on error
 428  */
 429 int log_add_filter(const char *drv_name, enum log_category_t cat_list[],
 430                    enum log_level_t max_level, const char *file_list);
 431
 432 /**
 433  * log_remove_filter() - Remove a filter from a log device
 434  *
 435  * @drv_name: Driver name to remove the filter from (since each driver only has
 436  *      a single device)
 437  * @filter_num: Filter number to remove (as returned by log_add_filter())
 438  * @return 0 if the filter was removed, -ENOENT if either the driver or the
 439  *      filter number was not found
 440  */
 441 int log_remove_filter(const char *drv_name, int filter_num);
 442
 443 #if CONFIG_IS_ENABLED(LOG)
 444 /**
 445  * log_init() - Set up the log system ready for use
 446  *
 447  * @return 0 if OK, -ENOMEM if out of memory
 448  */
 449 int log_init(void);
 450 #else
 451 static inline int log_init(void)
 452 {
 453         return 0;
 454 }
 455 #endif
 456
 457 #endif