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