1
2#ifndef __KERNEL_PRINTK__
3#define __KERNEL_PRINTK__
4
5#include <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
13extern const char linux_banner[];
14extern const char linux_proc_banner[];
15
16extern int oops_in_progress;
17
18#define PRINTK_MAX_SINGLE_HEADER_LEN 2
19
20static 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':
26 return buffer[1];
27 }
28 }
29 return 0;
30}
31
32static 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
40static 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
51#define MESSAGE_LOGLEVEL_DEFAULT CONFIG_MESSAGE_LOGLEVEL_DEFAULT
52
53
54#define CONSOLE_LOGLEVEL_SILENT 0
55#define CONSOLE_LOGLEVEL_MIN 1
56#define CONSOLE_LOGLEVEL_DEBUG 10
57#define CONSOLE_LOGLEVEL_MOTORMOUTH 15
58
59
60
61
62
63#define CONSOLE_LOGLEVEL_DEFAULT CONFIG_CONSOLE_LOGLEVEL_DEFAULT
64#define CONSOLE_LOGLEVEL_QUIET CONFIG_CONSOLE_LOGLEVEL_QUIET
65
66extern 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
73static inline void console_silent(void)
74{
75 console_loglevel = CONSOLE_LOGLEVEL_SILENT;
76}
77
78static inline void console_verbose(void)
79{
80 if (console_loglevel)
81 console_loglevel = CONSOLE_LOGLEVEL_MOTORMOUTH;
82}
83
84
85#define DEVKMSG_STR_MAX_SIZE 10
86extern char devkmsg_log_str[];
87struct ctl_table;
88
89extern int suppress_printk;
90
91struct va_format {
92 const char *fmt;
93 va_list *va;
94};
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116#define FW_BUG "[Firmware Bug]: "
117#define FW_WARN "[Firmware Warn]: "
118#define FW_INFO "[Firmware Info]: "
119
120
121
122
123
124
125#define HW_ERR "[Hardware Error]: "
126
127
128
129
130
131
132#define DEPRECATED "[Deprecated]: "
133
134
135
136
137
138#define no_printk(fmt, ...) \
139({ \
140 if (0) \
141 printk(fmt, ##__VA_ARGS__); \
142 0; \
143})
144
145#ifdef CONFIG_EARLY_PRINTK
146extern asmlinkage __printf(1, 2)
147void early_printk(const char *fmt, ...);
148#else
149static inline __printf(1, 2) __cold
150void early_printk(const char *s, ...) { }
151#endif
152
153#ifdef CONFIG_PRINTK_NMI
154extern void printk_nmi_enter(void);
155extern void printk_nmi_exit(void);
156extern void printk_nmi_direct_enter(void);
157extern void printk_nmi_direct_exit(void);
158#else
159static inline void printk_nmi_enter(void) { }
160static inline void printk_nmi_exit(void) { }
161static inline void printk_nmi_direct_enter(void) { }
162static inline void printk_nmi_direct_exit(void) { }
163#endif
164
165struct dev_printk_info;
166
167#ifdef CONFIG_PRINTK
168asmlinkage __printf(4, 0)
169int vprintk_emit(int facility, int level,
170 const struct dev_printk_info *dev_info,
171 const char *fmt, va_list args);
172
173asmlinkage __printf(1, 0)
174int vprintk(const char *fmt, va_list args);
175
176asmlinkage __printf(1, 2) __cold
177int printk(const char *fmt, ...);
178
179
180
181
182__printf(1, 2) __cold int printk_deferred(const char *fmt, ...);
183
184
185
186
187
188
189extern int __printk_ratelimit(const char *func);
190#define printk_ratelimit() __printk_ratelimit(__func__)
191extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
192 unsigned int interval_msec);
193
194extern int printk_delay_msec;
195extern int dmesg_restrict;
196
197extern int
198devkmsg_sysctl_set_loglvl(struct ctl_table *table, int write, void *buf,
199 size_t *lenp, loff_t *ppos);
200
201extern void wake_up_klogd(void);
202
203char *log_buf_addr_get(void);
204u32 log_buf_len_get(void);
205void log_buf_vmcoreinfo_setup(void);
206void __init setup_log_buf(int early);
207__printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...);
208void dump_stack_print_info(const char *log_lvl);
209void show_regs_print_info(const char *log_lvl);
210extern asmlinkage void dump_stack_lvl(const char *log_lvl) __cold;
211extern asmlinkage void dump_stack(void) __cold;
212extern void printk_safe_flush(void);
213extern void printk_safe_flush_on_panic(void);
214#else
215static inline __printf(1, 0)
216int vprintk(const char *s, va_list args)
217{
218 return 0;
219}
220static inline __printf(1, 2) __cold
221int printk(const char *s, ...)
222{
223 return 0;
224}
225static inline __printf(1, 2) __cold
226int printk_deferred(const char *s, ...)
227{
228 return 0;
229}
230static inline int printk_ratelimit(void)
231{
232 return 0;
233}
234static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies,
235 unsigned int interval_msec)
236{
237 return false;
238}
239
240static inline void wake_up_klogd(void)
241{
242}
243
244static inline char *log_buf_addr_get(void)
245{
246 return NULL;
247}
248
249static inline u32 log_buf_len_get(void)
250{
251 return 0;
252}
253
254static inline void log_buf_vmcoreinfo_setup(void)
255{
256}
257
258static inline void setup_log_buf(int early)
259{
260}
261
262static inline __printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...)
263{
264}
265
266static inline void dump_stack_print_info(const char *log_lvl)
267{
268}
269
270static inline void show_regs_print_info(const char *log_lvl)
271{
272}
273
274static inline void dump_stack_lvl(const char *log_lvl)
275{
276}
277
278static inline void dump_stack(void)
279{
280}
281
282static inline void printk_safe_flush(void)
283{
284}
285
286static inline void printk_safe_flush_on_panic(void)
287{
288}
289#endif
290
291#ifdef CONFIG_SMP
292extern int __printk_cpu_trylock(void);
293extern void __printk_wait_on_cpu_lock(void);
294extern void __printk_cpu_unlock(void);
295
296
297
298
299
300
301
302
303
304
305#define printk_cpu_lock_irqsave(flags) \
306 for (;;) { \
307 local_irq_save(flags); \
308 if (__printk_cpu_trylock()) \
309 break; \
310 local_irq_restore(flags); \
311 __printk_wait_on_cpu_lock(); \
312 }
313
314
315
316
317
318
319#define printk_cpu_unlock_irqrestore(flags) \
320 do { \
321 __printk_cpu_unlock(); \
322 local_irq_restore(flags); \
323 } while (0) \
324
325#else
326
327#define printk_cpu_lock_irqsave(flags) ((void)flags)
328#define printk_cpu_unlock_irqrestore(flags) ((void)flags)
329
330#endif
331
332extern int kptr_restrict;
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347#ifndef pr_fmt
348#define pr_fmt(fmt) fmt
349#endif
350
351
352
353
354
355
356
357
358
359#define pr_emerg(fmt, ...) \
360 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
361
362
363
364
365
366
367
368
369#define pr_alert(fmt, ...) \
370 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
371
372
373
374
375
376
377
378
379#define pr_crit(fmt, ...) \
380 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
381
382
383
384
385
386
387
388
389#define pr_err(fmt, ...) \
390 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
391
392
393
394
395
396
397
398
399#define pr_warn(fmt, ...) \
400 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
401
402
403
404
405
406
407
408
409#define pr_notice(fmt, ...) \
410 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
411
412
413
414
415
416
417
418
419#define pr_info(fmt, ...) \
420 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
421
422
423
424
425
426
427
428
429
430
431#define pr_cont(fmt, ...) \
432 printk(KERN_CONT fmt, ##__VA_ARGS__)
433
434
435
436
437
438
439
440
441
442
443
444#ifdef DEBUG
445#define pr_devel(fmt, ...) \
446 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
447#else
448#define pr_devel(fmt, ...) \
449 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
450#endif
451
452
453
454#if defined(CONFIG_DYNAMIC_DEBUG) || \
455 (defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
456#include <linux/dynamic_debug.h>
457
458
459
460
461
462
463
464
465
466
467
468
469
470#define pr_debug(fmt, ...) \
471 dynamic_pr_debug(fmt, ##__VA_ARGS__)
472#elif defined(DEBUG)
473#define pr_debug(fmt, ...) \
474 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
475#else
476#define pr_debug(fmt, ...) \
477 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
478#endif
479
480
481
482
483
484#ifdef CONFIG_PRINTK
485#define printk_once(fmt, ...) \
486 DO_ONCE_LITE(printk, fmt, ##__VA_ARGS__)
487#define printk_deferred_once(fmt, ...) \
488 DO_ONCE_LITE(printk_deferred, fmt, ##__VA_ARGS__)
489#else
490#define printk_once(fmt, ...) \
491 no_printk(fmt, ##__VA_ARGS__)
492#define printk_deferred_once(fmt, ...) \
493 no_printk(fmt, ##__VA_ARGS__)
494#endif
495
496#define pr_emerg_once(fmt, ...) \
497 printk_once(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
498#define pr_alert_once(fmt, ...) \
499 printk_once(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
500#define pr_crit_once(fmt, ...) \
501 printk_once(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
502#define pr_err_once(fmt, ...) \
503 printk_once(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
504#define pr_warn_once(fmt, ...) \
505 printk_once(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
506#define pr_notice_once(fmt, ...) \
507 printk_once(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
508#define pr_info_once(fmt, ...) \
509 printk_once(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
510
511
512#if defined(DEBUG)
513#define pr_devel_once(fmt, ...) \
514 printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
515#else
516#define pr_devel_once(fmt, ...) \
517 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
518#endif
519
520
521#if defined(DEBUG)
522#define pr_debug_once(fmt, ...) \
523 printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
524#else
525#define pr_debug_once(fmt, ...) \
526 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
527#endif
528
529
530
531
532
533#ifdef CONFIG_PRINTK
534#define printk_ratelimited(fmt, ...) \
535({ \
536 static DEFINE_RATELIMIT_STATE(_rs, \
537 DEFAULT_RATELIMIT_INTERVAL, \
538 DEFAULT_RATELIMIT_BURST); \
539 \
540 if (__ratelimit(&_rs)) \
541 printk(fmt, ##__VA_ARGS__); \
542})
543#else
544#define printk_ratelimited(fmt, ...) \
545 no_printk(fmt, ##__VA_ARGS__)
546#endif
547
548#define pr_emerg_ratelimited(fmt, ...) \
549 printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
550#define pr_alert_ratelimited(fmt, ...) \
551 printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
552#define pr_crit_ratelimited(fmt, ...) \
553 printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
554#define pr_err_ratelimited(fmt, ...) \
555 printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
556#define pr_warn_ratelimited(fmt, ...) \
557 printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
558#define pr_notice_ratelimited(fmt, ...) \
559 printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
560#define pr_info_ratelimited(fmt, ...) \
561 printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
562
563
564#if defined(DEBUG)
565#define pr_devel_ratelimited(fmt, ...) \
566 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
567#else
568#define pr_devel_ratelimited(fmt, ...) \
569 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
570#endif
571
572
573#if defined(CONFIG_DYNAMIC_DEBUG) || \
574 (defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
575
576#define pr_debug_ratelimited(fmt, ...) \
577do { \
578 static DEFINE_RATELIMIT_STATE(_rs, \
579 DEFAULT_RATELIMIT_INTERVAL, \
580 DEFAULT_RATELIMIT_BURST); \
581 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, pr_fmt(fmt)); \
582 if (DYNAMIC_DEBUG_BRANCH(descriptor) && \
583 __ratelimit(&_rs)) \
584 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), ##__VA_ARGS__); \
585} while (0)
586#elif defined(DEBUG)
587#define pr_debug_ratelimited(fmt, ...) \
588 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
589#else
590#define pr_debug_ratelimited(fmt, ...) \
591 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
592#endif
593
594extern const struct file_operations kmsg_fops;
595
596enum {
597 DUMP_PREFIX_NONE,
598 DUMP_PREFIX_ADDRESS,
599 DUMP_PREFIX_OFFSET
600};
601extern int hex_dump_to_buffer(const void *buf, size_t len, int rowsize,
602 int groupsize, char *linebuf, size_t linebuflen,
603 bool ascii);
604#ifdef CONFIG_PRINTK
605extern void print_hex_dump(const char *level, const char *prefix_str,
606 int prefix_type, int rowsize, int groupsize,
607 const void *buf, size_t len, bool ascii);
608#else
609static inline void print_hex_dump(const char *level, const char *prefix_str,
610 int prefix_type, int rowsize, int groupsize,
611 const void *buf, size_t len, bool ascii)
612{
613}
614static inline void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
615 const void *buf, size_t len)
616{
617}
618
619#endif
620
621#if defined(CONFIG_DYNAMIC_DEBUG) || \
622 (defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
623#define print_hex_dump_debug(prefix_str, prefix_type, rowsize, \
624 groupsize, buf, len, ascii) \
625 dynamic_hex_dump(prefix_str, prefix_type, rowsize, \
626 groupsize, buf, len, ascii)
627#elif defined(DEBUG)
628#define print_hex_dump_debug(prefix_str, prefix_type, rowsize, \
629 groupsize, buf, len, ascii) \
630 print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, rowsize, \
631 groupsize, buf, len, ascii)
632#else
633static inline void print_hex_dump_debug(const char *prefix_str, int prefix_type,
634 int rowsize, int groupsize,
635 const void *buf, size_t len, bool ascii)
636{
637}
638#endif
639
640
641
642
643
644
645
646
647
648
649
650
651
652#define print_hex_dump_bytes(prefix_str, prefix_type, buf, len) \
653 print_hex_dump_debug(prefix_str, prefix_type, 16, 1, buf, len, true)
654
655#endif
656