1 /* SPDX-License-Identifier: GPL-2.0+ */
5 * Copyright (c) 2017 Google, Inc
6 * Written by Simon Glass <sjg@chromium.org>
13 #include <linker_lists.h>
14 #include <dm/uclass-id.h>
15 #include <linux/bitops.h>
16 #include <linux/list.h>
21 * enum log_level_t - Log levels supported, ranging from most to least important
24 /** @LOGL_EMERG: U-Boot is unstable */
26 /** @LOGL_ALERT: Action must be taken immediately */
28 /** @LOGL_CRIT: Critical conditions */
30 /** @LOGL_ERR: Error that prevents something from working */
32 /** @LOGL_WARNING: Warning may prevent optimal operation */
34 /** @LOGL_NOTICE: Normal but significant condition, printf() */
36 /** @LOGL_INFO: General information message */
38 /** @LOGL_DEBUG: Basic debug-level message */
40 /** @LOGL_DEBUG_CONTENT: Debug message showing full message content */
42 /** @LOGL_DEBUG_IO: Debug message showing hardware I/O access */
45 /** @LOGL_COUNT: Total number of valid log levels */
47 /** @LOGL_NONE: Used to indicate that there is no valid log level */
50 /** @LOGL_LEVEL_MASK: Mask for valid log levels */
51 LOGL_LEVEL_MASK = 0xf,
52 /** @LOGL_FORCE_DEBUG: Mask to force output due to LOG_DEBUG */
53 LOGL_FORCE_DEBUG = 0x10,
55 /** @LOGL_FIRST: The first, most-important log level */
56 LOGL_FIRST = LOGL_EMERG,
57 /** @LOGL_MAX: The last, least-important log level */
58 LOGL_MAX = LOGL_DEBUG_IO,
59 /** @LOGL_CONT: Use same log level as in previous call */
64 * enum log_category_t - Log categories supported.
66 * Log categories between %LOGC_FIRST and %LOGC_NONE correspond to uclasses
67 * (i.e. &enum uclass_id), but there are also some more generic categories.
69 * Remember to update log_cat_name[] after adding a new category.
72 /** @LOGC_FIRST: First log category */
73 LOGC_FIRST = 0, /* First part mirrors UCLASS_... */
75 /** @LOGC_NONE: Default log category */
76 LOGC_NONE = UCLASS_COUNT, /* First number is after all uclasses */
77 /** @LOGC_ARCH: Related to arch-specific code */
79 /** @LOGC_BOARD: Related to board-specific code */
81 /** @LOGC_CORE: Related to core features (non-driver-model) */
83 /** @LOGC_DM: Core driver-model */
85 /** @LOGC_DT: Device-tree */
87 /** @LOGC_EFI: EFI implementation */
89 /** @LOGC_ALLOC: Memory allocation */
91 /** @LOGC_SANDBOX: Related to the sandbox board */
93 /** @LOGC_BLOBLIST: Bloblist */
95 /** @LOGC_DEVRES: Device resources (``devres_...`` functions) */
97 /** @LOGC_ACPI: Advanced Configuration and Power Interface (ACPI) */
99 /** @LOGC_BOOT: Related to boot process / boot image processing */
101 /** @LOGC_COUNT: Number of log categories */
103 /** @LOGC_END: Sentinel value for lists of log categories */
105 /** @LOGC_CONT: Use same category as in previous call */
109 /* Helper to cast a uclass ID to a log category */
110 static inline int log_uc_cat(enum uclass_id id)
112 return (enum log_category_t)id;
116 * _log() - Internal function to emit a new log record
118 * @cat: Category of log record (indicating which subsystem generated it)
119 * @level: Level of log record (indicating its severity)
120 * @file: File name of file where log record was generated
121 * @line: Line number in file where log record was generated
122 * @func: Function where log record was generated
123 * @fmt: printf() format string for log record
124 * @...: Optional parameters, according to the format string @fmt
125 * Return: 0 if log record was emitted, -ve on error
127 int _log(enum log_category_t cat, enum log_level_t level, const char *file,
128 int line, const char *func, const char *fmt, ...)
129 __attribute__ ((format (__printf__, 6, 7)));
131 static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
132 const char *file, int line, const char *func,
133 const char *fmt, ...)
134 __attribute__ ((format (__printf__, 6, 7)));
136 static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
137 const char *file, int line, const char *func,
138 const char *fmt, ...)
143 /* Define this at the top of a file to add a prefix to debug messages */
145 #define pr_fmt(fmt) fmt
148 /* Use a default category if this file does not supply one */
150 #define LOG_CATEGORY LOGC_NONE
154 * This header may be including when CONFIG_LOG is disabled, in which case
155 * CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
157 #if CONFIG_IS_ENABLED(LOG)
158 #define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
159 #define log_emer(_fmt...) log(LOG_CATEGORY, LOGL_EMERG, ##_fmt)
160 #define log_alert(_fmt...) log(LOG_CATEGORY, LOGL_ALERT, ##_fmt)
161 #define log_crit(_fmt...) log(LOG_CATEGORY, LOGL_CRIT, ##_fmt)
162 #define log_err(_fmt...) log(LOG_CATEGORY, LOGL_ERR, ##_fmt)
163 #define log_warning(_fmt...) log(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
164 #define log_notice(_fmt...) log(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
165 #define log_info(_fmt...) log(LOG_CATEGORY, LOGL_INFO, ##_fmt)
166 #define log_debug(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
167 #define log_content(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_CONTENT, ##_fmt)
168 #define log_io(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
169 #define log_cont(_fmt...) log(LOGC_CONT, LOGL_CONT, ##_fmt)
171 #define _LOG_MAX_LEVEL LOGL_INFO
172 #define log_emerg(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
173 #define log_alert(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
174 #define log_crit(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
175 #define log_err(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
176 #define log_warning(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
177 #define log_notice(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
178 #define log_info(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
179 #define log_cont(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
180 #define log_debug(_fmt, ...) debug(_fmt, ##__VA_ARGS__)
181 #define log_content(_fmt...) log_nop(LOG_CATEGORY, \
182 LOGL_DEBUG_CONTENT, ##_fmt)
183 #define log_io(_fmt...) log_nop(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
186 #if CONFIG_IS_ENABLED(LOG)
188 #define _LOG_DEBUG LOGL_FORCE_DEBUG
193 /* Emit a log record if the level is less that the maximum */
194 #define log(_cat, _level, _fmt, _args...) ({ \
196 if (CONFIG_IS_ENABLED(LOG) && \
197 (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL)) \
198 _log((enum log_category_t)(_cat), \
199 (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
200 __LINE__, __func__, \
201 pr_fmt(_fmt), ##_args); \
204 #define log(_cat, _level, _fmt, _args...)
207 #define log_nop(_cat, _level, _fmt, _args...) ({ \
209 _log_nop((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
210 __func__, pr_fmt(_fmt), ##_args); \
219 #ifdef CONFIG_SPL_BUILD
225 #if !_DEBUG && CONFIG_IS_ENABLED(LOG)
227 #define debug_cond(cond, fmt, args...) \
229 log(LOG_CATEGORY, LOGL_DEBUG, fmt, ##args); \
235 * Output a debug text when condition "cond" is met. The "cond" should be
236 * computed by a preprocessor in the best case, allowing for the best
239 #define debug_cond(cond, fmt, args...) \
242 printf(pr_fmt(fmt), ##args); \
247 /* Show a message if DEBUG is defined in a file */
248 #define debug(fmt, args...) \
249 debug_cond(_DEBUG, fmt, ##args)
251 /* Show a message if not in SPL */
252 #define warn_non_spl(fmt, args...) \
253 debug_cond(!_SPL_BUILD, fmt, ##args)
256 * An assertion is run-time check done in debug mode only. If DEBUG is not
257 * defined then it is skipped. If DEBUG is defined and the assertion fails,
258 * then it calls panic*( which may or may not reset/halt U-Boot (see
259 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
260 * before release, and after release it is hoped that they don't matter. But
261 * in any case these failing assertions cannot be fixed with a reset (which
262 * may just do the same assertion again).
264 void __assert_fail(const char *assertion, const char *file, unsigned int line,
265 const char *function);
268 * assert() - assert expression is true
270 * If the expression x evaluates to false and _DEBUG evaluates to true, a panic
271 * message is written and the system stalls. The value of _DEBUG is set to true
272 * if DEBUG is defined before including common.h.
274 * The expression x is always executed irrespective of the value of _DEBUG.
276 * @x: expression to test
279 ({ if (!(x) && _DEBUG) \
280 __assert_fail(#x, __FILE__, __LINE__, __func__); })
283 * This one actually gets compiled in even without DEBUG. It doesn't include the
284 * full pathname as it may be huge. Only use this when the user should be
285 * warning, similar to BUG_ON() in linux.
287 * Return: true if assertion succeeded (condition is true), else false
289 #define assert_noisy(x) \
290 ({ bool _val = (x); \
292 __assert_fail(#x, "?", __LINE__, __func__); \
296 #if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
298 * Log an error return value, possibly with a message. Usage:
300 * return log_ret(fred_call());
304 * return log_msg_ret("fred failed", fred_call());
306 #define log_ret(_ret) ({ \
307 int __ret = (_ret); \
309 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
312 #define log_msg_ret(_msg, _ret) ({ \
313 int __ret = (_ret); \
315 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
320 /* Non-logging versions of the above which just return the error code */
321 #define log_ret(_ret) (_ret)
322 #define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
325 /** * enum log_rec_flags - Flags for a log record */
327 /** @LOGRECF_FORCE_DEBUG: Force output of debug record */
328 LOGRECF_FORCE_DEBUG = BIT(0),
329 /** @LOGRECF_CONT: Continuation of previous log record */
330 LOGRECF_CONT = BIT(1),
334 * struct log_rec - a single log record
336 * Holds information about a single record in the log
338 * Members marked as 'not allocated' are stored as pointers and the caller is
339 * responsible for making sure that the data pointed to is not overwritten.
340 * Members marked as 'allocated' are allocated (e.g. via strdup()) by the log
343 * TODO(sjg@chromium.org): Compress this struct down a bit to reduce space, e.g.
344 * a single u32 for cat, level, line and force_debug
346 * @cat: Category, representing a uclass or part of U-Boot
347 * @level: Severity level, less severe is higher
348 * @line: Line number where the log record was generated
349 * @flags: Flags for log record (enum log_rec_flags)
350 * @file: Name of file where the log record was generated (not allocated)
351 * @func: Function where the log record was generated (not allocated)
352 * @msg: Log message (allocated)
355 enum log_category_t cat;
356 enum log_level_t level;
366 enum log_device_flags {
367 LOGDF_ENABLE = BIT(0), /* Device is enabled */
371 * struct log_driver - a driver which accepts and processes log records
373 * @name: Name of driver
374 * @emit: Method to call to emit a log record via this device
375 * @flags: Initial value for flags (use LOGDF_ENABLE to enable on start-up)
381 * @emit: emit a log record
383 * Called by the log system to pass a log record to a particular driver
384 * for processing. The filter is checked before calling this function.
386 int (*emit)(struct log_device *ldev, struct log_rec *rec);
387 unsigned short flags;
391 * struct log_device - an instance of a log driver
393 * Since drivers are set up at build-time we need to have a separate device for
394 * the run-time aspects of drivers (currently just a list of filters to apply
395 * to records send to this device).
397 * @next_filter_num: Sequence number of next filter filter added (0=no filters
398 * yet). This increments with each new filter on the device, but never
400 * @flags: Flags for this filter (enum log_device_flags)
401 * @drv: Pointer to driver for this device
402 * @filter_head: List of filters for this device
403 * @sibling_node: Next device in the list of all devices
406 unsigned short next_filter_num;
407 unsigned short flags;
408 struct log_driver *drv;
409 struct list_head filter_head;
410 struct list_head sibling_node;
414 LOGF_MAX_CATEGORIES = 5, /* maximum categories per filter */
418 * enum log_filter_flags - Flags which modify a filter
420 enum log_filter_flags {
421 /** @LOGFF_HAS_CAT: Filter has a category list */
422 LOGFF_HAS_CAT = 1 << 0,
423 /** @LOGFF_DENY: Filter denies matching messages */
425 /** @LOGFF_LEVEL_MIN: Filter's level is a minimum, not a maximum */
426 LOGFF_LEVEL_MIN = 1 << 2,
430 * struct log_filter - criteria to filter out log messages
432 * If a message matches all criteria, then it is allowed. If LOGFF_DENY is set,
433 * then it is denied instead.
435 * @filter_num: Sequence number of this filter. This is returned when adding a
436 * new filter, and must be provided when removing a previously added
438 * @flags: Flags for this filter (``LOGFF_...``)
439 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
440 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
442 * @level: Maximum (or minimum, if %LOGFF_MIN_LEVEL) log level to allow
443 * @file_list: List of files to allow, separated by comma. If NULL then all
444 * files are permitted
445 * @sibling_node: Next filter in the list of filters for this log device
450 enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
451 enum log_level_t level;
452 const char *file_list;
453 struct list_head sibling_node;
456 #define LOG_DRIVER(_name) \
457 ll_entry_declare(struct log_driver, _name, log_driver)
459 /* Get a pointer to a given driver */
460 #define LOG_GET_DRIVER(__name) \
461 ll_entry_get(struct log_driver, __name, log_driver)
464 * log_get_cat_name() - Get the name of a category
466 * @cat: Category to look up
467 * Return: category name (which may be a uclass driver name) if found, or
468 * "<invalid>" if invalid, or "<missing>" if not found. All error
469 * responses begin with '<'.
471 const char *log_get_cat_name(enum log_category_t cat);
474 * log_get_cat_by_name() - Look up a category by name
476 * @name: Name to look up
477 * Return: Category, or %LOGC_NONE if not found
479 enum log_category_t log_get_cat_by_name(const char *name);
482 * log_get_level_name() - Get the name of a log level
484 * @level: Log level to look up
485 * Return: Log level name (in ALL CAPS)
487 const char *log_get_level_name(enum log_level_t level);
490 * log_get_level_by_name() - Look up a log level by name
492 * @name: Name to look up
493 * Return: Log level, or %LOGL_NONE if not found
495 enum log_level_t log_get_level_by_name(const char *name);
498 * log_device_find_by_name() - Look up a log device by its driver's name
500 * @drv_name: Name of the driver
501 * Return: the log device, or %NULL if not found
503 struct log_device *log_device_find_by_name(const char *drv_name);
506 * log_has_cat() - check if a log category exists within a list
508 * @cat_list: List of categories to check, at most %LOGF_MAX_CATEGORIES entries
509 * long, terminated by %LC_END if fewer
510 * @cat: Category to search for
512 * Return: ``true`` if @cat is in @cat_list, else ``false``
514 bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat);
517 * log_has_file() - check if a file is with a list
519 * @file_list: List of files to check, separated by comma
520 * @file: File to check for. This string is matched against the end of each
521 * file in the list, i.e. ignoring any preceding path. The list is
522 * intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
524 * Return: ``true`` if @file is in @file_list, else ``false``
526 bool log_has_file(const char *file_list, const char *file);
528 /* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
541 /* Handle the 'log test' command */
542 int do_log_test(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
545 * log_add_filter_flags() - Add a new filter to a log device, specifying flags
547 * @drv_name: Driver name to add the filter to (since each driver only has a
549 * @flags: Flags for this filter (``LOGFF_...``)
550 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
551 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
553 * @level: Maximum (or minimum, if %LOGFF_LEVEL_MIN) log level to allow
554 * @file_list: List of files to allow, separated by comma. If NULL then all
555 * files are permitted
557 * the sequence number of the new filter (>=0) if the filter was added, or a
560 int log_add_filter_flags(const char *drv_name, enum log_category_t cat_list[],
561 enum log_level_t level, const char *file_list,
565 * log_add_filter() - Add a new filter to a log device
567 * @drv_name: Driver name to add the filter to (since each driver only has a
569 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
570 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
572 * @max_level: Maximum log level to allow
573 * @file_list: List of files to allow, separated by comma. If %NULL then all
574 * files are permitted
576 * the sequence number of the new filter (>=0) if the filter was added, or a
579 static inline int log_add_filter(const char *drv_name,
580 enum log_category_t cat_list[],
581 enum log_level_t max_level,
582 const char *file_list)
584 return log_add_filter_flags(drv_name, cat_list, max_level, file_list,
589 * log_remove_filter() - Remove a filter from a log device
591 * @drv_name: Driver name to remove the filter from (since each driver only has
593 * @filter_num: Filter number to remove (as returned by log_add_filter())
595 * 0 if the filter was removed, -%ENOENT if either the driver or the filter
596 * number was not found
598 int log_remove_filter(const char *drv_name, int filter_num);
601 * log_device_set_enable() - Enable or disable a log device
603 * Devices are referenced by their driver, so use LOG_GET_DRIVER(name) to pass
604 * the driver to this function. For example if the driver is declared with
605 * LOG_DRIVER(wibble) then pass LOG_GET_DRIVER(wibble) here.
607 * @drv: Driver of device to enable
608 * @enable: true to enable, false to disable
609 * @return 0 if OK, -ENOENT if the driver was not found
611 int log_device_set_enable(struct log_driver *drv, bool enable);
613 #if CONFIG_IS_ENABLED(LOG)
615 * log_init() - Set up the log system ready for use
617 * Return: 0 if OK, -%ENOMEM if out of memory
621 static inline int log_init(void)
628 * log_get_default_format() - get default log format
630 * The default log format is configurable via
631 * %CONFIG_LOGF_FILE, %CONFIG_LOGF_LINE, and %CONFIG_LOGF_FUNC.
633 * Return: default log format
635 static inline int log_get_default_format(void)
637 return BIT(LOGF_MSG) |
638 (IS_ENABLED(CONFIG_LOGF_FILE) ? BIT(LOGF_FILE) : 0) |
639 (IS_ENABLED(CONFIG_LOGF_LINE) ? BIT(LOGF_LINE) : 0) |
640 (IS_ENABLED(CONFIG_LOGF_FUNC) ? BIT(LOGF_FUNC) : 0);