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 do {                                            \
 113         if (0)                                  \
 114                 printk(fmt, ##__VA_ARGS__);     \
 115 } while (0)
 116
 117 #ifdef CONFIG_EARLY_PRINTK
 118 extern asmlinkage __printf(1, 2)
 119 void early_printk(const char *fmt, ...);
 120 #else
 121 static inline __printf(1, 2) __cold
 122 void early_printk(const char *s, ...) { }
 123 #endif
 124
 125 typedef __printf(1, 0) int (*printk_func_t)(const char *fmt, va_list args);
 126
 127 #ifdef CONFIG_PRINTK
 128 asmlinkage __printf(5, 0)
 129 int vprintk_emit(int facility, int level,
 130                  const char *dict, size_t dictlen,
 131                  const char *fmt, va_list args);
 132
 133 asmlinkage __printf(1, 0)
 134 int vprintk(const char *fmt, va_list args);
 135
 136 asmlinkage __printf(5, 6) __cold
 137 int printk_emit(int facility, int level,
 138                 const char *dict, size_t dictlen,
 139                 const char *fmt, ...);
 140
 141 asmlinkage __printf(1, 2) __cold
 142 int printk(const char *fmt, ...);
 143
 144 /*
 145  * Special printk facility for scheduler/timekeeping use only, _DO_NOT_USE_ !
 146  */
 147 __printf(1, 2) __cold int printk_deferred(const char *fmt, ...);
 148
 149 /*
 150  * Please don't use printk_ratelimit(), because it shares ratelimiting state
 151  * with all other unrelated printk_ratelimit() callsites.  Instead use
 152  * printk_ratelimited() or plain old __ratelimit().
 153  */
 154 extern int __printk_ratelimit(const char *func);
 155 #define printk_ratelimit() __printk_ratelimit(__func__)
 156 extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
 157                                    unsigned int interval_msec);
 158
 159 extern int printk_delay_msec;
 160 extern int dmesg_restrict;
 161 extern int kptr_restrict;
 162
 163 extern void wake_up_klogd(void);
 164
 165 char *log_buf_addr_get(void);
 166 u32 log_buf_len_get(void);
 167 void log_buf_kexec_setup(void);
 168 void __init setup_log_buf(int early);
 169 __printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...);
 170 void dump_stack_print_info(const char *log_lvl);
 171 void show_regs_print_info(const char *log_lvl);
 172 #else
 173 static inline __printf(1, 0)
 174 int vprintk(const char *s, va_list args)
 175 {
 176         return 0;
 177 }
 178 static inline __printf(1, 2) __cold
 179 int printk(const char *s, ...)
 180 {
 181         return 0;
 182 }
 183 static inline __printf(1, 2) __cold
 184 int printk_deferred(const char *s, ...)
 185 {
 186         return 0;
 187 }
 188 static inline int printk_ratelimit(void)
 189 {
 190         return 0;
 191 }
 192 static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies,
 193                                           unsigned int interval_msec)
 194 {
 195         return false;
 196 }
 197
 198 static inline void wake_up_klogd(void)
 199 {
 200 }
 201
 202 static inline char *log_buf_addr_get(void)
 203 {
 204         return NULL;
 205 }
 206
 207 static inline u32 log_buf_len_get(void)
 208 {
 209         return 0;
 210 }
 211
 212 static inline void log_buf_kexec_setup(void)
 213 {
 214 }
 215
 216 static inline void setup_log_buf(int early)
 217 {
 218 }
 219
 220 static inline __printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...)
 221 {
 222 }
 223
 224 static inline void dump_stack_print_info(const char *log_lvl)
 225 {
 226 }
 227
 228 static inline void show_regs_print_info(const char *log_lvl)
 229 {
 230 }
 231 #endif
 232
 233 extern asmlinkage void dump_stack(void) __cold;
 234
 235 #ifndef pr_fmt
 236 #define pr_fmt(fmt) fmt
 237 #endif
 238
 239 /*
 240  * These can be used to print at the various log levels.
 241  * All of these will print unconditionally, although note that pr_debug()
 242  * and other debug macros are compiled out unless either DEBUG is defined
 243  * or CONFIG_DYNAMIC_DEBUG is set.
 244  */
 245 #define pr_emerg(fmt, ...) \
 246         printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 247 #define pr_alert(fmt, ...) \
 248         printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 249 #define pr_crit(fmt, ...) \
 250         printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 251 #define pr_err(fmt, ...) \
 252         printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 253 #define pr_warning(fmt, ...) \
 254         printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 255 #define pr_warn pr_warning
 256 #define pr_notice(fmt, ...) \
 257         printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 258 #define pr_info(fmt, ...) \
 259         printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 260 /*
 261  * Like KERN_CONT, pr_cont() should only be used when continuing
 262  * a line with no newline ('\n') enclosed. Otherwise it defaults
 263  * back to KERN_DEFAULT.
 264  */
 265 #define pr_cont(fmt, ...) \
 266         printk(KERN_CONT fmt, ##__VA_ARGS__)
 267
 268 /* pr_devel() should produce zero code unless DEBUG is defined */
 269 #ifdef DEBUG
 270 #define pr_devel(fmt, ...) \
 271         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 272 #else
 273 #define pr_devel(fmt, ...) \
 274         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 275 #endif
 276
 277 #include <linux/dynamic_debug.h>
 278
 279 /* If you are writing a driver, please use dev_dbg instead */
 280 #if defined(CONFIG_DYNAMIC_DEBUG)
 281 /* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
 282 #define pr_debug(fmt, ...) \
 283         dynamic_pr_debug(fmt, ##__VA_ARGS__)
 284 #elif defined(DEBUG)
 285 #define pr_debug(fmt, ...) \
 286         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 287 #else
 288 #define pr_debug(fmt, ...) \
 289         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 290 #endif
 291
 292 /*
 293  * Print a one-time message (analogous to WARN_ONCE() et al):
 294  */
 295
 296 #ifdef CONFIG_PRINTK
 297 #define printk_once(fmt, ...)                                   \
 298 ({                                                              \
 299         static bool __print_once __read_mostly;                 \
 300                                                                 \
 301         if (!__print_once) {                                    \
 302                 __print_once = true;                            \
 303                 printk(fmt, ##__VA_ARGS__);                     \
 304         }                                                       \
 305 })
 306 #define printk_deferred_once(fmt, ...)                          \
 307 ({                                                              \
 308         static bool __print_once __read_mostly;                 \
 309                                                                 \
 310         if (!__print_once) {                                    \
 311                 __print_once = true;                            \
 312                 printk_deferred(fmt, ##__VA_ARGS__);            \
 313         }                                                       \
 314 })
 315 #else
 316 #define printk_once(fmt, ...)                                   \
 317         no_printk(fmt, ##__VA_ARGS__)
 318 #define printk_deferred_once(fmt, ...)                          \
 319         no_printk(fmt, ##__VA_ARGS__)
 320 #endif
 321
 322 #define pr_emerg_once(fmt, ...)                                 \
 323         printk_once(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 324 #define pr_alert_once(fmt, ...)                                 \
 325         printk_once(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 326 #define pr_crit_once(fmt, ...)                                  \
 327         printk_once(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 328 #define pr_err_once(fmt, ...)                                   \
 329         printk_once(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 330 #define pr_warn_once(fmt, ...)                                  \
 331         printk_once(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 332 #define pr_notice_once(fmt, ...)                                \
 333         printk_once(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 334 #define pr_info_once(fmt, ...)                                  \
 335         printk_once(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 336 #define pr_cont_once(fmt, ...)                                  \
 337         printk_once(KERN_CONT pr_fmt(fmt), ##__VA_ARGS__)
 338
 339 #if defined(DEBUG)
 340 #define pr_devel_once(fmt, ...)                                 \
 341         printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 342 #else
 343 #define pr_devel_once(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_once(fmt, ...)                                 \
 350         printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 351 #else
 352 #define pr_debug_once(fmt, ...)                                 \
 353         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 354 #endif
 355
 356 /*
 357  * ratelimited messages with local ratelimit_state,
 358  * no local ratelimit_state used in the !PRINTK case
 359  */
 360 #ifdef CONFIG_PRINTK
 361 #define printk_ratelimited(fmt, ...)                                    \
 362 ({                                                                      \
 363         static DEFINE_RATELIMIT_STATE(_rs,                              \
 364                                       DEFAULT_RATELIMIT_INTERVAL,       \
 365                                       DEFAULT_RATELIMIT_BURST);         \
 366                                                                         \
 367         if (__ratelimit(&_rs))                                          \
 368                 printk(fmt, ##__VA_ARGS__);                             \
 369 })
 370 #else
 371 #define printk_ratelimited(fmt, ...)                                    \
 372         no_printk(fmt, ##__VA_ARGS__)
 373 #endif
 374
 375 #define pr_emerg_ratelimited(fmt, ...)                                  \
 376         printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 377 #define pr_alert_ratelimited(fmt, ...)                                  \
 378         printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 379 #define pr_crit_ratelimited(fmt, ...)                                   \
 380         printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 381 #define pr_err_ratelimited(fmt, ...)                                    \
 382         printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 383 #define pr_warn_ratelimited(fmt, ...)                                   \
 384         printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 385 #define pr_notice_ratelimited(fmt, ...)                                 \
 386         printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 387 #define pr_info_ratelimited(fmt, ...)                                   \
 388         printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 389 /* no pr_cont_ratelimited, don't do that... */
 390
 391 #if defined(DEBUG)
 392 #define pr_devel_ratelimited(fmt, ...)                                  \
 393         printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 394 #else
 395 #define pr_devel_ratelimited(fmt, ...)                                  \
 396         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 397 #endif
 398
 399 /* If you are writing a driver, please use dev_dbg instead */
 400 #if defined(CONFIG_DYNAMIC_DEBUG)
 401 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
 402 #define pr_debug_ratelimited(fmt, ...)                                  \
 403 do {                                                                    \
 404         static DEFINE_RATELIMIT_STATE(_rs,                              \
 405                                       DEFAULT_RATELIMIT_INTERVAL,       \
 406                                       DEFAULT_RATELIMIT_BURST);         \
 407         DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, pr_fmt(fmt));         \
 408         if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) &&        \
 409             __ratelimit(&_rs))                                          \
 410                 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), ##__VA_ARGS__);    \
 411 } while (0)
 412 #elif defined(DEBUG)
 413 #define pr_debug_ratelimited(fmt, ...)                                  \
 414         printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 415 #else
 416 #define pr_debug_ratelimited(fmt, ...) \
 417         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 418 #endif
 419
 420 extern const struct file_operations kmsg_fops;
 421
 422 enum {
 423         DUMP_PREFIX_NONE,
 424         DUMP_PREFIX_ADDRESS,
 425         DUMP_PREFIX_OFFSET
 426 };
 427 extern int hex_dump_to_buffer(const void *buf, size_t len, int rowsize,
 428                               int groupsize, char *linebuf, size_t linebuflen,
 429                               bool ascii);
 430 #ifdef CONFIG_PRINTK
 431 extern void print_hex_dump(const char *level, const char *prefix_str,
 432                            int prefix_type, int rowsize, int groupsize,
 433                            const void *buf, size_t len, bool ascii);
 434 #if defined(CONFIG_DYNAMIC_DEBUG)
 435 #define print_hex_dump_bytes(prefix_str, prefix_type, buf, len) \
 436         dynamic_hex_dump(prefix_str, prefix_type, 16, 1, buf, len, true)
 437 #else
 438 extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
 439                                  const void *buf, size_t len);
 440 #endif /* defined(CONFIG_DYNAMIC_DEBUG) */
 441 #else
 442 static inline void print_hex_dump(const char *level, const char *prefix_str,
 443                                   int prefix_type, int rowsize, int groupsize,
 444                                   const void *buf, size_t len, bool ascii)
 445 {
 446 }
 447 static inline void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
 448                                         const void *buf, size_t len)
 449 {
 450 }
 451
 452 #endif
 453
 454 #if defined(CONFIG_DYNAMIC_DEBUG)
 455 #define print_hex_dump_debug(prefix_str, prefix_type, rowsize,  \
 456                              groupsize, buf, len, ascii)        \
 457         dynamic_hex_dump(prefix_str, prefix_type, rowsize,      \
 458                          groupsize, buf, len, ascii)
 459 #elif defined(DEBUG)
 460 #define print_hex_dump_debug(prefix_str, prefix_type, rowsize,          \
 461                              groupsize, buf, len, ascii)                \
 462         print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, rowsize,    \
 463                        groupsize, buf, len, ascii)
 464 #else
 465 static inline void print_hex_dump_debug(const char *prefix_str, int prefix_type,
 466                                         int rowsize, int groupsize,
 467                                         const void *buf, size_t len, bool ascii)
 468 {
 469 }
 470 #endif
 471
 472 #endif