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

/* 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 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, ...);
#else
static inline __printf(1, 2) __cold
void early_printk(const char *s, ...) { }
#endif

typedef int(*printk_func_t)(const char *fmt, va_list args);

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