Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1#ifndef __KERNEL_PRINTK__
2#define __KERNEL_PRINTK__
3
4#include <stdarg.h>
5#include <linux/init.h>
6#include <linux/kern_levels.h>
7#include <linux/linkage.h>
8
9extern const char linux_banner[];
10extern const char linux_proc_banner[];
11
12static inline int printk_get_level(const char *buffer)
13{
14 if (buffer[0] == KERN_SOH_ASCII && buffer[1]) {
15 switch (buffer[1]) {
16 case '0' ... '7':
17 case 'd': /* KERN_DEFAULT */
18 return buffer[1];
19 }
20 }
21 return 0;
22}
23
24static inline const char *printk_skip_level(const char *buffer)
25{
26 if (printk_get_level(buffer)) {
27 switch (buffer[1]) {
28 case '0' ... '7':
29 case 'd': /* KERN_DEFAULT */
30 return buffer + 2;
31 }
32 }
33 return buffer;
34}
35
36extern int console_printk[];
37
38#define console_loglevel (console_printk[0])
39#define default_message_loglevel (console_printk[1])
40#define minimum_console_loglevel (console_printk[2])
41#define default_console_loglevel (console_printk[3])
42
43static inline void console_silent(void)
44{
45 console_loglevel = 0;
46}
47
48static inline void console_verbose(void)
49{
50 if (console_loglevel)
51 console_loglevel = 15;
52}
53
54struct va_format {
55 const char *fmt;
56 va_list *va;
57};
58
59/*
60 * FW_BUG
61 * Add this to a message where you are sure the firmware is buggy or behaves
62 * really stupid or out of spec. Be aware that the responsible BIOS developer
63 * should be able to fix this issue or at least get a concrete idea of the
64 * problem by reading your message without the need of looking at the kernel
65 * code.
66 *
67 * Use it for definite and high priority BIOS bugs.
68 *
69 * FW_WARN
70 * Use it for not that clear (e.g. could the kernel messed up things already?)
71 * and medium priority BIOS bugs.
72 *
73 * FW_INFO
74 * Use this one if you want to tell the user or vendor about something
75 * suspicious, but generally harmless related to the firmware.
76 *
77 * Use it for information or very low priority BIOS bugs.
78 */
79#define FW_BUG "[Firmware Bug]: "
80#define FW_WARN "[Firmware Warn]: "
81#define FW_INFO "[Firmware Info]: "
82
83/*
84 * HW_ERR
85 * Add this to a message for hardware errors, so that user can report
86 * it to hardware vendor instead of LKML or software vendor.
87 */
88#define HW_ERR "[Hardware Error]: "
89
90/*
91 * Dummy printk for disabled debugging statements to use whilst maintaining
92 * gcc's format and side-effect checking.
93 */
94static inline __printf(1, 2)
95int no_printk(const char *fmt, ...)
96{
97 return 0;
98}
99
100#ifdef CONFIG_EARLY_PRINTK
101extern asmlinkage __printf(1, 2)
102void early_printk(const char *fmt, ...);
103void early_vprintk(const char *fmt, va_list ap);
104#else
105static inline __printf(1, 2) __cold
106void early_printk(const char *s, ...) { }
107#endif
108
109#ifdef CONFIG_PRINTK
110asmlinkage __printf(5, 0)
111int vprintk_emit(int facility, int level,
112 const char *dict, size_t dictlen,
113 const char *fmt, va_list args);
114
115asmlinkage __printf(1, 0)
116int vprintk(const char *fmt, va_list args);
117
118asmlinkage __printf(5, 6) __cold
119asmlinkage int printk_emit(int facility, int level,
120 const char *dict, size_t dictlen,
121 const char *fmt, ...);
122
123asmlinkage __printf(1, 2) __cold
124int printk(const char *fmt, ...);
125
126/*
127 * Special printk facility for scheduler use only, _DO_NOT_USE_ !
128 */
129__printf(1, 2) __cold int printk_sched(const char *fmt, ...);
130
131/*
132 * Please don't use printk_ratelimit(), because it shares ratelimiting state
133 * with all other unrelated printk_ratelimit() callsites. Instead use
134 * printk_ratelimited() or plain old __ratelimit().
135 */
136extern int __printk_ratelimit(const char *func);
137#define printk_ratelimit() __printk_ratelimit(__func__)
138extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
139 unsigned int interval_msec);
140
141extern int printk_delay_msec;
142extern int dmesg_restrict;
143extern int kptr_restrict;
144
145extern void wake_up_klogd(void);
146
147void log_buf_kexec_setup(void);
148void __init setup_log_buf(int early);
149void dump_stack_set_arch_desc(const char *fmt, ...);
150void dump_stack_print_info(const char *log_lvl);
151void show_regs_print_info(const char *log_lvl);
152#else
153static inline __printf(1, 0)
154int vprintk(const char *s, va_list args)
155{
156 return 0;
157}
158static inline __printf(1, 2) __cold
159int printk(const char *s, ...)
160{
161 return 0;
162}
163static inline __printf(1, 2) __cold
164int printk_sched(const char *s, ...)
165{
166 return 0;
167}
168static inline int printk_ratelimit(void)
169{
170 return 0;
171}
172static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies,
173 unsigned int interval_msec)
174{
175 return false;
176}
177
178static inline void wake_up_klogd(void)
179{
180}
181
182static inline void log_buf_kexec_setup(void)
183{
184}
185
186static inline void setup_log_buf(int early)
187{
188}
189
190static inline void dump_stack_set_arch_desc(const char *fmt, ...)
191{
192}
193
194static inline void dump_stack_print_info(const char *log_lvl)
195{
196}
197
198static inline void show_regs_print_info(const char *log_lvl)
199{
200}
201#endif
202
203extern asmlinkage void dump_stack(void) __cold;
204
205#ifndef pr_fmt
206#define pr_fmt(fmt) fmt
207#endif
208
209#define pr_emerg(fmt, ...) \
210 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
211#define pr_alert(fmt, ...) \
212 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
213#define pr_crit(fmt, ...) \
214 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
215#define pr_err(fmt, ...) \
216 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
217#define pr_warning(fmt, ...) \
218 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
219#define pr_warn pr_warning
220#define pr_notice(fmt, ...) \
221 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
222#define pr_info(fmt, ...) \
223 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
224#define pr_cont(fmt, ...) \
225 printk(KERN_CONT fmt, ##__VA_ARGS__)
226
227/* pr_devel() should produce zero code unless DEBUG is defined */
228#ifdef DEBUG
229#define pr_devel(fmt, ...) \
230 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
231#else
232#define pr_devel(fmt, ...) \
233 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
234#endif
235
236/* If you are writing a driver, please use dev_dbg instead */
237#if defined(CONFIG_DYNAMIC_DEBUG)
238/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
239#define pr_debug(fmt, ...) \
240 dynamic_pr_debug(fmt, ##__VA_ARGS__)
241#elif defined(DEBUG)
242#define pr_debug(fmt, ...) \
243 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
244#else
245#define pr_debug(fmt, ...) \
246 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
247#endif
248
249/*
250 * Print a one-time message (analogous to WARN_ONCE() et al):
251 */
252
253#ifdef CONFIG_PRINTK
254#define printk_once(fmt, ...) \
255({ \
256 static bool __print_once; \
257 \
258 if (!__print_once) { \
259 __print_once = true; \
260 printk(fmt, ##__VA_ARGS__); \
261 } \
262})
263#else
264#define printk_once(fmt, ...) \
265 no_printk(fmt, ##__VA_ARGS__)
266#endif
267
268#define pr_emerg_once(fmt, ...) \
269 printk_once(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
270#define pr_alert_once(fmt, ...) \
271 printk_once(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
272#define pr_crit_once(fmt, ...) \
273 printk_once(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
274#define pr_err_once(fmt, ...) \
275 printk_once(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
276#define pr_warn_once(fmt, ...) \
277 printk_once(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
278#define pr_notice_once(fmt, ...) \
279 printk_once(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
280#define pr_info_once(fmt, ...) \
281 printk_once(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
282#define pr_cont_once(fmt, ...) \
283 printk_once(KERN_CONT pr_fmt(fmt), ##__VA_ARGS__)
284
285#if defined(DEBUG)
286#define pr_devel_once(fmt, ...) \
287 printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
288#else
289#define pr_devel_once(fmt, ...) \
290 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
291#endif
292
293/* If you are writing a driver, please use dev_dbg instead */
294#if defined(DEBUG)
295#define pr_debug_once(fmt, ...) \
296 printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
297#else
298#define pr_debug_once(fmt, ...) \
299 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
300#endif
301
302/*
303 * ratelimited messages with local ratelimit_state,
304 * no local ratelimit_state used in the !PRINTK case
305 */
306#ifdef CONFIG_PRINTK
307#define printk_ratelimited(fmt, ...) \
308({ \
309 static DEFINE_RATELIMIT_STATE(_rs, \
310 DEFAULT_RATELIMIT_INTERVAL, \
311 DEFAULT_RATELIMIT_BURST); \
312 \
313 if (__ratelimit(&_rs)) \
314 printk(fmt, ##__VA_ARGS__); \
315})
316#else
317#define printk_ratelimited(fmt, ...) \
318 no_printk(fmt, ##__VA_ARGS__)
319#endif
320
321#define pr_emerg_ratelimited(fmt, ...) \
322 printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
323#define pr_alert_ratelimited(fmt, ...) \
324 printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
325#define pr_crit_ratelimited(fmt, ...) \
326 printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
327#define pr_err_ratelimited(fmt, ...) \
328 printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
329#define pr_warn_ratelimited(fmt, ...) \
330 printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
331#define pr_notice_ratelimited(fmt, ...) \
332 printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
333#define pr_info_ratelimited(fmt, ...) \
334 printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
335/* no pr_cont_ratelimited, don't do that... */
336
337#if defined(DEBUG)
338#define pr_devel_ratelimited(fmt, ...) \
339 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
340#else
341#define pr_devel_ratelimited(fmt, ...) \
342 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
343#endif
344
345/* If you are writing a driver, please use dev_dbg instead */
346#if defined(DEBUG)
347#define pr_debug_ratelimited(fmt, ...) \
348 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
349#else
350#define pr_debug_ratelimited(fmt, ...) \
351 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
352#endif
353
354extern const struct file_operations kmsg_fops;
355
356enum {
357 DUMP_PREFIX_NONE,
358 DUMP_PREFIX_ADDRESS,
359 DUMP_PREFIX_OFFSET
360};
361extern void hex_dump_to_buffer(const void *buf, size_t len,
362 int rowsize, int groupsize,
363 char *linebuf, size_t linebuflen, bool ascii);
364#ifdef CONFIG_PRINTK
365extern void print_hex_dump(const char *level, const char *prefix_str,
366 int prefix_type, int rowsize, int groupsize,
367 const void *buf, size_t len, bool ascii);
368#if defined(CONFIG_DYNAMIC_DEBUG)
369#define print_hex_dump_bytes(prefix_str, prefix_type, buf, len) \
370 dynamic_hex_dump(prefix_str, prefix_type, 16, 1, buf, len, true)
371#else
372extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
373 const void *buf, size_t len);
374#endif /* defined(CONFIG_DYNAMIC_DEBUG) */
375#else
376static inline void print_hex_dump(const char *level, const char *prefix_str,
377 int prefix_type, int rowsize, int groupsize,
378 const void *buf, size_t len, bool ascii)
379{
380}
381static inline void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
382 const void *buf, size_t len)
383{
384}
385
386#endif
387
388#if defined(CONFIG_DYNAMIC_DEBUG)
389#define print_hex_dump_debug(prefix_str, prefix_type, rowsize, \
390 groupsize, buf, len, ascii) \
391 dynamic_hex_dump(prefix_str, prefix_type, rowsize, \
392 groupsize, buf, len, ascii)
393#else
394#define print_hex_dump_debug(prefix_str, prefix_type, rowsize, \
395 groupsize, buf, len, ascii) \
396 print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, rowsize, \
397 groupsize, buf, len, ascii)
398#endif /* defined(CONFIG_DYNAMIC_DEBUG) */
399
400#endif