[mirror_ubuntu-focal-kernel.git] / include / linux / printk.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __KERNEL_PRINTK__
#define __KERNEL_PRINTK__

#include <stdarg.h>
#include <linux/init.h>
#include <linux/kern_levels.h>
#include <linux/linkage.h>
#include <linux/cache.h>

extern const char linux_banner[];
extern const char linux_proc_banner[];

#define PRINTK_MAX_SINGLE_HEADER_LEN 2

static inline int printk_get_level(const char *buffer)
{
	if (buffer[0] == KERN_SOH_ASCII && buffer[1]) {
		switch (buffer[1]) {
		case '0' ... '7':
		case 'c':	/* KERN_CONT */
			return buffer[1];
		}
	}
	return 0;
}

static inline const char *printk_skip_level(const char *buffer)
{
	if (printk_get_level(buffer))
		return buffer + 2;

	return buffer;
}

static inline const char *printk_skip_headers(const char *buffer)
{
	while (printk_get_level(buffer))
		buffer = printk_skip_level(buffer);

	return buffer;
}

#define CONSOLE_EXT_LOG_MAX	8192

/* printk's without a loglevel use this.. */
#define MESSAGE_LOGLEVEL_DEFAULT CONFIG_MESSAGE_LOGLEVEL_DEFAULT

/* We show everything that is MORE important than this.. */
#define CONSOLE_LOGLEVEL_SILENT  0 /* Mum's the word */
#define CONSOLE_LOGLEVEL_MIN	 1 /* Minimum loglevel we let people use */
#define CONSOLE_LOGLEVEL_DEBUG	10 /* issue debug messages */
#define CONSOLE_LOGLEVEL_MOTORMOUTH 15	/* You can't shut this one up */

/*
 * Default used to be hard-coded at 7, quiet used to be hardcoded at 4,
 * we're now allowing both to be set from kernel config.
 */
#define CONSOLE_LOGLEVEL_DEFAULT CONFIG_CONSOLE_LOGLEVEL_DEFAULT
#define CONSOLE_LOGLEVEL_QUIET	 CONFIG_CONSOLE_LOGLEVEL_QUIET

extern int console_printk[];

#define console_loglevel (console_printk[0])
#define default_message_loglevel (console_printk[1])
#define minimum_console_loglevel (console_printk[2])
#define default_console_loglevel (console_printk[3])

static inline void console_silent(void)
{
	console_loglevel = CONSOLE_LOGLEVEL_SILENT;
}

static inline void console_verbose(void)
{
	if (console_loglevel)
		console_loglevel = CONSOLE_LOGLEVEL_MOTORMOUTH;
}

/* strlen("ratelimit") + 1 */
#define DEVKMSG_STR_MAX_SIZE 10
extern char devkmsg_log_str[];
struct ctl_table;

extern int suppress_printk;

struct va_format {
	const char *fmt;
	va_list *va;
};

/*
 * FW_BUG
 * Add this to a message where you are sure the firmware is buggy or behaves
 * really stupid or out of spec. Be aware that the responsible BIOS developer
 * should be able to fix this issue or at least get a concrete idea of the
 * problem by reading your message without the need of looking at the kernel
 * code.
 *
 * Use it for definite and high priority BIOS bugs.
 *
 * FW_WARN
 * Use it for not that clear (e.g. could the kernel messed up things already?)
 * and medium priority BIOS bugs.
 *
 * FW_INFO
 * Use this one if you want to tell the user or vendor about something
 * suspicious, but generally harmless related to the firmware.
 *
 * Use it for information or very low priority BIOS bugs.
 */
#define FW_BUG		"[Firmware Bug]: "
#define FW_WARN		"[Firmware Warn]: "
#define FW_INFO		"[Firmware Info]: "

/*
 * HW_ERR
 * Add this to a message for hardware errors, so that user can report
 * it to hardware vendor instead of LKML or software vendor.
 */
#define HW_ERR		"[Hardware Error]: "

/*
 * DEPRECATED
 * Add this to a message whenever you want to warn user space about the use
 * of a deprecated aspect of an API so they can stop using it
 */
#define DEPRECATED	"[Deprecated]: "

/*
 * Dummy printk for disabled debugging statements to use whilst maintaining
 * gcc's format checking.
 */
#define no_printk(fmt, ...)				\
({							\
	if (0)						\
		printk(fmt, ##__VA_ARGS__);		\
	0;						\
})

#ifdef CONFIG_EARLY_PRINTK
extern asmlinkage __printf(1, 2)
void early_printk(const char *fmt, ...);
#else
static inline __printf(1, 2) __cold
void early_printk(const char *s, ...) { }
#endif

#ifdef CONFIG_PRINTK_NMI
extern void printk_nmi_enter(void);
extern void printk_nmi_exit(void);
extern void printk_nmi_direct_enter(void);
extern void printk_nmi_direct_exit(void);
#else
static inline void printk_nmi_enter(void) { }
static inline void printk_nmi_exit(void) { }
static inline void printk_nmi_direct_enter(void) { }
static inline void printk_nmi_direct_exit(void) { }
#endif /* PRINTK_NMI */

#ifdef CONFIG_PRINTK
asmlinkage __printf(5, 0)
int vprintk_emit(int facility, int level,
		 const char *dict, size_t dictlen,
		 const char *fmt, va_list args);

asmlinkage __printf(1, 0)
int vprintk(const char *fmt, va_list args);

asmlinkage __printf(1, 2) __cold
int printk(const char *fmt, ...);

/*
 * Special printk facility for scheduler/timekeeping use only, _DO_NOT_USE_ !
 */
__printf(1, 2) __cold int printk_deferred(const char *fmt, ...);

/*
 * Please don't use printk_ratelimit(), because it shares ratelimiting state
 * with all other unrelated printk_ratelimit() callsites.  Instead use
 * printk_ratelimited() or plain old __ratelimit().
 */
extern int __printk_ratelimit(const char *func);
#define printk_ratelimit() __printk_ratelimit(__func__)
extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
				   unsigned int interval_msec);

extern int printk_delay_msec;
extern int dmesg_restrict;

extern int
devkmsg_sysctl_set_loglvl(struct ctl_table *table, int write, void __user *buf,
			  size_t *lenp, loff_t *ppos);

extern void wake_up_klogd(void);

char *log_buf_addr_get(void);
u32 log_buf_len_get(void);
void log_buf_vmcoreinfo_setup(void);
void __init setup_log_buf(int early);
__printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...);
void dump_stack_print_info(const char *log_lvl);
void show_regs_print_info(const char *log_lvl);
extern asmlinkage void dump_stack(void) __cold;
extern void printk_safe_flush(void);
extern void printk_safe_flush_on_panic(void);
#else
static inline __printf(1, 0)
int vprintk(const char *s, va_list args)
{
	return 0;
}
static inline __printf(1, 2) __cold
int printk(const char *s, ...)
{
	return 0;
}
static inline __printf(1, 2) __cold
int printk_deferred(const char *s, ...)
{
	return 0;
}
static inline int printk_ratelimit(void)
{
	return 0;
}
static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies,
					  unsigned int interval_msec)
{
	return false;
}

static inline void wake_up_klogd(void)
{
}

static inline char *log_buf_addr_get(void)
{
	return NULL;
}

static inline u32 log_buf_len_get(void)
{
	return 0;
}

static inline void log_buf_vmcoreinfo_setup(void)
{
}

static inline void setup_log_buf(int early)
{
}

static inline __printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...)
{
}

static inline void dump_stack_print_info(const char *log_lvl)
{
}

static inline void show_regs_print_info(const char *log_lvl)
{
}

static inline void dump_stack(void)
{
}

static inline void printk_safe_flush(void)
{
}

static inline void printk_safe_flush_on_panic(void)
{
}
#endif

extern int kptr_restrict;

#ifndef pr_fmt
#define pr_fmt(fmt) fmt
#endif

#if defined(__KMSG_CHECKER) && defined(KMSG_COMPONENT)

/* generate magic string for scripts/kmsg-doc to parse */
#define pr_printk_hash(level, format, ...) \
	__KMSG_PRINT(level _FMT_ format _ARGS_ __VA_ARGS__ _END_)

#elif defined(CONFIG_KMSG_IDS) && defined(KMSG_COMPONENT)

/* format element '%pj' prints the six digit jhash of a string */
#define _pr_printk_hash(pfx, fmt, ...) \
	printk(pfx fmt, pfx fmt + __builtin_strlen(pfx), ##__VA_ARGS__)
#define pr_printk_hash(level, format, ...) \
	_pr_printk_hash(level KMSG_COMPONENT ".%pj: ", format, ##__VA_ARGS__)

#else /* !defined(CONFIG_KMSG_IDS) */

#define pr_printk_hash(level, format, ...) \
	printk(level pr_fmt(format), ##__VA_ARGS__)

#endif

/*
 * These can be used to print at the various log levels.
 * All of these will print unconditionally, although note that pr_debug()
 * and other debug macros are compiled out unless either DEBUG is defined
 * or CONFIG_DYNAMIC_DEBUG is set.
 */
#define pr_emerg(fmt, ...) \
	pr_printk_hash(KERN_EMERG, fmt, ##__VA_ARGS__)
#define pr_alert(fmt, ...) \
	pr_printk_hash(KERN_ALERT, fmt, ##__VA_ARGS__)
#define pr_crit(fmt, ...) \
	pr_printk_hash(KERN_CRIT, fmt, ##__VA_ARGS__)
#define pr_err(fmt, ...) \
	pr_printk_hash(KERN_ERR, fmt, ##__VA_ARGS__)
#define pr_warning(fmt, ...) \
	pr_printk_hash(KERN_WARNING, fmt, ##__VA_ARGS__)
#define pr_warn pr_warning
#define pr_notice(fmt, ...) \
	pr_printk_hash(KERN_NOTICE, fmt, ##__VA_ARGS__)
#define pr_info(fmt, ...) \
	pr_printk_hash(KERN_INFO, fmt, ##__VA_ARGS__)
/*
 * Like KERN_CONT, pr_cont() should only be used when continuing
 * a line with no newline ('\n') enclosed. Otherwise it defaults
 * back to KERN_DEFAULT.
 */
#define pr_cont(fmt, ...) \
	printk(KERN_CONT fmt, ##__VA_ARGS__)

/* pr_devel() should produce zero code unless DEBUG is defined */
#ifdef DEBUG
#define pr_devel(fmt, ...) \
	printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#else
#define pr_devel(fmt, ...) \
	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#endif


/* If you are writing a driver, please use dev_dbg instead */
#if defined(CONFIG_DYNAMIC_DEBUG)
#include <linux/dynamic_debug.h>

/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
#define pr_debug(fmt, ...) \
	dynamic_pr_debug(fmt, ##__VA_ARGS__)
#elif defined(DEBUG)
#define pr_debug(fmt, ...) \
	printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#else
#define pr_debug(fmt, ...) \
	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#endif

/*
 * Print a one-time message (analogous to WARN_ONCE() et al):
 */

#ifdef CONFIG_PRINTK
#define printk_once(fmt, ...)					\
({								\
	static bool __section(.data.once) __print_once;		\
	bool __ret_print_once = !__print_once;			\
								\
	if (!__print_once) {					\
		__print_once = true;				\
		printk(fmt, ##__VA_ARGS__);			\
	}							\
	unlikely(__ret_print_once);				\
})
#define printk_deferred_once(fmt, ...)				\
({								\
	static bool __section(.data.once) __print_once;		\
	bool __ret_print_once = !__print_once;			\
								\
	if (!__print_once) {					\
		__print_once = true;				\
		printk_deferred(fmt, ##__VA_ARGS__);		\
	}							\
	unlikely(__ret_print_once);				\
})
#else
#define printk_once(fmt, ...)					\
	no_printk(fmt, ##__VA_ARGS__)
#define printk_deferred_once(fmt, ...)				\
	no_printk(fmt, ##__VA_ARGS__)
#endif

#define pr_emerg_once(fmt, ...)					\
	printk_once(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
#define pr_alert_once(fmt, ...)					\
	printk_once(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
#define pr_crit_once(fmt, ...)					\
	printk_once(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
#define pr_err_once(fmt, ...)					\
	printk_once(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
#define pr_warn_once(fmt, ...)					\
	printk_once(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
#define pr_notice_once(fmt, ...)				\
	printk_once(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
#define pr_info_once(fmt, ...)					\
	printk_once(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
#define pr_cont_once(fmt, ...)					\
	printk_once(KERN_CONT pr_fmt(fmt), ##__VA_ARGS__)

#if defined(DEBUG)
#define pr_devel_once(fmt, ...)					\
	printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#else
#define pr_devel_once(fmt, ...)					\
	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#endif

/* If you are writing a driver, please use dev_dbg instead */
#if defined(DEBUG)
#define pr_debug_once(fmt, ...)					\
	printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#else
#define pr_debug_once(fmt, ...)					\
	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#endif

/*
 * ratelimited messages with local ratelimit_state,
 * no local ratelimit_state used in the !PRINTK case
 */
#ifdef CONFIG_PRINTK
#define printk_ratelimited(fmt, ...)					\
({									\
	static DEFINE_RATELIMIT_STATE(_rs,				\
				      DEFAULT_RATELIMIT_INTERVAL,	\
				      DEFAULT_RATELIMIT_BURST);		\
									\
	if (__ratelimit(&_rs))						\
		printk(fmt, ##__VA_ARGS__);				\
})
#else
#define printk_ratelimited(fmt, ...)					\
	no_printk(fmt, ##__VA_ARGS__)
#endif

#define pr_emerg_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
#define pr_alert_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
#define pr_crit_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
#define pr_err_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
#define pr_warn_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
#define pr_notice_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
#define pr_info_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
/* no pr_cont_ratelimited, don't do that... */

#if defined(DEBUG)
#define pr_devel_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#else
#define pr_devel_ratelimited(fmt, ...)					\
	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#endif

/* If you are writing a driver, please use dev_dbg instead */
#if defined(CONFIG_DYNAMIC_DEBUG)
/* descriptor check is first to prevent flooding with "callbacks suppressed" */
#define pr_debug_ratelimited(fmt, ...)					\
do {									\
	static DEFINE_RATELIMIT_STATE(_rs,				\
				      DEFAULT_RATELIMIT_INTERVAL,	\
				      DEFAULT_RATELIMIT_BURST);		\
	DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, pr_fmt(fmt));		\
	if (DYNAMIC_DEBUG_BRANCH(descriptor) &&				\
	    __ratelimit(&_rs))						\
		__dynamic_pr_debug(&descriptor, pr_fmt(fmt), ##__VA_ARGS__);	\
} while (0)
#elif defined(DEBUG)
#define pr_debug_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#else
#define pr_debug_ratelimited(fmt, ...) \
	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#endif

extern const struct file_operations kmsg_fops;

enum {
	DUMP_PREFIX_NONE,
	DUMP_PREFIX_ADDRESS,
	DUMP_PREFIX_OFFSET
};
extern int hex_dump_to_buffer(const void *buf, size_t len, int rowsize,
			      int groupsize, char *linebuf, size_t linebuflen,
			      bool ascii);
#ifdef CONFIG_PRINTK
extern void print_hex_dump(const char *level, const char *prefix_str,
			   int prefix_type, int rowsize, int groupsize,
			   const void *buf, size_t len, bool ascii);
#else
static inline void print_hex_dump(const char *level, const char *prefix_str,
				  int prefix_type, int rowsize, int groupsize,
				  const void *buf, size_t len, bool ascii)
{
}
static inline void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
					const void *buf, size_t len)
{
}

#endif

#if defined(CONFIG_DYNAMIC_DEBUG)
#define print_hex_dump_debug(prefix_str, prefix_type, rowsize,	\
			     groupsize, buf, len, ascii)	\
	dynamic_hex_dump(prefix_str, prefix_type, rowsize,	\
			 groupsize, buf, len, ascii)
#elif defined(DEBUG)
#define print_hex_dump_debug(prefix_str, prefix_type, rowsize,		\
			     groupsize, buf, len, ascii)		\
	print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, rowsize,	\
		       groupsize, buf, len, ascii)
#else
static inline void print_hex_dump_debug(const char *prefix_str, int prefix_type,
					int rowsize, int groupsize,
					const void *buf, size_t len, bool ascii)
{
}
#endif

/**
 * print_hex_dump_bytes - shorthand form of print_hex_dump() with default params
 * @prefix_str: string to prefix each line with;
 *  caller supplies trailing spaces for alignment if desired
 * @prefix_type: controls whether prefix of an offset, address, or none
 *  is printed (%DUMP_PREFIX_OFFSET, %DUMP_PREFIX_ADDRESS, %DUMP_PREFIX_NONE)
 * @buf: data blob to dump
 * @len: number of bytes in the @buf
 *
 * Calls print_hex_dump(), with log level of KERN_DEBUG,
 * rowsize of 16, groupsize of 1, and ASCII output included.
 */
#define print_hex_dump_bytes(prefix_str, prefix_type, buf, len)	\
	print_hex_dump_debug(prefix_str, prefix_type, 16, 1, buf, len, true)

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
968ab183 LT	2	#ifndef __KERNEL_PRINTK__
	3	#define __KERNEL_PRINTK__
	4
1b2c289b	5	#include <stdarg.h>
162a7e75	6	#include <linux/init.h>
314ba352	7	#include <linux/kern_levels.h>
154c2670	8	#include <linux/linkage.h>
c28aa1f0	9	#include <linux/cache.h>
162a7e75	10
968ab183 LT	11	extern const char linux_banner[];
	12	extern const char linux_proc_banner[];
	13
262c5e86 PM	14	#define PRINTK_MAX_SINGLE_HEADER_LEN 2
262c5e86 PM	15
acc8fa41 JP	16	static inline int printk_get_level(const char *buffer)
acc8fa41 JP	17	{
04d2c8c8	18	if (buffer[0] == KERN_SOH_ASCII && buffer[1]) {
acc8fa41 JP	19	switch (buffer[1]) {
acc8fa41 JP	20	case '0' ... '7':
4bcc595c	21	case 'c': /* KERN_CONT */
acc8fa41 JP	22	return buffer[1];
	23	}
	24	}
	25	return 0;
	26	}
	27
	28	static inline const char printk_skip_level(const char buffer)
	29	{
0185698c PM	30	if (printk_get_level(buffer))
	31	return buffer + 2;
	32
acc8fa41 JP	33	return buffer;
	34	}
	35
49795757 PM	36	static inline const char printk_skip_headers(const char buffer)
	37	{
	38	while (printk_get_level(buffer))
	39	buffer = printk_skip_level(buffer);
	40
	41	return buffer;
	42	}
	43
d43ff430 TH	44	#define CONSOLE_EXT_LOG_MAX 8192
d43ff430 TH	45
a8fe19eb	46	/* printk's without a loglevel use this.. */
42a9dc0b	47	#define MESSAGE_LOGLEVEL_DEFAULT CONFIG_MESSAGE_LOGLEVEL_DEFAULT
a8fe19eb BP	48
	49	/* We show everything that is MORE important than this.. */
	50	#define CONSOLE_LOGLEVEL_SILENT 0 /* Mum's the word */
	51	#define CONSOLE_LOGLEVEL_MIN 1 /* Minimum loglevel we let people use */
a8fe19eb BP	52	#define CONSOLE_LOGLEVEL_DEBUG 10 /* issue debug messages */
	53	#define CONSOLE_LOGLEVEL_MOTORMOUTH 15 /* You can't shut this one up */
	54
a8cfdc68	55	/*
22eceb8b HG	56	* Default used to be hard-coded at 7, quiet used to be hardcoded at 4,
22eceb8b HG	57	* we're now allowing both to be set from kernel config.
a8cfdc68 OJ	58	*/
a8cfdc68 OJ	59	#define CONSOLE_LOGLEVEL_DEFAULT CONFIG_CONSOLE_LOGLEVEL_DEFAULT
22eceb8b	60	#define CONSOLE_LOGLEVEL_QUIET CONFIG_CONSOLE_LOGLEVEL_QUIET
a8cfdc68	61
968ab183 LT	62	extern int console_printk[];
	63
	64	#define console_loglevel (console_printk[0])
	65	#define default_message_loglevel (console_printk[1])
	66	#define minimum_console_loglevel (console_printk[2])
	67	#define default_console_loglevel (console_printk[3])
	68
a9747cc3 JP	69	static inline void console_silent(void)
a9747cc3 JP	70	{
a8fe19eb	71	console_loglevel = CONSOLE_LOGLEVEL_SILENT;
a9747cc3 JP	72	}
	73
	74	static inline void console_verbose(void)
	75	{
	76	if (console_loglevel)
a8fe19eb	77	console_loglevel = CONSOLE_LOGLEVEL_MOTORMOUTH;
a9747cc3 JP	78	}
a9747cc3 JP	79
750afe7b BP	80	/* strlen("ratelimit") + 1 */
	81	#define DEVKMSG_STR_MAX_SIZE 10
	82	extern char devkmsg_log_str[];
	83	struct ctl_table;
	84
c39ea0b9 FT	85	extern int suppress_printk;
c39ea0b9 FT	86
968ab183 LT	87	struct va_format {
	88	const char *fmt;
	89	va_list *va;
	90	};
	91
	92	/*
	93	* FW_BUG
	94	* Add this to a message where you are sure the firmware is buggy or behaves
	95	* really stupid or out of spec. Be aware that the responsible BIOS developer
	96	* should be able to fix this issue or at least get a concrete idea of the
	97	* problem by reading your message without the need of looking at the kernel
	98	* code.
	99	*
	100	* Use it for definite and high priority BIOS bugs.
	101	*
	102	* FW_WARN
	103	* Use it for not that clear (e.g. could the kernel messed up things already?)
	104	* and medium priority BIOS bugs.
	105	*
	106	* FW_INFO
	107	* Use this one if you want to tell the user or vendor about something
	108	* suspicious, but generally harmless related to the firmware.
	109	*
	110	* Use it for information or very low priority BIOS bugs.
	111	*/
	112	#define FW_BUG "[Firmware Bug]: "
	113	#define FW_WARN "[Firmware Warn]: "
	114	#define FW_INFO "[Firmware Info]: "
	115
	116	/*
	117	* HW_ERR
	118	* Add this to a message for hardware errors, so that user can report
	119	* it to hardware vendor instead of LKML or software vendor.
	120	*/
	121	#define HW_ERR "[Hardware Error]: "
	122
0a9a8bfd NH	123	/*
	124	* DEPRECATED
	125	* Add this to a message whenever you want to warn user space about the use
	126	* of a deprecated aspect of an API so they can stop using it
	127	*/
	128	#define DEPRECATED "[Deprecated]: "
	129
5264f2f7 JP	130	/*
5264f2f7 JP	131	* Dummy printk for disabled debugging statements to use whilst maintaining
fe22cd9b	132	* gcc's format checking.
5264f2f7	133	*/
069f0cd0 BP	134	#define no_printk(fmt, ...) \
069f0cd0 BP	135	({ \
93b138dd MY	136	if (0) \
93b138dd MY	137	printk(fmt, ##__VA_ARGS__); \
069f0cd0 BP	138	0; \
069f0cd0 BP	139	})
5264f2f7	140
d0380e6c	141	#ifdef CONFIG_EARLY_PRINTK
b9075fa9	142	extern asmlinkage __printf(1, 2)
5264f2f7	143	void early_printk(const char *fmt, ...);
d0380e6c TG	144	#else
	145	static inline __printf(1, 2) __cold
	146	void early_printk(const char *s, ...) { }
	147	#endif
5264f2f7	148
42a0bb3f	149	#ifdef CONFIG_PRINTK_NMI
42a0bb3f PM	150	extern void printk_nmi_enter(void);
42a0bb3f PM	151	extern void printk_nmi_exit(void);
03fc7f9c PM	152	extern void printk_nmi_direct_enter(void);
03fc7f9c PM	153	extern void printk_nmi_direct_exit(void);
42a0bb3f	154	#else
42a0bb3f PM	155	static inline void printk_nmi_enter(void) { }
42a0bb3f PM	156	static inline void printk_nmi_exit(void) { }
03fc7f9c PM	157	static inline void printk_nmi_direct_enter(void) { }
03fc7f9c PM	158	static inline void printk_nmi_direct_exit(void) { }
42a0bb3f	159	#endif /* PRINTK_NMI */
04b74b27	160
968ab183	161	#ifdef CONFIG_PRINTK
7ff9554b KS	162	asmlinkage __printf(5, 0)
	163	int vprintk_emit(int facility, int level,
	164	const char *dict, size_t dictlen,
	165	const char *fmt, va_list args);
	166
b9075fa9	167	asmlinkage __printf(1, 0)
5264f2f7	168	int vprintk(const char *fmt, va_list args);
7ff9554b	169
b9075fa9	170	asmlinkage __printf(1, 2) __cold
5264f2f7	171	int printk(const char *fmt, ...);
968ab183	172
3ccf3e83	173	/*
aac74dc4	174	* Special printk facility for scheduler/timekeeping use only, _DO_NOT_USE_ !
3ccf3e83	175	*/
aac74dc4	176	__printf(1, 2) __cold int printk_deferred(const char *fmt, ...);
3ccf3e83	177
968ab183 LT	178	/*
	179	* Please don't use printk_ratelimit(), because it shares ratelimiting state
	180	* with all other unrelated printk_ratelimit() callsites. Instead use
	181	* printk_ratelimited() or plain old __ratelimit().
	182	*/
	183	extern int __printk_ratelimit(const char *func);
	184	#define printk_ratelimit() __printk_ratelimit(__func__)
	185	extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
	186	unsigned int interval_msec);
	187
	188	extern int printk_delay_msec;
	189	extern int dmesg_restrict;
	190
750afe7b BP	191	extern int
	192	devkmsg_sysctl_set_loglvl(struct ctl_table table, int write, void __user buf,
	193	size_t lenp, loff_t ppos);
	194
dc72c32e FW	195	extern void wake_up_klogd(void);
dc72c32e FW	196
07261edb PK	197	char *log_buf_addr_get(void);
07261edb PK	198	u32 log_buf_len_get(void);
692f66f2	199	void log_buf_vmcoreinfo_setup(void);
162a7e75	200	void __init setup_log_buf(int early);
8db14860	201	__printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...);
196779b9	202	void dump_stack_print_info(const char *log_lvl);
a43cb95d	203	void show_regs_print_info(const char *log_lvl);
e36df28f	204	extern asmlinkage void dump_stack(void) __cold;
099f1c84 SS	205	extern void printk_safe_flush(void);
099f1c84 SS	206	extern void printk_safe_flush_on_panic(void);
968ab183	207	#else
b9075fa9	208	static inline __printf(1, 0)
5264f2f7 JP	209	int vprintk(const char *s, va_list args)
	210	{
	211	return 0;
	212	}
b9075fa9	213	static inline __printf(1, 2) __cold
5264f2f7 JP	214	int printk(const char *s, ...)
	215	{
	216	return 0;
	217	}
3ccf3e83	218	static inline __printf(1, 2) __cold
aac74dc4	219	int printk_deferred(const char *s, ...)
3ccf3e83 PZ	220	{
	221	return 0;
	222	}
5264f2f7 JP	223	static inline int printk_ratelimit(void)
	224	{
	225	return 0;
	226	}
	227	static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies,
	228	unsigned int interval_msec)
	229	{
	230	return false;
	231	}
968ab183	232
dc72c32e FW	233	static inline void wake_up_klogd(void)
	234	{
	235	}
	236
07261edb PK	237	static inline char *log_buf_addr_get(void)
	238	{
	239	return NULL;
	240	}
	241
	242	static inline u32 log_buf_len_get(void)
	243	{
	244	return 0;
	245	}
	246
692f66f2	247	static inline void log_buf_vmcoreinfo_setup(void)
968ab183 LT	248	{
968ab183 LT	249	}
162a7e75 MT	250
	251	static inline void setup_log_buf(int early)
	252	{
	253	}
196779b9	254
8db14860	255	static inline __printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...)
98e5e1bf TH	256	{
	257	}
	258
196779b9 TH	259	static inline void dump_stack_print_info(const char *log_lvl)
	260	{
	261	}
a43cb95d TH	262
	263	static inline void show_regs_print_info(const char *log_lvl)
	264	{
	265	}
099f1c84	266
e6310f0f	267	static inline void dump_stack(void)
e36df28f DY	268	{
	269	}
	270
099f1c84 SS	271	static inline void printk_safe_flush(void)
	272	{
	273	}
	274
	275	static inline void printk_safe_flush_on_panic(void)
	276	{
	277	}
968ab183 LT	278	#endif
968ab183 LT	279
01c313dd AB	280	extern int kptr_restrict;
01c313dd AB	281
968ab183 LT	282	#ifndef pr_fmt
	283	#define pr_fmt(fmt) fmt
	284	#endif
	285
a2dc5b76 MS	286	#if defined(__KMSG_CHECKER) && defined(KMSG_COMPONENT)
	287
	288	/* generate magic string for scripts/kmsg-doc to parse */
	289	#define pr_printk_hash(level, format, ...) \
	290	__KMSG_PRINT(level _FMT_ format _ARGS_ __VA_ARGS__ _END_)
	291
	292	#elif defined(CONFIG_KMSG_IDS) && defined(KMSG_COMPONENT)
	293
	294	/* format element '%pj' prints the six digit jhash of a string */
	295	#define _pr_printk_hash(pfx, fmt, ...) \
	296	printk(pfx fmt, pfx fmt + __builtin_strlen(pfx), ##__VA_ARGS__)
	297	#define pr_printk_hash(level, format, ...) \
	298	_pr_printk_hash(level KMSG_COMPONENT ".%pj: ", format, ##__VA_ARGS__)
	299
	300	#else /* !defined(CONFIG_KMSG_IDS) */
	301
	302	#define pr_printk_hash(level, format, ...) \
	303	printk(level pr_fmt(format), ##__VA_ARGS__)
	304
	305	#endif
	306
6e099f55 DS	307	/*
	308	* These can be used to print at the various log levels.
	309	* All of these will print unconditionally, although note that pr_debug()
	310	* and other debug macros are compiled out unless either DEBUG is defined
	311	* or CONFIG_DYNAMIC_DEBUG is set.
	312	*/
a0cba217	313	#define pr_emerg(fmt, ...) \
a2dc5b76	314	pr_printk_hash(KERN_EMERG, fmt, ##__VA_ARGS__)
a0cba217	315	#define pr_alert(fmt, ...) \
a2dc5b76	316	pr_printk_hash(KERN_ALERT, fmt, ##__VA_ARGS__)
a0cba217	317	#define pr_crit(fmt, ...) \
a2dc5b76	318	pr_printk_hash(KERN_CRIT, fmt, ##__VA_ARGS__)
a0cba217	319	#define pr_err(fmt, ...) \
a2dc5b76	320	pr_printk_hash(KERN_ERR, fmt, ##__VA_ARGS__)
a0cba217	321	#define pr_warning(fmt, ...) \
a2dc5b76	322	pr_printk_hash(KERN_WARNING, fmt, ##__VA_ARGS__)
a0cba217 LT	323	#define pr_warn pr_warning
a0cba217 LT	324	#define pr_notice(fmt, ...) \
a2dc5b76	325	pr_printk_hash(KERN_NOTICE, fmt, ##__VA_ARGS__)
a0cba217	326	#define pr_info(fmt, ...) \
a2dc5b76	327	pr_printk_hash(KERN_INFO, fmt, ##__VA_ARGS__)
7b1460ec SR	328	/*
	329	* Like KERN_CONT, pr_cont() should only be used when continuing
	330	* a line with no newline ('\n') enclosed. Otherwise it defaults
	331	* back to KERN_DEFAULT.
	332	*/
968ab183 LT	333	#define pr_cont(fmt, ...) \
	334	printk(KERN_CONT fmt, ##__VA_ARGS__)
	335
	336	/* pr_devel() should produce zero code unless DEBUG is defined */
	337	#ifdef DEBUG
	338	#define pr_devel(fmt, ...) \
	339	printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
	340	#else
	341	#define pr_devel(fmt, ...) \
5264f2f7	342	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
968ab183 LT	343	#endif
968ab183 LT	344
29fc2bc7	345
968ab183	346	/* If you are writing a driver, please use dev_dbg instead */
b558c96f	347	#if defined(CONFIG_DYNAMIC_DEBUG)
9d5059c9 LB	348	#include <linux/dynamic_debug.h>
9d5059c9 LB	349
968ab183 LT	350	/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
	351	#define pr_debug(fmt, ...) \
	352	dynamic_pr_debug(fmt, ##__VA_ARGS__)
b558c96f JC	353	#elif defined(DEBUG)
	354	#define pr_debug(fmt, ...) \
	355	printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
968ab183 LT	356	#else
968ab183 LT	357	#define pr_debug(fmt, ...) \
5264f2f7	358	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
968ab183 LT	359	#endif
968ab183 LT	360
16cb839f JP	361	/*
	362	* Print a one-time message (analogous to WARN_ONCE() et al):
	363	*/
	364
	365	#ifdef CONFIG_PRINTK
c28aa1f0 JP	366	#define printk_once(fmt, ...) \
c28aa1f0 JP	367	({ \
3ec25826	368	static bool __section(.data.once) __print_once; \
069f0cd0	369	bool __ret_print_once = !__print_once; \
c28aa1f0 JP	370	\
	371	if (!__print_once) { \
	372	__print_once = true; \
	373	printk(fmt, ##__VA_ARGS__); \
	374	} \
069f0cd0	375	unlikely(__ret_print_once); \
16cb839f	376	})
c224815d JS	377	#define printk_deferred_once(fmt, ...) \
c224815d JS	378	({ \
3ec25826	379	static bool __section(.data.once) __print_once; \
069f0cd0	380	bool __ret_print_once = !__print_once; \
c224815d JS	381	\
	382	if (!__print_once) { \
	383	__print_once = true; \
	384	printk_deferred(fmt, ##__VA_ARGS__); \
	385	} \
069f0cd0	386	unlikely(__ret_print_once); \
c224815d	387	})
16cb839f	388	#else
c28aa1f0	389	#define printk_once(fmt, ...) \
16cb839f	390	no_printk(fmt, ##__VA_ARGS__)
c224815d JS	391	#define printk_deferred_once(fmt, ...) \
c224815d JS	392	no_printk(fmt, ##__VA_ARGS__)
16cb839f JP	393	#endif
	394
	395	#define pr_emerg_once(fmt, ...) \
	396	printk_once(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
	397	#define pr_alert_once(fmt, ...) \
	398	printk_once(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
	399	#define pr_crit_once(fmt, ...) \
	400	printk_once(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
	401	#define pr_err_once(fmt, ...) \
	402	printk_once(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
	403	#define pr_warn_once(fmt, ...) \
	404	printk_once(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
	405	#define pr_notice_once(fmt, ...) \
	406	printk_once(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
	407	#define pr_info_once(fmt, ...) \
	408	printk_once(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
	409	#define pr_cont_once(fmt, ...) \
	410	printk_once(KERN_CONT pr_fmt(fmt), ##__VA_ARGS__)
36d308d8 MG	411
	412	#if defined(DEBUG)
	413	#define pr_devel_once(fmt, ...) \
	414	printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
	415	#else
	416	#define pr_devel_once(fmt, ...) \
	417	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
	418	#endif
	419
16cb839f JP	420	/* If you are writing a driver, please use dev_dbg instead */
	421	#if defined(DEBUG)
	422	#define pr_debug_once(fmt, ...) \
	423	printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
	424	#else
	425	#define pr_debug_once(fmt, ...) \
	426	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
	427	#endif
	428
968ab183 LT	429	/*
	430	* ratelimited messages with local ratelimit_state,
	431	* no local ratelimit_state used in the !PRINTK case
	432	*/
	433	#ifdef CONFIG_PRINTK
6ec42a56 JP	434	#define printk_ratelimited(fmt, ...) \
6ec42a56 JP	435	({ \
968ab183 LT	436	static DEFINE_RATELIMIT_STATE(_rs, \
	437	DEFAULT_RATELIMIT_INTERVAL, \
	438	DEFAULT_RATELIMIT_BURST); \
	439	\
	440	if (__ratelimit(&_rs)) \
	441	printk(fmt, ##__VA_ARGS__); \
	442	})
	443	#else
6ec42a56 JP	444	#define printk_ratelimited(fmt, ...) \
6ec42a56 JP	445	no_printk(fmt, ##__VA_ARGS__)
968ab183 LT	446	#endif
968ab183 LT	447
6ec42a56	448	#define pr_emerg_ratelimited(fmt, ...) \
968ab183	449	printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56	450	#define pr_alert_ratelimited(fmt, ...) \
968ab183	451	printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56	452	#define pr_crit_ratelimited(fmt, ...) \
968ab183	453	printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56	454	#define pr_err_ratelimited(fmt, ...) \
968ab183	455	printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56	456	#define pr_warn_ratelimited(fmt, ...) \
968ab183	457	printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56	458	#define pr_notice_ratelimited(fmt, ...) \
968ab183	459	printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56	460	#define pr_info_ratelimited(fmt, ...) \
968ab183 LT	461	printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
968ab183 LT	462	/* no pr_cont_ratelimited, don't do that... */
36d308d8 MG	463
	464	#if defined(DEBUG)
	465	#define pr_devel_ratelimited(fmt, ...) \
	466	printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
	467	#else
	468	#define pr_devel_ratelimited(fmt, ...) \
	469	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
	470	#endif
	471
968ab183	472	/* If you are writing a driver, please use dev_dbg instead */
29fc2bc7 JP	473	#if defined(CONFIG_DYNAMIC_DEBUG)
	474	/* descriptor check is first to prevent flooding with "callbacks suppressed" */
	475	#define pr_debug_ratelimited(fmt, ...) \
	476	do { \
	477	static DEFINE_RATELIMIT_STATE(_rs, \
	478	DEFAULT_RATELIMIT_INTERVAL, \
	479	DEFAULT_RATELIMIT_BURST); \
515a9adc	480	DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, pr_fmt(fmt)); \
a9d4ab7a	481	if (DYNAMIC_DEBUG_BRANCH(descriptor) && \
29fc2bc7	482	__ratelimit(&_rs)) \
515a9adc	483	__dynamic_pr_debug(&descriptor, pr_fmt(fmt), ##__VA_ARGS__); \
29fc2bc7 JP	484	} while (0)
29fc2bc7 JP	485	#elif defined(DEBUG)
6ec42a56	486	#define pr_debug_ratelimited(fmt, ...) \
968ab183 LT	487	printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
	488	#else
	489	#define pr_debug_ratelimited(fmt, ...) \
5264f2f7	490	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
968ab183 LT	491	#endif
968ab183 LT	492
e11fea92 KS	493	extern const struct file_operations kmsg_fops;
e11fea92 KS	494
ac83ed68 JP	495	enum {
	496	DUMP_PREFIX_NONE,
	497	DUMP_PREFIX_ADDRESS,
	498	DUMP_PREFIX_OFFSET
	499	};
114fc1af AS	500	extern int hex_dump_to_buffer(const void *buf, size_t len, int rowsize,
	501	int groupsize, char *linebuf, size_t linebuflen,
	502	bool ascii);
ac83ed68 JP	503	#ifdef CONFIG_PRINTK
	504	extern void print_hex_dump(const char level, const char prefix_str,
	505	int prefix_type, int rowsize, int groupsize,
	506	const void *buf, size_t len, bool ascii);
ac83ed68 JP	507	#else
	508	static inline void print_hex_dump(const char level, const char prefix_str,
	509	int prefix_type, int rowsize, int groupsize,
	510	const void *buf, size_t len, bool ascii)
	511	{
	512	}
	513	static inline void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
	514	const void *buf, size_t len)
	515	{
	516	}
	517
	518	#endif
	519
7a555613 VK	520	#if defined(CONFIG_DYNAMIC_DEBUG)
	521	#define print_hex_dump_debug(prefix_str, prefix_type, rowsize, \
	522	groupsize, buf, len, ascii) \
	523	dynamic_hex_dump(prefix_str, prefix_type, rowsize, \
	524	groupsize, buf, len, ascii)
cdf17449	525	#elif defined(DEBUG)
7a555613 VK	526	#define print_hex_dump_debug(prefix_str, prefix_type, rowsize, \
	527	groupsize, buf, len, ascii) \
	528	print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, rowsize, \
	529	groupsize, buf, len, ascii)
cdf17449 LW	530	#else
	531	static inline void print_hex_dump_debug(const char *prefix_str, int prefix_type,
	532	int rowsize, int groupsize,
	533	const void *buf, size_t len, bool ascii)
	534	{
	535	}
	536	#endif
7a555613	537
091cb099 SB	538	/**
	539	* print_hex_dump_bytes - shorthand form of print_hex_dump() with default params
	540	* @prefix_str: string to prefix each line with;
	541	* caller supplies trailing spaces for alignment if desired
	542	* @prefix_type: controls whether prefix of an offset, address, or none
	543	* is printed (%DUMP_PREFIX_OFFSET, %DUMP_PREFIX_ADDRESS, %DUMP_PREFIX_NONE)
	544	* @buf: data blob to dump
	545	* @len: number of bytes in the @buf
	546	*
	547	* Calls print_hex_dump(), with log level of KERN_DEBUG,
	548	* rowsize of 16, groupsize of 1, and ASCII output included.
	549	*/
	550	#define print_hex_dump_bytes(prefix_str, prefix_type, buf, len) \
	551	print_hex_dump_debug(prefix_str, prefix_type, 16, 1, buf, len, true)
	552
968ab183	553	#endif