[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>

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)) {
		switch (buffer[1]) {
		case '0' ... '7':
		case 'd':	/* KERN_DEFAULT */
			return buffer + 2;
		}
	}
	return buffer;
}

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

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

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 and side-effect checking.
 */
static inline __printf(1, 2)
int no_printk(const char *fmt, ...)
{
	return 0;
}

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

#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
asmlinkage 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 use only, _DO_NOT_USE_ !
 */
__printf(1, 2) __cold int printk_sched(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);

void log_buf_kexec_setup(void);
void __init setup_log_buf(int early);
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_sched(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 void log_buf_kexec_setup(void)
{
}

static inline void setup_log_buf(int early)
{
}

static inline 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

#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__)
#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;		\
						\
	if (!__print_once) {			\
		__print_once = true;		\
		printk(fmt, ##__VA_ARGS__);	\
	}					\
})
#else
#define printk_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, fmt);			\
	if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) &&	\
	    __ratelimit(&_rs))						\
		__dynamic_pr_debug(&descriptor, 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 void 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)
#else
#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)
#endif /* defined(CONFIG_DYNAMIC_DEBUG) */

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