include/linux/printk.h: add pr_<level>_once macros
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / printk.h
CommitLineData
968ab183
LT
1#ifndef __KERNEL_PRINTK__
2#define __KERNEL_PRINTK__
3
4extern const char linux_banner[];
5extern const char linux_proc_banner[];
6
7d1e91ae
JP
7#define KERN_EMERG "<0>" /* system is unusable */
8#define KERN_ALERT "<1>" /* action must be taken immediately */
9#define KERN_CRIT "<2>" /* critical conditions */
10#define KERN_ERR "<3>" /* error conditions */
11#define KERN_WARNING "<4>" /* warning conditions */
12#define KERN_NOTICE "<5>" /* normal but significant condition */
13#define KERN_INFO "<6>" /* informational */
14#define KERN_DEBUG "<7>" /* debug-level messages */
968ab183
LT
15
16/* Use the default kernel loglevel */
17#define KERN_DEFAULT "<d>"
18/*
19 * Annotation for a "continued" line of log printout (only done after a
20 * line that had no enclosing \n). Only to be used by core/arch code
21 * during early bootup (a continued line is not SMP-safe otherwise).
22 */
7d1e91ae 23#define KERN_CONT "<c>"
968ab183
LT
24
25extern int console_printk[];
26
27#define console_loglevel (console_printk[0])
28#define default_message_loglevel (console_printk[1])
29#define minimum_console_loglevel (console_printk[2])
30#define default_console_loglevel (console_printk[3])
31
a9747cc3
JP
32static inline void console_silent(void)
33{
34 console_loglevel = 0;
35}
36
37static inline void console_verbose(void)
38{
39 if (console_loglevel)
40 console_loglevel = 15;
41}
42
968ab183
LT
43struct va_format {
44 const char *fmt;
45 va_list *va;
46};
47
48/*
49 * FW_BUG
50 * Add this to a message where you are sure the firmware is buggy or behaves
51 * really stupid or out of spec. Be aware that the responsible BIOS developer
52 * should be able to fix this issue or at least get a concrete idea of the
53 * problem by reading your message without the need of looking at the kernel
54 * code.
55 *
56 * Use it for definite and high priority BIOS bugs.
57 *
58 * FW_WARN
59 * Use it for not that clear (e.g. could the kernel messed up things already?)
60 * and medium priority BIOS bugs.
61 *
62 * FW_INFO
63 * Use this one if you want to tell the user or vendor about something
64 * suspicious, but generally harmless related to the firmware.
65 *
66 * Use it for information or very low priority BIOS bugs.
67 */
68#define FW_BUG "[Firmware Bug]: "
69#define FW_WARN "[Firmware Warn]: "
70#define FW_INFO "[Firmware Info]: "
71
72/*
73 * HW_ERR
74 * Add this to a message for hardware errors, so that user can report
75 * it to hardware vendor instead of LKML or software vendor.
76 */
77#define HW_ERR "[Hardware Error]: "
78
5264f2f7
JP
79/*
80 * Dummy printk for disabled debugging statements to use whilst maintaining
81 * gcc's format and side-effect checking.
82 */
83static inline __attribute__ ((format (printf, 1, 2)))
84int no_printk(const char *fmt, ...)
85{
86 return 0;
87}
88
89extern asmlinkage __attribute__ ((format (printf, 1, 2)))
90void early_printk(const char *fmt, ...);
91
92extern int printk_needs_cpu(int cpu);
93extern void printk_tick(void);
94
968ab183 95#ifdef CONFIG_PRINTK
5264f2f7
JP
96asmlinkage __attribute__ ((format (printf, 1, 0)))
97int vprintk(const char *fmt, va_list args);
98asmlinkage __attribute__ ((format (printf, 1, 2))) __cold
99int printk(const char *fmt, ...);
968ab183
LT
100
101/*
102 * Please don't use printk_ratelimit(), because it shares ratelimiting state
103 * with all other unrelated printk_ratelimit() callsites. Instead use
104 * printk_ratelimited() or plain old __ratelimit().
105 */
106extern int __printk_ratelimit(const char *func);
107#define printk_ratelimit() __printk_ratelimit(__func__)
108extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
109 unsigned int interval_msec);
110
111extern int printk_delay_msec;
112extern int dmesg_restrict;
455cd5ab 113extern int kptr_restrict;
968ab183 114
968ab183
LT
115void log_buf_kexec_setup(void);
116#else
5264f2f7
JP
117static inline __attribute__ ((format (printf, 1, 0)))
118int vprintk(const char *s, va_list args)
119{
120 return 0;
121}
122static inline __attribute__ ((format (printf, 1, 2))) __cold
123int printk(const char *s, ...)
124{
125 return 0;
126}
127static inline int printk_ratelimit(void)
128{
129 return 0;
130}
131static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies,
132 unsigned int interval_msec)
133{
134 return false;
135}
968ab183 136
968ab183
LT
137static inline void log_buf_kexec_setup(void)
138{
139}
140#endif
141
968ab183
LT
142extern void dump_stack(void) __cold;
143
144enum {
145 DUMP_PREFIX_NONE,
146 DUMP_PREFIX_ADDRESS,
147 DUMP_PREFIX_OFFSET
148};
149extern void hex_dump_to_buffer(const void *buf, size_t len,
150 int rowsize, int groupsize,
151 char *linebuf, size_t linebuflen, bool ascii);
152extern void print_hex_dump(const char *level, const char *prefix_str,
153 int prefix_type, int rowsize, int groupsize,
154 const void *buf, size_t len, bool ascii);
155extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
156 const void *buf, size_t len);
157
158#ifndef pr_fmt
159#define pr_fmt(fmt) fmt
160#endif
161
162#define pr_emerg(fmt, ...) \
163 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
164#define pr_alert(fmt, ...) \
165 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
166#define pr_crit(fmt, ...) \
167 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
168#define pr_err(fmt, ...) \
169 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
170#define pr_warning(fmt, ...) \
171 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
172#define pr_warn pr_warning
173#define pr_notice(fmt, ...) \
174 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
175#define pr_info(fmt, ...) \
176 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
177#define pr_cont(fmt, ...) \
178 printk(KERN_CONT fmt, ##__VA_ARGS__)
179
180/* pr_devel() should produce zero code unless DEBUG is defined */
181#ifdef DEBUG
182#define pr_devel(fmt, ...) \
183 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
184#else
185#define pr_devel(fmt, ...) \
5264f2f7 186 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
968ab183
LT
187#endif
188
189/* If you are writing a driver, please use dev_dbg instead */
190#if defined(DEBUG)
191#define pr_debug(fmt, ...) \
192 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
193#elif defined(CONFIG_DYNAMIC_DEBUG)
194/* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
195#define pr_debug(fmt, ...) \
196 dynamic_pr_debug(fmt, ##__VA_ARGS__)
197#else
198#define pr_debug(fmt, ...) \
5264f2f7 199 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
968ab183
LT
200#endif
201
16cb839f
JP
202/*
203 * Print a one-time message (analogous to WARN_ONCE() et al):
204 */
205
206#ifdef CONFIG_PRINTK
207#define printk_once(fmt, ...) \
208({ \
209 static bool __print_once; \
210 \
211 if (!__print_once) { \
212 __print_once = true; \
213 printk(fmt, ##__VA_ARGS__); \
214 } \
215})
216#else
217#define printk_once(fmt, ...) \
218 no_printk(fmt, ##__VA_ARGS__)
219#endif
220
221#define pr_emerg_once(fmt, ...) \
222 printk_once(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
223#define pr_alert_once(fmt, ...) \
224 printk_once(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
225#define pr_crit_once(fmt, ...) \
226 printk_once(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
227#define pr_err_once(fmt, ...) \
228 printk_once(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
229#define pr_warn_once(fmt, ...) \
230 printk_once(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
231#define pr_notice_once(fmt, ...) \
232 printk_once(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
233#define pr_info_once(fmt, ...) \
234 printk_once(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
235#define pr_cont_once(fmt, ...) \
236 printk_once(KERN_CONT pr_fmt(fmt), ##__VA_ARGS__)
237/* If you are writing a driver, please use dev_dbg instead */
238#if defined(DEBUG)
239#define pr_debug_once(fmt, ...) \
240 printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
241#else
242#define pr_debug_once(fmt, ...) \
243 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
244#endif
245
968ab183
LT
246/*
247 * ratelimited messages with local ratelimit_state,
248 * no local ratelimit_state used in the !PRINTK case
249 */
250#ifdef CONFIG_PRINTK
251#define printk_ratelimited(fmt, ...) ({ \
252 static DEFINE_RATELIMIT_STATE(_rs, \
253 DEFAULT_RATELIMIT_INTERVAL, \
254 DEFAULT_RATELIMIT_BURST); \
255 \
256 if (__ratelimit(&_rs)) \
257 printk(fmt, ##__VA_ARGS__); \
258})
259#else
260/* No effect, but we still get type checking even in the !PRINTK case: */
261#define printk_ratelimited printk
262#endif
263
264#define pr_emerg_ratelimited(fmt, ...) \
265 printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
266#define pr_alert_ratelimited(fmt, ...) \
267 printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
268#define pr_crit_ratelimited(fmt, ...) \
269 printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
270#define pr_err_ratelimited(fmt, ...) \
271 printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
272#define pr_warning_ratelimited(fmt, ...) \
273 printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
274#define pr_warn_ratelimited pr_warning_ratelimited
275#define pr_notice_ratelimited(fmt, ...) \
276 printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
277#define pr_info_ratelimited(fmt, ...) \
278 printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
279/* no pr_cont_ratelimited, don't do that... */
280/* If you are writing a driver, please use dev_dbg instead */
281#if defined(DEBUG)
282#define pr_debug_ratelimited(fmt, ...) \
283 printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
284#else
285#define pr_debug_ratelimited(fmt, ...) \
5264f2f7 286 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
968ab183
LT
287#endif
288
289#endif