1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __KERNEL_PRINTK__
3 #define __KERNEL_PRINTK__
6 #include <linux/init.h>
7 #include <linux/kern_levels.h>
8 #include <linux/linkage.h>
9 #include <linux/cache.h>
11 extern const char linux_banner[];
12 extern const char linux_proc_banner[];
14 #define PRINTK_MAX_SINGLE_HEADER_LEN 2
16 static inline int printk_get_level(const char *buffer)
18 if (buffer[0] == KERN_SOH_ASCII && buffer[1]) {
21 case 'c': /* KERN_CONT */
28 static inline const char *printk_skip_level(const char *buffer)
30 if (printk_get_level(buffer))
36 static inline const char *printk_skip_headers(const char *buffer)
38 while (printk_get_level(buffer))
39 buffer = printk_skip_level(buffer);
44 #define CONSOLE_EXT_LOG_MAX 8192
46 /* printk's without a loglevel use this.. */
47 #define MESSAGE_LOGLEVEL_DEFAULT CONFIG_MESSAGE_LOGLEVEL_DEFAULT
49 /* We show everything that is MORE important than this.. */
50 #define CONSOLE_LOGLEVEL_SILENT 0 /* Mum's the word */
51 #define CONSOLE_LOGLEVEL_MIN 1 /* Minimum loglevel we let people use */
52 #define CONSOLE_LOGLEVEL_DEBUG 10 /* issue debug messages */
53 #define CONSOLE_LOGLEVEL_MOTORMOUTH 15 /* You can't shut this one up */
56 * Default used to be hard-coded at 7, quiet used to be hardcoded at 4,
57 * we're now allowing both to be set from kernel config.
59 #define CONSOLE_LOGLEVEL_DEFAULT CONFIG_CONSOLE_LOGLEVEL_DEFAULT
60 #define CONSOLE_LOGLEVEL_QUIET CONFIG_CONSOLE_LOGLEVEL_QUIET
62 extern int console_printk[];
64 #define console_loglevel (console_printk[0])
65 #define default_message_loglevel (console_printk[1])
66 #define minimum_console_loglevel (console_printk[2])
67 #define default_console_loglevel (console_printk[3])
69 static inline void console_silent(void)
71 console_loglevel = CONSOLE_LOGLEVEL_SILENT;
74 static inline void console_verbose(void)
77 console_loglevel = CONSOLE_LOGLEVEL_MOTORMOUTH;
80 /* strlen("ratelimit") + 1 */
81 #define DEVKMSG_STR_MAX_SIZE 10
82 extern char devkmsg_log_str[];
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
98 * Use it for definite and high priority BIOS bugs.
101 * Use it for not that clear (e.g. could the kernel messed up things already?)
102 * and medium priority BIOS bugs.
105 * Use this one if you want to tell the user or vendor about something
106 * suspicious, but generally harmless related to the firmware.
108 * Use it for information or very low priority BIOS bugs.
110 #define FW_BUG "[Firmware Bug]: "
111 #define FW_WARN "[Firmware Warn]: "
112 #define FW_INFO "[Firmware Info]: "
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.
119 #define HW_ERR "[Hardware Error]: "
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
126 #define DEPRECATED "[Deprecated]: "
129 * Dummy printk for disabled debugging statements to use whilst maintaining
130 * gcc's format checking.
132 #define no_printk(fmt, ...) \
135 printk(fmt, ##__VA_ARGS__); \
139 #ifdef CONFIG_EARLY_PRINTK
140 extern asmlinkage __printf(1, 2)
141 void early_printk(const char *fmt, ...);
143 static inline __printf(1, 2) __cold
144 void early_printk(const char *s, ...) { }
147 #ifdef CONFIG_PRINTK_NMI
148 extern void printk_nmi_enter(void);
149 extern void printk_nmi_exit(void);
150 extern void printk_nmi_direct_enter(void);
151 extern void printk_nmi_direct_exit(void);
153 static inline void printk_nmi_enter(void) { }
154 static inline void printk_nmi_exit(void) { }
155 static inline void printk_nmi_direct_enter(void) { }
156 static inline void printk_nmi_direct_exit(void) { }
157 #endif /* PRINTK_NMI */
160 asmlinkage __printf(5, 0)
161 int vprintk_emit(int facility, int level,
162 const char *dict, size_t dictlen,
163 const char *fmt, va_list args);
165 asmlinkage __printf(1, 0)
166 int vprintk(const char *fmt, va_list args);
168 asmlinkage __printf(1, 2) __cold
169 int printk(const char *fmt, ...);
172 * Special printk facility for scheduler/timekeeping use only, _DO_NOT_USE_ !
174 __printf(1, 2) __cold int printk_deferred(const char *fmt, ...);
177 * Please don't use printk_ratelimit(), because it shares ratelimiting state
178 * with all other unrelated printk_ratelimit() callsites. Instead use
179 * printk_ratelimited() or plain old __ratelimit().
181 extern int __printk_ratelimit(const char *func);
182 #define printk_ratelimit() __printk_ratelimit(__func__)
183 extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
184 unsigned int interval_msec);
186 extern int printk_delay_msec;
187 extern int dmesg_restrict;
190 devkmsg_sysctl_set_loglvl(struct ctl_table *table, int write, void __user *buf,
191 size_t *lenp, loff_t *ppos);
193 extern void wake_up_klogd(void);
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(void) __cold;
203 extern void printk_safe_init(void);
204 extern void printk_safe_flush(void);
205 extern void printk_safe_flush_on_panic(void);
207 static inline __printf(1, 0)
208 int vprintk(const char *s, va_list args)
212 static inline __printf(1, 2) __cold
213 int printk(const char *s, ...)
217 static inline __printf(1, 2) __cold
218 int printk_deferred(const char *s, ...)
222 static inline int printk_ratelimit(void)
226 static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies,
227 unsigned int interval_msec)
232 static inline void wake_up_klogd(void)
236 static inline char *log_buf_addr_get(void)
241 static inline u32 log_buf_len_get(void)
246 static inline void log_buf_vmcoreinfo_setup(void)
250 static inline void setup_log_buf(int early)
254 static inline __printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...)
258 static inline void dump_stack_print_info(const char *log_lvl)
262 static inline void show_regs_print_info(const char *log_lvl)
266 static inline void dump_stack(void)
270 static inline void printk_safe_init(void)
274 static inline void printk_safe_flush(void)
278 static inline void printk_safe_flush_on_panic(void)
283 extern int kptr_restrict;
286 #define pr_fmt(fmt) fmt
290 * These can be used to print at the various log levels.
291 * All of these will print unconditionally, although note that pr_debug()
292 * and other debug macros are compiled out unless either DEBUG is defined
293 * or CONFIG_DYNAMIC_DEBUG is set.
295 #define pr_emerg(fmt, ...) \
296 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
297 #define pr_alert(fmt, ...) \
298 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
299 #define pr_crit(fmt, ...) \
300 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
301 #define pr_err(fmt, ...) \
302 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
303 #define pr_warning(fmt, ...) \
304 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
305 #define pr_warn pr_warning
306 #define pr_notice(fmt, ...) \
307 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
308 #define pr_info(fmt, ...) \
309 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
311 * Like KERN_CONT, pr_cont() should only be used when continuing
312 * a line with no newline ('\n') enclosed. Otherwise it defaults
313 * back to KERN_DEFAULT.
315 #define pr_cont(fmt, ...) \
316 printk(KERN_CONT fmt, ##__VA_ARGS__)
318 /* pr_devel() should produce zero code unless DEBUG is defined */
320 #define pr_devel(fmt, ...) \
321 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
323 #define pr_devel(fmt, ...) \
324 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
328 /* If you are writing a driver, please use dev_dbg instead */
329 #if defined(CONFIG_DYNAMIC_DEBUG)
330 #include <linux/dynamic_debug.h>
332 /* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
333 #define pr_debug(fmt, ...) \
334 dynamic_pr_debug(fmt, ##__VA_ARGS__)
336 #define pr_debug(fmt, ...) \
337 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
339 #define pr_debug(fmt, ...) \
340 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
344 * Print a one-time message (analogous to WARN_ONCE() et al):
348 #define printk_once(fmt, ...) \
350 static bool __print_once __read_mostly; \
351 bool __ret_print_once = !__print_once; \
353 if (!__print_once) { \
354 __print_once = true; \
355 printk(fmt, ##__VA_ARGS__); \
357 unlikely(__ret_print_once); \
359 #define printk_deferred_once(fmt, ...) \
361 static bool __print_once __read_mostly; \
362 bool __ret_print_once = !__print_once; \
364 if (!__print_once) { \
365 __print_once = true; \
366 printk_deferred(fmt, ##__VA_ARGS__); \
368 unlikely(__ret_print_once); \
371 #define printk_once(fmt, ...) \
372 no_printk(fmt, ##__VA_ARGS__)
373 #define printk_deferred_once(fmt, ...) \
374 no_printk(fmt, ##__VA_ARGS__)
377 #define pr_emerg_once(fmt, ...) \
378 printk_once(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
379 #define pr_alert_once(fmt, ...) \
380 printk_once(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
381 #define pr_crit_once(fmt, ...) \
382 printk_once(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
383 #define pr_err_once(fmt, ...) \
384 printk_once(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
385 #define pr_warn_once(fmt, ...) \
386 printk_once(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
387 #define pr_notice_once(fmt, ...) \
388 printk_once(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
389 #define pr_info_once(fmt, ...) \
390 printk_once(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
391 #define pr_cont_once(fmt, ...) \
392 printk_once(KERN_CONT pr_fmt(fmt), ##__VA_ARGS__)
395 #define pr_devel_once(fmt, ...) \
396 printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
398 #define pr_devel_once(fmt, ...) \
399 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
402 /* If you are writing a driver, please use dev_dbg instead */
404 #define pr_debug_once(fmt, ...) \
405 printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
407 #define pr_debug_once(fmt, ...) \
408 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
412 * ratelimited messages with local ratelimit_state,
413 * no local ratelimit_state used in the !PRINTK case
416 #define printk_ratelimited(fmt, ...) \
418 static DEFINE_RATELIMIT_STATE(_rs, \
419 DEFAULT_RATELIMIT_INTERVAL, \
420 DEFAULT_RATELIMIT_BURST); \
422 if (__ratelimit(&_rs)) \
423 printk(fmt, ##__VA_ARGS__); \
426 #define printk_ratelimited(fmt, ...) \
427 no_printk(fmt, ##__VA_ARGS__)
430 #define pr_emerg_ratelimited(fmt, ...) \
431 printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
432 #define pr_alert_ratelimited(fmt, ...) \
433 printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
434 #define pr_crit_ratelimited(fmt, ...) \
435 printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
436 #define pr_err_ratelimited(fmt, ...) \
437 printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
438 #define pr_warn_ratelimited(fmt, ...) \
439 printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
440 #define pr_notice_ratelimited(fmt, ...) \
441 printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
442 #define pr_info_ratelimited(fmt, ...) \
443 printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
444 /* no pr_cont_ratelimited, don't do that... */
447 #define pr_devel_ratelimited(fmt, ...) \
448 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
450 #define pr_devel_ratelimited(fmt, ...) \
451 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
454 /* If you are writing a driver, please use dev_dbg instead */
455 #if defined(CONFIG_DYNAMIC_DEBUG)
456 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
457 #define pr_debug_ratelimited(fmt, ...) \
459 static DEFINE_RATELIMIT_STATE(_rs, \
460 DEFAULT_RATELIMIT_INTERVAL, \
461 DEFAULT_RATELIMIT_BURST); \
462 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, pr_fmt(fmt)); \
463 if (DYNAMIC_DEBUG_BRANCH(descriptor) && \
465 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), ##__VA_ARGS__); \
468 #define pr_debug_ratelimited(fmt, ...) \
469 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
471 #define pr_debug_ratelimited(fmt, ...) \
472 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
475 extern const struct file_operations kmsg_fops;
482 extern int hex_dump_to_buffer(const void *buf, size_t len, int rowsize,
483 int groupsize, char *linebuf, size_t linebuflen,
486 extern void print_hex_dump(const char *level, const char *prefix_str,
487 int prefix_type, int rowsize, int groupsize,
488 const void *buf, size_t len, bool ascii);
489 #if defined(CONFIG_DYNAMIC_DEBUG)
490 #define print_hex_dump_bytes(prefix_str, prefix_type, buf, len) \
491 dynamic_hex_dump(prefix_str, prefix_type, 16, 1, buf, len, true)
493 extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
494 const void *buf, size_t len);
495 #endif /* defined(CONFIG_DYNAMIC_DEBUG) */
497 static inline void print_hex_dump(const char *level, const char *prefix_str,
498 int prefix_type, int rowsize, int groupsize,
499 const void *buf, size_t len, bool ascii)
502 static inline void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
503 const void *buf, size_t len)
509 #if defined(CONFIG_DYNAMIC_DEBUG)
510 #define print_hex_dump_debug(prefix_str, prefix_type, rowsize, \
511 groupsize, buf, len, ascii) \
512 dynamic_hex_dump(prefix_str, prefix_type, rowsize, \
513 groupsize, buf, len, ascii)
515 #define print_hex_dump_debug(prefix_str, prefix_type, rowsize, \
516 groupsize, buf, len, ascii) \
517 print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, rowsize, \
518 groupsize, buf, len, ascii)
520 static inline void print_hex_dump_debug(const char *prefix_str, int prefix_type,
521 int rowsize, int groupsize,
522 const void *buf, size_t len, bool ascii)