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