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