blob: cf32351134375bc4fd86d126b57f8d12a5dd2983 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass0e98b0a2017-12-04 13:48:20 -07002/*
3 * Logging support
4 *
5 * Copyright (c) 2017 Google, Inc
6 * Written by Simon Glass <sjg@chromium.org>
Simon Glass0e98b0a2017-12-04 13:48:20 -07007 */
8
9#ifndef __LOG_H
10#define __LOG_H
11
Sean Andersonaaa05de2019-12-24 23:54:54 -050012#include <command.h>
Simon Glasse9c8d492017-12-04 13:48:24 -070013#include <dm/uclass-id.h>
14#include <linux/list.h>
15
16/** Log levels supported, ranging from most to least important */
17enum log_level_t {
Simon Glass6fc7e932019-02-16 20:24:34 -070018 LOGL_EMERG = 0, /* U-Boot is unstable */
Simon Glasse9c8d492017-12-04 13:48:24 -070019 LOGL_ALERT, /* Action must be taken immediately */
20 LOGL_CRIT, /* Critical conditions */
21 LOGL_ERR, /* Error that prevents something from working */
22 LOGL_WARNING, /* Warning may prevent optimial operation */
23 LOGL_NOTICE, /* Normal but significant condition, printf() */
24 LOGL_INFO, /* General information message */
25 LOGL_DEBUG, /* Basic debug-level message */
26 LOGL_DEBUG_CONTENT, /* Debug message showing full message content */
27 LOGL_DEBUG_IO, /* Debug message showing hardware I/O access */
28
29 LOGL_COUNT,
Simon Glassf941c8d2017-12-28 13:14:16 -070030 LOGL_NONE,
31
Simon Glasse9c8d492017-12-04 13:48:24 -070032 LOGL_FIRST = LOGL_EMERG,
Simon Glassf941c8d2017-12-28 13:14:16 -070033 LOGL_MAX = LOGL_DEBUG_IO,
Simon Glasse9c8d492017-12-04 13:48:24 -070034};
35
36/**
37 * Log categories supported. Most of these correspond to uclasses (i.e.
38 * enum uclass_id) but there are also some more generic categories
39 */
40enum log_category_t {
41 LOGC_FIRST = 0, /* First part mirrors UCLASS_... */
42
Simon Glass0bf96452018-10-01 12:22:32 -060043 LOGC_NONE = UCLASS_COUNT, /* First number is after all uclasses */
44 LOGC_ARCH, /* Related to arch-specific code */
45 LOGC_BOARD, /* Related to board-specific code */
46 LOGC_CORE, /* Related to core features (non-driver-model) */
Simon Glassf941c8d2017-12-28 13:14:16 -070047 LOGC_DM, /* Core driver-model */
48 LOGC_DT, /* Device-tree */
Heinrich Schuchardtd8d89972018-03-23 21:12:17 +010049 LOGC_EFI, /* EFI implementation */
Simon Glassc3aed5d2018-10-01 11:55:13 -060050 LOGC_ALLOC, /* Memory allocation */
Simon Glassa5c13b62018-11-06 15:21:24 -070051 LOGC_SANDBOX, /* Related to the sandbox board */
Simon Glass9f407d42018-11-15 18:43:50 -070052 LOGC_BLOBLIST, /* Bloblist */
Simon Glasscce61fc2019-12-29 21:19:24 -070053 LOGC_DEVRES, /* Device resources (devres_... functions) */
Simon Glass7ca28502020-04-09 10:27:38 -060054 /* Advanced Configuration and Power Interface (ACPI) */
55 LOGC_ACPI,
Simon Glasse9c8d492017-12-04 13:48:24 -070056
Simon Glass0bf96452018-10-01 12:22:32 -060057 LOGC_COUNT, /* Number of log categories */
58 LOGC_END, /* Sentinel value for a list of log categories */
Simon Glasse9c8d492017-12-04 13:48:24 -070059};
60
61/* Helper to cast a uclass ID to a log category */
62static inline int log_uc_cat(enum uclass_id id)
63{
64 return (enum log_category_t)id;
65}
66
67/**
68 * _log() - Internal function to emit a new log record
69 *
70 * @cat: Category of log record (indicating which subsystem generated it)
71 * @level: Level of log record (indicating its severity)
72 * @file: File name of file where log record was generated
73 * @line: Line number in file where log record was generated
74 * @func: Function where log record was generated
75 * @fmt: printf() format string for log record
76 * @...: Optional parameters, according to the format string @fmt
77 * @return 0 if log record was emitted, -ve on error
78 */
79int _log(enum log_category_t cat, enum log_level_t level, const char *file,
Simon Glassed4e9332019-01-07 16:44:19 -070080 int line, const char *func, const char *fmt, ...)
81 __attribute__ ((format (__printf__, 6, 7)));
Simon Glasse9c8d492017-12-04 13:48:24 -070082
Simon Glassfd429482019-09-25 08:56:23 -060083static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
84 const char *file, int line, const char *func,
85 const char *fmt, ...)
86 __attribute__ ((format (__printf__, 6, 7)));
87
88static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
89 const char *file, int line, const char *func,
90 const char *fmt, ...)
91{
92 return 0;
93}
94
Simon Glasse9c8d492017-12-04 13:48:24 -070095/* Define this at the top of a file to add a prefix to debug messages */
96#ifndef pr_fmt
97#define pr_fmt(fmt) fmt
98#endif
99
100/* Use a default category if this file does not supply one */
101#ifndef LOG_CATEGORY
102#define LOG_CATEGORY LOGC_NONE
103#endif
104
105/*
106 * This header may be including when CONFIG_LOG is disabled, in which case
107 * CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
108 */
109#if CONFIG_IS_ENABLED(LOG)
110#define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
Simon Glasscdd140a2018-10-01 11:55:06 -0600111#define log_err(_fmt...) log(LOG_CATEGORY, LOGL_ERR, ##_fmt)
112#define log_warning(_fmt...) log(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
113#define log_notice(_fmt...) log(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
114#define log_info(_fmt...) log(LOG_CATEGORY, LOGL_INFO, ##_fmt)
115#define log_debug(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
116#define log_content(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_CONTENT, ##_fmt)
117#define log_io(_fmt...) log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
Simon Glasse9c8d492017-12-04 13:48:24 -0700118#else
119#define _LOG_MAX_LEVEL LOGL_INFO
Heinrich Schuchardt20fd2562020-02-26 21:48:17 +0100120#define log_err(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
121#define log_warning(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
122#define log_notice(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
123#define log_info(_fmt, ...) printf(_fmt, ##__VA_ARGS__)
124#define log_debug(_fmt, ...) debug(_fmt, ##__VA_ARGS__)
Simon Glassfd429482019-09-25 08:56:23 -0600125#define log_content(_fmt...) log_nop(LOG_CATEGORY, \
126 LOGL_DEBUG_CONTENT, ##_fmt)
127#define log_io(_fmt...) log_nop(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
Simon Glasse9c8d492017-12-04 13:48:24 -0700128#endif
129
Simon Glass4d8d3052018-11-15 18:43:49 -0700130#if CONFIG_IS_ENABLED(LOG)
Simon Glassf9811e82019-02-16 20:24:37 -0700131#ifdef LOG_DEBUG
132#define _LOG_DEBUG 1
133#else
134#define _LOG_DEBUG 0
135#endif
Simon Glass4d8d3052018-11-15 18:43:49 -0700136
Simon Glasse9c8d492017-12-04 13:48:24 -0700137/* Emit a log record if the level is less that the maximum */
138#define log(_cat, _level, _fmt, _args...) ({ \
139 int _l = _level; \
Simon Glassf9811e82019-02-16 20:24:37 -0700140 if (CONFIG_IS_ENABLED(LOG) && (_l <= _LOG_MAX_LEVEL || _LOG_DEBUG)) \
Simon Glasse9c8d492017-12-04 13:48:24 -0700141 _log((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
142 __func__, \
143 pr_fmt(_fmt), ##_args); \
144 })
Simon Glass4d8d3052018-11-15 18:43:49 -0700145#else
146#define log(_cat, _level, _fmt, _args...)
147#endif
Simon Glasse9c8d492017-12-04 13:48:24 -0700148
Simon Glassfd429482019-09-25 08:56:23 -0600149#define log_nop(_cat, _level, _fmt, _args...) ({ \
150 int _l = _level; \
151 _log_nop((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
152 __func__, pr_fmt(_fmt), ##_args); \
153})
154
Simon Glass0e98b0a2017-12-04 13:48:20 -0700155#ifdef DEBUG
156#define _DEBUG 1
157#else
158#define _DEBUG 0
159#endif
160
161#ifdef CONFIG_SPL_BUILD
162#define _SPL_BUILD 1
163#else
164#define _SPL_BUILD 0
165#endif
166
Simon Glasse9c8d492017-12-04 13:48:24 -0700167#if !_DEBUG && CONFIG_IS_ENABLED(LOG)
168
169#define debug_cond(cond, fmt, args...) \
170 do { \
171 if (1) \
172 log(LOG_CATEGORY, LOGL_DEBUG, fmt, ##args); \
173 } while (0)
174
175#else /* _DEBUG */
176
Simon Glass0e98b0a2017-12-04 13:48:20 -0700177/*
178 * Output a debug text when condition "cond" is met. The "cond" should be
179 * computed by a preprocessor in the best case, allowing for the best
180 * optimization.
181 */
182#define debug_cond(cond, fmt, args...) \
183 do { \
184 if (cond) \
185 printf(pr_fmt(fmt), ##args); \
186 } while (0)
187
Simon Glasse9c8d492017-12-04 13:48:24 -0700188#endif /* _DEBUG */
189
Simon Glass0e98b0a2017-12-04 13:48:20 -0700190/* Show a message if DEBUG is defined in a file */
191#define debug(fmt, args...) \
192 debug_cond(_DEBUG, fmt, ##args)
193
194/* Show a message if not in SPL */
195#define warn_non_spl(fmt, args...) \
196 debug_cond(!_SPL_BUILD, fmt, ##args)
197
198/*
199 * An assertion is run-time check done in debug mode only. If DEBUG is not
200 * defined then it is skipped. If DEBUG is defined and the assertion fails,
201 * then it calls panic*( which may or may not reset/halt U-Boot (see
202 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
203 * before release, and after release it is hoped that they don't matter. But
204 * in any case these failing assertions cannot be fixed with a reset (which
205 * may just do the same assertion again).
206 */
207void __assert_fail(const char *assertion, const char *file, unsigned int line,
208 const char *function);
Heinrich Schuchardtb236f8c2019-07-27 20:21:06 +0200209
210/**
211 * assert() - assert expression is true
212 *
213 * If the expression x evaluates to false and _DEBUG evaluates to true, a panic
214 * message is written and the system stalls. The value of _DEBUG is set to true
215 * if DEBUG is defined before including common.h.
216 *
217 * The expression x is always executed irrespective of the value of _DEBUG.
218 *
219 * @x: expression to test
220 */
Simon Glass0e98b0a2017-12-04 13:48:20 -0700221#define assert(x) \
222 ({ if (!(x) && _DEBUG) \
223 __assert_fail(#x, __FILE__, __LINE__, __func__); })
224
Simon Glasscd01d2d2019-12-29 21:19:10 -0700225/*
226 * This one actually gets compiled in even without DEBUG. It doesn't include the
227 * full pathname as it may be huge. Only use this when the user should be
228 * warning, similar to BUG_ON() in linux.
229 *
230 * @return true if assertion succeeded (condition is true), else false
231 */
232#define assert_noisy(x) \
233 ({ bool _val = (x); \
234 if (!_val) \
235 __assert_fail(#x, "?", __LINE__, __func__); \
236 _val; \
237 })
238
Simon Glass4d8d3052018-11-15 18:43:49 -0700239#if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
240/*
241 * Log an error return value, possibly with a message. Usage:
242 *
243 * return log_ret(fred_call());
244 *
245 * or:
246 *
247 * return log_msg_ret("fred failed", fred_call());
248 */
Simon Glass3707c6e2017-12-28 13:14:23 -0700249#define log_ret(_ret) ({ \
250 int __ret = (_ret); \
251 if (__ret < 0) \
252 log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
253 __ret; \
254 })
Simon Glassb616cef2018-06-11 13:07:14 -0600255#define log_msg_ret(_msg, _ret) ({ \
256 int __ret = (_ret); \
257 if (__ret < 0) \
258 log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
259 __ret); \
260 __ret; \
261 })
Simon Glass3707c6e2017-12-28 13:14:23 -0700262#else
Simon Glass4d8d3052018-11-15 18:43:49 -0700263/* Non-logging versions of the above which just return the error code */
Simon Glass3707c6e2017-12-28 13:14:23 -0700264#define log_ret(_ret) (_ret)
Simon Glass4d8d3052018-11-15 18:43:49 -0700265#define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
Simon Glass3707c6e2017-12-28 13:14:23 -0700266#endif
267
Simon Glasse9c8d492017-12-04 13:48:24 -0700268/**
269 * struct log_rec - a single log record
270 *
271 * Holds information about a single record in the log
272 *
273 * Members marked as 'not allocated' are stored as pointers and the caller is
274 * responsible for making sure that the data pointed to is not overwritten.
275 * Memebers marked as 'allocated' are allocated (e.g. via strdup()) by the log
276 * system.
277 *
278 * @cat: Category, representing a uclass or part of U-Boot
279 * @level: Severity level, less severe is higher
280 * @file: Name of file where the log record was generated (not allocated)
281 * @line: Line number where the log record was generated
282 * @func: Function where the log record was generated (not allocated)
283 * @msg: Log message (allocated)
284 */
285struct log_rec {
286 enum log_category_t cat;
287 enum log_level_t level;
288 const char *file;
289 int line;
290 const char *func;
291 const char *msg;
292};
293
294struct log_device;
295
296/**
297 * struct log_driver - a driver which accepts and processes log records
298 *
299 * @name: Name of driver
300 */
301struct log_driver {
302 const char *name;
303 /**
304 * emit() - emit a log record
305 *
306 * Called by the log system to pass a log record to a particular driver
307 * for processing. The filter is checked before calling this function.
308 */
309 int (*emit)(struct log_device *ldev, struct log_rec *rec);
310};
311
312/**
313 * struct log_device - an instance of a log driver
314 *
315 * Since drivers are set up at build-time we need to have a separate device for
316 * the run-time aspects of drivers (currently just a list of filters to apply
317 * to records send to this device).
318 *
319 * @next_filter_num: Seqence number of next filter filter added (0=no filters
320 * yet). This increments with each new filter on the device, but never
321 * decrements
322 * @drv: Pointer to driver for this device
323 * @filter_head: List of filters for this device
324 * @sibling_node: Next device in the list of all devices
325 */
326struct log_device {
327 int next_filter_num;
328 struct log_driver *drv;
329 struct list_head filter_head;
330 struct list_head sibling_node;
331};
332
333enum {
334 LOGF_MAX_CATEGORIES = 5, /* maximum categories per filter */
335};
336
337enum log_filter_flags {
338 LOGFF_HAS_CAT = 1 << 0, /* Filter has a category list */
339};
340
341/**
342 * struct log_filter - criterial to filter out log messages
343 *
344 * @filter_num: Sequence number of this filter. This is returned when adding a
345 * new filter, and must be provided when removing a previously added
346 * filter.
347 * @flags: Flags for this filter (LOGFF_...)
348 * @cat_list: List of categories to allow (terminated by LOGC_none). If empty
349 * then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
350 * can be provided
351 * @max_level: Maximum log level to allow
352 * @file_list: List of files to allow, separated by comma. If NULL then all
353 * files are permitted
354 * @sibling_node: Next filter in the list of filters for this log device
355 */
356struct log_filter {
357 int filter_num;
358 int flags;
359 enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
360 enum log_level_t max_level;
361 const char *file_list;
362 struct list_head sibling_node;
363};
364
365#define LOG_DRIVER(_name) \
366 ll_entry_declare(struct log_driver, _name, log_driver)
367
Simon Glassf941c8d2017-12-28 13:14:16 -0700368/**
369 * log_get_cat_name() - Get the name of a category
370 *
371 * @cat: Category to look up
Simon Glassc2e4e7e2018-06-12 00:04:55 -0600372 * @return category name (which may be a uclass driver name) if found, or
373 * "<invalid>" if invalid, or "<missing>" if not found
Simon Glassf941c8d2017-12-28 13:14:16 -0700374 */
375const char *log_get_cat_name(enum log_category_t cat);
376
377/**
378 * log_get_cat_by_name() - Look up a category by name
379 *
380 * @name: Name to look up
381 * @return category ID, or LOGC_NONE if not found
382 */
383enum log_category_t log_get_cat_by_name(const char *name);
384
385/**
386 * log_get_level_name() - Get the name of a log level
387 *
388 * @level: Log level to look up
389 * @return log level name (in ALL CAPS)
390 */
391const char *log_get_level_name(enum log_level_t level);
392
393/**
394 * log_get_level_by_name() - Look up a log level by name
395 *
396 * @name: Name to look up
397 * @return log level ID, or LOGL_NONE if not found
398 */
399enum log_level_t log_get_level_by_name(const char *name);
400
Simon Glass3b73e8d2017-12-28 13:14:17 -0700401/* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
402enum log_fmt {
403 LOGF_CAT = 0,
404 LOGF_LEVEL,
405 LOGF_FILE,
406 LOGF_LINE,
407 LOGF_FUNC,
408 LOGF_MSG,
409
410 LOGF_COUNT,
411 LOGF_DEFAULT = (1 << LOGF_FUNC) | (1 << LOGF_MSG),
412 LOGF_ALL = 0x3f,
413};
414
Simon Glassef11ed82017-12-04 13:48:27 -0700415/* Handle the 'log test' command */
416int do_log_test(cmd_tbl_t *cmdtp, int flag, int argc, char *const argv[]);
417
Simon Glasse9c8d492017-12-04 13:48:24 -0700418/**
419 * log_add_filter() - Add a new filter to a log device
420 *
421 * @drv_name: Driver name to add the filter to (since each driver only has a
422 * single device)
423 * @cat_list: List of categories to allow (terminated by LOGC_none). If empty
424 * then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
425 * can be provided
426 * @max_level: Maximum log level to allow
427 * @file_list: List of files to allow, separated by comma. If NULL then all
428 * files are permitted
429 * @return the sequence number of the new filter (>=0) if the filter was added,
430 * or a -ve value on error
431 */
432int log_add_filter(const char *drv_name, enum log_category_t cat_list[],
433 enum log_level_t max_level, const char *file_list);
434
435/**
436 * log_remove_filter() - Remove a filter from a log device
437 *
438 * @drv_name: Driver name to remove the filter from (since each driver only has
439 * a single device)
440 * @filter_num: Filter number to remove (as returned by log_add_filter())
441 * @return 0 if the filter was removed, -ENOENT if either the driver or the
442 * filter number was not found
443 */
444int log_remove_filter(const char *drv_name, int filter_num);
445
446#if CONFIG_IS_ENABLED(LOG)
447/**
448 * log_init() - Set up the log system ready for use
449 *
450 * @return 0 if OK, -ENOMEM if out of memory
451 */
452int log_init(void);
453#else
454static inline int log_init(void)
455{
456 return 0;
457}
458#endif
459
Simon Glass0e98b0a2017-12-04 13:48:20 -0700460#endif