1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/kernel/printk.c
5 * Copyright (C) 1991, 1992 Linus Torvalds
7 * Modified to make sys_syslog() more flexible: added commands to
8 * return the last 4k of kernel messages, regardless of whether
9 * they've been read or not. Added option to suppress kernel printk's
10 * to the console. Added hook for sending the console messages
11 * elsewhere, in preparation for a serial line console (someday).
13 * Modified for sysctl support, 1/8/97, Chris Horn.
14 * Fixed SMP synchronization, 08/08/99, Manfred Spraul
15 * manfred@colorfullife.com
16 * Rewrote bits to get rid of console_lock
17 * 01Mar01 Andrew Morton
20 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
22 #include <linux/kernel.h>
24 #include <linux/tty.h>
25 #include <linux/tty_driver.h>
26 #include <linux/console.h>
27 #include <linux/init.h>
28 #include <linux/jiffies.h>
29 #include <linux/nmi.h>
30 #include <linux/module.h>
31 #include <linux/moduleparam.h>
32 #include <linux/delay.h>
33 #include <linux/smp.h>
34 #include <linux/security.h>
35 #include <linux/memblock.h>
36 #include <linux/syscalls.h>
37 #include <linux/crash_core.h>
38 #include <linux/ratelimit.h>
39 #include <linux/kmsg_dump.h>
40 #include <linux/syslog.h>
41 #include <linux/cpu.h>
42 #include <linux/rculist.h>
43 #include <linux/poll.h>
44 #include <linux/irq_work.h>
45 #include <linux/ctype.h>
46 #include <linux/uio.h>
47 #include <linux/sched/clock.h>
48 #include <linux/sched/debug.h>
49 #include <linux/sched/task_stack.h>
51 #include <linux/uaccess.h>
52 #include <asm/sections.h>
54 #include <trace/events/initcall.h>
55 #define CREATE_TRACE_POINTS
56 #include <trace/events/printk.h>
58 #include "printk_ringbuffer.h"
59 #include "console_cmdline.h"
63 int console_printk[4] = {
64 CONSOLE_LOGLEVEL_DEFAULT, /* console_loglevel */
65 MESSAGE_LOGLEVEL_DEFAULT, /* default_message_loglevel */
66 CONSOLE_LOGLEVEL_MIN, /* minimum_console_loglevel */
67 CONSOLE_LOGLEVEL_DEFAULT, /* default_console_loglevel */
69 EXPORT_SYMBOL_GPL(console_printk);
71 atomic_t ignore_console_lock_warning __read_mostly = ATOMIC_INIT(0);
72 EXPORT_SYMBOL(ignore_console_lock_warning);
75 * Low level drivers may need that to know if they can schedule in
76 * their unblank() callback or not. So let's export it.
79 EXPORT_SYMBOL(oops_in_progress);
82 * console_sem protects the console_drivers list, and also
83 * provides serialisation for access to the entire console
86 static DEFINE_SEMAPHORE(console_sem);
87 struct console *console_drivers;
88 EXPORT_SYMBOL_GPL(console_drivers);
91 * System may need to suppress printk message under certain
92 * circumstances, like after kernel panic happens.
94 int __read_mostly suppress_printk;
97 static struct lockdep_map console_lock_dep_map = {
98 .name = "console_lock"
102 enum devkmsg_log_bits {
103 __DEVKMSG_LOG_BIT_ON = 0,
104 __DEVKMSG_LOG_BIT_OFF,
105 __DEVKMSG_LOG_BIT_LOCK,
108 enum devkmsg_log_masks {
109 DEVKMSG_LOG_MASK_ON = BIT(__DEVKMSG_LOG_BIT_ON),
110 DEVKMSG_LOG_MASK_OFF = BIT(__DEVKMSG_LOG_BIT_OFF),
111 DEVKMSG_LOG_MASK_LOCK = BIT(__DEVKMSG_LOG_BIT_LOCK),
114 /* Keep both the 'on' and 'off' bits clear, i.e. ratelimit by default: */
115 #define DEVKMSG_LOG_MASK_DEFAULT 0
117 static unsigned int __read_mostly devkmsg_log = DEVKMSG_LOG_MASK_DEFAULT;
119 static int __control_devkmsg(char *str)
126 len = str_has_prefix(str, "on");
128 devkmsg_log = DEVKMSG_LOG_MASK_ON;
132 len = str_has_prefix(str, "off");
134 devkmsg_log = DEVKMSG_LOG_MASK_OFF;
138 len = str_has_prefix(str, "ratelimit");
140 devkmsg_log = DEVKMSG_LOG_MASK_DEFAULT;
147 static int __init control_devkmsg(char *str)
149 if (__control_devkmsg(str) < 0)
153 * Set sysctl string accordingly:
155 if (devkmsg_log == DEVKMSG_LOG_MASK_ON)
156 strcpy(devkmsg_log_str, "on");
157 else if (devkmsg_log == DEVKMSG_LOG_MASK_OFF)
158 strcpy(devkmsg_log_str, "off");
159 /* else "ratelimit" which is set by default. */
162 * Sysctl cannot change it anymore. The kernel command line setting of
163 * this parameter is to force the setting to be permanent throughout the
164 * runtime of the system. This is a precation measure against userspace
165 * trying to be a smarta** and attempting to change it up on us.
167 devkmsg_log |= DEVKMSG_LOG_MASK_LOCK;
171 __setup("printk.devkmsg=", control_devkmsg);
173 char devkmsg_log_str[DEVKMSG_STR_MAX_SIZE] = "ratelimit";
175 int devkmsg_sysctl_set_loglvl(struct ctl_table *table, int write,
176 void *buffer, size_t *lenp, loff_t *ppos)
178 char old_str[DEVKMSG_STR_MAX_SIZE];
183 if (devkmsg_log & DEVKMSG_LOG_MASK_LOCK)
187 strncpy(old_str, devkmsg_log_str, DEVKMSG_STR_MAX_SIZE);
190 err = proc_dostring(table, write, buffer, lenp, ppos);
195 err = __control_devkmsg(devkmsg_log_str);
198 * Do not accept an unknown string OR a known string with
201 if (err < 0 || (err + 1 != *lenp)) {
203 /* ... and restore old setting. */
205 strncpy(devkmsg_log_str, old_str, DEVKMSG_STR_MAX_SIZE);
214 /* Number of registered extended console drivers. */
215 static int nr_ext_console_drivers;
218 * Helper macros to handle lockdep when locking/unlocking console_sem. We use
219 * macros instead of functions so that _RET_IP_ contains useful information.
221 #define down_console_sem() do { \
223 mutex_acquire(&console_lock_dep_map, 0, 0, _RET_IP_);\
226 static int __down_trylock_console_sem(unsigned long ip)
232 * Here and in __up_console_sem() we need to be in safe mode,
233 * because spindump/WARN/etc from under console ->lock will
234 * deadlock in printk()->down_trylock_console_sem() otherwise.
236 printk_safe_enter_irqsave(flags);
237 lock_failed = down_trylock(&console_sem);
238 printk_safe_exit_irqrestore(flags);
242 mutex_acquire(&console_lock_dep_map, 0, 1, ip);
245 #define down_trylock_console_sem() __down_trylock_console_sem(_RET_IP_)
247 static void __up_console_sem(unsigned long ip)
251 mutex_release(&console_lock_dep_map, ip);
253 printk_safe_enter_irqsave(flags);
255 printk_safe_exit_irqrestore(flags);
257 #define up_console_sem() __up_console_sem(_RET_IP_)
260 * This is used for debugging the mess that is the VT code by
261 * keeping track if we have the console semaphore held. It's
262 * definitely not the perfect debug tool (we don't know if _WE_
263 * hold it and are racing, but it helps tracking those weird code
264 * paths in the console code where we end up in places I want
265 * locked without the console semaphore held).
267 static int console_locked, console_suspended;
270 * If exclusive_console is non-NULL then only this console is to be printed to.
272 static struct console *exclusive_console;
275 * Array of consoles built from command line options (console=)
278 #define MAX_CMDLINECONSOLES 8
280 static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
282 static int preferred_console = -1;
283 static bool has_preferred_console;
284 int console_set_on_cmdline;
285 EXPORT_SYMBOL(console_set_on_cmdline);
287 /* Flag: console code may call schedule() */
288 static int console_may_schedule;
290 enum con_msg_format_flags {
291 MSG_FORMAT_DEFAULT = 0,
292 MSG_FORMAT_SYSLOG = (1 << 0),
295 static int console_msg_format = MSG_FORMAT_DEFAULT;
298 * The printk log buffer consists of a sequenced collection of records, each
299 * containing variable length message text. Every record also contains its
300 * own meta-data (@info).
302 * Every record meta-data carries the timestamp in microseconds, as well as
303 * the standard userspace syslog level and syslog facility. The usual kernel
304 * messages use LOG_KERN; userspace-injected messages always carry a matching
305 * syslog facility, by default LOG_USER. The origin of every message can be
306 * reliably determined that way.
308 * The human readable log message of a record is available in @text, the
309 * length of the message text in @text_len. The stored message is not
312 * Optionally, a record can carry a dictionary of properties (key/value
313 * pairs), to provide userspace with a machine-readable message context.
315 * Examples for well-defined, commonly used property names are:
316 * DEVICE=b12:8 device identifier
320 * +sound:card0 subsystem:devname
321 * SUBSYSTEM=pci driver-core subsystem name
323 * Valid characters in property names are [a-zA-Z0-9.-_]. Property names
324 * and values are terminated by a '\0' character.
326 * Example of record values:
327 * record.text_buf = "it's a line" (unterminated)
328 * record.info.seq = 56
329 * record.info.ts_nsec = 36863
330 * record.info.text_len = 11
331 * record.info.facility = 0 (LOG_KERN)
332 * record.info.flags = 0
333 * record.info.level = 3 (LOG_ERR)
334 * record.info.caller_id = 299 (task 299)
335 * record.info.dev_info.subsystem = "pci" (terminated)
336 * record.info.dev_info.device = "+pci:0000:00:01.0" (terminated)
338 * The 'struct printk_info' buffer 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.
353 /* syslog_lock protects syslog_* variables and write access to clear_seq. */
354 static DEFINE_RAW_SPINLOCK(syslog_lock);
357 DECLARE_WAIT_QUEUE_HEAD(log_wait);
358 /* All 3 protected by @syslog_lock. */
359 /* the next printk record to read by syslog(READ) or /proc/kmsg */
360 static u64 syslog_seq;
361 static size_t syslog_partial;
362 static bool syslog_time;
364 /* All 3 protected by @console_sem. */
365 /* the next printk record to write to the console */
366 static u64 console_seq;
367 static u64 exclusive_console_stop_seq;
368 static unsigned long console_dropped;
371 seqcount_latch_t latch;
376 * The next printk record to read after the last 'clear' command. There are
377 * two copies (updated with seqcount_latch) so that reads can locklessly
378 * access a valid value. Writers are synchronized by @syslog_lock.
380 static struct latched_seq clear_seq = {
381 .latch = SEQCNT_LATCH_ZERO(clear_seq.latch),
386 #ifdef CONFIG_PRINTK_CALLER
387 #define PREFIX_MAX 48
389 #define PREFIX_MAX 32
392 /* the maximum size of a formatted record (i.e. with prefix added per line) */
393 #define CONSOLE_LOG_MAX 1024
395 /* the maximum size allowed to be reserved for a record */
396 #define LOG_LINE_MAX (CONSOLE_LOG_MAX - PREFIX_MAX)
398 #define LOG_LEVEL(v) ((v) & 0x07)
399 #define LOG_FACILITY(v) ((v) >> 3 & 0xff)
402 #define LOG_ALIGN __alignof__(unsigned long)
403 #define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
404 #define LOG_BUF_LEN_MAX (u32)(1 << 31)
405 static char __log_buf[__LOG_BUF_LEN] __aligned(LOG_ALIGN);
406 static char *log_buf = __log_buf;
407 static u32 log_buf_len = __LOG_BUF_LEN;
410 * Define the average message size. This only affects the number of
411 * descriptors that will be available. Underestimating is better than
412 * overestimating (too many available descriptors is better than not enough).
414 #define PRB_AVGBITS 5 /* 32 character average length */
416 #if CONFIG_LOG_BUF_SHIFT <= PRB_AVGBITS
417 #error CONFIG_LOG_BUF_SHIFT value too small.
419 _DEFINE_PRINTKRB(printk_rb_static, CONFIG_LOG_BUF_SHIFT - PRB_AVGBITS,
420 PRB_AVGBITS, &__log_buf[0]);
422 static struct printk_ringbuffer printk_rb_dynamic;
424 static struct printk_ringbuffer *prb = &printk_rb_static;
427 * We cannot access per-CPU data (e.g. per-CPU flush irq_work) before
428 * per_cpu_areas are initialised. This variable is set to true when
429 * it's safe to access per-CPU data.
431 static bool __printk_percpu_data_ready __read_mostly;
433 bool printk_percpu_data_ready(void)
435 return __printk_percpu_data_ready;
438 /* Must be called under syslog_lock. */
439 static void latched_seq_write(struct latched_seq *ls, u64 val)
441 raw_write_seqcount_latch(&ls->latch);
443 raw_write_seqcount_latch(&ls->latch);
447 /* Can be called from any context. */
448 static u64 latched_seq_read_nolock(struct latched_seq *ls)
455 seq = raw_read_seqcount_latch(&ls->latch);
458 } while (read_seqcount_latch_retry(&ls->latch, seq));
463 /* Return log buffer address */
464 char *log_buf_addr_get(void)
469 /* Return log buffer size */
470 u32 log_buf_len_get(void)
476 * Define how much of the log buffer we could take at maximum. The value
477 * must be greater than two. Note that only half of the buffer is available
478 * when the index points to the middle.
480 #define MAX_LOG_TAKE_PART 4
481 static const char trunc_msg[] = "<truncated>";
483 static void truncate_msg(u16 *text_len, u16 *trunc_msg_len)
486 * The message should not take the whole buffer. Otherwise, it might
487 * get removed too soon.
489 u32 max_text_len = log_buf_len / MAX_LOG_TAKE_PART;
491 if (*text_len > max_text_len)
492 *text_len = max_text_len;
494 /* enable the warning message (if there is room) */
495 *trunc_msg_len = strlen(trunc_msg);
496 if (*text_len >= *trunc_msg_len)
497 *text_len -= *trunc_msg_len;
502 int dmesg_restrict = IS_ENABLED(CONFIG_SECURITY_DMESG_RESTRICT);
504 static int syslog_action_restricted(int type)
509 * Unless restricted, we allow "read all" and "get buffer size"
512 return type != SYSLOG_ACTION_READ_ALL &&
513 type != SYSLOG_ACTION_SIZE_BUFFER;
516 static int check_syslog_permissions(int type, int source)
519 * If this is from /proc/kmsg and we've already opened it, then we've
520 * already done the capabilities checks at open time.
522 if (source == SYSLOG_FROM_PROC && type != SYSLOG_ACTION_OPEN)
525 if (syslog_action_restricted(type)) {
526 if (capable(CAP_SYSLOG))
529 * For historical reasons, accept CAP_SYS_ADMIN too, with
532 if (capable(CAP_SYS_ADMIN)) {
533 pr_warn_once("%s (%d): Attempt to access syslog with "
534 "CAP_SYS_ADMIN but no CAP_SYSLOG "
536 current->comm, task_pid_nr(current));
542 return security_syslog(type);
545 static void append_char(char **pp, char *e, char c)
551 static ssize_t info_print_ext_header(char *buf, size_t size,
552 struct printk_info *info)
554 u64 ts_usec = info->ts_nsec;
556 #ifdef CONFIG_PRINTK_CALLER
557 u32 id = info->caller_id;
559 snprintf(caller, sizeof(caller), ",caller=%c%u",
560 id & 0x80000000 ? 'C' : 'T', id & ~0x80000000);
565 do_div(ts_usec, 1000);
567 return scnprintf(buf, size, "%u,%llu,%llu,%c%s;",
568 (info->facility << 3) | info->level, info->seq,
569 ts_usec, info->flags & LOG_CONT ? 'c' : '-', caller);
572 static ssize_t msg_add_ext_text(char *buf, size_t size,
573 const char *text, size_t text_len,
576 char *p = buf, *e = buf + size;
579 /* escape non-printable characters */
580 for (i = 0; i < text_len; i++) {
581 unsigned char c = text[i];
583 if (c < ' ' || c >= 127 || c == '\\')
584 p += scnprintf(p, e - p, "\\x%02x", c);
586 append_char(&p, e, c);
588 append_char(&p, e, endc);
593 static ssize_t msg_add_dict_text(char *buf, size_t size,
594 const char *key, const char *val)
596 size_t val_len = strlen(val);
602 len = msg_add_ext_text(buf, size, "", 0, ' '); /* dict prefix */
603 len += msg_add_ext_text(buf + len, size - len, key, strlen(key), '=');
604 len += msg_add_ext_text(buf + len, size - len, val, val_len, '\n');
609 static ssize_t msg_print_ext_body(char *buf, size_t size,
610 char *text, size_t text_len,
611 struct dev_printk_info *dev_info)
615 len = msg_add_ext_text(buf, size, text, text_len, '\n');
620 len += msg_add_dict_text(buf + len, size - len, "SUBSYSTEM",
621 dev_info->subsystem);
622 len += msg_add_dict_text(buf + len, size - len, "DEVICE",
628 /* /dev/kmsg - userspace message inject/listen interface */
629 struct devkmsg_user {
631 struct ratelimit_state rs;
633 char buf[CONSOLE_EXT_LOG_MAX];
635 struct printk_info info;
636 char text_buf[CONSOLE_EXT_LOG_MAX];
637 struct printk_record record;
640 static __printf(3, 4) __cold
641 int devkmsg_emit(int facility, int level, const char *fmt, ...)
647 r = vprintk_emit(facility, level, NULL, fmt, args);
653 static ssize_t devkmsg_write(struct kiocb *iocb, struct iov_iter *from)
656 int level = default_message_loglevel;
657 int facility = 1; /* LOG_USER */
658 struct file *file = iocb->ki_filp;
659 struct devkmsg_user *user = file->private_data;
660 size_t len = iov_iter_count(from);
663 if (!user || len > LOG_LINE_MAX)
666 /* Ignore when user logging is disabled. */
667 if (devkmsg_log & DEVKMSG_LOG_MASK_OFF)
670 /* Ratelimit when not explicitly enabled. */
671 if (!(devkmsg_log & DEVKMSG_LOG_MASK_ON)) {
672 if (!___ratelimit(&user->rs, current->comm))
676 buf = kmalloc(len+1, GFP_KERNEL);
681 if (!copy_from_iter_full(buf, len, from)) {
687 * Extract and skip the syslog prefix <[0-9]*>. Coming from userspace
688 * the decimal value represents 32bit, the lower 3 bit are the log
689 * level, the rest are the log facility.
691 * If no prefix or no userspace facility is specified, we
692 * enforce LOG_USER, to be able to reliably distinguish
693 * kernel-generated messages from userspace-injected ones.
696 if (line[0] == '<') {
700 u = simple_strtoul(line + 1, &endp, 10);
701 if (endp && endp[0] == '>') {
702 level = LOG_LEVEL(u);
703 if (LOG_FACILITY(u) != 0)
704 facility = LOG_FACILITY(u);
710 devkmsg_emit(facility, level, "%s", line);
715 static ssize_t devkmsg_read(struct file *file, char __user *buf,
716 size_t count, loff_t *ppos)
718 struct devkmsg_user *user = file->private_data;
719 struct printk_record *r = &user->record;
726 ret = mutex_lock_interruptible(&user->lock);
730 printk_safe_enter_irq();
731 if (!prb_read_valid(prb, atomic64_read(&user->seq), r)) {
732 if (file->f_flags & O_NONBLOCK) {
734 printk_safe_exit_irq();
738 printk_safe_exit_irq();
739 ret = wait_event_interruptible(log_wait,
740 prb_read_valid(prb, atomic64_read(&user->seq), r));
743 printk_safe_enter_irq();
746 if (r->info->seq != atomic64_read(&user->seq)) {
747 /* our last seen message is gone, return error and reset */
748 atomic64_set(&user->seq, r->info->seq);
750 printk_safe_exit_irq();
754 len = info_print_ext_header(user->buf, sizeof(user->buf), r->info);
755 len += msg_print_ext_body(user->buf + len, sizeof(user->buf) - len,
756 &r->text_buf[0], r->info->text_len,
759 atomic64_set(&user->seq, r->info->seq + 1);
760 printk_safe_exit_irq();
767 if (copy_to_user(buf, user->buf, len)) {
773 mutex_unlock(&user->lock);
778 * Be careful when modifying this function!!!
780 * Only few operations are supported because the device works only with the
781 * entire variable length messages (records). Non-standard values are
782 * returned in the other cases and has been this way for quite some time.
783 * User space applications might depend on this behavior.
785 static loff_t devkmsg_llseek(struct file *file, loff_t offset, int whence)
787 struct devkmsg_user *user = file->private_data;
795 printk_safe_enter_irq();
798 /* the first record */
799 atomic64_set(&user->seq, prb_first_valid_seq(prb));
803 * The first record after the last SYSLOG_ACTION_CLEAR,
804 * like issued by 'dmesg -c'. Reading /dev/kmsg itself
805 * changes no global state, and does not clear anything.
807 atomic64_set(&user->seq, latched_seq_read_nolock(&clear_seq));
810 /* after the last record */
811 atomic64_set(&user->seq, prb_next_seq(prb));
816 printk_safe_exit_irq();
820 static __poll_t devkmsg_poll(struct file *file, poll_table *wait)
822 struct devkmsg_user *user = file->private_data;
823 struct printk_info info;
827 return EPOLLERR|EPOLLNVAL;
829 poll_wait(file, &log_wait, wait);
831 printk_safe_enter_irq();
832 if (prb_read_valid_info(prb, atomic64_read(&user->seq), &info, NULL)) {
833 /* return error when data has vanished underneath us */
834 if (info.seq != atomic64_read(&user->seq))
835 ret = EPOLLIN|EPOLLRDNORM|EPOLLERR|EPOLLPRI;
837 ret = EPOLLIN|EPOLLRDNORM;
839 printk_safe_exit_irq();
844 static int devkmsg_open(struct inode *inode, struct file *file)
846 struct devkmsg_user *user;
849 if (devkmsg_log & DEVKMSG_LOG_MASK_OFF)
852 /* write-only does not need any file context */
853 if ((file->f_flags & O_ACCMODE) != O_WRONLY) {
854 err = check_syslog_permissions(SYSLOG_ACTION_READ_ALL,
860 user = kmalloc(sizeof(struct devkmsg_user), GFP_KERNEL);
864 ratelimit_default_init(&user->rs);
865 ratelimit_set_flags(&user->rs, RATELIMIT_MSG_ON_RELEASE);
867 mutex_init(&user->lock);
869 prb_rec_init_rd(&user->record, &user->info,
870 &user->text_buf[0], sizeof(user->text_buf));
872 printk_safe_enter_irq();
873 atomic64_set(&user->seq, prb_first_valid_seq(prb));
874 printk_safe_exit_irq();
876 file->private_data = user;
880 static int devkmsg_release(struct inode *inode, struct file *file)
882 struct devkmsg_user *user = file->private_data;
887 ratelimit_state_exit(&user->rs);
889 mutex_destroy(&user->lock);
894 const struct file_operations kmsg_fops = {
895 .open = devkmsg_open,
896 .read = devkmsg_read,
897 .write_iter = devkmsg_write,
898 .llseek = devkmsg_llseek,
899 .poll = devkmsg_poll,
900 .release = devkmsg_release,
903 #ifdef CONFIG_CRASH_CORE
905 * This appends the listed symbols to /proc/vmcore
907 * /proc/vmcore is used by various utilities, like crash and makedumpfile to
908 * obtain access to symbols that are otherwise very difficult to locate. These
909 * symbols are specifically used so that utilities can access and extract the
910 * dmesg log from a vmcore file after a crash.
912 void log_buf_vmcoreinfo_setup(void)
914 struct dev_printk_info *dev_info = NULL;
916 VMCOREINFO_SYMBOL(prb);
917 VMCOREINFO_SYMBOL(printk_rb_static);
918 VMCOREINFO_SYMBOL(clear_seq);
921 * Export struct size and field offsets. User space tools can
922 * parse it and detect any changes to structure down the line.
925 VMCOREINFO_STRUCT_SIZE(printk_ringbuffer);
926 VMCOREINFO_OFFSET(printk_ringbuffer, desc_ring);
927 VMCOREINFO_OFFSET(printk_ringbuffer, text_data_ring);
928 VMCOREINFO_OFFSET(printk_ringbuffer, fail);
930 VMCOREINFO_STRUCT_SIZE(prb_desc_ring);
931 VMCOREINFO_OFFSET(prb_desc_ring, count_bits);
932 VMCOREINFO_OFFSET(prb_desc_ring, descs);
933 VMCOREINFO_OFFSET(prb_desc_ring, infos);
934 VMCOREINFO_OFFSET(prb_desc_ring, head_id);
935 VMCOREINFO_OFFSET(prb_desc_ring, tail_id);
937 VMCOREINFO_STRUCT_SIZE(prb_desc);
938 VMCOREINFO_OFFSET(prb_desc, state_var);
939 VMCOREINFO_OFFSET(prb_desc, text_blk_lpos);
941 VMCOREINFO_STRUCT_SIZE(prb_data_blk_lpos);
942 VMCOREINFO_OFFSET(prb_data_blk_lpos, begin);
943 VMCOREINFO_OFFSET(prb_data_blk_lpos, next);
945 VMCOREINFO_STRUCT_SIZE(printk_info);
946 VMCOREINFO_OFFSET(printk_info, seq);
947 VMCOREINFO_OFFSET(printk_info, ts_nsec);
948 VMCOREINFO_OFFSET(printk_info, text_len);
949 VMCOREINFO_OFFSET(printk_info, caller_id);
950 VMCOREINFO_OFFSET(printk_info, dev_info);
952 VMCOREINFO_STRUCT_SIZE(dev_printk_info);
953 VMCOREINFO_OFFSET(dev_printk_info, subsystem);
954 VMCOREINFO_LENGTH(printk_info_subsystem, sizeof(dev_info->subsystem));
955 VMCOREINFO_OFFSET(dev_printk_info, device);
956 VMCOREINFO_LENGTH(printk_info_device, sizeof(dev_info->device));
958 VMCOREINFO_STRUCT_SIZE(prb_data_ring);
959 VMCOREINFO_OFFSET(prb_data_ring, size_bits);
960 VMCOREINFO_OFFSET(prb_data_ring, data);
961 VMCOREINFO_OFFSET(prb_data_ring, head_lpos);
962 VMCOREINFO_OFFSET(prb_data_ring, tail_lpos);
964 VMCOREINFO_SIZE(atomic_long_t);
965 VMCOREINFO_TYPE_OFFSET(atomic_long_t, counter);
967 VMCOREINFO_STRUCT_SIZE(latched_seq);
968 VMCOREINFO_OFFSET(latched_seq, val);
972 /* requested log_buf_len from kernel cmdline */
973 static unsigned long __initdata new_log_buf_len;
975 /* we practice scaling the ring buffer by powers of 2 */
976 static void __init log_buf_len_update(u64 size)
978 if (size > (u64)LOG_BUF_LEN_MAX) {
979 size = (u64)LOG_BUF_LEN_MAX;
980 pr_err("log_buf over 2G is not supported.\n");
984 size = roundup_pow_of_two(size);
985 if (size > log_buf_len)
986 new_log_buf_len = (unsigned long)size;
989 /* save requested log_buf_len since it's too early to process it */
990 static int __init log_buf_len_setup(char *str)
997 size = memparse(str, &str);
999 log_buf_len_update(size);
1003 early_param("log_buf_len", log_buf_len_setup);
1006 #define __LOG_CPU_MAX_BUF_LEN (1 << CONFIG_LOG_CPU_MAX_BUF_SHIFT)
1008 static void __init log_buf_add_cpu(void)
1010 unsigned int cpu_extra;
1013 * archs should set up cpu_possible_bits properly with
1014 * set_cpu_possible() after setup_arch() but just in
1015 * case lets ensure this is valid.
1017 if (num_possible_cpus() == 1)
1020 cpu_extra = (num_possible_cpus() - 1) * __LOG_CPU_MAX_BUF_LEN;
1022 /* by default this will only continue through for large > 64 CPUs */
1023 if (cpu_extra <= __LOG_BUF_LEN / 2)
1026 pr_info("log_buf_len individual max cpu contribution: %d bytes\n",
1027 __LOG_CPU_MAX_BUF_LEN);
1028 pr_info("log_buf_len total cpu_extra contributions: %d bytes\n",
1030 pr_info("log_buf_len min size: %d bytes\n", __LOG_BUF_LEN);
1032 log_buf_len_update(cpu_extra + __LOG_BUF_LEN);
1034 #else /* !CONFIG_SMP */
1035 static inline void log_buf_add_cpu(void) {}
1036 #endif /* CONFIG_SMP */
1038 static void __init set_percpu_data_ready(void)
1041 /* Make sure we set this flag only after printk_safe() init is done */
1043 __printk_percpu_data_ready = true;
1046 static unsigned int __init add_to_rb(struct printk_ringbuffer *rb,
1047 struct printk_record *r)
1049 struct prb_reserved_entry e;
1050 struct printk_record dest_r;
1052 prb_rec_init_wr(&dest_r, r->info->text_len);
1054 if (!prb_reserve(&e, rb, &dest_r))
1057 memcpy(&dest_r.text_buf[0], &r->text_buf[0], r->info->text_len);
1058 dest_r.info->text_len = r->info->text_len;
1059 dest_r.info->facility = r->info->facility;
1060 dest_r.info->level = r->info->level;
1061 dest_r.info->flags = r->info->flags;
1062 dest_r.info->ts_nsec = r->info->ts_nsec;
1063 dest_r.info->caller_id = r->info->caller_id;
1064 memcpy(&dest_r.info->dev_info, &r->info->dev_info, sizeof(dest_r.info->dev_info));
1066 prb_final_commit(&e);
1068 return prb_record_text_space(&e);
1071 static char setup_text_buf[LOG_LINE_MAX] __initdata;
1073 void __init setup_log_buf(int early)
1075 struct printk_info *new_infos;
1076 unsigned int new_descs_count;
1077 struct prb_desc *new_descs;
1078 struct printk_info info;
1079 struct printk_record r;
1080 size_t new_descs_size;
1081 size_t new_infos_size;
1082 unsigned long flags;
1088 * Some archs call setup_log_buf() multiple times - first is very
1089 * early, e.g. from setup_arch(), and second - when percpu_areas
1093 set_percpu_data_ready();
1095 if (log_buf != __log_buf)
1098 if (!early && !new_log_buf_len)
1101 if (!new_log_buf_len)
1104 new_descs_count = new_log_buf_len >> PRB_AVGBITS;
1105 if (new_descs_count == 0) {
1106 pr_err("new_log_buf_len: %lu too small\n", new_log_buf_len);
1110 new_log_buf = memblock_alloc(new_log_buf_len, LOG_ALIGN);
1111 if (unlikely(!new_log_buf)) {
1112 pr_err("log_buf_len: %lu text bytes not available\n",
1117 new_descs_size = new_descs_count * sizeof(struct prb_desc);
1118 new_descs = memblock_alloc(new_descs_size, LOG_ALIGN);
1119 if (unlikely(!new_descs)) {
1120 pr_err("log_buf_len: %zu desc bytes not available\n",
1122 goto err_free_log_buf;
1125 new_infos_size = new_descs_count * sizeof(struct printk_info);
1126 new_infos = memblock_alloc(new_infos_size, LOG_ALIGN);
1127 if (unlikely(!new_infos)) {
1128 pr_err("log_buf_len: %zu info bytes not available\n",
1130 goto err_free_descs;
1133 prb_rec_init_rd(&r, &info, &setup_text_buf[0], sizeof(setup_text_buf));
1135 prb_init(&printk_rb_dynamic,
1136 new_log_buf, ilog2(new_log_buf_len),
1137 new_descs, ilog2(new_descs_count),
1140 printk_safe_enter_irqsave(flags);
1142 log_buf_len = new_log_buf_len;
1143 log_buf = new_log_buf;
1144 new_log_buf_len = 0;
1146 free = __LOG_BUF_LEN;
1147 prb_for_each_record(0, &printk_rb_static, seq, &r)
1148 free -= add_to_rb(&printk_rb_dynamic, &r);
1151 * This is early enough that everything is still running on the
1152 * boot CPU and interrupts are disabled. So no new messages will
1153 * appear during the transition to the dynamic buffer.
1155 prb = &printk_rb_dynamic;
1157 printk_safe_exit_irqrestore(flags);
1159 if (seq != prb_next_seq(&printk_rb_static)) {
1160 pr_err("dropped %llu messages\n",
1161 prb_next_seq(&printk_rb_static) - seq);
1164 pr_info("log_buf_len: %u bytes\n", log_buf_len);
1165 pr_info("early log buf free: %u(%u%%)\n",
1166 free, (free * 100) / __LOG_BUF_LEN);
1170 memblock_free(__pa(new_descs), new_descs_size);
1172 memblock_free(__pa(new_log_buf), new_log_buf_len);
1175 static bool __read_mostly ignore_loglevel;
1177 static int __init ignore_loglevel_setup(char *str)
1179 ignore_loglevel = true;
1180 pr_info("debug: ignoring loglevel setting.\n");
1185 early_param("ignore_loglevel", ignore_loglevel_setup);
1186 module_param(ignore_loglevel, bool, S_IRUGO | S_IWUSR);
1187 MODULE_PARM_DESC(ignore_loglevel,
1188 "ignore loglevel setting (prints all kernel messages to the console)");
1190 static bool suppress_message_printing(int level)
1192 return (level >= console_loglevel && !ignore_loglevel);
1195 #ifdef CONFIG_BOOT_PRINTK_DELAY
1197 static int boot_delay; /* msecs delay after each printk during bootup */
1198 static unsigned long long loops_per_msec; /* based on boot_delay */
1200 static int __init boot_delay_setup(char *str)
1204 lpj = preset_lpj ? preset_lpj : 1000000; /* some guess */
1205 loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
1207 get_option(&str, &boot_delay);
1208 if (boot_delay > 10 * 1000)
1211 pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
1212 "HZ: %d, loops_per_msec: %llu\n",
1213 boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
1216 early_param("boot_delay", boot_delay_setup);
1218 static void boot_delay_msec(int level)
1220 unsigned long long k;
1221 unsigned long timeout;
1223 if ((boot_delay == 0 || system_state >= SYSTEM_RUNNING)
1224 || suppress_message_printing(level)) {
1228 k = (unsigned long long)loops_per_msec * boot_delay;
1230 timeout = jiffies + msecs_to_jiffies(boot_delay);
1235 * use (volatile) jiffies to prevent
1236 * compiler reduction; loop termination via jiffies
1237 * is secondary and may or may not happen.
1239 if (time_after(jiffies, timeout))
1241 touch_nmi_watchdog();
1245 static inline void boot_delay_msec(int level)
1250 static bool printk_time = IS_ENABLED(CONFIG_PRINTK_TIME);
1251 module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
1253 static size_t print_syslog(unsigned int level, char *buf)
1255 return sprintf(buf, "<%u>", level);
1258 static size_t print_time(u64 ts, char *buf)
1260 unsigned long rem_nsec = do_div(ts, 1000000000);
1262 return sprintf(buf, "[%5lu.%06lu]",
1263 (unsigned long)ts, rem_nsec / 1000);
1266 #ifdef CONFIG_PRINTK_CALLER
1267 static size_t print_caller(u32 id, char *buf)
1271 snprintf(caller, sizeof(caller), "%c%u",
1272 id & 0x80000000 ? 'C' : 'T', id & ~0x80000000);
1273 return sprintf(buf, "[%6s]", caller);
1276 #define print_caller(id, buf) 0
1279 static size_t info_print_prefix(const struct printk_info *info, bool syslog,
1280 bool time, char *buf)
1285 len = print_syslog((info->facility << 3) | info->level, buf);
1288 len += print_time(info->ts_nsec, buf + len);
1290 len += print_caller(info->caller_id, buf + len);
1292 if (IS_ENABLED(CONFIG_PRINTK_CALLER) || time) {
1301 * Prepare the record for printing. The text is shifted within the given
1302 * buffer to avoid a need for another one. The following operations are
1305 * - Add prefix for each line.
1306 * - Drop truncated lines that no longer fit into the buffer.
1307 * - Add the trailing newline that has been removed in vprintk_store().
1308 * - Add a string terminator.
1310 * Since the produced string is always terminated, the maximum possible
1311 * return value is @r->text_buf_size - 1;
1313 * Return: The length of the updated/prepared text, including the added
1314 * prefixes and the newline. The terminator is not counted. The dropped
1315 * line(s) are not counted.
1317 static size_t record_print_text(struct printk_record *r, bool syslog,
1320 size_t text_len = r->info->text_len;
1321 size_t buf_size = r->text_buf_size;
1322 char *text = r->text_buf;
1323 char prefix[PREFIX_MAX];
1324 bool truncated = false;
1331 * If the message was truncated because the buffer was not large
1332 * enough, treat the available text as if it were the full text.
1334 if (text_len > buf_size)
1335 text_len = buf_size;
1337 prefix_len = info_print_prefix(r->info, syslog, time, prefix);
1340 * @text_len: bytes of unprocessed text
1341 * @line_len: bytes of current line _without_ newline
1342 * @text: pointer to beginning of current line
1343 * @len: number of bytes prepared in r->text_buf
1346 next = memchr(text, '\n', text_len);
1348 line_len = next - text;
1350 /* Drop truncated line(s). */
1353 line_len = text_len;
1357 * Truncate the text if there is not enough space to add the
1358 * prefix and a trailing newline and a terminator.
1360 if (len + prefix_len + text_len + 1 + 1 > buf_size) {
1361 /* Drop even the current line if no space. */
1362 if (len + prefix_len + line_len + 1 + 1 > buf_size)
1365 text_len = buf_size - len - prefix_len - 1 - 1;
1369 memmove(text + prefix_len, text, text_len);
1370 memcpy(text, prefix, prefix_len);
1373 * Increment the prepared length to include the text and
1374 * prefix that were just moved+copied. Also increment for the
1375 * newline at the end of this line. If this is the last line,
1376 * there is no newline, but it will be added immediately below.
1378 len += prefix_len + line_len + 1;
1379 if (text_len == line_len) {
1381 * This is the last line. Add the trailing newline
1382 * removed in vprintk_store().
1384 text[prefix_len + line_len] = '\n';
1389 * Advance beyond the added prefix and the related line with
1392 text += prefix_len + line_len + 1;
1395 * The remaining text has only decreased by the line with its
1398 * Note that @text_len can become zero. It happens when @text
1399 * ended with a newline (either due to truncation or the
1400 * original string ending with "\n\n"). The loop is correctly
1401 * repeated and (if not truncated) an empty line with a prefix
1404 text_len -= line_len + 1;
1408 * If a buffer was provided, it will be terminated. Space for the
1409 * string terminator is guaranteed to be available. The terminator is
1410 * not counted in the return value.
1413 r->text_buf[len] = 0;
1418 static size_t get_record_print_text_size(struct printk_info *info,
1419 unsigned int line_count,
1420 bool syslog, bool time)
1422 char prefix[PREFIX_MAX];
1425 prefix_len = info_print_prefix(info, syslog, time, prefix);
1428 * Each line will be preceded with a prefix. The intermediate
1429 * newlines are already within the text, but a final trailing
1430 * newline will be added.
1432 return ((prefix_len * line_count) + info->text_len + 1);
1436 * Beginning with @start_seq, find the first record where it and all following
1437 * records up to (but not including) @max_seq fit into @size.
1439 * @max_seq is simply an upper bound and does not need to exist. If the caller
1440 * does not require an upper bound, -1 can be used for @max_seq.
1442 static u64 find_first_fitting_seq(u64 start_seq, u64 max_seq, size_t size,
1443 bool syslog, bool time)
1445 struct printk_info info;
1446 unsigned int line_count;
1450 /* Determine the size of the records up to @max_seq. */
1451 prb_for_each_info(start_seq, prb, seq, &info, &line_count) {
1452 if (info.seq >= max_seq)
1454 len += get_record_print_text_size(&info, line_count, syslog, time);
1458 * Adjust the upper bound for the next loop to avoid subtracting
1459 * lengths that were never added.
1465 * Move first record forward until length fits into the buffer. Ignore
1466 * newest messages that were not counted in the above cycle. Messages
1467 * might appear and get lost in the meantime. This is a best effort
1468 * that prevents an infinite loop that could occur with a retry.
1470 prb_for_each_info(start_seq, prb, seq, &info, &line_count) {
1471 if (len <= size || info.seq >= max_seq)
1473 len -= get_record_print_text_size(&info, line_count, syslog, time);
1479 static int syslog_print(char __user *buf, int size)
1481 struct printk_info info;
1482 struct printk_record r;
1486 text = kmalloc(CONSOLE_LOG_MAX, GFP_KERNEL);
1490 prb_rec_init_rd(&r, &info, text, CONSOLE_LOG_MAX);
1496 printk_safe_enter_irq();
1497 raw_spin_lock(&syslog_lock);
1498 if (!prb_read_valid(prb, syslog_seq, &r)) {
1499 raw_spin_unlock(&syslog_lock);
1500 printk_safe_exit_irq();
1503 if (r.info->seq != syslog_seq) {
1504 /* message is gone, move to next valid one */
1505 syslog_seq = r.info->seq;
1510 * To keep reading/counting partial line consistent,
1511 * use printk_time value as of the beginning of a line.
1513 if (!syslog_partial)
1514 syslog_time = printk_time;
1516 skip = syslog_partial;
1517 n = record_print_text(&r, true, syslog_time);
1518 if (n - syslog_partial <= size) {
1519 /* message fits into buffer, move forward */
1520 syslog_seq = r.info->seq + 1;
1521 n -= syslog_partial;
1524 /* partial read(), remember position */
1526 syslog_partial += n;
1529 raw_spin_unlock(&syslog_lock);
1530 printk_safe_exit_irq();
1535 if (copy_to_user(buf, text + skip, n)) {
1550 static int syslog_print_all(char __user *buf, int size, bool clear)
1552 struct printk_info info;
1553 struct printk_record r;
1559 text = kmalloc(CONSOLE_LOG_MAX, GFP_KERNEL);
1564 printk_safe_enter_irq();
1566 * Find first record that fits, including all following records,
1567 * into the user-provided buffer for this dump.
1569 seq = find_first_fitting_seq(latched_seq_read_nolock(&clear_seq), -1,
1572 prb_rec_init_rd(&r, &info, text, CONSOLE_LOG_MAX);
1575 prb_for_each_record(seq, prb, seq, &r) {
1578 textlen = record_print_text(&r, true, time);
1580 if (len + textlen > size) {
1585 printk_safe_exit_irq();
1586 if (copy_to_user(buf + len, text, textlen))
1590 printk_safe_enter_irq();
1597 raw_spin_lock(&syslog_lock);
1598 latched_seq_write(&clear_seq, seq);
1599 raw_spin_unlock(&syslog_lock);
1601 printk_safe_exit_irq();
1607 static void syslog_clear(void)
1609 printk_safe_enter_irq();
1610 raw_spin_lock(&syslog_lock);
1611 latched_seq_write(&clear_seq, prb_next_seq(prb));
1612 raw_spin_unlock(&syslog_lock);
1613 printk_safe_exit_irq();
1616 /* Return a consistent copy of @syslog_seq. */
1617 static u64 read_syslog_seq_irq(void)
1621 raw_spin_lock_irq(&syslog_lock);
1623 raw_spin_unlock_irq(&syslog_lock);
1628 int do_syslog(int type, char __user *buf, int len, int source)
1630 struct printk_info info;
1632 static int saved_console_loglevel = LOGLEVEL_DEFAULT;
1635 error = check_syslog_permissions(type, source);
1640 case SYSLOG_ACTION_CLOSE: /* Close log */
1642 case SYSLOG_ACTION_OPEN: /* Open log */
1644 case SYSLOG_ACTION_READ: /* Read from log */
1645 if (!buf || len < 0)
1649 if (!access_ok(buf, len))
1652 error = wait_event_interruptible(log_wait,
1653 prb_read_valid(prb, read_syslog_seq_irq(), NULL));
1656 error = syslog_print(buf, len);
1658 /* Read/clear last kernel messages */
1659 case SYSLOG_ACTION_READ_CLEAR:
1662 /* Read last kernel messages */
1663 case SYSLOG_ACTION_READ_ALL:
1664 if (!buf || len < 0)
1668 if (!access_ok(buf, len))
1670 error = syslog_print_all(buf, len, clear);
1672 /* Clear ring buffer */
1673 case SYSLOG_ACTION_CLEAR:
1676 /* Disable logging to console */
1677 case SYSLOG_ACTION_CONSOLE_OFF:
1678 if (saved_console_loglevel == LOGLEVEL_DEFAULT)
1679 saved_console_loglevel = console_loglevel;
1680 console_loglevel = minimum_console_loglevel;
1682 /* Enable logging to console */
1683 case SYSLOG_ACTION_CONSOLE_ON:
1684 if (saved_console_loglevel != LOGLEVEL_DEFAULT) {
1685 console_loglevel = saved_console_loglevel;
1686 saved_console_loglevel = LOGLEVEL_DEFAULT;
1689 /* Set level of messages printed to console */
1690 case SYSLOG_ACTION_CONSOLE_LEVEL:
1691 if (len < 1 || len > 8)
1693 if (len < minimum_console_loglevel)
1694 len = minimum_console_loglevel;
1695 console_loglevel = len;
1696 /* Implicitly re-enable logging to console */
1697 saved_console_loglevel = LOGLEVEL_DEFAULT;
1699 /* Number of chars in the log buffer */
1700 case SYSLOG_ACTION_SIZE_UNREAD:
1701 printk_safe_enter_irq();
1702 raw_spin_lock(&syslog_lock);
1703 if (!prb_read_valid_info(prb, syslog_seq, &info, NULL)) {
1704 /* No unread messages. */
1705 raw_spin_unlock(&syslog_lock);
1706 printk_safe_exit_irq();
1709 if (info.seq != syslog_seq) {
1710 /* messages are gone, move to first one */
1711 syslog_seq = info.seq;
1714 if (source == SYSLOG_FROM_PROC) {
1716 * Short-cut for poll(/"proc/kmsg") which simply checks
1717 * for pending data, not the size; return the count of
1718 * records, not the length.
1720 error = prb_next_seq(prb) - syslog_seq;
1722 bool time = syslog_partial ? syslog_time : printk_time;
1723 unsigned int line_count;
1726 prb_for_each_info(syslog_seq, prb, seq, &info,
1728 error += get_record_print_text_size(&info, line_count,
1732 error -= syslog_partial;
1734 raw_spin_unlock(&syslog_lock);
1735 printk_safe_exit_irq();
1737 /* Size of the log buffer */
1738 case SYSLOG_ACTION_SIZE_BUFFER:
1739 error = log_buf_len;
1749 SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
1751 return do_syslog(type, buf, len, SYSLOG_FROM_READER);
1755 * Special console_lock variants that help to reduce the risk of soft-lockups.
1756 * They allow to pass console_lock to another printk() call using a busy wait.
1759 #ifdef CONFIG_LOCKDEP
1760 static struct lockdep_map console_owner_dep_map = {
1761 .name = "console_owner"
1765 static DEFINE_RAW_SPINLOCK(console_owner_lock);
1766 static struct task_struct *console_owner;
1767 static bool console_waiter;
1770 * console_lock_spinning_enable - mark beginning of code where another
1771 * thread might safely busy wait
1773 * This basically converts console_lock into a spinlock. This marks
1774 * the section where the console_lock owner can not sleep, because
1775 * there may be a waiter spinning (like a spinlock). Also it must be
1776 * ready to hand over the lock at the end of the section.
1778 static void console_lock_spinning_enable(void)
1780 raw_spin_lock(&console_owner_lock);
1781 console_owner = current;
1782 raw_spin_unlock(&console_owner_lock);
1784 /* The waiter may spin on us after setting console_owner */
1785 spin_acquire(&console_owner_dep_map, 0, 0, _THIS_IP_);
1789 * console_lock_spinning_disable_and_check - mark end of code where another
1790 * thread was able to busy wait and check if there is a waiter
1792 * This is called at the end of the section where spinning is allowed.
1793 * It has two functions. First, it is a signal that it is no longer
1794 * safe to start busy waiting for the lock. Second, it checks if
1795 * there is a busy waiter and passes the lock rights to her.
1797 * Important: Callers lose the lock if there was a busy waiter.
1798 * They must not touch items synchronized by console_lock
1801 * Return: 1 if the lock rights were passed, 0 otherwise.
1803 static int console_lock_spinning_disable_and_check(void)
1807 raw_spin_lock(&console_owner_lock);
1808 waiter = READ_ONCE(console_waiter);
1809 console_owner = NULL;
1810 raw_spin_unlock(&console_owner_lock);
1813 spin_release(&console_owner_dep_map, _THIS_IP_);
1817 /* The waiter is now free to continue */
1818 WRITE_ONCE(console_waiter, false);
1820 spin_release(&console_owner_dep_map, _THIS_IP_);
1823 * Hand off console_lock to waiter. The waiter will perform
1824 * the up(). After this, the waiter is the console_lock owner.
1826 mutex_release(&console_lock_dep_map, _THIS_IP_);
1831 * console_trylock_spinning - try to get console_lock by busy waiting
1833 * This allows to busy wait for the console_lock when the current
1834 * owner is running in specially marked sections. It means that
1835 * the current owner is running and cannot reschedule until it
1836 * is ready to lose the lock.
1838 * Return: 1 if we got the lock, 0 othrewise
1840 static int console_trylock_spinning(void)
1842 struct task_struct *owner = NULL;
1845 unsigned long flags;
1847 if (console_trylock())
1850 printk_safe_enter_irqsave(flags);
1852 raw_spin_lock(&console_owner_lock);
1853 owner = READ_ONCE(console_owner);
1854 waiter = READ_ONCE(console_waiter);
1855 if (!waiter && owner && owner != current) {
1856 WRITE_ONCE(console_waiter, true);
1859 raw_spin_unlock(&console_owner_lock);
1862 * If there is an active printk() writing to the
1863 * consoles, instead of having it write our data too,
1864 * see if we can offload that load from the active
1865 * printer, and do some printing ourselves.
1866 * Go into a spin only if there isn't already a waiter
1867 * spinning, and there is an active printer, and
1868 * that active printer isn't us (recursive printk?).
1871 printk_safe_exit_irqrestore(flags);
1875 /* We spin waiting for the owner to release us */
1876 spin_acquire(&console_owner_dep_map, 0, 0, _THIS_IP_);
1877 /* Owner will clear console_waiter on hand off */
1878 while (READ_ONCE(console_waiter))
1880 spin_release(&console_owner_dep_map, _THIS_IP_);
1882 printk_safe_exit_irqrestore(flags);
1884 * The owner passed the console lock to us.
1885 * Since we did not spin on console lock, annotate
1886 * this as a trylock. Otherwise lockdep will
1889 mutex_acquire(&console_lock_dep_map, 0, 1, _THIS_IP_);
1895 * Call the console drivers, asking them to write out
1896 * log_buf[start] to log_buf[end - 1].
1897 * The console_lock must be held.
1899 static void call_console_drivers(const char *ext_text, size_t ext_len,
1900 const char *text, size_t len)
1902 static char dropped_text[64];
1903 size_t dropped_len = 0;
1904 struct console *con;
1906 trace_console_rcuidle(text, len);
1908 if (!console_drivers)
1911 if (console_dropped) {
1912 dropped_len = snprintf(dropped_text, sizeof(dropped_text),
1913 "** %lu printk messages dropped **\n",
1915 console_dropped = 0;
1918 for_each_console(con) {
1919 if (exclusive_console && con != exclusive_console)
1921 if (!(con->flags & CON_ENABLED))
1925 if (!cpu_online(smp_processor_id()) &&
1926 !(con->flags & CON_ANYTIME))
1928 if (con->flags & CON_EXTENDED)
1929 con->write(con, ext_text, ext_len);
1932 con->write(con, dropped_text, dropped_len);
1933 con->write(con, text, len);
1938 int printk_delay_msec __read_mostly;
1940 static inline void printk_delay(void)
1942 if (unlikely(printk_delay_msec)) {
1943 int m = printk_delay_msec;
1947 touch_nmi_watchdog();
1952 static inline u32 printk_caller_id(void)
1954 return in_task() ? task_pid_nr(current) :
1955 0x80000000 + raw_smp_processor_id();
1959 * printk_parse_prefix - Parse level and control flags.
1961 * @text: The terminated text message.
1962 * @level: A pointer to the current level value, will be updated.
1963 * @flags: A pointer to the current printk_info flags, will be updated.
1965 * @level may be NULL if the caller is not interested in the parsed value.
1966 * Otherwise the variable pointed to by @level must be set to
1967 * LOGLEVEL_DEFAULT in order to be updated with the parsed value.
1969 * @flags may be NULL if the caller is not interested in the parsed value.
1970 * Otherwise the variable pointed to by @flags will be OR'd with the parsed
1973 * Return: The length of the parsed level and control flags.
1975 u16 printk_parse_prefix(const char *text, int *level,
1976 enum printk_info_flags *flags)
1982 kern_level = printk_get_level(text);
1986 switch (kern_level) {
1988 if (level && *level == LOGLEVEL_DEFAULT)
1989 *level = kern_level - '0';
1991 case 'c': /* KERN_CONT */
2003 static u16 printk_sprint(char *text, u16 size, int facility,
2004 enum printk_info_flags *flags, const char *fmt,
2009 text_len = vscnprintf(text, size, fmt, args);
2011 /* Mark and strip a trailing newline. */
2012 if (text_len && text[text_len - 1] == '\n') {
2014 *flags |= LOG_NEWLINE;
2017 /* Strip log level and control flags. */
2018 if (facility == 0) {
2021 prefix_len = printk_parse_prefix(text, NULL, NULL);
2023 text_len -= prefix_len;
2024 memmove(text, text + prefix_len, text_len);
2032 int vprintk_store(int facility, int level,
2033 const struct dev_printk_info *dev_info,
2034 const char *fmt, va_list args)
2036 const u32 caller_id = printk_caller_id();
2037 struct prb_reserved_entry e;
2038 enum printk_info_flags flags = 0;
2039 struct printk_record r;
2040 u16 trunc_msg_len = 0;
2048 * Since the duration of printk() can vary depending on the message
2049 * and state of the ringbuffer, grab the timestamp now so that it is
2050 * close to the call of printk(). This provides a more deterministic
2051 * timestamp with respect to the caller.
2053 ts_nsec = local_clock();
2056 * The sprintf needs to come first since the syslog prefix might be
2057 * passed in as a parameter. An extra byte must be reserved so that
2058 * later the vscnprintf() into the reserved buffer has room for the
2059 * terminating '\0', which is not counted by vsnprintf().
2061 va_copy(args2, args);
2062 reserve_size = vsnprintf(&prefix_buf[0], sizeof(prefix_buf), fmt, args2) + 1;
2065 if (reserve_size > LOG_LINE_MAX)
2066 reserve_size = LOG_LINE_MAX;
2068 /* Extract log level or control flags. */
2070 printk_parse_prefix(&prefix_buf[0], &level, &flags);
2072 if (level == LOGLEVEL_DEFAULT)
2073 level = default_message_loglevel;
2076 flags |= LOG_NEWLINE;
2078 if (flags & LOG_CONT) {
2079 prb_rec_init_wr(&r, reserve_size);
2080 if (prb_reserve_in_last(&e, prb, &r, caller_id, LOG_LINE_MAX)) {
2081 text_len = printk_sprint(&r.text_buf[r.info->text_len], reserve_size,
2082 facility, &flags, fmt, args);
2083 r.info->text_len += text_len;
2085 if (flags & LOG_NEWLINE) {
2086 r.info->flags |= LOG_NEWLINE;
2087 prb_final_commit(&e);
2097 * Explicitly initialize the record before every prb_reserve() call.
2098 * prb_reserve_in_last() and prb_reserve() purposely invalidate the
2099 * structure when they fail.
2101 prb_rec_init_wr(&r, reserve_size);
2102 if (!prb_reserve(&e, prb, &r)) {
2103 /* truncate the message if it is too long for empty buffer */
2104 truncate_msg(&reserve_size, &trunc_msg_len);
2106 prb_rec_init_wr(&r, reserve_size + trunc_msg_len);
2107 if (!prb_reserve(&e, prb, &r))
2112 text_len = printk_sprint(&r.text_buf[0], reserve_size, facility, &flags, fmt, args);
2114 memcpy(&r.text_buf[text_len], trunc_msg, trunc_msg_len);
2115 r.info->text_len = text_len + trunc_msg_len;
2116 r.info->facility = facility;
2117 r.info->level = level & 7;
2118 r.info->flags = flags & 0x1f;
2119 r.info->ts_nsec = ts_nsec;
2120 r.info->caller_id = caller_id;
2122 memcpy(&r.info->dev_info, dev_info, sizeof(r.info->dev_info));
2124 /* A message without a trailing newline can be continued. */
2125 if (!(flags & LOG_NEWLINE))
2128 prb_final_commit(&e);
2130 return (text_len + trunc_msg_len);
2133 asmlinkage int vprintk_emit(int facility, int level,
2134 const struct dev_printk_info *dev_info,
2135 const char *fmt, va_list args)
2138 bool in_sched = false;
2139 unsigned long flags;
2141 /* Suppress unimportant messages after panic happens */
2142 if (unlikely(suppress_printk))
2145 if (level == LOGLEVEL_SCHED) {
2146 level = LOGLEVEL_DEFAULT;
2150 boot_delay_msec(level);
2153 printk_safe_enter_irqsave(flags);
2154 printed_len = vprintk_store(facility, level, dev_info, fmt, args);
2155 printk_safe_exit_irqrestore(flags);
2157 /* If called from the scheduler, we can not call up(). */
2160 * Disable preemption to avoid being preempted while holding
2161 * console_sem which would prevent anyone from printing to
2166 * Try to acquire and then immediately release the console
2167 * semaphore. The release will print out buffers and wake up
2168 * /dev/kmsg and syslog() users.
2170 if (console_trylock_spinning())
2178 EXPORT_SYMBOL(vprintk_emit);
2180 int vprintk_default(const char *fmt, va_list args)
2182 return vprintk_emit(0, LOGLEVEL_DEFAULT, NULL, fmt, args);
2184 EXPORT_SYMBOL_GPL(vprintk_default);
2186 asmlinkage __visible int _printk(const char *fmt, ...)
2191 va_start(args, fmt);
2192 r = vprintk(fmt, args);
2197 EXPORT_SYMBOL(_printk);
2199 #else /* CONFIG_PRINTK */
2201 #define CONSOLE_LOG_MAX 0
2202 #define printk_time false
2204 #define prb_read_valid(rb, seq, r) false
2205 #define prb_first_valid_seq(rb) 0
2207 static u64 syslog_seq;
2208 static u64 console_seq;
2209 static u64 exclusive_console_stop_seq;
2210 static unsigned long console_dropped;
2212 static size_t record_print_text(const struct printk_record *r,
2213 bool syslog, bool time)
2217 static ssize_t info_print_ext_header(char *buf, size_t size,
2218 struct printk_info *info)
2222 static ssize_t msg_print_ext_body(char *buf, size_t size,
2223 char *text, size_t text_len,
2224 struct dev_printk_info *dev_info) { return 0; }
2225 static void console_lock_spinning_enable(void) { }
2226 static int console_lock_spinning_disable_and_check(void) { return 0; }
2227 static void call_console_drivers(const char *ext_text, size_t ext_len,
2228 const char *text, size_t len) {}
2229 static bool suppress_message_printing(int level) { return false; }
2231 #endif /* CONFIG_PRINTK */
2233 #ifdef CONFIG_EARLY_PRINTK
2234 struct console *early_console;
2236 asmlinkage __visible void early_printk(const char *fmt, ...)
2246 n = vscnprintf(buf, sizeof(buf), fmt, ap);
2249 early_console->write(early_console, buf, n);
2253 static int __add_preferred_console(char *name, int idx, char *options,
2254 char *brl_options, bool user_specified)
2256 struct console_cmdline *c;
2260 * See if this tty is not yet registered, and
2261 * if we have a slot free.
2263 for (i = 0, c = console_cmdline;
2264 i < MAX_CMDLINECONSOLES && c->name[0];
2266 if (strcmp(c->name, name) == 0 && c->index == idx) {
2268 preferred_console = i;
2270 c->user_specified = true;
2274 if (i == MAX_CMDLINECONSOLES)
2277 preferred_console = i;
2278 strlcpy(c->name, name, sizeof(c->name));
2279 c->options = options;
2280 c->user_specified = user_specified;
2281 braille_set_options(c, brl_options);
2287 static int __init console_msg_format_setup(char *str)
2289 if (!strcmp(str, "syslog"))
2290 console_msg_format = MSG_FORMAT_SYSLOG;
2291 if (!strcmp(str, "default"))
2292 console_msg_format = MSG_FORMAT_DEFAULT;
2295 __setup("console_msg_format=", console_msg_format_setup);
2298 * Set up a console. Called via do_early_param() in init/main.c
2299 * for each "console=" parameter in the boot command line.
2301 static int __init console_setup(char *str)
2303 char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for "ttyS" */
2304 char *s, *options, *brl_options = NULL;
2308 * console="" or console=null have been suggested as a way to
2309 * disable console output. Use ttynull that has been created
2310 * for exactly this purpose.
2312 if (str[0] == 0 || strcmp(str, "null") == 0) {
2313 __add_preferred_console("ttynull", 0, NULL, NULL, true);
2317 if (_braille_console_setup(&str, &brl_options))
2321 * Decode str into name, index, options.
2323 if (str[0] >= '0' && str[0] <= '9') {
2324 strcpy(buf, "ttyS");
2325 strncpy(buf + 4, str, sizeof(buf) - 5);
2327 strncpy(buf, str, sizeof(buf) - 1);
2329 buf[sizeof(buf) - 1] = 0;
2330 options = strchr(str, ',');
2334 if (!strcmp(str, "ttya"))
2335 strcpy(buf, "ttyS0");
2336 if (!strcmp(str, "ttyb"))
2337 strcpy(buf, "ttyS1");
2339 for (s = buf; *s; s++)
2340 if (isdigit(*s) || *s == ',')
2342 idx = simple_strtoul(s, NULL, 10);
2345 __add_preferred_console(buf, idx, options, brl_options, true);
2346 console_set_on_cmdline = 1;
2349 __setup("console=", console_setup);
2352 * add_preferred_console - add a device to the list of preferred consoles.
2353 * @name: device name
2354 * @idx: device index
2355 * @options: options for this console
2357 * The last preferred console added will be used for kernel messages
2358 * and stdin/out/err for init. Normally this is used by console_setup
2359 * above to handle user-supplied console arguments; however it can also
2360 * be used by arch-specific code either to override the user or more
2361 * commonly to provide a default console (ie from PROM variables) when
2362 * the user has not supplied one.
2364 int add_preferred_console(char *name, int idx, char *options)
2366 return __add_preferred_console(name, idx, options, NULL, false);
2369 bool console_suspend_enabled = true;
2370 EXPORT_SYMBOL(console_suspend_enabled);
2372 static int __init console_suspend_disable(char *str)
2374 console_suspend_enabled = false;
2377 __setup("no_console_suspend", console_suspend_disable);
2378 module_param_named(console_suspend, console_suspend_enabled,
2379 bool, S_IRUGO | S_IWUSR);
2380 MODULE_PARM_DESC(console_suspend, "suspend console during suspend"
2381 " and hibernate operations");
2384 * suspend_console - suspend the console subsystem
2386 * This disables printk() while we go into suspend states
2388 void suspend_console(void)
2390 if (!console_suspend_enabled)
2392 pr_info("Suspending console(s) (use no_console_suspend to debug)\n");
2394 console_suspended = 1;
2398 void resume_console(void)
2400 if (!console_suspend_enabled)
2403 console_suspended = 0;
2408 * console_cpu_notify - print deferred console messages after CPU hotplug
2411 * If printk() is called from a CPU that is not online yet, the messages
2412 * will be printed on the console only if there are CON_ANYTIME consoles.
2413 * This function is called when a new CPU comes online (or fails to come
2414 * up) or goes offline.
2416 static int console_cpu_notify(unsigned int cpu)
2418 if (!cpuhp_tasks_frozen) {
2419 /* If trylock fails, someone else is doing the printing */
2420 if (console_trylock())
2427 * console_lock - lock the console system for exclusive use.
2429 * Acquires a lock which guarantees that the caller has
2430 * exclusive access to the console system and the console_drivers list.
2432 * Can sleep, returns nothing.
2434 void console_lock(void)
2439 if (console_suspended)
2442 console_may_schedule = 1;
2444 EXPORT_SYMBOL(console_lock);
2447 * console_trylock - try to lock the console system for exclusive use.
2449 * Try to acquire a lock which guarantees that the caller has exclusive
2450 * access to the console system and the console_drivers list.
2452 * returns 1 on success, and 0 on failure to acquire the lock.
2454 int console_trylock(void)
2456 if (down_trylock_console_sem())
2458 if (console_suspended) {
2463 console_may_schedule = 0;
2466 EXPORT_SYMBOL(console_trylock);
2468 int is_console_locked(void)
2470 return console_locked;
2472 EXPORT_SYMBOL(is_console_locked);
2475 * Check if we have any console that is capable of printing while cpu is
2476 * booting or shutting down. Requires console_sem.
2478 static int have_callable_console(void)
2480 struct console *con;
2482 for_each_console(con)
2483 if ((con->flags & CON_ENABLED) &&
2484 (con->flags & CON_ANYTIME))
2491 * Can we actually use the console at this time on this cpu?
2493 * Console drivers may assume that per-cpu resources have been allocated. So
2494 * unless they're explicitly marked as being able to cope (CON_ANYTIME) don't
2495 * call them until this CPU is officially up.
2497 static inline int can_use_console(void)
2499 return cpu_online(raw_smp_processor_id()) || have_callable_console();
2503 * console_unlock - unlock the console system
2505 * Releases the console_lock which the caller holds on the console system
2506 * and the console driver list.
2508 * While the console_lock was held, console output may have been buffered
2509 * by printk(). If this is the case, console_unlock(); emits
2510 * the output prior to releasing the lock.
2512 * If there is output waiting, we wake /dev/kmsg and syslog() users.
2514 * console_unlock(); may be called from any context.
2516 void console_unlock(void)
2518 static char ext_text[CONSOLE_EXT_LOG_MAX];
2519 static char text[CONSOLE_LOG_MAX];
2520 unsigned long flags;
2521 bool do_cond_resched, retry;
2522 struct printk_info info;
2523 struct printk_record r;
2525 if (console_suspended) {
2530 prb_rec_init_rd(&r, &info, text, sizeof(text));
2533 * Console drivers are called with interrupts disabled, so
2534 * @console_may_schedule should be cleared before; however, we may
2535 * end up dumping a lot of lines, for example, if called from
2536 * console registration path, and should invoke cond_resched()
2537 * between lines if allowable. Not doing so can cause a very long
2538 * scheduling stall on a slow console leading to RCU stall and
2539 * softlockup warnings which exacerbate the issue with more
2540 * messages practically incapacitating the system.
2542 * console_trylock() is not able to detect the preemptive
2543 * context reliably. Therefore the value must be stored before
2544 * and cleared after the "again" goto label.
2546 do_cond_resched = console_may_schedule;
2548 console_may_schedule = 0;
2551 * We released the console_sem lock, so we need to recheck if
2552 * cpu is online and (if not) is there at least one CON_ANYTIME
2555 if (!can_use_console()) {
2565 printk_safe_enter_irqsave(flags);
2567 if (!prb_read_valid(prb, console_seq, &r))
2570 if (console_seq != r.info->seq) {
2571 console_dropped += r.info->seq - console_seq;
2572 console_seq = r.info->seq;
2575 if (suppress_message_printing(r.info->level)) {
2577 * Skip record we have buffered and already printed
2578 * directly to the console when we received it, and
2579 * record that has level above the console loglevel.
2585 /* Output to all consoles once old messages replayed. */
2586 if (unlikely(exclusive_console &&
2587 console_seq >= exclusive_console_stop_seq)) {
2588 exclusive_console = NULL;
2592 * Handle extended console text first because later
2593 * record_print_text() will modify the record buffer in-place.
2595 if (nr_ext_console_drivers) {
2596 ext_len = info_print_ext_header(ext_text,
2599 ext_len += msg_print_ext_body(ext_text + ext_len,
2600 sizeof(ext_text) - ext_len,
2605 len = record_print_text(&r,
2606 console_msg_format & MSG_FORMAT_SYSLOG,
2611 * While actively printing out messages, if another printk()
2612 * were to occur on another CPU, it may wait for this one to
2613 * finish. This task can not be preempted if there is a
2614 * waiter waiting to take over.
2616 console_lock_spinning_enable();
2618 stop_critical_timings(); /* don't trace print latency */
2619 call_console_drivers(ext_text, ext_len, text, len);
2620 start_critical_timings();
2622 if (console_lock_spinning_disable_and_check()) {
2623 printk_safe_exit_irqrestore(flags);
2627 printk_safe_exit_irqrestore(flags);
2629 if (do_cond_resched)
2638 * Someone could have filled up the buffer again, so re-check if there's
2639 * something to flush. In case we cannot trylock the console_sem again,
2640 * there's a new owner and the console_unlock() from them will do the
2641 * flush, no worries.
2643 retry = prb_read_valid(prb, console_seq, NULL);
2644 printk_safe_exit_irqrestore(flags);
2646 if (retry && console_trylock())
2649 EXPORT_SYMBOL(console_unlock);
2652 * console_conditional_schedule - yield the CPU if required
2654 * If the console code is currently allowed to sleep, and
2655 * if this CPU should yield the CPU to another task, do
2658 * Must be called within console_lock();.
2660 void __sched console_conditional_schedule(void)
2662 if (console_may_schedule)
2665 EXPORT_SYMBOL(console_conditional_schedule);
2667 void console_unblank(void)
2672 * console_unblank can no longer be called in interrupt context unless
2673 * oops_in_progress is set to 1..
2675 if (oops_in_progress) {
2676 if (down_trylock_console_sem() != 0)
2682 console_may_schedule = 0;
2684 if ((c->flags & CON_ENABLED) && c->unblank)
2690 * console_flush_on_panic - flush console content on panic
2691 * @mode: flush all messages in buffer or just the pending ones
2693 * Immediately output all pending messages no matter what.
2695 void console_flush_on_panic(enum con_flush_mode mode)
2698 * If someone else is holding the console lock, trylock will fail
2699 * and may_schedule may be set. Ignore and proceed to unlock so
2700 * that messages are flushed out. As this can be called from any
2701 * context and we don't want to get preempted while flushing,
2702 * ensure may_schedule is cleared.
2705 console_may_schedule = 0;
2707 if (mode == CONSOLE_REPLAY_ALL) {
2708 unsigned long flags;
2710 printk_safe_enter_irqsave(flags);
2711 console_seq = prb_first_valid_seq(prb);
2712 printk_safe_exit_irqrestore(flags);
2718 * Return the console tty driver structure and its associated index
2720 struct tty_driver *console_device(int *index)
2723 struct tty_driver *driver = NULL;
2726 for_each_console(c) {
2729 driver = c->device(c, index);
2738 * Prevent further output on the passed console device so that (for example)
2739 * serial drivers can disable console output before suspending a port, and can
2740 * re-enable output afterwards.
2742 void console_stop(struct console *console)
2745 console->flags &= ~CON_ENABLED;
2748 EXPORT_SYMBOL(console_stop);
2750 void console_start(struct console *console)
2753 console->flags |= CON_ENABLED;
2756 EXPORT_SYMBOL(console_start);
2758 static int __read_mostly keep_bootcon;
2760 static int __init keep_bootcon_setup(char *str)
2763 pr_info("debug: skip boot console de-registration.\n");
2768 early_param("keep_bootcon", keep_bootcon_setup);
2771 * This is called by register_console() to try to match
2772 * the newly registered console with any of the ones selected
2773 * by either the command line or add_preferred_console() and
2776 * Care need to be taken with consoles that are statically
2777 * enabled such as netconsole
2779 static int try_enable_new_console(struct console *newcon, bool user_specified)
2781 struct console_cmdline *c;
2784 for (i = 0, c = console_cmdline;
2785 i < MAX_CMDLINECONSOLES && c->name[0];
2787 if (c->user_specified != user_specified)
2789 if (!newcon->match ||
2790 newcon->match(newcon, c->name, c->index, c->options) != 0) {
2791 /* default matching */
2792 BUILD_BUG_ON(sizeof(c->name) != sizeof(newcon->name));
2793 if (strcmp(c->name, newcon->name) != 0)
2795 if (newcon->index >= 0 &&
2796 newcon->index != c->index)
2798 if (newcon->index < 0)
2799 newcon->index = c->index;
2801 if (_braille_register_console(newcon, c))
2804 if (newcon->setup &&
2805 (err = newcon->setup(newcon, c->options)) != 0)
2808 newcon->flags |= CON_ENABLED;
2809 if (i == preferred_console) {
2810 newcon->flags |= CON_CONSDEV;
2811 has_preferred_console = true;
2817 * Some consoles, such as pstore and netconsole, can be enabled even
2818 * without matching. Accept the pre-enabled consoles only when match()
2819 * and setup() had a chance to be called.
2821 if (newcon->flags & CON_ENABLED && c->user_specified == user_specified)
2828 * The console driver calls this routine during kernel initialization
2829 * to register the console printing procedure with printk() and to
2830 * print any messages that were printed by the kernel before the
2831 * console driver was initialized.
2833 * This can happen pretty early during the boot process (because of
2834 * early_printk) - sometimes before setup_arch() completes - be careful
2835 * of what kernel features are used - they may not be initialised yet.
2837 * There are two types of consoles - bootconsoles (early_printk) and
2838 * "real" consoles (everything which is not a bootconsole) which are
2839 * handled differently.
2840 * - Any number of bootconsoles can be registered at any time.
2841 * - As soon as a "real" console is registered, all bootconsoles
2842 * will be unregistered automatically.
2843 * - Once a "real" console is registered, any attempt to register a
2844 * bootconsoles will be rejected
2846 void register_console(struct console *newcon)
2848 unsigned long flags;
2849 struct console *bcon = NULL;
2852 for_each_console(bcon) {
2853 if (WARN(bcon == newcon, "console '%s%d' already registered\n",
2854 bcon->name, bcon->index))
2859 * before we register a new CON_BOOT console, make sure we don't
2860 * already have a valid console
2862 if (newcon->flags & CON_BOOT) {
2863 for_each_console(bcon) {
2864 if (!(bcon->flags & CON_BOOT)) {
2865 pr_info("Too late to register bootconsole %s%d\n",
2866 newcon->name, newcon->index);
2872 if (console_drivers && console_drivers->flags & CON_BOOT)
2873 bcon = console_drivers;
2875 if (!has_preferred_console || bcon || !console_drivers)
2876 has_preferred_console = preferred_console >= 0;
2879 * See if we want to use this console driver. If we
2880 * didn't select a console we take the first one
2881 * that registers here.
2883 if (!has_preferred_console) {
2884 if (newcon->index < 0)
2886 if (newcon->setup == NULL ||
2887 newcon->setup(newcon, NULL) == 0) {
2888 newcon->flags |= CON_ENABLED;
2889 if (newcon->device) {
2890 newcon->flags |= CON_CONSDEV;
2891 has_preferred_console = true;
2896 /* See if this console matches one we selected on the command line */
2897 err = try_enable_new_console(newcon, true);
2899 /* If not, try to match against the platform default(s) */
2901 err = try_enable_new_console(newcon, false);
2903 /* printk() messages are not printed to the Braille console. */
2904 if (err || newcon->flags & CON_BRL)
2908 * If we have a bootconsole, and are switching to a real console,
2909 * don't print everything out again, since when the boot console, and
2910 * the real console are the same physical device, it's annoying to
2911 * see the beginning boot messages twice
2913 if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
2914 newcon->flags &= ~CON_PRINTBUFFER;
2917 * Put this console in the list - keep the
2918 * preferred driver at the head of the list.
2921 if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
2922 newcon->next = console_drivers;
2923 console_drivers = newcon;
2925 newcon->next->flags &= ~CON_CONSDEV;
2926 /* Ensure this flag is always set for the head of the list */
2927 newcon->flags |= CON_CONSDEV;
2929 newcon->next = console_drivers->next;
2930 console_drivers->next = newcon;
2933 if (newcon->flags & CON_EXTENDED)
2934 nr_ext_console_drivers++;
2936 if (newcon->flags & CON_PRINTBUFFER) {
2938 * console_unlock(); will print out the buffered messages
2941 * We're about to replay the log buffer. Only do this to the
2942 * just-registered console to avoid excessive message spam to
2943 * the already-registered consoles.
2945 * Set exclusive_console with disabled interrupts to reduce
2946 * race window with eventual console_flush_on_panic() that
2947 * ignores console_lock.
2949 exclusive_console = newcon;
2950 exclusive_console_stop_seq = console_seq;
2952 /* Get a consistent copy of @syslog_seq. */
2953 raw_spin_lock_irqsave(&syslog_lock, flags);
2954 console_seq = syslog_seq;
2955 raw_spin_unlock_irqrestore(&syslog_lock, flags);
2958 console_sysfs_notify();
2961 * By unregistering the bootconsoles after we enable the real console
2962 * we get the "console xxx enabled" message on all the consoles -
2963 * boot consoles, real consoles, etc - this is to ensure that end
2964 * users know there might be something in the kernel's log buffer that
2965 * went to the bootconsole (that they do not see on the real console)
2967 pr_info("%sconsole [%s%d] enabled\n",
2968 (newcon->flags & CON_BOOT) ? "boot" : "" ,
2969 newcon->name, newcon->index);
2971 ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
2973 /* We need to iterate through all boot consoles, to make
2974 * sure we print everything out, before we unregister them.
2976 for_each_console(bcon)
2977 if (bcon->flags & CON_BOOT)
2978 unregister_console(bcon);
2981 EXPORT_SYMBOL(register_console);
2983 int unregister_console(struct console *console)
2985 struct console *con;
2988 pr_info("%sconsole [%s%d] disabled\n",
2989 (console->flags & CON_BOOT) ? "boot" : "" ,
2990 console->name, console->index);
2992 res = _braille_unregister_console(console);
3000 if (console_drivers == console) {
3001 console_drivers=console->next;
3004 for_each_console(con) {
3005 if (con->next == console) {
3006 con->next = console->next;
3014 goto out_disable_unlock;
3016 if (console->flags & CON_EXTENDED)
3017 nr_ext_console_drivers--;
3020 * If this isn't the last console and it has CON_CONSDEV set, we
3021 * need to set it on the next preferred console.
3023 if (console_drivers != NULL && console->flags & CON_CONSDEV)
3024 console_drivers->flags |= CON_CONSDEV;
3026 console->flags &= ~CON_ENABLED;
3028 console_sysfs_notify();
3031 res = console->exit(console);
3036 console->flags &= ~CON_ENABLED;
3041 EXPORT_SYMBOL(unregister_console);
3044 * Initialize the console device. This is called *early*, so
3045 * we can't necessarily depend on lots of kernel help here.
3046 * Just do some early initializations, and do the complex setup
3049 void __init console_init(void)
3053 initcall_entry_t *ce;
3055 /* Setup the default TTY line discipline. */
3059 * set up the console device so that later boot sequences can
3060 * inform about problems etc..
3062 ce = __con_initcall_start;
3063 trace_initcall_level("console");
3064 while (ce < __con_initcall_end) {
3065 call = initcall_from_entry(ce);
3066 trace_initcall_start(call);
3068 trace_initcall_finish(call, ret);
3074 * Some boot consoles access data that is in the init section and which will
3075 * be discarded after the initcalls have been run. To make sure that no code
3076 * will access this data, unregister the boot consoles in a late initcall.
3078 * If for some reason, such as deferred probe or the driver being a loadable
3079 * module, the real console hasn't registered yet at this point, there will
3080 * be a brief interval in which no messages are logged to the console, which
3081 * makes it difficult to diagnose problems that occur during this time.
3083 * To mitigate this problem somewhat, only unregister consoles whose memory
3084 * intersects with the init section. Note that all other boot consoles will
3085 * get unregistered when the real preferred console is registered.
3087 static int __init printk_late_init(void)
3089 struct console *con;
3092 for_each_console(con) {
3093 if (!(con->flags & CON_BOOT))
3096 /* Check addresses that might be used for enabled consoles. */
3097 if (init_section_intersects(con, sizeof(*con)) ||
3098 init_section_contains(con->write, 0) ||
3099 init_section_contains(con->read, 0) ||
3100 init_section_contains(con->device, 0) ||
3101 init_section_contains(con->unblank, 0) ||
3102 init_section_contains(con->data, 0)) {
3104 * Please, consider moving the reported consoles out
3105 * of the init section.
3107 pr_warn("bootconsole [%s%d] uses init memory and must be disabled even before the real one is ready\n",
3108 con->name, con->index);
3109 unregister_console(con);
3112 ret = cpuhp_setup_state_nocalls(CPUHP_PRINTK_DEAD, "printk:dead", NULL,
3113 console_cpu_notify);
3115 ret = cpuhp_setup_state_nocalls(CPUHP_AP_ONLINE_DYN, "printk:online",
3116 console_cpu_notify, NULL);
3120 late_initcall(printk_late_init);
3122 #if defined CONFIG_PRINTK
3124 * Delayed printk version, for scheduler-internal messages:
3126 #define PRINTK_PENDING_WAKEUP 0x01
3127 #define PRINTK_PENDING_OUTPUT 0x02
3129 static DEFINE_PER_CPU(int, printk_pending);
3131 static void wake_up_klogd_work_func(struct irq_work *irq_work)
3133 int pending = __this_cpu_xchg(printk_pending, 0);
3135 if (pending & PRINTK_PENDING_OUTPUT) {
3136 /* If trylock fails, someone else is doing the printing */
3137 if (console_trylock())
3141 if (pending & PRINTK_PENDING_WAKEUP)
3142 wake_up_interruptible(&log_wait);
3145 static DEFINE_PER_CPU(struct irq_work, wake_up_klogd_work) =
3146 IRQ_WORK_INIT_LAZY(wake_up_klogd_work_func);
3148 void wake_up_klogd(void)
3150 if (!printk_percpu_data_ready())
3154 if (waitqueue_active(&log_wait)) {
3155 this_cpu_or(printk_pending, PRINTK_PENDING_WAKEUP);
3156 irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
3161 void defer_console_output(void)
3163 if (!printk_percpu_data_ready())
3167 __this_cpu_or(printk_pending, PRINTK_PENDING_OUTPUT);
3168 irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
3172 int vprintk_deferred(const char *fmt, va_list args)
3176 r = vprintk_emit(0, LOGLEVEL_SCHED, NULL, fmt, args);
3177 defer_console_output();
3182 int _printk_deferred(const char *fmt, ...)
3187 va_start(args, fmt);
3188 r = vprintk_deferred(fmt, args);
3195 * printk rate limiting, lifted from the networking subsystem.
3197 * This enforces a rate limit: not more than 10 kernel messages
3198 * every 5s to make a denial-of-service attack impossible.
3200 DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
3202 int __printk_ratelimit(const char *func)
3204 return ___ratelimit(&printk_ratelimit_state, func);
3206 EXPORT_SYMBOL(__printk_ratelimit);
3209 * printk_timed_ratelimit - caller-controlled printk ratelimiting
3210 * @caller_jiffies: pointer to caller's state
3211 * @interval_msecs: minimum interval between prints
3213 * printk_timed_ratelimit() returns true if more than @interval_msecs
3214 * milliseconds have elapsed since the last time printk_timed_ratelimit()
3217 bool printk_timed_ratelimit(unsigned long *caller_jiffies,
3218 unsigned int interval_msecs)
3220 unsigned long elapsed = jiffies - *caller_jiffies;
3222 if (*caller_jiffies && elapsed <= msecs_to_jiffies(interval_msecs))
3225 *caller_jiffies = jiffies;
3228 EXPORT_SYMBOL(printk_timed_ratelimit);
3230 static DEFINE_SPINLOCK(dump_list_lock);
3231 static LIST_HEAD(dump_list);
3234 * kmsg_dump_register - register a kernel log dumper.
3235 * @dumper: pointer to the kmsg_dumper structure
3237 * Adds a kernel log dumper to the system. The dump callback in the
3238 * structure will be called when the kernel oopses or panics and must be
3239 * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
3241 int kmsg_dump_register(struct kmsg_dumper *dumper)
3243 unsigned long flags;
3246 /* The dump callback needs to be set */
3250 spin_lock_irqsave(&dump_list_lock, flags);
3251 /* Don't allow registering multiple times */
3252 if (!dumper->registered) {
3253 dumper->registered = 1;
3254 list_add_tail_rcu(&dumper->list, &dump_list);
3257 spin_unlock_irqrestore(&dump_list_lock, flags);
3261 EXPORT_SYMBOL_GPL(kmsg_dump_register);
3264 * kmsg_dump_unregister - unregister a kmsg dumper.
3265 * @dumper: pointer to the kmsg_dumper structure
3267 * Removes a dump device from the system. Returns zero on success and
3268 * %-EINVAL otherwise.
3270 int kmsg_dump_unregister(struct kmsg_dumper *dumper)
3272 unsigned long flags;
3275 spin_lock_irqsave(&dump_list_lock, flags);
3276 if (dumper->registered) {
3277 dumper->registered = 0;
3278 list_del_rcu(&dumper->list);
3281 spin_unlock_irqrestore(&dump_list_lock, flags);
3286 EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
3288 static bool always_kmsg_dump;
3289 module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);
3291 const char *kmsg_dump_reason_str(enum kmsg_dump_reason reason)
3294 case KMSG_DUMP_PANIC:
3296 case KMSG_DUMP_OOPS:
3298 case KMSG_DUMP_EMERG:
3300 case KMSG_DUMP_SHUTDOWN:
3306 EXPORT_SYMBOL_GPL(kmsg_dump_reason_str);
3309 * kmsg_dump - dump kernel log to kernel message dumpers.
3310 * @reason: the reason (oops, panic etc) for dumping
3312 * Call each of the registered dumper's dump() callback, which can
3313 * retrieve the kmsg records with kmsg_dump_get_line() or
3314 * kmsg_dump_get_buffer().
3316 void kmsg_dump(enum kmsg_dump_reason reason)
3318 struct kmsg_dumper *dumper;
3321 list_for_each_entry_rcu(dumper, &dump_list, list) {
3322 enum kmsg_dump_reason max_reason = dumper->max_reason;
3325 * If client has not provided a specific max_reason, default
3326 * to KMSG_DUMP_OOPS, unless always_kmsg_dump was set.
3328 if (max_reason == KMSG_DUMP_UNDEF) {
3329 max_reason = always_kmsg_dump ? KMSG_DUMP_MAX :
3332 if (reason > max_reason)
3335 /* invoke dumper which will iterate over records */
3336 dumper->dump(dumper, reason);
3342 * kmsg_dump_get_line - retrieve one kmsg log line
3343 * @iter: kmsg dump iterator
3344 * @syslog: include the "<4>" prefixes
3345 * @line: buffer to copy the line to
3346 * @size: maximum size of the buffer
3347 * @len: length of line placed into buffer
3349 * Start at the beginning of the kmsg buffer, with the oldest kmsg
3350 * record, and copy one record into the provided buffer.
3352 * Consecutive calls will return the next available record moving
3353 * towards the end of the buffer with the youngest messages.
3355 * A return value of FALSE indicates that there are no more records to
3358 bool kmsg_dump_get_line(struct kmsg_dump_iter *iter, bool syslog,
3359 char *line, size_t size, size_t *len)
3361 u64 min_seq = latched_seq_read_nolock(&clear_seq);
3362 struct printk_info info;
3363 unsigned int line_count;
3364 struct printk_record r;
3365 unsigned long flags;
3369 if (iter->cur_seq < min_seq)
3370 iter->cur_seq = min_seq;
3372 printk_safe_enter_irqsave(flags);
3373 prb_rec_init_rd(&r, &info, line, size);
3375 /* Read text or count text lines? */
3377 if (!prb_read_valid(prb, iter->cur_seq, &r))
3379 l = record_print_text(&r, syslog, printk_time);
3381 if (!prb_read_valid_info(prb, iter->cur_seq,
3382 &info, &line_count)) {
3385 l = get_record_print_text_size(&info, line_count, syslog,
3390 iter->cur_seq = r.info->seq + 1;
3393 printk_safe_exit_irqrestore(flags);
3398 EXPORT_SYMBOL_GPL(kmsg_dump_get_line);
3401 * kmsg_dump_get_buffer - copy kmsg log lines
3402 * @iter: kmsg dump iterator
3403 * @syslog: include the "<4>" prefixes
3404 * @buf: buffer to copy the line to
3405 * @size: maximum size of the buffer
3406 * @len_out: length of line placed into buffer
3408 * Start at the end of the kmsg buffer and fill the provided buffer
3409 * with as many of the *youngest* kmsg records that fit into it.
3410 * If the buffer is large enough, all available kmsg records will be
3411 * copied with a single call.
3413 * Consecutive calls will fill the buffer with the next block of
3414 * available older records, not including the earlier retrieved ones.
3416 * A return value of FALSE indicates that there are no more records to
3419 bool kmsg_dump_get_buffer(struct kmsg_dump_iter *iter, bool syslog,
3420 char *buf, size_t size, size_t *len_out)
3422 u64 min_seq = latched_seq_read_nolock(&clear_seq);
3423 struct printk_info info;
3424 struct printk_record r;
3425 unsigned long flags;
3430 bool time = printk_time;
3435 if (iter->cur_seq < min_seq)
3436 iter->cur_seq = min_seq;
3438 printk_safe_enter_irqsave(flags);
3439 if (prb_read_valid_info(prb, iter->cur_seq, &info, NULL)) {
3440 if (info.seq != iter->cur_seq) {
3441 /* messages are gone, move to first available one */
3442 iter->cur_seq = info.seq;
3447 if (iter->cur_seq >= iter->next_seq) {
3448 printk_safe_exit_irqrestore(flags);
3453 * Find first record that fits, including all following records,
3454 * into the user-provided buffer for this dump. Pass in size-1
3455 * because this function (by way of record_print_text()) will
3456 * not write more than size-1 bytes of text into @buf.
3458 seq = find_first_fitting_seq(iter->cur_seq, iter->next_seq,
3459 size - 1, syslog, time);
3462 * Next kmsg_dump_get_buffer() invocation will dump block of
3463 * older records stored right before this one.
3467 prb_rec_init_rd(&r, &info, buf, size);
3470 prb_for_each_record(seq, prb, seq, &r) {
3471 if (r.info->seq >= iter->next_seq)
3474 len += record_print_text(&r, syslog, time);
3476 /* Adjust record to store to remaining buffer space. */
3477 prb_rec_init_rd(&r, &info, buf + len, size - len);
3480 iter->next_seq = next_seq;
3482 printk_safe_exit_irqrestore(flags);
3488 EXPORT_SYMBOL_GPL(kmsg_dump_get_buffer);
3491 * kmsg_dump_rewind - reset the iterator
3492 * @iter: kmsg dump iterator
3494 * Reset the dumper's iterator so that kmsg_dump_get_line() and
3495 * kmsg_dump_get_buffer() can be called again and used multiple
3496 * times within the same dumper.dump() callback.
3498 void kmsg_dump_rewind(struct kmsg_dump_iter *iter)
3500 unsigned long flags;
3502 printk_safe_enter_irqsave(flags);
3503 iter->cur_seq = latched_seq_read_nolock(&clear_seq);
3504 iter->next_seq = prb_next_seq(prb);
3505 printk_safe_exit_irqrestore(flags);
3507 EXPORT_SYMBOL_GPL(kmsg_dump_rewind);
3512 static atomic_t printk_cpulock_owner = ATOMIC_INIT(-1);
3513 static atomic_t printk_cpulock_nested = ATOMIC_INIT(0);
3516 * __printk_wait_on_cpu_lock() - Busy wait until the printk cpu-reentrant
3517 * spinning lock is not owned by any CPU.
3519 * Context: Any context.
3521 void __printk_wait_on_cpu_lock(void)
3525 } while (atomic_read(&printk_cpulock_owner) != -1);
3527 EXPORT_SYMBOL(__printk_wait_on_cpu_lock);
3530 * __printk_cpu_trylock() - Try to acquire the printk cpu-reentrant
3533 * If no processor has the lock, the calling processor takes the lock and
3534 * becomes the owner. If the calling processor is already the owner of the
3535 * lock, this function succeeds immediately.
3537 * Context: Any context. Expects interrupts to be disabled.
3538 * Return: 1 on success, otherwise 0.
3540 int __printk_cpu_trylock(void)
3545 cpu = smp_processor_id();
3548 * Guarantee loads and stores from this CPU when it is the lock owner
3549 * are _not_ visible to the previous lock owner. This pairs with
3550 * __printk_cpu_unlock:B.
3552 * Memory barrier involvement:
3554 * If __printk_cpu_trylock:A reads from __printk_cpu_unlock:B, then
3555 * __printk_cpu_unlock:A can never read from __printk_cpu_trylock:B.
3559 * RELEASE from __printk_cpu_unlock:A to __printk_cpu_unlock:B
3560 * of the previous CPU
3562 * ACQUIRE from __printk_cpu_trylock:A to __printk_cpu_trylock:B
3565 old = atomic_cmpxchg_acquire(&printk_cpulock_owner, -1,
3566 cpu); /* LMM(__printk_cpu_trylock:A) */
3569 * This CPU is now the owner and begins loading/storing
3570 * data: LMM(__printk_cpu_trylock:B)
3574 } else if (old == cpu) {
3575 /* This CPU is already the owner. */
3576 atomic_inc(&printk_cpulock_nested);
3582 EXPORT_SYMBOL(__printk_cpu_trylock);
3585 * __printk_cpu_unlock() - Release the printk cpu-reentrant spinning lock.
3587 * The calling processor must be the owner of the lock.
3589 * Context: Any context. Expects interrupts to be disabled.
3591 void __printk_cpu_unlock(void)
3593 if (atomic_read(&printk_cpulock_nested)) {
3594 atomic_dec(&printk_cpulock_nested);
3599 * This CPU is finished loading/storing data:
3600 * LMM(__printk_cpu_unlock:A)
3604 * Guarantee loads and stores from this CPU when it was the
3605 * lock owner are visible to the next lock owner. This pairs
3606 * with __printk_cpu_trylock:A.
3608 * Memory barrier involvement:
3610 * If __printk_cpu_trylock:A reads from __printk_cpu_unlock:B,
3611 * then __printk_cpu_trylock:B reads from __printk_cpu_unlock:A.
3615 * RELEASE from __printk_cpu_unlock:A to __printk_cpu_unlock:B
3618 * ACQUIRE from __printk_cpu_trylock:A to __printk_cpu_trylock:B
3621 atomic_set_release(&printk_cpulock_owner,
3622 -1); /* LMM(__printk_cpu_unlock:B) */
3624 EXPORT_SYMBOL(__printk_cpu_unlock);
3625 #endif /* CONFIG_SMP */