[J-u-boot.git] / include / log.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * Logging support
 *
 * Copyright (c) 2017 Google, Inc
 * Written by Simon Glass <[email protected]>
 */

#ifndef __LOG_H
#define __LOG_H

#include <stdio.h>
#include <linker_lists.h>
#include <dm/uclass-id.h>
#include <linux/bitops.h>
#include <linux/list.h>

struct cmd_tbl;

/** Log levels supported, ranging from most to least important */
enum log_level_t {
	LOGL_EMERG = 0,		/* U-Boot is unstable */
	LOGL_ALERT,		/* Action must be taken immediately */
	LOGL_CRIT,		/* Critical conditions */
	LOGL_ERR,		/* Error that prevents something from working */
	LOGL_WARNING,		/* Warning may prevent optimial operation */
	LOGL_NOTICE,		/* Normal but significant condition, printf() */
	LOGL_INFO,		/* General information message */
	LOGL_DEBUG,		/* Basic debug-level message */
	LOGL_DEBUG_CONTENT,	/* Debug message showing full message content */
	LOGL_DEBUG_IO,		/* Debug message showing hardware I/O access */

	LOGL_COUNT,
	LOGL_NONE,

	LOGL_LEVEL_MASK = 0xf,	/* Mask for valid log levels */
	LOGL_FORCE_DEBUG = 0x10, /* Mask to force output due to LOG_DEBUG */

	LOGL_FIRST = LOGL_EMERG,
	LOGL_MAX = LOGL_DEBUG_IO,
};

/**
 * Log categories supported. Most of these correspond to uclasses (i.e.
 * enum uclass_id) but there are also some more generic categories
 */
enum log_category_t {
	LOGC_FIRST = 0,	/* First part mirrors UCLASS_... */

	LOGC_NONE = UCLASS_COUNT,	/* First number is after all uclasses */
	LOGC_ARCH,	/* Related to arch-specific code */
	LOGC_BOARD,	/* Related to board-specific code */
	LOGC_CORE,	/* Related to core features (non-driver-model) */
	LOGC_DM,	/* Core driver-model */
	LOGC_DT,	/* Device-tree */
	LOGC_EFI,	/* EFI implementation */
	LOGC_ALLOC,	/* Memory allocation */
	LOGC_SANDBOX,	/* Related to the sandbox board */
	LOGC_BLOBLIST,	/* Bloblist */
	LOGC_DEVRES,	/* Device resources (devres_... functions) */
	/* Advanced Configuration and Power Interface (ACPI) */
	LOGC_ACPI,

	LOGC_COUNT,	/* Number of log categories */
	LOGC_END,	/* Sentinel value for a list of log categories */
};

/* Helper to cast a uclass ID to a log category */
static inline int log_uc_cat(enum uclass_id id)
{
	return (enum log_category_t)id;
}

/**
 * _log() - Internal function to emit a new log record
 *
 * @cat: Category of log record (indicating which subsystem generated it)
 * @level: Level of log record (indicating its severity)
 * @file: File name of file where log record was generated
 * @line: Line number in file where log record was generated
 * @func: Function where log record was generated
 * @fmt: printf() format string for log record
 * @...: Optional parameters, according to the format string @fmt
 * @return 0 if log record was emitted, -ve on error
 */
int _log(enum log_category_t cat, enum log_level_t level, const char *file,
	 int line, const char *func, const char *fmt, ...)
		__attribute__ ((format (__printf__, 6, 7)));

static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
			   const char *file, int line, const char *func,
			   const char *fmt, ...)
		__attribute__ ((format (__printf__, 6, 7)));

static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
			   const char *file, int line, const char *func,
			   const char *fmt, ...)
{
	return 0;
}

/* Define this at the top of a file to add a prefix to debug messages */
#ifndef pr_fmt
#define pr_fmt(fmt) fmt
#endif

/* Use a default category if this file does not supply one */
#ifndef LOG_CATEGORY
#define LOG_CATEGORY LOGC_NONE
#endif

/*
 * This header may be including when CONFIG_LOG is disabled, in which case
 * CONFIG_LOG_MAX_LEVEL is not defined. Add a check for this.
 */
#if CONFIG_IS_ENABLED(LOG)
#define _LOG_MAX_LEVEL CONFIG_VAL(LOG_MAX_LEVEL)
#define log_err(_fmt...)	log(LOG_CATEGORY, LOGL_ERR, ##_fmt)
#define log_warning(_fmt...)	log(LOG_CATEGORY, LOGL_WARNING, ##_fmt)
#define log_notice(_fmt...)	log(LOG_CATEGORY, LOGL_NOTICE, ##_fmt)
#define log_info(_fmt...)	log(LOG_CATEGORY, LOGL_INFO, ##_fmt)
#define log_debug(_fmt...)	log(LOG_CATEGORY, LOGL_DEBUG, ##_fmt)
#define log_content(_fmt...)	log(LOG_CATEGORY, LOGL_DEBUG_CONTENT, ##_fmt)
#define log_io(_fmt...)		log(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
#else
#define _LOG_MAX_LEVEL LOGL_INFO
#define log_err(_fmt, ...)	printf(_fmt, ##__VA_ARGS__)
#define log_warning(_fmt, ...)	printf(_fmt, ##__VA_ARGS__)
#define log_notice(_fmt, ...)	printf(_fmt, ##__VA_ARGS__)
#define log_info(_fmt, ...)	printf(_fmt, ##__VA_ARGS__)
#define log_debug(_fmt, ...)	debug(_fmt, ##__VA_ARGS__)
#define log_content(_fmt...)	log_nop(LOG_CATEGORY, \
					LOGL_DEBUG_CONTENT, ##_fmt)
#define log_io(_fmt...)		log_nop(LOG_CATEGORY, LOGL_DEBUG_IO, ##_fmt)
#endif

#if CONFIG_IS_ENABLED(LOG)
#ifdef LOG_DEBUG
#define _LOG_DEBUG	LOGL_FORCE_DEBUG
#else
#define _LOG_DEBUG	0
#endif

/* Emit a log record if the level is less that the maximum */
#define log(_cat, _level, _fmt, _args...) ({ \
	int _l = _level; \
	if (CONFIG_IS_ENABLED(LOG) && \
	    (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL)) \
		_log((enum log_category_t)(_cat), \
		     (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
		     __LINE__, __func__, \
		      pr_fmt(_fmt), ##_args); \
	})
#else
#define log(_cat, _level, _fmt, _args...)
#endif

#define log_nop(_cat, _level, _fmt, _args...) ({ \
	int _l = _level; \
	_log_nop((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
		      __func__, pr_fmt(_fmt), ##_args); \
})

#ifdef DEBUG
#define _DEBUG	1
#else
#define _DEBUG	0
#endif

#ifdef CONFIG_SPL_BUILD
#define _SPL_BUILD	1
#else
#define _SPL_BUILD	0
#endif

#if !_DEBUG && CONFIG_IS_ENABLED(LOG)

#define debug_cond(cond, fmt, args...)			\
	do {						\
		if (1)					\
			log(LOG_CATEGORY, LOGL_DEBUG, fmt, ##args); \
	} while (0)

#else /* _DEBUG */

/*
 * Output a debug text when condition "cond" is met. The "cond" should be
 * computed by a preprocessor in the best case, allowing for the best
 * optimization.
 */
#define debug_cond(cond, fmt, args...)			\
	do {						\
		if (cond)				\
			printf(pr_fmt(fmt), ##args);	\
	} while (0)

#endif /* _DEBUG */

/* Show a message if DEBUG is defined in a file */
#define debug(fmt, args...)			\
	debug_cond(_DEBUG, fmt, ##args)

/* Show a message if not in SPL */
#define warn_non_spl(fmt, args...)			\
	debug_cond(!_SPL_BUILD, fmt, ##args)

/*
 * An assertion is run-time check done in debug mode only. If DEBUG is not
 * defined then it is skipped. If DEBUG is defined and the assertion fails,
 * then it calls panic*( which may or may not reset/halt U-Boot (see
 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
 * before release, and after release it is hoped that they don't matter. But
 * in any case these failing assertions cannot be fixed with a reset (which
 * may just do the same assertion again).
 */
void __assert_fail(const char *assertion, const char *file, unsigned int line,
		   const char *function);

/**
 * assert() - assert expression is true
 *
 * If the expression x evaluates to false and _DEBUG evaluates to true, a panic
 * message is written and the system stalls. The value of _DEBUG is set to true
 * if DEBUG is defined before including common.h.
 *
 * The expression x is always executed irrespective of the value of _DEBUG.
 *
 * @x:		expression to test
 */
#define assert(x) \
	({ if (!(x) && _DEBUG) \
		__assert_fail(#x, __FILE__, __LINE__, __func__); })

/*
 * This one actually gets compiled in even without DEBUG. It doesn't include the
 * full pathname as it may be huge. Only use this when the user should be
 * warning, similar to BUG_ON() in linux.
 *
 * @return true if assertion succeeded (condition is true), else false
 */
#define assert_noisy(x) \
	({ bool _val = (x); \
	if (!_val) \
		__assert_fail(#x, "?", __LINE__, __func__); \
	_val; \
	})

#if CONFIG_IS_ENABLED(LOG) && defined(CONFIG_LOG_ERROR_RETURN)
/*
 * Log an error return value, possibly with a message. Usage:
 *
 *	return log_ret(fred_call());
 *
 * or:
 *
 *	return log_msg_ret("fred failed", fred_call());
 */
#define log_ret(_ret) ({ \
	int __ret = (_ret); \
	if (__ret < 0) \
		log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \
	__ret; \
	})
#define log_msg_ret(_msg, _ret) ({ \
	int __ret = (_ret); \
	if (__ret < 0) \
		log(LOG_CATEGORY, LOGL_ERR, "%s: returning err=%d\n", _msg, \
		    __ret); \
	__ret; \
	})
#else
/* Non-logging versions of the above which just return the error code */
#define log_ret(_ret) (_ret)
#define log_msg_ret(_msg, _ret) ((void)(_msg), _ret)
#endif

/**
 * struct log_rec - a single log record
 *
 * Holds information about a single record in the log
 *
 * Members marked as 'not allocated' are stored as pointers and the caller is
 * responsible for making sure that the data pointed to is not overwritten.
 * Memebers marked as 'allocated' are allocated (e.g. via strdup()) by the log
 * system.
 *
 * TODO([email protected]): Compress this struct down a bit to reduce space, e.g.
 * a single u32 for cat, level, line and force_debug
 *
 * @cat: Category, representing a uclass or part of U-Boot
 * @level: Severity level, less severe is higher
 * @force_debug: Force output of debug
 * @file: Name of file where the log record was generated (not allocated)
 * @line: Line number where the log record was generated
 * @func: Function where the log record was generated (not allocated)
 * @msg: Log message (allocated)
 */
struct log_rec {
	enum log_category_t cat;
	enum log_level_t level;
	bool force_debug;
	const char *file;
	int line;
	const char *func;
	const char *msg;
};

struct log_device;

enum log_device_flags {
	LOGDF_ENABLE		= BIT(0),	/* Device is enabled */
};

/**
 * struct log_driver - a driver which accepts and processes log records
 *
 * @name: Name of driver
 * @emit: Method to call to emit a log record via this device
 * @flags: Initial value for flags (use LOGDF_ENABLE to enable on start-up)
 */
struct log_driver {
	const char *name;
	/**
	 * emit() - emit a log record
	 *
	 * Called by the log system to pass a log record to a particular driver
	 * for processing. The filter is checked before calling this function.
	 */
	int (*emit)(struct log_device *ldev, struct log_rec *rec);
	unsigned short flags;
};

/**
 * struct log_device - an instance of a log driver
 *
 * Since drivers are set up at build-time we need to have a separate device for
 * the run-time aspects of drivers (currently just a list of filters to apply
 * to records send to this device).
 *
 * @next_filter_num: Seqence number of next filter filter added (0=no filters
 *	yet). This increments with each new filter on the device, but never
 *	decrements
 * @flags: Flags for this filter (enum log_device_flags)
 * @drv: Pointer to driver for this device
 * @filter_head: List of filters for this device
 * @sibling_node: Next device in the list of all devices
 */
struct log_device {
	unsigned short next_filter_num;
	unsigned short flags;
	struct log_driver *drv;
	struct list_head filter_head;
	struct list_head sibling_node;
};

enum {
	LOGF_MAX_CATEGORIES = 5,	/* maximum categories per filter */
};

enum log_filter_flags {
	LOGFF_HAS_CAT		= 1 << 0,	/* Filter has a category list */
};

/**
 * struct log_filter - criterial to filter out log messages
 *
 * @filter_num: Sequence number of this filter.  This is returned when adding a
 *	new filter, and must be provided when removing a previously added
 *	filter.
 * @flags: Flags for this filter (LOGFF_...)
 * @cat_list: List of categories to allow (terminated by LOGC_none). If empty
 *	then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
 *	can be provided
 * @max_level: Maximum log level to allow
 * @file_list: List of files to allow, separated by comma. If NULL then all
 *	files are permitted
 * @sibling_node: Next filter in the list of filters for this log device
 */
struct log_filter {
	int filter_num;
	int flags;
	enum log_category_t cat_list[LOGF_MAX_CATEGORIES];
	enum log_level_t max_level;
	const char *file_list;
	struct list_head sibling_node;
};

#define LOG_DRIVER(_name) \
	ll_entry_declare(struct log_driver, _name, log_driver)

/**
 * log_get_cat_name() - Get the name of a category
 *
 * @cat: Category to look up
 * @return category name (which may be a uclass driver name) if found, or
 *	 "<invalid>" if invalid, or "<missing>" if not found
 */
const char *log_get_cat_name(enum log_category_t cat);

/**
 * log_get_cat_by_name() - Look up a category by name
 *
 * @name: Name to look up
 * @return category ID, or LOGC_NONE if not found
 */
enum log_category_t log_get_cat_by_name(const char *name);

/**
 * log_get_level_name() - Get the name of a log level
 *
 * @level: Log level to look up
 * @return log level name (in ALL CAPS)
 */
const char *log_get_level_name(enum log_level_t level);

/**
 * log_get_level_by_name() - Look up a log level by name
 *
 * @name: Name to look up
 * @return log level ID, or LOGL_NONE if not found
 */
enum log_level_t log_get_level_by_name(const char *name);

/* Log format flags (bit numbers) for gd->log_fmt. See log_fmt_chars */
enum log_fmt {
	LOGF_CAT	= 0,
	LOGF_LEVEL,
	LOGF_FILE,
	LOGF_LINE,
	LOGF_FUNC,
	LOGF_MSG,

	LOGF_COUNT,
	LOGF_ALL = 0x3f,
};

/* Handle the 'log test' command */
int do_log_test(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);

/**
 * log_add_filter() - Add a new filter to a log device
 *
 * @drv_name: Driver name to add the filter to (since each driver only has a
 *	single device)
 * @cat_list: List of categories to allow (terminated by LOGC_none). If empty
 *	then all categories are permitted. Up to LOGF_MAX_CATEGORIES entries
 *	can be provided
 * @max_level: Maximum log level to allow
 * @file_list: List of files to allow, separated by comma. If NULL then all
 *	files are permitted
 * @return the sequence number of the new filter (>=0) if the filter was added,
 *	or a -ve value on error
 */
int log_add_filter(const char *drv_name, enum log_category_t cat_list[],
		   enum log_level_t max_level, const char *file_list);

/**
 * log_remove_filter() - Remove a filter from a log device
 *
 * @drv_name: Driver name to remove the filter from (since each driver only has
 *	a single device)
 * @filter_num: Filter number to remove (as returned by log_add_filter())
 * @return 0 if the filter was removed, -ENOENT if either the driver or the
 *	filter number was not found
 */
int log_remove_filter(const char *drv_name, int filter_num);

#if CONFIG_IS_ENABLED(LOG)
/**
 * log_init() - Set up the log system ready for use
 *
 * @return 0 if OK, -ENOMEM if out of memory
 */
int log_init(void);
#else
static inline int log_init(void)
{
	return 0;
}
#endif

/**
 * log_get_default_format() - get default log format
 *
 * The default log format is configurable via
 * CONFIG_LOGF_FILE, CONFIG_LOGF_LINE, CONFIG_LOGF_FUNC.
 *
 * Return:	default log format
 */
static inline int log_get_default_format(void)
{
	return BIT(LOGF_MSG) |
	       (IS_ENABLED(CONFIG_LOGF_FILE) ? BIT(LOGF_FILE) : 0) |
	       (IS_ENABLED(CONFIG_LOGF_LINE) ? BIT(LOGF_LINE) : 0) |
	       (IS_ENABLED(CONFIG_LOGF_FUNC) ? BIT(LOGF_FUNC) : 0);
}

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