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