printk.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  2#ifndef __KERNEL_PRINTK__
  3#define __KERNEL_PRINTK__
  4
  5#include <linux/stdarg.h>
  6#include <linux/init.h>
  7#include <linux/kern_levels.h>
  8#include <linux/linkage.h>
  9#include <linux/ratelimit_types.h>
 10#include <linux/once_lite.h>
 11
 12struct console;
 13
 14extern const char linux_banner[];
 15extern const char linux_proc_banner[];
 16
 17extern int oops_in_progress;	/* If set, an oops, panic(), BUG() or die() is in progress */
 18
 19#define PRINTK_MAX_SINGLE_HEADER_LEN 2
 20
 21static inline int printk_get_level(const char *buffer)
 22{
 23	if (buffer[0] == KERN_SOH_ASCII && buffer[1]) {
 24		switch (buffer[1]) {
 25		case '0' ... '7':
 26		case 'c':	/* KERN_CONT */
 27			return buffer[1];
 28		}
 29	}
 30	return 0;
 31}
 32
 33static inline const char *printk_skip_level(const char *buffer)
 34{
 35	if (printk_get_level(buffer))
 36		return buffer + 2;
 37
 38	return buffer;
 39}
 40
 41static inline const char *printk_skip_headers(const char *buffer)
 42{
 43	while (printk_get_level(buffer))
 44		buffer = printk_skip_level(buffer);
 45
 46	return buffer;
 47}
 48
 49/* printk's without a loglevel use this.. */
 50#define MESSAGE_LOGLEVEL_DEFAULT CONFIG_MESSAGE_LOGLEVEL_DEFAULT
 51
 52/* We show everything that is MORE important than this.. */
 53#define CONSOLE_LOGLEVEL_SILENT  0 /* Mum's the word */
 54#define CONSOLE_LOGLEVEL_MIN	 1 /* Minimum loglevel we let people use */
 55#define CONSOLE_LOGLEVEL_DEBUG	10 /* issue debug messages */
 56#define CONSOLE_LOGLEVEL_MOTORMOUTH 15	/* You can't shut this one up */
 57
 58/*
 59 * Default used to be hard-coded at 7, quiet used to be hardcoded at 4,
 60 * we're now allowing both to be set from kernel config.
 61 */
 62#define CONSOLE_LOGLEVEL_DEFAULT CONFIG_CONSOLE_LOGLEVEL_DEFAULT
 63#define CONSOLE_LOGLEVEL_QUIET	 CONFIG_CONSOLE_LOGLEVEL_QUIET
 64
 65int match_devname_and_update_preferred_console(const char *match,
 66					       const char *name,
 67					       const short idx);
 68
 69extern int console_printk[];
 70
 71#define console_loglevel (console_printk[0])
 72#define default_message_loglevel (console_printk[1])
 73#define minimum_console_loglevel (console_printk[2])
 74#define default_console_loglevel (console_printk[3])
 75
 76extern void console_verbose(void);
 77
 78/* strlen("ratelimit") + 1 */
 79#define DEVKMSG_STR_MAX_SIZE 10
 80extern char devkmsg_log_str[DEVKMSG_STR_MAX_SIZE];
 81struct ctl_table;
 82
 83extern int suppress_printk;
 84
 85struct 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
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
128/*
129 * Dummy printk for disabled debugging statements to use whilst maintaining
130 * gcc's format checking.
131 */
132#define no_printk(fmt, ...)				\
133({							\
134	if (0)						\
135		_printk(fmt, ##__VA_ARGS__);		\
136	0;						\
137})
138
139#ifdef CONFIG_EARLY_PRINTK
140extern asmlinkage __printf(1, 2)
141void early_printk(const char *fmt, ...);
142#else
143static inline __printf(1, 2) __cold
144void early_printk(const char *s, ...) { }
145#endif
146
147struct dev_printk_info;
148
149#ifdef CONFIG_PRINTK
150asmlinkage __printf(4, 0)
151int vprintk_emit(int facility, int level,
152		 const struct dev_printk_info *dev_info,
153		 const char *fmt, va_list args);
154
155asmlinkage __printf(1, 0)
156int vprintk(const char *fmt, va_list args);
157__printf(1, 0)
158int vprintk_deferred(const char *fmt, va_list args);
159
160asmlinkage __printf(1, 2) __cold
161int _printk(const char *fmt, ...);
162
163/*
164 * Special printk facility for scheduler/timekeeping use only, _DO_NOT_USE_ !
165 */
166__printf(1, 2) __cold int _printk_deferred(const char *fmt, ...);
167
168extern void __printk_deferred_enter(void);
169extern void __printk_deferred_exit(void);
170
171extern void printk_force_console_enter(void);
172extern void printk_force_console_exit(void);
173
174/*
175 * The printk_deferred_enter/exit macros are available only as a hack for
176 * some code paths that need to defer all printk console printing. Interrupts
177 * must be disabled for the deferred duration.
178 */
179#define printk_deferred_enter() __printk_deferred_enter()
180#define printk_deferred_exit() __printk_deferred_exit()
181
182/*
183 * Please don't use printk_ratelimit(), because it shares ratelimiting state
184 * with all other unrelated printk_ratelimit() callsites.  Instead use
185 * printk_ratelimited() or plain old __ratelimit().
186 */
187extern int __printk_ratelimit(const char *func);
188#define printk_ratelimit() __printk_ratelimit(__func__)
189extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
190				   unsigned int interval_msec);
191
192extern int printk_delay_msec;
193extern int dmesg_restrict;
194
195extern void wake_up_klogd(void);
196
197char *log_buf_addr_get(void);
198u32 log_buf_len_get(void);
199void log_buf_vmcoreinfo_setup(void);
200void __init setup_log_buf(int early);
201__printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...);
202void dump_stack_print_info(const char *log_lvl);
203void show_regs_print_info(const char *log_lvl);
204extern asmlinkage void dump_stack_lvl(const char *log_lvl) __cold;
205extern asmlinkage void dump_stack(void) __cold;
206void printk_trigger_flush(void);
207void console_try_replay_all(void);
208void printk_legacy_allow_panic_sync(void);
209extern bool nbcon_device_try_acquire(struct console *con);
210extern void nbcon_device_release(struct console *con);
211void nbcon_atomic_flush_unsafe(void);
212bool pr_flush(int timeout_ms, bool reset_on_progress);
213#else
214static inline __printf(1, 0)
215int vprintk(const char *s, va_list args)
216{
217	return 0;
218}
219static inline __printf(1, 0)
220int vprintk_deferred(const char *fmt, va_list args)
221{
222	return 0;
223}
224static inline __printf(1, 2) __cold
225int _printk(const char *s, ...)
226{
227	return 0;
228}
229static inline __printf(1, 2) __cold
230int _printk_deferred(const char *s, ...)
231{
232	return 0;
233}
234
235static inline void printk_deferred_enter(void)
236{
237}
238
239static inline void printk_deferred_exit(void)
240{
241}
242
243static inline void printk_force_console_enter(void)
244{
245}
246
247static inline void printk_force_console_exit(void)
248{
249}
250
251static inline int printk_ratelimit(void)
252{
253	return 0;
254}
255static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies,
256					  unsigned int interval_msec)
257{
258	return false;
259}
260
261static inline void wake_up_klogd(void)
262{
263}
264
265static inline char *log_buf_addr_get(void)
266{
267	return NULL;
268}
269
270static inline u32 log_buf_len_get(void)
271{
272	return 0;
273}
274
275static inline void log_buf_vmcoreinfo_setup(void)
276{
277}
278
279static inline void setup_log_buf(int early)
280{
281}
282
283static inline __printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...)
284{
285}
286
287static inline void dump_stack_print_info(const char *log_lvl)
288{
289}
290
291static inline void show_regs_print_info(const char *log_lvl)
292{
293}
294
295static inline void dump_stack_lvl(const char *log_lvl)
296{
297}
298
299static inline void dump_stack(void)
300{
301}
302static inline void printk_trigger_flush(void)
303{
304}
305static inline void console_try_replay_all(void)
306{
307}
308
309static inline void printk_legacy_allow_panic_sync(void)
310{
311}
312
313static inline bool nbcon_device_try_acquire(struct console *con)
314{
315	return false;
316}
317
318static inline void nbcon_device_release(struct console *con)
319{
320}
321
322static inline void nbcon_atomic_flush_unsafe(void)
323{
324}
325
326static inline bool pr_flush(int timeout_ms, bool reset_on_progress)
327{
328	return true;
329}
330
331#endif
332
333#ifdef CONFIG_SMP
334extern int __printk_cpu_sync_try_get(void);
335extern void __printk_cpu_sync_wait(void);
336extern void __printk_cpu_sync_put(void);
337
338#else
339
340#define __printk_cpu_sync_try_get() true
341#define __printk_cpu_sync_wait()
342#define __printk_cpu_sync_put()
343#endif /* CONFIG_SMP */
344
345/**
346 * printk_cpu_sync_get_irqsave() - Disable interrupts and acquire the printk
347 *                                 cpu-reentrant spinning lock.
348 * @flags: Stack-allocated storage for saving local interrupt state,
349 *         to be passed to printk_cpu_sync_put_irqrestore().
350 *
351 * If the lock is owned by another CPU, spin until it becomes available.
352 * Interrupts are restored while spinning.
353 *
354 * CAUTION: This function must be used carefully. It does not behave like a
355 * typical lock. Here are important things to watch out for...
356 *
357 *     * This function is reentrant on the same CPU. Therefore the calling
358 *       code must not assume exclusive access to data if code accessing the
359 *       data can run reentrant or within NMI context on the same CPU.
360 *
361 *     * If there exists usage of this function from NMI context, it becomes
362 *       unsafe to perform any type of locking or spinning to wait for other
363 *       CPUs after calling this function from any context. This includes
364 *       using spinlocks or any other busy-waiting synchronization methods.
365 */
366#define printk_cpu_sync_get_irqsave(flags)		\
367	for (;;) {					\
368		local_irq_save(flags);			\
369		if (__printk_cpu_sync_try_get())	\
370			break;				\
371		local_irq_restore(flags);		\
372		__printk_cpu_sync_wait();		\
373	}
374
375/**
376 * printk_cpu_sync_put_irqrestore() - Release the printk cpu-reentrant spinning
377 *                                    lock and restore interrupts.
378 * @flags: Caller's saved interrupt state, from printk_cpu_sync_get_irqsave().
379 */
380#define printk_cpu_sync_put_irqrestore(flags)	\
381	do {					\
382		__printk_cpu_sync_put();	\
383		local_irq_restore(flags);	\
384	} while (0)
385
386extern int kptr_restrict;
387
388/**
389 * pr_fmt - used by the pr_*() macros to generate the printk format string
390 * @fmt: format string passed from a pr_*() macro
391 *
392 * This macro can be used to generate a unified format string for pr_*()
393 * macros. A common use is to prefix all pr_*() messages in a file with a common
394 * string. For example, defining this at the top of a source file:
395 *
396 *        #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
397 *
398 * would prefix all pr_info, pr_emerg... messages in the file with the module
399 * name.
400 */
401#ifndef pr_fmt
402#define pr_fmt(fmt) fmt
403#endif
404
405struct module;
406
407#ifdef CONFIG_PRINTK_INDEX
408struct pi_entry {
409	const char *fmt;
410	const char *func;
411	const char *file;
412	unsigned int line;
413
414	/*
415	 * While printk and pr_* have the level stored in the string at compile
416	 * time, some subsystems dynamically add it at runtime through the
417	 * format string. For these dynamic cases, we allow the subsystem to
418	 * tell us the level at compile time.
419	 *
420	 * NULL indicates that the level, if any, is stored in fmt.
421	 */
422	const char *level;
423
424	/*
425	 * The format string used by various subsystem specific printk()
426	 * wrappers to prefix the message.
427	 *
428	 * Note that the static prefix defined by the pr_fmt() macro is stored
429	 * directly in the message format (@fmt), not here.
430	 */
431	const char *subsys_fmt_prefix;
432} __packed;
433
434#define __printk_index_emit(_fmt, _level, _subsys_fmt_prefix)		\
435	do {								\
436		if (__builtin_constant_p(_fmt) && __builtin_constant_p(_level)) { \
437			/*
438			 * We check __builtin_constant_p multiple times here
439			 * for the same input because GCC will produce an error
440			 * if we try to assign a static variable to fmt if it
441			 * is not a constant, even with the outer if statement.
442			 */						\
443			static const struct pi_entry _entry		\
444			__used = {					\
445				.fmt = __builtin_constant_p(_fmt) ? (_fmt) : NULL, \
446				.func = __func__,			\
447				.file = __FILE__,			\
448				.line = __LINE__,			\
449				.level = __builtin_constant_p(_level) ? (_level) : NULL, \
450				.subsys_fmt_prefix = _subsys_fmt_prefix,\
451			};						\
452			static const struct pi_entry *_entry_ptr	\
453			__used __section(".printk_index") = &_entry;	\
454		}							\
455	} while (0)
456
457#else /* !CONFIG_PRINTK_INDEX */
458#define __printk_index_emit(...) do {} while (0)
459#endif /* CONFIG_PRINTK_INDEX */
460
461/*
462 * Some subsystems have their own custom printk that applies a va_format to a
463 * generic format, for example, to include a device number or other metadata
464 * alongside the format supplied by the caller.
465 *
466 * In order to store these in the way they would be emitted by the printk
467 * infrastructure, the subsystem provides us with the start, fixed string, and
468 * any subsequent text in the format string.
469 *
470 * We take a variable argument list as pr_fmt/dev_fmt/etc are sometimes passed
471 * as multiple arguments (eg: `"%s: ", "blah"`), and we must only take the
472 * first one.
473 *
474 * subsys_fmt_prefix must be known at compile time, or compilation will fail
475 * (since this is a mistake). If fmt or level is not known at compile time, no
476 * index entry will be made (since this can legitimately happen).
477 */
478#define printk_index_subsys_emit(subsys_fmt_prefix, level, fmt, ...) \
479	__printk_index_emit(fmt, level, subsys_fmt_prefix)
480
481#define printk_index_wrap(_p_func, _fmt, ...)				\
482	({								\
483		__printk_index_emit(_fmt, NULL, NULL);			\
484		_p_func(_fmt, ##__VA_ARGS__);				\
485	})
486
487
488/**
489 * printk - print a kernel message
490 * @fmt: format string
491 *
492 * This is printk(). It can be called from any context. We want it to work.
493 *
494 * If printk indexing is enabled, _printk() is called from printk_index_wrap.
495 * Otherwise, printk is simply #defined to _printk.
496 *
497 * We try to grab the console_lock. If we succeed, it's easy - we log the
498 * output and call the console drivers.  If we fail to get the semaphore, we
499 * place the output into the log buffer and return. The current holder of
500 * the console_sem will notice the new output in console_unlock(); and will
501 * send it to the consoles before releasing the lock.
502 *
503 * One effect of this deferred printing is that code which calls printk() and
504 * then changes console_loglevel may break. This is because console_loglevel
505 * is inspected when the actual printing occurs.
506 *
507 * See also:
508 * printf(3)
509 *
510 * See the vsnprintf() documentation for format string extensions over C99.
511 */
512#define printk(fmt, ...) printk_index_wrap(_printk, fmt, ##__VA_ARGS__)
513#define printk_deferred(fmt, ...)					\
514	printk_index_wrap(_printk_deferred, fmt, ##__VA_ARGS__)
515
516/**
517 * pr_emerg - Print an emergency-level message
518 * @fmt: format string
519 * @...: arguments for the format string
520 *
521 * This macro expands to a printk with KERN_EMERG loglevel. It uses pr_fmt() to
522 * generate the format string.
523 */
524#define pr_emerg(fmt, ...) \
525	printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
526/**
527 * pr_alert - Print an alert-level message
528 * @fmt: format string
529 * @...: arguments for the format string
530 *
531 * This macro expands to a printk with KERN_ALERT loglevel. It uses pr_fmt() to
532 * generate the format string.
533 */
534#define pr_alert(fmt, ...) \
535	printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
536/**
537 * pr_crit - Print a critical-level message
538 * @fmt: format string
539 * @...: arguments for the format string
540 *
541 * This macro expands to a printk with KERN_CRIT loglevel. It uses pr_fmt() to
542 * generate the format string.
543 */
544#define pr_crit(fmt, ...) \
545	printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
546/**
547 * pr_err - Print an error-level message
548 * @fmt: format string
549 * @...: arguments for the format string
550 *
551 * This macro expands to a printk with KERN_ERR loglevel. It uses pr_fmt() to
552 * generate the format string.
553 */
554#define pr_err(fmt, ...) \
555	printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
556/**
557 * pr_warn - Print a warning-level message
558 * @fmt: format string
559 * @...: arguments for the format string
560 *
561 * This macro expands to a printk with KERN_WARNING loglevel. It uses pr_fmt()
562 * to generate the format string.
563 */
564#define pr_warn(fmt, ...) \
565	printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
566/**
567 * pr_notice - Print a notice-level message
568 * @fmt: format string
569 * @...: arguments for the format string
570 *
571 * This macro expands to a printk with KERN_NOTICE loglevel. It uses pr_fmt() to
572 * generate the format string.
573 */
574#define pr_notice(fmt, ...) \
575	printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
576/**
577 * pr_info - Print an info-level message
578 * @fmt: format string
579 * @...: arguments for the format string
580 *
581 * This macro expands to a printk with KERN_INFO loglevel. It uses pr_fmt() to
582 * generate the format string.
583 */
584#define pr_info(fmt, ...) \
585	printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
586
587/**
588 * pr_cont - Continues a previous log message in the same line.
589 * @fmt: format string
590 * @...: arguments for the format string
591 *
592 * This macro expands to a printk with KERN_CONT loglevel. It should only be
593 * used when continuing a log message with no newline ('\n') enclosed. Otherwise
594 * it defaults back to KERN_DEFAULT loglevel.
595 */
596#define pr_cont(fmt, ...) \
597	printk(KERN_CONT fmt, ##__VA_ARGS__)
598
599/**
600 * pr_devel - Print a debug-level message conditionally
601 * @fmt: format string
602 * @...: arguments for the format string
603 *
604 * This macro expands to a printk with KERN_DEBUG loglevel if DEBUG is
605 * defined. Otherwise it does nothing.
606 *
607 * It uses pr_fmt() to generate the format string.
608 */
609#ifdef DEBUG
610#define pr_devel(fmt, ...) \
611	printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
612#else
613#define pr_devel(fmt, ...) \
614	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
615#endif
616
617
618/* If you are writing a driver, please use dev_dbg instead */
619#if defined(CONFIG_DYNAMIC_DEBUG) || \
620	(defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
621#include <linux/dynamic_debug.h>
622
623/**
624 * pr_debug - Print a debug-level message conditionally
625 * @fmt: format string
626 * @...: arguments for the format string
627 *
628 * This macro expands to dynamic_pr_debug() if CONFIG_DYNAMIC_DEBUG is
629 * set. Otherwise, if DEBUG is defined, it's equivalent to a printk with
630 * KERN_DEBUG loglevel. If DEBUG is not defined it does nothing.
631 *
632 * It uses pr_fmt() to generate the format string (dynamic_pr_debug() uses
633 * pr_fmt() internally).
634 */
635#define pr_debug(fmt, ...)			\
636	dynamic_pr_debug(fmt, ##__VA_ARGS__)
637#elif defined(DEBUG)
638#define pr_debug(fmt, ...) \
639	printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
640#else
641#define pr_debug(fmt, ...) \
642	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
643#endif
644
645/*
646 * Print a one-time message (analogous to WARN_ONCE() et al):
647 */
648
649#ifdef CONFIG_PRINTK
650#define printk_once(fmt, ...)					\
651	DO_ONCE_LITE(printk, fmt, ##__VA_ARGS__)
652#define printk_deferred_once(fmt, ...)				\
653	DO_ONCE_LITE(printk_deferred, fmt, ##__VA_ARGS__)
654#else
655#define printk_once(fmt, ...)					\
656	no_printk(fmt, ##__VA_ARGS__)
657#define printk_deferred_once(fmt, ...)				\
658	no_printk(fmt, ##__VA_ARGS__)
659#endif
660
661#define pr_emerg_once(fmt, ...)					\
662	printk_once(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
663#define pr_alert_once(fmt, ...)					\
664	printk_once(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
665#define pr_crit_once(fmt, ...)					\
666	printk_once(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
667#define pr_err_once(fmt, ...)					\
668	printk_once(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
669#define pr_warn_once(fmt, ...)					\
670	printk_once(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
671#define pr_notice_once(fmt, ...)				\
672	printk_once(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
673#define pr_info_once(fmt, ...)					\
674	printk_once(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
675/* no pr_cont_once, don't do that... */
676
677#if defined(DEBUG)
678#define pr_devel_once(fmt, ...)					\
679	printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
680#else
681#define pr_devel_once(fmt, ...)					\
682	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
683#endif
684
685/* If you are writing a driver, please use dev_dbg instead */
686#if defined(DEBUG)
687#define pr_debug_once(fmt, ...)					\
688	printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
689#else
690#define pr_debug_once(fmt, ...)					\
691	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
692#endif
693
694/*
695 * ratelimited messages with local ratelimit_state,
696 * no local ratelimit_state used in the !PRINTK case
697 */
698#ifdef CONFIG_PRINTK
699#define printk_ratelimited(fmt, ...)					\
700({									\
701	static DEFINE_RATELIMIT_STATE(_rs,				\
702				      DEFAULT_RATELIMIT_INTERVAL,	\
703				      DEFAULT_RATELIMIT_BURST);		\
704									\
705	if (__ratelimit(&_rs))						\
706		printk(fmt, ##__VA_ARGS__);				\
707})
708#else
709#define printk_ratelimited(fmt, ...)					\
710	no_printk(fmt, ##__VA_ARGS__)
711#endif
712
713#define pr_emerg_ratelimited(fmt, ...)					\
714	printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
715#define pr_alert_ratelimited(fmt, ...)					\
716	printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
717#define pr_crit_ratelimited(fmt, ...)					\
718	printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
719#define pr_err_ratelimited(fmt, ...)					\
720	printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
721#define pr_warn_ratelimited(fmt, ...)					\
722	printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
723#define pr_notice_ratelimited(fmt, ...)					\
724	printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
725#define pr_info_ratelimited(fmt, ...)					\
726	printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
727/* no pr_cont_ratelimited, don't do that... */
728
729#if defined(DEBUG)
730#define pr_devel_ratelimited(fmt, ...)					\
731	printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
732#else
733#define pr_devel_ratelimited(fmt, ...)					\
734	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
735#endif
736
737/* If you are writing a driver, please use dev_dbg instead */
738#if defined(CONFIG_DYNAMIC_DEBUG) || \
739	(defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
740/* descriptor check is first to prevent flooding with "callbacks suppressed" */
741#define pr_debug_ratelimited(fmt, ...)					\
742do {									\
743	static DEFINE_RATELIMIT_STATE(_rs,				\
744				      DEFAULT_RATELIMIT_INTERVAL,	\
745				      DEFAULT_RATELIMIT_BURST);		\
746	DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, pr_fmt(fmt));		\
747	if (DYNAMIC_DEBUG_BRANCH(descriptor) &&				\
748	    __ratelimit(&_rs))						\
749		__dynamic_pr_debug(&descriptor, pr_fmt(fmt), ##__VA_ARGS__);	\
750} while (0)
751#elif defined(DEBUG)
752#define pr_debug_ratelimited(fmt, ...)					\
753	printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
754#else
755#define pr_debug_ratelimited(fmt, ...) \
756	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
757#endif
758
759extern const struct file_operations kmsg_fops;
760
761enum {
762	DUMP_PREFIX_NONE,
763	DUMP_PREFIX_ADDRESS,
764	DUMP_PREFIX_OFFSET
765};
766extern int hex_dump_to_buffer(const void *buf, size_t len, int rowsize,
767			      int groupsize, char *linebuf, size_t linebuflen,
768			      bool ascii);
769#ifdef CONFIG_PRINTK
770extern void print_hex_dump(const char *level, const char *prefix_str,
771			   int prefix_type, int rowsize, int groupsize,
772			   const void *buf, size_t len, bool ascii);
773#else
774static inline void print_hex_dump(const char *level, const char *prefix_str,
775				  int prefix_type, int rowsize, int groupsize,
776				  const void *buf, size_t len, bool ascii)
777{
778}
779static inline void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
780					const void *buf, size_t len)
781{
782}
783
784#endif
785
786#if defined(CONFIG_DYNAMIC_DEBUG) || \
787	(defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
788#define print_hex_dump_debug(prefix_str, prefix_type, rowsize,	\
789			     groupsize, buf, len, ascii)	\
790	dynamic_hex_dump(prefix_str, prefix_type, rowsize,	\
791			 groupsize, buf, len, ascii)
792#elif defined(DEBUG)
793#define print_hex_dump_debug(prefix_str, prefix_type, rowsize,		\
794			     groupsize, buf, len, ascii)		\
795	print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, rowsize,	\
796		       groupsize, buf, len, ascii)
797#else
798static inline void print_hex_dump_debug(const char *prefix_str, int prefix_type,
799					int rowsize, int groupsize,
800					const void *buf, size_t len, bool ascii)
801{
802}
803#endif
804
805/**
806 * print_hex_dump_bytes - shorthand form of print_hex_dump() with default params
807 * @prefix_str: string to prefix each line with;
808 *  caller supplies trailing spaces for alignment if desired
809 * @prefix_type: controls whether prefix of an offset, address, or none
810 *  is printed (%DUMP_PREFIX_OFFSET, %DUMP_PREFIX_ADDRESS, %DUMP_PREFIX_NONE)
811 * @buf: data blob to dump
812 * @len: number of bytes in the @buf
813 *
814 * Calls print_hex_dump(), with log level of KERN_DEBUG,
815 * rowsize of 16, groupsize of 1, and ASCII output included.
816 */
817#define print_hex_dump_bytes(prefix_str, prefix_type, buf, len)	\
818	print_hex_dump_debug(prefix_str, prefix_type, 16, 1, buf, len, true)
819
820#endif