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