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