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/kexec.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>
49 #include <asm/uaccess.h>
50 #include <asm/sections.h>
52 #define CREATE_TRACE_POINTS
53 #include <trace/events/printk.h>
55 #include "console_cmdline.h"
59 int console_printk[4] = {
60 CONSOLE_LOGLEVEL_DEFAULT, /* console_loglevel */
61 MESSAGE_LOGLEVEL_DEFAULT, /* default_message_loglevel */
62 CONSOLE_LOGLEVEL_MIN, /* minimum_console_loglevel */
63 CONSOLE_LOGLEVEL_DEFAULT, /* default_console_loglevel */
67 * Low level drivers may need that to know if they can schedule in
68 * their unblank() callback or not. So let's export it.
71 EXPORT_SYMBOL(oops_in_progress);
74 * console_sem protects the console_drivers list, and also
75 * provides serialisation for access to the entire console
78 static DEFINE_SEMAPHORE(console_sem);
79 struct console *console_drivers;
80 EXPORT_SYMBOL_GPL(console_drivers);
83 static struct lockdep_map console_lock_dep_map = {
84 .name = "console_lock"
88 enum devkmsg_log_bits {
89 __DEVKMSG_LOG_BIT_ON = 0,
90 __DEVKMSG_LOG_BIT_OFF,
91 __DEVKMSG_LOG_BIT_LOCK,
94 enum devkmsg_log_masks {
95 DEVKMSG_LOG_MASK_ON = BIT(__DEVKMSG_LOG_BIT_ON),
96 DEVKMSG_LOG_MASK_OFF = BIT(__DEVKMSG_LOG_BIT_OFF),
97 DEVKMSG_LOG_MASK_LOCK = BIT(__DEVKMSG_LOG_BIT_LOCK),
100 /* Keep both the 'on' and 'off' bits clear, i.e. ratelimit by default: */
101 #define DEVKMSG_LOG_MASK_DEFAULT 0
103 static unsigned int __read_mostly devkmsg_log = DEVKMSG_LOG_MASK_DEFAULT;
105 static int __control_devkmsg(char *str)
110 if (!strncmp(str, "on", 2)) {
111 devkmsg_log = DEVKMSG_LOG_MASK_ON;
113 } else if (!strncmp(str, "off", 3)) {
114 devkmsg_log = DEVKMSG_LOG_MASK_OFF;
116 } else if (!strncmp(str, "ratelimit", 9)) {
117 devkmsg_log = DEVKMSG_LOG_MASK_DEFAULT;
123 static int __init control_devkmsg(char *str)
125 if (__control_devkmsg(str) < 0)
129 * Set sysctl string accordingly:
131 if (devkmsg_log == DEVKMSG_LOG_MASK_ON) {
132 memset(devkmsg_log_str, 0, DEVKMSG_STR_MAX_SIZE);
133 strncpy(devkmsg_log_str, "on", 2);
134 } else if (devkmsg_log == DEVKMSG_LOG_MASK_OFF) {
135 memset(devkmsg_log_str, 0, DEVKMSG_STR_MAX_SIZE);
136 strncpy(devkmsg_log_str, "off", 3);
138 /* else "ratelimit" which is set by default. */
141 * Sysctl cannot change it anymore. The kernel command line setting of
142 * this parameter is to force the setting to be permanent throughout the
143 * runtime of the system. This is a precation measure against userspace
144 * trying to be a smarta** and attempting to change it up on us.
146 devkmsg_log |= DEVKMSG_LOG_MASK_LOCK;
150 __setup("printk.devkmsg=", control_devkmsg);
152 char devkmsg_log_str[DEVKMSG_STR_MAX_SIZE] = "ratelimit";
154 int devkmsg_sysctl_set_loglvl(struct ctl_table *table, int write,
155 void __user *buffer, size_t *lenp, loff_t *ppos)
157 char old_str[DEVKMSG_STR_MAX_SIZE];
162 if (devkmsg_log & DEVKMSG_LOG_MASK_LOCK)
166 strncpy(old_str, devkmsg_log_str, DEVKMSG_STR_MAX_SIZE);
169 err = proc_dostring(table, write, buffer, lenp, ppos);
174 err = __control_devkmsg(devkmsg_log_str);
177 * Do not accept an unknown string OR a known string with
180 if (err < 0 || (err + 1 != *lenp)) {
182 /* ... and restore old setting. */
184 strncpy(devkmsg_log_str, old_str, DEVKMSG_STR_MAX_SIZE);
194 * Number of registered extended console drivers.
196 * If extended consoles are present, in-kernel cont reassembly is disabled
197 * and each fragment is stored as a separate log entry with proper
198 * continuation flag so that every emitted message has full metadata. This
199 * doesn't change the result for regular consoles or /proc/kmsg. For
200 * /dev/kmsg, as long as the reader concatenates messages according to
201 * consecutive continuation flags, the end result should be the same too.
203 static int nr_ext_console_drivers;
206 * Helper macros to handle lockdep when locking/unlocking console_sem. We use
207 * macros instead of functions so that _RET_IP_ contains useful information.
209 #define down_console_sem() do { \
211 mutex_acquire(&console_lock_dep_map, 0, 0, _RET_IP_);\
214 static int __down_trylock_console_sem(unsigned long ip)
216 if (down_trylock(&console_sem))
218 mutex_acquire(&console_lock_dep_map, 0, 1, ip);
221 #define down_trylock_console_sem() __down_trylock_console_sem(_RET_IP_)
223 #define up_console_sem() do { \
224 mutex_release(&console_lock_dep_map, 1, _RET_IP_);\
229 * This is used for debugging the mess that is the VT code by
230 * keeping track if we have the console semaphore held. It's
231 * definitely not the perfect debug tool (we don't know if _WE_
232 * hold it and are racing, but it helps tracking those weird code
233 * paths in the console code where we end up in places I want
234 * locked without the console sempahore held).
236 static int console_locked, console_suspended;
239 * If exclusive_console is non-NULL then only this console is to be printed to.
241 static struct console *exclusive_console;
244 * Array of consoles built from command line options (console=)
247 #define MAX_CMDLINECONSOLES 8
249 static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
251 static int selected_console = -1;
252 static int preferred_console = -1;
253 int console_set_on_cmdline;
254 EXPORT_SYMBOL(console_set_on_cmdline);
257 static bool of_specified_console;
259 void console_set_by_of(void)
261 of_specified_console = true;
264 # define of_specified_console false
267 /* Flag: console code may call schedule() */
268 static int console_may_schedule;
271 * The printk log buffer consists of a chain of concatenated variable
272 * length records. Every record starts with a record header, containing
273 * the overall length of the record.
275 * The heads to the first and last entry in the buffer, as well as the
276 * sequence numbers of these entries are maintained when messages are
279 * If the heads indicate available messages, the length in the header
280 * tells the start next message. A length == 0 for the next message
281 * indicates a wrap-around to the beginning of the buffer.
283 * Every record carries the monotonic timestamp in microseconds, as well as
284 * the standard userspace syslog level and syslog facility. The usual
285 * kernel messages use LOG_KERN; userspace-injected messages always carry
286 * a matching syslog facility, by default LOG_USER. The origin of every
287 * message can be reliably determined that way.
289 * The human readable log message directly follows the message header. The
290 * length of the message text is stored in the header, the stored message
293 * Optionally, a message can carry a dictionary of properties (key/value pairs),
294 * to provide userspace with a machine-readable message context.
296 * Examples for well-defined, commonly used property names are:
297 * DEVICE=b12:8 device identifier
301 * +sound:card0 subsystem:devname
302 * SUBSYSTEM=pci driver-core subsystem name
304 * Valid characters in property names are [a-zA-Z0-9.-_]. The plain text value
305 * follows directly after a '=' character. Every property is terminated by
306 * a '\0' character. The last property is not terminated.
308 * Example of a message structure:
309 * 0000 ff 8f 00 00 00 00 00 00 monotonic time in nsec
310 * 0008 34 00 record is 52 bytes long
311 * 000a 0b 00 text is 11 bytes long
312 * 000c 1f 00 dictionary is 23 bytes long
313 * 000e 03 00 LOG_KERN (facility) LOG_ERR (level)
314 * 0010 69 74 27 73 20 61 20 6c "it's a l"
316 * 001b 44 45 56 49 43 "DEVIC"
317 * 45 3d 62 38 3a 32 00 44 "E=b8:2\0D"
318 * 52 49 56 45 52 3d 62 75 "RIVER=bu"
320 * 0032 00 00 00 padding to next message header
322 * The 'struct printk_log' buffer header must never be directly exported to
323 * userspace, it is a kernel-private implementation detail that might
324 * need to be changed in the future, when the requirements change.
326 * /dev/kmsg exports the structured data in the following line format:
327 * "<level>,<sequnum>,<timestamp>,<contflag>[,additional_values, ... ];<message text>\n"
329 * Users of the export format should ignore possible additional values
330 * separated by ',', and find the message after the ';' character.
332 * The optional key/value pairs are attached as continuation lines starting
333 * with a space character and terminated by a newline. All possible
334 * non-prinatable characters are escaped in the "\xff" notation.
338 LOG_NOCONS = 1, /* already flushed, do not print to console */
339 LOG_NEWLINE = 2, /* text ended with a newline */
340 LOG_PREFIX = 4, /* text started with a prefix */
341 LOG_CONT = 8, /* text is a fragment of a continuation line */
345 u64 ts_nsec; /* timestamp in nanoseconds */
346 u16 len; /* length of entire record */
347 u16 text_len; /* length of text buffer */
348 u16 dict_len; /* length of dictionary buffer */
349 u8 facility; /* syslog facility */
350 u8 flags:5; /* internal record flags */
351 u8 level:3; /* syslog level */
353 #ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
354 __packed __aligned(4)
359 * The logbuf_lock protects kmsg buffer, indices, counters. This can be taken
360 * within the scheduler's rq lock. It must be released before calling
361 * console_unlock() or anything else that might wake up a process.
363 DEFINE_RAW_SPINLOCK(logbuf_lock);
366 DECLARE_WAIT_QUEUE_HEAD(log_wait);
367 /* the next printk record to read by syslog(READ) or /proc/kmsg */
368 static u64 syslog_seq;
369 static u32 syslog_idx;
370 static enum log_flags syslog_prev;
371 static size_t syslog_partial;
373 /* index and sequence number of the first record stored in the buffer */
374 static u64 log_first_seq;
375 static u32 log_first_idx;
377 /* index and sequence number of the next record to store in the buffer */
378 static u64 log_next_seq;
379 static u32 log_next_idx;
381 /* the next printk record to write to the console */
382 static u64 console_seq;
383 static u32 console_idx;
384 static enum log_flags console_prev;
386 /* the next printk record to read after the last 'clear' command */
387 static u64 clear_seq;
388 static u32 clear_idx;
390 #define PREFIX_MAX 32
391 #define LOG_LINE_MAX (1024 - PREFIX_MAX)
393 #define LOG_LEVEL(v) ((v) & 0x07)
394 #define LOG_FACILITY(v) ((v) >> 3 & 0xff)
397 #define LOG_ALIGN __alignof__(struct printk_log)
398 #define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
399 static char __log_buf[__LOG_BUF_LEN] __aligned(LOG_ALIGN);
400 static char *log_buf = __log_buf;
401 static u32 log_buf_len = __LOG_BUF_LEN;
403 /* Return log buffer address */
404 char *log_buf_addr_get(void)
409 /* Return log buffer size */
410 u32 log_buf_len_get(void)
415 /* human readable text of the record */
416 static char *log_text(const struct printk_log *msg)
418 return (char *)msg + sizeof(struct printk_log);
421 /* optional key/value pair dictionary attached to the record */
422 static char *log_dict(const struct printk_log *msg)
424 return (char *)msg + sizeof(struct printk_log) + msg->text_len;
427 /* get record by index; idx must point to valid msg */
428 static struct printk_log *log_from_idx(u32 idx)
430 struct printk_log *msg = (struct printk_log *)(log_buf + idx);
433 * A length == 0 record is the end of buffer marker. Wrap around and
434 * read the message at the start of the buffer.
437 return (struct printk_log *)log_buf;
441 /* get next record; idx must point to valid msg */
442 static u32 log_next(u32 idx)
444 struct printk_log *msg = (struct printk_log *)(log_buf + idx);
446 /* length == 0 indicates the end of the buffer; wrap */
448 * A length == 0 record is the end of buffer marker. Wrap around and
449 * read the message at the start of the buffer as *this* one, and
450 * return the one after that.
453 msg = (struct printk_log *)log_buf;
456 return idx + msg->len;
460 * Check whether there is enough free space for the given message.
462 * The same values of first_idx and next_idx mean that the buffer
463 * is either empty or full.
465 * If the buffer is empty, we must respect the position of the indexes.
466 * They cannot be reset to the beginning of the buffer.
468 static int logbuf_has_space(u32 msg_size, bool empty)
472 if (log_next_idx > log_first_idx || empty)
473 free = max(log_buf_len - log_next_idx, log_first_idx);
475 free = log_first_idx - log_next_idx;
478 * We need space also for an empty header that signalizes wrapping
481 return free >= msg_size + sizeof(struct printk_log);
484 static int log_make_free_space(u32 msg_size)
486 while (log_first_seq < log_next_seq &&
487 !logbuf_has_space(msg_size, false)) {
488 /* drop old messages until we have enough contiguous space */
489 log_first_idx = log_next(log_first_idx);
493 if (clear_seq < log_first_seq) {
494 clear_seq = log_first_seq;
495 clear_idx = log_first_idx;
498 /* sequence numbers are equal, so the log buffer is empty */
499 if (logbuf_has_space(msg_size, log_first_seq == log_next_seq))
505 /* compute the message size including the padding bytes */
506 static u32 msg_used_size(u16 text_len, u16 dict_len, u32 *pad_len)
510 size = sizeof(struct printk_log) + text_len + dict_len;
511 *pad_len = (-size) & (LOG_ALIGN - 1);
518 * Define how much of the log buffer we could take at maximum. The value
519 * must be greater than two. Note that only half of the buffer is available
520 * when the index points to the middle.
522 #define MAX_LOG_TAKE_PART 4
523 static const char trunc_msg[] = "<truncated>";
525 static u32 truncate_msg(u16 *text_len, u16 *trunc_msg_len,
526 u16 *dict_len, u32 *pad_len)
529 * The message should not take the whole buffer. Otherwise, it might
530 * get removed too soon.
532 u32 max_text_len = log_buf_len / MAX_LOG_TAKE_PART;
533 if (*text_len > max_text_len)
534 *text_len = max_text_len;
535 /* enable the warning message */
536 *trunc_msg_len = strlen(trunc_msg);
537 /* disable the "dict" completely */
539 /* compute the size again, count also the warning message */
540 return msg_used_size(*text_len + *trunc_msg_len, 0, pad_len);
543 /* insert record into the buffer, discard old ones, update heads */
544 static int log_store(int facility, int level,
545 enum log_flags flags, u64 ts_nsec,
546 const char *dict, u16 dict_len,
547 const char *text, u16 text_len)
549 struct printk_log *msg;
551 u16 trunc_msg_len = 0;
553 /* number of '\0' padding bytes to next message */
554 size = msg_used_size(text_len, dict_len, &pad_len);
556 if (log_make_free_space(size)) {
557 /* truncate the message if it is too long for empty buffer */
558 size = truncate_msg(&text_len, &trunc_msg_len,
559 &dict_len, &pad_len);
560 /* survive when the log buffer is too small for trunc_msg */
561 if (log_make_free_space(size))
565 if (log_next_idx + size + sizeof(struct printk_log) > log_buf_len) {
567 * This message + an additional empty header does not fit
568 * at the end of the buffer. Add an empty header with len == 0
569 * to signify a wrap around.
571 memset(log_buf + log_next_idx, 0, sizeof(struct printk_log));
576 msg = (struct printk_log *)(log_buf + log_next_idx);
577 memcpy(log_text(msg), text, text_len);
578 msg->text_len = text_len;
580 memcpy(log_text(msg) + text_len, trunc_msg, trunc_msg_len);
581 msg->text_len += trunc_msg_len;
583 memcpy(log_dict(msg), dict, dict_len);
584 msg->dict_len = dict_len;
585 msg->facility = facility;
586 msg->level = level & 7;
587 msg->flags = flags & 0x1f;
589 msg->ts_nsec = ts_nsec;
591 msg->ts_nsec = local_clock();
592 memset(log_dict(msg) + dict_len, 0, pad_len);
596 log_next_idx += msg->len;
599 return msg->text_len;
602 int dmesg_restrict = IS_ENABLED(CONFIG_SECURITY_DMESG_RESTRICT);
604 static int syslog_action_restricted(int type)
609 * Unless restricted, we allow "read all" and "get buffer size"
612 return type != SYSLOG_ACTION_READ_ALL &&
613 type != SYSLOG_ACTION_SIZE_BUFFER;
616 int check_syslog_permissions(int type, int source)
619 * If this is from /proc/kmsg and we've already opened it, then we've
620 * already done the capabilities checks at open time.
622 if (source == SYSLOG_FROM_PROC && type != SYSLOG_ACTION_OPEN)
625 if (syslog_action_restricted(type)) {
626 if (capable(CAP_SYSLOG))
629 * For historical reasons, accept CAP_SYS_ADMIN too, with
632 if (capable(CAP_SYS_ADMIN)) {
633 pr_warn_once("%s (%d): Attempt to access syslog with "
634 "CAP_SYS_ADMIN but no CAP_SYSLOG "
636 current->comm, task_pid_nr(current));
642 return security_syslog(type);
644 EXPORT_SYMBOL_GPL(check_syslog_permissions);
646 static void append_char(char **pp, char *e, char c)
652 static ssize_t msg_print_ext_header(char *buf, size_t size,
653 struct printk_log *msg, u64 seq,
654 enum log_flags prev_flags)
656 u64 ts_usec = msg->ts_nsec;
659 do_div(ts_usec, 1000);
662 * If we couldn't merge continuation line fragments during the print,
663 * export the stored flags to allow an optional external merge of the
664 * records. Merging the records isn't always neccessarily correct, like
665 * when we hit a race during printing. In most cases though, it produces
666 * better readable output. 'c' in the record flags mark the first
667 * fragment of a line, '+' the following.
669 if (msg->flags & LOG_CONT)
670 cont = (prev_flags & LOG_CONT) ? '+' : 'c';
672 return scnprintf(buf, size, "%u,%llu,%llu,%c;",
673 (msg->facility << 3) | msg->level, seq, ts_usec, cont);
676 static ssize_t msg_print_ext_body(char *buf, size_t size,
677 char *dict, size_t dict_len,
678 char *text, size_t text_len)
680 char *p = buf, *e = buf + size;
683 /* escape non-printable characters */
684 for (i = 0; i < text_len; i++) {
685 unsigned char c = text[i];
687 if (c < ' ' || c >= 127 || c == '\\')
688 p += scnprintf(p, e - p, "\\x%02x", c);
690 append_char(&p, e, c);
692 append_char(&p, e, '\n');
697 for (i = 0; i < dict_len; i++) {
698 unsigned char c = dict[i];
701 append_char(&p, e, ' ');
706 append_char(&p, e, '\n');
711 if (c < ' ' || c >= 127 || c == '\\') {
712 p += scnprintf(p, e - p, "\\x%02x", c);
716 append_char(&p, e, c);
718 append_char(&p, e, '\n');
724 /* /dev/kmsg - userspace message inject/listen interface */
725 struct devkmsg_user {
729 struct ratelimit_state rs;
731 char buf[CONSOLE_EXT_LOG_MAX];
734 static ssize_t devkmsg_write(struct kiocb *iocb, struct iov_iter *from)
737 int level = default_message_loglevel;
738 int facility = 1; /* LOG_USER */
739 struct file *file = iocb->ki_filp;
740 struct devkmsg_user *user = file->private_data;
741 size_t len = iov_iter_count(from);
744 if (!user || len > LOG_LINE_MAX)
747 /* Ignore when user logging is disabled. */
748 if (devkmsg_log & DEVKMSG_LOG_MASK_OFF)
751 /* Ratelimit when not explicitly enabled. */
752 if (!(devkmsg_log & DEVKMSG_LOG_MASK_ON)) {
753 if (!___ratelimit(&user->rs, current->comm))
757 buf = kmalloc(len+1, GFP_KERNEL);
762 if (copy_from_iter(buf, len, from) != len) {
768 * Extract and skip the syslog prefix <[0-9]*>. Coming from userspace
769 * the decimal value represents 32bit, the lower 3 bit are the log
770 * level, the rest are the log facility.
772 * If no prefix or no userspace facility is specified, we
773 * enforce LOG_USER, to be able to reliably distinguish
774 * kernel-generated messages from userspace-injected ones.
777 if (line[0] == '<') {
781 u = simple_strtoul(line + 1, &endp, 10);
782 if (endp && endp[0] == '>') {
783 level = LOG_LEVEL(u);
784 if (LOG_FACILITY(u) != 0)
785 facility = LOG_FACILITY(u);
792 printk_emit(facility, level, NULL, 0, "%s", line);
797 static void cont_flush(void);
799 static ssize_t devkmsg_read(struct file *file, char __user *buf,
800 size_t count, loff_t *ppos)
802 struct devkmsg_user *user = file->private_data;
803 struct printk_log *msg;
810 ret = mutex_lock_interruptible(&user->lock);
813 raw_spin_lock_irq(&logbuf_lock);
815 while (user->seq == log_next_seq) {
816 if (file->f_flags & O_NONBLOCK) {
818 raw_spin_unlock_irq(&logbuf_lock);
822 raw_spin_unlock_irq(&logbuf_lock);
823 ret = wait_event_interruptible(log_wait,
824 user->seq != log_next_seq);
827 raw_spin_lock_irq(&logbuf_lock);
830 if (user->seq < log_first_seq) {
831 /* our last seen message is gone, return error and reset */
832 user->idx = log_first_idx;
833 user->seq = log_first_seq;
835 raw_spin_unlock_irq(&logbuf_lock);
839 msg = log_from_idx(user->idx);
840 len = msg_print_ext_header(user->buf, sizeof(user->buf),
841 msg, user->seq, user->prev);
842 len += msg_print_ext_body(user->buf + len, sizeof(user->buf) - len,
843 log_dict(msg), msg->dict_len,
844 log_text(msg), msg->text_len);
846 user->prev = msg->flags;
847 user->idx = log_next(user->idx);
849 raw_spin_unlock_irq(&logbuf_lock);
856 if (copy_to_user(buf, user->buf, len)) {
862 mutex_unlock(&user->lock);
866 static loff_t devkmsg_llseek(struct file *file, loff_t offset, int whence)
868 struct devkmsg_user *user = file->private_data;
876 raw_spin_lock_irq(&logbuf_lock);
880 /* the first record */
881 user->idx = log_first_idx;
882 user->seq = log_first_seq;
886 * The first record after the last SYSLOG_ACTION_CLEAR,
887 * like issued by 'dmesg -c'. Reading /dev/kmsg itself
888 * changes no global state, and does not clear anything.
890 user->idx = clear_idx;
891 user->seq = clear_seq;
894 /* after the last record */
895 user->idx = log_next_idx;
896 user->seq = log_next_seq;
901 raw_spin_unlock_irq(&logbuf_lock);
905 static unsigned int devkmsg_poll(struct file *file, poll_table *wait)
907 struct devkmsg_user *user = file->private_data;
911 return POLLERR|POLLNVAL;
913 poll_wait(file, &log_wait, wait);
915 raw_spin_lock_irq(&logbuf_lock);
917 if (user->seq < log_next_seq) {
918 /* return error when data has vanished underneath us */
919 if (user->seq < log_first_seq)
920 ret = POLLIN|POLLRDNORM|POLLERR|POLLPRI;
922 ret = POLLIN|POLLRDNORM;
924 raw_spin_unlock_irq(&logbuf_lock);
929 static int devkmsg_open(struct inode *inode, struct file *file)
931 struct devkmsg_user *user;
934 if (devkmsg_log & DEVKMSG_LOG_MASK_OFF)
937 /* write-only does not need any file context */
938 if ((file->f_flags & O_ACCMODE) != O_WRONLY) {
939 err = check_syslog_permissions(SYSLOG_ACTION_READ_ALL,
945 user = kmalloc(sizeof(struct devkmsg_user), GFP_KERNEL);
949 ratelimit_default_init(&user->rs);
950 ratelimit_set_flags(&user->rs, RATELIMIT_MSG_ON_RELEASE);
952 mutex_init(&user->lock);
954 raw_spin_lock_irq(&logbuf_lock);
955 user->idx = log_first_idx;
956 user->seq = log_first_seq;
957 raw_spin_unlock_irq(&logbuf_lock);
959 file->private_data = user;
963 static int devkmsg_release(struct inode *inode, struct file *file)
965 struct devkmsg_user *user = file->private_data;
970 ratelimit_state_exit(&user->rs);
972 mutex_destroy(&user->lock);
977 const struct file_operations kmsg_fops = {
978 .open = devkmsg_open,
979 .read = devkmsg_read,
980 .write_iter = devkmsg_write,
981 .llseek = devkmsg_llseek,
982 .poll = devkmsg_poll,
983 .release = devkmsg_release,
986 #ifdef CONFIG_KEXEC_CORE
988 * This appends the listed symbols to /proc/vmcore
990 * /proc/vmcore is used by various utilities, like crash and makedumpfile to
991 * obtain access to symbols that are otherwise very difficult to locate. These
992 * symbols are specifically used so that utilities can access and extract the
993 * dmesg log from a vmcore file after a crash.
995 void log_buf_kexec_setup(void)
997 VMCOREINFO_SYMBOL(log_buf);
998 VMCOREINFO_SYMBOL(log_buf_len);
999 VMCOREINFO_SYMBOL(log_first_idx);
1000 VMCOREINFO_SYMBOL(clear_idx);
1001 VMCOREINFO_SYMBOL(log_next_idx);
1003 * Export struct printk_log size and field offsets. User space tools can
1004 * parse it and detect any changes to structure down the line.
1006 VMCOREINFO_STRUCT_SIZE(printk_log);
1007 VMCOREINFO_OFFSET(printk_log, ts_nsec);
1008 VMCOREINFO_OFFSET(printk_log, len);
1009 VMCOREINFO_OFFSET(printk_log, text_len);
1010 VMCOREINFO_OFFSET(printk_log, dict_len);
1014 /* requested log_buf_len from kernel cmdline */
1015 static unsigned long __initdata new_log_buf_len;
1017 /* we practice scaling the ring buffer by powers of 2 */
1018 static void __init log_buf_len_update(unsigned size)
1021 size = roundup_pow_of_two(size);
1022 if (size > log_buf_len)
1023 new_log_buf_len = size;
1026 /* save requested log_buf_len since it's too early to process it */
1027 static int __init log_buf_len_setup(char *str)
1029 unsigned size = memparse(str, &str);
1031 log_buf_len_update(size);
1035 early_param("log_buf_len", log_buf_len_setup);
1038 #define __LOG_CPU_MAX_BUF_LEN (1 << CONFIG_LOG_CPU_MAX_BUF_SHIFT)
1040 static void __init log_buf_add_cpu(void)
1042 unsigned int cpu_extra;
1045 * archs should set up cpu_possible_bits properly with
1046 * set_cpu_possible() after setup_arch() but just in
1047 * case lets ensure this is valid.
1049 if (num_possible_cpus() == 1)
1052 cpu_extra = (num_possible_cpus() - 1) * __LOG_CPU_MAX_BUF_LEN;
1054 /* by default this will only continue through for large > 64 CPUs */
1055 if (cpu_extra <= __LOG_BUF_LEN / 2)
1058 pr_info("log_buf_len individual max cpu contribution: %d bytes\n",
1059 __LOG_CPU_MAX_BUF_LEN);
1060 pr_info("log_buf_len total cpu_extra contributions: %d bytes\n",
1062 pr_info("log_buf_len min size: %d bytes\n", __LOG_BUF_LEN);
1064 log_buf_len_update(cpu_extra + __LOG_BUF_LEN);
1066 #else /* !CONFIG_SMP */
1067 static inline void log_buf_add_cpu(void) {}
1068 #endif /* CONFIG_SMP */
1070 void __init setup_log_buf(int early)
1072 unsigned long flags;
1076 if (log_buf != __log_buf)
1079 if (!early && !new_log_buf_len)
1082 if (!new_log_buf_len)
1087 memblock_virt_alloc(new_log_buf_len, LOG_ALIGN);
1089 new_log_buf = memblock_virt_alloc_nopanic(new_log_buf_len,
1093 if (unlikely(!new_log_buf)) {
1094 pr_err("log_buf_len: %ld bytes not available\n",
1099 raw_spin_lock_irqsave(&logbuf_lock, flags);
1100 log_buf_len = new_log_buf_len;
1101 log_buf = new_log_buf;
1102 new_log_buf_len = 0;
1103 free = __LOG_BUF_LEN - log_next_idx;
1104 memcpy(log_buf, __log_buf, __LOG_BUF_LEN);
1105 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
1107 pr_info("log_buf_len: %d bytes\n", log_buf_len);
1108 pr_info("early log buf free: %d(%d%%)\n",
1109 free, (free * 100) / __LOG_BUF_LEN);
1112 static bool __read_mostly ignore_loglevel;
1114 static int __init ignore_loglevel_setup(char *str)
1116 ignore_loglevel = true;
1117 pr_info("debug: ignoring loglevel setting.\n");
1122 early_param("ignore_loglevel", ignore_loglevel_setup);
1123 module_param(ignore_loglevel, bool, S_IRUGO | S_IWUSR);
1124 MODULE_PARM_DESC(ignore_loglevel,
1125 "ignore loglevel setting (prints all kernel messages to the console)");
1127 static bool suppress_message_printing(int level)
1129 return (level >= console_loglevel && !ignore_loglevel);
1132 #ifdef CONFIG_BOOT_PRINTK_DELAY
1134 static int boot_delay; /* msecs delay after each printk during bootup */
1135 static unsigned long long loops_per_msec; /* based on boot_delay */
1137 static int __init boot_delay_setup(char *str)
1141 lpj = preset_lpj ? preset_lpj : 1000000; /* some guess */
1142 loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
1144 get_option(&str, &boot_delay);
1145 if (boot_delay > 10 * 1000)
1148 pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
1149 "HZ: %d, loops_per_msec: %llu\n",
1150 boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
1153 early_param("boot_delay", boot_delay_setup);
1155 static void boot_delay_msec(int level)
1157 unsigned long long k;
1158 unsigned long timeout;
1160 if ((boot_delay == 0 || system_state != SYSTEM_BOOTING)
1161 || suppress_message_printing(level)) {
1165 k = (unsigned long long)loops_per_msec * boot_delay;
1167 timeout = jiffies + msecs_to_jiffies(boot_delay);
1172 * use (volatile) jiffies to prevent
1173 * compiler reduction; loop termination via jiffies
1174 * is secondary and may or may not happen.
1176 if (time_after(jiffies, timeout))
1178 touch_nmi_watchdog();
1182 static inline void boot_delay_msec(int level)
1187 static bool printk_time = IS_ENABLED(CONFIG_PRINTK_TIME);
1188 module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
1190 static size_t print_time(u64 ts, char *buf)
1192 unsigned long rem_nsec;
1197 rem_nsec = do_div(ts, 1000000000);
1200 return snprintf(NULL, 0, "[%5lu.000000] ", (unsigned long)ts);
1202 return sprintf(buf, "[%5lu.%06lu] ",
1203 (unsigned long)ts, rem_nsec / 1000);
1206 static size_t print_prefix(const struct printk_log *msg, bool syslog, char *buf)
1209 unsigned int prefix = (msg->facility << 3) | msg->level;
1213 len += sprintf(buf, "<%u>", prefix);
1218 else if (prefix > 99)
1220 else if (prefix > 9)
1225 len += print_time(msg->ts_nsec, buf ? buf + len : NULL);
1229 static size_t msg_print_text(const struct printk_log *msg, enum log_flags prev,
1230 bool syslog, char *buf, size_t size)
1232 const char *text = log_text(msg);
1233 size_t text_size = msg->text_len;
1235 bool newline = true;
1238 if ((prev & LOG_CONT) && !(msg->flags & LOG_PREFIX))
1241 if (msg->flags & LOG_CONT) {
1242 if ((prev & LOG_CONT) && !(prev & LOG_NEWLINE))
1245 if (!(msg->flags & LOG_NEWLINE))
1250 const char *next = memchr(text, '\n', text_size);
1254 text_len = next - text;
1256 text_size -= next - text;
1258 text_len = text_size;
1262 if (print_prefix(msg, syslog, NULL) +
1263 text_len + 1 >= size - len)
1267 len += print_prefix(msg, syslog, buf + len);
1268 memcpy(buf + len, text, text_len);
1270 if (next || newline)
1273 /* SYSLOG_ACTION_* buffer size only calculation */
1275 len += print_prefix(msg, syslog, NULL);
1277 if (next || newline)
1288 static int syslog_print(char __user *buf, int size)
1291 struct printk_log *msg;
1294 text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1302 raw_spin_lock_irq(&logbuf_lock);
1304 if (syslog_seq < log_first_seq) {
1305 /* messages are gone, move to first one */
1306 syslog_seq = log_first_seq;
1307 syslog_idx = log_first_idx;
1311 if (syslog_seq == log_next_seq) {
1312 raw_spin_unlock_irq(&logbuf_lock);
1316 skip = syslog_partial;
1317 msg = log_from_idx(syslog_idx);
1318 n = msg_print_text(msg, syslog_prev, true, text,
1319 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 syslog_prev = msg->flags;
1325 n -= syslog_partial;
1328 /* partial read(), remember position */
1330 syslog_partial += n;
1333 raw_spin_unlock_irq(&logbuf_lock);
1338 if (copy_to_user(buf, text + skip, n)) {
1353 static int syslog_print_all(char __user *buf, int size, bool clear)
1358 text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1362 raw_spin_lock_irq(&logbuf_lock);
1368 enum log_flags prev;
1371 * Find first record that fits, including all following records,
1372 * into the user-provided buffer for this dump.
1377 while (seq < log_next_seq) {
1378 struct printk_log *msg = log_from_idx(idx);
1380 len += msg_print_text(msg, prev, true, NULL, 0);
1382 idx = log_next(idx);
1386 /* move first record forward until length fits into the buffer */
1390 while (len > size && seq < log_next_seq) {
1391 struct printk_log *msg = log_from_idx(idx);
1393 len -= msg_print_text(msg, prev, true, NULL, 0);
1395 idx = log_next(idx);
1399 /* last message fitting into this dump */
1400 next_seq = log_next_seq;
1403 while (len >= 0 && seq < next_seq) {
1404 struct printk_log *msg = log_from_idx(idx);
1407 textlen = msg_print_text(msg, prev, true, text,
1408 LOG_LINE_MAX + PREFIX_MAX);
1413 idx = log_next(idx);
1417 raw_spin_unlock_irq(&logbuf_lock);
1418 if (copy_to_user(buf + len, text, textlen))
1422 raw_spin_lock_irq(&logbuf_lock);
1424 if (seq < log_first_seq) {
1425 /* messages are gone, move to next one */
1426 seq = log_first_seq;
1427 idx = log_first_idx;
1434 clear_seq = log_next_seq;
1435 clear_idx = log_next_idx;
1437 raw_spin_unlock_irq(&logbuf_lock);
1443 int do_syslog(int type, char __user *buf, int len, int source)
1446 static int saved_console_loglevel = LOGLEVEL_DEFAULT;
1449 error = check_syslog_permissions(type, source);
1454 case SYSLOG_ACTION_CLOSE: /* Close log */
1456 case SYSLOG_ACTION_OPEN: /* Open log */
1458 case SYSLOG_ACTION_READ: /* Read from log */
1460 if (!buf || len < 0)
1465 if (!access_ok(VERIFY_WRITE, buf, len)) {
1469 error = wait_event_interruptible(log_wait,
1470 syslog_seq != log_next_seq);
1473 error = syslog_print(buf, len);
1475 /* Read/clear last kernel messages */
1476 case SYSLOG_ACTION_READ_CLEAR:
1479 /* Read last kernel messages */
1480 case SYSLOG_ACTION_READ_ALL:
1482 if (!buf || len < 0)
1487 if (!access_ok(VERIFY_WRITE, buf, len)) {
1491 error = syslog_print_all(buf, len, clear);
1493 /* Clear ring buffer */
1494 case SYSLOG_ACTION_CLEAR:
1495 syslog_print_all(NULL, 0, true);
1497 /* Disable logging to console */
1498 case SYSLOG_ACTION_CONSOLE_OFF:
1499 if (saved_console_loglevel == LOGLEVEL_DEFAULT)
1500 saved_console_loglevel = console_loglevel;
1501 console_loglevel = minimum_console_loglevel;
1503 /* Enable logging to console */
1504 case SYSLOG_ACTION_CONSOLE_ON:
1505 if (saved_console_loglevel != LOGLEVEL_DEFAULT) {
1506 console_loglevel = saved_console_loglevel;
1507 saved_console_loglevel = LOGLEVEL_DEFAULT;
1510 /* Set level of messages printed to console */
1511 case SYSLOG_ACTION_CONSOLE_LEVEL:
1513 if (len < 1 || len > 8)
1515 if (len < minimum_console_loglevel)
1516 len = minimum_console_loglevel;
1517 console_loglevel = len;
1518 /* Implicitly re-enable logging to console */
1519 saved_console_loglevel = LOGLEVEL_DEFAULT;
1522 /* Number of chars in the log buffer */
1523 case SYSLOG_ACTION_SIZE_UNREAD:
1524 raw_spin_lock_irq(&logbuf_lock);
1526 if (syslog_seq < log_first_seq) {
1527 /* messages are gone, move to first one */
1528 syslog_seq = log_first_seq;
1529 syslog_idx = log_first_idx;
1533 if (source == SYSLOG_FROM_PROC) {
1535 * Short-cut for poll(/"proc/kmsg") which simply checks
1536 * for pending data, not the size; return the count of
1537 * records, not the length.
1539 error = log_next_seq - syslog_seq;
1541 u64 seq = syslog_seq;
1542 u32 idx = syslog_idx;
1543 enum log_flags prev = syslog_prev;
1546 while (seq < log_next_seq) {
1547 struct printk_log *msg = log_from_idx(idx);
1549 error += msg_print_text(msg, prev, true, NULL, 0);
1550 idx = log_next(idx);
1554 error -= syslog_partial;
1556 raw_spin_unlock_irq(&logbuf_lock);
1558 /* Size of the log buffer */
1559 case SYSLOG_ACTION_SIZE_BUFFER:
1560 error = log_buf_len;
1570 SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
1572 return do_syslog(type, buf, len, SYSLOG_FROM_READER);
1576 * Call the console drivers, asking them to write out
1577 * log_buf[start] to log_buf[end - 1].
1578 * The console_lock must be held.
1580 static void call_console_drivers(int level,
1581 const char *ext_text, size_t ext_len,
1582 const char *text, size_t len)
1584 struct console *con;
1586 trace_console(text, len);
1588 if (!console_drivers)
1591 for_each_console(con) {
1592 if (exclusive_console && con != exclusive_console)
1594 if (!(con->flags & CON_ENABLED))
1598 if (!cpu_online(smp_processor_id()) &&
1599 !(con->flags & CON_ANYTIME))
1601 if (con->flags & CON_EXTENDED)
1602 con->write(con, ext_text, ext_len);
1604 con->write(con, text, len);
1609 * Zap console related locks when oopsing.
1610 * To leave time for slow consoles to print a full oops,
1611 * only zap at most once every 30 seconds.
1613 static void zap_locks(void)
1615 static unsigned long oops_timestamp;
1617 if (time_after_eq(jiffies, oops_timestamp) &&
1618 !time_after(jiffies, oops_timestamp + 30 * HZ))
1621 oops_timestamp = jiffies;
1624 /* If a crash is occurring, make sure we can't deadlock */
1625 raw_spin_lock_init(&logbuf_lock);
1626 /* And make sure that we print immediately */
1627 sema_init(&console_sem, 1);
1630 int printk_delay_msec __read_mostly;
1632 static inline void printk_delay(void)
1634 if (unlikely(printk_delay_msec)) {
1635 int m = printk_delay_msec;
1639 touch_nmi_watchdog();
1645 * Continuation lines are buffered, and not committed to the record buffer
1646 * until the line is complete, or a race forces it. The line fragments
1647 * though, are printed immediately to the consoles to ensure everything has
1648 * reached the console in case of a kernel crash.
1650 static struct cont {
1651 char buf[LOG_LINE_MAX];
1652 size_t len; /* length == 0 means unused buffer */
1653 size_t cons; /* bytes written to console */
1654 struct task_struct *owner; /* task of first print*/
1655 u64 ts_nsec; /* time of first print */
1656 u8 level; /* log level of first message */
1657 u8 facility; /* log facility of first message */
1658 enum log_flags flags; /* prefix, newline flags */
1659 bool flushed:1; /* buffer sealed and committed */
1662 static void cont_flush(void)
1670 * If a fragment of this line was directly flushed to the
1671 * console; wait for the console to pick up the rest of the
1672 * line. LOG_NOCONS suppresses a duplicated output.
1674 log_store(cont.facility, cont.level, cont.flags | LOG_NOCONS,
1675 cont.ts_nsec, NULL, 0, cont.buf, cont.len);
1676 cont.flushed = true;
1679 * If no fragment of this line ever reached the console,
1680 * just submit it to the store and free the buffer.
1682 log_store(cont.facility, cont.level, cont.flags, 0,
1683 NULL, 0, cont.buf, cont.len);
1688 static bool cont_add(int facility, int level, enum log_flags flags, const char *text, size_t len)
1690 if (cont.len && cont.flushed)
1694 * If ext consoles are present, flush and skip in-kernel
1695 * continuation. See nr_ext_console_drivers definition. Also, if
1696 * the line gets too long, split it up in separate records.
1698 if (nr_ext_console_drivers || cont.len + len > sizeof(cont.buf)) {
1704 cont.facility = facility;
1706 cont.owner = current;
1707 cont.ts_nsec = local_clock();
1710 cont.flushed = false;
1713 memcpy(cont.buf + cont.len, text, len);
1716 // The original flags come from the first line,
1717 // but later continuations can add a newline.
1718 if (flags & LOG_NEWLINE) {
1719 cont.flags |= LOG_NEWLINE;
1723 if (cont.len > (sizeof(cont.buf) * 80) / 100)
1729 static size_t cont_print_text(char *text, size_t size)
1734 if (cont.cons == 0 && (console_prev & LOG_NEWLINE)) {
1735 textlen += print_time(cont.ts_nsec, text);
1739 len = cont.len - cont.cons;
1743 memcpy(text + textlen, cont.buf + cont.cons, len);
1745 cont.cons = cont.len;
1749 if (cont.flags & LOG_NEWLINE)
1750 text[textlen++] = '\n';
1751 /* got everything, release buffer */
1757 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)
1760 * If an earlier line was buffered, and we're a continuation
1761 * write from the same process, try to add it to the buffer.
1764 if (cont.owner == current && (lflags & LOG_CONT)) {
1765 if (cont_add(facility, level, lflags, text, text_len))
1768 /* Otherwise, make sure it's flushed */
1772 /* Skip empty continuation lines that couldn't be added - they just flush */
1773 if (!text_len && (lflags & LOG_CONT))
1776 /* If it doesn't end in a newline, try to buffer the current line */
1777 if (!(lflags & LOG_NEWLINE)) {
1778 if (cont_add(facility, level, lflags, text, text_len))
1782 /* Store it in the record log */
1783 return log_store(facility, level, lflags, 0, dict, dictlen, text, text_len);
1786 asmlinkage int vprintk_emit(int facility, int level,
1787 const char *dict, size_t dictlen,
1788 const char *fmt, va_list args)
1790 static bool recursion_bug;
1791 static char textbuf[LOG_LINE_MAX];
1792 char *text = textbuf;
1793 size_t text_len = 0;
1794 enum log_flags lflags = 0;
1795 unsigned long flags;
1797 int printed_len = 0;
1798 int nmi_message_lost;
1799 bool in_sched = false;
1800 /* cpu currently holding logbuf_lock in this function */
1801 static unsigned int logbuf_cpu = UINT_MAX;
1803 if (level == LOGLEVEL_SCHED) {
1804 level = LOGLEVEL_DEFAULT;
1808 boot_delay_msec(level);
1811 local_irq_save(flags);
1812 this_cpu = smp_processor_id();
1815 * Ouch, printk recursed into itself!
1817 if (unlikely(logbuf_cpu == this_cpu)) {
1819 * If a crash is occurring during printk() on this CPU,
1820 * then try to get the crash message out but make sure
1821 * we can't deadlock. Otherwise just return to avoid the
1822 * recursion and return - but flag the recursion so that
1823 * it can be printed at the next appropriate moment:
1825 if (!oops_in_progress && !lockdep_recursing(current)) {
1826 recursion_bug = true;
1827 local_irq_restore(flags);
1834 /* This stops the holder of console_sem just where we want him */
1835 raw_spin_lock(&logbuf_lock);
1836 logbuf_cpu = this_cpu;
1838 if (unlikely(recursion_bug)) {
1839 static const char recursion_msg[] =
1840 "BUG: recent printk recursion!";
1842 recursion_bug = false;
1843 /* emit KERN_CRIT message */
1844 printed_len += log_store(0, 2, LOG_PREFIX|LOG_NEWLINE, 0,
1845 NULL, 0, recursion_msg,
1846 strlen(recursion_msg));
1849 nmi_message_lost = get_nmi_message_lost();
1850 if (unlikely(nmi_message_lost)) {
1851 text_len = scnprintf(textbuf, sizeof(textbuf),
1852 "BAD LUCK: lost %d message(s) from NMI context!",
1854 printed_len += log_store(0, 2, LOG_PREFIX|LOG_NEWLINE, 0,
1855 NULL, 0, textbuf, text_len);
1859 * The printf needs to come first; we need the syslog
1860 * prefix which might be passed-in as a parameter.
1862 text_len = vscnprintf(text, sizeof(textbuf), fmt, args);
1864 /* mark and strip a trailing newline */
1865 if (text_len && text[text_len-1] == '\n') {
1867 lflags |= LOG_NEWLINE;
1870 /* strip kernel syslog prefix and extract log level or control flags */
1871 if (facility == 0) {
1874 while ((kern_level = printk_get_level(text)) != 0) {
1875 switch (kern_level) {
1877 if (level == LOGLEVEL_DEFAULT)
1878 level = kern_level - '0';
1880 case 'd': /* KERN_DEFAULT */
1881 lflags |= LOG_PREFIX;
1883 case 'c': /* KERN_CONT */
1892 if (level == LOGLEVEL_DEFAULT)
1893 level = default_message_loglevel;
1896 lflags |= LOG_PREFIX|LOG_NEWLINE;
1898 printed_len += log_output(facility, level, lflags, dict, dictlen, text, text_len);
1900 logbuf_cpu = UINT_MAX;
1901 raw_spin_unlock(&logbuf_lock);
1903 local_irq_restore(flags);
1905 /* If called from the scheduler, we can not call up(). */
1909 * Try to acquire and then immediately release the console
1910 * semaphore. The release will print out buffers and wake up
1911 * /dev/kmsg and syslog() users.
1913 if (console_trylock())
1920 EXPORT_SYMBOL(vprintk_emit);
1922 asmlinkage int vprintk(const char *fmt, va_list args)
1924 return vprintk_emit(0, LOGLEVEL_DEFAULT, NULL, 0, fmt, args);
1926 EXPORT_SYMBOL(vprintk);
1928 asmlinkage int printk_emit(int facility, int level,
1929 const char *dict, size_t dictlen,
1930 const char *fmt, ...)
1935 va_start(args, fmt);
1936 r = vprintk_emit(facility, level, dict, dictlen, fmt, args);
1941 EXPORT_SYMBOL(printk_emit);
1943 int vprintk_default(const char *fmt, va_list args)
1947 #ifdef CONFIG_KGDB_KDB
1948 if (unlikely(kdb_trap_printk)) {
1949 r = vkdb_printf(KDB_MSGSRC_PRINTK, fmt, args);
1953 r = vprintk_emit(0, LOGLEVEL_DEFAULT, NULL, 0, fmt, args);
1957 EXPORT_SYMBOL_GPL(vprintk_default);
1960 * printk - print a kernel message
1961 * @fmt: format string
1963 * This is printk(). It can be called from any context. We want it to work.
1965 * We try to grab the console_lock. If we succeed, it's easy - we log the
1966 * output and call the console drivers. If we fail to get the semaphore, we
1967 * place the output into the log buffer and return. The current holder of
1968 * the console_sem will notice the new output in console_unlock(); and will
1969 * send it to the consoles before releasing the lock.
1971 * One effect of this deferred printing is that code which calls printk() and
1972 * then changes console_loglevel may break. This is because console_loglevel
1973 * is inspected when the actual printing occurs.
1978 * See the vsnprintf() documentation for format string extensions over C99.
1980 asmlinkage __visible int printk(const char *fmt, ...)
1985 va_start(args, fmt);
1986 r = vprintk_func(fmt, args);
1991 EXPORT_SYMBOL(printk);
1993 #else /* CONFIG_PRINTK */
1995 #define LOG_LINE_MAX 0
1996 #define PREFIX_MAX 0
1998 static u64 syslog_seq;
1999 static u32 syslog_idx;
2000 static u64 console_seq;
2001 static u32 console_idx;
2002 static enum log_flags syslog_prev;
2003 static u64 log_first_seq;
2004 static u32 log_first_idx;
2005 static u64 log_next_seq;
2006 static enum log_flags console_prev;
2007 static struct cont {
2013 static char *log_text(const struct printk_log *msg) { return NULL; }
2014 static char *log_dict(const struct printk_log *msg) { return NULL; }
2015 static struct printk_log *log_from_idx(u32 idx) { return NULL; }
2016 static u32 log_next(u32 idx) { return 0; }
2017 static ssize_t msg_print_ext_header(char *buf, size_t size,
2018 struct printk_log *msg, u64 seq,
2019 enum log_flags prev_flags) { return 0; }
2020 static ssize_t msg_print_ext_body(char *buf, size_t size,
2021 char *dict, size_t dict_len,
2022 char *text, size_t text_len) { return 0; }
2023 static void call_console_drivers(int level,
2024 const char *ext_text, size_t ext_len,
2025 const char *text, size_t len) {}
2026 static size_t msg_print_text(const struct printk_log *msg, enum log_flags prev,
2027 bool syslog, char *buf, size_t size) { return 0; }
2028 static size_t cont_print_text(char *text, size_t size) { return 0; }
2029 static bool suppress_message_printing(int level) { return false; }
2031 /* Still needs to be defined for users */
2032 DEFINE_PER_CPU(printk_func_t, printk_func);
2034 #endif /* CONFIG_PRINTK */
2036 #ifdef CONFIG_EARLY_PRINTK
2037 struct console *early_console;
2039 asmlinkage __visible void early_printk(const char *fmt, ...)
2049 n = vscnprintf(buf, sizeof(buf), fmt, ap);
2052 early_console->write(early_console, buf, n);
2056 static int __add_preferred_console(char *name, int idx, char *options,
2059 struct console_cmdline *c;
2063 * See if this tty is not yet registered, and
2064 * if we have a slot free.
2066 for (i = 0, c = console_cmdline;
2067 i < MAX_CMDLINECONSOLES && c->name[0];
2069 if (strcmp(c->name, name) == 0 && c->index == idx) {
2071 selected_console = i;
2075 if (i == MAX_CMDLINECONSOLES)
2078 selected_console = i;
2079 strlcpy(c->name, name, sizeof(c->name));
2080 c->options = options;
2081 braille_set_options(c, brl_options);
2087 * Set up a console. Called via do_early_param() in init/main.c
2088 * for each "console=" parameter in the boot command line.
2090 static int __init console_setup(char *str)
2092 char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for "ttyS" */
2093 char *s, *options, *brl_options = NULL;
2096 if (_braille_console_setup(&str, &brl_options))
2100 * Decode str into name, index, options.
2102 if (str[0] >= '0' && str[0] <= '9') {
2103 strcpy(buf, "ttyS");
2104 strncpy(buf + 4, str, sizeof(buf) - 5);
2106 strncpy(buf, str, sizeof(buf) - 1);
2108 buf[sizeof(buf) - 1] = 0;
2109 options = strchr(str, ',');
2113 if (!strcmp(str, "ttya"))
2114 strcpy(buf, "ttyS0");
2115 if (!strcmp(str, "ttyb"))
2116 strcpy(buf, "ttyS1");
2118 for (s = buf; *s; s++)
2119 if (isdigit(*s) || *s == ',')
2121 idx = simple_strtoul(s, NULL, 10);
2124 __add_preferred_console(buf, idx, options, brl_options);
2125 console_set_on_cmdline = 1;
2128 __setup("console=", console_setup);
2131 * add_preferred_console - add a device to the list of preferred consoles.
2132 * @name: device name
2133 * @idx: device index
2134 * @options: options for this console
2136 * The last preferred console added will be used for kernel messages
2137 * and stdin/out/err for init. Normally this is used by console_setup
2138 * above to handle user-supplied console arguments; however it can also
2139 * be used by arch-specific code either to override the user or more
2140 * commonly to provide a default console (ie from PROM variables) when
2141 * the user has not supplied one.
2143 int add_preferred_console(char *name, int idx, char *options)
2145 return __add_preferred_console(name, idx, options, NULL);
2148 bool console_suspend_enabled = true;
2149 EXPORT_SYMBOL(console_suspend_enabled);
2151 static int __init console_suspend_disable(char *str)
2153 console_suspend_enabled = false;
2156 __setup("no_console_suspend", console_suspend_disable);
2157 module_param_named(console_suspend, console_suspend_enabled,
2158 bool, S_IRUGO | S_IWUSR);
2159 MODULE_PARM_DESC(console_suspend, "suspend console during suspend"
2160 " and hibernate operations");
2163 * suspend_console - suspend the console subsystem
2165 * This disables printk() while we go into suspend states
2167 void suspend_console(void)
2169 if (!console_suspend_enabled)
2171 printk("Suspending console(s) (use no_console_suspend to debug)\n");
2173 console_suspended = 1;
2177 void resume_console(void)
2179 if (!console_suspend_enabled)
2182 console_suspended = 0;
2187 * console_cpu_notify - print deferred console messages after CPU hotplug
2188 * @self: notifier struct
2189 * @action: CPU hotplug event
2192 * If printk() is called from a CPU that is not online yet, the messages
2193 * will be spooled but will not show up on the console. This function is
2194 * called when a new CPU comes online (or fails to come up), and ensures
2195 * that any such output gets printed.
2197 static int console_cpu_notify(struct notifier_block *self,
2198 unsigned long action, void *hcpu)
2203 case CPU_DOWN_FAILED:
2204 case CPU_UP_CANCELED:
2212 * console_lock - lock the console system for exclusive use.
2214 * Acquires a lock which guarantees that the caller has
2215 * exclusive access to the console system and the console_drivers list.
2217 * Can sleep, returns nothing.
2219 void console_lock(void)
2224 if (console_suspended)
2227 console_may_schedule = 1;
2229 EXPORT_SYMBOL(console_lock);
2232 * console_trylock - try to lock the console system for exclusive use.
2234 * Try to acquire a lock which guarantees that the caller has exclusive
2235 * access to the console system and the console_drivers list.
2237 * returns 1 on success, and 0 on failure to acquire the lock.
2239 int console_trylock(void)
2241 if (down_trylock_console_sem())
2243 if (console_suspended) {
2249 * When PREEMPT_COUNT disabled we can't reliably detect if it's
2250 * safe to schedule (e.g. calling printk while holding a spin_lock),
2251 * because preempt_disable()/preempt_enable() are just barriers there
2252 * and preempt_count() is always 0.
2254 * RCU read sections have a separate preemption counter when
2255 * PREEMPT_RCU enabled thus we must take extra care and check
2256 * rcu_preempt_depth(), otherwise RCU read sections modify
2259 console_may_schedule = !oops_in_progress &&
2261 !rcu_preempt_depth();
2264 EXPORT_SYMBOL(console_trylock);
2266 int is_console_locked(void)
2268 return console_locked;
2272 * Check if we have any console that is capable of printing while cpu is
2273 * booting or shutting down. Requires console_sem.
2275 static int have_callable_console(void)
2277 struct console *con;
2279 for_each_console(con)
2280 if ((con->flags & CON_ENABLED) &&
2281 (con->flags & CON_ANYTIME))
2288 * Can we actually use the console at this time on this cpu?
2290 * Console drivers may assume that per-cpu resources have been allocated. So
2291 * unless they're explicitly marked as being able to cope (CON_ANYTIME) don't
2292 * call them until this CPU is officially up.
2294 static inline int can_use_console(void)
2296 return cpu_online(raw_smp_processor_id()) || have_callable_console();
2299 static void console_cont_flush(char *text, size_t size)
2301 unsigned long flags;
2304 raw_spin_lock_irqsave(&logbuf_lock, flags);
2309 if (suppress_message_printing(cont.level)) {
2310 cont.cons = cont.len;
2317 * We still queue earlier records, likely because the console was
2318 * busy. The earlier ones need to be printed before this one, we
2319 * did not flush any fragment so far, so just let it queue up.
2321 if (console_seq < log_next_seq && !cont.cons)
2324 len = cont_print_text(text, size);
2325 raw_spin_unlock(&logbuf_lock);
2326 stop_critical_timings();
2327 call_console_drivers(cont.level, NULL, 0, text, len);
2328 start_critical_timings();
2329 local_irq_restore(flags);
2332 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2336 * console_unlock - unlock the console system
2338 * Releases the console_lock which the caller holds on the console system
2339 * and the console driver list.
2341 * While the console_lock was held, console output may have been buffered
2342 * by printk(). If this is the case, console_unlock(); emits
2343 * the output prior to releasing the lock.
2345 * If there is output waiting, we wake /dev/kmsg and syslog() users.
2347 * console_unlock(); may be called from any context.
2349 void console_unlock(void)
2351 static char ext_text[CONSOLE_EXT_LOG_MAX];
2352 static char text[LOG_LINE_MAX + PREFIX_MAX];
2353 static u64 seen_seq;
2354 unsigned long flags;
2355 bool wake_klogd = false;
2356 bool do_cond_resched, retry;
2358 if (console_suspended) {
2364 * Console drivers are called under logbuf_lock, so
2365 * @console_may_schedule should be cleared before; however, we may
2366 * end up dumping a lot of lines, for example, if called from
2367 * console registration path, and should invoke cond_resched()
2368 * between lines if allowable. Not doing so can cause a very long
2369 * scheduling stall on a slow console leading to RCU stall and
2370 * softlockup warnings which exacerbate the issue with more
2371 * messages practically incapacitating the system.
2373 do_cond_resched = console_may_schedule;
2374 console_may_schedule = 0;
2378 * We released the console_sem lock, so we need to recheck if
2379 * cpu is online and (if not) is there at least one CON_ANYTIME
2382 if (!can_use_console()) {
2388 /* flush buffered message fragment immediately to console */
2389 console_cont_flush(text, sizeof(text));
2392 struct printk_log *msg;
2397 raw_spin_lock_irqsave(&logbuf_lock, flags);
2398 if (seen_seq != log_next_seq) {
2400 seen_seq = log_next_seq;
2403 if (console_seq < log_first_seq) {
2404 len = sprintf(text, "** %u printk messages dropped ** ",
2405 (unsigned)(log_first_seq - console_seq));
2407 /* messages are gone, move to first one */
2408 console_seq = log_first_seq;
2409 console_idx = log_first_idx;
2415 if (console_seq == log_next_seq)
2418 msg = log_from_idx(console_idx);
2420 if ((msg->flags & LOG_NOCONS) ||
2421 suppress_message_printing(level)) {
2423 * Skip record we have buffered and already printed
2424 * directly to the console when we received it, and
2425 * record that has level above the console loglevel.
2427 console_idx = log_next(console_idx);
2430 * We will get here again when we register a new
2431 * CON_PRINTBUFFER console. Clear the flag so we
2432 * will properly dump everything later.
2434 msg->flags &= ~LOG_NOCONS;
2435 console_prev = msg->flags;
2439 len += msg_print_text(msg, console_prev, false,
2440 text + len, sizeof(text) - len);
2441 if (nr_ext_console_drivers) {
2442 ext_len = msg_print_ext_header(ext_text,
2444 msg, console_seq, console_prev);
2445 ext_len += msg_print_ext_body(ext_text + ext_len,
2446 sizeof(ext_text) - ext_len,
2447 log_dict(msg), msg->dict_len,
2448 log_text(msg), msg->text_len);
2450 console_idx = log_next(console_idx);
2452 console_prev = msg->flags;
2453 raw_spin_unlock(&logbuf_lock);
2455 stop_critical_timings(); /* don't trace print latency */
2456 call_console_drivers(level, ext_text, ext_len, text, len);
2457 start_critical_timings();
2458 local_irq_restore(flags);
2460 if (do_cond_resched)
2465 /* Release the exclusive_console once it is used */
2466 if (unlikely(exclusive_console))
2467 exclusive_console = NULL;
2469 raw_spin_unlock(&logbuf_lock);
2474 * Someone could have filled up the buffer again, so re-check if there's
2475 * something to flush. In case we cannot trylock the console_sem again,
2476 * there's a new owner and the console_unlock() from them will do the
2477 * flush, no worries.
2479 raw_spin_lock(&logbuf_lock);
2480 retry = console_seq != log_next_seq;
2481 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2483 if (retry && console_trylock())
2489 EXPORT_SYMBOL(console_unlock);
2492 * console_conditional_schedule - yield the CPU if required
2494 * If the console code is currently allowed to sleep, and
2495 * if this CPU should yield the CPU to another task, do
2498 * Must be called within console_lock();.
2500 void __sched console_conditional_schedule(void)
2502 if (console_may_schedule)
2505 EXPORT_SYMBOL(console_conditional_schedule);
2507 void console_unblank(void)
2512 * console_unblank can no longer be called in interrupt context unless
2513 * oops_in_progress is set to 1..
2515 if (oops_in_progress) {
2516 if (down_trylock_console_sem() != 0)
2522 console_may_schedule = 0;
2524 if ((c->flags & CON_ENABLED) && c->unblank)
2530 * console_flush_on_panic - flush console content on panic
2532 * Immediately output all pending messages no matter what.
2534 void console_flush_on_panic(void)
2537 * If someone else is holding the console lock, trylock will fail
2538 * and may_schedule may be set. Ignore and proceed to unlock so
2539 * that messages are flushed out. As this can be called from any
2540 * context and we don't want to get preempted while flushing,
2541 * ensure may_schedule is cleared.
2544 console_may_schedule = 0;
2549 * Return the console tty driver structure and its associated index
2551 struct tty_driver *console_device(int *index)
2554 struct tty_driver *driver = NULL;
2557 for_each_console(c) {
2560 driver = c->device(c, index);
2569 * Prevent further output on the passed console device so that (for example)
2570 * serial drivers can disable console output before suspending a port, and can
2571 * re-enable output afterwards.
2573 void console_stop(struct console *console)
2576 console->flags &= ~CON_ENABLED;
2579 EXPORT_SYMBOL(console_stop);
2581 void console_start(struct console *console)
2584 console->flags |= CON_ENABLED;
2587 EXPORT_SYMBOL(console_start);
2589 static int __read_mostly keep_bootcon;
2591 static int __init keep_bootcon_setup(char *str)
2594 pr_info("debug: skip boot console de-registration.\n");
2599 early_param("keep_bootcon", keep_bootcon_setup);
2602 * The console driver calls this routine during kernel initialization
2603 * to register the console printing procedure with printk() and to
2604 * print any messages that were printed by the kernel before the
2605 * console driver was initialized.
2607 * This can happen pretty early during the boot process (because of
2608 * early_printk) - sometimes before setup_arch() completes - be careful
2609 * of what kernel features are used - they may not be initialised yet.
2611 * There are two types of consoles - bootconsoles (early_printk) and
2612 * "real" consoles (everything which is not a bootconsole) which are
2613 * handled differently.
2614 * - Any number of bootconsoles can be registered at any time.
2615 * - As soon as a "real" console is registered, all bootconsoles
2616 * will be unregistered automatically.
2617 * - Once a "real" console is registered, any attempt to register a
2618 * bootconsoles will be rejected
2620 void register_console(struct console *newcon)
2623 unsigned long flags;
2624 struct console *bcon = NULL;
2625 struct console_cmdline *c;
2627 if (console_drivers)
2628 for_each_console(bcon)
2629 if (WARN(bcon == newcon,
2630 "console '%s%d' already registered\n",
2631 bcon->name, bcon->index))
2635 * before we register a new CON_BOOT console, make sure we don't
2636 * already have a valid console
2638 if (console_drivers && newcon->flags & CON_BOOT) {
2639 /* find the last or real console */
2640 for_each_console(bcon) {
2641 if (!(bcon->flags & CON_BOOT)) {
2642 pr_info("Too late to register bootconsole %s%d\n",
2643 newcon->name, newcon->index);
2649 if (console_drivers && console_drivers->flags & CON_BOOT)
2650 bcon = console_drivers;
2652 if (preferred_console < 0 || bcon || !console_drivers)
2653 preferred_console = selected_console;
2656 * See if we want to use this console driver. If we
2657 * didn't select a console we take the first one
2658 * that registers here.
2660 if (preferred_console < 0 && !of_specified_console) {
2661 if (newcon->index < 0)
2663 if (newcon->setup == NULL ||
2664 newcon->setup(newcon, NULL) == 0) {
2665 newcon->flags |= CON_ENABLED;
2666 if (newcon->device) {
2667 newcon->flags |= CON_CONSDEV;
2668 preferred_console = 0;
2674 * See if this console matches one we selected on
2677 for (i = 0, c = console_cmdline;
2678 i < MAX_CMDLINECONSOLES && c->name[0];
2680 if (!newcon->match ||
2681 newcon->match(newcon, c->name, c->index, c->options) != 0) {
2682 /* default matching */
2683 BUILD_BUG_ON(sizeof(c->name) != sizeof(newcon->name));
2684 if (strcmp(c->name, newcon->name) != 0)
2686 if (newcon->index >= 0 &&
2687 newcon->index != c->index)
2689 if (newcon->index < 0)
2690 newcon->index = c->index;
2692 if (_braille_register_console(newcon, c))
2695 if (newcon->setup &&
2696 newcon->setup(newcon, c->options) != 0)
2700 newcon->flags |= CON_ENABLED;
2701 if (i == selected_console) {
2702 newcon->flags |= CON_CONSDEV;
2703 preferred_console = selected_console;
2708 if (!(newcon->flags & CON_ENABLED))
2712 * If we have a bootconsole, and are switching to a real console,
2713 * don't print everything out again, since when the boot console, and
2714 * the real console are the same physical device, it's annoying to
2715 * see the beginning boot messages twice
2717 if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
2718 newcon->flags &= ~CON_PRINTBUFFER;
2721 * Put this console in the list - keep the
2722 * preferred driver at the head of the list.
2725 if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
2726 newcon->next = console_drivers;
2727 console_drivers = newcon;
2729 newcon->next->flags &= ~CON_CONSDEV;
2731 newcon->next = console_drivers->next;
2732 console_drivers->next = newcon;
2735 if (newcon->flags & CON_EXTENDED)
2736 if (!nr_ext_console_drivers++)
2737 pr_info("printk: continuation disabled due to ext consoles, expect more fragments in /dev/kmsg\n");
2739 if (newcon->flags & CON_PRINTBUFFER) {
2741 * console_unlock(); will print out the buffered messages
2744 raw_spin_lock_irqsave(&logbuf_lock, flags);
2745 console_seq = syslog_seq;
2746 console_idx = syslog_idx;
2747 console_prev = syslog_prev;
2748 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2750 * We're about to replay the log buffer. Only do this to the
2751 * just-registered console to avoid excessive message spam to
2752 * the already-registered consoles.
2754 exclusive_console = newcon;
2757 console_sysfs_notify();
2760 * By unregistering the bootconsoles after we enable the real console
2761 * we get the "console xxx enabled" message on all the consoles -
2762 * boot consoles, real consoles, etc - this is to ensure that end
2763 * users know there might be something in the kernel's log buffer that
2764 * went to the bootconsole (that they do not see on the real console)
2766 pr_info("%sconsole [%s%d] enabled\n",
2767 (newcon->flags & CON_BOOT) ? "boot" : "" ,
2768 newcon->name, newcon->index);
2770 ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
2772 /* We need to iterate through all boot consoles, to make
2773 * sure we print everything out, before we unregister them.
2775 for_each_console(bcon)
2776 if (bcon->flags & CON_BOOT)
2777 unregister_console(bcon);
2780 EXPORT_SYMBOL(register_console);
2782 int unregister_console(struct console *console)
2784 struct console *a, *b;
2787 pr_info("%sconsole [%s%d] disabled\n",
2788 (console->flags & CON_BOOT) ? "boot" : "" ,
2789 console->name, console->index);
2791 res = _braille_unregister_console(console);
2797 if (console_drivers == console) {
2798 console_drivers=console->next;
2800 } else if (console_drivers) {
2801 for (a=console_drivers->next, b=console_drivers ;
2802 a; b=a, a=b->next) {
2811 if (!res && (console->flags & CON_EXTENDED))
2812 nr_ext_console_drivers--;
2815 * If this isn't the last console and it has CON_CONSDEV set, we
2816 * need to set it on the next preferred console.
2818 if (console_drivers != NULL && console->flags & CON_CONSDEV)
2819 console_drivers->flags |= CON_CONSDEV;
2821 console->flags &= ~CON_ENABLED;
2823 console_sysfs_notify();
2826 EXPORT_SYMBOL(unregister_console);
2829 * Some boot consoles access data that is in the init section and which will
2830 * be discarded after the initcalls have been run. To make sure that no code
2831 * will access this data, unregister the boot consoles in a late initcall.
2833 * If for some reason, such as deferred probe or the driver being a loadable
2834 * module, the real console hasn't registered yet at this point, there will
2835 * be a brief interval in which no messages are logged to the console, which
2836 * makes it difficult to diagnose problems that occur during this time.
2838 * To mitigate this problem somewhat, only unregister consoles whose memory
2839 * intersects with the init section. Note that code exists elsewhere to get
2840 * rid of the boot console as soon as the proper console shows up, so there
2841 * won't be side-effects from postponing the removal.
2843 static int __init printk_late_init(void)
2845 struct console *con;
2847 for_each_console(con) {
2848 if (!keep_bootcon && con->flags & CON_BOOT) {
2850 * Make sure to unregister boot consoles whose data
2851 * resides in the init section before the init section
2852 * is discarded. Boot consoles whose data will stick
2853 * around will automatically be unregistered when the
2854 * proper console replaces them.
2856 if (init_section_intersects(con, sizeof(*con)))
2857 unregister_console(con);
2860 hotcpu_notifier(console_cpu_notify, 0);
2863 late_initcall(printk_late_init);
2865 #if defined CONFIG_PRINTK
2867 * Delayed printk version, for scheduler-internal messages:
2869 #define PRINTK_PENDING_WAKEUP 0x01
2870 #define PRINTK_PENDING_OUTPUT 0x02
2872 static DEFINE_PER_CPU(int, printk_pending);
2874 static void wake_up_klogd_work_func(struct irq_work *irq_work)
2876 int pending = __this_cpu_xchg(printk_pending, 0);
2878 if (pending & PRINTK_PENDING_OUTPUT) {
2879 /* If trylock fails, someone else is doing the printing */
2880 if (console_trylock())
2884 if (pending & PRINTK_PENDING_WAKEUP)
2885 wake_up_interruptible(&log_wait);
2888 static DEFINE_PER_CPU(struct irq_work, wake_up_klogd_work) = {
2889 .func = wake_up_klogd_work_func,
2890 .flags = IRQ_WORK_LAZY,
2893 void wake_up_klogd(void)
2896 if (waitqueue_active(&log_wait)) {
2897 this_cpu_or(printk_pending, PRINTK_PENDING_WAKEUP);
2898 irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2903 int printk_deferred(const char *fmt, ...)
2909 va_start(args, fmt);
2910 r = vprintk_emit(0, LOGLEVEL_SCHED, NULL, 0, fmt, args);
2913 __this_cpu_or(printk_pending, PRINTK_PENDING_OUTPUT);
2914 irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2921 * printk rate limiting, lifted from the networking subsystem.
2923 * This enforces a rate limit: not more than 10 kernel messages
2924 * every 5s to make a denial-of-service attack impossible.
2926 DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
2928 int __printk_ratelimit(const char *func)
2930 return ___ratelimit(&printk_ratelimit_state, func);
2932 EXPORT_SYMBOL(__printk_ratelimit);
2935 * printk_timed_ratelimit - caller-controlled printk ratelimiting
2936 * @caller_jiffies: pointer to caller's state
2937 * @interval_msecs: minimum interval between prints
2939 * printk_timed_ratelimit() returns true if more than @interval_msecs
2940 * milliseconds have elapsed since the last time printk_timed_ratelimit()
2943 bool printk_timed_ratelimit(unsigned long *caller_jiffies,
2944 unsigned int interval_msecs)
2946 unsigned long elapsed = jiffies - *caller_jiffies;
2948 if (*caller_jiffies && elapsed <= msecs_to_jiffies(interval_msecs))
2951 *caller_jiffies = jiffies;
2954 EXPORT_SYMBOL(printk_timed_ratelimit);
2956 static DEFINE_SPINLOCK(dump_list_lock);
2957 static LIST_HEAD(dump_list);
2960 * kmsg_dump_register - register a kernel log dumper.
2961 * @dumper: pointer to the kmsg_dumper structure
2963 * Adds a kernel log dumper to the system. The dump callback in the
2964 * structure will be called when the kernel oopses or panics and must be
2965 * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
2967 int kmsg_dump_register(struct kmsg_dumper *dumper)
2969 unsigned long flags;
2972 /* The dump callback needs to be set */
2976 spin_lock_irqsave(&dump_list_lock, flags);
2977 /* Don't allow registering multiple times */
2978 if (!dumper->registered) {
2979 dumper->registered = 1;
2980 list_add_tail_rcu(&dumper->list, &dump_list);
2983 spin_unlock_irqrestore(&dump_list_lock, flags);
2987 EXPORT_SYMBOL_GPL(kmsg_dump_register);
2990 * kmsg_dump_unregister - unregister a kmsg dumper.
2991 * @dumper: pointer to the kmsg_dumper structure
2993 * Removes a dump device from the system. Returns zero on success and
2994 * %-EINVAL otherwise.
2996 int kmsg_dump_unregister(struct kmsg_dumper *dumper)
2998 unsigned long flags;
3001 spin_lock_irqsave(&dump_list_lock, flags);
3002 if (dumper->registered) {
3003 dumper->registered = 0;
3004 list_del_rcu(&dumper->list);
3007 spin_unlock_irqrestore(&dump_list_lock, flags);
3012 EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
3014 static bool always_kmsg_dump;
3015 module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);
3018 * kmsg_dump - dump kernel log to kernel message dumpers.
3019 * @reason: the reason (oops, panic etc) for dumping
3021 * Call each of the registered dumper's dump() callback, which can
3022 * retrieve the kmsg records with kmsg_dump_get_line() or
3023 * kmsg_dump_get_buffer().
3025 void kmsg_dump(enum kmsg_dump_reason reason)
3027 struct kmsg_dumper *dumper;
3028 unsigned long flags;
3030 if ((reason > KMSG_DUMP_OOPS) && !always_kmsg_dump)
3034 list_for_each_entry_rcu(dumper, &dump_list, list) {
3035 if (dumper->max_reason && reason > dumper->max_reason)
3038 /* initialize iterator with data about the stored records */
3039 dumper->active = true;
3041 raw_spin_lock_irqsave(&logbuf_lock, flags);
3043 dumper->cur_seq = clear_seq;
3044 dumper->cur_idx = clear_idx;
3045 dumper->next_seq = log_next_seq;
3046 dumper->next_idx = log_next_idx;
3047 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
3049 /* invoke dumper which will iterate over records */
3050 dumper->dump(dumper, reason);
3052 /* reset iterator */
3053 dumper->active = false;
3059 * kmsg_dump_get_line_nolock - retrieve one kmsg log line (unlocked version)
3060 * @dumper: registered kmsg dumper
3061 * @syslog: include the "<4>" prefixes
3062 * @line: buffer to copy the line to
3063 * @size: maximum size of the buffer
3064 * @len: length of line placed into buffer
3066 * Start at the beginning of the kmsg buffer, with the oldest kmsg
3067 * record, and copy one record into the provided buffer.
3069 * Consecutive calls will return the next available record moving
3070 * towards the end of the buffer with the youngest messages.
3072 * A return value of FALSE indicates that there are no more records to
3075 * The function is similar to kmsg_dump_get_line(), but grabs no locks.
3077 bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper, bool syslog,
3078 char *line, size_t size, size_t *len)
3080 struct printk_log *msg;
3084 if (!dumper->active)
3087 if (dumper->cur_seq < log_first_seq) {
3088 /* messages are gone, move to first available one */
3089 dumper->cur_seq = log_first_seq;
3090 dumper->cur_idx = log_first_idx;
3094 if (dumper->cur_seq >= log_next_seq)
3097 msg = log_from_idx(dumper->cur_idx);
3098 l = msg_print_text(msg, 0, syslog, line, size);
3100 dumper->cur_idx = log_next(dumper->cur_idx);
3110 * kmsg_dump_get_line - retrieve one kmsg log line
3111 * @dumper: registered kmsg dumper
3112 * @syslog: include the "<4>" prefixes
3113 * @line: buffer to copy the line to
3114 * @size: maximum size of the buffer
3115 * @len: length of line placed into buffer
3117 * Start at the beginning of the kmsg buffer, with the oldest kmsg
3118 * record, and copy one record into the provided buffer.
3120 * Consecutive calls will return the next available record moving
3121 * towards the end of the buffer with the youngest messages.
3123 * A return value of FALSE indicates that there are no more records to
3126 bool kmsg_dump_get_line(struct kmsg_dumper *dumper, bool syslog,
3127 char *line, size_t size, size_t *len)
3129 unsigned long flags;
3132 raw_spin_lock_irqsave(&logbuf_lock, flags);
3134 ret = kmsg_dump_get_line_nolock(dumper, syslog, line, size, len);
3135 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
3139 EXPORT_SYMBOL_GPL(kmsg_dump_get_line);
3142 * kmsg_dump_get_buffer - copy kmsg log lines
3143 * @dumper: registered kmsg dumper
3144 * @syslog: include the "<4>" prefixes
3145 * @buf: buffer to copy the line to
3146 * @size: maximum size of the buffer
3147 * @len: length of line placed into buffer
3149 * Start at the end of the kmsg buffer and fill the provided buffer
3150 * with as many of the the *youngest* kmsg records that fit into it.
3151 * If the buffer is large enough, all available kmsg records will be
3152 * copied with a single call.
3154 * Consecutive calls will fill the buffer with the next block of
3155 * available older records, not including the earlier retrieved ones.
3157 * A return value of FALSE indicates that there are no more records to
3160 bool kmsg_dump_get_buffer(struct kmsg_dumper *dumper, bool syslog,
3161 char *buf, size_t size, size_t *len)
3163 unsigned long flags;
3168 enum log_flags prev;
3172 if (!dumper->active)
3175 raw_spin_lock_irqsave(&logbuf_lock, flags);
3177 if (dumper->cur_seq < log_first_seq) {
3178 /* messages are gone, move to first available one */
3179 dumper->cur_seq = log_first_seq;
3180 dumper->cur_idx = log_first_idx;
3184 if (dumper->cur_seq >= dumper->next_seq) {
3185 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
3189 /* calculate length of entire buffer */
3190 seq = dumper->cur_seq;
3191 idx = dumper->cur_idx;
3193 while (seq < dumper->next_seq) {
3194 struct printk_log *msg = log_from_idx(idx);
3196 l += msg_print_text(msg, prev, true, NULL, 0);
3197 idx = log_next(idx);
3202 /* move first record forward until length fits into the buffer */
3203 seq = dumper->cur_seq;
3204 idx = dumper->cur_idx;
3206 while (l > size && seq < dumper->next_seq) {
3207 struct printk_log *msg = log_from_idx(idx);
3209 l -= msg_print_text(msg, prev, true, NULL, 0);
3210 idx = log_next(idx);
3215 /* last message in next interation */
3220 while (seq < dumper->next_seq) {
3221 struct printk_log *msg = log_from_idx(idx);
3223 l += msg_print_text(msg, prev, syslog, buf + l, size - l);
3224 idx = log_next(idx);
3229 dumper->next_seq = next_seq;
3230 dumper->next_idx = next_idx;
3232 raw_spin_unlock_irqrestore(&logbuf_lock, 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 raw_spin_lock_irqsave(&logbuf_lock, flags);
3271 kmsg_dump_rewind_nolock(dumper);
3272 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
3274 EXPORT_SYMBOL_GPL(kmsg_dump_rewind);
3276 static char dump_stack_arch_desc_str[128];
3279 * dump_stack_set_arch_desc - set arch-specific str to show with task dumps
3280 * @fmt: printf-style format string
3281 * @...: arguments for the format string
3283 * The configured string will be printed right after utsname during task
3284 * dumps. Usually used to add arch-specific system identifiers. If an
3285 * arch wants to make use of such an ID string, it should initialize this
3286 * as soon as possible during boot.
3288 void __init dump_stack_set_arch_desc(const char *fmt, ...)
3292 va_start(args, fmt);
3293 vsnprintf(dump_stack_arch_desc_str, sizeof(dump_stack_arch_desc_str),
3299 * dump_stack_print_info - print generic debug info for dump_stack()
3300 * @log_lvl: log level
3302 * Arch-specific dump_stack() implementations can use this function to
3303 * print out the same debug information as the generic dump_stack().
3305 void dump_stack_print_info(const char *log_lvl)
3307 printk("%sCPU: %d PID: %d Comm: %.20s %s %s %.*s\n",
3308 log_lvl, raw_smp_processor_id(), current->pid, current->comm,
3309 print_tainted(), init_utsname()->release,
3310 (int)strcspn(init_utsname()->version, " "),
3311 init_utsname()->version);
3313 if (dump_stack_arch_desc_str[0] != '\0')
3314 printk("%sHardware name: %s\n",
3315 log_lvl, dump_stack_arch_desc_str);
3317 print_worker_info(log_lvl, current);
3321 * show_regs_print_info - print generic debug info for show_regs()
3322 * @log_lvl: log level
3324 * show_regs() implementations can use this function to print out generic
3325 * debug information.
3327 void show_regs_print_info(const char *log_lvl)
3329 dump_stack_print_info(log_lvl);
3331 printk("%stask: %p task.stack: %p\n",
3332 log_lvl, current, task_stack_page(current));