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 __user *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#ifndef pr_fmt
283#define pr_fmt(fmt) fmt
284#endif
285
286
287
288
289
290
291
292#define pr_emerg(fmt, ...) \
293 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
294#define pr_alert(fmt, ...) \
295 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
296#define pr_crit(fmt, ...) \
297 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
298#define pr_err(fmt, ...) \
299 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
300#define pr_warning(fmt, ...) \
301 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
302#define pr_warn pr_warning
303#define pr_notice(fmt, ...) \
304 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
305#define pr_info(fmt, ...) \
306 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
307
308
309
310
311
312#define pr_cont(fmt, ...) \
313 printk(KERN_CONT fmt, ##__VA_ARGS__)
314
315
316#ifdef DEBUG
317#define pr_devel(fmt, ...) \
318 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
319#else
320#define pr_devel(fmt, ...) \
321 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
322#endif
323
324
325
326#if defined(CONFIG_DYNAMIC_DEBUG)
327#include <linux/dynamic_debug.h>
328
329
330#define pr_debug(fmt, ...) \
331 dynamic_pr_debug(fmt, ##__VA_ARGS__)
332#elif defined(DEBUG)
333#define pr_debug(fmt, ...) \
334 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
335#else
336#define pr_debug(fmt, ...) \
337 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
338#endif
339
340
341
342
343
344#ifdef CONFIG_PRINTK
345#define printk_once(fmt, ...) \
346({ \
347 static bool __section(.data.once) __print_once; \
348 bool __ret_print_once = !__print_once; \
349 \
350 if (!__print_once) { \
351 __print_once = true; \
352 printk(fmt, ##__VA_ARGS__); \
353 } \
354 unlikely(__ret_print_once); \
355})
356#define printk_deferred_once(fmt, ...) \
357({ \
358 static bool __section(.data.once) __print_once; \
359 bool __ret_print_once = !__print_once; \
360 \
361 if (!__print_once) { \
362 __print_once = true; \
363 printk_deferred(fmt, ##__VA_ARGS__); \
364 } \
365 unlikely(__ret_print_once); \
366})
367#else
368#define printk_once(fmt, ...) \
369 no_printk(fmt, ##__VA_ARGS__)
370#define printk_deferred_once(fmt, ...) \
371 no_printk(fmt, ##__VA_ARGS__)
372#endif
373
374#define pr_emerg_once(fmt, ...) \
375 printk_once(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
376#define pr_alert_once(fmt, ...) \
377 printk_once(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
378#define pr_crit_once(fmt, ...) \
379 printk_once(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
380#define pr_err_once(fmt, ...) \
381 printk_once(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
382#define pr_warn_once(fmt, ...) \
383 printk_once(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
384#define pr_notice_once(fmt, ...) \
385 printk_once(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
386#define pr_info_once(fmt, ...) \
387 printk_once(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
388#define pr_cont_once(fmt, ...) \
389 printk_once(KERN_CONT pr_fmt(fmt), ##__VA_ARGS__)
390
391#if defined(DEBUG)
392#define pr_devel_once(fmt, ...) \
393 printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
394#else
395#define pr_devel_once(fmt, ...) \
396 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
397#endif
398
399
400#if defined(DEBUG)
401#define pr_debug_once(fmt, ...) \
402 printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
403#else
404#define pr_debug_once(fmt, ...) \
405 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
406#endif
407
408
409
410
411
412#ifdef CONFIG_PRINTK
413#define printk_ratelimited(fmt, ...) \
414({ \
415 static DEFINE_RATELIMIT_STATE(_rs, \
416 DEFAULT_RATELIMIT_INTERVAL, \
417 DEFAULT_RATELIMIT_BURST); \
418 \
419 if (__ratelimit(&_rs)) \
420 printk(fmt, ##__VA_ARGS__); \
421})
422#else
423#define printk_ratelimited(fmt, ...) \
424 no_printk(fmt, ##__VA_ARGS__)
425#endif
426
427#define pr_emerg_ratelimited(fmt, ...) \
428 printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
429#define pr_alert_ratelimited(fmt, ...) \
430 printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
431#define pr_crit_ratelimited(fmt, ...) \
432 printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
433#define pr_err_ratelimited(fmt, ...) \
434 printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
435#define pr_warn_ratelimited(fmt, ...) \
436 printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
437#define pr_notice_ratelimited(fmt, ...) \
438 printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
439#define pr_info_ratelimited(fmt, ...) \
440 printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
441
442
443#if defined(DEBUG)
444#define pr_devel_ratelimited(fmt, ...) \
445 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
446#else
447#define pr_devel_ratelimited(fmt, ...) \
448 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
449#endif
450
451
452#if defined(CONFIG_DYNAMIC_DEBUG)
453
454#define pr_debug_ratelimited(fmt, ...) \
455do { \
456 static DEFINE_RATELIMIT_STATE(_rs, \
457 DEFAULT_RATELIMIT_INTERVAL, \
458 DEFAULT_RATELIMIT_BURST); \
459 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, pr_fmt(fmt)); \
460 if (DYNAMIC_DEBUG_BRANCH(descriptor) && \
461 __ratelimit(&_rs)) \
462 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), ##__VA_ARGS__); \
463} while (0)
464#elif defined(DEBUG)
465#define pr_debug_ratelimited(fmt, ...) \
466 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
467#else
468#define pr_debug_ratelimited(fmt, ...) \
469 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
470#endif
471
472extern const struct file_operations kmsg_fops;
473
474enum {
475 DUMP_PREFIX_NONE,
476 DUMP_PREFIX_ADDRESS,
477 DUMP_PREFIX_OFFSET
478};
479extern int hex_dump_to_buffer(const void *buf, size_t len, int rowsize,
480 int groupsize, char *linebuf, size_t linebuflen,
481 bool ascii);
482#ifdef CONFIG_PRINTK
483extern void print_hex_dump(const char *level, const char *prefix_str,
484 int prefix_type, int rowsize, int groupsize,
485 const void *buf, size_t len, bool ascii);
486#if defined(CONFIG_DYNAMIC_DEBUG)
487#define print_hex_dump_bytes(prefix_str, prefix_type, buf, len) \
488 dynamic_hex_dump(prefix_str, prefix_type, 16, 1, buf, len, true)
489#else
490extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
491 const void *buf, size_t len);
492#endif
493#else
494static inline void print_hex_dump(const char *level, const char *prefix_str,
495 int prefix_type, int rowsize, int groupsize,
496 const void *buf, size_t len, bool ascii)
497{
498}
499static inline void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
500 const void *buf, size_t len)
501{
502}
503
504#endif
505
506#if defined(CONFIG_DYNAMIC_DEBUG)
507#define print_hex_dump_debug(prefix_str, prefix_type, rowsize, \
508 groupsize, buf, len, ascii) \
509 dynamic_hex_dump(prefix_str, prefix_type, rowsize, \
510 groupsize, buf, len, ascii)
511#elif defined(DEBUG)
512#define print_hex_dump_debug(prefix_str, prefix_type, rowsize, \
513 groupsize, buf, len, ascii) \
514 print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, rowsize, \
515 groupsize, buf, len, ascii)
516#else
517static inline void print_hex_dump_debug(const char *prefix_str, int prefix_type,
518 int rowsize, int groupsize,
519 const void *buf, size_t len, bool ascii)
520{
521}
522#endif
523
524#endif
525