printk.h 13.5 KB
Newer Older
1 2 3
#ifndef __KERNEL_PRINTK__
#define __KERNEL_PRINTK__

4
#include <stdarg.h>
5
#include <linux/init.h>
6
#include <linux/kern_levels.h>
7
#include <linux/linkage.h>
8
#include <linux/cache.h>
9

10 11 12
extern const char linux_banner[];
extern const char linux_proc_banner[];

13 14
static inline int printk_get_level(const char *buffer)
{
15
	if (buffer[0] == KERN_SOH_ASCII && buffer[1]) {
16 17 18 19 20 21 22 23 24 25 26
		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)
{
27 28 29
	if (printk_get_level(buffer))
		return buffer + 2;

30 31 32
	return buffer;
}

33 34
#define CONSOLE_EXT_LOG_MAX	8192

35
/* printk's without a loglevel use this.. */
36
#define MESSAGE_LOGLEVEL_DEFAULT CONFIG_MESSAGE_LOGLEVEL_DEFAULT
37 38 39 40 41 42 43 44 45

/* 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 */

46 47 48 49 50 51 52
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])

53 54
static inline void console_silent(void)
{
55
	console_loglevel = CONSOLE_LOGLEVEL_SILENT;
56 57 58 59 60
}

static inline void console_verbose(void)
{
	if (console_loglevel)
61
		console_loglevel = CONSOLE_LOGLEVEL_MOTORMOUTH;
62 63
}

64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
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]: "

N
Neil Horman 已提交
100 101 102 103 104 105 106
/*
 * 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]: "

107 108
/*
 * Dummy printk for disabled debugging statements to use whilst maintaining
109
 * gcc's format checking.
110
 */
111 112 113 114 115
#define no_printk(fmt, ...)			\
do {						\
	if (0)					\
		printk(fmt, ##__VA_ARGS__);	\
} while (0)
116

117
#ifdef CONFIG_EARLY_PRINTK
118
extern asmlinkage __printf(1, 2)
119
void early_printk(const char *fmt, ...);
120 121 122 123
#else
static inline __printf(1, 2) __cold
void early_printk(const char *s, ...) { }
#endif
124

125 126 127 128 129 130 131 132 133 134 135
#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);
#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) { }
#endif /* PRINTK_NMI */
136

137
#ifdef CONFIG_PRINTK
138 139 140 141 142
asmlinkage __printf(5, 0)
int vprintk_emit(int facility, int level,
		 const char *dict, size_t dictlen,
		 const char *fmt, va_list args);

143
asmlinkage __printf(1, 0)
144
int vprintk(const char *fmt, va_list args);
145 146

asmlinkage __printf(5, 6) __cold
147 148 149
int printk_emit(int facility, int level,
		const char *dict, size_t dictlen,
		const char *fmt, ...);
150

151
asmlinkage __printf(1, 2) __cold
152
int printk(const char *fmt, ...);
153

154
/*
155
 * Special printk facility for scheduler/timekeeping use only, _DO_NOT_USE_ !
156
 */
157
__printf(1, 2) __cold int printk_deferred(const char *fmt, ...);
158

159 160 161 162 163 164 165 166 167 168 169 170
/*
 * 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;
171
extern int kptr_restrict;
172

173 174
extern void wake_up_klogd(void);

175 176
char *log_buf_addr_get(void);
u32 log_buf_len_get(void);
177
void log_buf_kexec_setup(void);
178
void __init setup_log_buf(int early);
179
__printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...);
180
void dump_stack_print_info(const char *log_lvl);
181
void show_regs_print_info(const char *log_lvl);
182
#else
183
static inline __printf(1, 0)
184 185 186 187
int vprintk(const char *s, va_list args)
{
	return 0;
}
188
static inline __printf(1, 2) __cold
189 190 191 192
int printk(const char *s, ...)
{
	return 0;
}
193
static inline __printf(1, 2) __cold
194
int printk_deferred(const char *s, ...)
195 196 197
{
	return 0;
}
198 199 200 201 202 203 204 205 206
static inline int printk_ratelimit(void)
{
	return 0;
}
static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies,
					  unsigned int interval_msec)
{
	return false;
}
207

208 209 210 211
static inline void wake_up_klogd(void)
{
}

212 213 214 215 216 217 218 219 220 221
static inline char *log_buf_addr_get(void)
{
	return NULL;
}

static inline u32 log_buf_len_get(void)
{
	return 0;
}

222 223 224
static inline void log_buf_kexec_setup(void)
{
}
225 226 227 228

static inline void setup_log_buf(int early)
{
}
229

230
static inline __printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...)
231 232 233
{
}

234 235 236
static inline void dump_stack_print_info(const char *log_lvl)
{
}
237 238 239 240

static inline void show_regs_print_info(const char *log_lvl)
{
}
241 242
#endif

243
extern asmlinkage void dump_stack(void) __cold;
244 245 246 247 248

#ifndef pr_fmt
#define pr_fmt(fmt) fmt
#endif

249 250 251 252 253 254
/*
 * 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.
 */
255
#define pr_emerg(fmt, ...) \
256
	printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
257
#define pr_alert(fmt, ...) \
258
	printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
259
#define pr_crit(fmt, ...) \
260
	printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
261
#define pr_err(fmt, ...) \
262
	printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
263
#define pr_warning(fmt, ...) \
264
	printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
265 266
#define pr_warn pr_warning
#define pr_notice(fmt, ...) \
267
	printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
268
#define pr_info(fmt, ...) \
269
	printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
270 271 272 273 274
/*
 * 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.
 */
275 276 277 278 279 280 281 282 283
#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, ...) \
284
	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
285 286
#endif

287 288
#include <linux/dynamic_debug.h>

289
/* If you are writing a driver, please use dev_dbg instead */
290
#if defined(CONFIG_DYNAMIC_DEBUG)
291 292 293
/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
#define pr_debug(fmt, ...) \
	dynamic_pr_debug(fmt, ##__VA_ARGS__)
294 295 296
#elif defined(DEBUG)
#define pr_debug(fmt, ...) \
	printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
297 298
#else
#define pr_debug(fmt, ...) \
299
	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
300 301
#endif

302 303 304 305 306
/*
 * Print a one-time message (analogous to WARN_ONCE() et al):
 */

#ifdef CONFIG_PRINTK
307 308 309 310 311 312 313 314
#define printk_once(fmt, ...)					\
({								\
	static bool __print_once __read_mostly;			\
								\
	if (!__print_once) {					\
		__print_once = true;				\
		printk(fmt, ##__VA_ARGS__);			\
	}							\
315
})
J
John Stultz 已提交
316 317 318 319 320 321 322 323 324
#define printk_deferred_once(fmt, ...)				\
({								\
	static bool __print_once __read_mostly;			\
								\
	if (!__print_once) {					\
		__print_once = true;				\
		printk_deferred(fmt, ##__VA_ARGS__);		\
	}							\
})
325
#else
326
#define printk_once(fmt, ...)					\
327
	no_printk(fmt, ##__VA_ARGS__)
J
John Stultz 已提交
328 329
#define printk_deferred_once(fmt, ...)				\
	no_printk(fmt, ##__VA_ARGS__)
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
#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__)
348 349 350 351 352 353 354 355 356

#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

357 358 359 360 361 362 363 364 365
/* 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

366 367 368 369 370
/*
 * ratelimited messages with local ratelimit_state,
 * no local ratelimit_state used in the !PRINTK case
 */
#ifdef CONFIG_PRINTK
371 372
#define printk_ratelimited(fmt, ...)					\
({									\
373 374 375 376 377 378 379 380
	static DEFINE_RATELIMIT_STATE(_rs,				\
				      DEFAULT_RATELIMIT_INTERVAL,	\
				      DEFAULT_RATELIMIT_BURST);		\
									\
	if (__ratelimit(&_rs))						\
		printk(fmt, ##__VA_ARGS__);				\
})
#else
381 382
#define printk_ratelimited(fmt, ...)					\
	no_printk(fmt, ##__VA_ARGS__)
383 384
#endif

385
#define pr_emerg_ratelimited(fmt, ...)					\
386
	printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
387
#define pr_alert_ratelimited(fmt, ...)					\
388
	printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
389
#define pr_crit_ratelimited(fmt, ...)					\
390
	printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
391
#define pr_err_ratelimited(fmt, ...)					\
392
	printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
393
#define pr_warn_ratelimited(fmt, ...)					\
394
	printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
395
#define pr_notice_ratelimited(fmt, ...)					\
396
	printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
397
#define pr_info_ratelimited(fmt, ...)					\
398 399
	printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
/* no pr_cont_ratelimited, don't do that... */
400 401 402 403 404 405 406 407 408

#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

409
/* If you are writing a driver, please use dev_dbg instead */
410 411 412 413 414 415 416
#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);		\
417
	DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, pr_fmt(fmt));		\
418 419
	if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) &&	\
	    __ratelimit(&_rs))						\
420
		__dynamic_pr_debug(&descriptor, pr_fmt(fmt), ##__VA_ARGS__);	\
421 422
} while (0)
#elif defined(DEBUG)
423
#define pr_debug_ratelimited(fmt, ...)					\
424 425 426
	printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
#else
#define pr_debug_ratelimited(fmt, ...) \
427
	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
428 429
#endif

430 431
extern const struct file_operations kmsg_fops;

432 433 434 435 436
enum {
	DUMP_PREFIX_NONE,
	DUMP_PREFIX_ADDRESS,
	DUMP_PREFIX_OFFSET
};
437 438 439
extern int hex_dump_to_buffer(const void *buf, size_t len, int rowsize,
			      int groupsize, char *linebuf, size_t linebuflen,
			      bool ascii);
440 441 442 443
#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);
444 445 446 447
#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
448 449
extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
				 const void *buf, size_t len);
450
#endif /* defined(CONFIG_DYNAMIC_DEBUG) */
451 452 453 454 455 456 457 458 459 460 461 462 463
#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

464 465 466 467 468
#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)
469
#elif defined(DEBUG)
470 471 472 473
#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)
474 475 476 477 478 479 480
#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
481

482
#endif