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

#define PRINTK_MAX_SINGLE_HEADER_LEN 2

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

static inline const char *printk_skip_headers(const char *buffer)
{
	while (printk_get_level(buffer))
		buffer = printk_skip_level(buffer);

	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_DEBUG	10 /* issue debug messages */
#define CONSOLE_LOGLEVEL_MOTORMOUTH 15	/* You can't shut this one up */

/*
 * Default used to be hard-coded at 7, we're now allowing it to be set from
 * kernel config.
 */
#define CONSOLE_LOGLEVEL_DEFAULT CONFIG_CONSOLE_LOGLEVEL_DEFAULT

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

#if defined(__KMSG_CHECKER) && defined(KMSG_COMPONENT)

/* generate magic string for scripts/kmsg-doc to parse */
#define pr_printk_hash(level, format, ...) \
	__KMSG_PRINT(level _FMT_ format _ARGS_ __VA_ARGS__ _END_)

#elif defined(CONFIG_KMSG_IDS) && defined(KMSG_COMPONENT)

/* format element '%pj' prints the six digit jhash of a string */
#define _pr_printk_hash(pfx, fmt, ...) \
	printk(pfx fmt, pfx fmt + __builtin_strlen(pfx), ##__VA_ARGS__)
#define pr_printk_hash(level, format, ...) \
	_pr_printk_hash(level KMSG_COMPONENT ".%pj: ", format, ##__VA_ARGS__)

#else /* !defined(CONFIG_KMSG_IDS) */

#define pr_printk_hash(level, format, ...) \
	printk(level pr_fmt(format), ##__VA_ARGS__)

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