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