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 optimial 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) */
100 /** @LOGC_COUNT: Number of log categories */
102 /** @LOGC_END: Sentinel value for lists of log categories */
104 /** @LOGC_CONT: Use same category as in previous call */
108 /* Helper to cast a uclass ID to a log category */
109 static inline int log_uc_cat(enum uclass_id id)
111 return (enum log_category_t)id;
115 * _log() - Internal function to emit a new log record
117 * @cat: Category of log record (indicating which subsystem generated it)
118 * @level: Level of log record (indicating its severity)
119 * @file: File name of file where log record was generated
120 * @line: Line number in file where log record was generated
121 * @func: Function where log record was generated
122 * @fmt: printf() format string for log record
123 * @...: Optional parameters, according to the format string @fmt
124 * Return: 0 if log record was emitted, -ve on error
126 int _log(enum log_category_t cat, enum log_level_t level, const char *file,
127 int line, const char *func, const char *fmt, ...)
128 __attribute__ ((format (__printf__, 6, 7)));
130 static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
131 const char *file, int line, const char *func,
132 const char *fmt, ...)
133 __attribute__ ((format (__printf__, 6, 7)));
135 static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
136 const char *file, int line, const char *func,
137 const char *fmt, ...)
142 /* Define this at the top of a file to add a prefix to debug messages */
144 #define pr_fmt(fmt) fmt
147 /* Use a default category if this file does not supply one */
149 #define LOG_CATEGORY LOGC_NONE
153 * This header may be including when CONFIG_LOG is disabled, in which case
154 * CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
156 #if CONFIG_IS_ENABLED(LOG)
157 #define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
158 #define log_err(_fmt...) log(LOG_CATEGORY, LOGL_ERR, ##_fmt)
159 #define log_warning(_fmt...) log(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
160 #define log_notice(_fmt...) log(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
161 #define log_info(_fmt...) log(LOG_CATEGORY, LOGL_INFO, ##_fmt)
162 #define log_debug(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
163 #define log_content(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_CONTENT, ##_fmt)
164 #define log_io(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
166 #define _LOG_MAX_LEVEL LOGL_INFO
167 #define log_err(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
168 #define log_warning(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
169 #define log_notice(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
170 #define log_info(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
171 #define log_debug(_fmt, ...) debug(_fmt, ##__VA_ARGS__)
172 #define log_content(_fmt...) log_nop(LOG_CATEGORY, \
173 LOGL_DEBUG_CONTENT, ##_fmt)
174 #define log_io(_fmt...) log_nop(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
177 #if CONFIG_IS_ENABLED(LOG)
179 #define _LOG_DEBUG LOGL_FORCE_DEBUG
184 /* Emit a log record if the level is less that the maximum */
185 #define log(_cat, _level, _fmt, _args...) ({ \
187 if (CONFIG_IS_ENABLED(LOG) && \
188 (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL)) \
189 _log((enum log_category_t)(_cat), \
190 (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
191 __LINE__, __func__, \
192 pr_fmt(_fmt), ##_args); \
195 #define log(_cat, _level, _fmt, _args...)
198 #define log_nop(_cat, _level, _fmt, _args...) ({ \
200 _log_nop((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
201 __func__, pr_fmt(_fmt), ##_args); \
210 #ifdef CONFIG_SPL_BUILD
216 #if !_DEBUG && CONFIG_IS_ENABLED(LOG)
218 #define debug_cond(cond, fmt, args...) \
221 log(LOG_CATEGORY, LOGL_DEBUG, fmt, ##args); \
227 * Output a debug text when condition "cond" is met. The "cond" should be
228 * computed by a preprocessor in the best case, allowing for the best
231 #define debug_cond(cond, fmt, args...) \
234 printf(pr_fmt(fmt), ##args); \
239 /* Show a message if DEBUG is defined in a file */
240 #define debug(fmt, args...) \
241 debug_cond(_DEBUG, fmt, ##args)
243 /* Show a message if not in SPL */
244 #define warn_non_spl(fmt, args...) \
245 debug_cond(!_SPL_BUILD, fmt, ##args)
248 * An assertion is run-time check done in debug mode only. If DEBUG is not
249 * defined then it is skipped. If DEBUG is defined and the assertion fails,
250 * then it calls panic*( which may or may not reset/halt U-Boot (see
251 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
252 * before release, and after release it is hoped that they don't matter. But
253 * in any case these failing assertions cannot be fixed with a reset (which
254 * may just do the same assertion again).
256 void __assert_fail(const char *assertion, const char *file, unsigned int line,
257 const char *function);
260 * assert() - assert expression is true
262 * If the expression x evaluates to false and _DEBUG evaluates to true, a panic
263 * message is written and the system stalls. The value of _DEBUG is set to true
264 * if DEBUG is defined before including common.h.
266 * The expression x is always executed irrespective of the value of _DEBUG.
268 * @x: expression to test
271 ({ if (!(x) && _DEBUG) \
272 __assert_fail(#x, __FILE__, __LINE__, __func__); })
275 * This one actually gets compiled in even without DEBUG. It doesn't include the
276 * full pathname as it may be huge. Only use this when the user should be
277 * warning, similar to BUG_ON() in linux.
279 * Return: true if assertion succeeded (condition is true), else false
281 #define assert_noisy(x) \
282 ({ bool _val = (x); \
284 __assert_fail(#x, "?", __LINE__, __func__); \
288 #if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
290 * Log an error return value, possibly with a message. Usage:
292 * return log_ret(fred_call());
296 * return log_msg_ret("fred failed", fred_call());
298 #define log_ret(_ret) ({ \
299 int __ret = (_ret); \
301 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
304 #define log_msg_ret(_msg, _ret) ({ \
305 int __ret = (_ret); \
307 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
312 /* Non-logging versions of the above which just return the error code */
313 #define log_ret(_ret) (_ret)
314 #define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
318 * struct log_rec - a single log record
320 * Holds information about a single record in the log
322 * Members marked as 'not allocated' are stored as pointers and the caller is
323 * responsible for making sure that the data pointed to is not overwritten.
324 * Memebers marked as 'allocated' are allocated (e.g. via strdup()) by the log
327 * TODO(sjg@chromium.org): Compress this struct down a bit to reduce space, e.g.
328 * a single u32 for cat, level, line and force_debug
330 * @cat: Category, representing a uclass or part of U-Boot
331 * @level: Severity level, less severe is higher
332 * @force_debug: Force output of debug
333 * @file: Name of file where the log record was generated (not allocated)
334 * @line: Line number where the log record was generated
335 * @func: Function where the log record was generated (not allocated)
336 * @msg: Log message (allocated)
339 enum log_category_t cat;
340 enum log_level_t level;
350 enum log_device_flags {
351 LOGDF_ENABLE = BIT(0), /* Device is enabled */
355 * struct log_driver - a driver which accepts and processes log records
357 * @name: Name of driver
358 * @emit: Method to call to emit a log record via this device
359 * @flags: Initial value for flags (use LOGDF_ENABLE to enable on start-up)
365 * @emit: emit a log record
367 * Called by the log system to pass a log record to a particular driver
368 * for processing. The filter is checked before calling this function.
370 int (*emit)(struct log_device *ldev, struct log_rec *rec);
371 unsigned short flags;
375 * struct log_device - an instance of a log driver
377 * Since drivers are set up at build-time we need to have a separate device for
378 * the run-time aspects of drivers (currently just a list of filters to apply
379 * to records send to this device).
381 * @next_filter_num: Seqence number of next filter filter added (0=no filters
382 * yet). This increments with each new filter on the device, but never
384 * @flags: Flags for this filter (enum log_device_flags)
385 * @drv: Pointer to driver for this device
386 * @filter_head: List of filters for this device
387 * @sibling_node: Next device in the list of all devices
390 unsigned short next_filter_num;
391 unsigned short flags;
392 struct log_driver *drv;
393 struct list_head filter_head;
394 struct list_head sibling_node;
398 LOGF_MAX_CATEGORIES = 5, /* maximum categories per filter */
402 * enum log_filter_flags - Flags which modify a filter
404 enum log_filter_flags {
405 /** @LOGFF_HAS_CAT: Filter has a category list */
406 LOGFF_HAS_CAT = 1 << 0,
407 /** @LOGFF_DENY: Filter denies matching messages */
409 /** @LOGFF_LEVEL_MIN: Filter's level is a minimum, not a maximum */
410 LOGFF_LEVEL_MIN = 1 << 2,
414 * struct log_filter - criterial to filter out log messages
416 * If a message matches all criteria, then it is allowed. If LOGFF_DENY is set,
417 * then it is denied instead.
419 * @filter_num: Sequence number of this filter. This is returned when adding a
420 * new filter, and must be provided when removing a previously added
422 * @flags: Flags for this filter (``LOGFF_...``)
423 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
424 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
426 * @level: Maximum (or minimum, if %LOGFF_MIN_LEVEL) log level to allow
427 * @file_list: List of files to allow, separated by comma. If NULL then all
428 * files are permitted
429 * @sibling_node: Next filter in the list of filters for this log device
434 enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
435 enum log_level_t level;
436 const char *file_list;
437 struct list_head sibling_node;
440 #define LOG_DRIVER(_name) \
441 ll_entry_declare(struct log_driver, _name, log_driver)
443 /* Get a pointer to a given driver */
444 #define LOG_GET_DRIVER(__name) \
445 ll_entry_get(struct log_driver, __name, log_driver)
448 * log_get_cat_name() - Get the name of a category
450 * @cat: Category to look up
451 * Return: category name (which may be a uclass driver name) if found, or
452 * "<invalid>" if invalid, or "<missing>" if not found. All error
453 * responses begin with '<'.
455 const char *log_get_cat_name(enum log_category_t cat);
458 * log_get_cat_by_name() - Look up a category by name
460 * @name: Name to look up
461 * Return: Category, or %LOGC_NONE if not found
463 enum log_category_t log_get_cat_by_name(const char *name);
466 * log_get_level_name() - Get the name of a log level
468 * @level: Log level to look up
469 * Return: Log level name (in ALL CAPS)
471 const char *log_get_level_name(enum log_level_t level);
474 * log_get_level_by_name() - Look up a log level by name
476 * @name: Name to look up
477 * Return: Log level, or %LOGL_NONE if not found
479 enum log_level_t log_get_level_by_name(const char *name);
482 * log_device_find_by_name() - Look up a log device by its driver's name
484 * @drv_name: Name of the driver
485 * Return: the log device, or %NULL if not found
487 struct log_device *log_device_find_by_name(const char *drv_name);
490 * log_has_cat() - check if a log category exists within a list
492 * @cat_list: List of categories to check, at most %LOGF_MAX_CATEGORIES entries
493 * long, terminated by %LC_END if fewer
494 * @cat: Category to search for
496 * Return: ``true`` if @cat is in @cat_list, else ``false``
498 bool log_has_cat(enum log_category_t cat_list[], enum log_category_t cat);
501 * log_has_file() - check if a file is with a list
503 * @file_list: List of files to check, separated by comma
504 * @file: File to check for. This string is matched against the end of each
505 * file in the list, i.e. ignoring any preceding path. The list is
506 * intended to consist of relative pathnames, e.g. common/main.c,cmd/log.c
508 * Return: ``true`` if @file is in @file_list, else ``false``
510 bool log_has_file(const char *file_list, const char *file);
512 /* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
525 /* Handle the 'log test' command */
526 int do_log_test(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
529 * log_add_filter_flags() - Add a new filter to a log device, specifying flags
531 * @drv_name: Driver name to add the filter to (since each driver only has a
533 * @flags: Flags for this filter (``LOGFF_...``)
534 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
535 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
537 * @level: Maximum (or minimum, if %LOGFF_LEVEL_MIN) log level to allow
538 * @file_list: List of files to allow, separated by comma. If NULL then all
539 * files are permitted
541 * the sequence number of the new filter (>=0) if the filter was added, or a
544 int log_add_filter_flags(const char *drv_name, enum log_category_t cat_list[],
545 enum log_level_t level, const char *file_list,
549 * log_add_filter() - Add a new filter to a log device
551 * @drv_name: Driver name to add the filter to (since each driver only has a
553 * @cat_list: List of categories to allow (terminated by %LOGC_END). If empty
554 * then all categories are permitted. Up to %LOGF_MAX_CATEGORIES entries
556 * @max_level: Maximum log level to allow
557 * @file_list: List of files to allow, separated by comma. If %NULL then all
558 * files are permitted
560 * the sequence number of the new filter (>=0) if the filter was added, or a
563 static inline int log_add_filter(const char *drv_name,
564 enum log_category_t cat_list[],
565 enum log_level_t max_level,
566 const char *file_list)
568 return log_add_filter_flags(drv_name, cat_list, max_level, file_list,
573 * log_remove_filter() - Remove a filter from a log device
575 * @drv_name: Driver name to remove the filter from (since each driver only has
577 * @filter_num: Filter number to remove (as returned by log_add_filter())
579 * 0 if the filter was removed, -%ENOENT if either the driver or the filter
580 * number was not found
582 int log_remove_filter(const char *drv_name, int filter_num);
585 * log_device_set_enable() - Enable or disable a log device
587 * Devices are referenced by their driver, so use LOG_GET_DRIVER(name) to pass
588 * the driver to this function. For example if the driver is declared with
589 * LOG_DRIVER(wibble) then pass LOG_GET_DRIVER(wibble) here.
591 * @drv: Driver of device to enable
592 * @enable: true to enable, false to disable
593 * @return 0 if OK, -ENOENT if the driver was not found
595 int log_device_set_enable(struct log_driver *drv, bool enable);
597 #if CONFIG_IS_ENABLED(LOG)
599 * log_init() - Set up the log system ready for use
601 * Return: 0 if OK, -%ENOMEM if out of memory
605 static inline int log_init(void)
612 * log_get_default_format() - get default log format
614 * The default log format is configurable via
615 * %CONFIG_LOGF_FILE, %CONFIG_LOGF_LINE, and %CONFIG_LOGF_FUNC.
617 * Return: default log format
619 static inline int log_get_default_format(void)
621 return BIT(LOGF_MSG) |
622 (IS_ENABLED(CONFIG_LOGF_FILE) ? BIT(LOGF_FILE) : 0) |
623 (IS_ENABLED(CONFIG_LOGF_LINE) ? BIT(LOGF_LINE) : 0) |
624 (IS_ENABLED(CONFIG_LOGF_FUNC) ? BIT(LOGF_FUNC) : 0);