]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - include/linux/printk.h
sparc32: make show_stack() acquire %fp if @_ksp is not specified
[mirror_ubuntu-zesty-kernel.git] / include / linux / printk.h
CommitLineData
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>
162a7e75 7
968ab183
LT
8extern const char linux_banner[];
9extern const char linux_proc_banner[];
10
acc8fa41
JP
11static inline int printk_get_level(const char *buffer)
12{
04d2c8c8 13 if (buffer[0] == KERN_SOH_ASCII && buffer[1]) {
acc8fa41
JP
14 switch (buffer[1]) {
15 case '0' ... '7':
16 case 'd': /* KERN_DEFAULT */
acc8fa41
JP
17 return buffer[1];
18 }
19 }
20 return 0;
21}
22
23static 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 */
04d2c8c8 29 return buffer + 2;
acc8fa41
JP
30 }
31 }
32 return buffer;
33}
34
968ab183
LT
35extern 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
a9747cc3
JP
42static inline void console_silent(void)
43{
44 console_loglevel = 0;
45}
46
47static inline void console_verbose(void)
48{
49 if (console_loglevel)
50 console_loglevel = 15;
51}
52
968ab183
LT
53struct 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
5264f2f7
JP
89/*
90 * Dummy printk for disabled debugging statements to use whilst maintaining
91 * gcc's format and side-effect checking.
92 */
b9075fa9 93static inline __printf(1, 2)
5264f2f7
JP
94int no_printk(const char *fmt, ...)
95{
96 return 0;
97}
98
d0380e6c 99#ifdef CONFIG_EARLY_PRINTK
b9075fa9 100extern asmlinkage __printf(1, 2)
5264f2f7 101void early_printk(const char *fmt, ...);
d0380e6c
TG
102void early_vprintk(const char *fmt, va_list ap);
103#else
104static inline __printf(1, 2) __cold
105void early_printk(const char *s, ...) { }
106#endif
5264f2f7 107
968ab183 108#ifdef CONFIG_PRINTK
7ff9554b
KS
109asmlinkage __printf(5, 0)
110int vprintk_emit(int facility, int level,
111 const char *dict, size_t dictlen,
112 const char *fmt, va_list args);
113
b9075fa9 114asmlinkage __printf(1, 0)
5264f2f7 115int vprintk(const char *fmt, va_list args);
7ff9554b
KS
116
117asmlinkage __printf(5, 6) __cold
118asmlinkage int printk_emit(int facility, int level,
119 const char *dict, size_t dictlen,
120 const char *fmt, ...);
121
b9075fa9 122asmlinkage __printf(1, 2) __cold
5264f2f7 123int printk(const char *fmt, ...);
968ab183 124
3ccf3e83
PZ
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
968ab183
LT
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 */
135extern int __printk_ratelimit(const char *func);
136#define printk_ratelimit() __printk_ratelimit(__func__)
137extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
138 unsigned int interval_msec);
139
140extern int printk_delay_msec;
141extern int dmesg_restrict;
455cd5ab 142extern int kptr_restrict;
968ab183 143
dc72c32e
FW
144extern void wake_up_klogd(void);
145
968ab183 146void log_buf_kexec_setup(void);
162a7e75 147void __init setup_log_buf(int early);
968ab183 148#else
b9075fa9 149static inline __printf(1, 0)
5264f2f7
JP
150int vprintk(const char *s, va_list args)
151{
152 return 0;
153}
b9075fa9 154static inline __printf(1, 2) __cold
5264f2f7
JP
155int printk(const char *s, ...)
156{
157 return 0;
158}
3ccf3e83
PZ
159static inline __printf(1, 2) __cold
160int printk_sched(const char *s, ...)
161{
162 return 0;
163}
5264f2f7
JP
164static inline int printk_ratelimit(void)
165{
166 return 0;
167}
168static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies,
169 unsigned int interval_msec)
170{
171 return false;
172}
968ab183 173
dc72c32e
FW
174static inline void wake_up_klogd(void)
175{
176}
177
968ab183
LT
178static inline void log_buf_kexec_setup(void)
179{
180}
162a7e75
MT
181
182static inline void setup_log_buf(int early)
183{
184}
968ab183
LT
185#endif
186
968ab183
LT
187extern void dump_stack(void) __cold;
188
968ab183
LT
189#ifndef pr_fmt
190#define pr_fmt(fmt) fmt
191#endif
192
193#define pr_emerg(fmt, ...) \
a3f938bf 194 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
968ab183 195#define pr_alert(fmt, ...) \
a3f938bf 196 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
968ab183 197#define pr_crit(fmt, ...) \
a3f938bf 198 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
968ab183 199#define pr_err(fmt, ...) \
a3f938bf 200 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
968ab183 201#define pr_warning(fmt, ...) \
a3f938bf 202 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
968ab183
LT
203#define pr_warn pr_warning
204#define pr_notice(fmt, ...) \
a3f938bf 205 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
968ab183 206#define pr_info(fmt, ...) \
a3f938bf 207 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
968ab183
LT
208#define pr_cont(fmt, ...) \
209 printk(KERN_CONT fmt, ##__VA_ARGS__)
210
211/* pr_devel() should produce zero code unless DEBUG is defined */
212#ifdef DEBUG
213#define pr_devel(fmt, ...) \
214 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
215#else
216#define pr_devel(fmt, ...) \
5264f2f7 217 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
968ab183
LT
218#endif
219
220/* If you are writing a driver, please use dev_dbg instead */
b558c96f 221#if defined(CONFIG_DYNAMIC_DEBUG)
968ab183
LT
222/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
223#define pr_debug(fmt, ...) \
224 dynamic_pr_debug(fmt, ##__VA_ARGS__)
b558c96f
JC
225#elif defined(DEBUG)
226#define pr_debug(fmt, ...) \
227 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
968ab183
LT
228#else
229#define pr_debug(fmt, ...) \
5264f2f7 230 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
968ab183
LT
231#endif
232
16cb839f
JP
233/*
234 * Print a one-time message (analogous to WARN_ONCE() et al):
235 */
236
237#ifdef CONFIG_PRINTK
238#define printk_once(fmt, ...) \
239({ \
240 static bool __print_once; \
241 \
242 if (!__print_once) { \
243 __print_once = true; \
244 printk(fmt, ##__VA_ARGS__); \
245 } \
246})
247#else
248#define printk_once(fmt, ...) \
249 no_printk(fmt, ##__VA_ARGS__)
250#endif
251
252#define pr_emerg_once(fmt, ...) \
253 printk_once(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
254#define pr_alert_once(fmt, ...) \
255 printk_once(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
256#define pr_crit_once(fmt, ...) \
257 printk_once(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
258#define pr_err_once(fmt, ...) \
259 printk_once(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
260#define pr_warn_once(fmt, ...) \
261 printk_once(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
262#define pr_notice_once(fmt, ...) \
263 printk_once(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
264#define pr_info_once(fmt, ...) \
265 printk_once(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
266#define pr_cont_once(fmt, ...) \
267 printk_once(KERN_CONT pr_fmt(fmt), ##__VA_ARGS__)
36d308d8
MG
268
269#if defined(DEBUG)
270#define pr_devel_once(fmt, ...) \
271 printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
272#else
273#define pr_devel_once(fmt, ...) \
274 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
275#endif
276
16cb839f
JP
277/* If you are writing a driver, please use dev_dbg instead */
278#if defined(DEBUG)
279#define pr_debug_once(fmt, ...) \
280 printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
281#else
282#define pr_debug_once(fmt, ...) \
283 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
284#endif
285
968ab183
LT
286/*
287 * ratelimited messages with local ratelimit_state,
288 * no local ratelimit_state used in the !PRINTK case
289 */
290#ifdef CONFIG_PRINTK
6ec42a56
JP
291#define printk_ratelimited(fmt, ...) \
292({ \
968ab183
LT
293 static DEFINE_RATELIMIT_STATE(_rs, \
294 DEFAULT_RATELIMIT_INTERVAL, \
295 DEFAULT_RATELIMIT_BURST); \
296 \
297 if (__ratelimit(&_rs)) \
298 printk(fmt, ##__VA_ARGS__); \
299})
300#else
6ec42a56
JP
301#define printk_ratelimited(fmt, ...) \
302 no_printk(fmt, ##__VA_ARGS__)
968ab183
LT
303#endif
304
6ec42a56 305#define pr_emerg_ratelimited(fmt, ...) \
968ab183 306 printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56 307#define pr_alert_ratelimited(fmt, ...) \
968ab183 308 printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56 309#define pr_crit_ratelimited(fmt, ...) \
968ab183 310 printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56 311#define pr_err_ratelimited(fmt, ...) \
968ab183 312 printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56 313#define pr_warn_ratelimited(fmt, ...) \
968ab183 314 printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56 315#define pr_notice_ratelimited(fmt, ...) \
968ab183 316 printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56 317#define pr_info_ratelimited(fmt, ...) \
968ab183
LT
318 printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
319/* no pr_cont_ratelimited, don't do that... */
36d308d8
MG
320
321#if defined(DEBUG)
322#define pr_devel_ratelimited(fmt, ...) \
323 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
324#else
325#define pr_devel_ratelimited(fmt, ...) \
326 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
327#endif
328
968ab183
LT
329/* If you are writing a driver, please use dev_dbg instead */
330#if defined(DEBUG)
6ec42a56 331#define pr_debug_ratelimited(fmt, ...) \
968ab183
LT
332 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
333#else
334#define pr_debug_ratelimited(fmt, ...) \
5264f2f7 335 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
968ab183
LT
336#endif
337
e11fea92
KS
338extern const struct file_operations kmsg_fops;
339
ac83ed68
JP
340enum {
341 DUMP_PREFIX_NONE,
342 DUMP_PREFIX_ADDRESS,
343 DUMP_PREFIX_OFFSET
344};
345extern void hex_dump_to_buffer(const void *buf, size_t len,
346 int rowsize, int groupsize,
347 char *linebuf, size_t linebuflen, bool ascii);
348#ifdef CONFIG_PRINTK
349extern void print_hex_dump(const char *level, const char *prefix_str,
350 int prefix_type, int rowsize, int groupsize,
351 const void *buf, size_t len, bool ascii);
7a555613
VK
352#if defined(CONFIG_DYNAMIC_DEBUG)
353#define print_hex_dump_bytes(prefix_str, prefix_type, buf, len) \
354 dynamic_hex_dump(prefix_str, prefix_type, 16, 1, buf, len, true)
355#else
ac83ed68
JP
356extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
357 const void *buf, size_t len);
7a555613 358#endif /* defined(CONFIG_DYNAMIC_DEBUG) */
ac83ed68
JP
359#else
360static inline void print_hex_dump(const char *level, const char *prefix_str,
361 int prefix_type, int rowsize, int groupsize,
362 const void *buf, size_t len, bool ascii)
363{
364}
365static inline void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
366 const void *buf, size_t len)
367{
368}
369
370#endif
371
7a555613
VK
372#if defined(CONFIG_DYNAMIC_DEBUG)
373#define print_hex_dump_debug(prefix_str, prefix_type, rowsize, \
374 groupsize, buf, len, ascii) \
375 dynamic_hex_dump(prefix_str, prefix_type, rowsize, \
376 groupsize, buf, len, ascii)
377#else
378#define print_hex_dump_debug(prefix_str, prefix_type, rowsize, \
379 groupsize, buf, len, ascii) \
380 print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, rowsize, \
381 groupsize, buf, len, ascii)
382#endif /* defined(CONFIG_DYNAMIC_DEBUG) */
383
968ab183 384#endif