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

static inline int printk_get_level(const char *buffer)
{
	if (buffer[0] == KERN_SOH_ASCII && buffer[1]) {
		switch (buffer[1]) {
		case '0' ... '7':
		case 'd':	/* KERN_DEFAULT */
		case 'c':	/* KERN_CONT */
			return buffer[1];
		}
	}
	return 0;
}

static inline const char *printk_skip_level(const char *buffer)
{
	if (printk_get_level(buffer))
		return buffer + 2;

	return buffer;
}

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

/* strlen("ratelimit") + 1 */
#define DEVKMSG_STR_MAX_SIZE 10
extern char devkmsg_log_str[];
struct ctl_table;

struct va_format {
	const char *fmt;
	va_list *va;
};

/*
 * FW_BUG
 * Add this to a message where you are sure the firmware is buggy or behaves
 * really stupid or out of spec. Be aware that the responsible BIOS developer
 * should be able to fix this issue or at least get a concrete idea of the
 * problem by reading your message without the need of looking at the kernel
 * code.
 *
 * Use it for definite and high priority BIOS bugs.
 *
 * FW_WARN
 * Use it for not that clear (e.g. could the kernel messed up things already?)
 * and medium priority BIOS bugs.
 *
 * FW_INFO
 * Use this one if you want to tell the user or vendor about something
 * suspicious, but generally harmless related to the firmware.
 *
 * Use it for information or very low priority BIOS bugs.
 */
#define FW_BUG		"[Firmware Bug]: "
#define FW_WARN		"[Firmware Warn]: "
#define FW_INFO		"[Firmware Info]: "

/*
 * HW_ERR
 * Add this to a message for hardware errors, so that user can report
 * it to hardware vendor instead of LKML or software vendor.
 */
#define HW_ERR		"[Hardware Error]: "

/*
 * DEPRECATED
 * Add this to a message whenever you want to warn user space about the use
 * of a deprecated aspect of an API so they can stop using it
 */
#define DEPRECATED	"[Deprecated]: "

/*
 * Dummy printk for disabled debugging statements to use whilst maintaining
 * gcc's format checking.
 */
#define no_printk(fmt, ...)				\
({							\
	do {						\
		if (0)					\
			printk(fmt, ##__VA_ARGS__);	\
	} while (0);					\
	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);
extern void printk_nmi_flush_on_panic(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) { }
static inline void printk_nmi_flush_on_panic(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 int
devkmsg_sysctl_set_loglvl(struct ctl_table *table, int write, void __user *buf,
			  size_t *lenp, loff_t *ppos);

extern void wake_up_klogd(void);

char *log_buf_addr_get(void);
u32 log_buf_len_get(void);
void log_buf_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


/* If you are writing a driver, please use dev_dbg instead */
#if defined(CONFIG_DYNAMIC_DEBUG)
#include <linux/dynamic_debug.h>

/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
#define pr_debug(fmt, ...) \
	dynamic_pr_debug(fmt, ##__VA_ARGS__)
#elif defined(DEBUG)
#define pr_debug(fmt, ...) \
	printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#else
#define pr_debug(fmt, ...) \
	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#endif

/*
 * Print a one-time message (analogous to WARN_ONCE() et al):
 */

#ifdef CONFIG_PRINTK
#define printk_once(fmt, ...)					\
({								\
	static bool __print_once __read_mostly;			\
	bool __ret_print_once = !__print_once;			\
								\
	if (!__print_once) {					\
		__print_once = true;				\
		printk(fmt, ##__VA_ARGS__);			\
	}							\
	unlikely(__ret_print_once);				\
})
#define printk_deferred_once(fmt, ...)				\
({								\
	static bool __print_once __read_mostly;			\
	bool __ret_print_once = !__print_once;			\
								\
	if (!__print_once) {					\
		__print_once = true;				\
		printk_deferred(fmt, ##__VA_ARGS__);		\
	}							\
	unlikely(__ret_print_once);				\
})
#else
#define printk_once(fmt, ...)					\
	no_printk(fmt, ##__VA_ARGS__)
#define printk_deferred_once(fmt, ...)				\
	no_printk(fmt, ##__VA_ARGS__)
#endif

#define pr_emerg_once(fmt, ...)					\
	printk_once(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
#define pr_alert_once(fmt, ...)					\
	printk_once(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
#define pr_crit_once(fmt, ...)					\
	printk_once(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
#define pr_err_once(fmt, ...)					\
	printk_once(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
#define pr_warn_once(fmt, ...)					\
	printk_once(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
#define pr_notice_once(fmt, ...)				\
	printk_once(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
#define pr_info_once(fmt, ...)					\
	printk_once(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
#define pr_cont_once(fmt, ...)					\
	printk_once(KERN_CONT pr_fmt(fmt), ##__VA_ARGS__)

#if defined(DEBUG)
#define pr_devel_once(fmt, ...)					\
	printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#else
#define pr_devel_once(fmt, ...)					\
	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#endif

/* If you are writing a driver, please use dev_dbg instead */
#if defined(DEBUG)
#define pr_debug_once(fmt, ...)					\
	printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#else
#define pr_debug_once(fmt, ...)					\
	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#endif

/*
 * ratelimited messages with local ratelimit_state,
 * no local ratelimit_state used in the !PRINTK case
 */
#ifdef CONFIG_PRINTK
#define printk_ratelimited(fmt, ...)					\
({									\
	static DEFINE_RATELIMIT_STATE(_rs,				\
				      DEFAULT_RATELIMIT_INTERVAL,	\
				      DEFAULT_RATELIMIT_BURST);		\
									\
	if (__ratelimit(&_rs))						\
		printk(fmt, ##__VA_ARGS__);				\
})
#else
#define printk_ratelimited(fmt, ...)					\
	no_printk(fmt, ##__VA_ARGS__)
#endif

#define pr_emerg_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
#define pr_alert_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
#define pr_crit_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
#define pr_err_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
#define pr_warn_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
#define pr_notice_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
#define pr_info_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
/* no pr_cont_ratelimited, don't do that... */

#if defined(DEBUG)
#define pr_devel_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#else
#define pr_devel_ratelimited(fmt, ...)					\
	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#endif

/* If you are writing a driver, please use dev_dbg instead */
#if defined(CONFIG_DYNAMIC_DEBUG)
/* descriptor check is first to prevent flooding with "callbacks suppressed" */
#define pr_debug_ratelimited(fmt, ...)					\
do {									\
	static DEFINE_RATELIMIT_STATE(_rs,				\
				      DEFAULT_RATELIMIT_INTERVAL,	\
				      DEFAULT_RATELIMIT_BURST);		\
	DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, pr_fmt(fmt));		\
	if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) &&	\
	    __ratelimit(&_rs))						\
		__dynamic_pr_debug(&descriptor, pr_fmt(fmt), ##__VA_ARGS__);	\
} while (0)
#elif defined(DEBUG)
#define pr_debug_ratelimited(fmt, ...)					\
	printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#else
#define pr_debug_ratelimited(fmt, ...) \
	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#endif

extern const struct file_operations kmsg_fops;

enum {
	DUMP_PREFIX_NONE,
	DUMP_PREFIX_ADDRESS,
	DUMP_PREFIX_OFFSET
};
extern int hex_dump_to_buffer(const void *buf, size_t len, int rowsize,
			      int groupsize, char *linebuf, size_t linebuflen,
			      bool ascii);
#ifdef CONFIG_PRINTK
extern void print_hex_dump(const char *level, const char *prefix_str,
			   int prefix_type, int rowsize, int groupsize,
			   const void *buf, size_t len, bool ascii);
#if defined(CONFIG_DYNAMIC_DEBUG)
#define print_hex_dump_bytes(prefix_str, prefix_type, buf, len)	\
	dynamic_hex_dump(prefix_str, prefix_type, 16, 1, buf, len, true)
#else
extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
				 const void *buf, size_t len);
#endif /* defined(CONFIG_DYNAMIC_DEBUG) */
#else
static inline void print_hex_dump(const char *level, const char *prefix_str,
				  int prefix_type, int rowsize, int groupsize,
				  const void *buf, size_t len, bool ascii)
{
}
static inline void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
					const void *buf, size_t len)
{
}

#endif

#if defined(CONFIG_DYNAMIC_DEBUG)
#define print_hex_dump_debug(prefix_str, prefix_type, rowsize,	\
			     groupsize, buf, len, ascii)	\
	dynamic_hex_dump(prefix_str, prefix_type, rowsize,	\
			 groupsize, buf, len, ascii)
#elif defined(DEBUG)
#define print_hex_dump_debug(prefix_str, prefix_type, rowsize,		\
			     groupsize, buf, len, ascii)		\
	print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, rowsize,	\
		       groupsize, buf, len, ascii)
#else
static inline void print_hex_dump_debug(const char *prefix_str, int prefix_type,
					int rowsize, int groupsize,
					const void *buf, size_t len, bool ascii)
{
}
#endif

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