[mirror_ubuntu-bionic-kernel.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[];

extern char *log_buf_addr_get(void);
extern u32 log_buf_len_get(void);

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

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