[deliverable/linux.git] / include / linux / printk.h

#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[];

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 */
			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;
}

#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_DEFAULT 7 /* anything MORE serious than KERN_DEBUG */
#define CONSOLE_LOGLEVEL_DEBUG	10 /* issue debug messages */
#define CONSOLE_LOGLEVEL_MOTORMOUTH 15	/* You can't shut this one up */

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;
}

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, ...)			\
do {						\
	if (0)					\
		printk(fmt, ##__VA_ARGS__);	\
} while (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_init(void);
extern void printk_nmi_enter(void);
extern void printk_nmi_exit(void);
extern void printk_nmi_flush(void);
#else
static inline void printk_nmi_init(void) { }
static inline void printk_nmi_enter(void) { }
static inline void printk_nmi_exit(void) { }
static inline void printk_nmi_flush(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 kptr_restrict;

extern void wake_up_klogd(void);

char *log_buf_addr_get(void);
u32 log_buf_len_get(void);
void log_buf_kexec_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);
#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_kexec_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)
{
}
#endif

extern asmlinkage void dump_stack(void) __cold;

#ifndef pr_fmt
#define pr_fmt(fmt) fmt
#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, ...) \
	printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
#define pr_alert(fmt, ...) \
	printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
#define pr_crit(fmt, ...) \
	printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
#define pr_err(fmt, ...) \
	printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
#define pr_warning(fmt, ...) \
	printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
#define pr_warn pr_warning
#define pr_notice(fmt, ...) \
	printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
#define pr_info(fmt, ...) \
	printk(KERN_INFO pr_fmt(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

#include <linux/dynamic_debug.h>

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