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