include/linux/printk.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __KERNEL_PRINTK__
   3 #define __KERNEL_PRINTK__
   4
   5 #include <linux/stdarg.h>
   6 #include <linux/init.h>
   7 #include <linux/kern_levels.h>
   8 #include <linux/linkage.h>
   9 #include <linux/ratelimit_types.h>
  10 #include <linux/once_lite.h>
  11
  12 extern const char linux_banner[];
  13 extern const char linux_proc_banner[];
  14
  15 extern int oops_in_progress;    /* If set, an oops, panic(), BUG() or die() is in progress */
  16
  17 #define PRINTK_MAX_SINGLE_HEADER_LEN 2
  18
  19 static inline int printk_get_level(const char *buffer)
  20 {
  21         if (buffer[0] == KERN_SOH_ASCII && buffer[1]) {
  22                 switch (buffer[1]) {
  23                 case '0' ... '7':
  24                 case 'c':       /* KERN_CONT */
  25                         return buffer[1];
  26                 }
  27         }
  28         return 0;
  29 }
  30
  31 static inline const char *printk_skip_level(const char *buffer)
  32 {
  33         if (printk_get_level(buffer))
  34                 return buffer + 2;
  35
  36         return buffer;
  37 }
  38
  39 static inline const char *printk_skip_headers(const char *buffer)
  40 {
  41         while (printk_get_level(buffer))
  42                 buffer = printk_skip_level(buffer);
  43
  44         return buffer;
  45 }
  46
  47 /* printk's without a loglevel use this.. */
  48 #define MESSAGE_LOGLEVEL_DEFAULT CONFIG_MESSAGE_LOGLEVEL_DEFAULT
  49
  50 /* We show everything that is MORE important than this.. */
  51 #define CONSOLE_LOGLEVEL_SILENT  0 /* Mum's the word */
  52 #define CONSOLE_LOGLEVEL_MIN     1 /* Minimum loglevel we let people use */
  53 #define CONSOLE_LOGLEVEL_DEBUG  10 /* issue debug messages */
  54 #define CONSOLE_LOGLEVEL_MOTORMOUTH 15  /* You can't shut this one up */
  55
  56 /*
  57  * Default used to be hard-coded at 7, quiet used to be hardcoded at 4,
  58  * we're now allowing both to be set from kernel config.
  59  */
  60 #define CONSOLE_LOGLEVEL_DEFAULT CONFIG_CONSOLE_LOGLEVEL_DEFAULT
  61 #define CONSOLE_LOGLEVEL_QUIET   CONFIG_CONSOLE_LOGLEVEL_QUIET
  62
  63 extern int console_printk[];
  64
  65 #define console_loglevel (console_printk[0])
  66 #define default_message_loglevel (console_printk[1])
  67 #define minimum_console_loglevel (console_printk[2])
  68 #define default_console_loglevel (console_printk[3])
  69
  70 extern void console_verbose(void);
  71
  72 /* strlen("ratelimit") + 1 */
  73 #define DEVKMSG_STR_MAX_SIZE 10
  74 extern char devkmsg_log_str[];
  75 struct ctl_table;
  76
  77 extern int suppress_printk;
  78
  79 struct va_format {
  80         const char *fmt;
  81         va_list *va;
  82 };
  83
  84 /*
  85  * FW_BUG
  86  * Add this to a message where you are sure the firmware is buggy or behaves
  87  * really stupid or out of spec. Be aware that the responsible BIOS developer
  88  * should be able to fix this issue or at least get a concrete idea of the
  89  * problem by reading your message without the need of looking at the kernel
  90  * code.
  91  *
  92  * Use it for definite and high priority BIOS bugs.
  93  *
  94  * FW_WARN
  95  * Use it for not that clear (e.g. could the kernel messed up things already?)
  96  * and medium priority BIOS bugs.
  97  *
  98  * FW_INFO
  99  * Use this one if you want to tell the user or vendor about something
 100  * suspicious, but generally harmless related to the firmware.
 101  *
 102  * Use it for information or very low priority BIOS bugs.
 103  */
 104 #define FW_BUG          "[Firmware Bug]: "
 105 #define FW_WARN         "[Firmware Warn]: "
 106 #define FW_INFO         "[Firmware Info]: "
 107
 108 /*
 109  * HW_ERR
 110  * Add this to a message for hardware errors, so that user can report
 111  * it to hardware vendor instead of LKML or software vendor.
 112  */
 113 #define HW_ERR          "[Hardware Error]: "
 114
 115 /*
 116  * DEPRECATED
 117  * Add this to a message whenever you want to warn user space about the use
 118  * of a deprecated aspect of an API so they can stop using it
 119  */
 120 #define DEPRECATED      "[Deprecated]: "
 121
 122 /*
 123  * Dummy printk for disabled debugging statements to use whilst maintaining
 124  * gcc's format checking.
 125  */
 126 #define no_printk(fmt, ...)                             \
 127 ({                                                      \
 128         if (0)                                          \
 129                 printk(fmt, ##__VA_ARGS__);             \
 130         0;                                              \
 131 })
 132
 133 #ifdef CONFIG_EARLY_PRINTK
 134 extern asmlinkage __printf(1, 2)
 135 void early_printk(const char *fmt, ...);
 136 #else
 137 static inline __printf(1, 2) __cold
 138 void early_printk(const char *s, ...) { }
 139 #endif
 140
 141 struct dev_printk_info;
 142
 143 #ifdef CONFIG_PRINTK
 144 asmlinkage __printf(4, 0)
 145 int vprintk_emit(int facility, int level,
 146                  const struct dev_printk_info *dev_info,
 147                  const char *fmt, va_list args);
 148
 149 asmlinkage __printf(1, 0)
 150 int vprintk(const char *fmt, va_list args);
 151
 152 asmlinkage __printf(1, 2) __cold
 153 int _printk(const char *fmt, ...);
 154
 155 /*
 156  * Special printk facility for scheduler/timekeeping use only, _DO_NOT_USE_ !
 157  */
 158 __printf(1, 2) __cold int _printk_deferred(const char *fmt, ...);
 159
 160 extern void __printk_safe_enter(void);
 161 extern void __printk_safe_exit(void);
 162 /*
 163  * The printk_deferred_enter/exit macros are available only as a hack for
 164  * some code paths that need to defer all printk console printing. Interrupts
 165  * must be disabled for the deferred duration.
 166  */
 167 #define printk_deferred_enter __printk_safe_enter
 168 #define printk_deferred_exit __printk_safe_exit
 169
 170 /*
 171  * Please don't use printk_ratelimit(), because it shares ratelimiting state
 172  * with all other unrelated printk_ratelimit() callsites.  Instead use
 173  * printk_ratelimited() or plain old __ratelimit().
 174  */
 175 extern int __printk_ratelimit(const char *func);
 176 #define printk_ratelimit() __printk_ratelimit(__func__)
 177 extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
 178                                    unsigned int interval_msec);
 179
 180 extern int printk_delay_msec;
 181 extern int dmesg_restrict;
 182
 183 extern void wake_up_klogd(void);
 184
 185 char *log_buf_addr_get(void);
 186 u32 log_buf_len_get(void);
 187 void log_buf_vmcoreinfo_setup(void);
 188 void __init setup_log_buf(int early);
 189 __printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...);
 190 void dump_stack_print_info(const char *log_lvl);
 191 void show_regs_print_info(const char *log_lvl);
 192 extern asmlinkage void dump_stack_lvl(const char *log_lvl) __cold;
 193 extern asmlinkage void dump_stack(void) __cold;
 194 void printk_trigger_flush(void);
 195 #else
 196 static inline __printf(1, 0)
 197 int vprintk(const char *s, va_list args)
 198 {
 199         return 0;
 200 }
 201 static inline __printf(1, 2) __cold
 202 int _printk(const char *s, ...)
 203 {
 204         return 0;
 205 }
 206 static inline __printf(1, 2) __cold
 207 int _printk_deferred(const char *s, ...)
 208 {
 209         return 0;
 210 }
 211
 212 static inline void printk_deferred_enter(void)
 213 {
 214 }
 215
 216 static inline void printk_deferred_exit(void)
 217 {
 218 }
 219
 220 static inline int printk_ratelimit(void)
 221 {
 222         return 0;
 223 }
 224 static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies,
 225                                           unsigned int interval_msec)
 226 {
 227         return false;
 228 }
 229
 230 static inline void wake_up_klogd(void)
 231 {
 232 }
 233
 234 static inline char *log_buf_addr_get(void)
 235 {
 236         return NULL;
 237 }
 238
 239 static inline u32 log_buf_len_get(void)
 240 {
 241         return 0;
 242 }
 243
 244 static inline void log_buf_vmcoreinfo_setup(void)
 245 {
 246 }
 247
 248 static inline void setup_log_buf(int early)
 249 {
 250 }
 251
 252 static inline __printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...)
 253 {
 254 }
 255
 256 static inline void dump_stack_print_info(const char *log_lvl)
 257 {
 258 }
 259
 260 static inline void show_regs_print_info(const char *log_lvl)
 261 {
 262 }
 263
 264 static inline void dump_stack_lvl(const char *log_lvl)
 265 {
 266 }
 267
 268 static inline void dump_stack(void)
 269 {
 270 }
 271 static inline void printk_trigger_flush(void)
 272 {
 273 }
 274 #endif
 275
 276 bool this_cpu_in_panic(void);
 277
 278 #ifdef CONFIG_SMP
 279 extern int __printk_cpu_sync_try_get(void);
 280 extern void __printk_cpu_sync_wait(void);
 281 extern void __printk_cpu_sync_put(void);
 282
 283 #else
 284
 285 #define __printk_cpu_sync_try_get() true
 286 #define __printk_cpu_sync_wait()
 287 #define __printk_cpu_sync_put()
 288 #endif /* CONFIG_SMP */
 289
 290 /**
 291  * printk_cpu_sync_get_irqsave() - Disable interrupts and acquire the printk
 292  *                                 cpu-reentrant spinning lock.
 293  * @flags: Stack-allocated storage for saving local interrupt state,
 294  *         to be passed to printk_cpu_sync_put_irqrestore().
 295  *
 296  * If the lock is owned by another CPU, spin until it becomes available.
 297  * Interrupts are restored while spinning.
 298  *
 299  * CAUTION: This function must be used carefully. It does not behave like a
 300  * typical lock. Here are important things to watch out for...
 301  *
 302  *     * This function is reentrant on the same CPU. Therefore the calling
 303  *       code must not assume exclusive access to data if code accessing the
 304  *       data can run reentrant or within NMI context on the same CPU.
 305  *
 306  *     * If there exists usage of this function from NMI context, it becomes
 307  *       unsafe to perform any type of locking or spinning to wait for other
 308  *       CPUs after calling this function from any context. This includes
 309  *       using spinlocks or any other busy-waiting synchronization methods.
 310  */
 311 #define printk_cpu_sync_get_irqsave(flags)              \
 312         for (;;) {                                      \
 313                 local_irq_save(flags);                  \
 314                 if (__printk_cpu_sync_try_get())        \
 315                         break;                          \
 316                 local_irq_restore(flags);               \
 317                 __printk_cpu_sync_wait();               \
 318         }
 319
 320 /**
 321  * printk_cpu_sync_put_irqrestore() - Release the printk cpu-reentrant spinning
 322  *                                    lock and restore interrupts.
 323  * @flags: Caller's saved interrupt state, from printk_cpu_sync_get_irqsave().
 324  */
 325 #define printk_cpu_sync_put_irqrestore(flags)   \
 326         do {                                    \
 327                 __printk_cpu_sync_put();        \
 328                 local_irq_restore(flags);       \
 329         } while (0)
 330
 331 extern int kptr_restrict;
 332
 333 /**
 334  * pr_fmt - used by the pr_*() macros to generate the printk format string
 335  * @fmt: format string passed from a pr_*() macro
 336  *
 337  * This macro can be used to generate a unified format string for pr_*()
 338  * macros. A common use is to prefix all pr_*() messages in a file with a common
 339  * string. For example, defining this at the top of a source file:
 340  *
 341  *        #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
 342  *
 343  * would prefix all pr_info, pr_emerg... messages in the file with the module
 344  * name.
 345  */
 346 #ifndef pr_fmt
 347 #define pr_fmt(fmt) fmt
 348 #endif
 349
 350 struct module;
 351
 352 #ifdef CONFIG_PRINTK_INDEX
 353 struct pi_entry {
 354         const char *fmt;
 355         const char *func;
 356         const char *file;
 357         unsigned int line;
 358
 359         /*
 360          * While printk and pr_* have the level stored in the string at compile
 361          * time, some subsystems dynamically add it at runtime through the
 362          * format string. For these dynamic cases, we allow the subsystem to
 363          * tell us the level at compile time.
 364          *
 365          * NULL indicates that the level, if any, is stored in fmt.
 366          */
 367         const char *level;
 368
 369         /*
 370          * The format string used by various subsystem specific printk()
 371          * wrappers to prefix the message.
 372          *
 373          * Note that the static prefix defined by the pr_fmt() macro is stored
 374          * directly in the message format (@fmt), not here.
 375          */
 376         const char *subsys_fmt_prefix;
 377 } __packed;
 378
 379 #define __printk_index_emit(_fmt, _level, _subsys_fmt_prefix)           \
 380         do {                                                            \
 381                 if (__builtin_constant_p(_fmt) && __builtin_constant_p(_level)) { \
 382                         /*
 383                          * We check __builtin_constant_p multiple times here
 384                          * for the same input because GCC will produce an error
 385                          * if we try to assign a static variable to fmt if it
 386                          * is not a constant, even with the outer if statement.
 387                          */                                             \
 388                         static const struct pi_entry _entry             \
 389                         __used = {                                      \
 390                                 .fmt = __builtin_constant_p(_fmt) ? (_fmt) : NULL, \
 391                                 .func = __func__,                       \
 392                                 .file = __FILE__,                       \
 393                                 .line = __LINE__,                       \
 394                                 .level = __builtin_constant_p(_level) ? (_level) : NULL, \
 395                                 .subsys_fmt_prefix = _subsys_fmt_prefix,\
 396                         };                                              \
 397                         static const struct pi_entry *_entry_ptr        \
 398                         __used __section(".printk_index") = &_entry;    \
 399                 }                                                       \
 400         } while (0)
 401
 402 #else /* !CONFIG_PRINTK_INDEX */
 403 #define __printk_index_emit(...) do {} while (0)
 404 #endif /* CONFIG_PRINTK_INDEX */
 405
 406 /*
 407  * Some subsystems have their own custom printk that applies a va_format to a
 408  * generic format, for example, to include a device number or other metadata
 409  * alongside the format supplied by the caller.
 410  *
 411  * In order to store these in the way they would be emitted by the printk
 412  * infrastructure, the subsystem provides us with the start, fixed string, and
 413  * any subsequent text in the format string.
 414  *
 415  * We take a variable argument list as pr_fmt/dev_fmt/etc are sometimes passed
 416  * as multiple arguments (eg: `"%s: ", "blah"`), and we must only take the
 417  * first one.
 418  *
 419  * subsys_fmt_prefix must be known at compile time, or compilation will fail
 420  * (since this is a mistake). If fmt or level is not known at compile time, no
 421  * index entry will be made (since this can legitimately happen).
 422  */
 423 #define printk_index_subsys_emit(subsys_fmt_prefix, level, fmt, ...) \
 424         __printk_index_emit(fmt, level, subsys_fmt_prefix)
 425
 426 #define printk_index_wrap(_p_func, _fmt, ...)                           \
 427         ({                                                              \
 428                 __printk_index_emit(_fmt, NULL, NULL);                  \
 429                 _p_func(_fmt, ##__VA_ARGS__);                           \
 430         })
 431
 432
 433 /**
 434  * printk - print a kernel message
 435  * @fmt: format string
 436  *
 437  * This is printk(). It can be called from any context. We want it to work.
 438  *
 439  * If printk indexing is enabled, _printk() is called from printk_index_wrap.
 440  * Otherwise, printk is simply #defined to _printk.
 441  *
 442  * We try to grab the console_lock. If we succeed, it's easy - we log the
 443  * output and call the console drivers.  If we fail to get the semaphore, we
 444  * place the output into the log buffer and return. The current holder of
 445  * the console_sem will notice the new output in console_unlock(); and will
 446  * send it to the consoles before releasing the lock.
 447  *
 448  * One effect of this deferred printing is that code which calls printk() and
 449  * then changes console_loglevel may break. This is because console_loglevel
 450  * is inspected when the actual printing occurs.
 451  *
 452  * See also:
 453  * printf(3)
 454  *
 455  * See the vsnprintf() documentation for format string extensions over C99.
 456  */
 457 #define printk(fmt, ...) printk_index_wrap(_printk, fmt, ##__VA_ARGS__)
 458 #define printk_deferred(fmt, ...)                                       \
 459         printk_index_wrap(_printk_deferred, fmt, ##__VA_ARGS__)
 460
 461 /**
 462  * pr_emerg - Print an emergency-level message
 463  * @fmt: format string
 464  * @...: arguments for the format string
 465  *
 466  * This macro expands to a printk with KERN_EMERG loglevel. It uses pr_fmt() to
 467  * generate the format string.
 468  */
 469 #define pr_emerg(fmt, ...) \
 470         printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 471 /**
 472  * pr_alert - Print an alert-level message
 473  * @fmt: format string
 474  * @...: arguments for the format string
 475  *
 476  * This macro expands to a printk with KERN_ALERT loglevel. It uses pr_fmt() to
 477  * generate the format string.
 478  */
 479 #define pr_alert(fmt, ...) \
 480         printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 481 /**
 482  * pr_crit - Print a critical-level message
 483  * @fmt: format string
 484  * @...: arguments for the format string
 485  *
 486  * This macro expands to a printk with KERN_CRIT loglevel. It uses pr_fmt() to
 487  * generate the format string.
 488  */
 489 #define pr_crit(fmt, ...) \
 490         printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 491 /**
 492  * pr_err - Print an error-level message
 493  * @fmt: format string
 494  * @...: arguments for the format string
 495  *
 496  * This macro expands to a printk with KERN_ERR loglevel. It uses pr_fmt() to
 497  * generate the format string.
 498  */
 499 #define pr_err(fmt, ...) \
 500         printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 501 /**
 502  * pr_warn - Print a warning-level message
 503  * @fmt: format string
 504  * @...: arguments for the format string
 505  *
 506  * This macro expands to a printk with KERN_WARNING loglevel. It uses pr_fmt()
 507  * to generate the format string.
 508  */
 509 #define pr_warn(fmt, ...) \
 510         printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 511 /**
 512  * pr_notice - Print a notice-level message
 513  * @fmt: format string
 514  * @...: arguments for the format string
 515  *
 516  * This macro expands to a printk with KERN_NOTICE loglevel. It uses pr_fmt() to
 517  * generate the format string.
 518  */
 519 #define pr_notice(fmt, ...) \
 520         printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 521 /**
 522  * pr_info - Print an info-level message
 523  * @fmt: format string
 524  * @...: arguments for the format string
 525  *
 526  * This macro expands to a printk with KERN_INFO loglevel. It uses pr_fmt() to
 527  * generate the format string.
 528  */
 529 #define pr_info(fmt, ...) \
 530         printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 531
 532 /**
 533  * pr_cont - Continues a previous log message in the same line.
 534  * @fmt: format string
 535  * @...: arguments for the format string
 536  *
 537  * This macro expands to a printk with KERN_CONT loglevel. It should only be
 538  * used when continuing a log message with no newline ('\n') enclosed. Otherwise
 539  * it defaults back to KERN_DEFAULT loglevel.
 540  */
 541 #define pr_cont(fmt, ...) \
 542         printk(KERN_CONT fmt, ##__VA_ARGS__)
 543
 544 /**
 545  * pr_devel - Print a debug-level message conditionally
 546  * @fmt: format string
 547  * @...: arguments for the format string
 548  *
 549  * This macro expands to a printk with KERN_DEBUG loglevel if DEBUG is
 550  * defined. Otherwise it does nothing.
 551  *
 552  * It uses pr_fmt() to generate the format string.
 553  */
 554 #ifdef DEBUG
 555 #define pr_devel(fmt, ...) \
 556         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 557 #else
 558 #define pr_devel(fmt, ...) \
 559         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 560 #endif
 561
 562
 563 /* If you are writing a driver, please use dev_dbg instead */
 564 #if defined(CONFIG_DYNAMIC_DEBUG) || \
 565         (defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
 566 #include <linux/dynamic_debug.h>
 567
 568 /**
 569  * pr_debug - Print a debug-level message conditionally
 570  * @fmt: format string
 571  * @...: arguments for the format string
 572  *
 573  * This macro expands to dynamic_pr_debug() if CONFIG_DYNAMIC_DEBUG is
 574  * set. Otherwise, if DEBUG is defined, it's equivalent to a printk with
 575  * KERN_DEBUG loglevel. If DEBUG is not defined it does nothing.
 576  *
 577  * It uses pr_fmt() to generate the format string (dynamic_pr_debug() uses
 578  * pr_fmt() internally).
 579  */
 580 #define pr_debug(fmt, ...)                      \
 581         dynamic_pr_debug(fmt, ##__VA_ARGS__)
 582 #elif defined(DEBUG)
 583 #define pr_debug(fmt, ...) \
 584         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 585 #else
 586 #define pr_debug(fmt, ...) \
 587         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 588 #endif
 589
 590 /*
 591  * Print a one-time message (analogous to WARN_ONCE() et al):
 592  */
 593
 594 #ifdef CONFIG_PRINTK
 595 #define printk_once(fmt, ...)                                   \
 596         DO_ONCE_LITE(printk, fmt, ##__VA_ARGS__)
 597 #define printk_deferred_once(fmt, ...)                          \
 598         DO_ONCE_LITE(printk_deferred, fmt, ##__VA_ARGS__)
 599 #else
 600 #define printk_once(fmt, ...)                                   \
 601         no_printk(fmt, ##__VA_ARGS__)
 602 #define printk_deferred_once(fmt, ...)                          \
 603         no_printk(fmt, ##__VA_ARGS__)
 604 #endif
 605
 606 #define pr_emerg_once(fmt, ...)                                 \
 607         printk_once(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 608 #define pr_alert_once(fmt, ...)                                 \
 609         printk_once(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 610 #define pr_crit_once(fmt, ...)                                  \
 611         printk_once(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 612 #define pr_err_once(fmt, ...)                                   \
 613         printk_once(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 614 #define pr_warn_once(fmt, ...)                                  \
 615         printk_once(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 616 #define pr_notice_once(fmt, ...)                                \
 617         printk_once(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 618 #define pr_info_once(fmt, ...)                                  \
 619         printk_once(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 620 /* no pr_cont_once, don't do that... */
 621
 622 #if defined(DEBUG)
 623 #define pr_devel_once(fmt, ...)                                 \
 624         printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 625 #else
 626 #define pr_devel_once(fmt, ...)                                 \
 627         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 628 #endif
 629
 630 /* If you are writing a driver, please use dev_dbg instead */
 631 #if defined(DEBUG)
 632 #define pr_debug_once(fmt, ...)                                 \
 633         printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 634 #else
 635 #define pr_debug_once(fmt, ...)                                 \
 636         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 637 #endif
 638
 639 /*
 640  * ratelimited messages with local ratelimit_state,
 641  * no local ratelimit_state used in the !PRINTK case
 642  */
 643 #ifdef CONFIG_PRINTK
 644 #define printk_ratelimited(fmt, ...)                                    \
 645 ({                                                                      \
 646         static DEFINE_RATELIMIT_STATE(_rs,                              \
 647                                       DEFAULT_RATELIMIT_INTERVAL,       \
 648                                       DEFAULT_RATELIMIT_BURST);         \
 649                                                                         \
 650         if (__ratelimit(&_rs))                                          \
 651                 printk(fmt, ##__VA_ARGS__);                             \
 652 })
 653 #else
 654 #define printk_ratelimited(fmt, ...)                                    \
 655         no_printk(fmt, ##__VA_ARGS__)
 656 #endif
 657
 658 #define pr_emerg_ratelimited(fmt, ...)                                  \
 659         printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 660 #define pr_alert_ratelimited(fmt, ...)                                  \
 661         printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 662 #define pr_crit_ratelimited(fmt, ...)                                   \
 663         printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 664 #define pr_err_ratelimited(fmt, ...)                                    \
 665         printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 666 #define pr_warn_ratelimited(fmt, ...)                                   \
 667         printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 668 #define pr_notice_ratelimited(fmt, ...)                                 \
 669         printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 670 #define pr_info_ratelimited(fmt, ...)                                   \
 671         printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 672 /* no pr_cont_ratelimited, don't do that... */
 673
 674 #if defined(DEBUG)
 675 #define pr_devel_ratelimited(fmt, ...)                                  \
 676         printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 677 #else
 678 #define pr_devel_ratelimited(fmt, ...)                                  \
 679         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 680 #endif
 681
 682 /* If you are writing a driver, please use dev_dbg instead */
 683 #if defined(CONFIG_DYNAMIC_DEBUG) || \
 684         (defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
 685 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
 686 #define pr_debug_ratelimited(fmt, ...)                                  \
 687 do {                                                                    \
 688         static DEFINE_RATELIMIT_STATE(_rs,                              \
 689                                       DEFAULT_RATELIMIT_INTERVAL,       \
 690                                       DEFAULT_RATELIMIT_BURST);         \
 691         DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, pr_fmt(fmt));         \
 692         if (DYNAMIC_DEBUG_BRANCH(descriptor) &&                         \
 693             __ratelimit(&_rs))                                          \
 694                 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), ##__VA_ARGS__);    \
 695 } while (0)
 696 #elif defined(DEBUG)
 697 #define pr_debug_ratelimited(fmt, ...)                                  \
 698         printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 699 #else
 700 #define pr_debug_ratelimited(fmt, ...) \
 701         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 702 #endif
 703
 704 extern const struct file_operations kmsg_fops;
 705
 706 enum {
 707         DUMP_PREFIX_NONE,
 708         DUMP_PREFIX_ADDRESS,
 709         DUMP_PREFIX_OFFSET
 710 };
 711 extern int hex_dump_to_buffer(const void *buf, size_t len, int rowsize,
 712                               int groupsize, char *linebuf, size_t linebuflen,
 713                               bool ascii);
 714 #ifdef CONFIG_PRINTK
 715 extern void print_hex_dump(const char *level, const char *prefix_str,
 716                            int prefix_type, int rowsize, int groupsize,
 717                            const void *buf, size_t len, bool ascii);
 718 #else
 719 static inline void print_hex_dump(const char *level, const char *prefix_str,
 720                                   int prefix_type, int rowsize, int groupsize,
 721                                   const void *buf, size_t len, bool ascii)
 722 {
 723 }
 724 static inline void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
 725                                         const void *buf, size_t len)
 726 {
 727 }
 728
 729 #endif
 730
 731 #if defined(CONFIG_DYNAMIC_DEBUG) || \
 732         (defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
 733 #define print_hex_dump_debug(prefix_str, prefix_type, rowsize,  \
 734                              groupsize, buf, len, ascii)        \
 735         dynamic_hex_dump(prefix_str, prefix_type, rowsize,      \
 736                          groupsize, buf, len, ascii)
 737 #elif defined(DEBUG)
 738 #define print_hex_dump_debug(prefix_str, prefix_type, rowsize,          \
 739                              groupsize, buf, len, ascii)                \
 740         print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, rowsize,    \
 741                        groupsize, buf, len, ascii)
 742 #else
 743 static inline void print_hex_dump_debug(const char *prefix_str, int prefix_type,
 744                                         int rowsize, int groupsize,
 745                                         const void *buf, size_t len, bool ascii)
 746 {
 747 }
 748 #endif
 749
 750 /**
 751  * print_hex_dump_bytes - shorthand form of print_hex_dump() with default params
 752  * @prefix_str: string to prefix each line with;
 753  *  caller supplies trailing spaces for alignment if desired
 754  * @prefix_type: controls whether prefix of an offset, address, or none
 755  *  is printed (%DUMP_PREFIX_OFFSET, %DUMP_PREFIX_ADDRESS, %DUMP_PREFIX_NONE)
 756  * @buf: data blob to dump
 757  * @len: number of bytes in the @buf
 758  *
 759  * Calls print_hex_dump(), with log level of KERN_DEBUG,
 760  * rowsize of 16, groupsize of 1, and ASCII output included.
 761  */
 762 #define print_hex_dump_bytes(prefix_str, prefix_type, buf, len) \
 763         print_hex_dump_debug(prefix_str, prefix_type, 16, 1, buf, len, true)
 764
 765 #endif