]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/printk.h
lib/vsprintf.c: add %pa format specifier for phys_addr_t types
[mirror_ubuntu-bionic-kernel.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
b9075fa9 98extern asmlinkage __printf(1, 2)
5264f2f7
JP
99void early_printk(const char *fmt, ...);
100
968ab183 101#ifdef CONFIG_PRINTK
7ff9554b
KS
102asmlinkage __printf(5, 0)
103int vprintk_emit(int facility, int level,
104 const char *dict, size_t dictlen,
105 const char *fmt, va_list args);
106
b9075fa9 107asmlinkage __printf(1, 0)
5264f2f7 108int vprintk(const char *fmt, va_list args);
7ff9554b
KS
109
110asmlinkage __printf(5, 6) __cold
111asmlinkage int printk_emit(int facility, int level,
112 const char *dict, size_t dictlen,
113 const char *fmt, ...);
114
b9075fa9 115asmlinkage __printf(1, 2) __cold
5264f2f7 116int printk(const char *fmt, ...);
968ab183 117
3ccf3e83
PZ
118/*
119 * Special printk facility for scheduler use only, _DO_NOT_USE_ !
120 */
121__printf(1, 2) __cold int printk_sched(const char *fmt, ...);
122
968ab183
LT
123/*
124 * Please don't use printk_ratelimit(), because it shares ratelimiting state
125 * with all other unrelated printk_ratelimit() callsites. Instead use
126 * printk_ratelimited() or plain old __ratelimit().
127 */
128extern int __printk_ratelimit(const char *func);
129#define printk_ratelimit() __printk_ratelimit(__func__)
130extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
131 unsigned int interval_msec);
132
133extern int printk_delay_msec;
134extern int dmesg_restrict;
455cd5ab 135extern int kptr_restrict;
968ab183 136
968ab183 137void log_buf_kexec_setup(void);
162a7e75 138void __init setup_log_buf(int early);
968ab183 139#else
b9075fa9 140static inline __printf(1, 0)
5264f2f7
JP
141int vprintk(const char *s, va_list args)
142{
143 return 0;
144}
b9075fa9 145static inline __printf(1, 2) __cold
5264f2f7
JP
146int printk(const char *s, ...)
147{
148 return 0;
149}
3ccf3e83
PZ
150static inline __printf(1, 2) __cold
151int printk_sched(const char *s, ...)
152{
153 return 0;
154}
5264f2f7
JP
155static inline int printk_ratelimit(void)
156{
157 return 0;
158}
159static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies,
160 unsigned int interval_msec)
161{
162 return false;
163}
968ab183 164
968ab183
LT
165static inline void log_buf_kexec_setup(void)
166{
167}
162a7e75
MT
168
169static inline void setup_log_buf(int early)
170{
171}
968ab183
LT
172#endif
173
968ab183
LT
174extern void dump_stack(void) __cold;
175
968ab183
LT
176#ifndef pr_fmt
177#define pr_fmt(fmt) fmt
178#endif
179
180#define pr_emerg(fmt, ...) \
a3f938bf 181 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
968ab183 182#define pr_alert(fmt, ...) \
a3f938bf 183 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
968ab183 184#define pr_crit(fmt, ...) \
a3f938bf 185 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
968ab183 186#define pr_err(fmt, ...) \
a3f938bf 187 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
968ab183 188#define pr_warning(fmt, ...) \
a3f938bf 189 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
968ab183
LT
190#define pr_warn pr_warning
191#define pr_notice(fmt, ...) \
a3f938bf 192 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
968ab183 193#define pr_info(fmt, ...) \
a3f938bf 194 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
968ab183
LT
195#define pr_cont(fmt, ...) \
196 printk(KERN_CONT fmt, ##__VA_ARGS__)
197
198/* pr_devel() should produce zero code unless DEBUG is defined */
199#ifdef DEBUG
200#define pr_devel(fmt, ...) \
201 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
202#else
203#define pr_devel(fmt, ...) \
5264f2f7 204 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
968ab183
LT
205#endif
206
207/* If you are writing a driver, please use dev_dbg instead */
b558c96f 208#if defined(CONFIG_DYNAMIC_DEBUG)
968ab183
LT
209/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
210#define pr_debug(fmt, ...) \
211 dynamic_pr_debug(fmt, ##__VA_ARGS__)
b558c96f
JC
212#elif defined(DEBUG)
213#define pr_debug(fmt, ...) \
214 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
968ab183
LT
215#else
216#define pr_debug(fmt, ...) \
5264f2f7 217 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
968ab183
LT
218#endif
219
16cb839f
JP
220/*
221 * Print a one-time message (analogous to WARN_ONCE() et al):
222 */
223
224#ifdef CONFIG_PRINTK
225#define printk_once(fmt, ...) \
226({ \
227 static bool __print_once; \
228 \
229 if (!__print_once) { \
230 __print_once = true; \
231 printk(fmt, ##__VA_ARGS__); \
232 } \
233})
234#else
235#define printk_once(fmt, ...) \
236 no_printk(fmt, ##__VA_ARGS__)
237#endif
238
239#define pr_emerg_once(fmt, ...) \
240 printk_once(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
241#define pr_alert_once(fmt, ...) \
242 printk_once(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
243#define pr_crit_once(fmt, ...) \
244 printk_once(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
245#define pr_err_once(fmt, ...) \
246 printk_once(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
247#define pr_warn_once(fmt, ...) \
248 printk_once(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
249#define pr_notice_once(fmt, ...) \
250 printk_once(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
251#define pr_info_once(fmt, ...) \
252 printk_once(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
253#define pr_cont_once(fmt, ...) \
254 printk_once(KERN_CONT pr_fmt(fmt), ##__VA_ARGS__)
255/* If you are writing a driver, please use dev_dbg instead */
256#if defined(DEBUG)
257#define pr_debug_once(fmt, ...) \
258 printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
259#else
260#define pr_debug_once(fmt, ...) \
261 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
262#endif
263
968ab183
LT
264/*
265 * ratelimited messages with local ratelimit_state,
266 * no local ratelimit_state used in the !PRINTK case
267 */
268#ifdef CONFIG_PRINTK
6ec42a56
JP
269#define printk_ratelimited(fmt, ...) \
270({ \
968ab183
LT
271 static DEFINE_RATELIMIT_STATE(_rs, \
272 DEFAULT_RATELIMIT_INTERVAL, \
273 DEFAULT_RATELIMIT_BURST); \
274 \
275 if (__ratelimit(&_rs)) \
276 printk(fmt, ##__VA_ARGS__); \
277})
278#else
6ec42a56
JP
279#define printk_ratelimited(fmt, ...) \
280 no_printk(fmt, ##__VA_ARGS__)
968ab183
LT
281#endif
282
6ec42a56 283#define pr_emerg_ratelimited(fmt, ...) \
968ab183 284 printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56 285#define pr_alert_ratelimited(fmt, ...) \
968ab183 286 printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56 287#define pr_crit_ratelimited(fmt, ...) \
968ab183 288 printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56 289#define pr_err_ratelimited(fmt, ...) \
968ab183 290 printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56 291#define pr_warn_ratelimited(fmt, ...) \
968ab183 292 printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56 293#define pr_notice_ratelimited(fmt, ...) \
968ab183 294 printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
6ec42a56 295#define pr_info_ratelimited(fmt, ...) \
968ab183
LT
296 printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
297/* no pr_cont_ratelimited, don't do that... */
298/* If you are writing a driver, please use dev_dbg instead */
299#if defined(DEBUG)
6ec42a56 300#define pr_debug_ratelimited(fmt, ...) \
968ab183
LT
301 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
302#else
303#define pr_debug_ratelimited(fmt, ...) \
5264f2f7 304 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
968ab183
LT
305#endif
306
e11fea92
KS
307extern const struct file_operations kmsg_fops;
308
ac83ed68
JP
309enum {
310 DUMP_PREFIX_NONE,
311 DUMP_PREFIX_ADDRESS,
312 DUMP_PREFIX_OFFSET
313};
314extern void hex_dump_to_buffer(const void *buf, size_t len,
315 int rowsize, int groupsize,
316 char *linebuf, size_t linebuflen, bool ascii);
317#ifdef CONFIG_PRINTK
318extern void print_hex_dump(const char *level, const char *prefix_str,
319 int prefix_type, int rowsize, int groupsize,
320 const void *buf, size_t len, bool ascii);
321extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
322 const void *buf, size_t len);
323#else
324static inline void print_hex_dump(const char *level, const char *prefix_str,
325 int prefix_type, int rowsize, int groupsize,
326 const void *buf, size_t len, bool ascii)
327{
328}
329static inline void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
330 const void *buf, size_t len)
331{
332}
333
334#endif
335
968ab183 336#endif