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/rculist.h>
42 #include <linux/poll.h>
43 #include <linux/irq_work.h>
44 #include <linux/ctype.h>
45 #include <linux/uio.h>
46 #include <linux/sched/clock.h>
47 #include <linux/sched/debug.h>
48 #include <linux/sched/task_stack.h>
50 #include <linux/uaccess.h>
51 #include <asm/sections.h>
53 #include <trace/events/initcall.h>
54 #define CREATE_TRACE_POINTS
55 #include <trace/events/printk.h>
57 #include "console_cmdline.h"
61 int console_printk[4] = {
62 CONSOLE_LOGLEVEL_DEFAULT, /* console_loglevel */
63 MESSAGE_LOGLEVEL_DEFAULT, /* default_message_loglevel */
64 CONSOLE_LOGLEVEL_MIN, /* minimum_console_loglevel */
65 CONSOLE_LOGLEVEL_DEFAULT, /* default_console_loglevel */
68 atomic_t ignore_console_lock_warning __read_mostly = ATOMIC_INIT(0);
69 EXPORT_SYMBOL(ignore_console_lock_warning);
72 * Low level drivers may need that to know if they can schedule in
73 * their unblank() callback or not. So let's export it.
76 EXPORT_SYMBOL(oops_in_progress);
79 * console_sem protects the console_drivers list, and also
80 * provides serialisation for access to the entire console
83 static DEFINE_SEMAPHORE(console_sem);
84 struct console *console_drivers;
85 EXPORT_SYMBOL_GPL(console_drivers);
88 static struct lockdep_map console_lock_dep_map = {
89 .name = "console_lock"
93 enum devkmsg_log_bits {
94 __DEVKMSG_LOG_BIT_ON = 0,
95 __DEVKMSG_LOG_BIT_OFF,
96 __DEVKMSG_LOG_BIT_LOCK,
99 enum devkmsg_log_masks {
100 DEVKMSG_LOG_MASK_ON = BIT(__DEVKMSG_LOG_BIT_ON),
101 DEVKMSG_LOG_MASK_OFF = BIT(__DEVKMSG_LOG_BIT_OFF),
102 DEVKMSG_LOG_MASK_LOCK = BIT(__DEVKMSG_LOG_BIT_LOCK),
105 /* Keep both the 'on' and 'off' bits clear, i.e. ratelimit by default: */
106 #define DEVKMSG_LOG_MASK_DEFAULT 0
108 static unsigned int __read_mostly devkmsg_log = DEVKMSG_LOG_MASK_DEFAULT;
110 static int __control_devkmsg(char *str)
115 if (!strncmp(str, "on", 2)) {
116 devkmsg_log = DEVKMSG_LOG_MASK_ON;
118 } else if (!strncmp(str, "off", 3)) {
119 devkmsg_log = DEVKMSG_LOG_MASK_OFF;
121 } else if (!strncmp(str, "ratelimit", 9)) {
122 devkmsg_log = DEVKMSG_LOG_MASK_DEFAULT;
128 static int __init control_devkmsg(char *str)
130 if (__control_devkmsg(str) < 0)
134 * Set sysctl string accordingly:
136 if (devkmsg_log == DEVKMSG_LOG_MASK_ON)
137 strcpy(devkmsg_log_str, "on");
138 else if (devkmsg_log == DEVKMSG_LOG_MASK_OFF)
139 strcpy(devkmsg_log_str, "off");
140 /* else "ratelimit" which is set by default. */
143 * Sysctl cannot change it anymore. The kernel command line setting of
144 * this parameter is to force the setting to be permanent throughout the
145 * runtime of the system. This is a precation measure against userspace
146 * trying to be a smarta** and attempting to change it up on us.
148 devkmsg_log |= DEVKMSG_LOG_MASK_LOCK;
152 __setup("printk.devkmsg=", control_devkmsg);
154 char devkmsg_log_str[DEVKMSG_STR_MAX_SIZE] = "ratelimit";
156 int devkmsg_sysctl_set_loglvl(struct ctl_table *table, int write,
157 void __user *buffer, size_t *lenp, loff_t *ppos)
159 char old_str[DEVKMSG_STR_MAX_SIZE];
164 if (devkmsg_log & DEVKMSG_LOG_MASK_LOCK)
168 strncpy(old_str, devkmsg_log_str, DEVKMSG_STR_MAX_SIZE);
171 err = proc_dostring(table, write, buffer, lenp, ppos);
176 err = __control_devkmsg(devkmsg_log_str);
179 * Do not accept an unknown string OR a known string with
182 if (err < 0 || (err + 1 != *lenp)) {
184 /* ... and restore old setting. */
186 strncpy(devkmsg_log_str, old_str, DEVKMSG_STR_MAX_SIZE);
196 * Number of registered extended console drivers.
198 * If extended consoles are present, in-kernel cont reassembly is disabled
199 * and each fragment is stored as a separate log entry with proper
200 * continuation flag so that every emitted message has full metadata. This
201 * doesn't change the result for regular consoles or /proc/kmsg. For
202 * /dev/kmsg, as long as the reader concatenates messages according to
203 * consecutive continuation flags, the end result should be the same too.
205 static int nr_ext_console_drivers;
208 * Helper macros to handle lockdep when locking/unlocking console_sem. We use
209 * macros instead of functions so that _RET_IP_ contains useful information.
211 #define down_console_sem() do { \
213 mutex_acquire(&console_lock_dep_map, 0, 0, _RET_IP_);\
216 static int __down_trylock_console_sem(unsigned long ip)
222 * Here and in __up_console_sem() we need to be in safe mode,
223 * because spindump/WARN/etc from under console ->lock will
224 * deadlock in printk()->down_trylock_console_sem() otherwise.
226 printk_safe_enter_irqsave(flags);
227 lock_failed = down_trylock(&console_sem);
228 printk_safe_exit_irqrestore(flags);
232 mutex_acquire(&console_lock_dep_map, 0, 1, ip);
235 #define down_trylock_console_sem() __down_trylock_console_sem(_RET_IP_)
237 static void __up_console_sem(unsigned long ip)
241 mutex_release(&console_lock_dep_map, 1, ip);
243 printk_safe_enter_irqsave(flags);
245 printk_safe_exit_irqrestore(flags);
247 #define up_console_sem() __up_console_sem(_RET_IP_)
250 * This is used for debugging the mess that is the VT code by
251 * keeping track if we have the console semaphore held. It's
252 * definitely not the perfect debug tool (we don't know if _WE_
253 * hold it and are racing, but it helps tracking those weird code
254 * paths in the console code where we end up in places I want
255 * locked without the console sempahore held).
257 static int console_locked, console_suspended;
260 * If exclusive_console is non-NULL then only this console is to be printed to.
262 static struct console *exclusive_console;
265 * Array of consoles built from command line options (console=)
268 #define MAX_CMDLINECONSOLES 8
270 static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
272 static int preferred_console = -1;
273 int console_set_on_cmdline;
274 EXPORT_SYMBOL(console_set_on_cmdline);
276 /* Flag: console code may call schedule() */
277 static int console_may_schedule;
279 enum con_msg_format_flags {
280 MSG_FORMAT_DEFAULT = 0,
281 MSG_FORMAT_SYSLOG = (1 << 0),
284 static int console_msg_format = MSG_FORMAT_DEFAULT;
287 * The printk log buffer consists of a chain of concatenated variable
288 * length records. Every record starts with a record header, containing
289 * the overall length of the record.
291 * The heads to the first and last entry in the buffer, as well as the
292 * sequence numbers of these entries are maintained when messages are
295 * If the heads indicate available messages, the length in the header
296 * tells the start next message. A length == 0 for the next message
297 * indicates a wrap-around to the beginning of the buffer.
299 * Every record carries the monotonic timestamp in microseconds, as well as
300 * the standard userspace syslog level and syslog facility. The usual
301 * kernel messages use LOG_KERN; userspace-injected messages always carry
302 * a matching syslog facility, by default LOG_USER. The origin of every
303 * message can be reliably determined that way.
305 * The human readable log message directly follows the message header. The
306 * length of the message text is stored in the header, the stored message
309 * Optionally, a message can carry a dictionary of properties (key/value pairs),
310 * to provide userspace with a machine-readable message context.
312 * Examples for well-defined, commonly used property names are:
313 * DEVICE=b12:8 device identifier
317 * +sound:card0 subsystem:devname
318 * SUBSYSTEM=pci driver-core subsystem name
320 * Valid characters in property names are [a-zA-Z0-9.-_]. The plain text value
321 * follows directly after a '=' character. Every property is terminated by
322 * a '\0' character. The last property is not terminated.
324 * Example of a message structure:
325 * 0000 ff 8f 00 00 00 00 00 00 monotonic time in nsec
326 * 0008 34 00 record is 52 bytes long
327 * 000a 0b 00 text is 11 bytes long
328 * 000c 1f 00 dictionary is 23 bytes long
329 * 000e 03 00 LOG_KERN (facility) LOG_ERR (level)
330 * 0010 69 74 27 73 20 61 20 6c "it's a l"
332 * 001b 44 45 56 49 43 "DEVIC"
333 * 45 3d 62 38 3a 32 00 44 "E=b8:2\0D"
334 * 52 49 56 45 52 3d 62 75 "RIVER=bu"
336 * 0032 00 00 00 padding to next message header
338 * The 'struct printk_log' buffer header must never be directly exported to
339 * userspace, it is a kernel-private implementation detail that might
340 * need to be changed in the future, when the requirements change.
342 * /dev/kmsg exports the structured data in the following line format:
343 * "<level>,<sequnum>,<timestamp>,<contflag>[,additional_values, ... ];<message text>\n"
345 * Users of the export format should ignore possible additional values
346 * separated by ',', and find the message after the ';' character.
348 * The optional key/value pairs are attached as continuation lines starting
349 * with a space character and terminated by a newline. All possible
350 * non-prinatable characters are escaped in the "\xff" notation.
354 LOG_NEWLINE = 2, /* text ended with a newline */
355 LOG_PREFIX = 4, /* text started with a prefix */
356 LOG_CONT = 8, /* text is a fragment of a continuation line */
360 u64 ts_nsec; /* timestamp in nanoseconds */
361 u16 len; /* length of entire record */
362 u16 text_len; /* length of text buffer */
363 u16 dict_len; /* length of dictionary buffer */
364 u8 facility; /* syslog facility */
365 u8 flags:5; /* internal record flags */
366 u8 level:3; /* syslog level */
368 #ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
369 __packed __aligned(4)
374 * The logbuf_lock protects kmsg buffer, indices, counters. This can be taken
375 * within the scheduler's rq lock. It must be released before calling
376 * console_unlock() or anything else that might wake up a process.
378 DEFINE_RAW_SPINLOCK(logbuf_lock);
381 * Helper macros to lock/unlock logbuf_lock and switch between
382 * printk-safe/unsafe modes.
384 #define logbuf_lock_irq() \
386 printk_safe_enter_irq(); \
387 raw_spin_lock(&logbuf_lock); \
390 #define logbuf_unlock_irq() \
392 raw_spin_unlock(&logbuf_lock); \
393 printk_safe_exit_irq(); \
396 #define logbuf_lock_irqsave(flags) \
398 printk_safe_enter_irqsave(flags); \
399 raw_spin_lock(&logbuf_lock); \
402 #define logbuf_unlock_irqrestore(flags) \
404 raw_spin_unlock(&logbuf_lock); \
405 printk_safe_exit_irqrestore(flags); \
409 DECLARE_WAIT_QUEUE_HEAD(log_wait);
410 /* the next printk record to read by syslog(READ) or /proc/kmsg */
411 static u64 syslog_seq;
412 static u32 syslog_idx;
413 static size_t syslog_partial;
415 /* index and sequence number of the first record stored in the buffer */
416 static u64 log_first_seq;
417 static u32 log_first_idx;
419 /* index and sequence number of the next record to store in the buffer */
420 static u64 log_next_seq;
421 static u32 log_next_idx;
423 /* the next printk record to write to the console */
424 static u64 console_seq;
425 static u32 console_idx;
427 /* the next printk record to read after the last 'clear' command */
428 static u64 clear_seq;
429 static u32 clear_idx;
431 #define PREFIX_MAX 32
432 #define LOG_LINE_MAX (1024 - PREFIX_MAX)
434 #define LOG_LEVEL(v) ((v) & 0x07)
435 #define LOG_FACILITY(v) ((v) >> 3 & 0xff)
438 #define LOG_ALIGN __alignof__(struct printk_log)
439 #define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
440 static char __log_buf[__LOG_BUF_LEN] __aligned(LOG_ALIGN);
441 static char *log_buf = __log_buf;
442 static u32 log_buf_len = __LOG_BUF_LEN;
444 /* Return log buffer address */
445 char *log_buf_addr_get(void)
450 /* Return log buffer size */
451 u32 log_buf_len_get(void)
456 /* human readable text of the record */
457 static char *log_text(const struct printk_log *msg)
459 return (char *)msg + sizeof(struct printk_log);
462 /* optional key/value pair dictionary attached to the record */
463 static char *log_dict(const struct printk_log *msg)
465 return (char *)msg + sizeof(struct printk_log) + msg->text_len;
468 /* get record by index; idx must point to valid msg */
469 static struct printk_log *log_from_idx(u32 idx)
471 struct printk_log *msg = (struct printk_log *)(log_buf + idx);
474 * A length == 0 record is the end of buffer marker. Wrap around and
475 * read the message at the start of the buffer.
478 return (struct printk_log *)log_buf;
482 /* get next record; idx must point to valid msg */
483 static u32 log_next(u32 idx)
485 struct printk_log *msg = (struct printk_log *)(log_buf + idx);
487 /* length == 0 indicates the end of the buffer; wrap */
489 * A length == 0 record is the end of buffer marker. Wrap around and
490 * read the message at the start of the buffer as *this* one, and
491 * return the one after that.
494 msg = (struct printk_log *)log_buf;
497 return idx + msg->len;
501 * Check whether there is enough free space for the given message.
503 * The same values of first_idx and next_idx mean that the buffer
504 * is either empty or full.
506 * If the buffer is empty, we must respect the position of the indexes.
507 * They cannot be reset to the beginning of the buffer.
509 static int logbuf_has_space(u32 msg_size, bool empty)
513 if (log_next_idx > log_first_idx || empty)
514 free = max(log_buf_len - log_next_idx, log_first_idx);
516 free = log_first_idx - log_next_idx;
519 * We need space also for an empty header that signalizes wrapping
522 return free >= msg_size + sizeof(struct printk_log);
525 static int log_make_free_space(u32 msg_size)
527 while (log_first_seq < log_next_seq &&
528 !logbuf_has_space(msg_size, false)) {
529 /* drop old messages until we have enough contiguous space */
530 log_first_idx = log_next(log_first_idx);
534 if (clear_seq < log_first_seq) {
535 clear_seq = log_first_seq;
536 clear_idx = log_first_idx;
539 /* sequence numbers are equal, so the log buffer is empty */
540 if (logbuf_has_space(msg_size, log_first_seq == log_next_seq))
546 /* compute the message size including the padding bytes */
547 static u32 msg_used_size(u16 text_len, u16 dict_len, u32 *pad_len)
551 size = sizeof(struct printk_log) + text_len + dict_len;
552 *pad_len = (-size) & (LOG_ALIGN - 1);
559 * Define how much of the log buffer we could take at maximum. The value
560 * must be greater than two. Note that only half of the buffer is available
561 * when the index points to the middle.
563 #define MAX_LOG_TAKE_PART 4
564 static const char trunc_msg[] = "<truncated>";
566 static u32 truncate_msg(u16 *text_len, u16 *trunc_msg_len,
567 u16 *dict_len, u32 *pad_len)
570 * The message should not take the whole buffer. Otherwise, it might
571 * get removed too soon.
573 u32 max_text_len = log_buf_len / MAX_LOG_TAKE_PART;
574 if (*text_len > max_text_len)
575 *text_len = max_text_len;
576 /* enable the warning message */
577 *trunc_msg_len = strlen(trunc_msg);
578 /* disable the "dict" completely */
580 /* compute the size again, count also the warning message */
581 return msg_used_size(*text_len + *trunc_msg_len, 0, pad_len);
584 /* insert record into the buffer, discard old ones, update heads */
585 static int log_store(int facility, int level,
586 enum log_flags flags, u64 ts_nsec,
587 const char *dict, u16 dict_len,
588 const char *text, u16 text_len)
590 struct printk_log *msg;
592 u16 trunc_msg_len = 0;
594 /* number of '\0' padding bytes to next message */
595 size = msg_used_size(text_len, dict_len, &pad_len);
597 if (log_make_free_space(size)) {
598 /* truncate the message if it is too long for empty buffer */
599 size = truncate_msg(&text_len, &trunc_msg_len,
600 &dict_len, &pad_len);
601 /* survive when the log buffer is too small for trunc_msg */
602 if (log_make_free_space(size))
606 if (log_next_idx + size + sizeof(struct printk_log) > log_buf_len) {
608 * This message + an additional empty header does not fit
609 * at the end of the buffer. Add an empty header with len == 0
610 * to signify a wrap around.
612 memset(log_buf + log_next_idx, 0, sizeof(struct printk_log));
617 msg = (struct printk_log *)(log_buf + log_next_idx);
618 memcpy(log_text(msg), text, text_len);
619 msg->text_len = text_len;
621 memcpy(log_text(msg) + text_len, trunc_msg, trunc_msg_len);
622 msg->text_len += trunc_msg_len;
624 memcpy(log_dict(msg), dict, dict_len);
625 msg->dict_len = dict_len;
626 msg->facility = facility;
627 msg->level = level & 7;
628 msg->flags = flags & 0x1f;
630 msg->ts_nsec = ts_nsec;
632 msg->ts_nsec = local_clock();
633 memset(log_dict(msg) + dict_len, 0, pad_len);
637 log_next_idx += msg->len;
640 return msg->text_len;
643 int dmesg_restrict = IS_ENABLED(CONFIG_SECURITY_DMESG_RESTRICT);
645 static int syslog_action_restricted(int type)
650 * Unless restricted, we allow "read all" and "get buffer size"
653 return type != SYSLOG_ACTION_READ_ALL &&
654 type != SYSLOG_ACTION_SIZE_BUFFER;
657 static int check_syslog_permissions(int type, int source)
660 * If this is from /proc/kmsg and we've already opened it, then we've
661 * already done the capabilities checks at open time.
663 if (source == SYSLOG_FROM_PROC && type != SYSLOG_ACTION_OPEN)
666 if (syslog_action_restricted(type)) {
667 if (capable(CAP_SYSLOG))
670 * For historical reasons, accept CAP_SYS_ADMIN too, with
673 if (capable(CAP_SYS_ADMIN)) {
674 pr_warn_once("%s (%d): Attempt to access syslog with "
675 "CAP_SYS_ADMIN but no CAP_SYSLOG "
677 current->comm, task_pid_nr(current));
683 return security_syslog(type);
686 static void append_char(char **pp, char *e, char c)
692 static ssize_t msg_print_ext_header(char *buf, size_t size,
693 struct printk_log *msg, u64 seq)
695 u64 ts_usec = msg->ts_nsec;
697 do_div(ts_usec, 1000);
699 return scnprintf(buf, size, "%u,%llu,%llu,%c;",
700 (msg->facility << 3) | msg->level, seq, ts_usec,
701 msg->flags & LOG_CONT ? 'c' : '-');
704 static ssize_t msg_print_ext_body(char *buf, size_t size,
705 char *dict, size_t dict_len,
706 char *text, size_t text_len)
708 char *p = buf, *e = buf + size;
711 /* escape non-printable characters */
712 for (i = 0; i < text_len; i++) {
713 unsigned char c = text[i];
715 if (c < ' ' || c >= 127 || c == '\\')
716 p += scnprintf(p, e - p, "\\x%02x", c);
718 append_char(&p, e, c);
720 append_char(&p, e, '\n');
725 for (i = 0; i < dict_len; i++) {
726 unsigned char c = dict[i];
729 append_char(&p, e, ' ');
734 append_char(&p, e, '\n');
739 if (c < ' ' || c >= 127 || c == '\\') {
740 p += scnprintf(p, e - p, "\\x%02x", c);
744 append_char(&p, e, c);
746 append_char(&p, e, '\n');
752 /* /dev/kmsg - userspace message inject/listen interface */
753 struct devkmsg_user {
756 struct ratelimit_state rs;
758 char buf[CONSOLE_EXT_LOG_MAX];
761 static ssize_t devkmsg_write(struct kiocb *iocb, struct iov_iter *from)
764 int level = default_message_loglevel;
765 int facility = 1; /* LOG_USER */
766 struct file *file = iocb->ki_filp;
767 struct devkmsg_user *user = file->private_data;
768 size_t len = iov_iter_count(from);
771 if (!user || len > LOG_LINE_MAX)
774 /* Ignore when user logging is disabled. */
775 if (devkmsg_log & DEVKMSG_LOG_MASK_OFF)
778 /* Ratelimit when not explicitly enabled. */
779 if (!(devkmsg_log & DEVKMSG_LOG_MASK_ON)) {
780 if (!___ratelimit(&user->rs, current->comm))
784 buf = kmalloc(len+1, GFP_KERNEL);
789 if (!copy_from_iter_full(buf, len, from)) {
795 * Extract and skip the syslog prefix <[0-9]*>. Coming from userspace
796 * the decimal value represents 32bit, the lower 3 bit are the log
797 * level, the rest are the log facility.
799 * If no prefix or no userspace facility is specified, we
800 * enforce LOG_USER, to be able to reliably distinguish
801 * kernel-generated messages from userspace-injected ones.
804 if (line[0] == '<') {
808 u = simple_strtoul(line + 1, &endp, 10);
809 if (endp && endp[0] == '>') {
810 level = LOG_LEVEL(u);
811 if (LOG_FACILITY(u) != 0)
812 facility = LOG_FACILITY(u);
819 printk_emit(facility, level, NULL, 0, "%s", line);
824 static ssize_t devkmsg_read(struct file *file, char __user *buf,
825 size_t count, loff_t *ppos)
827 struct devkmsg_user *user = file->private_data;
828 struct printk_log *msg;
835 ret = mutex_lock_interruptible(&user->lock);
840 while (user->seq == log_next_seq) {
841 if (file->f_flags & O_NONBLOCK) {
848 ret = wait_event_interruptible(log_wait,
849 user->seq != log_next_seq);
855 if (user->seq < log_first_seq) {
856 /* our last seen message is gone, return error and reset */
857 user->idx = log_first_idx;
858 user->seq = log_first_seq;
864 msg = log_from_idx(user->idx);
865 len = msg_print_ext_header(user->buf, sizeof(user->buf),
867 len += msg_print_ext_body(user->buf + len, sizeof(user->buf) - len,
868 log_dict(msg), msg->dict_len,
869 log_text(msg), msg->text_len);
871 user->idx = log_next(user->idx);
880 if (copy_to_user(buf, user->buf, len)) {
886 mutex_unlock(&user->lock);
890 static loff_t devkmsg_llseek(struct file *file, loff_t offset, int whence)
892 struct devkmsg_user *user = file->private_data;
903 /* the first record */
904 user->idx = log_first_idx;
905 user->seq = log_first_seq;
909 * The first record after the last SYSLOG_ACTION_CLEAR,
910 * like issued by 'dmesg -c'. Reading /dev/kmsg itself
911 * changes no global state, and does not clear anything.
913 user->idx = clear_idx;
914 user->seq = clear_seq;
917 /* after the last record */
918 user->idx = log_next_idx;
919 user->seq = log_next_seq;
928 static __poll_t devkmsg_poll(struct file *file, poll_table *wait)
930 struct devkmsg_user *user = file->private_data;
934 return EPOLLERR|EPOLLNVAL;
936 poll_wait(file, &log_wait, wait);
939 if (user->seq < log_next_seq) {
940 /* return error when data has vanished underneath us */
941 if (user->seq < log_first_seq)
942 ret = EPOLLIN|EPOLLRDNORM|EPOLLERR|EPOLLPRI;
944 ret = EPOLLIN|EPOLLRDNORM;
951 static int devkmsg_open(struct inode *inode, struct file *file)
953 struct devkmsg_user *user;
956 if (devkmsg_log & DEVKMSG_LOG_MASK_OFF)
959 /* write-only does not need any file context */
960 if ((file->f_flags & O_ACCMODE) != O_WRONLY) {
961 err = check_syslog_permissions(SYSLOG_ACTION_READ_ALL,
967 user = kmalloc(sizeof(struct devkmsg_user), GFP_KERNEL);
971 ratelimit_default_init(&user->rs);
972 ratelimit_set_flags(&user->rs, RATELIMIT_MSG_ON_RELEASE);
974 mutex_init(&user->lock);
977 user->idx = log_first_idx;
978 user->seq = log_first_seq;
981 file->private_data = user;
985 static int devkmsg_release(struct inode *inode, struct file *file)
987 struct devkmsg_user *user = file->private_data;
992 ratelimit_state_exit(&user->rs);
994 mutex_destroy(&user->lock);
999 const struct file_operations kmsg_fops = {
1000 .open = devkmsg_open,
1001 .read = devkmsg_read,
1002 .write_iter = devkmsg_write,
1003 .llseek = devkmsg_llseek,
1004 .poll = devkmsg_poll,
1005 .release = devkmsg_release,
1008 #ifdef CONFIG_CRASH_CORE
1010 * This appends the listed symbols to /proc/vmcore
1012 * /proc/vmcore is used by various utilities, like crash and makedumpfile to
1013 * obtain access to symbols that are otherwise very difficult to locate. These
1014 * symbols are specifically used so that utilities can access and extract the
1015 * dmesg log from a vmcore file after a crash.
1017 void log_buf_vmcoreinfo_setup(void)
1019 VMCOREINFO_SYMBOL(log_buf);
1020 VMCOREINFO_SYMBOL(log_buf_len);
1021 VMCOREINFO_SYMBOL(log_first_idx);
1022 VMCOREINFO_SYMBOL(clear_idx);
1023 VMCOREINFO_SYMBOL(log_next_idx);
1025 * Export struct printk_log size and field offsets. User space tools can
1026 * parse it and detect any changes to structure down the line.
1028 VMCOREINFO_STRUCT_SIZE(printk_log);
1029 VMCOREINFO_OFFSET(printk_log, ts_nsec);
1030 VMCOREINFO_OFFSET(printk_log, len);
1031 VMCOREINFO_OFFSET(printk_log, text_len);
1032 VMCOREINFO_OFFSET(printk_log, dict_len);
1036 /* requested log_buf_len from kernel cmdline */
1037 static unsigned long __initdata new_log_buf_len;
1039 /* we practice scaling the ring buffer by powers of 2 */
1040 static void __init log_buf_len_update(unsigned size)
1043 size = roundup_pow_of_two(size);
1044 if (size > log_buf_len)
1045 new_log_buf_len = size;
1048 /* save requested log_buf_len since it's too early to process it */
1049 static int __init log_buf_len_setup(char *str)
1051 unsigned size = memparse(str, &str);
1053 log_buf_len_update(size);
1057 early_param("log_buf_len", log_buf_len_setup);
1060 #define __LOG_CPU_MAX_BUF_LEN (1 << CONFIG_LOG_CPU_MAX_BUF_SHIFT)
1062 static void __init log_buf_add_cpu(void)
1064 unsigned int cpu_extra;
1067 * archs should set up cpu_possible_bits properly with
1068 * set_cpu_possible() after setup_arch() but just in
1069 * case lets ensure this is valid.
1071 if (num_possible_cpus() == 1)
1074 cpu_extra = (num_possible_cpus() - 1) * __LOG_CPU_MAX_BUF_LEN;
1076 /* by default this will only continue through for large > 64 CPUs */
1077 if (cpu_extra <= __LOG_BUF_LEN / 2)
1080 pr_info("log_buf_len individual max cpu contribution: %d bytes\n",
1081 __LOG_CPU_MAX_BUF_LEN);
1082 pr_info("log_buf_len total cpu_extra contributions: %d bytes\n",
1084 pr_info("log_buf_len min size: %d bytes\n", __LOG_BUF_LEN);
1086 log_buf_len_update(cpu_extra + __LOG_BUF_LEN);
1088 #else /* !CONFIG_SMP */
1089 static inline void log_buf_add_cpu(void) {}
1090 #endif /* CONFIG_SMP */
1092 void __init setup_log_buf(int early)
1094 unsigned long flags;
1098 if (log_buf != __log_buf)
1101 if (!early && !new_log_buf_len)
1104 if (!new_log_buf_len)
1109 memblock_virt_alloc(new_log_buf_len, LOG_ALIGN);
1111 new_log_buf = memblock_virt_alloc_nopanic(new_log_buf_len,
1115 if (unlikely(!new_log_buf)) {
1116 pr_err("log_buf_len: %ld bytes not available\n",
1121 logbuf_lock_irqsave(flags);
1122 log_buf_len = new_log_buf_len;
1123 log_buf = new_log_buf;
1124 new_log_buf_len = 0;
1125 free = __LOG_BUF_LEN - log_next_idx;
1126 memcpy(log_buf, __log_buf, __LOG_BUF_LEN);
1127 logbuf_unlock_irqrestore(flags);
1129 pr_info("log_buf_len: %d bytes\n", log_buf_len);
1130 pr_info("early log buf free: %d(%d%%)\n",
1131 free, (free * 100) / __LOG_BUF_LEN);
1134 static bool __read_mostly ignore_loglevel;
1136 static int __init ignore_loglevel_setup(char *str)
1138 ignore_loglevel = true;
1139 pr_info("debug: ignoring loglevel setting.\n");
1144 early_param("ignore_loglevel", ignore_loglevel_setup);
1145 module_param(ignore_loglevel, bool, S_IRUGO | S_IWUSR);
1146 MODULE_PARM_DESC(ignore_loglevel,
1147 "ignore loglevel setting (prints all kernel messages to the console)");
1149 static bool suppress_message_printing(int level)
1151 return (level >= console_loglevel && !ignore_loglevel);
1154 #ifdef CONFIG_BOOT_PRINTK_DELAY
1156 static int boot_delay; /* msecs delay after each printk during bootup */
1157 static unsigned long long loops_per_msec; /* based on boot_delay */
1159 static int __init boot_delay_setup(char *str)
1163 lpj = preset_lpj ? preset_lpj : 1000000; /* some guess */
1164 loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
1166 get_option(&str, &boot_delay);
1167 if (boot_delay > 10 * 1000)
1170 pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
1171 "HZ: %d, loops_per_msec: %llu\n",
1172 boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
1175 early_param("boot_delay", boot_delay_setup);
1177 static void boot_delay_msec(int level)
1179 unsigned long long k;
1180 unsigned long timeout;
1182 if ((boot_delay == 0 || system_state >= SYSTEM_RUNNING)
1183 || suppress_message_printing(level)) {
1187 k = (unsigned long long)loops_per_msec * boot_delay;
1189 timeout = jiffies + msecs_to_jiffies(boot_delay);
1194 * use (volatile) jiffies to prevent
1195 * compiler reduction; loop termination via jiffies
1196 * is secondary and may or may not happen.
1198 if (time_after(jiffies, timeout))
1200 touch_nmi_watchdog();
1204 static inline void boot_delay_msec(int level)
1209 static bool printk_time = IS_ENABLED(CONFIG_PRINTK_TIME);
1210 module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
1212 static size_t print_time(u64 ts, char *buf)
1214 unsigned long rem_nsec;
1219 rem_nsec = do_div(ts, 1000000000);
1222 return snprintf(NULL, 0, "[%5lu.000000] ", (unsigned long)ts);
1224 return sprintf(buf, "[%5lu.%06lu] ",
1225 (unsigned long)ts, rem_nsec / 1000);
1228 static size_t print_prefix(const struct printk_log *msg, bool syslog, char *buf)
1231 unsigned int prefix = (msg->facility << 3) | msg->level;
1235 len += sprintf(buf, "<%u>", prefix);
1240 else if (prefix > 99)
1242 else if (prefix > 9)
1247 len += print_time(msg->ts_nsec, buf ? buf + len : NULL);
1251 static size_t msg_print_text(const struct printk_log *msg, bool syslog, char *buf, size_t size)
1253 const char *text = log_text(msg);
1254 size_t text_size = msg->text_len;
1258 const char *next = memchr(text, '\n', text_size);
1262 text_len = next - text;
1264 text_size -= next - text;
1266 text_len = text_size;
1270 if (print_prefix(msg, syslog, NULL) +
1271 text_len + 1 >= size - len)
1274 len += print_prefix(msg, syslog, buf + len);
1275 memcpy(buf + len, text, text_len);
1279 /* SYSLOG_ACTION_* buffer size only calculation */
1280 len += print_prefix(msg, syslog, NULL);
1291 static int syslog_print(char __user *buf, int size)
1294 struct printk_log *msg;
1297 text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1306 if (syslog_seq < log_first_seq) {
1307 /* messages are gone, move to first one */
1308 syslog_seq = log_first_seq;
1309 syslog_idx = log_first_idx;
1312 if (syslog_seq == log_next_seq) {
1313 logbuf_unlock_irq();
1317 skip = syslog_partial;
1318 msg = log_from_idx(syslog_idx);
1319 n = msg_print_text(msg, true, text, LOG_LINE_MAX + PREFIX_MAX);
1320 if (n - syslog_partial <= size) {
1321 /* message fits into buffer, move forward */
1322 syslog_idx = log_next(syslog_idx);
1324 n -= syslog_partial;
1327 /* partial read(), remember position */
1329 syslog_partial += n;
1332 logbuf_unlock_irq();
1337 if (copy_to_user(buf, text + skip, n)) {
1352 static int syslog_print_all(char __user *buf, int size, bool clear)
1360 text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1366 * Find first record that fits, including all following records,
1367 * into the user-provided buffer for this dump.
1371 while (seq < log_next_seq) {
1372 struct printk_log *msg = log_from_idx(idx);
1374 len += msg_print_text(msg, true, NULL, 0);
1375 idx = log_next(idx);
1379 /* move first record forward until length fits into the buffer */
1382 while (len > size && seq < log_next_seq) {
1383 struct printk_log *msg = log_from_idx(idx);
1385 len -= msg_print_text(msg, true, NULL, 0);
1386 idx = log_next(idx);
1390 /* last message fitting into this dump */
1391 next_seq = log_next_seq;
1394 while (len >= 0 && seq < next_seq) {
1395 struct printk_log *msg = log_from_idx(idx);
1398 textlen = msg_print_text(msg, true, text,
1399 LOG_LINE_MAX + PREFIX_MAX);
1404 idx = log_next(idx);
1407 logbuf_unlock_irq();
1408 if (copy_to_user(buf + len, text, textlen))
1414 if (seq < log_first_seq) {
1415 /* messages are gone, move to next one */
1416 seq = log_first_seq;
1417 idx = log_first_idx;
1422 clear_seq = log_next_seq;
1423 clear_idx = log_next_idx;
1425 logbuf_unlock_irq();
1431 static void syslog_clear(void)
1434 clear_seq = log_next_seq;
1435 clear_idx = log_next_idx;
1436 logbuf_unlock_irq();
1439 int do_syslog(int type, char __user *buf, int len, int source)
1442 static int saved_console_loglevel = LOGLEVEL_DEFAULT;
1445 error = check_syslog_permissions(type, source);
1450 case SYSLOG_ACTION_CLOSE: /* Close log */
1452 case SYSLOG_ACTION_OPEN: /* Open log */
1454 case SYSLOG_ACTION_READ: /* Read from log */
1455 if (!buf || len < 0)
1459 if (!access_ok(VERIFY_WRITE, buf, len))
1461 error = wait_event_interruptible(log_wait,
1462 syslog_seq != log_next_seq);
1465 error = syslog_print(buf, len);
1467 /* Read/clear last kernel messages */
1468 case SYSLOG_ACTION_READ_CLEAR:
1471 /* Read last kernel messages */
1472 case SYSLOG_ACTION_READ_ALL:
1473 if (!buf || len < 0)
1477 if (!access_ok(VERIFY_WRITE, buf, len))
1479 error = syslog_print_all(buf, len, clear);
1481 /* Clear ring buffer */
1482 case SYSLOG_ACTION_CLEAR:
1485 /* Disable logging to console */
1486 case SYSLOG_ACTION_CONSOLE_OFF:
1487 if (saved_console_loglevel == LOGLEVEL_DEFAULT)
1488 saved_console_loglevel = console_loglevel;
1489 console_loglevel = minimum_console_loglevel;
1491 /* Enable logging to console */
1492 case SYSLOG_ACTION_CONSOLE_ON:
1493 if (saved_console_loglevel != LOGLEVEL_DEFAULT) {
1494 console_loglevel = saved_console_loglevel;
1495 saved_console_loglevel = LOGLEVEL_DEFAULT;
1498 /* Set level of messages printed to console */
1499 case SYSLOG_ACTION_CONSOLE_LEVEL:
1500 if (len < 1 || len > 8)
1502 if (len < minimum_console_loglevel)
1503 len = minimum_console_loglevel;
1504 console_loglevel = len;
1505 /* Implicitly re-enable logging to console */
1506 saved_console_loglevel = LOGLEVEL_DEFAULT;
1508 /* Number of chars in the log buffer */
1509 case SYSLOG_ACTION_SIZE_UNREAD:
1511 if (syslog_seq < log_first_seq) {
1512 /* messages are gone, move to first one */
1513 syslog_seq = log_first_seq;
1514 syslog_idx = log_first_idx;
1517 if (source == SYSLOG_FROM_PROC) {
1519 * Short-cut for poll(/"proc/kmsg") which simply checks
1520 * for pending data, not the size; return the count of
1521 * records, not the length.
1523 error = log_next_seq - syslog_seq;
1525 u64 seq = syslog_seq;
1526 u32 idx = syslog_idx;
1528 while (seq < log_next_seq) {
1529 struct printk_log *msg = log_from_idx(idx);
1531 error += msg_print_text(msg, true, NULL, 0);
1532 idx = log_next(idx);
1535 error -= syslog_partial;
1537 logbuf_unlock_irq();
1539 /* Size of the log buffer */
1540 case SYSLOG_ACTION_SIZE_BUFFER:
1541 error = log_buf_len;
1551 SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
1553 return do_syslog(type, buf, len, SYSLOG_FROM_READER);
1557 * Special console_lock variants that help to reduce the risk of soft-lockups.
1558 * They allow to pass console_lock to another printk() call using a busy wait.
1561 #ifdef CONFIG_LOCKDEP
1562 static struct lockdep_map console_owner_dep_map = {
1563 .name = "console_owner"
1567 static DEFINE_RAW_SPINLOCK(console_owner_lock);
1568 static struct task_struct *console_owner;
1569 static bool console_waiter;
1572 * console_lock_spinning_enable - mark beginning of code where another
1573 * thread might safely busy wait
1575 * This basically converts console_lock into a spinlock. This marks
1576 * the section where the console_lock owner can not sleep, because
1577 * there may be a waiter spinning (like a spinlock). Also it must be
1578 * ready to hand over the lock at the end of the section.
1580 static void console_lock_spinning_enable(void)
1582 raw_spin_lock(&console_owner_lock);
1583 console_owner = current;
1584 raw_spin_unlock(&console_owner_lock);
1586 /* The waiter may spin on us after setting console_owner */
1587 spin_acquire(&console_owner_dep_map, 0, 0, _THIS_IP_);
1591 * console_lock_spinning_disable_and_check - mark end of code where another
1592 * thread was able to busy wait and check if there is a waiter
1594 * This is called at the end of the section where spinning is allowed.
1595 * It has two functions. First, it is a signal that it is no longer
1596 * safe to start busy waiting for the lock. Second, it checks if
1597 * there is a busy waiter and passes the lock rights to her.
1599 * Important: Callers lose the lock if there was a busy waiter.
1600 * They must not touch items synchronized by console_lock
1603 * Return: 1 if the lock rights were passed, 0 otherwise.
1605 static int console_lock_spinning_disable_and_check(void)
1609 raw_spin_lock(&console_owner_lock);
1610 waiter = READ_ONCE(console_waiter);
1611 console_owner = NULL;
1612 raw_spin_unlock(&console_owner_lock);
1615 spin_release(&console_owner_dep_map, 1, _THIS_IP_);
1619 /* The waiter is now free to continue */
1620 WRITE_ONCE(console_waiter, false);
1622 spin_release(&console_owner_dep_map, 1, _THIS_IP_);
1625 * Hand off console_lock to waiter. The waiter will perform
1626 * the up(). After this, the waiter is the console_lock owner.
1628 mutex_release(&console_lock_dep_map, 1, _THIS_IP_);
1633 * console_trylock_spinning - try to get console_lock by busy waiting
1635 * This allows to busy wait for the console_lock when the current
1636 * owner is running in specially marked sections. It means that
1637 * the current owner is running and cannot reschedule until it
1638 * is ready to lose the lock.
1640 * Return: 1 if we got the lock, 0 othrewise
1642 static int console_trylock_spinning(void)
1644 struct task_struct *owner = NULL;
1647 unsigned long flags;
1649 if (console_trylock())
1652 printk_safe_enter_irqsave(flags);
1654 raw_spin_lock(&console_owner_lock);
1655 owner = READ_ONCE(console_owner);
1656 waiter = READ_ONCE(console_waiter);
1657 if (!waiter && owner && owner != current) {
1658 WRITE_ONCE(console_waiter, true);
1661 raw_spin_unlock(&console_owner_lock);
1664 * If there is an active printk() writing to the
1665 * consoles, instead of having it write our data too,
1666 * see if we can offload that load from the active
1667 * printer, and do some printing ourselves.
1668 * Go into a spin only if there isn't already a waiter
1669 * spinning, and there is an active printer, and
1670 * that active printer isn't us (recursive printk?).
1673 printk_safe_exit_irqrestore(flags);
1677 /* We spin waiting for the owner to release us */
1678 spin_acquire(&console_owner_dep_map, 0, 0, _THIS_IP_);
1679 /* Owner will clear console_waiter on hand off */
1680 while (READ_ONCE(console_waiter))
1682 spin_release(&console_owner_dep_map, 1, _THIS_IP_);
1684 printk_safe_exit_irqrestore(flags);
1686 * The owner passed the console lock to us.
1687 * Since we did not spin on console lock, annotate
1688 * this as a trylock. Otherwise lockdep will
1691 mutex_acquire(&console_lock_dep_map, 0, 1, _THIS_IP_);
1697 * Call the console drivers, asking them to write out
1698 * log_buf[start] to log_buf[end - 1].
1699 * The console_lock must be held.
1701 static void call_console_drivers(const char *ext_text, size_t ext_len,
1702 const char *text, size_t len)
1704 struct console *con;
1706 trace_console_rcuidle(text, len);
1708 if (!console_drivers)
1711 for_each_console(con) {
1712 if (exclusive_console && con != exclusive_console)
1714 if (!(con->flags & CON_ENABLED))
1718 if (!cpu_online(smp_processor_id()) &&
1719 !(con->flags & CON_ANYTIME))
1721 if (con->flags & CON_EXTENDED)
1722 con->write(con, ext_text, ext_len);
1724 con->write(con, text, len);
1728 int printk_delay_msec __read_mostly;
1730 static inline void printk_delay(void)
1732 if (unlikely(printk_delay_msec)) {
1733 int m = printk_delay_msec;
1737 touch_nmi_watchdog();
1743 * Continuation lines are buffered, and not committed to the record buffer
1744 * until the line is complete, or a race forces it. The line fragments
1745 * though, are printed immediately to the consoles to ensure everything has
1746 * reached the console in case of a kernel crash.
1748 static struct cont {
1749 char buf[LOG_LINE_MAX];
1750 size_t len; /* length == 0 means unused buffer */
1751 struct task_struct *owner; /* task of first print*/
1752 u64 ts_nsec; /* time of first print */
1753 u8 level; /* log level of first message */
1754 u8 facility; /* log facility of first message */
1755 enum log_flags flags; /* prefix, newline flags */
1758 static void cont_flush(void)
1763 log_store(cont.facility, cont.level, cont.flags, cont.ts_nsec,
1764 NULL, 0, cont.buf, cont.len);
1768 static bool cont_add(int facility, int level, enum log_flags flags, const char *text, size_t len)
1771 * If ext consoles are present, flush and skip in-kernel
1772 * continuation. See nr_ext_console_drivers definition. Also, if
1773 * the line gets too long, split it up in separate records.
1775 if (nr_ext_console_drivers || cont.len + len > sizeof(cont.buf)) {
1781 cont.facility = facility;
1783 cont.owner = current;
1784 cont.ts_nsec = local_clock();
1788 memcpy(cont.buf + cont.len, text, len);
1791 // The original flags come from the first line,
1792 // but later continuations can add a newline.
1793 if (flags & LOG_NEWLINE) {
1794 cont.flags |= LOG_NEWLINE;
1798 if (cont.len > (sizeof(cont.buf) * 80) / 100)
1804 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)
1807 * If an earlier line was buffered, and we're a continuation
1808 * write from the same process, try to add it to the buffer.
1811 if (cont.owner == current && (lflags & LOG_CONT)) {
1812 if (cont_add(facility, level, lflags, text, text_len))
1815 /* Otherwise, make sure it's flushed */
1819 /* Skip empty continuation lines that couldn't be added - they just flush */
1820 if (!text_len && (lflags & LOG_CONT))
1823 /* If it doesn't end in a newline, try to buffer the current line */
1824 if (!(lflags & LOG_NEWLINE)) {
1825 if (cont_add(facility, level, lflags, text, text_len))
1829 /* Store it in the record log */
1830 return log_store(facility, level, lflags, 0, dict, dictlen, text, text_len);
1833 /* Must be called under logbuf_lock. */
1834 int vprintk_store(int facility, int level,
1835 const char *dict, size_t dictlen,
1836 const char *fmt, va_list args)
1838 static char textbuf[LOG_LINE_MAX];
1839 char *text = textbuf;
1841 enum log_flags lflags = 0;
1844 * The printf needs to come first; we need the syslog
1845 * prefix which might be passed-in as a parameter.
1847 text_len = vscnprintf(text, sizeof(textbuf), fmt, args);
1849 /* mark and strip a trailing newline */
1850 if (text_len && text[text_len-1] == '\n') {
1852 lflags |= LOG_NEWLINE;
1855 /* strip kernel syslog prefix and extract log level or control flags */
1856 if (facility == 0) {
1859 while ((kern_level = printk_get_level(text)) != 0) {
1860 switch (kern_level) {
1862 if (level == LOGLEVEL_DEFAULT)
1863 level = kern_level - '0';
1865 case 'd': /* KERN_DEFAULT */
1866 lflags |= LOG_PREFIX;
1868 case 'c': /* KERN_CONT */
1877 if (level == LOGLEVEL_DEFAULT)
1878 level = default_message_loglevel;
1881 lflags |= LOG_PREFIX|LOG_NEWLINE;
1883 return log_output(facility, level, lflags,
1884 dict, dictlen, text, text_len);
1887 asmlinkage int vprintk_emit(int facility, int level,
1888 const char *dict, size_t dictlen,
1889 const char *fmt, va_list args)
1892 bool in_sched = false;
1893 unsigned long flags;
1895 if (level == LOGLEVEL_SCHED) {
1896 level = LOGLEVEL_DEFAULT;
1900 boot_delay_msec(level);
1903 /* This stops the holder of console_sem just where we want him */
1904 logbuf_lock_irqsave(flags);
1905 printed_len = vprintk_store(facility, level, dict, dictlen, fmt, args);
1906 logbuf_unlock_irqrestore(flags);
1908 /* If called from the scheduler, we can not call up(). */
1911 * Disable preemption to avoid being preempted while holding
1912 * console_sem which would prevent anyone from printing to
1917 * Try to acquire and then immediately release the console
1918 * semaphore. The release will print out buffers and wake up
1919 * /dev/kmsg and syslog() users.
1921 if (console_trylock_spinning())
1929 EXPORT_SYMBOL(vprintk_emit);
1931 asmlinkage int vprintk(const char *fmt, va_list args)
1933 return vprintk_func(fmt, args);
1935 EXPORT_SYMBOL(vprintk);
1937 asmlinkage int printk_emit(int facility, int level,
1938 const char *dict, size_t dictlen,
1939 const char *fmt, ...)
1944 va_start(args, fmt);
1945 r = vprintk_emit(facility, level, dict, dictlen, fmt, args);
1950 EXPORT_SYMBOL(printk_emit);
1952 int vprintk_default(const char *fmt, va_list args)
1956 #ifdef CONFIG_KGDB_KDB
1957 /* Allow to pass printk() to kdb but avoid a recursion. */
1958 if (unlikely(kdb_trap_printk && kdb_printf_cpu < 0)) {
1959 r = vkdb_printf(KDB_MSGSRC_PRINTK, fmt, args);
1963 r = vprintk_emit(0, LOGLEVEL_DEFAULT, NULL, 0, fmt, args);
1967 EXPORT_SYMBOL_GPL(vprintk_default);
1970 * printk - print a kernel message
1971 * @fmt: format string
1973 * This is printk(). It can be called from any context. We want it to work.
1975 * We try to grab the console_lock. If we succeed, it's easy - we log the
1976 * output and call the console drivers. If we fail to get the semaphore, we
1977 * place the output into the log buffer and return. The current holder of
1978 * the console_sem will notice the new output in console_unlock(); and will
1979 * send it to the consoles before releasing the lock.
1981 * One effect of this deferred printing is that code which calls printk() and
1982 * then changes console_loglevel may break. This is because console_loglevel
1983 * is inspected when the actual printing occurs.
1988 * See the vsnprintf() documentation for format string extensions over C99.
1990 asmlinkage __visible int printk(const char *fmt, ...)
1995 va_start(args, fmt);
1996 r = vprintk_func(fmt, args);
2001 EXPORT_SYMBOL(printk);
2003 #else /* CONFIG_PRINTK */
2005 #define LOG_LINE_MAX 0
2006 #define PREFIX_MAX 0
2008 static u64 syslog_seq;
2009 static u32 syslog_idx;
2010 static u64 console_seq;
2011 static u32 console_idx;
2012 static u64 log_first_seq;
2013 static u32 log_first_idx;
2014 static u64 log_next_seq;
2015 static char *log_text(const struct printk_log *msg) { return NULL; }
2016 static char *log_dict(const struct printk_log *msg) { return NULL; }
2017 static struct printk_log *log_from_idx(u32 idx) { return NULL; }
2018 static u32 log_next(u32 idx) { return 0; }
2019 static ssize_t msg_print_ext_header(char *buf, size_t size,
2020 struct printk_log *msg,
2021 u64 seq) { return 0; }
2022 static ssize_t msg_print_ext_body(char *buf, size_t size,
2023 char *dict, size_t dict_len,
2024 char *text, size_t text_len) { return 0; }
2025 static void console_lock_spinning_enable(void) { }
2026 static int console_lock_spinning_disable_and_check(void) { return 0; }
2027 static void call_console_drivers(const char *ext_text, size_t ext_len,
2028 const char *text, size_t len) {}
2029 static size_t msg_print_text(const struct printk_log *msg,
2030 bool syslog, char *buf, size_t size) { return 0; }
2031 static bool suppress_message_printing(int level) { return false; }
2033 #endif /* CONFIG_PRINTK */
2035 #ifdef CONFIG_EARLY_PRINTK
2036 struct console *early_console;
2038 asmlinkage __visible void early_printk(const char *fmt, ...)
2048 n = vscnprintf(buf, sizeof(buf), fmt, ap);
2051 early_console->write(early_console, buf, n);
2055 static int __add_preferred_console(char *name, int idx, char *options,
2058 struct console_cmdline *c;
2062 * See if this tty is not yet registered, and
2063 * if we have a slot free.
2065 for (i = 0, c = console_cmdline;
2066 i < MAX_CMDLINECONSOLES && c->name[0];
2068 if (strcmp(c->name, name) == 0 && c->index == idx) {
2070 preferred_console = i;
2074 if (i == MAX_CMDLINECONSOLES)
2077 preferred_console = i;
2078 strlcpy(c->name, name, sizeof(c->name));
2079 c->options = options;
2080 braille_set_options(c, brl_options);
2086 static int __init console_msg_format_setup(char *str)
2088 if (!strcmp(str, "syslog"))
2089 console_msg_format = MSG_FORMAT_SYSLOG;
2090 if (!strcmp(str, "default"))
2091 console_msg_format = MSG_FORMAT_DEFAULT;
2094 __setup("console_msg_format=", console_msg_format_setup);
2097 * Set up a console. Called via do_early_param() in init/main.c
2098 * for each "console=" parameter in the boot command line.
2100 static int __init console_setup(char *str)
2102 char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for "ttyS" */
2103 char *s, *options, *brl_options = NULL;
2106 if (_braille_console_setup(&str, &brl_options))
2110 * Decode str into name, index, options.
2112 if (str[0] >= '0' && str[0] <= '9') {
2113 strcpy(buf, "ttyS");
2114 strncpy(buf + 4, str, sizeof(buf) - 5);
2116 strncpy(buf, str, sizeof(buf) - 1);
2118 buf[sizeof(buf) - 1] = 0;
2119 options = strchr(str, ',');
2123 if (!strcmp(str, "ttya"))
2124 strcpy(buf, "ttyS0");
2125 if (!strcmp(str, "ttyb"))
2126 strcpy(buf, "ttyS1");
2128 for (s = buf; *s; s++)
2129 if (isdigit(*s) || *s == ',')
2131 idx = simple_strtoul(s, NULL, 10);
2134 __add_preferred_console(buf, idx, options, brl_options);
2135 console_set_on_cmdline = 1;
2138 __setup("console=", console_setup);
2141 * add_preferred_console - add a device to the list of preferred consoles.
2142 * @name: device name
2143 * @idx: device index
2144 * @options: options for this console
2146 * The last preferred console added will be used for kernel messages
2147 * and stdin/out/err for init. Normally this is used by console_setup
2148 * above to handle user-supplied console arguments; however it can also
2149 * be used by arch-specific code either to override the user or more
2150 * commonly to provide a default console (ie from PROM variables) when
2151 * the user has not supplied one.
2153 int add_preferred_console(char *name, int idx, char *options)
2155 return __add_preferred_console(name, idx, options, NULL);
2158 bool console_suspend_enabled = true;
2159 EXPORT_SYMBOL(console_suspend_enabled);
2161 static int __init console_suspend_disable(char *str)
2163 console_suspend_enabled = false;
2166 __setup("no_console_suspend", console_suspend_disable);
2167 module_param_named(console_suspend, console_suspend_enabled,
2168 bool, S_IRUGO | S_IWUSR);
2169 MODULE_PARM_DESC(console_suspend, "suspend console during suspend"
2170 " and hibernate operations");
2173 * suspend_console - suspend the console subsystem
2175 * This disables printk() while we go into suspend states
2177 void suspend_console(void)
2179 if (!console_suspend_enabled)
2181 pr_info("Suspending console(s) (use no_console_suspend to debug)\n");
2183 console_suspended = 1;
2187 void resume_console(void)
2189 if (!console_suspend_enabled)
2192 console_suspended = 0;
2197 * console_cpu_notify - print deferred console messages after CPU hotplug
2200 * If printk() is called from a CPU that is not online yet, the messages
2201 * will be printed on the console only if there are CON_ANYTIME consoles.
2202 * This function is called when a new CPU comes online (or fails to come
2203 * up) or goes offline.
2205 static int console_cpu_notify(unsigned int cpu)
2207 if (!cpuhp_tasks_frozen) {
2208 /* If trylock fails, someone else is doing the printing */
2209 if (console_trylock())
2216 * console_lock - lock the console system for exclusive use.
2218 * Acquires a lock which guarantees that the caller has
2219 * exclusive access to the console system and the console_drivers list.
2221 * Can sleep, returns nothing.
2223 void console_lock(void)
2228 if (console_suspended)
2231 console_may_schedule = 1;
2233 EXPORT_SYMBOL(console_lock);
2236 * console_trylock - try to lock the console system for exclusive use.
2238 * Try to acquire a lock which guarantees that the caller has exclusive
2239 * access to the console system and the console_drivers list.
2241 * returns 1 on success, and 0 on failure to acquire the lock.
2243 int console_trylock(void)
2245 if (down_trylock_console_sem())
2247 if (console_suspended) {
2252 console_may_schedule = 0;
2255 EXPORT_SYMBOL(console_trylock);
2257 int is_console_locked(void)
2259 return console_locked;
2261 EXPORT_SYMBOL(is_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 unsigned long flags;
2310 bool do_cond_resched, retry;
2312 if (console_suspended) {
2318 * Console drivers are called with interrupts disabled, so
2319 * @console_may_schedule should be cleared before; however, we may
2320 * end up dumping a lot of lines, for example, if called from
2321 * console registration path, and should invoke cond_resched()
2322 * between lines if allowable. Not doing so can cause a very long
2323 * scheduling stall on a slow console leading to RCU stall and
2324 * softlockup warnings which exacerbate the issue with more
2325 * messages practically incapacitating the system.
2327 * console_trylock() is not able to detect the preemptive
2328 * context reliably. Therefore the value must be stored before
2329 * and cleared after the the "again" goto label.
2331 do_cond_resched = console_may_schedule;
2333 console_may_schedule = 0;
2336 * We released the console_sem lock, so we need to recheck if
2337 * cpu is online and (if not) is there at least one CON_ANYTIME
2340 if (!can_use_console()) {
2347 struct printk_log *msg;
2351 printk_safe_enter_irqsave(flags);
2352 raw_spin_lock(&logbuf_lock);
2353 if (console_seq < log_first_seq) {
2354 len = sprintf(text, "** %u printk messages dropped **\n",
2355 (unsigned)(log_first_seq - console_seq));
2357 /* messages are gone, move to first one */
2358 console_seq = log_first_seq;
2359 console_idx = log_first_idx;
2364 if (console_seq == log_next_seq)
2367 msg = log_from_idx(console_idx);
2368 if (suppress_message_printing(msg->level)) {
2370 * Skip record we have buffered and already printed
2371 * directly to the console when we received it, and
2372 * record that has level above the console loglevel.
2374 console_idx = log_next(console_idx);
2379 len += msg_print_text(msg,
2380 console_msg_format & MSG_FORMAT_SYSLOG,
2382 sizeof(text) - len);
2383 if (nr_ext_console_drivers) {
2384 ext_len = msg_print_ext_header(ext_text,
2387 ext_len += msg_print_ext_body(ext_text + ext_len,
2388 sizeof(ext_text) - ext_len,
2389 log_dict(msg), msg->dict_len,
2390 log_text(msg), msg->text_len);
2392 console_idx = log_next(console_idx);
2394 raw_spin_unlock(&logbuf_lock);
2397 * While actively printing out messages, if another printk()
2398 * were to occur on another CPU, it may wait for this one to
2399 * finish. This task can not be preempted if there is a
2400 * waiter waiting to take over.
2402 console_lock_spinning_enable();
2404 stop_critical_timings(); /* don't trace print latency */
2405 call_console_drivers(ext_text, ext_len, text, len);
2406 start_critical_timings();
2408 if (console_lock_spinning_disable_and_check()) {
2409 printk_safe_exit_irqrestore(flags);
2413 printk_safe_exit_irqrestore(flags);
2415 if (do_cond_resched)
2421 /* Release the exclusive_console once it is used */
2422 if (unlikely(exclusive_console))
2423 exclusive_console = NULL;
2425 raw_spin_unlock(&logbuf_lock);
2430 * Someone could have filled up the buffer again, so re-check if there's
2431 * something to flush. In case we cannot trylock the console_sem again,
2432 * there's a new owner and the console_unlock() from them will do the
2433 * flush, no worries.
2435 raw_spin_lock(&logbuf_lock);
2436 retry = console_seq != log_next_seq;
2437 raw_spin_unlock(&logbuf_lock);
2438 printk_safe_exit_irqrestore(flags);
2440 if (retry && console_trylock())
2443 EXPORT_SYMBOL(console_unlock);
2446 * console_conditional_schedule - yield the CPU if required
2448 * If the console code is currently allowed to sleep, and
2449 * if this CPU should yield the CPU to another task, do
2452 * Must be called within console_lock();.
2454 void __sched console_conditional_schedule(void)
2456 if (console_may_schedule)
2459 EXPORT_SYMBOL(console_conditional_schedule);
2461 void console_unblank(void)
2466 * console_unblank can no longer be called in interrupt context unless
2467 * oops_in_progress is set to 1..
2469 if (oops_in_progress) {
2470 if (down_trylock_console_sem() != 0)
2476 console_may_schedule = 0;
2478 if ((c->flags & CON_ENABLED) && c->unblank)
2484 * console_flush_on_panic - flush console content on panic
2486 * Immediately output all pending messages no matter what.
2488 void console_flush_on_panic(void)
2491 * If someone else is holding the console lock, trylock will fail
2492 * and may_schedule may be set. Ignore and proceed to unlock so
2493 * that messages are flushed out. As this can be called from any
2494 * context and we don't want to get preempted while flushing,
2495 * ensure may_schedule is cleared.
2498 console_may_schedule = 0;
2503 * Return the console tty driver structure and its associated index
2505 struct tty_driver *console_device(int *index)
2508 struct tty_driver *driver = NULL;
2511 for_each_console(c) {
2514 driver = c->device(c, index);
2523 * Prevent further output on the passed console device so that (for example)
2524 * serial drivers can disable console output before suspending a port, and can
2525 * re-enable output afterwards.
2527 void console_stop(struct console *console)
2530 console->flags &= ~CON_ENABLED;
2533 EXPORT_SYMBOL(console_stop);
2535 void console_start(struct console *console)
2538 console->flags |= CON_ENABLED;
2541 EXPORT_SYMBOL(console_start);
2543 static int __read_mostly keep_bootcon;
2545 static int __init keep_bootcon_setup(char *str)
2548 pr_info("debug: skip boot console de-registration.\n");
2553 early_param("keep_bootcon", keep_bootcon_setup);
2556 * The console driver calls this routine during kernel initialization
2557 * to register the console printing procedure with printk() and to
2558 * print any messages that were printed by the kernel before the
2559 * console driver was initialized.
2561 * This can happen pretty early during the boot process (because of
2562 * early_printk) - sometimes before setup_arch() completes - be careful
2563 * of what kernel features are used - they may not be initialised yet.
2565 * There are two types of consoles - bootconsoles (early_printk) and
2566 * "real" consoles (everything which is not a bootconsole) which are
2567 * handled differently.
2568 * - Any number of bootconsoles can be registered at any time.
2569 * - As soon as a "real" console is registered, all bootconsoles
2570 * will be unregistered automatically.
2571 * - Once a "real" console is registered, any attempt to register a
2572 * bootconsoles will be rejected
2574 void register_console(struct console *newcon)
2577 unsigned long flags;
2578 struct console *bcon = NULL;
2579 struct console_cmdline *c;
2580 static bool has_preferred;
2582 if (console_drivers)
2583 for_each_console(bcon)
2584 if (WARN(bcon == newcon,
2585 "console '%s%d' already registered\n",
2586 bcon->name, bcon->index))
2590 * before we register a new CON_BOOT console, make sure we don't
2591 * already have a valid console
2593 if (console_drivers && newcon->flags & CON_BOOT) {
2594 /* find the last or real console */
2595 for_each_console(bcon) {
2596 if (!(bcon->flags & CON_BOOT)) {
2597 pr_info("Too late to register bootconsole %s%d\n",
2598 newcon->name, newcon->index);
2604 if (console_drivers && console_drivers->flags & CON_BOOT)
2605 bcon = console_drivers;
2607 if (!has_preferred || bcon || !console_drivers)
2608 has_preferred = preferred_console >= 0;
2611 * See if we want to use this console driver. If we
2612 * didn't select a console we take the first one
2613 * that registers here.
2615 if (!has_preferred) {
2616 if (newcon->index < 0)
2618 if (newcon->setup == NULL ||
2619 newcon->setup(newcon, NULL) == 0) {
2620 newcon->flags |= CON_ENABLED;
2621 if (newcon->device) {
2622 newcon->flags |= CON_CONSDEV;
2623 has_preferred = true;
2629 * See if this console matches one we selected on
2632 for (i = 0, c = console_cmdline;
2633 i < MAX_CMDLINECONSOLES && c->name[0];
2635 if (!newcon->match ||
2636 newcon->match(newcon, c->name, c->index, c->options) != 0) {
2637 /* default matching */
2638 BUILD_BUG_ON(sizeof(c->name) != sizeof(newcon->name));
2639 if (strcmp(c->name, newcon->name) != 0)
2641 if (newcon->index >= 0 &&
2642 newcon->index != c->index)
2644 if (newcon->index < 0)
2645 newcon->index = c->index;
2647 if (_braille_register_console(newcon, c))
2650 if (newcon->setup &&
2651 newcon->setup(newcon, c->options) != 0)
2655 newcon->flags |= CON_ENABLED;
2656 if (i == preferred_console) {
2657 newcon->flags |= CON_CONSDEV;
2658 has_preferred = true;
2663 if (!(newcon->flags & CON_ENABLED))
2667 * If we have a bootconsole, and are switching to a real console,
2668 * don't print everything out again, since when the boot console, and
2669 * the real console are the same physical device, it's annoying to
2670 * see the beginning boot messages twice
2672 if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
2673 newcon->flags &= ~CON_PRINTBUFFER;
2676 * Put this console in the list - keep the
2677 * preferred driver at the head of the list.
2680 if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
2681 newcon->next = console_drivers;
2682 console_drivers = newcon;
2684 newcon->next->flags &= ~CON_CONSDEV;
2686 newcon->next = console_drivers->next;
2687 console_drivers->next = newcon;
2690 if (newcon->flags & CON_EXTENDED)
2691 if (!nr_ext_console_drivers++)
2692 pr_info("printk: continuation disabled due to ext consoles, expect more fragments in /dev/kmsg\n");
2694 if (newcon->flags & CON_PRINTBUFFER) {
2696 * console_unlock(); will print out the buffered messages
2699 logbuf_lock_irqsave(flags);
2700 console_seq = syslog_seq;
2701 console_idx = syslog_idx;
2702 logbuf_unlock_irqrestore(flags);
2704 * We're about to replay the log buffer. Only do this to the
2705 * just-registered console to avoid excessive message spam to
2706 * the already-registered consoles.
2708 exclusive_console = newcon;
2711 console_sysfs_notify();
2714 * By unregistering the bootconsoles after we enable the real console
2715 * we get the "console xxx enabled" message on all the consoles -
2716 * boot consoles, real consoles, etc - this is to ensure that end
2717 * users know there might be something in the kernel's log buffer that
2718 * went to the bootconsole (that they do not see on the real console)
2720 pr_info("%sconsole [%s%d] enabled\n",
2721 (newcon->flags & CON_BOOT) ? "boot" : "" ,
2722 newcon->name, newcon->index);
2724 ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
2726 /* We need to iterate through all boot consoles, to make
2727 * sure we print everything out, before we unregister them.
2729 for_each_console(bcon)
2730 if (bcon->flags & CON_BOOT)
2731 unregister_console(bcon);
2734 EXPORT_SYMBOL(register_console);
2736 int unregister_console(struct console *console)
2738 struct console *a, *b;
2741 pr_info("%sconsole [%s%d] disabled\n",
2742 (console->flags & CON_BOOT) ? "boot" : "" ,
2743 console->name, console->index);
2745 res = _braille_unregister_console(console);
2751 if (console_drivers == console) {
2752 console_drivers=console->next;
2754 } else if (console_drivers) {
2755 for (a=console_drivers->next, b=console_drivers ;
2756 a; b=a, a=b->next) {
2765 if (!res && (console->flags & CON_EXTENDED))
2766 nr_ext_console_drivers--;
2769 * If this isn't the last console and it has CON_CONSDEV set, we
2770 * need to set it on the next preferred console.
2772 if (console_drivers != NULL && console->flags & CON_CONSDEV)
2773 console_drivers->flags |= CON_CONSDEV;
2775 console->flags &= ~CON_ENABLED;
2777 console_sysfs_notify();
2780 EXPORT_SYMBOL(unregister_console);
2783 * Initialize the console device. This is called *early*, so
2784 * we can't necessarily depend on lots of kernel help here.
2785 * Just do some early initializations, and do the complex setup
2788 void __init console_init(void)
2792 initcall_entry_t *ce;
2794 /* Setup the default TTY line discipline. */
2798 * set up the console device so that later boot sequences can
2799 * inform about problems etc..
2801 ce = __con_initcall_start;
2802 trace_initcall_level("console");
2803 while (ce < __con_initcall_end) {
2804 call = initcall_from_entry(ce);
2805 trace_initcall_start(call);
2807 trace_initcall_finish(call, ret);
2813 * Some boot consoles access data that is in the init section and which will
2814 * be discarded after the initcalls have been run. To make sure that no code
2815 * will access this data, unregister the boot consoles in a late initcall.
2817 * If for some reason, such as deferred probe or the driver being a loadable
2818 * module, the real console hasn't registered yet at this point, there will
2819 * be a brief interval in which no messages are logged to the console, which
2820 * makes it difficult to diagnose problems that occur during this time.
2822 * To mitigate this problem somewhat, only unregister consoles whose memory
2823 * intersects with the init section. Note that all other boot consoles will
2824 * get unregistred when the real preferred console is registered.
2826 static int __init printk_late_init(void)
2828 struct console *con;
2831 for_each_console(con) {
2832 if (!(con->flags & CON_BOOT))
2835 /* Check addresses that might be used for enabled consoles. */
2836 if (init_section_intersects(con, sizeof(*con)) ||
2837 init_section_contains(con->write, 0) ||
2838 init_section_contains(con->read, 0) ||
2839 init_section_contains(con->device, 0) ||
2840 init_section_contains(con->unblank, 0) ||
2841 init_section_contains(con->data, 0)) {
2843 * Please, consider moving the reported consoles out
2844 * of the init section.
2846 pr_warn("bootconsole [%s%d] uses init memory and must be disabled even before the real one is ready\n",
2847 con->name, con->index);
2848 unregister_console(con);
2851 ret = cpuhp_setup_state_nocalls(CPUHP_PRINTK_DEAD, "printk:dead", NULL,
2852 console_cpu_notify);
2854 ret = cpuhp_setup_state_nocalls(CPUHP_AP_ONLINE_DYN, "printk:online",
2855 console_cpu_notify, NULL);
2859 late_initcall(printk_late_init);
2861 #if defined CONFIG_PRINTK
2863 * Delayed printk version, for scheduler-internal messages:
2865 #define PRINTK_PENDING_WAKEUP 0x01
2866 #define PRINTK_PENDING_OUTPUT 0x02
2868 static DEFINE_PER_CPU(int, printk_pending);
2870 static void wake_up_klogd_work_func(struct irq_work *irq_work)
2872 int pending = __this_cpu_xchg(printk_pending, 0);
2874 if (pending & PRINTK_PENDING_OUTPUT) {
2875 /* If trylock fails, someone else is doing the printing */
2876 if (console_trylock())
2880 if (pending & PRINTK_PENDING_WAKEUP)
2881 wake_up_interruptible(&log_wait);
2884 static DEFINE_PER_CPU(struct irq_work, wake_up_klogd_work) = {
2885 .func = wake_up_klogd_work_func,
2886 .flags = IRQ_WORK_LAZY,
2889 void wake_up_klogd(void)
2892 if (waitqueue_active(&log_wait)) {
2893 this_cpu_or(printk_pending, PRINTK_PENDING_WAKEUP);
2894 irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2899 void defer_console_output(void)
2902 __this_cpu_or(printk_pending, PRINTK_PENDING_OUTPUT);
2903 irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2907 int vprintk_deferred(const char *fmt, va_list args)
2911 r = vprintk_emit(0, LOGLEVEL_SCHED, NULL, 0, fmt, args);
2912 defer_console_output();
2917 int printk_deferred(const char *fmt, ...)
2922 va_start(args, fmt);
2923 r = vprintk_deferred(fmt, args);
2930 * printk rate limiting, lifted from the networking subsystem.
2932 * This enforces a rate limit: not more than 10 kernel messages
2933 * every 5s to make a denial-of-service attack impossible.
2935 DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
2937 int __printk_ratelimit(const char *func)
2939 return ___ratelimit(&printk_ratelimit_state, func);
2941 EXPORT_SYMBOL(__printk_ratelimit);
2944 * printk_timed_ratelimit - caller-controlled printk ratelimiting
2945 * @caller_jiffies: pointer to caller's state
2946 * @interval_msecs: minimum interval between prints
2948 * printk_timed_ratelimit() returns true if more than @interval_msecs
2949 * milliseconds have elapsed since the last time printk_timed_ratelimit()
2952 bool printk_timed_ratelimit(unsigned long *caller_jiffies,
2953 unsigned int interval_msecs)
2955 unsigned long elapsed = jiffies - *caller_jiffies;
2957 if (*caller_jiffies && elapsed <= msecs_to_jiffies(interval_msecs))
2960 *caller_jiffies = jiffies;
2963 EXPORT_SYMBOL(printk_timed_ratelimit);
2965 static DEFINE_SPINLOCK(dump_list_lock);
2966 static LIST_HEAD(dump_list);
2969 * kmsg_dump_register - register a kernel log dumper.
2970 * @dumper: pointer to the kmsg_dumper structure
2972 * Adds a kernel log dumper to the system. The dump callback in the
2973 * structure will be called when the kernel oopses or panics and must be
2974 * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
2976 int kmsg_dump_register(struct kmsg_dumper *dumper)
2978 unsigned long flags;
2981 /* The dump callback needs to be set */
2985 spin_lock_irqsave(&dump_list_lock, flags);
2986 /* Don't allow registering multiple times */
2987 if (!dumper->registered) {
2988 dumper->registered = 1;
2989 list_add_tail_rcu(&dumper->list, &dump_list);
2992 spin_unlock_irqrestore(&dump_list_lock, flags);
2996 EXPORT_SYMBOL_GPL(kmsg_dump_register);
2999 * kmsg_dump_unregister - unregister a kmsg dumper.
3000 * @dumper: pointer to the kmsg_dumper structure
3002 * Removes a dump device from the system. Returns zero on success and
3003 * %-EINVAL otherwise.
3005 int kmsg_dump_unregister(struct kmsg_dumper *dumper)
3007 unsigned long flags;
3010 spin_lock_irqsave(&dump_list_lock, flags);
3011 if (dumper->registered) {
3012 dumper->registered = 0;
3013 list_del_rcu(&dumper->list);
3016 spin_unlock_irqrestore(&dump_list_lock, flags);
3021 EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
3023 static bool always_kmsg_dump;
3024 module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);
3027 * kmsg_dump - dump kernel log to kernel message dumpers.
3028 * @reason: the reason (oops, panic etc) for dumping
3030 * Call each of the registered dumper's dump() callback, which can
3031 * retrieve the kmsg records with kmsg_dump_get_line() or
3032 * kmsg_dump_get_buffer().
3034 void kmsg_dump(enum kmsg_dump_reason reason)
3036 struct kmsg_dumper *dumper;
3037 unsigned long flags;
3039 if ((reason > KMSG_DUMP_OOPS) && !always_kmsg_dump)
3043 list_for_each_entry_rcu(dumper, &dump_list, list) {
3044 if (dumper->max_reason && reason > dumper->max_reason)
3047 /* initialize iterator with data about the stored records */
3048 dumper->active = true;
3050 logbuf_lock_irqsave(flags);
3051 dumper->cur_seq = clear_seq;
3052 dumper->cur_idx = clear_idx;
3053 dumper->next_seq = log_next_seq;
3054 dumper->next_idx = log_next_idx;
3055 logbuf_unlock_irqrestore(flags);
3057 /* invoke dumper which will iterate over records */
3058 dumper->dump(dumper, reason);
3060 /* reset iterator */
3061 dumper->active = false;
3067 * kmsg_dump_get_line_nolock - retrieve one kmsg log line (unlocked version)
3068 * @dumper: registered kmsg dumper
3069 * @syslog: include the "<4>" prefixes
3070 * @line: buffer to copy the line to
3071 * @size: maximum size of the buffer
3072 * @len: length of line placed into buffer
3074 * Start at the beginning of the kmsg buffer, with the oldest kmsg
3075 * record, and copy one record into the provided buffer.
3077 * Consecutive calls will return the next available record moving
3078 * towards the end of the buffer with the youngest messages.
3080 * A return value of FALSE indicates that there are no more records to
3083 * The function is similar to kmsg_dump_get_line(), but grabs no locks.
3085 bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper, bool syslog,
3086 char *line, size_t size, size_t *len)
3088 struct printk_log *msg;
3092 if (!dumper->active)
3095 if (dumper->cur_seq < log_first_seq) {
3096 /* messages are gone, move to first available one */
3097 dumper->cur_seq = log_first_seq;
3098 dumper->cur_idx = log_first_idx;
3102 if (dumper->cur_seq >= log_next_seq)
3105 msg = log_from_idx(dumper->cur_idx);
3106 l = msg_print_text(msg, syslog, line, size);
3108 dumper->cur_idx = log_next(dumper->cur_idx);
3118 * kmsg_dump_get_line - retrieve one kmsg log line
3119 * @dumper: registered kmsg dumper
3120 * @syslog: include the "<4>" prefixes
3121 * @line: buffer to copy the line to
3122 * @size: maximum size of the buffer
3123 * @len: length of line placed into buffer
3125 * Start at the beginning of the kmsg buffer, with the oldest kmsg
3126 * record, and copy one record into the provided buffer.
3128 * Consecutive calls will return the next available record moving
3129 * towards the end of the buffer with the youngest messages.
3131 * A return value of FALSE indicates that there are no more records to
3134 bool kmsg_dump_get_line(struct kmsg_dumper *dumper, bool syslog,
3135 char *line, size_t size, size_t *len)
3137 unsigned long flags;
3140 logbuf_lock_irqsave(flags);
3141 ret = kmsg_dump_get_line_nolock(dumper, syslog, line, size, len);
3142 logbuf_unlock_irqrestore(flags);
3146 EXPORT_SYMBOL_GPL(kmsg_dump_get_line);
3149 * kmsg_dump_get_buffer - copy kmsg log lines
3150 * @dumper: registered kmsg dumper
3151 * @syslog: include the "<4>" prefixes
3152 * @buf: buffer to copy the line to
3153 * @size: maximum size of the buffer
3154 * @len: length of line placed into buffer
3156 * Start at the end of the kmsg buffer and fill the provided buffer
3157 * with as many of the the *youngest* kmsg records that fit into it.
3158 * If the buffer is large enough, all available kmsg records will be
3159 * copied with a single call.
3161 * Consecutive calls will fill the buffer with the next block of
3162 * available older records, not including the earlier retrieved ones.
3164 * A return value of FALSE indicates that there are no more records to
3167 bool kmsg_dump_get_buffer(struct kmsg_dumper *dumper, bool syslog,
3168 char *buf, size_t size, size_t *len)
3170 unsigned long flags;
3178 if (!dumper->active)
3181 logbuf_lock_irqsave(flags);
3182 if (dumper->cur_seq < log_first_seq) {
3183 /* messages are gone, move to first available one */
3184 dumper->cur_seq = log_first_seq;
3185 dumper->cur_idx = log_first_idx;
3189 if (dumper->cur_seq >= dumper->next_seq) {
3190 logbuf_unlock_irqrestore(flags);
3194 /* calculate length of entire buffer */
3195 seq = dumper->cur_seq;
3196 idx = dumper->cur_idx;
3197 while (seq < dumper->next_seq) {
3198 struct printk_log *msg = log_from_idx(idx);
3200 l += msg_print_text(msg, true, NULL, 0);
3201 idx = log_next(idx);
3205 /* move first record forward until length fits into the buffer */
3206 seq = dumper->cur_seq;
3207 idx = dumper->cur_idx;
3208 while (l > size && seq < dumper->next_seq) {
3209 struct printk_log *msg = log_from_idx(idx);
3211 l -= msg_print_text(msg, true, NULL, 0);
3212 idx = log_next(idx);
3216 /* last message in next interation */
3221 while (seq < dumper->next_seq) {
3222 struct printk_log *msg = log_from_idx(idx);
3224 l += msg_print_text(msg, syslog, buf + l, size - l);
3225 idx = log_next(idx);
3229 dumper->next_seq = next_seq;
3230 dumper->next_idx = next_idx;
3232 logbuf_unlock_irqrestore(flags);
3238 EXPORT_SYMBOL_GPL(kmsg_dump_get_buffer);
3241 * kmsg_dump_rewind_nolock - reset the interator (unlocked version)
3242 * @dumper: registered kmsg dumper
3244 * Reset the dumper's iterator so that kmsg_dump_get_line() and
3245 * kmsg_dump_get_buffer() can be called again and used multiple
3246 * times within the same dumper.dump() callback.
3248 * The function is similar to kmsg_dump_rewind(), but grabs no locks.
3250 void kmsg_dump_rewind_nolock(struct kmsg_dumper *dumper)
3252 dumper->cur_seq = clear_seq;
3253 dumper->cur_idx = clear_idx;
3254 dumper->next_seq = log_next_seq;
3255 dumper->next_idx = log_next_idx;
3259 * kmsg_dump_rewind - reset the interator
3260 * @dumper: registered kmsg dumper
3262 * Reset the dumper's iterator so that kmsg_dump_get_line() and
3263 * kmsg_dump_get_buffer() can be called again and used multiple
3264 * times within the same dumper.dump() callback.
3266 void kmsg_dump_rewind(struct kmsg_dumper *dumper)
3268 unsigned long flags;
3270 logbuf_lock_irqsave(flags);
3271 kmsg_dump_rewind_nolock(dumper);
3272 logbuf_unlock_irqrestore(flags);
3274 EXPORT_SYMBOL_GPL(kmsg_dump_rewind);