include/linux/printk.h

   1 #ifndef __KERNEL_PRINTK__
   2 #define __KERNEL_PRINTK__
   3
   4 extern const char linux_banner[];
   5 extern const char linux_proc_banner[];
   6
   7 #define KERN_EMERG      "<0>"   /* system is unusable                   */
   8 #define KERN_ALERT      "<1>"   /* action must be taken immediately     */
   9 #define KERN_CRIT       "<2>"   /* critical conditions                  */
  10 #define KERN_ERR        "<3>"   /* error conditions                     */
  11 #define KERN_WARNING    "<4>"   /* warning conditions                   */
  12 #define KERN_NOTICE     "<5>"   /* normal but significant condition     */
  13 #define KERN_INFO       "<6>"   /* informational                        */
  14 #define KERN_DEBUG      "<7>"   /* debug-level messages                 */
  15
  16 /* Use the default kernel loglevel */
  17 #define KERN_DEFAULT    "<d>"
  18 /*
  19  * Annotation for a "continued" line of log printout (only done after a
  20  * line that had no enclosing \n). Only to be used by core/arch code
  21  * during early bootup (a continued line is not SMP-safe otherwise).
  22  */
  23 #define KERN_CONT       "<c>"
  24
  25 extern int console_printk[];
  26
  27 #define console_loglevel (console_printk[0])
  28 #define default_message_loglevel (console_printk[1])
  29 #define minimum_console_loglevel (console_printk[2])
  30 #define default_console_loglevel (console_printk[3])
  31
  32 static inline void console_silent(void)
  33 {
  34         console_loglevel = 0;
  35 }
  36
  37 static inline void console_verbose(void)
  38 {
  39         if (console_loglevel)
  40                 console_loglevel = 15;
  41 }
  42
  43 struct va_format {
  44         const char *fmt;
  45         va_list *va;
  46 };
  47
  48 /*
  49  * FW_BUG
  50  * Add this to a message where you are sure the firmware is buggy or behaves
  51  * really stupid or out of spec. Be aware that the responsible BIOS developer
  52  * should be able to fix this issue or at least get a concrete idea of the
  53  * problem by reading your message without the need of looking at the kernel
  54  * code.
  55  *
  56  * Use it for definite and high priority BIOS bugs.
  57  *
  58  * FW_WARN
  59  * Use it for not that clear (e.g. could the kernel messed up things already?)
  60  * and medium priority BIOS bugs.
  61  *
  62  * FW_INFO
  63  * Use this one if you want to tell the user or vendor about something
  64  * suspicious, but generally harmless related to the firmware.
  65  *
  66  * Use it for information or very low priority BIOS bugs.
  67  */
  68 #define FW_BUG          "[Firmware Bug]: "
  69 #define FW_WARN         "[Firmware Warn]: "
  70 #define FW_INFO         "[Firmware Info]: "
  71
  72 /*
  73  * HW_ERR
  74  * Add this to a message for hardware errors, so that user can report
  75  * it to hardware vendor instead of LKML or software vendor.
  76  */
  77 #define HW_ERR          "[Hardware Error]: "
  78
  79 #ifdef CONFIG_PRINTK
  80 asmlinkage int vprintk(const char *fmt, va_list args)
  81         __attribute__ ((format (printf, 1, 0)));
  82 asmlinkage int printk(const char * fmt, ...)
  83         __attribute__ ((format (printf, 1, 2))) __cold;
  84
  85 /*
  86  * Please don't use printk_ratelimit(), because it shares ratelimiting state
  87  * with all other unrelated printk_ratelimit() callsites.  Instead use
  88  * printk_ratelimited() or plain old __ratelimit().
  89  */
  90 extern int __printk_ratelimit(const char *func);
  91 #define printk_ratelimit() __printk_ratelimit(__func__)
  92 extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
  93                                    unsigned int interval_msec);
  94
  95 extern int printk_delay_msec;
  96 extern int dmesg_restrict;
  97 extern int kptr_restrict;
  98
  99 /*
 100  * Print a one-time message (analogous to WARN_ONCE() et al):
 101  */
 102 #define printk_once(x...) ({                    \
 103         static bool __print_once;               \
 104                                                 \
 105         if (!__print_once) {                    \
 106                 __print_once = true;            \
 107                 printk(x);                      \
 108         }                                       \
 109 })
 110
 111 void log_buf_kexec_setup(void);
 112 #else
 113 static inline int vprintk(const char *s, va_list args)
 114         __attribute__ ((format (printf, 1, 0)));
 115 static inline int vprintk(const char *s, va_list args) { return 0; }
 116 static inline int printk(const char *s, ...)
 117         __attribute__ ((format (printf, 1, 2)));
 118 static inline int __cold printk(const char *s, ...) { return 0; }
 119 static inline int printk_ratelimit(void) { return 0; }
 120 static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
 121                                           unsigned int interval_msec)   \
 122                 { return false; }
 123
 124 /* No effect, but we still get type checking even in the !PRINTK case: */
 125 #define printk_once(x...) printk(x)
 126
 127 static inline void log_buf_kexec_setup(void)
 128 {
 129 }
 130 #endif
 131
 132 /*
 133  * Dummy printk for disabled debugging statements to use whilst maintaining
 134  * gcc's format and side-effect checking.
 135  */
 136 static inline __attribute__ ((format (printf, 1, 2)))
 137 int no_printk(const char *s, ...) { return 0; }
 138
 139 extern int printk_needs_cpu(int cpu);
 140 extern void printk_tick(void);
 141
 142 extern void asmlinkage __attribute__((format(printf, 1, 2)))
 143         early_printk(const char *fmt, ...);
 144
 145 extern void dump_stack(void) __cold;
 146
 147 enum {
 148         DUMP_PREFIX_NONE,
 149         DUMP_PREFIX_ADDRESS,
 150         DUMP_PREFIX_OFFSET
 151 };
 152 extern void hex_dump_to_buffer(const void *buf, size_t len,
 153                                 int rowsize, int groupsize,
 154                                 char *linebuf, size_t linebuflen, bool ascii);
 155 extern void print_hex_dump(const char *level, const char *prefix_str,
 156                                 int prefix_type, int rowsize, int groupsize,
 157                                 const void *buf, size_t len, bool ascii);
 158 extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
 159                         const void *buf, size_t len);
 160
 161 #ifndef pr_fmt
 162 #define pr_fmt(fmt) fmt
 163 #endif
 164
 165 #define pr_emerg(fmt, ...) \
 166         printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 167 #define pr_alert(fmt, ...) \
 168         printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 169 #define pr_crit(fmt, ...) \
 170         printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 171 #define pr_err(fmt, ...) \
 172         printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 173 #define pr_warning(fmt, ...) \
 174         printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 175 #define pr_warn pr_warning
 176 #define pr_notice(fmt, ...) \
 177         printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 178 #define pr_info(fmt, ...) \
 179         printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 180 #define pr_cont(fmt, ...) \
 181         printk(KERN_CONT fmt, ##__VA_ARGS__)
 182
 183 /* pr_devel() should produce zero code unless DEBUG is defined */
 184 #ifdef DEBUG
 185 #define pr_devel(fmt, ...) \
 186         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 187 #else
 188 #define pr_devel(fmt, ...) \
 189         ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
 190 #endif
 191
 192 /* If you are writing a driver, please use dev_dbg instead */
 193 #if defined(DEBUG)
 194 #define pr_debug(fmt, ...) \
 195         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 196 #elif defined(CONFIG_DYNAMIC_DEBUG)
 197 /* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
 198 #define pr_debug(fmt, ...) \
 199         dynamic_pr_debug(fmt, ##__VA_ARGS__)
 200 #else
 201 #define pr_debug(fmt, ...) \
 202         ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
 203 #endif
 204
 205 /*
 206  * ratelimited messages with local ratelimit_state,
 207  * no local ratelimit_state used in the !PRINTK case
 208  */
 209 #ifdef CONFIG_PRINTK
 210 #define printk_ratelimited(fmt, ...)  ({                                \
 211         static DEFINE_RATELIMIT_STATE(_rs,                              \
 212                                       DEFAULT_RATELIMIT_INTERVAL,       \
 213                                       DEFAULT_RATELIMIT_BURST);         \
 214                                                                         \
 215         if (__ratelimit(&_rs))                                          \
 216                 printk(fmt, ##__VA_ARGS__);                             \
 217 })
 218 #else
 219 /* No effect, but we still get type checking even in the !PRINTK case: */
 220 #define printk_ratelimited printk
 221 #endif
 222
 223 #define pr_emerg_ratelimited(fmt, ...) \
 224         printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
 225 #define pr_alert_ratelimited(fmt, ...) \
 226         printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
 227 #define pr_crit_ratelimited(fmt, ...) \
 228         printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
 229 #define pr_err_ratelimited(fmt, ...) \
 230         printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
 231 #define pr_warning_ratelimited(fmt, ...) \
 232         printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
 233 #define pr_warn_ratelimited pr_warning_ratelimited
 234 #define pr_notice_ratelimited(fmt, ...) \
 235         printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
 236 #define pr_info_ratelimited(fmt, ...) \
 237         printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
 238 /* no pr_cont_ratelimited, don't do that... */
 239 /* If you are writing a driver, please use dev_dbg instead */
 240 #if defined(DEBUG)
 241 #define pr_debug_ratelimited(fmt, ...) \
 242         printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 243 #else
 244 #define pr_debug_ratelimited(fmt, ...) \
 245         ({ if (0) printk_ratelimited(KERN_DEBUG pr_fmt(fmt), \
 246                                      ##__VA_ARGS__); 0; })
 247 #endif
 248
 249 #endif