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