blob: 22c7052e937248e4c3337778d8608b3508a24ce5 [file] [log] [blame]
Linus Torvalds968ab182010-11-15 13:37:37 -08001#ifndef __KERNEL_PRINTK__
2#define __KERNEL_PRINTK__
3
Andrew Morton1b2c2892013-04-29 16:17:19 -07004#include <stdarg.h>
Mike Travis162a7e72011-05-24 17:13:20 -07005#include <linux/init.h>
Joe Perches314ba352012-07-30 14:40:11 -07006#include <linux/kern_levels.h>
Ralf Baechle154c2672013-05-21 10:51:10 +02007#include <linux/linkage.h>
Mike Travis162a7e72011-05-24 17:13:20 -07008
Linus Torvalds968ab182010-11-15 13:37:37 -08009extern const char linux_banner[];
10extern const char linux_proc_banner[];
11
Joe Perchesacc8fa412012-07-30 14:40:09 -070012static inline int printk_get_level(const char *buffer)
13{
Joe Perches04d2c8c2012-07-30 14:40:17 -070014 if (buffer[0] == KERN_SOH_ASCII && buffer[1]) {
Joe Perchesacc8fa412012-07-30 14:40:09 -070015 switch (buffer[1]) {
16 case '0' ... '7':
17 case 'd': /* KERN_DEFAULT */
Joe Perchesacc8fa412012-07-30 14:40:09 -070018 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 */
Joe Perches04d2c8c2012-07-30 14:40:17 -070030 return buffer + 2;
Joe Perchesacc8fa412012-07-30 14:40:09 -070031 }
32 }
33 return buffer;
34}
35
Linus Torvalds968ab182010-11-15 13:37:37 -080036extern 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
Joe Perchesa9747cc2011-01-12 16:59:43 -080043static 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
Linus Torvalds968ab182010-11-15 13:37:37 -080054struct 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
Joe Perches5264f2f2011-01-12 16:59:45 -080090/*
91 * Dummy printk for disabled debugging statements to use whilst maintaining
92 * gcc's format and side-effect checking.
93 */
Joe Perchesb9075fa2011-10-31 17:11:33 -070094static inline __printf(1, 2)
Joe Perches5264f2f2011-01-12 16:59:45 -080095int no_printk(const char *fmt, ...)
96{
97 return 0;
98}
99
Thomas Gleixnerd0380e62013-04-29 16:17:18 -0700100#ifdef CONFIG_EARLY_PRINTK
Joe Perchesb9075fa2011-10-31 17:11:33 -0700101extern asmlinkage __printf(1, 2)
Joe Perches5264f2f2011-01-12 16:59:45 -0800102void early_printk(const char *fmt, ...);
Thomas Gleixnerd0380e62013-04-29 16:17:18 -0700103void early_vprintk(const char *fmt, va_list ap);
104#else
105static inline __printf(1, 2) __cold
106void early_printk(const char *s, ...) { }
107#endif
Joe Perches5264f2f2011-01-12 16:59:45 -0800108
Linus Torvalds968ab182010-11-15 13:37:37 -0800109#ifdef CONFIG_PRINTK
Kay Sievers7ff95542012-05-03 02:29:13 +0200110asmlinkage __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
Joe Perchesb9075fa2011-10-31 17:11:33 -0700115asmlinkage __printf(1, 0)
Joe Perches5264f2f2011-01-12 16:59:45 -0800116int vprintk(const char *fmt, va_list args);
Kay Sievers7ff95542012-05-03 02:29:13 +0200117
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
Joe Perchesb9075fa2011-10-31 17:11:33 -0700123asmlinkage __printf(1, 2) __cold
Joe Perches5264f2f2011-01-12 16:59:45 -0800124int printk(const char *fmt, ...);
Linus Torvalds968ab182010-11-15 13:37:37 -0800125
126/*
Peter Zijlstra3ccf3e82012-02-27 10:47:00 +0100127 * Special printk facility for scheduler use only, _DO_NOT_USE_ !
128 */
129__printf(1, 2) __cold int printk_sched(const char *fmt, ...);
130
131/*
Linus Torvalds968ab182010-11-15 13:37:37 -0800132 * 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;
Dan Rosenberg455cd5a2011-01-12 16:59:41 -0800143extern int kptr_restrict;
Linus Torvalds968ab182010-11-15 13:37:37 -0800144
Frederic Weisbeckerdc72c322013-03-22 15:04:39 -0700145extern void wake_up_klogd(void);
146
Linus Torvalds968ab182010-11-15 13:37:37 -0800147void log_buf_kexec_setup(void);
Mike Travis162a7e72011-05-24 17:13:20 -0700148void __init setup_log_buf(int early);
Tejun Heo98e5e1b2013-04-30 15:27:15 -0700149void dump_stack_set_arch_desc(const char *fmt, ...);
Tejun Heo196779b2013-04-30 15:27:12 -0700150void dump_stack_print_info(const char *log_lvl);
Tejun Heoa43cb952013-04-30 15:27:17 -0700151void show_regs_print_info(const char *log_lvl);
Linus Torvalds968ab182010-11-15 13:37:37 -0800152#else
Joe Perchesb9075fa2011-10-31 17:11:33 -0700153static inline __printf(1, 0)
Joe Perches5264f2f2011-01-12 16:59:45 -0800154int vprintk(const char *s, va_list args)
155{
156 return 0;
157}
Joe Perchesb9075fa2011-10-31 17:11:33 -0700158static inline __printf(1, 2) __cold
Joe Perches5264f2f2011-01-12 16:59:45 -0800159int printk(const char *s, ...)
160{
161 return 0;
162}
Peter Zijlstra3ccf3e82012-02-27 10:47:00 +0100163static inline __printf(1, 2) __cold
164int printk_sched(const char *s, ...)
165{
166 return 0;
167}
Joe Perches5264f2f2011-01-12 16:59:45 -0800168static 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}
Linus Torvalds968ab182010-11-15 13:37:37 -0800177
Frederic Weisbeckerdc72c322013-03-22 15:04:39 -0700178static inline void wake_up_klogd(void)
179{
180}
181
Linus Torvalds968ab182010-11-15 13:37:37 -0800182static inline void log_buf_kexec_setup(void)
183{
184}
Mike Travis162a7e72011-05-24 17:13:20 -0700185
186static inline void setup_log_buf(int early)
187{
188}
Tejun Heo196779b2013-04-30 15:27:12 -0700189
Tejun Heo98e5e1b2013-04-30 15:27:15 -0700190static inline void dump_stack_set_arch_desc(const char *fmt, ...)
191{
192}
193
Tejun Heo196779b2013-04-30 15:27:12 -0700194static inline void dump_stack_print_info(const char *log_lvl)
195{
196}
Tejun Heoa43cb952013-04-30 15:27:17 -0700197
198static inline void show_regs_print_info(const char *log_lvl)
199{
200}
Linus Torvalds968ab182010-11-15 13:37:37 -0800201#endif
202
Linus Torvalds968ab182010-11-15 13:37:37 -0800203extern void dump_stack(void) __cold;
204
Linus Torvalds968ab182010-11-15 13:37:37 -0800205#ifndef pr_fmt
206#define pr_fmt(fmt) fmt
207#endif
208
209#define pr_emerg(fmt, ...) \
Joe Perchesa3f938b2011-01-12 16:59:48 -0800210 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
Linus Torvalds968ab182010-11-15 13:37:37 -0800211#define pr_alert(fmt, ...) \
Joe Perchesa3f938b2011-01-12 16:59:48 -0800212 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
Linus Torvalds968ab182010-11-15 13:37:37 -0800213#define pr_crit(fmt, ...) \
Joe Perchesa3f938b2011-01-12 16:59:48 -0800214 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
Linus Torvalds968ab182010-11-15 13:37:37 -0800215#define pr_err(fmt, ...) \
Joe Perchesa3f938b2011-01-12 16:59:48 -0800216 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
Linus Torvalds968ab182010-11-15 13:37:37 -0800217#define pr_warning(fmt, ...) \
Joe Perchesa3f938b2011-01-12 16:59:48 -0800218 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
Linus Torvalds968ab182010-11-15 13:37:37 -0800219#define pr_warn pr_warning
220#define pr_notice(fmt, ...) \
Joe Perchesa3f938b2011-01-12 16:59:48 -0800221 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
Linus Torvalds968ab182010-11-15 13:37:37 -0800222#define pr_info(fmt, ...) \
Joe Perchesa3f938b2011-01-12 16:59:48 -0800223 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
Linus Torvalds968ab182010-11-15 13:37:37 -0800224#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, ...) \
Joe Perches5264f2f2011-01-12 16:59:45 -0800233 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
Linus Torvalds968ab182010-11-15 13:37:37 -0800234#endif
235
236/* If you are writing a driver, please use dev_dbg instead */
Jim Cromieb558c962011-12-19 17:11:18 -0500237#if defined(CONFIG_DYNAMIC_DEBUG)
Linus Torvalds968ab182010-11-15 13:37:37 -0800238/* 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__)
Jim Cromieb558c962011-12-19 17:11:18 -0500241#elif defined(DEBUG)
242#define pr_debug(fmt, ...) \
243 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
Linus Torvalds968ab182010-11-15 13:37:37 -0800244#else
245#define pr_debug(fmt, ...) \
Joe Perches5264f2f2011-01-12 16:59:45 -0800246 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
Linus Torvalds968ab182010-11-15 13:37:37 -0800247#endif
248
249/*
Joe Perches16cb8392011-01-12 16:59:46 -0800250 * 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__)
Mikhail Gruzdev36d308d2013-02-21 16:43:10 -0800284
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
Joe Perches16cb8392011-01-12 16:59:46 -0800293/* 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/*
Linus Torvalds968ab182010-11-15 13:37:37 -0800303 * ratelimited messages with local ratelimit_state,
304 * no local ratelimit_state used in the !PRINTK case
305 */
306#ifdef CONFIG_PRINTK
Joe Perches6ec42a562011-01-12 16:59:47 -0800307#define printk_ratelimited(fmt, ...) \
308({ \
Linus Torvalds968ab182010-11-15 13:37:37 -0800309 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
Joe Perches6ec42a562011-01-12 16:59:47 -0800317#define printk_ratelimited(fmt, ...) \
318 no_printk(fmt, ##__VA_ARGS__)
Linus Torvalds968ab182010-11-15 13:37:37 -0800319#endif
320
Joe Perches6ec42a562011-01-12 16:59:47 -0800321#define pr_emerg_ratelimited(fmt, ...) \
Linus Torvalds968ab182010-11-15 13:37:37 -0800322 printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
Joe Perches6ec42a562011-01-12 16:59:47 -0800323#define pr_alert_ratelimited(fmt, ...) \
Linus Torvalds968ab182010-11-15 13:37:37 -0800324 printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
Joe Perches6ec42a562011-01-12 16:59:47 -0800325#define pr_crit_ratelimited(fmt, ...) \
Linus Torvalds968ab182010-11-15 13:37:37 -0800326 printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
Joe Perches6ec42a562011-01-12 16:59:47 -0800327#define pr_err_ratelimited(fmt, ...) \
Linus Torvalds968ab182010-11-15 13:37:37 -0800328 printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
Joe Perches6ec42a562011-01-12 16:59:47 -0800329#define pr_warn_ratelimited(fmt, ...) \
Linus Torvalds968ab182010-11-15 13:37:37 -0800330 printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
Joe Perches6ec42a562011-01-12 16:59:47 -0800331#define pr_notice_ratelimited(fmt, ...) \
Linus Torvalds968ab182010-11-15 13:37:37 -0800332 printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
Joe Perches6ec42a562011-01-12 16:59:47 -0800333#define pr_info_ratelimited(fmt, ...) \
Linus Torvalds968ab182010-11-15 13:37:37 -0800334 printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
335/* no pr_cont_ratelimited, don't do that... */
Mikhail Gruzdev36d308d2013-02-21 16:43:10 -0800336
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
Linus Torvalds968ab182010-11-15 13:37:37 -0800345/* If you are writing a driver, please use dev_dbg instead */
346#if defined(DEBUG)
Joe Perches6ec42a562011-01-12 16:59:47 -0800347#define pr_debug_ratelimited(fmt, ...) \
Linus Torvalds968ab182010-11-15 13:37:37 -0800348 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
349#else
350#define pr_debug_ratelimited(fmt, ...) \
Joe Perches5264f2f2011-01-12 16:59:45 -0800351 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
Linus Torvalds968ab182010-11-15 13:37:37 -0800352#endif
353
Kay Sieverse11fea92012-05-03 02:29:41 +0200354extern const struct file_operations kmsg_fops;
355
Joe Perchesac83ed62011-01-12 16:59:47 -0800356enum {
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);
Vladimir Kondratiev7a555612012-12-05 16:48:27 -0500368#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
Joe Perchesac83ed62011-01-12 16:59:47 -0800372extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
373 const void *buf, size_t len);
Vladimir Kondratiev7a555612012-12-05 16:48:27 -0500374#endif /* defined(CONFIG_DYNAMIC_DEBUG) */
Joe Perchesac83ed62011-01-12 16:59:47 -0800375#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
Vladimir Kondratiev7a555612012-12-05 16:48:27 -0500388#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
Linus Torvalds968ab182010-11-15 13:37:37 -0800400#endif