[mirror_ubuntu-bionic-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 'd':	/* KERN_DEFAULT */
		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_QUIET	 4 /* Shhh ..., when booted with "quiet" */
#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, we're now allowing it to be set from
 * kernel config.
 */
#define CONSOLE_LOGLEVEL_DEFAULT CONFIG_CONSOLE_LOGLEVEL_DEFAULT

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;

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(5, 6) __cold
int printk_emit(int facility, int level,
		const char *dict, size_t dictlen,
		const char *fmt, ...);

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 void printk_safe_init(void);
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 printk_safe_init(void)
{
}

static inline void printk_safe_flush(void)
{
}

static inline void printk_safe_flush_on_panic(void)
{
}
#endif

extern int kptr_restrict;

extern asmlinkage void dump_stack(void) __cold;

#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 __print_once __read_mostly;			\
	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 __print_once __read_mostly;			\
	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 (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) &&	\
	    __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);
#if defined(CONFIG_DYNAMIC_DEBUG)
#define print_hex_dump_bytes(prefix_str, prefix_type, buf, len)	\
	dynamic_hex_dump(prefix_str, prefix_type, 16, 1, buf, len, true)
#else
extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
				 const void *buf, size_t len);
#endif /* defined(CONFIG_DYNAMIC_DEBUG) */
#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

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