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