include/linux/printk.h

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