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