2 * linux/kernel/printk.c
4 * Copyright (C) 1991, 1992 Linus Torvalds
6 * Modified to make sys_syslog() more flexible: added commands to
7 * return the last 4k of kernel messages, regardless of whether
8 * they've been read or not. Added option to suppress kernel printk's
9 * to the console. Added hook for sending the console messages
10 * elsewhere, in preparation for a serial line console (someday).
12 * Modified for sysctl support, 1/8/97, Chris Horn.
13 * Fixed SMP synchronization, 08/08/99, Manfred Spraul
14 * manfred@colorfullife.com
15 * Rewrote bits to get rid of console_lock
16 * 01Mar01 Andrew Morton
19 #include <linux/kernel.h>
21 #include <linux/tty.h>
22 #include <linux/tty_driver.h>
23 #include <linux/console.h>
24 #include <linux/init.h>
25 #include <linux/jiffies.h>
26 #include <linux/nmi.h>
27 #include <linux/module.h>
28 #include <linux/moduleparam.h>
29 #include <linux/delay.h>
30 #include <linux/smp.h>
31 #include <linux/security.h>
32 #include <linux/bootmem.h>
33 #include <linux/memblock.h>
34 #include <linux/syscalls.h>
35 #include <linux/crash_core.h>
36 #include <linux/kdb.h>
37 #include <linux/ratelimit.h>
38 #include <linux/kmsg_dump.h>
39 #include <linux/syslog.h>
40 #include <linux/cpu.h>
41 #include <linux/notifier.h>
42 #include <linux/rculist.h>
43 #include <linux/poll.h>
44 #include <linux/irq_work.h>
45 #include <linux/utsname.h>
46 #include <linux/ctype.h>
47 #include <linux/uio.h>
48 #include <linux/sched/clock.h>
49 #include <linux/sched/debug.h>
50 #include <linux/sched/task_stack.h>
52 #include <linux/uaccess.h>
53 #include <asm/sections.h>
55 #define CREATE_TRACE_POINTS
56 #include <trace/events/printk.h>
58 #include "console_cmdline.h"
62 int console_printk[4] = {
63 CONSOLE_LOGLEVEL_DEFAULT, /* console_loglevel */
64 MESSAGE_LOGLEVEL_DEFAULT, /* default_message_loglevel */
65 CONSOLE_LOGLEVEL_MIN, /* minimum_console_loglevel */
66 CONSOLE_LOGLEVEL_DEFAULT, /* default_console_loglevel */
70 * Low level drivers may need that to know if they can schedule in
71 * their unblank() callback or not. So let's export it.
74 EXPORT_SYMBOL(oops_in_progress);
77 * console_sem protects the console_drivers list, and also
78 * provides serialisation for access to the entire console
81 static DEFINE_SEMAPHORE(console_sem);
82 struct console *console_drivers;
83 EXPORT_SYMBOL_GPL(console_drivers);
86 static struct lockdep_map console_lock_dep_map = {
87 .name = "console_lock"
91 enum devkmsg_log_bits {
92 __DEVKMSG_LOG_BIT_ON = 0,
93 __DEVKMSG_LOG_BIT_OFF,
94 __DEVKMSG_LOG_BIT_LOCK,
97 enum devkmsg_log_masks {
98 DEVKMSG_LOG_MASK_ON = BIT(__DEVKMSG_LOG_BIT_ON),
99 DEVKMSG_LOG_MASK_OFF = BIT(__DEVKMSG_LOG_BIT_OFF),
100 DEVKMSG_LOG_MASK_LOCK = BIT(__DEVKMSG_LOG_BIT_LOCK),
103 /* Keep both the 'on' and 'off' bits clear, i.e. ratelimit by default: */
104 #define DEVKMSG_LOG_MASK_DEFAULT 0
106 static unsigned int __read_mostly devkmsg_log = DEVKMSG_LOG_MASK_DEFAULT;
108 static int __control_devkmsg(char *str)
113 if (!strncmp(str, "on", 2)) {
114 devkmsg_log = DEVKMSG_LOG_MASK_ON;
116 } else if (!strncmp(str, "off", 3)) {
117 devkmsg_log = DEVKMSG_LOG_MASK_OFF;
119 } else if (!strncmp(str, "ratelimit", 9)) {
120 devkmsg_log = DEVKMSG_LOG_MASK_DEFAULT;
126 static int __init control_devkmsg(char *str)
128 if (__control_devkmsg(str) < 0) {
129 pr_warn("printk.devkmsg: bad option string '%s'\n", str);
134 * Set sysctl string accordingly:
136 if (devkmsg_log == DEVKMSG_LOG_MASK_ON) {
137 memset(devkmsg_log_str, 0, DEVKMSG_STR_MAX_SIZE);
138 strncpy(devkmsg_log_str, "on", 2);
139 } else if (devkmsg_log == DEVKMSG_LOG_MASK_OFF) {
140 memset(devkmsg_log_str, 0, DEVKMSG_STR_MAX_SIZE);
141 strncpy(devkmsg_log_str, "off", 3);
143 /* else "ratelimit" which is set by default. */
146 * Sysctl cannot change it anymore. The kernel command line setting of
147 * this parameter is to force the setting to be permanent throughout the
148 * runtime of the system. This is a precation measure against userspace
149 * trying to be a smarta** and attempting to change it up on us.
151 devkmsg_log |= DEVKMSG_LOG_MASK_LOCK;
155 __setup("printk.devkmsg=", control_devkmsg);
157 char devkmsg_log_str[DEVKMSG_STR_MAX_SIZE] = "ratelimit";
159 int devkmsg_sysctl_set_loglvl(struct ctl_table *table, int write,
160 void __user *buffer, size_t *lenp, loff_t *ppos)
162 char old_str[DEVKMSG_STR_MAX_SIZE];
167 if (devkmsg_log & DEVKMSG_LOG_MASK_LOCK)
171 strncpy(old_str, devkmsg_log_str, DEVKMSG_STR_MAX_SIZE);
174 err = proc_dostring(table, write, buffer, lenp, ppos);
179 err = __control_devkmsg(devkmsg_log_str);
182 * Do not accept an unknown string OR a known string with
185 if (err < 0 || (err + 1 != *lenp)) {
187 /* ... and restore old setting. */
189 strncpy(devkmsg_log_str, old_str, DEVKMSG_STR_MAX_SIZE);
199 * Number of registered extended console drivers.
201 * If extended consoles are present, in-kernel cont reassembly is disabled
202 * and each fragment is stored as a separate log entry with proper
203 * continuation flag so that every emitted message has full metadata. This
204 * doesn't change the result for regular consoles or /proc/kmsg. For
205 * /dev/kmsg, as long as the reader concatenates messages according to
206 * consecutive continuation flags, the end result should be the same too.
208 static int nr_ext_console_drivers;
211 * Helper macros to handle lockdep when locking/unlocking console_sem. We use
212 * macros instead of functions so that _RET_IP_ contains useful information.
214 #define down_console_sem() do { \
216 mutex_acquire(&console_lock_dep_map, 0, 0, _RET_IP_);\
219 static int __down_trylock_console_sem(unsigned long ip)
225 * Here and in __up_console_sem() we need to be in safe mode,
226 * because spindump/WARN/etc from under console ->lock will
227 * deadlock in printk()->down_trylock_console_sem() otherwise.
229 printk_safe_enter_irqsave(flags);
230 lock_failed = down_trylock(&console_sem);
231 printk_safe_exit_irqrestore(flags);
235 mutex_acquire(&console_lock_dep_map, 0, 1, ip);
238 #define down_trylock_console_sem() __down_trylock_console_sem(_RET_IP_)
240 static void __up_console_sem(unsigned long ip)
244 mutex_release(&console_lock_dep_map, 1, ip);
246 printk_safe_enter_irqsave(flags);
248 printk_safe_exit_irqrestore(flags);
250 #define up_console_sem() __up_console_sem(_RET_IP_)
253 * This is used for debugging the mess that is the VT code by
254 * keeping track if we have the console semaphore held. It's
255 * definitely not the perfect debug tool (we don't know if _WE_
256 * hold it and are racing, but it helps tracking those weird code
257 * paths in the console code where we end up in places I want
258 * locked without the console sempahore held).
260 static int console_locked, console_suspended;
263 * If exclusive_console is non-NULL then only this console is to be printed to.
265 static struct console *exclusive_console;
268 * Array of consoles built from command line options (console=)
271 #define MAX_CMDLINECONSOLES 8
273 static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
275 static int preferred_console = -1;
276 int console_set_on_cmdline;
277 EXPORT_SYMBOL(console_set_on_cmdline);
279 /* Flag: console code may call schedule() */
280 static int console_may_schedule;
283 * The printk log buffer consists of a chain of concatenated variable
284 * length records. Every record starts with a record header, containing
285 * the overall length of the record.
287 * The heads to the first and last entry in the buffer, as well as the
288 * sequence numbers of these entries are maintained when messages are
291 * If the heads indicate available messages, the length in the header
292 * tells the start next message. A length == 0 for the next message
293 * indicates a wrap-around to the beginning of the buffer.
295 * Every record carries the monotonic timestamp in microseconds, as well as
296 * the standard userspace syslog level and syslog facility. The usual
297 * kernel messages use LOG_KERN; userspace-injected messages always carry
298 * a matching syslog facility, by default LOG_USER. The origin of every
299 * message can be reliably determined that way.
301 * The human readable log message directly follows the message header. The
302 * length of the message text is stored in the header, the stored message
305 * Optionally, a message can carry a dictionary of properties (key/value pairs),
306 * to provide userspace with a machine-readable message context.
308 * Examples for well-defined, commonly used property names are:
309 * DEVICE=b12:8 device identifier
313 * +sound:card0 subsystem:devname
314 * SUBSYSTEM=pci driver-core subsystem name
316 * Valid characters in property names are [a-zA-Z0-9.-_]. The plain text value
317 * follows directly after a '=' character. Every property is terminated by
318 * a '\0' character. The last property is not terminated.
320 * Example of a message structure:
321 * 0000 ff 8f 00 00 00 00 00 00 monotonic time in nsec
322 * 0008 34 00 record is 52 bytes long
323 * 000a 0b 00 text is 11 bytes long
324 * 000c 1f 00 dictionary is 23 bytes long
325 * 000e 03 00 LOG_KERN (facility) LOG_ERR (level)
326 * 0010 69 74 27 73 20 61 20 6c "it's a l"
328 * 001b 44 45 56 49 43 "DEVIC"
329 * 45 3d 62 38 3a 32 00 44 "E=b8:2\0D"
330 * 52 49 56 45 52 3d 62 75 "RIVER=bu"
332 * 0032 00 00 00 padding to next message header
334 * The 'struct printk_log' buffer header must never be directly exported to
335 * userspace, it is a kernel-private implementation detail that might
336 * need to be changed in the future, when the requirements change.
338 * /dev/kmsg exports the structured data in the following line format:
339 * "<level>,<sequnum>,<timestamp>,<contflag>[,additional_values, ... ];<message text>\n"
341 * Users of the export format should ignore possible additional values
342 * separated by ',', and find the message after the ';' character.
344 * The optional key/value pairs are attached as continuation lines starting
345 * with a space character and terminated by a newline. All possible
346 * non-prinatable characters are escaped in the "\xff" notation.
350 LOG_NOCONS = 1, /* already flushed, do not print to console */
351 LOG_NEWLINE = 2, /* text ended with a newline */
352 LOG_PREFIX = 4, /* text started with a prefix */
353 LOG_CONT = 8, /* text is a fragment of a continuation line */
357 u64 ts_nsec; /* timestamp in nanoseconds */
358 u16 len; /* length of entire record */
359 u16 text_len; /* length of text buffer */
360 u16 dict_len; /* length of dictionary buffer */
361 u8 facility; /* syslog facility */
362 u8 flags:5; /* internal record flags */
363 u8 level:3; /* syslog level */
365 #ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
366 __packed __aligned(4)
371 * The logbuf_lock protects kmsg buffer, indices, counters. This can be taken
372 * within the scheduler's rq lock. It must be released before calling
373 * console_unlock() or anything else that might wake up a process.
375 DEFINE_RAW_SPINLOCK(logbuf_lock);
378 * Helper macros to lock/unlock logbuf_lock and switch between
379 * printk-safe/unsafe modes.
381 #define logbuf_lock_irq() \
383 printk_safe_enter_irq(); \
384 raw_spin_lock(&logbuf_lock); \
387 #define logbuf_unlock_irq() \
389 raw_spin_unlock(&logbuf_lock); \
390 printk_safe_exit_irq(); \
393 #define logbuf_lock_irqsave(flags) \
395 printk_safe_enter_irqsave(flags); \
396 raw_spin_lock(&logbuf_lock); \
399 #define logbuf_unlock_irqrestore(flags) \
401 raw_spin_unlock(&logbuf_lock); \
402 printk_safe_exit_irqrestore(flags); \
406 DECLARE_WAIT_QUEUE_HEAD(log_wait);
407 /* the next printk record to read by syslog(READ) or /proc/kmsg */
408 static u64 syslog_seq;
409 static u32 syslog_idx;
410 static size_t syslog_partial;
412 /* index and sequence number of the first record stored in the buffer */
413 static u64 log_first_seq;
414 static u32 log_first_idx;
416 /* index and sequence number of the next record to store in the buffer */
417 static u64 log_next_seq;
418 static u32 log_next_idx;
420 /* the next printk record to write to the console */
421 static u64 console_seq;
422 static u32 console_idx;
424 /* the next printk record to read after the last 'clear' command */
425 static u64 clear_seq;
426 static u32 clear_idx;
428 #define PREFIX_MAX 32
429 #define LOG_LINE_MAX (1024 - PREFIX_MAX)
431 #define LOG_LEVEL(v) ((v) & 0x07)
432 #define LOG_FACILITY(v) ((v) >> 3 & 0xff)
435 #define LOG_ALIGN __alignof__(struct printk_log)
436 #define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
437 #define LOG_BUF_LEN_MAX (u32)(1 << 31)
438 static char __log_buf[__LOG_BUF_LEN] __aligned(LOG_ALIGN);
439 static char *log_buf = __log_buf;
440 static u32 log_buf_len = __LOG_BUF_LEN;
442 /* Return log buffer address */
443 char *log_buf_addr_get(void)
448 /* Return log buffer size */
449 u32 log_buf_len_get(void)
454 /* human readable text of the record */
455 static char *log_text(const struct printk_log *msg)
457 return (char *)msg + sizeof(struct printk_log);
460 /* optional key/value pair dictionary attached to the record */
461 static char *log_dict(const struct printk_log *msg)
463 return (char *)msg + sizeof(struct printk_log) + msg->text_len;
466 /* get record by index; idx must point to valid msg */
467 static struct printk_log *log_from_idx(u32 idx)
469 struct printk_log *msg = (struct printk_log *)(log_buf + idx);
472 * A length == 0 record is the end of buffer marker. Wrap around and
473 * read the message at the start of the buffer.
476 return (struct printk_log *)log_buf;
480 /* get next record; idx must point to valid msg */
481 static u32 log_next(u32 idx)
483 struct printk_log *msg = (struct printk_log *)(log_buf + idx);
485 /* length == 0 indicates the end of the buffer; wrap */
487 * A length == 0 record is the end of buffer marker. Wrap around and
488 * read the message at the start of the buffer as *this* one, and
489 * return the one after that.
492 msg = (struct printk_log *)log_buf;
495 return idx + msg->len;
499 * Check whether there is enough free space for the given message.
501 * The same values of first_idx and next_idx mean that the buffer
502 * is either empty or full.
504 * If the buffer is empty, we must respect the position of the indexes.
505 * They cannot be reset to the beginning of the buffer.
507 static int logbuf_has_space(u32 msg_size, bool empty)
511 if (log_next_idx > log_first_idx || empty)
512 free = max(log_buf_len - log_next_idx, log_first_idx);
514 free = log_first_idx - log_next_idx;
517 * We need space also for an empty header that signalizes wrapping
520 return free >= msg_size + sizeof(struct printk_log);
523 static int log_make_free_space(u32 msg_size)
525 while (log_first_seq < log_next_seq &&
526 !logbuf_has_space(msg_size, false)) {
527 /* drop old messages until we have enough contiguous space */
528 log_first_idx = log_next(log_first_idx);
532 if (clear_seq < log_first_seq) {
533 clear_seq = log_first_seq;
534 clear_idx = log_first_idx;
537 /* sequence numbers are equal, so the log buffer is empty */
538 if (logbuf_has_space(msg_size, log_first_seq == log_next_seq))
544 /* compute the message size including the padding bytes */
545 static u32 msg_used_size(u16 text_len, u16 dict_len, u32 *pad_len)
549 size = sizeof(struct printk_log) + text_len + dict_len;
550 *pad_len = (-size) & (LOG_ALIGN - 1);
557 * Define how much of the log buffer we could take at maximum. The value
558 * must be greater than two. Note that only half of the buffer is available
559 * when the index points to the middle.
561 #define MAX_LOG_TAKE_PART 4
562 static const char trunc_msg[] = "<truncated>";
564 static u32 truncate_msg(u16 *text_len, u16 *trunc_msg_len,
565 u16 *dict_len, u32 *pad_len)
568 * The message should not take the whole buffer. Otherwise, it might
569 * get removed too soon.
571 u32 max_text_len = log_buf_len / MAX_LOG_TAKE_PART;
572 if (*text_len > max_text_len)
573 *text_len = max_text_len;
574 /* enable the warning message */
575 *trunc_msg_len = strlen(trunc_msg);
576 /* disable the "dict" completely */
578 /* compute the size again, count also the warning message */
579 return msg_used_size(*text_len + *trunc_msg_len, 0, pad_len);
582 /* insert record into the buffer, discard old ones, update heads */
583 static int log_store(int facility, int level,
584 enum log_flags flags, u64 ts_nsec,
585 const char *dict, u16 dict_len,
586 const char *text, u16 text_len)
588 struct printk_log *msg;
590 u16 trunc_msg_len = 0;
592 /* number of '\0' padding bytes to next message */
593 size = msg_used_size(text_len, dict_len, &pad_len);
595 if (log_make_free_space(size)) {
596 /* truncate the message if it is too long for empty buffer */
597 size = truncate_msg(&text_len, &trunc_msg_len,
598 &dict_len, &pad_len);
599 /* survive when the log buffer is too small for trunc_msg */
600 if (log_make_free_space(size))
604 if (log_next_idx + size + sizeof(struct printk_log) > log_buf_len) {
606 * This message + an additional empty header does not fit
607 * at the end of the buffer. Add an empty header with len == 0
608 * to signify a wrap around.
610 memset(log_buf + log_next_idx, 0, sizeof(struct printk_log));
615 msg = (struct printk_log *)(log_buf + log_next_idx);
616 memcpy(log_text(msg), text, text_len);
617 msg->text_len = text_len;
619 memcpy(log_text(msg) + text_len, trunc_msg, trunc_msg_len);
620 msg->text_len += trunc_msg_len;
622 memcpy(log_dict(msg), dict, dict_len);
623 msg->dict_len = dict_len;
624 msg->facility = facility;
625 msg->level = level & 7;
626 msg->flags = flags & 0x1f;
628 msg->ts_nsec = ts_nsec;
630 msg->ts_nsec = local_clock();
631 memset(log_dict(msg) + dict_len, 0, pad_len);
635 log_next_idx += msg->len;
638 return msg->text_len;
641 int dmesg_restrict = IS_ENABLED(CONFIG_SECURITY_DMESG_RESTRICT);
643 static int syslog_action_restricted(int type)
648 * Unless restricted, we allow "read all" and "get buffer size"
651 return type != SYSLOG_ACTION_READ_ALL &&
652 type != SYSLOG_ACTION_SIZE_BUFFER;
655 static int check_syslog_permissions(int type, int source)
658 * If this is from /proc/kmsg and we've already opened it, then we've
659 * already done the capabilities checks at open time.
661 if (source == SYSLOG_FROM_PROC && type != SYSLOG_ACTION_OPEN)
664 if (syslog_action_restricted(type)) {
665 if (capable(CAP_SYSLOG))
668 * For historical reasons, accept CAP_SYS_ADMIN too, with
671 if (capable(CAP_SYS_ADMIN)) {
672 pr_warn_once("%s (%d): Attempt to access syslog with "
673 "CAP_SYS_ADMIN but no CAP_SYSLOG "
675 current->comm, task_pid_nr(current));
681 return security_syslog(type);
684 static void append_char(char **pp, char *e, char c)
690 static ssize_t msg_print_ext_header(char *buf, size_t size,
691 struct printk_log *msg, u64 seq)
693 u64 ts_usec = msg->ts_nsec;
695 do_div(ts_usec, 1000);
697 return scnprintf(buf, size, "%u,%llu,%llu,%c;",
698 (msg->facility << 3) | msg->level, seq, ts_usec,
699 msg->flags & LOG_CONT ? 'c' : '-');
702 static ssize_t msg_print_ext_body(char *buf, size_t size,
703 char *dict, size_t dict_len,
704 char *text, size_t text_len)
706 char *p = buf, *e = buf + size;
709 /* escape non-printable characters */
710 for (i = 0; i < text_len; i++) {
711 unsigned char c = text[i];
713 if (c < ' ' || c >= 127 || c == '\\')
714 p += scnprintf(p, e - p, "\\x%02x", c);
716 append_char(&p, e, c);
718 append_char(&p, e, '\n');
723 for (i = 0; i < dict_len; i++) {
724 unsigned char c = dict[i];
727 append_char(&p, e, ' ');
732 append_char(&p, e, '\n');
737 if (c < ' ' || c >= 127 || c == '\\') {
738 p += scnprintf(p, e - p, "\\x%02x", c);
742 append_char(&p, e, c);
744 append_char(&p, e, '\n');
750 /* /dev/kmsg - userspace message inject/listen interface */
751 struct devkmsg_user {
754 struct ratelimit_state rs;
756 char buf[CONSOLE_EXT_LOG_MAX];
759 static ssize_t devkmsg_write(struct kiocb *iocb, struct iov_iter *from)
762 int level = default_message_loglevel;
763 int facility = 1; /* LOG_USER */
764 struct file *file = iocb->ki_filp;
765 struct devkmsg_user *user = file->private_data;
766 size_t len = iov_iter_count(from);
769 if (!user || len > LOG_LINE_MAX)
772 /* Ignore when user logging is disabled. */
773 if (devkmsg_log & DEVKMSG_LOG_MASK_OFF)
776 /* Ratelimit when not explicitly enabled. */
777 if (!(devkmsg_log & DEVKMSG_LOG_MASK_ON)) {
778 if (!___ratelimit(&user->rs, current->comm))
782 buf = kmalloc(len+1, GFP_KERNEL);
787 if (!copy_from_iter_full(buf, len, from)) {
793 * Extract and skip the syslog prefix <[0-9]*>. Coming from userspace
794 * the decimal value represents 32bit, the lower 3 bit are the log
795 * level, the rest are the log facility.
797 * If no prefix or no userspace facility is specified, we
798 * enforce LOG_USER, to be able to reliably distinguish
799 * kernel-generated messages from userspace-injected ones.
802 if (line[0] == '<') {
806 u = simple_strtoul(line + 1, &endp, 10);
807 if (endp && endp[0] == '>') {
808 level = LOG_LEVEL(u);
809 if (LOG_FACILITY(u) != 0)
810 facility = LOG_FACILITY(u);
817 printk_emit(facility, level, NULL, 0, "%s", line);
822 static ssize_t devkmsg_read(struct file *file, char __user *buf,
823 size_t count, loff_t *ppos)
825 struct devkmsg_user *user = file->private_data;
826 struct printk_log *msg;
833 ret = mutex_lock_interruptible(&user->lock);
838 while (user->seq == log_next_seq) {
839 if (file->f_flags & O_NONBLOCK) {
846 ret = wait_event_interruptible(log_wait,
847 user->seq != log_next_seq);
853 if (user->seq < log_first_seq) {
854 /* our last seen message is gone, return error and reset */
855 user->idx = log_first_idx;
856 user->seq = log_first_seq;
862 msg = log_from_idx(user->idx);
863 len = msg_print_ext_header(user->buf, sizeof(user->buf),
865 len += msg_print_ext_body(user->buf + len, sizeof(user->buf) - len,
866 log_dict(msg), msg->dict_len,
867 log_text(msg), msg->text_len);
869 user->idx = log_next(user->idx);
878 if (copy_to_user(buf, user->buf, len)) {
884 mutex_unlock(&user->lock);
888 static loff_t devkmsg_llseek(struct file *file, loff_t offset, int whence)
890 struct devkmsg_user *user = file->private_data;
901 /* the first record */
902 user->idx = log_first_idx;
903 user->seq = log_first_seq;
907 * The first record after the last SYSLOG_ACTION_CLEAR,
908 * like issued by 'dmesg -c'. Reading /dev/kmsg itself
909 * changes no global state, and does not clear anything.
911 user->idx = clear_idx;
912 user->seq = clear_seq;
915 /* after the last record */
916 user->idx = log_next_idx;
917 user->seq = log_next_seq;
926 static unsigned int devkmsg_poll(struct file *file, poll_table *wait)
928 struct devkmsg_user *user = file->private_data;
932 return POLLERR|POLLNVAL;
934 poll_wait(file, &log_wait, wait);
937 if (user->seq < log_next_seq) {
938 /* return error when data has vanished underneath us */
939 if (user->seq < log_first_seq)
940 ret = POLLIN|POLLRDNORM|POLLERR|POLLPRI;
942 ret = POLLIN|POLLRDNORM;
949 static int devkmsg_open(struct inode *inode, struct file *file)
951 struct devkmsg_user *user;
954 if (devkmsg_log & DEVKMSG_LOG_MASK_OFF)
957 /* write-only does not need any file context */
958 if ((file->f_flags & O_ACCMODE) != O_WRONLY) {
959 err = check_syslog_permissions(SYSLOG_ACTION_READ_ALL,
965 user = kmalloc(sizeof(struct devkmsg_user), GFP_KERNEL);
969 ratelimit_default_init(&user->rs);
970 ratelimit_set_flags(&user->rs, RATELIMIT_MSG_ON_RELEASE);
972 mutex_init(&user->lock);
975 user->idx = log_first_idx;
976 user->seq = log_first_seq;
979 file->private_data = user;
983 static int devkmsg_release(struct inode *inode, struct file *file)
985 struct devkmsg_user *user = file->private_data;
990 ratelimit_state_exit(&user->rs);
992 mutex_destroy(&user->lock);
997 const struct file_operations kmsg_fops = {
998 .open = devkmsg_open,
999 .read = devkmsg_read,
1000 .write_iter = devkmsg_write,
1001 .llseek = devkmsg_llseek,
1002 .poll = devkmsg_poll,
1003 .release = devkmsg_release,
1006 #ifdef CONFIG_CRASH_CORE
1008 * This appends the listed symbols to /proc/vmcore
1010 * /proc/vmcore is used by various utilities, like crash and makedumpfile to
1011 * obtain access to symbols that are otherwise very difficult to locate. These
1012 * symbols are specifically used so that utilities can access and extract the
1013 * dmesg log from a vmcore file after a crash.
1015 void log_buf_vmcoreinfo_setup(void)
1017 VMCOREINFO_SYMBOL(log_buf);
1018 VMCOREINFO_SYMBOL(log_buf_len);
1019 VMCOREINFO_SYMBOL(log_first_idx);
1020 VMCOREINFO_SYMBOL(clear_idx);
1021 VMCOREINFO_SYMBOL(log_next_idx);
1023 * Export struct printk_log size and field offsets. User space tools can
1024 * parse it and detect any changes to structure down the line.
1026 VMCOREINFO_STRUCT_SIZE(printk_log);
1027 VMCOREINFO_OFFSET(printk_log, ts_nsec);
1028 VMCOREINFO_OFFSET(printk_log, len);
1029 VMCOREINFO_OFFSET(printk_log, text_len);
1030 VMCOREINFO_OFFSET(printk_log, dict_len);
1034 /* requested log_buf_len from kernel cmdline */
1035 static unsigned long __initdata new_log_buf_len;
1037 /* we practice scaling the ring buffer by powers of 2 */
1038 static void __init log_buf_len_update(u64 size)
1040 if (size > (u64)LOG_BUF_LEN_MAX) {
1041 size = (u64)LOG_BUF_LEN_MAX;
1042 pr_err("log_buf over 2G is not supported.\n");
1046 size = roundup_pow_of_two(size);
1047 if (size > log_buf_len)
1048 new_log_buf_len = (unsigned long)size;
1051 /* save requested log_buf_len since it's too early to process it */
1052 static int __init log_buf_len_setup(char *str)
1059 size = memparse(str, &str);
1061 log_buf_len_update(size);
1065 early_param("log_buf_len", log_buf_len_setup);
1068 #define __LOG_CPU_MAX_BUF_LEN (1 << CONFIG_LOG_CPU_MAX_BUF_SHIFT)
1070 static void __init log_buf_add_cpu(void)
1072 unsigned int cpu_extra;
1075 * archs should set up cpu_possible_bits properly with
1076 * set_cpu_possible() after setup_arch() but just in
1077 * case lets ensure this is valid.
1079 if (num_possible_cpus() == 1)
1082 cpu_extra = (num_possible_cpus() - 1) * __LOG_CPU_MAX_BUF_LEN;
1084 /* by default this will only continue through for large > 64 CPUs */
1085 if (cpu_extra <= __LOG_BUF_LEN / 2)
1088 pr_info("log_buf_len individual max cpu contribution: %d bytes\n",
1089 __LOG_CPU_MAX_BUF_LEN);
1090 pr_info("log_buf_len total cpu_extra contributions: %d bytes\n",
1092 pr_info("log_buf_len min size: %d bytes\n", __LOG_BUF_LEN);
1094 log_buf_len_update(cpu_extra + __LOG_BUF_LEN);
1096 #else /* !CONFIG_SMP */
1097 static inline void log_buf_add_cpu(void) {}
1098 #endif /* CONFIG_SMP */
1100 void __init setup_log_buf(int early)
1102 unsigned long flags;
1106 if (log_buf != __log_buf)
1109 if (!early && !new_log_buf_len)
1112 if (!new_log_buf_len)
1117 memblock_virt_alloc(new_log_buf_len, LOG_ALIGN);
1119 new_log_buf = memblock_virt_alloc_nopanic(new_log_buf_len,
1123 if (unlikely(!new_log_buf)) {
1124 pr_err("log_buf_len: %lu bytes not available\n",
1129 logbuf_lock_irqsave(flags);
1130 log_buf_len = new_log_buf_len;
1131 log_buf = new_log_buf;
1132 new_log_buf_len = 0;
1133 free = __LOG_BUF_LEN - log_next_idx;
1134 memcpy(log_buf, __log_buf, __LOG_BUF_LEN);
1135 logbuf_unlock_irqrestore(flags);
1137 pr_info("log_buf_len: %u bytes\n", log_buf_len);
1138 pr_info("early log buf free: %u(%u%%)\n",
1139 free, (free * 100) / __LOG_BUF_LEN);
1142 static bool __read_mostly ignore_loglevel;
1144 static int __init ignore_loglevel_setup(char *str)
1146 ignore_loglevel = true;
1147 pr_info("debug: ignoring loglevel setting.\n");
1152 early_param("ignore_loglevel", ignore_loglevel_setup);
1153 module_param(ignore_loglevel, bool, S_IRUGO | S_IWUSR);
1154 MODULE_PARM_DESC(ignore_loglevel,
1155 "ignore loglevel setting (prints all kernel messages to the console)");
1157 static bool suppress_message_printing(int level)
1159 return (level >= console_loglevel && !ignore_loglevel);
1162 #ifdef CONFIG_BOOT_PRINTK_DELAY
1164 static int boot_delay; /* msecs delay after each printk during bootup */
1165 static unsigned long long loops_per_msec; /* based on boot_delay */
1167 static int __init boot_delay_setup(char *str)
1171 lpj = preset_lpj ? preset_lpj : 1000000; /* some guess */
1172 loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
1174 get_option(&str, &boot_delay);
1175 if (boot_delay > 10 * 1000)
1178 pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
1179 "HZ: %d, loops_per_msec: %llu\n",
1180 boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
1183 early_param("boot_delay", boot_delay_setup);
1185 static void boot_delay_msec(int level)
1187 unsigned long long k;
1188 unsigned long timeout;
1190 if ((boot_delay == 0 || system_state >= SYSTEM_RUNNING)
1191 || suppress_message_printing(level)) {
1195 k = (unsigned long long)loops_per_msec * boot_delay;
1197 timeout = jiffies + msecs_to_jiffies(boot_delay);
1202 * use (volatile) jiffies to prevent
1203 * compiler reduction; loop termination via jiffies
1204 * is secondary and may or may not happen.
1206 if (time_after(jiffies, timeout))
1208 touch_nmi_watchdog();
1212 static inline void boot_delay_msec(int level)
1217 static bool printk_time = IS_ENABLED(CONFIG_PRINTK_TIME);
1218 module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
1220 static size_t print_time(u64 ts, char *buf)
1222 unsigned long rem_nsec;
1227 rem_nsec = do_div(ts, 1000000000);
1230 return snprintf(NULL, 0, "[%5lu.000000] ", (unsigned long)ts);
1232 return sprintf(buf, "[%5lu.%06lu] ",
1233 (unsigned long)ts, rem_nsec / 1000);
1236 static size_t print_prefix(const struct printk_log *msg, bool syslog, char *buf)
1239 unsigned int prefix = (msg->facility << 3) | msg->level;
1243 len += sprintf(buf, "<%u>", prefix);
1248 else if (prefix > 99)
1250 else if (prefix > 9)
1255 len += print_time(msg->ts_nsec, buf ? buf + len : NULL);
1259 static size_t msg_print_text(const struct printk_log *msg, bool syslog, char *buf, size_t size)
1261 const char *text = log_text(msg);
1262 size_t text_size = msg->text_len;
1266 const char *next = memchr(text, '\n', text_size);
1270 text_len = next - text;
1272 text_size -= next - text;
1274 text_len = text_size;
1278 if (print_prefix(msg, syslog, NULL) +
1279 text_len + 1 >= size - len)
1282 len += print_prefix(msg, syslog, buf + len);
1283 memcpy(buf + len, text, text_len);
1287 /* SYSLOG_ACTION_* buffer size only calculation */
1288 len += print_prefix(msg, syslog, NULL);
1299 static int syslog_print(char __user *buf, int size)
1302 struct printk_log *msg;
1305 text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1314 if (syslog_seq < log_first_seq) {
1315 /* messages are gone, move to first one */
1316 syslog_seq = log_first_seq;
1317 syslog_idx = log_first_idx;
1320 if (syslog_seq == log_next_seq) {
1321 logbuf_unlock_irq();
1325 skip = syslog_partial;
1326 msg = log_from_idx(syslog_idx);
1327 n = msg_print_text(msg, true, text, LOG_LINE_MAX + PREFIX_MAX);
1328 if (n - syslog_partial <= size) {
1329 /* message fits into buffer, move forward */
1330 syslog_idx = log_next(syslog_idx);
1332 n -= syslog_partial;
1335 /* partial read(), remember position */
1337 syslog_partial += n;
1340 logbuf_unlock_irq();
1345 if (copy_to_user(buf, text + skip, n)) {
1360 static int syslog_print_all(char __user *buf, int size, bool clear)
1365 text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1376 * Find first record that fits, including all following records,
1377 * into the user-provided buffer for this dump.
1381 while (seq < log_next_seq) {
1382 struct printk_log *msg = log_from_idx(idx);
1384 len += msg_print_text(msg, true, NULL, 0);
1385 idx = log_next(idx);
1389 /* move first record forward until length fits into the buffer */
1392 while (len > size && seq < log_next_seq) {
1393 struct printk_log *msg = log_from_idx(idx);
1395 len -= msg_print_text(msg, true, NULL, 0);
1396 idx = log_next(idx);
1400 /* last message fitting into this dump */
1401 next_seq = log_next_seq;
1404 while (len >= 0 && seq < next_seq) {
1405 struct printk_log *msg = log_from_idx(idx);
1408 textlen = msg_print_text(msg, true, text,
1409 LOG_LINE_MAX + PREFIX_MAX);
1414 idx = log_next(idx);
1417 logbuf_unlock_irq();
1418 if (copy_to_user(buf + len, text, textlen))
1424 if (seq < log_first_seq) {
1425 /* messages are gone, move to next one */
1426 seq = log_first_seq;
1427 idx = log_first_idx;
1433 clear_seq = log_next_seq;
1434 clear_idx = log_next_idx;
1436 logbuf_unlock_irq();
1442 int do_syslog(int type, char __user *buf, int len, int source)
1445 static int saved_console_loglevel = LOGLEVEL_DEFAULT;
1448 error = check_syslog_permissions(type, source);
1453 case SYSLOG_ACTION_CLOSE: /* Close log */
1455 case SYSLOG_ACTION_OPEN: /* Open log */
1457 case SYSLOG_ACTION_READ: /* Read from log */
1458 if (!buf || len < 0)
1462 if (!access_ok(VERIFY_WRITE, buf, len))
1464 error = wait_event_interruptible(log_wait,
1465 syslog_seq != log_next_seq);
1468 error = syslog_print(buf, len);
1470 /* Read/clear last kernel messages */
1471 case SYSLOG_ACTION_READ_CLEAR:
1474 /* Read last kernel messages */
1475 case SYSLOG_ACTION_READ_ALL:
1476 if (!buf || len < 0)
1480 if (!access_ok(VERIFY_WRITE, buf, len))
1482 error = syslog_print_all(buf, len, clear);
1484 /* Clear ring buffer */
1485 case SYSLOG_ACTION_CLEAR:
1486 syslog_print_all(NULL, 0, true);
1488 /* Disable logging to console */
1489 case SYSLOG_ACTION_CONSOLE_OFF:
1490 if (saved_console_loglevel == LOGLEVEL_DEFAULT)
1491 saved_console_loglevel = console_loglevel;
1492 console_loglevel = minimum_console_loglevel;
1494 /* Enable logging to console */
1495 case SYSLOG_ACTION_CONSOLE_ON:
1496 if (saved_console_loglevel != LOGLEVEL_DEFAULT) {
1497 console_loglevel = saved_console_loglevel;
1498 saved_console_loglevel = LOGLEVEL_DEFAULT;
1501 /* Set level of messages printed to console */
1502 case SYSLOG_ACTION_CONSOLE_LEVEL:
1503 if (len < 1 || len > 8)
1505 if (len < minimum_console_loglevel)
1506 len = minimum_console_loglevel;
1507 console_loglevel = len;
1508 /* Implicitly re-enable logging to console */
1509 saved_console_loglevel = LOGLEVEL_DEFAULT;
1511 /* Number of chars in the log buffer */
1512 case SYSLOG_ACTION_SIZE_UNREAD:
1514 if (syslog_seq < log_first_seq) {
1515 /* messages are gone, move to first one */
1516 syslog_seq = log_first_seq;
1517 syslog_idx = log_first_idx;
1520 if (source == SYSLOG_FROM_PROC) {
1522 * Short-cut for poll(/"proc/kmsg") which simply checks
1523 * for pending data, not the size; return the count of
1524 * records, not the length.
1526 error = log_next_seq - syslog_seq;
1528 u64 seq = syslog_seq;
1529 u32 idx = syslog_idx;
1531 while (seq < log_next_seq) {
1532 struct printk_log *msg = log_from_idx(idx);
1534 error += msg_print_text(msg, true, NULL, 0);
1535 idx = log_next(idx);
1538 error -= syslog_partial;
1540 logbuf_unlock_irq();
1542 /* Size of the log buffer */
1543 case SYSLOG_ACTION_SIZE_BUFFER:
1544 error = log_buf_len;
1554 SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
1556 return do_syslog(type, buf, len, SYSLOG_FROM_READER);
1560 * Special console_lock variants that help to reduce the risk of soft-lockups.
1561 * They allow to pass console_lock to another printk() call using a busy wait.
1564 #ifdef CONFIG_LOCKDEP
1565 static struct lockdep_map console_owner_dep_map = {
1566 .name = "console_owner"
1570 static DEFINE_RAW_SPINLOCK(console_owner_lock);
1571 static struct task_struct *console_owner;
1572 static bool console_waiter;
1575 * console_lock_spinning_enable - mark beginning of code where another
1576 * thread might safely busy wait
1578 * This basically converts console_lock into a spinlock. This marks
1579 * the section where the console_lock owner can not sleep, because
1580 * there may be a waiter spinning (like a spinlock). Also it must be
1581 * ready to hand over the lock at the end of the section.
1583 static void console_lock_spinning_enable(void)
1585 raw_spin_lock(&console_owner_lock);
1586 console_owner = current;
1587 raw_spin_unlock(&console_owner_lock);
1589 /* The waiter may spin on us after setting console_owner */
1590 spin_acquire(&console_owner_dep_map, 0, 0, _THIS_IP_);
1594 * console_lock_spinning_disable_and_check - mark end of code where another
1595 * thread was able to busy wait and check if there is a waiter
1597 * This is called at the end of the section where spinning is allowed.
1598 * It has two functions. First, it is a signal that it is no longer
1599 * safe to start busy waiting for the lock. Second, it checks if
1600 * there is a busy waiter and passes the lock rights to her.
1602 * Important: Callers lose the lock if there was a busy waiter.
1603 * They must not touch items synchronized by console_lock
1606 * Return: 1 if the lock rights were passed, 0 otherwise.
1608 static int console_lock_spinning_disable_and_check(void)
1612 raw_spin_lock(&console_owner_lock);
1613 waiter = READ_ONCE(console_waiter);
1614 console_owner = NULL;
1615 raw_spin_unlock(&console_owner_lock);
1618 spin_release(&console_owner_dep_map, 1, _THIS_IP_);
1622 /* The waiter is now free to continue */
1623 WRITE_ONCE(console_waiter, false);
1625 spin_release(&console_owner_dep_map, 1, _THIS_IP_);
1628 * Hand off console_lock to waiter. The waiter will perform
1629 * the up(). After this, the waiter is the console_lock owner.
1631 mutex_release(&console_lock_dep_map, 1, _THIS_IP_);
1636 * console_trylock_spinning - try to get console_lock by busy waiting
1638 * This allows to busy wait for the console_lock when the current
1639 * owner is running in specially marked sections. It means that
1640 * the current owner is running and cannot reschedule until it
1641 * is ready to lose the lock.
1643 * Return: 1 if we got the lock, 0 othrewise
1645 static int console_trylock_spinning(void)
1647 struct task_struct *owner = NULL;
1650 unsigned long flags;
1652 if (console_trylock())
1655 printk_safe_enter_irqsave(flags);
1657 raw_spin_lock(&console_owner_lock);
1658 owner = READ_ONCE(console_owner);
1659 waiter = READ_ONCE(console_waiter);
1660 if (!waiter && owner && owner != current) {
1661 WRITE_ONCE(console_waiter, true);
1664 raw_spin_unlock(&console_owner_lock);
1667 * If there is an active printk() writing to the
1668 * consoles, instead of having it write our data too,
1669 * see if we can offload that load from the active
1670 * printer, and do some printing ourselves.
1671 * Go into a spin only if there isn't already a waiter
1672 * spinning, and there is an active printer, and
1673 * that active printer isn't us (recursive printk?).
1676 printk_safe_exit_irqrestore(flags);
1680 /* We spin waiting for the owner to release us */
1681 spin_acquire(&console_owner_dep_map, 0, 0, _THIS_IP_);
1682 /* Owner will clear console_waiter on hand off */
1683 while (READ_ONCE(console_waiter))
1685 spin_release(&console_owner_dep_map, 1, _THIS_IP_);
1687 printk_safe_exit_irqrestore(flags);
1689 * The owner passed the console lock to us.
1690 * Since we did not spin on console lock, annotate
1691 * this as a trylock. Otherwise lockdep will
1694 mutex_acquire(&console_lock_dep_map, 0, 1, _THIS_IP_);
1700 * Call the console drivers, asking them to write out
1701 * log_buf[start] to log_buf[end - 1].
1702 * The console_lock must be held.
1704 static void call_console_drivers(const char *ext_text, size_t ext_len,
1705 const char *text, size_t len)
1707 struct console *con;
1709 trace_console_rcuidle(text, len);
1711 if (!console_drivers)
1714 for_each_console(con) {
1715 if (exclusive_console && con != exclusive_console)
1717 if (!(con->flags & CON_ENABLED))
1721 if (!cpu_online(smp_processor_id()) &&
1722 !(con->flags & CON_ANYTIME))
1724 if (con->flags & CON_EXTENDED)
1725 con->write(con, ext_text, ext_len);
1727 con->write(con, text, len);
1731 int printk_delay_msec __read_mostly;
1733 static inline void printk_delay(void)
1735 if (unlikely(printk_delay_msec)) {
1736 int m = printk_delay_msec;
1740 touch_nmi_watchdog();
1746 * Continuation lines are buffered, and not committed to the record buffer
1747 * until the line is complete, or a race forces it. The line fragments
1748 * though, are printed immediately to the consoles to ensure everything has
1749 * reached the console in case of a kernel crash.
1751 static struct cont {
1752 char buf[LOG_LINE_MAX];
1753 size_t len; /* length == 0 means unused buffer */
1754 struct task_struct *owner; /* task of first print*/
1755 u64 ts_nsec; /* time of first print */
1756 u8 level; /* log level of first message */
1757 u8 facility; /* log facility of first message */
1758 enum log_flags flags; /* prefix, newline flags */
1761 static void cont_flush(void)
1766 log_store(cont.facility, cont.level, cont.flags, cont.ts_nsec,
1767 NULL, 0, cont.buf, cont.len);
1771 static bool cont_add(int facility, int level, enum log_flags flags, const char *text, size_t len)
1774 * If ext consoles are present, flush and skip in-kernel
1775 * continuation. See nr_ext_console_drivers definition. Also, if
1776 * the line gets too long, split it up in separate records.
1778 if (nr_ext_console_drivers || cont.len + len > sizeof(cont.buf)) {
1784 cont.facility = facility;
1786 cont.owner = current;
1787 cont.ts_nsec = local_clock();
1791 memcpy(cont.buf + cont.len, text, len);
1794 // The original flags come from the first line,
1795 // but later continuations can add a newline.
1796 if (flags & LOG_NEWLINE) {
1797 cont.flags |= LOG_NEWLINE;
1801 if (cont.len > (sizeof(cont.buf) * 80) / 100)
1807 static size_t log_output(int facility, int level, enum log_flags lflags, const char *dict, size_t dictlen, char *text, size_t text_len)
1810 * If an earlier line was buffered, and we're a continuation
1811 * write from the same process, try to add it to the buffer.
1814 if (cont.owner == current && (lflags & LOG_CONT)) {
1815 if (cont_add(facility, level, lflags, text, text_len))
1818 /* Otherwise, make sure it's flushed */
1822 /* Skip empty continuation lines that couldn't be added - they just flush */
1823 if (!text_len && (lflags & LOG_CONT))
1826 /* If it doesn't end in a newline, try to buffer the current line */
1827 if (!(lflags & LOG_NEWLINE)) {
1828 if (cont_add(facility, level, lflags, text, text_len))
1832 /* Store it in the record log */
1833 return log_store(facility, level, lflags, 0, dict, dictlen, text, text_len);
1836 /* Must be called under logbuf_lock. */
1837 int vprintk_store(int facility, int level,
1838 const char *dict, size_t dictlen,
1839 const char *fmt, va_list args)
1841 static char textbuf[LOG_LINE_MAX];
1842 char *text = textbuf;
1844 enum log_flags lflags = 0;
1847 * The printf needs to come first; we need the syslog
1848 * prefix which might be passed-in as a parameter.
1850 text_len = vscnprintf(text, sizeof(textbuf), fmt, args);
1852 /* mark and strip a trailing newline */
1853 if (text_len && text[text_len-1] == '\n') {
1855 lflags |= LOG_NEWLINE;
1858 /* strip kernel syslog prefix and extract log level or control flags */
1859 if (facility == 0) {
1862 while ((kern_level = printk_get_level(text)) != 0) {
1863 switch (kern_level) {
1865 if (level == LOGLEVEL_DEFAULT)
1866 level = kern_level - '0';
1868 case 'd': /* KERN_DEFAULT */
1869 lflags |= LOG_PREFIX;
1871 case 'c': /* KERN_CONT */
1880 if (level == LOGLEVEL_DEFAULT)
1881 level = default_message_loglevel;
1884 lflags |= LOG_PREFIX|LOG_NEWLINE;
1886 return log_output(facility, level, lflags,
1887 dict, dictlen, text, text_len);
1890 asmlinkage int vprintk_emit(int facility, int level,
1891 const char *dict, size_t dictlen,
1892 const char *fmt, va_list args)
1895 bool in_sched = false;
1896 unsigned long flags;
1898 if (level == LOGLEVEL_SCHED) {
1899 level = LOGLEVEL_DEFAULT;
1903 boot_delay_msec(level);
1906 /* This stops the holder of console_sem just where we want him */
1907 logbuf_lock_irqsave(flags);
1908 printed_len = vprintk_store(facility, level, dict, dictlen, fmt, args);
1909 logbuf_unlock_irqrestore(flags);
1911 /* If called from the scheduler, we can not call up(). */
1914 * Disable preemption to avoid being preempted while holding
1915 * console_sem which would prevent anyone from printing to
1920 * Try to acquire and then immediately release the console
1921 * semaphore. The release will print out buffers and wake up
1922 * /dev/kmsg and syslog() users.
1924 if (console_trylock_spinning())
1931 EXPORT_SYMBOL(vprintk_emit);
1933 asmlinkage int vprintk(const char *fmt, va_list args)
1935 return vprintk_func(fmt, args);
1937 EXPORT_SYMBOL(vprintk);
1939 asmlinkage int printk_emit(int facility, int level,
1940 const char *dict, size_t dictlen,
1941 const char *fmt, ...)
1946 va_start(args, fmt);
1947 r = vprintk_emit(facility, level, dict, dictlen, fmt, args);
1952 EXPORT_SYMBOL(printk_emit);
1954 int vprintk_default(const char *fmt, va_list args)
1958 #ifdef CONFIG_KGDB_KDB
1959 /* Allow to pass printk() to kdb but avoid a recursion. */
1960 if (unlikely(kdb_trap_printk && kdb_printf_cpu < 0)) {
1961 r = vkdb_printf(KDB_MSGSRC_PRINTK, fmt, args);
1965 r = vprintk_emit(0, LOGLEVEL_DEFAULT, NULL, 0, fmt, args);
1969 EXPORT_SYMBOL_GPL(vprintk_default);
1972 * printk - print a kernel message
1973 * @fmt: format string
1975 * This is printk(). It can be called from any context. We want it to work.
1977 * We try to grab the console_lock. If we succeed, it's easy - we log the
1978 * output and call the console drivers. If we fail to get the semaphore, we
1979 * place the output into the log buffer and return. The current holder of
1980 * the console_sem will notice the new output in console_unlock(); and will
1981 * send it to the consoles before releasing the lock.
1983 * One effect of this deferred printing is that code which calls printk() and
1984 * then changes console_loglevel may break. This is because console_loglevel
1985 * is inspected when the actual printing occurs.
1990 * See the vsnprintf() documentation for format string extensions over C99.
1992 asmlinkage __visible int printk(const char *fmt, ...)
1997 va_start(args, fmt);
1998 r = vprintk_func(fmt, args);
2003 EXPORT_SYMBOL(printk);
2005 #else /* CONFIG_PRINTK */
2007 #define LOG_LINE_MAX 0
2008 #define PREFIX_MAX 0
2010 static u64 syslog_seq;
2011 static u32 syslog_idx;
2012 static u64 console_seq;
2013 static u32 console_idx;
2014 static u64 log_first_seq;
2015 static u32 log_first_idx;
2016 static u64 log_next_seq;
2017 static char *log_text(const struct printk_log *msg) { return NULL; }
2018 static char *log_dict(const struct printk_log *msg) { return NULL; }
2019 static struct printk_log *log_from_idx(u32 idx) { return NULL; }
2020 static u32 log_next(u32 idx) { return 0; }
2021 static ssize_t msg_print_ext_header(char *buf, size_t size,
2022 struct printk_log *msg,
2023 u64 seq) { return 0; }
2024 static ssize_t msg_print_ext_body(char *buf, size_t size,
2025 char *dict, size_t dict_len,
2026 char *text, size_t text_len) { return 0; }
2027 static void console_lock_spinning_enable(void) { }
2028 static int console_lock_spinning_disable_and_check(void) { return 0; }
2029 static void call_console_drivers(const char *ext_text, size_t ext_len,
2030 const char *text, size_t len) {}
2031 static size_t msg_print_text(const struct printk_log *msg,
2032 bool syslog, char *buf, size_t size) { return 0; }
2033 static bool suppress_message_printing(int level) { return false; }
2035 #endif /* CONFIG_PRINTK */
2037 #ifdef CONFIG_EARLY_PRINTK
2038 struct console *early_console;
2040 asmlinkage __visible void early_printk(const char *fmt, ...)
2050 n = vscnprintf(buf, sizeof(buf), fmt, ap);
2053 early_console->write(early_console, buf, n);
2057 static int __add_preferred_console(char *name, int idx, char *options,
2060 struct console_cmdline *c;
2064 * See if this tty is not yet registered, and
2065 * if we have a slot free.
2067 for (i = 0, c = console_cmdline;
2068 i < MAX_CMDLINECONSOLES && c->name[0];
2070 if (strcmp(c->name, name) == 0 && c->index == idx) {
2072 preferred_console = i;
2076 if (i == MAX_CMDLINECONSOLES)
2079 preferred_console = i;
2080 strlcpy(c->name, name, sizeof(c->name));
2081 c->options = options;
2082 braille_set_options(c, brl_options);
2088 * Set up a console. Called via do_early_param() in init/main.c
2089 * for each "console=" parameter in the boot command line.
2091 static int __init console_setup(char *str)
2093 char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for "ttyS" */
2094 char *s, *options, *brl_options = NULL;
2098 * console="" or console=null have been suggested as a way to
2099 * disable console output. Use ttynull that has been created
2100 * for exacly this purpose.
2102 if (str[0] == 0 || strcmp(str, "null") == 0) {
2103 __add_preferred_console("ttynull", 0, NULL, NULL);
2107 if (_braille_console_setup(&str, &brl_options))
2111 * Decode str into name, index, options.
2113 if (str[0] >= '0' && str[0] <= '9') {
2114 strcpy(buf, "ttyS");
2115 strncpy(buf + 4, str, sizeof(buf) - 5);
2117 strncpy(buf, str, sizeof(buf) - 1);
2119 buf[sizeof(buf) - 1] = 0;
2120 options = strchr(str, ',');
2124 if (!strcmp(str, "ttya"))
2125 strcpy(buf, "ttyS0");
2126 if (!strcmp(str, "ttyb"))
2127 strcpy(buf, "ttyS1");
2129 for (s = buf; *s; s++)
2130 if (isdigit(*s) || *s == ',')
2132 idx = simple_strtoul(s, NULL, 10);
2135 __add_preferred_console(buf, idx, options, brl_options);
2136 console_set_on_cmdline = 1;
2139 __setup("console=", console_setup);
2142 * add_preferred_console - add a device to the list of preferred consoles.
2143 * @name: device name
2144 * @idx: device index
2145 * @options: options for this console
2147 * The last preferred console added will be used for kernel messages
2148 * and stdin/out/err for init. Normally this is used by console_setup
2149 * above to handle user-supplied console arguments; however it can also
2150 * be used by arch-specific code either to override the user or more
2151 * commonly to provide a default console (ie from PROM variables) when
2152 * the user has not supplied one.
2154 int add_preferred_console(char *name, int idx, char *options)
2156 return __add_preferred_console(name, idx, options, NULL);
2159 bool console_suspend_enabled = true;
2160 EXPORT_SYMBOL(console_suspend_enabled);
2162 static int __init console_suspend_disable(char *str)
2164 console_suspend_enabled = false;
2167 __setup("no_console_suspend", console_suspend_disable);
2168 module_param_named(console_suspend, console_suspend_enabled,
2169 bool, S_IRUGO | S_IWUSR);
2170 MODULE_PARM_DESC(console_suspend, "suspend console during suspend"
2171 " and hibernate operations");
2174 * suspend_console - suspend the console subsystem
2176 * This disables printk() while we go into suspend states
2178 void suspend_console(void)
2180 if (!console_suspend_enabled)
2182 printk("Suspending console(s) (use no_console_suspend to debug)\n");
2184 console_suspended = 1;
2188 void resume_console(void)
2190 if (!console_suspend_enabled)
2193 console_suspended = 0;
2198 * console_cpu_notify - print deferred console messages after CPU hotplug
2201 * If printk() is called from a CPU that is not online yet, the messages
2202 * will be printed on the console only if there are CON_ANYTIME consoles.
2203 * This function is called when a new CPU comes online (or fails to come
2204 * up) or goes offline.
2206 static int console_cpu_notify(unsigned int cpu)
2208 if (!cpuhp_tasks_frozen) {
2209 /* If trylock fails, someone else is doing the printing */
2210 if (console_trylock())
2217 * console_lock - lock the console system for exclusive use.
2219 * Acquires a lock which guarantees that the caller has
2220 * exclusive access to the console system and the console_drivers list.
2222 * Can sleep, returns nothing.
2224 void console_lock(void)
2229 if (console_suspended)
2232 console_may_schedule = 1;
2234 EXPORT_SYMBOL(console_lock);
2237 * console_trylock - try to lock the console system for exclusive use.
2239 * Try to acquire a lock which guarantees that the caller has exclusive
2240 * access to the console system and the console_drivers list.
2242 * returns 1 on success, and 0 on failure to acquire the lock.
2244 int console_trylock(void)
2246 if (down_trylock_console_sem())
2248 if (console_suspended) {
2253 console_may_schedule = 0;
2256 EXPORT_SYMBOL(console_trylock);
2258 int is_console_locked(void)
2260 return console_locked;
2264 * Check if we have any console that is capable of printing while cpu is
2265 * booting or shutting down. Requires console_sem.
2267 static int have_callable_console(void)
2269 struct console *con;
2271 for_each_console(con)
2272 if ((con->flags & CON_ENABLED) &&
2273 (con->flags & CON_ANYTIME))
2280 * Can we actually use the console at this time on this cpu?
2282 * Console drivers may assume that per-cpu resources have been allocated. So
2283 * unless they're explicitly marked as being able to cope (CON_ANYTIME) don't
2284 * call them until this CPU is officially up.
2286 static inline int can_use_console(void)
2288 return cpu_online(raw_smp_processor_id()) || have_callable_console();
2292 * console_unlock - unlock the console system
2294 * Releases the console_lock which the caller holds on the console system
2295 * and the console driver list.
2297 * While the console_lock was held, console output may have been buffered
2298 * by printk(). If this is the case, console_unlock(); emits
2299 * the output prior to releasing the lock.
2301 * If there is output waiting, we wake /dev/kmsg and syslog() users.
2303 * console_unlock(); may be called from any context.
2305 void console_unlock(void)
2307 static char ext_text[CONSOLE_EXT_LOG_MAX];
2308 static char text[LOG_LINE_MAX + PREFIX_MAX];
2309 static u64 seen_seq;
2310 unsigned long flags;
2311 bool wake_klogd = false;
2312 bool do_cond_resched, retry;
2314 if (console_suspended) {
2320 * Console drivers are called with interrupts disabled, so
2321 * @console_may_schedule should be cleared before; however, we may
2322 * end up dumping a lot of lines, for example, if called from
2323 * console registration path, and should invoke cond_resched()
2324 * between lines if allowable. Not doing so can cause a very long
2325 * scheduling stall on a slow console leading to RCU stall and
2326 * softlockup warnings which exacerbate the issue with more
2327 * messages practically incapacitating the system.
2329 * console_trylock() is not able to detect the preemptive
2330 * context reliably. Therefore the value must be stored before
2331 * and cleared after the the "again" goto label.
2333 do_cond_resched = console_may_schedule;
2335 console_may_schedule = 0;
2338 * We released the console_sem lock, so we need to recheck if
2339 * cpu is online and (if not) is there at least one CON_ANYTIME
2342 if (!can_use_console()) {
2349 struct printk_log *msg;
2353 printk_safe_enter_irqsave(flags);
2354 raw_spin_lock(&logbuf_lock);
2355 if (seen_seq != log_next_seq) {
2357 seen_seq = log_next_seq;
2360 if (console_seq < log_first_seq) {
2361 len = sprintf(text, "** %u printk messages dropped ** ",
2362 (unsigned)(log_first_seq - console_seq));
2364 /* messages are gone, move to first one */
2365 console_seq = log_first_seq;
2366 console_idx = log_first_idx;
2371 if (console_seq == log_next_seq)
2374 msg = log_from_idx(console_idx);
2375 if (suppress_message_printing(msg->level)) {
2377 * Skip record we have buffered and already printed
2378 * directly to the console when we received it, and
2379 * record that has level above the console loglevel.
2381 console_idx = log_next(console_idx);
2386 len += msg_print_text(msg, false, text + len, sizeof(text) - len);
2387 if (nr_ext_console_drivers) {
2388 ext_len = msg_print_ext_header(ext_text,
2391 ext_len += msg_print_ext_body(ext_text + ext_len,
2392 sizeof(ext_text) - ext_len,
2393 log_dict(msg), msg->dict_len,
2394 log_text(msg), msg->text_len);
2396 console_idx = log_next(console_idx);
2398 raw_spin_unlock(&logbuf_lock);
2401 * While actively printing out messages, if another printk()
2402 * were to occur on another CPU, it may wait for this one to
2403 * finish. This task can not be preempted if there is a
2404 * waiter waiting to take over.
2406 console_lock_spinning_enable();
2408 stop_critical_timings(); /* don't trace print latency */
2409 call_console_drivers(ext_text, ext_len, text, len);
2410 start_critical_timings();
2412 if (console_lock_spinning_disable_and_check()) {
2413 printk_safe_exit_irqrestore(flags);
2417 printk_safe_exit_irqrestore(flags);
2419 if (do_cond_resched)
2425 /* Release the exclusive_console once it is used */
2426 if (unlikely(exclusive_console))
2427 exclusive_console = NULL;
2429 raw_spin_unlock(&logbuf_lock);
2434 * Someone could have filled up the buffer again, so re-check if there's
2435 * something to flush. In case we cannot trylock the console_sem again,
2436 * there's a new owner and the console_unlock() from them will do the
2437 * flush, no worries.
2439 raw_spin_lock(&logbuf_lock);
2440 retry = console_seq != log_next_seq;
2441 raw_spin_unlock(&logbuf_lock);
2442 printk_safe_exit_irqrestore(flags);
2444 if (retry && console_trylock())
2451 EXPORT_SYMBOL(console_unlock);
2454 * console_conditional_schedule - yield the CPU if required
2456 * If the console code is currently allowed to sleep, and
2457 * if this CPU should yield the CPU to another task, do
2460 * Must be called within console_lock();.
2462 void __sched console_conditional_schedule(void)
2464 if (console_may_schedule)
2467 EXPORT_SYMBOL(console_conditional_schedule);
2469 void console_unblank(void)
2474 * console_unblank can no longer be called in interrupt context unless
2475 * oops_in_progress is set to 1..
2477 if (oops_in_progress) {
2478 if (down_trylock_console_sem() != 0)
2484 console_may_schedule = 0;
2486 if ((c->flags & CON_ENABLED) && c->unblank)
2492 * console_flush_on_panic - flush console content on panic
2494 * Immediately output all pending messages no matter what.
2496 void console_flush_on_panic(void)
2499 * If someone else is holding the console lock, trylock will fail
2500 * and may_schedule may be set. Ignore and proceed to unlock so
2501 * that messages are flushed out. As this can be called from any
2502 * context and we don't want to get preempted while flushing,
2503 * ensure may_schedule is cleared.
2506 console_may_schedule = 0;
2511 * Return the console tty driver structure and its associated index
2513 struct tty_driver *console_device(int *index)
2516 struct tty_driver *driver = NULL;
2519 for_each_console(c) {
2522 driver = c->device(c, index);
2531 * Prevent further output on the passed console device so that (for example)
2532 * serial drivers can disable console output before suspending a port, and can
2533 * re-enable output afterwards.
2535 void console_stop(struct console *console)
2538 console->flags &= ~CON_ENABLED;
2541 EXPORT_SYMBOL(console_stop);
2543 void console_start(struct console *console)
2546 console->flags |= CON_ENABLED;
2549 EXPORT_SYMBOL(console_start);
2551 static int __read_mostly keep_bootcon;
2553 static int __init keep_bootcon_setup(char *str)
2556 pr_info("debug: skip boot console de-registration.\n");
2561 early_param("keep_bootcon", keep_bootcon_setup);
2564 * The console driver calls this routine during kernel initialization
2565 * to register the console printing procedure with printk() and to
2566 * print any messages that were printed by the kernel before the
2567 * console driver was initialized.
2569 * This can happen pretty early during the boot process (because of
2570 * early_printk) - sometimes before setup_arch() completes - be careful
2571 * of what kernel features are used - they may not be initialised yet.
2573 * There are two types of consoles - bootconsoles (early_printk) and
2574 * "real" consoles (everything which is not a bootconsole) which are
2575 * handled differently.
2576 * - Any number of bootconsoles can be registered at any time.
2577 * - As soon as a "real" console is registered, all bootconsoles
2578 * will be unregistered automatically.
2579 * - Once a "real" console is registered, any attempt to register a
2580 * bootconsoles will be rejected
2582 void register_console(struct console *newcon)
2585 unsigned long flags;
2586 struct console *bcon = NULL;
2587 struct console_cmdline *c;
2588 static bool has_preferred;
2590 if (console_drivers)
2591 for_each_console(bcon)
2592 if (WARN(bcon == newcon,
2593 "console '%s%d' already registered\n",
2594 bcon->name, bcon->index))
2598 * before we register a new CON_BOOT console, make sure we don't
2599 * already have a valid console
2601 if (console_drivers && newcon->flags & CON_BOOT) {
2602 /* find the last or real console */
2603 for_each_console(bcon) {
2604 if (!(bcon->flags & CON_BOOT)) {
2605 pr_info("Too late to register bootconsole %s%d\n",
2606 newcon->name, newcon->index);
2612 if (console_drivers && console_drivers->flags & CON_BOOT)
2613 bcon = console_drivers;
2615 if (!has_preferred || bcon || !console_drivers)
2616 has_preferred = preferred_console >= 0;
2619 * See if we want to use this console driver. If we
2620 * didn't select a console we take the first one
2621 * that registers here.
2623 if (!has_preferred) {
2624 if (newcon->index < 0)
2626 if (newcon->setup == NULL ||
2627 newcon->setup(newcon, NULL) == 0) {
2628 newcon->flags |= CON_ENABLED;
2629 if (newcon->device) {
2630 newcon->flags |= CON_CONSDEV;
2631 has_preferred = true;
2637 * See if this console matches one we selected on
2640 for (i = 0, c = console_cmdline;
2641 i < MAX_CMDLINECONSOLES && c->name[0];
2643 if (!newcon->match ||
2644 newcon->match(newcon, c->name, c->index, c->options) != 0) {
2645 /* default matching */
2646 BUILD_BUG_ON(sizeof(c->name) != sizeof(newcon->name));
2647 if (strcmp(c->name, newcon->name) != 0)
2649 if (newcon->index >= 0 &&
2650 newcon->index != c->index)
2652 if (newcon->index < 0)
2653 newcon->index = c->index;
2655 if (_braille_register_console(newcon, c))
2658 if (newcon->setup &&
2659 newcon->setup(newcon, c->options) != 0)
2663 newcon->flags |= CON_ENABLED;
2664 if (i == preferred_console) {
2665 newcon->flags |= CON_CONSDEV;
2666 has_preferred = true;
2671 if (!(newcon->flags & CON_ENABLED))
2675 * If we have a bootconsole, and are switching to a real console,
2676 * don't print everything out again, since when the boot console, and
2677 * the real console are the same physical device, it's annoying to
2678 * see the beginning boot messages twice
2680 if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
2681 newcon->flags &= ~CON_PRINTBUFFER;
2684 * Put this console in the list - keep the
2685 * preferred driver at the head of the list.
2688 if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
2689 newcon->next = console_drivers;
2690 console_drivers = newcon;
2692 newcon->next->flags &= ~CON_CONSDEV;
2694 newcon->next = console_drivers->next;
2695 console_drivers->next = newcon;
2698 if (newcon->flags & CON_EXTENDED)
2699 if (!nr_ext_console_drivers++)
2700 pr_info("printk: continuation disabled due to ext consoles, expect more fragments in /dev/kmsg\n");
2702 if (newcon->flags & CON_PRINTBUFFER) {
2704 * console_unlock(); will print out the buffered messages
2707 logbuf_lock_irqsave(flags);
2708 console_seq = syslog_seq;
2709 console_idx = syslog_idx;
2710 logbuf_unlock_irqrestore(flags);
2712 * We're about to replay the log buffer. Only do this to the
2713 * just-registered console to avoid excessive message spam to
2714 * the already-registered consoles.
2716 exclusive_console = newcon;
2719 console_sysfs_notify();
2722 * By unregistering the bootconsoles after we enable the real console
2723 * we get the "console xxx enabled" message on all the consoles -
2724 * boot consoles, real consoles, etc - this is to ensure that end
2725 * users know there might be something in the kernel's log buffer that
2726 * went to the bootconsole (that they do not see on the real console)
2728 pr_info("%sconsole [%s%d] enabled\n",
2729 (newcon->flags & CON_BOOT) ? "boot" : "" ,
2730 newcon->name, newcon->index);
2732 ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
2734 /* We need to iterate through all boot consoles, to make
2735 * sure we print everything out, before we unregister them.
2737 for_each_console(bcon)
2738 if (bcon->flags & CON_BOOT)
2739 unregister_console(bcon);
2742 EXPORT_SYMBOL(register_console);
2744 int unregister_console(struct console *console)
2746 struct console *a, *b;
2749 pr_info("%sconsole [%s%d] disabled\n",
2750 (console->flags & CON_BOOT) ? "boot" : "" ,
2751 console->name, console->index);
2753 res = _braille_unregister_console(console);
2759 if (console_drivers == console) {
2760 console_drivers=console->next;
2762 } else if (console_drivers) {
2763 for (a=console_drivers->next, b=console_drivers ;
2764 a; b=a, a=b->next) {
2773 if (!res && (console->flags & CON_EXTENDED))
2774 nr_ext_console_drivers--;
2777 * If this isn't the last console and it has CON_CONSDEV set, we
2778 * need to set it on the next preferred console.
2780 if (console_drivers != NULL && console->flags & CON_CONSDEV)
2781 console_drivers->flags |= CON_CONSDEV;
2783 console->flags &= ~CON_ENABLED;
2785 console_sysfs_notify();
2788 EXPORT_SYMBOL(unregister_console);
2791 * Initialize the console device. This is called *early*, so
2792 * we can't necessarily depend on lots of kernel help here.
2793 * Just do some early initializations, and do the complex setup
2796 void __init console_init(void)
2800 /* Setup the default TTY line discipline. */
2804 * set up the console device so that later boot sequences can
2805 * inform about problems etc..
2807 call = __con_initcall_start;
2808 while (call < __con_initcall_end) {
2815 * Some boot consoles access data that is in the init section and which will
2816 * be discarded after the initcalls have been run. To make sure that no code
2817 * will access this data, unregister the boot consoles in a late initcall.
2819 * If for some reason, such as deferred probe or the driver being a loadable
2820 * module, the real console hasn't registered yet at this point, there will
2821 * be a brief interval in which no messages are logged to the console, which
2822 * makes it difficult to diagnose problems that occur during this time.
2824 * To mitigate this problem somewhat, only unregister consoles whose memory
2825 * intersects with the init section. Note that all other boot consoles will
2826 * get unregistred when the real preferred console is registered.
2828 static int __init printk_late_init(void)
2830 struct console *con;
2833 for_each_console(con) {
2834 if (!(con->flags & CON_BOOT))
2837 /* Check addresses that might be used for enabled consoles. */
2838 if (init_section_intersects(con, sizeof(*con)) ||
2839 init_section_contains(con->write, 0) ||
2840 init_section_contains(con->read, 0) ||
2841 init_section_contains(con->device, 0) ||
2842 init_section_contains(con->unblank, 0) ||
2843 init_section_contains(con->data, 0)) {
2845 * Please, consider moving the reported consoles out
2846 * of the init section.
2848 pr_warn("bootconsole [%s%d] uses init memory and must be disabled even before the real one is ready\n",
2849 con->name, con->index);
2850 unregister_console(con);
2853 ret = cpuhp_setup_state_nocalls(CPUHP_PRINTK_DEAD, "printk:dead", NULL,
2854 console_cpu_notify);
2856 ret = cpuhp_setup_state_nocalls(CPUHP_AP_ONLINE_DYN, "printk:online",
2857 console_cpu_notify, NULL);
2861 late_initcall(printk_late_init);
2863 #if defined CONFIG_PRINTK
2865 * Delayed printk version, for scheduler-internal messages:
2867 #define PRINTK_PENDING_WAKEUP 0x01
2868 #define PRINTK_PENDING_OUTPUT 0x02
2870 static DEFINE_PER_CPU(int, printk_pending);
2872 static void wake_up_klogd_work_func(struct irq_work *irq_work)
2874 int pending = __this_cpu_xchg(printk_pending, 0);
2876 if (pending & PRINTK_PENDING_OUTPUT) {
2877 /* If trylock fails, someone else is doing the printing */
2878 if (console_trylock())
2882 if (pending & PRINTK_PENDING_WAKEUP)
2883 wake_up_interruptible(&log_wait);
2886 static DEFINE_PER_CPU(struct irq_work, wake_up_klogd_work) = {
2887 .func = wake_up_klogd_work_func,
2888 .flags = IRQ_WORK_LAZY,
2891 void wake_up_klogd(void)
2894 if (waitqueue_active(&log_wait)) {
2895 this_cpu_or(printk_pending, PRINTK_PENDING_WAKEUP);
2896 irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2901 void defer_console_output(void)
2904 __this_cpu_or(printk_pending, PRINTK_PENDING_OUTPUT);
2905 irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2909 int vprintk_deferred(const char *fmt, va_list args)
2913 r = vprintk_emit(0, LOGLEVEL_SCHED, NULL, 0, fmt, args);
2914 defer_console_output();
2919 int printk_deferred(const char *fmt, ...)
2924 va_start(args, fmt);
2925 r = vprintk_deferred(fmt, args);
2932 * printk rate limiting, lifted from the networking subsystem.
2934 * This enforces a rate limit: not more than 10 kernel messages
2935 * every 5s to make a denial-of-service attack impossible.
2937 DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
2939 int __printk_ratelimit(const char *func)
2941 return ___ratelimit(&printk_ratelimit_state, func);
2943 EXPORT_SYMBOL(__printk_ratelimit);
2946 * printk_timed_ratelimit - caller-controlled printk ratelimiting
2947 * @caller_jiffies: pointer to caller's state
2948 * @interval_msecs: minimum interval between prints
2950 * printk_timed_ratelimit() returns true if more than @interval_msecs
2951 * milliseconds have elapsed since the last time printk_timed_ratelimit()
2954 bool printk_timed_ratelimit(unsigned long *caller_jiffies,
2955 unsigned int interval_msecs)
2957 unsigned long elapsed = jiffies - *caller_jiffies;
2959 if (*caller_jiffies && elapsed <= msecs_to_jiffies(interval_msecs))
2962 *caller_jiffies = jiffies;
2965 EXPORT_SYMBOL(printk_timed_ratelimit);
2967 static DEFINE_SPINLOCK(dump_list_lock);
2968 static LIST_HEAD(dump_list);
2971 * kmsg_dump_register - register a kernel log dumper.
2972 * @dumper: pointer to the kmsg_dumper structure
2974 * Adds a kernel log dumper to the system. The dump callback in the
2975 * structure will be called when the kernel oopses or panics and must be
2976 * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
2978 int kmsg_dump_register(struct kmsg_dumper *dumper)
2980 unsigned long flags;
2983 /* The dump callback needs to be set */
2987 spin_lock_irqsave(&dump_list_lock, flags);
2988 /* Don't allow registering multiple times */
2989 if (!dumper->registered) {
2990 dumper->registered = 1;
2991 list_add_tail_rcu(&dumper->list, &dump_list);
2994 spin_unlock_irqrestore(&dump_list_lock, flags);
2998 EXPORT_SYMBOL_GPL(kmsg_dump_register);
3001 * kmsg_dump_unregister - unregister a kmsg dumper.
3002 * @dumper: pointer to the kmsg_dumper structure
3004 * Removes a dump device from the system. Returns zero on success and
3005 * %-EINVAL otherwise.
3007 int kmsg_dump_unregister(struct kmsg_dumper *dumper)
3009 unsigned long flags;
3012 spin_lock_irqsave(&dump_list_lock, flags);
3013 if (dumper->registered) {
3014 dumper->registered = 0;
3015 list_del_rcu(&dumper->list);
3018 spin_unlock_irqrestore(&dump_list_lock, flags);
3023 EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
3025 static bool always_kmsg_dump;
3026 module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);
3029 * kmsg_dump - dump kernel log to kernel message dumpers.
3030 * @reason: the reason (oops, panic etc) for dumping
3032 * Call each of the registered dumper's dump() callback, which can
3033 * retrieve the kmsg records with kmsg_dump_get_line() or
3034 * kmsg_dump_get_buffer().
3036 void kmsg_dump(enum kmsg_dump_reason reason)
3038 struct kmsg_dumper *dumper;
3039 unsigned long flags;
3041 if ((reason > KMSG_DUMP_OOPS) && !always_kmsg_dump)
3045 list_for_each_entry_rcu(dumper, &dump_list, list) {
3046 if (dumper->max_reason && reason > dumper->max_reason)
3049 /* initialize iterator with data about the stored records */
3050 dumper->active = true;
3052 logbuf_lock_irqsave(flags);
3053 dumper->cur_seq = clear_seq;
3054 dumper->cur_idx = clear_idx;
3055 dumper->next_seq = log_next_seq;
3056 dumper->next_idx = log_next_idx;
3057 logbuf_unlock_irqrestore(flags);
3059 /* invoke dumper which will iterate over records */
3060 dumper->dump(dumper, reason);
3062 /* reset iterator */
3063 dumper->active = false;
3069 * kmsg_dump_get_line_nolock - retrieve one kmsg log line (unlocked version)
3070 * @dumper: registered kmsg dumper
3071 * @syslog: include the "<4>" prefixes
3072 * @line: buffer to copy the line to
3073 * @size: maximum size of the buffer
3074 * @len: length of line placed into buffer
3076 * Start at the beginning of the kmsg buffer, with the oldest kmsg
3077 * record, and copy one record into the provided buffer.
3079 * Consecutive calls will return the next available record moving
3080 * towards the end of the buffer with the youngest messages.
3082 * A return value of FALSE indicates that there are no more records to
3085 * The function is similar to kmsg_dump_get_line(), but grabs no locks.
3087 bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper, bool syslog,
3088 char *line, size_t size, size_t *len)
3090 struct printk_log *msg;
3094 if (!dumper->active)
3097 if (dumper->cur_seq < log_first_seq) {
3098 /* messages are gone, move to first available one */
3099 dumper->cur_seq = log_first_seq;
3100 dumper->cur_idx = log_first_idx;
3104 if (dumper->cur_seq >= log_next_seq)
3107 msg = log_from_idx(dumper->cur_idx);
3108 l = msg_print_text(msg, syslog, line, size);
3110 dumper->cur_idx = log_next(dumper->cur_idx);
3120 * kmsg_dump_get_line - retrieve one kmsg log line
3121 * @dumper: registered kmsg dumper
3122 * @syslog: include the "<4>" prefixes
3123 * @line: buffer to copy the line to
3124 * @size: maximum size of the buffer
3125 * @len: length of line placed into buffer
3127 * Start at the beginning of the kmsg buffer, with the oldest kmsg
3128 * record, and copy one record into the provided buffer.
3130 * Consecutive calls will return the next available record moving
3131 * towards the end of the buffer with the youngest messages.
3133 * A return value of FALSE indicates that there are no more records to
3136 bool kmsg_dump_get_line(struct kmsg_dumper *dumper, bool syslog,
3137 char *line, size_t size, size_t *len)
3139 unsigned long flags;
3142 logbuf_lock_irqsave(flags);
3143 ret = kmsg_dump_get_line_nolock(dumper, syslog, line, size, len);
3144 logbuf_unlock_irqrestore(flags);
3148 EXPORT_SYMBOL_GPL(kmsg_dump_get_line);
3151 * kmsg_dump_get_buffer - copy kmsg log lines
3152 * @dumper: registered kmsg dumper
3153 * @syslog: include the "<4>" prefixes
3154 * @buf: buffer to copy the line to
3155 * @size: maximum size of the buffer
3156 * @len: length of line placed into buffer
3158 * Start at the end of the kmsg buffer and fill the provided buffer
3159 * with as many of the the *youngest* kmsg records that fit into it.
3160 * If the buffer is large enough, all available kmsg records will be
3161 * copied with a single call.
3163 * Consecutive calls will fill the buffer with the next block of
3164 * available older records, not including the earlier retrieved ones.
3166 * A return value of FALSE indicates that there are no more records to
3169 bool kmsg_dump_get_buffer(struct kmsg_dumper *dumper, bool syslog,
3170 char *buf, size_t size, size_t *len)
3172 unsigned long flags;
3180 if (!dumper->active)
3183 logbuf_lock_irqsave(flags);
3184 if (dumper->cur_seq < log_first_seq) {
3185 /* messages are gone, move to first available one */
3186 dumper->cur_seq = log_first_seq;
3187 dumper->cur_idx = log_first_idx;
3191 if (dumper->cur_seq >= dumper->next_seq) {
3192 logbuf_unlock_irqrestore(flags);
3196 /* calculate length of entire buffer */
3197 seq = dumper->cur_seq;
3198 idx = dumper->cur_idx;
3199 while (seq < dumper->next_seq) {
3200 struct printk_log *msg = log_from_idx(idx);
3202 l += msg_print_text(msg, true, NULL, 0);
3203 idx = log_next(idx);
3207 /* move first record forward until length fits into the buffer */
3208 seq = dumper->cur_seq;
3209 idx = dumper->cur_idx;
3210 while (l >= size && seq < dumper->next_seq) {
3211 struct printk_log *msg = log_from_idx(idx);
3213 l -= msg_print_text(msg, true, NULL, 0);
3214 idx = log_next(idx);
3218 /* last message in next interation */
3223 while (seq < dumper->next_seq) {
3224 struct printk_log *msg = log_from_idx(idx);
3226 l += msg_print_text(msg, syslog, buf + l, size - l);
3227 idx = log_next(idx);
3231 dumper->next_seq = next_seq;
3232 dumper->next_idx = next_idx;
3234 logbuf_unlock_irqrestore(flags);
3240 EXPORT_SYMBOL_GPL(kmsg_dump_get_buffer);
3243 * kmsg_dump_rewind_nolock - reset the interator (unlocked version)
3244 * @dumper: registered kmsg dumper
3246 * Reset the dumper's iterator so that kmsg_dump_get_line() and
3247 * kmsg_dump_get_buffer() can be called again and used multiple
3248 * times within the same dumper.dump() callback.
3250 * The function is similar to kmsg_dump_rewind(), but grabs no locks.
3252 void kmsg_dump_rewind_nolock(struct kmsg_dumper *dumper)
3254 dumper->cur_seq = clear_seq;
3255 dumper->cur_idx = clear_idx;
3256 dumper->next_seq = log_next_seq;
3257 dumper->next_idx = log_next_idx;
3261 * kmsg_dump_rewind - reset the interator
3262 * @dumper: registered kmsg dumper
3264 * Reset the dumper's iterator so that kmsg_dump_get_line() and
3265 * kmsg_dump_get_buffer() can be called again and used multiple
3266 * times within the same dumper.dump() callback.
3268 void kmsg_dump_rewind(struct kmsg_dumper *dumper)
3270 unsigned long flags;
3272 logbuf_lock_irqsave(flags);
3273 kmsg_dump_rewind_nolock(dumper);
3274 logbuf_unlock_irqrestore(flags);
3276 EXPORT_SYMBOL_GPL(kmsg_dump_rewind);
3278 static char dump_stack_arch_desc_str[128];
3281 * dump_stack_set_arch_desc - set arch-specific str to show with task dumps
3282 * @fmt: printf-style format string
3283 * @...: arguments for the format string
3285 * The configured string will be printed right after utsname during task
3286 * dumps. Usually used to add arch-specific system identifiers. If an
3287 * arch wants to make use of such an ID string, it should initialize this
3288 * as soon as possible during boot.
3290 void __init dump_stack_set_arch_desc(const char *fmt, ...)
3294 va_start(args, fmt);
3295 vsnprintf(dump_stack_arch_desc_str, sizeof(dump_stack_arch_desc_str),
3301 * dump_stack_print_info - print generic debug info for dump_stack()
3302 * @log_lvl: log level
3304 * Arch-specific dump_stack() implementations can use this function to
3305 * print out the same debug information as the generic dump_stack().
3307 void dump_stack_print_info(const char *log_lvl)
3309 printk("%sCPU: %d PID: %d Comm: %.20s %s %s %.*s\n",
3310 log_lvl, raw_smp_processor_id(), current->pid, current->comm,
3311 print_tainted(), init_utsname()->release,
3312 (int)strcspn(init_utsname()->version, " "),
3313 init_utsname()->version);
3315 if (dump_stack_arch_desc_str[0] != '\0')
3316 printk("%sHardware name: %s\n",
3317 log_lvl, dump_stack_arch_desc_str);
3319 print_worker_info(log_lvl, current);
3323 * show_regs_print_info - print generic debug info for show_regs()
3324 * @log_lvl: log level
3326 * show_regs() implementations can use this function to print out generic
3327 * debug information.
3329 void show_regs_print_info(const char *log_lvl)
3331 dump_stack_print_info(log_lvl);
3333 printk("%stask: %p task.stack: %p\n",
3334 log_lvl, current, task_stack_page(current));