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