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