include/linux/printk.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __KERNEL_PRINTK__
   3 #define __KERNEL_PRINTK__
   4
   5 #include <stdarg.h>
   6 #include <linux/init.h>
   7 #include <linux/kern_levels.h>
   8 #include <linux/linkage.h>
   9 #include <linux/cache.h>
  10 #include <linux/ratelimit_types.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 #define CONSOLE_EXT_LOG_MAX     8192
  48
  49 /* printk's without a loglevel use this.. */
  50 #define MESSAGE_LOGLEVEL_DEFAULT CONFIG_MESSAGE_LOGLEVEL_DEFAULT
  51
  52 /* We show everything that is MORE important than this.. */
  53 #define CONSOLE_LOGLEVEL_SILENT  0 /* Mum's the word */
  54 #define CONSOLE_LOGLEVEL_MIN     1 /* Minimum loglevel we let people use */
  55 #define CONSOLE_LOGLEVEL_DEBUG  10 /* issue debug messages */
  56 #define CONSOLE_LOGLEVEL_MOTORMOUTH 15  /* You can't shut this one up */
  57
  58 /*
  59  * Default used to be hard-coded at 7, quiet used to be hardcoded at 4,
  60  * we're now allowing both to be set from kernel config.
  61  */
  62 #define CONSOLE_LOGLEVEL_DEFAULT CONFIG_CONSOLE_LOGLEVEL_DEFAULT
  63 #define CONSOLE_LOGLEVEL_QUIET   CONFIG_CONSOLE_LOGLEVEL_QUIET
  64
  65 extern int console_printk[];
  66
  67 #define console_loglevel (console_printk[0])
  68 #define default_message_loglevel (console_printk[1])
  69 #define minimum_console_loglevel (console_printk[2])
  70 #define default_console_loglevel (console_printk[3])
  71
  72 static inline void console_silent(void)
  73 {
  74         console_loglevel = CONSOLE_LOGLEVEL_SILENT;
  75 }
  76
  77 static inline void console_verbose(void)
  78 {
  79         if (console_loglevel)
  80                 console_loglevel = CONSOLE_LOGLEVEL_MOTORMOUTH;
  81 }
  82
  83 /* strlen("ratelimit") + 1 */
  84 #define DEVKMSG_STR_MAX_SIZE 10
  85 extern char devkmsg_log_str[];
  86 struct ctl_table;
  87
  88 extern int suppress_printk;
  89
  90 struct va_format {
  91         const char *fmt;
  92         va_list *va;
  93 };
  94
  95 /*
  96  * FW_BUG
  97  * Add this to a message where you are sure the firmware is buggy or behaves
  98  * really stupid or out of spec. Be aware that the responsible BIOS developer
  99  * should be able to fix this issue or at least get a concrete idea of the
 100  * problem by reading your message without the need of looking at the kernel
 101  * code.
 102  *
 103  * Use it for definite and high priority BIOS bugs.
 104  *
 105  * FW_WARN
 106  * Use it for not that clear (e.g. could the kernel messed up things already?)
 107  * and medium priority BIOS bugs.
 108  *
 109  * FW_INFO
 110  * Use this one if you want to tell the user or vendor about something
 111  * suspicious, but generally harmless related to the firmware.
 112  *
 113  * Use it for information or very low priority BIOS bugs.
 114  */
 115 #define FW_BUG          "[Firmware Bug]: "
 116 #define FW_WARN         "[Firmware Warn]: "
 117 #define FW_INFO         "[Firmware Info]: "
 118
 119 /*
 120  * HW_ERR
 121  * Add this to a message for hardware errors, so that user can report
 122  * it to hardware vendor instead of LKML or software vendor.
 123  */
 124 #define HW_ERR          "[Hardware Error]: "
 125
 126 /*
 127  * DEPRECATED
 128  * Add this to a message whenever you want to warn user space about the use
 129  * of a deprecated aspect of an API so they can stop using it
 130  */
 131 #define DEPRECATED      "[Deprecated]: "
 132
 133 /*
 134  * Dummy printk for disabled debugging statements to use whilst maintaining
 135  * gcc's format checking.
 136  */
 137 #define no_printk(fmt, ...)                             \
 138 ({                                                      \
 139         if (0)                                          \
 140                 printk(fmt, ##__VA_ARGS__);             \
 141         0;                                              \
 142 })
 143
 144 #ifdef CONFIG_EARLY_PRINTK
 145 extern asmlinkage __printf(1, 2)
 146 void early_printk(const char *fmt, ...);
 147 #else
 148 static inline __printf(1, 2) __cold
 149 void early_printk(const char *s, ...) { }
 150 #endif
 151
 152 #ifdef CONFIG_PRINTK_NMI
 153 extern void printk_nmi_enter(void);
 154 extern void printk_nmi_exit(void);
 155 extern void printk_nmi_direct_enter(void);
 156 extern void printk_nmi_direct_exit(void);
 157 #else
 158 static inline void printk_nmi_enter(void) { }
 159 static inline void printk_nmi_exit(void) { }
 160 static inline void printk_nmi_direct_enter(void) { }
 161 static inline void printk_nmi_direct_exit(void) { }
 162 #endif /* PRINTK_NMI */
 163
 164 struct dev_printk_info;
 165
 166 #ifdef CONFIG_PRINTK
 167 asmlinkage __printf(4, 0)
 168 int vprintk_emit(int facility, int level,
 169                  const struct dev_printk_info *dev_info,
 170                  const char *fmt, va_list args);
 171
 172 asmlinkage __printf(1, 0)
 173 int vprintk(const char *fmt, va_list args);
 174
 175 asmlinkage __printf(1, 2) __cold
 176 int printk(const char *fmt, ...);
 177
 178 /*
 179  * Special printk facility for scheduler/timekeeping use only, _DO_NOT_USE_ !
 180  */
 181 __printf(1, 2) __cold int printk_deferred(const char *fmt, ...);
 182
 183 /*
 184  * Please don't use printk_ratelimit(), because it shares ratelimiting state
 185  * with all other unrelated printk_ratelimit() callsites.  Instead use
 186  * printk_ratelimited() or plain old __ratelimit().
 187  */
 188 extern int __printk_ratelimit(const char *func);
 189 #define printk_ratelimit() __printk_ratelimit(__func__)
 190 extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
 191                                    unsigned int interval_msec);
 192
 193 extern int printk_delay_msec;
 194 extern int dmesg_restrict;
 195
 196 extern int
 197 devkmsg_sysctl_set_loglvl(struct ctl_table *table, int write, void *buf,
 198                           size_t *lenp, loff_t *ppos);
 199
 200 extern void wake_up_klogd(void);
 201
 202 char *log_buf_addr_get(void);
 203 u32 log_buf_len_get(void);
 204 void log_buf_vmcoreinfo_setup(void);
 205 void __init setup_log_buf(int early);
 206 __printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...);
 207 void dump_stack_print_info(const char *log_lvl);
 208 void show_regs_print_info(const char *log_lvl);
 209 extern asmlinkage void dump_stack_lvl(const char *log_lvl) __cold;
 210 extern asmlinkage void dump_stack(void) __cold;
 211 extern void printk_safe_flush(void);
 212 extern void printk_safe_flush_on_panic(void);
 213 #else
 214 static inline __printf(1, 0)
 215 int vprintk(const char *s, va_list args)
 216 {
 217         return 0;
 218 }
 219 static inline __printf(1, 2) __cold
 220 int printk(const char *s, ...)
 221 {
 222         return 0;
 223 }
 224 static inline __printf(1, 2) __cold
 225 int printk_deferred(const char *s, ...)
 226 {
 227         return 0;
 228 }
 229 static inline int printk_ratelimit(void)
 230 {
 231         return 0;
 232 }
 233 static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies,
 234                                           unsigned int interval_msec)
 235 {
 236         return false;
 237 }
 238
 239 static inline void wake_up_klogd(void)
 240 {
 241 }
 242
 243 static inline char *log_buf_addr_get(void)
 244 {
 245         return NULL;
 246 }
 247
 248 static inline u32 log_buf_len_get(void)
 249 {
 250         return 0;
 251 }
 252
 253 static inline void log_buf_vmcoreinfo_setup(void)
 254 {
 255 }
 256
 257 static inline void setup_log_buf(int early)
 258 {
 259 }
 260
 261 static inline __printf(1, 2) void dump_stack_set_arch_desc(const char *fmt, ...)
 262 {
 263 }
 264
 265 static inline void dump_stack_print_info(const char *log_lvl)
 266 {
 267 }
 268
 269 static inline void show_regs_print_info(const char *log_lvl)
 270 {
 271 }
 272
 273 static inline void dump_stack_lvl(const char *log_lvl)
 274 {
 275 }
 276
 277 static inline void dump_stack(void)
 278 {
 279 }
 280
 281 static inline void printk_safe_flush(void)
 282 {
 283 }
 284
 285 static inline void printk_safe_flush_on_panic(void)
 286 {
 287 }
 288 #endif
 289
 290 #ifdef CONFIG_SMP
 291 extern int __printk_cpu_trylock(void);
 292 extern void __printk_wait_on_cpu_lock(void);
 293 extern void __printk_cpu_unlock(void);
 294
 295 /**
 296  * printk_cpu_lock_irqsave() - Acquire the printk cpu-reentrant spinning
 297  *                             lock and disable interrupts.
 298  * @flags: Stack-allocated storage for saving local interrupt state,
 299  *         to be passed to printk_cpu_unlock_irqrestore().
 300  *
 301  * If the lock is owned by another CPU, spin until it becomes available.
 302  * Interrupts are restored while spinning.
 303  */
 304 #define printk_cpu_lock_irqsave(flags)          \
 305         for (;;) {                              \
 306                 local_irq_save(flags);          \
 307                 if (__printk_cpu_trylock())     \
 308                         break;                  \
 309                 local_irq_restore(flags);       \
 310                 __printk_wait_on_cpu_lock();    \
 311         }
 312
 313 /**
 314  * printk_cpu_unlock_irqrestore() - Release the printk cpu-reentrant spinning
 315  *                                  lock and restore interrupts.
 316  * @flags: Caller's saved interrupt state, from printk_cpu_lock_irqsave().
 317  */
 318 #define printk_cpu_unlock_irqrestore(flags)     \
 319         do {                                    \
 320                 __printk_cpu_unlock();          \
 321                 local_irq_restore(flags);       \
 322         } while (0)                             \
 323
 324 #else
 325
 326 #define printk_cpu_lock_irqsave(flags) ((void)flags)
 327 #define printk_cpu_unlock_irqrestore(flags) ((void)flags)
 328
 329 #endif /* CONFIG_SMP */
 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 /**
 351  * pr_emerg - Print an emergency-level message
 352  * @fmt: format string
 353  * @...: arguments for the format string
 354  *
 355  * This macro expands to a printk with KERN_EMERG loglevel. It uses pr_fmt() to
 356  * generate the format string.
 357  */
 358 #define pr_emerg(fmt, ...) \
 359         printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 360 /**
 361  * pr_alert - Print an alert-level message
 362  * @fmt: format string
 363  * @...: arguments for the format string
 364  *
 365  * This macro expands to a printk with KERN_ALERT loglevel. It uses pr_fmt() to
 366  * generate the format string.
 367  */
 368 #define pr_alert(fmt, ...) \
 369         printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 370 /**
 371  * pr_crit - Print a critical-level message
 372  * @fmt: format string
 373  * @...: arguments for the format string
 374  *
 375  * This macro expands to a printk with KERN_CRIT loglevel. It uses pr_fmt() to
 376  * generate the format string.
 377  */
 378 #define pr_crit(fmt, ...) \
 379         printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 380 /**
 381  * pr_err - Print an error-level message
 382  * @fmt: format string
 383  * @...: arguments for the format string
 384  *
 385  * This macro expands to a printk with KERN_ERR loglevel. It uses pr_fmt() to
 386  * generate the format string.
 387  */
 388 #define pr_err(fmt, ...) \
 389         printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 390 /**
 391  * pr_warn - Print a warning-level message
 392  * @fmt: format string
 393  * @...: arguments for the format string
 394  *
 395  * This macro expands to a printk with KERN_WARNING loglevel. It uses pr_fmt()
 396  * to generate the format string.
 397  */
 398 #define pr_warn(fmt, ...) \
 399         printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 400 /**
 401  * pr_notice - Print a notice-level message
 402  * @fmt: format string
 403  * @...: arguments for the format string
 404  *
 405  * This macro expands to a printk with KERN_NOTICE loglevel. It uses pr_fmt() to
 406  * generate the format string.
 407  */
 408 #define pr_notice(fmt, ...) \
 409         printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 410 /**
 411  * pr_info - Print an info-level message
 412  * @fmt: format string
 413  * @...: arguments for the format string
 414  *
 415  * This macro expands to a printk with KERN_INFO loglevel. It uses pr_fmt() to
 416  * generate the format string.
 417  */
 418 #define pr_info(fmt, ...) \
 419         printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 420
 421 /**
 422  * pr_cont - Continues a previous log message in the same line.
 423  * @fmt: format string
 424  * @...: arguments for the format string
 425  *
 426  * This macro expands to a printk with KERN_CONT loglevel. It should only be
 427  * used when continuing a log message with no newline ('\n') enclosed. Otherwise
 428  * it defaults back to KERN_DEFAULT loglevel.
 429  */
 430 #define pr_cont(fmt, ...) \
 431         printk(KERN_CONT fmt, ##__VA_ARGS__)
 432
 433 /**
 434  * pr_devel - Print a debug-level message conditionally
 435  * @fmt: format string
 436  * @...: arguments for the format string
 437  *
 438  * This macro expands to a printk with KERN_DEBUG loglevel if DEBUG is
 439  * defined. Otherwise it does nothing.
 440  *
 441  * It uses pr_fmt() to generate the format string.
 442  */
 443 #ifdef DEBUG
 444 #define pr_devel(fmt, ...) \
 445         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 446 #else
 447 #define pr_devel(fmt, ...) \
 448         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 449 #endif
 450
 451
 452 /* If you are writing a driver, please use dev_dbg instead */
 453 #if defined(CONFIG_DYNAMIC_DEBUG) || \
 454         (defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
 455 #include <linux/dynamic_debug.h>
 456
 457 /**
 458  * pr_debug - Print a debug-level message conditionally
 459  * @fmt: format string
 460  * @...: arguments for the format string
 461  *
 462  * This macro expands to dynamic_pr_debug() if CONFIG_DYNAMIC_DEBUG is
 463  * set. Otherwise, if DEBUG is defined, it's equivalent to a printk with
 464  * KERN_DEBUG loglevel. If DEBUG is not defined it does nothing.
 465  *
 466  * It uses pr_fmt() to generate the format string (dynamic_pr_debug() uses
 467  * pr_fmt() internally).
 468  */
 469 #define pr_debug(fmt, ...)                      \
 470         dynamic_pr_debug(fmt, ##__VA_ARGS__)
 471 #elif defined(DEBUG)
 472 #define pr_debug(fmt, ...) \
 473         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 474 #else
 475 #define pr_debug(fmt, ...) \
 476         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 477 #endif
 478
 479 /*
 480  * Print a one-time message (analogous to WARN_ONCE() et al):
 481  */
 482
 483 #ifdef CONFIG_PRINTK
 484 #define printk_once(fmt, ...)                                   \
 485 ({                                                              \
 486         static bool __section(".data.once") __print_once;       \
 487         bool __ret_print_once = !__print_once;                  \
 488                                                                 \
 489         if (!__print_once) {                                    \
 490                 __print_once = true;                            \
 491                 printk(fmt, ##__VA_ARGS__);                     \
 492         }                                                       \
 493         unlikely(__ret_print_once);                             \
 494 })
 495 #define printk_deferred_once(fmt, ...)                          \
 496 ({                                                              \
 497         static bool __section(".data.once") __print_once;       \
 498         bool __ret_print_once = !__print_once;                  \
 499                                                                 \
 500         if (!__print_once) {                                    \
 501                 __print_once = true;                            \
 502                 printk_deferred(fmt, ##__VA_ARGS__);            \
 503         }                                                       \
 504         unlikely(__ret_print_once);                             \
 505 })
 506 #else
 507 #define printk_once(fmt, ...)                                   \
 508         no_printk(fmt, ##__VA_ARGS__)
 509 #define printk_deferred_once(fmt, ...)                          \
 510         no_printk(fmt, ##__VA_ARGS__)
 511 #endif
 512
 513 #define pr_emerg_once(fmt, ...)                                 \
 514         printk_once(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 515 #define pr_alert_once(fmt, ...)                                 \
 516         printk_once(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 517 #define pr_crit_once(fmt, ...)                                  \
 518         printk_once(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 519 #define pr_err_once(fmt, ...)                                   \
 520         printk_once(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 521 #define pr_warn_once(fmt, ...)                                  \
 522         printk_once(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 523 #define pr_notice_once(fmt, ...)                                \
 524         printk_once(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 525 #define pr_info_once(fmt, ...)                                  \
 526         printk_once(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 527 /* no pr_cont_once, don't do that... */
 528
 529 #if defined(DEBUG)
 530 #define pr_devel_once(fmt, ...)                                 \
 531         printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 532 #else
 533 #define pr_devel_once(fmt, ...)                                 \
 534         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 535 #endif
 536
 537 /* If you are writing a driver, please use dev_dbg instead */
 538 #if defined(DEBUG)
 539 #define pr_debug_once(fmt, ...)                                 \
 540         printk_once(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 541 #else
 542 #define pr_debug_once(fmt, ...)                                 \
 543         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 544 #endif
 545
 546 /*
 547  * ratelimited messages with local ratelimit_state,
 548  * no local ratelimit_state used in the !PRINTK case
 549  */
 550 #ifdef CONFIG_PRINTK
 551 #define printk_ratelimited(fmt, ...)                                    \
 552 ({                                                                      \
 553         static DEFINE_RATELIMIT_STATE(_rs,                              \
 554                                       DEFAULT_RATELIMIT_INTERVAL,       \
 555                                       DEFAULT_RATELIMIT_BURST);         \
 556                                                                         \
 557         if (__ratelimit(&_rs))                                          \
 558                 printk(fmt, ##__VA_ARGS__);                             \
 559 })
 560 #else
 561 #define printk_ratelimited(fmt, ...)                                    \
 562         no_printk(fmt, ##__VA_ARGS__)
 563 #endif
 564
 565 #define pr_emerg_ratelimited(fmt, ...)                                  \
 566         printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 567 #define pr_alert_ratelimited(fmt, ...)                                  \
 568         printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 569 #define pr_crit_ratelimited(fmt, ...)                                   \
 570         printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 571 #define pr_err_ratelimited(fmt, ...)                                    \
 572         printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 573 #define pr_warn_ratelimited(fmt, ...)                                   \
 574         printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 575 #define pr_notice_ratelimited(fmt, ...)                                 \
 576         printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 577 #define pr_info_ratelimited(fmt, ...)                                   \
 578         printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 579 /* no pr_cont_ratelimited, don't do that... */
 580
 581 #if defined(DEBUG)
 582 #define pr_devel_ratelimited(fmt, ...)                                  \
 583         printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 584 #else
 585 #define pr_devel_ratelimited(fmt, ...)                                  \
 586         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 587 #endif
 588
 589 /* If you are writing a driver, please use dev_dbg instead */
 590 #if defined(CONFIG_DYNAMIC_DEBUG) || \
 591         (defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
 592 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
 593 #define pr_debug_ratelimited(fmt, ...)                                  \
 594 do {                                                                    \
 595         static DEFINE_RATELIMIT_STATE(_rs,                              \
 596                                       DEFAULT_RATELIMIT_INTERVAL,       \
 597                                       DEFAULT_RATELIMIT_BURST);         \
 598         DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, pr_fmt(fmt));         \
 599         if (DYNAMIC_DEBUG_BRANCH(descriptor) &&                         \
 600             __ratelimit(&_rs))                                          \
 601                 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), ##__VA_ARGS__);    \
 602 } while (0)
 603 #elif defined(DEBUG)
 604 #define pr_debug_ratelimited(fmt, ...)                                  \
 605         printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 606 #else
 607 #define pr_debug_ratelimited(fmt, ...) \
 608         no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 609 #endif
 610
 611 extern const struct file_operations kmsg_fops;
 612
 613 enum {
 614         DUMP_PREFIX_NONE,
 615         DUMP_PREFIX_ADDRESS,
 616         DUMP_PREFIX_OFFSET
 617 };
 618 extern int hex_dump_to_buffer(const void *buf, size_t len, int rowsize,
 619                               int groupsize, char *linebuf, size_t linebuflen,
 620                               bool ascii);
 621 #ifdef CONFIG_PRINTK
 622 extern void print_hex_dump(const char *level, const char *prefix_str,
 623                            int prefix_type, int rowsize, int groupsize,
 624                            const void *buf, size_t len, bool ascii);
 625 #else
 626 static inline void print_hex_dump(const char *level, const char *prefix_str,
 627                                   int prefix_type, int rowsize, int groupsize,
 628                                   const void *buf, size_t len, bool ascii)
 629 {
 630 }
 631 static inline void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
 632                                         const void *buf, size_t len)
 633 {
 634 }
 635
 636 #endif
 637
 638 #if defined(CONFIG_DYNAMIC_DEBUG) || \
 639         (defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
 640 #define print_hex_dump_debug(prefix_str, prefix_type, rowsize,  \
 641                              groupsize, buf, len, ascii)        \
 642         dynamic_hex_dump(prefix_str, prefix_type, rowsize,      \
 643                          groupsize, buf, len, ascii)
 644 #elif defined(DEBUG)
 645 #define print_hex_dump_debug(prefix_str, prefix_type, rowsize,          \
 646                              groupsize, buf, len, ascii)                \
 647         print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, rowsize,    \
 648                        groupsize, buf, len, ascii)
 649 #else
 650 static inline void print_hex_dump_debug(const char *prefix_str, int prefix_type,
 651                                         int rowsize, int groupsize,
 652                                         const void *buf, size_t len, bool ascii)
 653 {
 654 }
 655 #endif
 656
 657 /**
 658  * print_hex_dump_bytes - shorthand form of print_hex_dump() with default params
 659  * @prefix_str: string to prefix each line with;
 660  *  caller supplies trailing spaces for alignment if desired
 661  * @prefix_type: controls whether prefix of an offset, address, or none
 662  *  is printed (%DUMP_PREFIX_OFFSET, %DUMP_PREFIX_ADDRESS, %DUMP_PREFIX_NONE)
 663  * @buf: data blob to dump
 664  * @len: number of bytes in the @buf
 665  *
 666  * Calls print_hex_dump(), with log level of KERN_DEBUG,
 667  * rowsize of 16, groupsize of 1, and ASCII output included.
 668  */
 669 #define print_hex_dump_bytes(prefix_str, prefix_type, buf, len) \
 670         print_hex_dump_debug(prefix_str, prefix_type, 16, 1, buf, len, true)
 671
 672 #endif