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