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