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 #include <linux/cache.h>
   9
  10 extern const char linux_banner[];
  11 extern const char linux_proc_banner[];
  12
  13 static inline int printk_get_level(const char *buffer)
  14 {
  15         if (buffer[0] == KERN_SOH_ASCII && buffer[1]) {
  16                 switch (buffer[1]) {
  17                 case '0' ... '7':
  18                 case 'd':       /* KERN_DEFAULT */
  19                         return buffer[1];
  20                 }
  21         }
  22         return 0;
  23 }
  24
  25 static inline const char *printk_skip_level(const char *buffer)
  26 {
  27         if (printk_get_level(buffer))
  28                 return buffer + 2;
  29
  30         return buffer;
  31 }
  32
  33 #define CONSOLE_EXT_LOG_MAX     8192
  34
  35 /* printk's without a loglevel use this.. */
  36 #define MESSAGE_LOGLEVEL_DEFAULT CONFIG_MESSAGE_LOGLEVEL_DEFAULT
  37
  38 /* We show everything that is MORE important than this.. */
  39 #define CONSOLE_LOGLEVEL_SILENT  0 /* Mum's the word */
  40 #define CONSOLE_LOGLEVEL_MIN     1 /* Minimum loglevel we let people use */
  41 #define CONSOLE_LOGLEVEL_QUIET   4 /* Shhh ..., when booted with "quiet" */
  42 #define CONSOLE_LOGLEVEL_DEFAULT 7 /* anything MORE serious than KERN_DEBUG */
  43 #define CONSOLE_LOGLEVEL_DEBUG  10 /* issue debug messages */
  44 #define CONSOLE_LOGLEVEL_MOTORMOUTH 15  /* You can't shut this one up */
  45
  46 extern int console_printk[];
  47
  48 #define console_loglevel (console_printk[0])
  49 #define default_message_loglevel (console_printk[1])
  50 #define minimum_console_loglevel (console_printk[2])
  51 #define default_console_loglevel (console_printk[3])
  52
  53 static inline void console_silent(void)
  54 {
  55         console_loglevel = CONSOLE_LOGLEVEL_SILENT;
  56 }
  57
  58 static inline void console_verbose(void)
  59 {
  60         if (console_loglevel)
  61                 console_loglevel = CONSOLE_LOGLEVEL_MOTORMOUTH;
  62 }
  63
  64 struct va_format {
  65         const char *fmt;
  66         va_list *va;
  67 };
  68
  69 /*
  70  * FW_BUG
  71  * Add this to a message where you are sure the firmware is buggy or behaves
  72  * really stupid or out of spec. Be aware that the responsible BIOS developer
  73  * should be able to fix this issue or at least get a concrete idea of the
  74  * problem by reading your message without the need of looking at the kernel
  75  * code.
  76  *
  77  * Use it for definite and high priority BIOS bugs.
  78  *
  79  * FW_WARN
  80  * Use it for not that clear (e.g. could the kernel messed up things already?)
  81  * and medium priority BIOS bugs.
  82  *
  83  * FW_INFO
  84  * Use this one if you want to tell the user or vendor about something
  85  * suspicious, but generally harmless related to the firmware.
  86  *
  87  * Use it for information or very low priority BIOS bugs.
  88  */
  89 #define FW_BUG          "[Firmware Bug]: "
  90 #define FW_WARN         "[Firmware Warn]: "
  91 #define FW_INFO         "[Firmware Info]: "
  92
  93 /*
  94  * HW_ERR
  95  * Add this to a message for hardware errors, so that user can report
  96  * it to hardware vendor instead of LKML or software vendor.
  97  */
  98 #define HW_ERR          "[Hardware Error]: "
  99
 100 /*
 101  * DEPRECATED
 102  * Add this to a message whenever you want to warn user space about the use
 103  * of a deprecated aspect of an API so they can stop using it
 104  */
 105 #define DEPRECATED      "[Deprecated]: "
 106
 107 /*
 108  * Dummy printk for disabled debugging statements to use whilst maintaining
 109  * gcc's format checking.
 110  */
 111 #define no_printk(fmt, ...)                             \
 112 ({                                                      \
 113         do {                                            \
 114                 if (0)                                  \
 115                         printk(fmt, ##__VA_ARGS__);     \
 116         } while (0);                                    \
 117         0;                                              \
 118 })
 119
 120 #ifdef CONFIG_EARLY_PRINTK
 121 extern asmlinkage __printf(1, 2)
 122 void early_printk(const char *fmt, ...);
 123 #else
 124 static inline __printf(1, 2) __cold
 125 void early_printk(const char *s, ...) { }
 126 #endif
 127
 128 #ifdef CONFIG_PRINTK_NMI
 129 extern void printk_nmi_init(void);
 130 extern void printk_nmi_enter(void);
 131 extern void printk_nmi_exit(void);
 132 extern void printk_nmi_flush(void);
 133 extern void printk_nmi_flush_on_panic(void);
 134 #else
 135 static inline void printk_nmi_init(void) { }
 136 static inline void printk_nmi_enter(void) { }
 137 static inline void printk_nmi_exit(void) { }
 138 static inline void printk_nmi_flush(void) { }
 139 static inline void printk_nmi_flush_on_panic(void) { }
 140 #endif /* PRINTK_NMI */
 141
 142 #ifdef CONFIG_PRINTK
 143 asmlinkage __printf(5, 0)
 144 int vprintk_emit(int facility, int level,
 145                  const char *dict, size_t dictlen,
 146                  const char *fmt, va_list args);
 147
 148 asmlinkage __printf(1, 0)
 149 int vprintk(const char *fmt, va_list args);
 150
 151 asmlinkage __printf(5, 6) __cold
 152 int printk_emit(int facility, int level,
 153                 const char *dict, size_t dictlen,
 154                 const char *fmt, ...);
 155
 156 asmlinkage __printf(1, 2) __cold
 157 int printk(const char *fmt, ...);
 158
 159 /*
 160  * Special printk facility for scheduler/timekeeping use only, _DO_NOT_USE_ !
 161  */
 162 __printf(1, 2) __cold int printk_deferred(const char *fmt, ...);
 163
 164 /*
 165  * Please don't use printk_ratelimit(), because it shares ratelimiting state
 166  * with all other unrelated printk_ratelimit() callsites.  Instead use
 167  * printk_ratelimited() or plain old __ratelimit().
 168  */
 169 extern int __printk_ratelimit(const char *func);
 170 #define printk_ratelimit() __printk_ratelimit(__func__)
 171 extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
 172                                    unsigned int interval_msec);
 173
 174 extern int printk_delay_msec;
 175 extern int dmesg_restrict;
 176 extern int kptr_restrict;
 177
 178 extern void wake_up_klogd(void);
 179
 180 char *log_buf_addr_get(void);
 181 u32 log_buf_len_get(void);
 182 void log_buf_kexec_setup(void);
 183 void __init setup_log_buf(int early);
 184 __printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...);
 185 void dump_stack_print_info(const char *log_lvl);
 186 void show_regs_print_info(const char *log_lvl);
 187 #else
 188 static inline __printf(1, 0)
 189 int vprintk(const char *s, va_list args)
 190 {
 191         return 0;
 192 }
 193 static inline __printf(1, 2) __cold
 194 int printk(const char *s, ...)
 195 {
 196         return 0;
 197 }
 198 static inline __printf(1, 2) __cold
 199 int printk_deferred(const char *s, ...)
 200 {
 201         return 0;
 202 }
 203 static inline int printk_ratelimit(void)
 204 {
 205         return 0;
 206 }
 207 static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies,
 208                                           unsigned int interval_msec)
 209 {
 210         return false;
 211 }
 212
 213 static inline void wake_up_klogd(void)
 214 {
 215 }
 216
 217 static inline char *log_buf_addr_get(void)
 218 {
 219         return NULL;
 220 }
 221
 222 static inline u32 log_buf_len_get(void)
 223 {
 224         return 0;
 225 }
 226
 227 static inline void log_buf_kexec_setup(void)
 228 {
 229 }
 230
 231 static inline void setup_log_buf(int early)
 232 {
 233 }
 234
 235 static inline __printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...)
 236 {
 237 }
 238
 239 static inline void dump_stack_print_info(const char *log_lvl)
 240 {
 241 }
 242
 243 static inline void show_regs_print_info(const char *log_lvl)
 244 {
 245 }
 246 #endif
 247
 248 extern asmlinkage void dump_stack(void) __cold;
 249
 250 #ifndef pr_fmt
 251 #define pr_fmt(fmt) fmt
 252 #endif
 253
 254 /*
 255  * These can be used to print at the various log levels.
 256  * All of these will print unconditionally, although note that pr_debug()
 257  * and other debug macros are compiled out unless either DEBUG is defined
 258  * or CONFIG_DYNAMIC_DEBUG is set.
 259  */
 260 #define pr_emerg(fmt, ...) \
 261         printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 262 #define pr_alert(fmt, ...) \
 263         printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 264 #define pr_crit(fmt, ...) \
 265         printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 266 #define pr_err(fmt, ...) \
 267         printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 268 #define pr_warning(fmt, ...) \
 269         printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 270 #define pr_warn pr_warning
 271 #define pr_notice(fmt, ...) \
 272         printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 273 #define pr_info(fmt, ...) \
 274         printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 275 /*
 276  * Like KERN_CONT, pr_cont() should only be used when continuing
 277  * a line with no newline ('\n') enclosed. Otherwise it defaults
 278  * back to KERN_DEFAULT.
 279  */
 280 #define pr_cont(fmt, ...) \
 281         printk(KERN_CONT fmt, ##__VA_ARGS__)
 282
 283 /* pr_devel() should produce zero code unless DEBUG is defined */
 284 #ifdef DEBUG
 285 #define pr_devel(fmt, ...) \
 286         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 287 #else
 288 #define pr_devel(fmt, ...) \
 289         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 290 #endif
 291
 292 #include <linux/dynamic_debug.h>
 293
 294 /* If you are writing a driver, please use dev_dbg instead */
 295 #if defined(CONFIG_DYNAMIC_DEBUG)
 296 /* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
 297 #define pr_debug(fmt, ...) \
 298         dynamic_pr_debug(fmt, ##__VA_ARGS__)
 299 #elif defined(DEBUG)
 300 #define pr_debug(fmt, ...) \
 301         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 302 #else
 303 #define pr_debug(fmt, ...) \
 304         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 305 #endif
 306
 307 /*
 308  * Print a one-time message (analogous to WARN_ONCE() et al):
 309  */
 310
 311 #ifdef CONFIG_PRINTK
 312 #define printk_once(fmt, ...)                                   \
 313 ({                                                              \
 314         static bool __print_once __read_mostly;                 \
 315         bool __ret_print_once = !__print_once;                  \
 316                                                                 \
 317         if (!__print_once) {                                    \
 318                 __print_once = true;                            \
 319                 printk(fmt, ##__VA_ARGS__);                     \
 320         }                                                       \
 321         unlikely(__ret_print_once);                             \
 322 })
 323 #define printk_deferred_once(fmt, ...)                          \
 324 ({                                                              \
 325         static bool __print_once __read_mostly;                 \
 326         bool __ret_print_once = !__print_once;                  \
 327                                                                 \
 328         if (!__print_once) {                                    \
 329                 __print_once = true;                            \
 330                 printk_deferred(fmt, ##__VA_ARGS__);            \
 331         }                                                       \
 332         unlikely(__ret_print_once);                             \
 333 })
 334 #else
 335 #define printk_once(fmt, ...)                                   \
 336         no_printk(fmt, ##__VA_ARGS__)
 337 #define printk_deferred_once(fmt, ...)                          \
 338         no_printk(fmt, ##__VA_ARGS__)
 339 #endif
 340
 341 #define pr_emerg_once(fmt, ...)                                 \
 342         printk_once(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 343 #define pr_alert_once(fmt, ...)                                 \
 344         printk_once(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 345 #define pr_crit_once(fmt, ...)                                  \
 346         printk_once(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 347 #define pr_err_once(fmt, ...)                                   \
 348         printk_once(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 349 #define pr_warn_once(fmt, ...)                                  \
 350         printk_once(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 351 #define pr_notice_once(fmt, ...)                                \
 352         printk_once(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 353 #define pr_info_once(fmt, ...)                                  \
 354         printk_once(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 355 #define pr_cont_once(fmt, ...)                                  \
 356         printk_once(KERN_CONT pr_fmt(fmt), ##__VA_ARGS__)
 357
 358 #if defined(DEBUG)
 359 #define pr_devel_once(fmt, ...)                                 \
 360         printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 361 #else
 362 #define pr_devel_once(fmt, ...)                                 \
 363         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 364 #endif
 365
 366 /* If you are writing a driver, please use dev_dbg instead */
 367 #if defined(DEBUG)
 368 #define pr_debug_once(fmt, ...)                                 \
 369         printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 370 #else
 371 #define pr_debug_once(fmt, ...)                                 \
 372         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 373 #endif
 374
 375 /*
 376  * ratelimited messages with local ratelimit_state,
 377  * no local ratelimit_state used in the !PRINTK case
 378  */
 379 #ifdef CONFIG_PRINTK
 380 #define printk_ratelimited(fmt, ...)                                    \
 381 ({                                                                      \
 382         static DEFINE_RATELIMIT_STATE(_rs,                              \
 383                                       DEFAULT_RATELIMIT_INTERVAL,       \
 384                                       DEFAULT_RATELIMIT_BURST);         \
 385                                                                         \
 386         if (__ratelimit(&_rs))                                          \
 387                 printk(fmt, ##__VA_ARGS__);                             \
 388 })
 389 #else
 390 #define printk_ratelimited(fmt, ...)                                    \
 391         no_printk(fmt, ##__VA_ARGS__)
 392 #endif
 393
 394 #define pr_emerg_ratelimited(fmt, ...)                                  \
 395         printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 396 #define pr_alert_ratelimited(fmt, ...)                                  \
 397         printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 398 #define pr_crit_ratelimited(fmt, ...)                                   \
 399         printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 400 #define pr_err_ratelimited(fmt, ...)                                    \
 401         printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 402 #define pr_warn_ratelimited(fmt, ...)                                   \
 403         printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 404 #define pr_notice_ratelimited(fmt, ...)                                 \
 405         printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 406 #define pr_info_ratelimited(fmt, ...)                                   \
 407         printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 408 /* no pr_cont_ratelimited, don't do that... */
 409
 410 #if defined(DEBUG)
 411 #define pr_devel_ratelimited(fmt, ...)                                  \
 412         printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 413 #else
 414 #define pr_devel_ratelimited(fmt, ...)                                  \
 415         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 416 #endif
 417
 418 /* If you are writing a driver, please use dev_dbg instead */
 419 #if defined(CONFIG_DYNAMIC_DEBUG)
 420 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
 421 #define pr_debug_ratelimited(fmt, ...)                                  \
 422 do {                                                                    \
 423         static DEFINE_RATELIMIT_STATE(_rs,                              \
 424                                       DEFAULT_RATELIMIT_INTERVAL,       \
 425                                       DEFAULT_RATELIMIT_BURST);         \
 426         DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, pr_fmt(fmt));         \
 427         if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) &&        \
 428             __ratelimit(&_rs))                                          \
 429                 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), ##__VA_ARGS__);    \
 430 } while (0)
 431 #elif defined(DEBUG)
 432 #define pr_debug_ratelimited(fmt, ...)                                  \
 433         printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 434 #else
 435 #define pr_debug_ratelimited(fmt, ...) \
 436         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 437 #endif
 438
 439 extern const struct file_operations kmsg_fops;
 440
 441 enum {
 442         DUMP_PREFIX_NONE,
 443         DUMP_PREFIX_ADDRESS,
 444         DUMP_PREFIX_OFFSET
 445 };
 446 extern int hex_dump_to_buffer(const void *buf, size_t len, int rowsize,
 447                               int groupsize, char *linebuf, size_t linebuflen,
 448                               bool ascii);
 449 #ifdef CONFIG_PRINTK
 450 extern void print_hex_dump(const char *level, const char *prefix_str,
 451                            int prefix_type, int rowsize, int groupsize,
 452                            const void *buf, size_t len, bool ascii);
 453 #if defined(CONFIG_DYNAMIC_DEBUG)
 454 #define print_hex_dump_bytes(prefix_str, prefix_type, buf, len) \
 455         dynamic_hex_dump(prefix_str, prefix_type, 16, 1, buf, len, true)
 456 #else
 457 extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
 458                                  const void *buf, size_t len);
 459 #endif /* defined(CONFIG_DYNAMIC_DEBUG) */
 460 #else
 461 static inline void print_hex_dump(const char *level, const char *prefix_str,
 462                                   int prefix_type, int rowsize, int groupsize,
 463                                   const void *buf, size_t len, bool ascii)
 464 {
 465 }
 466 static inline void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
 467                                         const void *buf, size_t len)
 468 {
 469 }
 470
 471 #endif
 472
 473 #if defined(CONFIG_DYNAMIC_DEBUG)
 474 #define print_hex_dump_debug(prefix_str, prefix_type, rowsize,  \
 475                              groupsize, buf, len, ascii)        \
 476         dynamic_hex_dump(prefix_str, prefix_type, rowsize,      \
 477                          groupsize, buf, len, ascii)
 478 #elif defined(DEBUG)
 479 #define print_hex_dump_debug(prefix_str, prefix_type, rowsize,          \
 480                              groupsize, buf, len, ascii)                \
 481         print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, rowsize,    \
 482                        groupsize, buf, len, ascii)
 483 #else
 484 static inline void print_hex_dump_debug(const char *prefix_str, int prefix_type,
 485                                         int rowsize, int groupsize,
 486                                         const void *buf, size_t len, bool ascii)
 487 {
 488 }
 489 #endif
 490
 491 #endif