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/interrupt.h> /* For in_interrupt() */
30 #include <linux/delay.h>
31 #include <linux/smp.h>
32 #include <linux/security.h>
33 #include <linux/bootmem.h>
34 #include <linux/memblock.h>
35 #include <linux/syscalls.h>
36 #include <linux/kexec.h>
37 #include <linux/kdb.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/notifier.h>
43 #include <linux/rculist.h>
45 #include <asm/uaccess.h>
47 #define CREATE_TRACE_POINTS
48 #include <trace/events/printk.h>
51 * Architectures can override it:
53 void asmlinkage __attribute__((weak)) early_printk(const char *fmt, ...)
57 #define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
59 /* printk's without a loglevel use this.. */
60 #define DEFAULT_MESSAGE_LOGLEVEL CONFIG_DEFAULT_MESSAGE_LOGLEVEL
62 /* We show everything that is MORE important than this.. */
63 #define MINIMUM_CONSOLE_LOGLEVEL 1 /* Minimum loglevel we let people use */
64 #define DEFAULT_CONSOLE_LOGLEVEL 7 /* anything MORE serious than KERN_DEBUG */
66 DECLARE_WAIT_QUEUE_HEAD(log_wait);
68 int console_printk[4] = {
69 DEFAULT_CONSOLE_LOGLEVEL, /* console_loglevel */
70 DEFAULT_MESSAGE_LOGLEVEL, /* default_message_loglevel */
71 MINIMUM_CONSOLE_LOGLEVEL, /* minimum_console_loglevel */
72 DEFAULT_CONSOLE_LOGLEVEL, /* default_console_loglevel */
76 * Low level drivers may need that to know if they can schedule in
77 * their unblank() callback or not. So let's export it.
80 EXPORT_SYMBOL(oops_in_progress);
83 * console_sem protects the console_drivers list, and also
84 * provides serialisation for access to the entire console
87 static DEFINE_SEMAPHORE(console_sem);
88 struct console *console_drivers;
89 EXPORT_SYMBOL_GPL(console_drivers);
92 * This is used for debugging the mess that is the VT code by
93 * keeping track if we have the console semaphore held. It's
94 * definitely not the perfect debug tool (we don't know if _WE_
95 * hold it are racing, but it helps tracking those weird code
96 * path in the console code where we end up in places I want
97 * locked without the console sempahore held
99 static int console_locked, console_suspended;
102 * logbuf_lock protects log_buf, log_start, log_end, con_start and logged_chars
103 * It is also used in interesting ways to provide interlocking in
106 static DEFINE_RAW_SPINLOCK(logbuf_lock);
108 #define LOG_BUF_MASK (log_buf_len-1)
109 #define LOG_BUF(idx) (log_buf[(idx) & LOG_BUF_MASK])
112 * The indices into log_buf are not constrained to log_buf_len - they
113 * must be masked before subscripting
115 static unsigned log_start; /* Index into log_buf: next char to be read by syslog() */
116 static unsigned con_start; /* Index into log_buf: next char to be sent to consoles */
117 static unsigned log_end; /* Index into log_buf: most-recently-written-char + 1 */
120 * If exclusive_console is non-NULL then only this console is to be printed to.
122 static struct console *exclusive_console;
125 * Array of consoles built from command line options (console=)
127 struct console_cmdline
129 char name[8]; /* Name of the driver */
130 int index; /* Minor dev. to use */
131 char *options; /* Options for the driver */
132 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
133 char *brl_options; /* Options for braille driver */
137 #define MAX_CMDLINECONSOLES 8
139 static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
140 static int selected_console = -1;
141 static int preferred_console = -1;
142 int console_set_on_cmdline;
143 EXPORT_SYMBOL(console_set_on_cmdline);
145 /* Flag: console code may call schedule() */
146 static int console_may_schedule;
150 static char __log_buf[__LOG_BUF_LEN];
151 static char *log_buf = __log_buf;
152 static int log_buf_len = __LOG_BUF_LEN;
153 static unsigned logged_chars; /* Number of chars produced since last read+clear operation */
154 static int saved_console_loglevel = -1;
158 * This appends the listed symbols to /proc/vmcoreinfo
160 * /proc/vmcoreinfo is used by various utiilties, like crash and makedumpfile to
161 * obtain access to symbols that are otherwise very difficult to locate. These
162 * symbols are specifically used so that utilities can access and extract the
163 * dmesg log from a vmcore file after a crash.
165 void log_buf_kexec_setup(void)
167 VMCOREINFO_SYMBOL(log_buf);
168 VMCOREINFO_SYMBOL(log_end);
169 VMCOREINFO_SYMBOL(log_buf_len);
170 VMCOREINFO_SYMBOL(logged_chars);
174 /* requested log_buf_len from kernel cmdline */
175 static unsigned long __initdata new_log_buf_len;
177 /* save requested log_buf_len since it's too early to process it */
178 static int __init log_buf_len_setup(char *str)
180 unsigned size = memparse(str, &str);
183 size = roundup_pow_of_two(size);
184 if (size > log_buf_len)
185 new_log_buf_len = size;
189 early_param("log_buf_len", log_buf_len_setup);
191 void __init setup_log_buf(int early)
194 unsigned start, dest_idx, offset;
198 if (!new_log_buf_len)
204 mem = memblock_alloc(new_log_buf_len, PAGE_SIZE);
207 new_log_buf = __va(mem);
209 new_log_buf = alloc_bootmem_nopanic(new_log_buf_len);
212 if (unlikely(!new_log_buf)) {
213 pr_err("log_buf_len: %ld bytes not available\n",
218 raw_spin_lock_irqsave(&logbuf_lock, flags);
219 log_buf_len = new_log_buf_len;
220 log_buf = new_log_buf;
222 free = __LOG_BUF_LEN - log_end;
224 offset = start = min(con_start, log_start);
226 while (start != log_end) {
227 unsigned log_idx_mask = start & (__LOG_BUF_LEN - 1);
229 log_buf[dest_idx] = __log_buf[log_idx_mask];
236 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
238 pr_info("log_buf_len: %d\n", log_buf_len);
239 pr_info("early log buf free: %d(%d%%)\n",
240 free, (free * 100) / __LOG_BUF_LEN);
243 #ifdef CONFIG_BOOT_PRINTK_DELAY
245 static int boot_delay; /* msecs delay after each printk during bootup */
246 static unsigned long long loops_per_msec; /* based on boot_delay */
248 static int __init boot_delay_setup(char *str)
252 lpj = preset_lpj ? preset_lpj : 1000000; /* some guess */
253 loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
255 get_option(&str, &boot_delay);
256 if (boot_delay > 10 * 1000)
259 pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
260 "HZ: %d, loops_per_msec: %llu\n",
261 boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
264 __setup("boot_delay=", boot_delay_setup);
266 static void boot_delay_msec(void)
268 unsigned long long k;
269 unsigned long timeout;
271 if (boot_delay == 0 || system_state != SYSTEM_BOOTING)
274 k = (unsigned long long)loops_per_msec * boot_delay;
276 timeout = jiffies + msecs_to_jiffies(boot_delay);
281 * use (volatile) jiffies to prevent
282 * compiler reduction; loop termination via jiffies
283 * is secondary and may or may not happen.
285 if (time_after(jiffies, timeout))
287 touch_nmi_watchdog();
291 static inline void boot_delay_msec(void)
296 #ifdef CONFIG_SECURITY_DMESG_RESTRICT
297 int dmesg_restrict = 1;
302 static int syslog_action_restricted(int type)
306 /* Unless restricted, we allow "read all" and "get buffer size" for everybody */
307 return type != SYSLOG_ACTION_READ_ALL && type != SYSLOG_ACTION_SIZE_BUFFER;
310 static int check_syslog_permissions(int type, bool from_file)
313 * If this is from /proc/kmsg and we've already opened it, then we've
314 * already done the capabilities checks at open time.
316 if (from_file && type != SYSLOG_ACTION_OPEN)
319 if (syslog_action_restricted(type)) {
320 if (capable(CAP_SYSLOG))
322 /* For historical reasons, accept CAP_SYS_ADMIN too, with a warning */
323 if (capable(CAP_SYS_ADMIN)) {
324 printk_once(KERN_WARNING "%s (%d): "
325 "Attempt to access syslog with CAP_SYS_ADMIN "
326 "but no CAP_SYSLOG (deprecated).\n",
327 current->comm, task_pid_nr(current));
335 int do_syslog(int type, char __user *buf, int len, bool from_file)
337 unsigned i, j, limit, count;
342 error = check_syslog_permissions(type, from_file);
346 error = security_syslog(type);
351 case SYSLOG_ACTION_CLOSE: /* Close log */
353 case SYSLOG_ACTION_OPEN: /* Open log */
355 case SYSLOG_ACTION_READ: /* Read from log */
362 if (!access_ok(VERIFY_WRITE, buf, len)) {
366 error = wait_event_interruptible(log_wait,
367 (log_start - log_end));
371 raw_spin_lock_irq(&logbuf_lock);
372 while (!error && (log_start != log_end) && i < len) {
373 c = LOG_BUF(log_start);
375 raw_spin_unlock_irq(&logbuf_lock);
376 error = __put_user(c,buf);
380 raw_spin_lock_irq(&logbuf_lock);
382 raw_spin_unlock_irq(&logbuf_lock);
386 /* Read/clear last kernel messages */
387 case SYSLOG_ACTION_READ_CLEAR:
390 /* Read last kernel messages */
391 case SYSLOG_ACTION_READ_ALL:
398 if (!access_ok(VERIFY_WRITE, buf, len)) {
403 if (count > log_buf_len)
405 raw_spin_lock_irq(&logbuf_lock);
406 if (count > logged_chars)
407 count = logged_chars;
412 * __put_user() could sleep, and while we sleep
413 * printk() could overwrite the messages
414 * we try to copy to user space. Therefore
415 * the messages are copied in reverse. <manfreds>
417 for (i = 0; i < count && !error; i++) {
419 if (j + log_buf_len < log_end)
422 raw_spin_unlock_irq(&logbuf_lock);
423 error = __put_user(c,&buf[count-1-i]);
425 raw_spin_lock_irq(&logbuf_lock);
427 raw_spin_unlock_irq(&logbuf_lock);
432 int offset = count-error;
433 /* buffer overflow during copy, correct user buffer. */
434 for (i = 0; i < error; i++) {
435 if (__get_user(c,&buf[i+offset]) ||
436 __put_user(c,&buf[i])) {
444 /* Clear ring buffer */
445 case SYSLOG_ACTION_CLEAR:
448 /* Disable logging to console */
449 case SYSLOG_ACTION_CONSOLE_OFF:
450 if (saved_console_loglevel == -1)
451 saved_console_loglevel = console_loglevel;
452 console_loglevel = minimum_console_loglevel;
454 /* Enable logging to console */
455 case SYSLOG_ACTION_CONSOLE_ON:
456 if (saved_console_loglevel != -1) {
457 console_loglevel = saved_console_loglevel;
458 saved_console_loglevel = -1;
461 /* Set level of messages printed to console */
462 case SYSLOG_ACTION_CONSOLE_LEVEL:
464 if (len < 1 || len > 8)
466 if (len < minimum_console_loglevel)
467 len = minimum_console_loglevel;
468 console_loglevel = len;
469 /* Implicitly re-enable logging to console */
470 saved_console_loglevel = -1;
473 /* Number of chars in the log buffer */
474 case SYSLOG_ACTION_SIZE_UNREAD:
475 error = log_end - log_start;
477 /* Size of the log buffer */
478 case SYSLOG_ACTION_SIZE_BUFFER:
489 SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
491 return do_syslog(type, buf, len, SYSLOG_FROM_CALL);
494 #ifdef CONFIG_KGDB_KDB
495 /* kdb dmesg command needs access to the syslog buffer. do_syslog()
496 * uses locks so it cannot be used during debugging. Just tell kdb
497 * where the start and end of the physical and logical logs are. This
498 * is equivalent to do_syslog(3).
500 void kdb_syslog_data(char *syslog_data[4])
502 syslog_data[0] = log_buf;
503 syslog_data[1] = log_buf + log_buf_len;
504 syslog_data[2] = log_buf + log_end -
505 (logged_chars < log_buf_len ? logged_chars : log_buf_len);
506 syslog_data[3] = log_buf + log_end;
508 #endif /* CONFIG_KGDB_KDB */
511 * Call the console drivers on a range of log_buf
513 static void __call_console_drivers(unsigned start, unsigned end)
517 for_each_console(con) {
518 if (exclusive_console && con != exclusive_console)
520 if ((con->flags & CON_ENABLED) && con->write &&
521 (cpu_online(smp_processor_id()) ||
522 (con->flags & CON_ANYTIME)))
523 con->write(con, &LOG_BUF(start), end - start);
527 static bool __read_mostly ignore_loglevel;
529 static int __init ignore_loglevel_setup(char *str)
532 printk(KERN_INFO "debug: ignoring loglevel setting.\n");
537 early_param("ignore_loglevel", ignore_loglevel_setup);
538 module_param(ignore_loglevel, bool, S_IRUGO | S_IWUSR);
539 MODULE_PARM_DESC(ignore_loglevel, "ignore loglevel setting, to"
540 "print all kernel messages to the console.");
543 * Write out chars from start to end - 1 inclusive
545 static void _call_console_drivers(unsigned start,
546 unsigned end, int msg_log_level)
548 trace_console(&LOG_BUF(0), start, end, log_buf_len);
550 if ((msg_log_level < console_loglevel || ignore_loglevel) &&
551 console_drivers && start != end) {
552 if ((start & LOG_BUF_MASK) > (end & LOG_BUF_MASK)) {
554 __call_console_drivers(start & LOG_BUF_MASK,
556 __call_console_drivers(0, end & LOG_BUF_MASK);
558 __call_console_drivers(start, end);
564 * Parse the syslog header <[0-9]*>. The decimal value represents 32bit, the
565 * lower 3 bit are the log level, the rest are the log facility. In case
566 * userspace passes usual userspace syslog messages to /dev/kmsg or
567 * /dev/ttyprintk, the log prefix might contain the facility. Printk needs
568 * to extract the correct log level for in-kernel processing, and not mangle
569 * the original value.
571 * If a prefix is found, the length of the prefix is returned. If 'level' is
572 * passed, it will be filled in with the log level without a possible facility
573 * value. If 'special' is passed, the special printk prefix chars are accepted
574 * and returned. If no valid header is found, 0 is returned and the passed
575 * variables are not touched.
577 static size_t log_prefix(const char *p, unsigned int *level, char *special)
579 unsigned int lev = 0;
583 if (p[0] != '<' || !p[1])
586 /* usual single digit level number or special char */
591 case 'c': /* KERN_CONT */
592 case 'd': /* KERN_DEFAULT */
600 /* multi digit including the level and facility number */
603 lev = (simple_strtoul(&p[1], &endp, 10) & 7);
604 if (endp == NULL || endp[0] != '>')
606 len = (endp + 1) - p;
609 /* do not accept special char if not asked for */
615 /* return special char, do not touch level */
626 * Call the console drivers, asking them to write out
627 * log_buf[start] to log_buf[end - 1].
628 * The console_lock must be held.
630 static void call_console_drivers(unsigned start, unsigned end)
632 unsigned cur_index, start_print;
633 static int msg_level = -1;
635 BUG_ON(((int)(start - end)) > 0);
639 while (cur_index != end) {
640 if (msg_level < 0 && ((end - cur_index) > 2)) {
641 /* strip log prefix */
642 cur_index += log_prefix(&LOG_BUF(cur_index), &msg_level, NULL);
643 start_print = cur_index;
645 while (cur_index != end) {
646 char c = LOG_BUF(cur_index);
652 * printk() has already given us loglevel tags in
653 * the buffer. This code is here in case the
654 * log buffer has wrapped right round and scribbled
657 msg_level = default_message_loglevel;
659 _call_console_drivers(start_print, cur_index, msg_level);
661 start_print = cur_index;
666 _call_console_drivers(start_print, end, msg_level);
669 static void emit_log_char(char c)
671 LOG_BUF(log_end) = c;
673 if (log_end - log_start > log_buf_len)
674 log_start = log_end - log_buf_len;
675 if (log_end - con_start > log_buf_len)
676 con_start = log_end - log_buf_len;
677 if (logged_chars < log_buf_len)
682 * Zap console related locks when oopsing. Only zap at most once
683 * every 10 seconds, to leave time for slow consoles to print a
686 static void zap_locks(void)
688 static unsigned long oops_timestamp;
690 if (time_after_eq(jiffies, oops_timestamp) &&
691 !time_after(jiffies, oops_timestamp + 30 * HZ))
694 oops_timestamp = jiffies;
697 /* If a crash is occurring, make sure we can't deadlock */
698 raw_spin_lock_init(&logbuf_lock);
699 /* And make sure that we print immediately */
700 sema_init(&console_sem, 1);
703 #if defined(CONFIG_PRINTK_TIME)
704 static bool printk_time = 1;
706 static bool printk_time = 0;
708 module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
710 static bool always_kmsg_dump;
711 module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);
713 /* Check if we have any console registered that can be called early in boot. */
714 static int have_callable_console(void)
718 for_each_console(con)
719 if (con->flags & CON_ANYTIME)
726 * printk - print a kernel message
727 * @fmt: format string
729 * This is printk(). It can be called from any context. We want it to work.
731 * We try to grab the console_lock. If we succeed, it's easy - we log the output and
732 * call the console drivers. If we fail to get the semaphore we place the output
733 * into the log buffer and return. The current holder of the console_sem will
734 * notice the new output in console_unlock(); and will send it to the
735 * consoles before releasing the lock.
737 * One effect of this deferred printing is that code which calls printk() and
738 * then changes console_loglevel may break. This is because console_loglevel
739 * is inspected when the actual printing occurs.
744 * See the vsnprintf() documentation for format string extensions over C99.
747 asmlinkage int printk(const char *fmt, ...)
752 #ifdef CONFIG_KGDB_KDB
753 if (unlikely(kdb_trap_printk)) {
755 r = vkdb_printf(fmt, args);
761 r = vprintk(fmt, args);
767 /* cpu currently holding logbuf_lock */
768 static volatile unsigned int printk_cpu = UINT_MAX;
771 * Can we actually use the console at this time on this cpu?
773 * Console drivers may assume that per-cpu resources have
774 * been allocated. So unless they're explicitly marked as
775 * being able to cope (CON_ANYTIME) don't call them until
776 * this CPU is officially up.
778 static inline int can_use_console(unsigned int cpu)
780 return cpu_online(cpu) || have_callable_console();
784 * Try to get console ownership to actually show the kernel
785 * messages from a 'printk'. Return true (and with the
786 * console_lock held, and 'console_locked' set) if it
787 * is successful, false otherwise.
789 * This gets called with the 'logbuf_lock' spinlock held and
790 * interrupts disabled. It should return with 'lockbuf_lock'
791 * released but interrupts still disabled.
793 static int console_trylock_for_printk(unsigned int cpu)
794 __releases(&logbuf_lock)
796 int retval = 0, wake = 0;
798 if (console_trylock()) {
802 * If we can't use the console, we need to release
803 * the console semaphore by hand to avoid flushing
804 * the buffer. We need to hold the console semaphore
805 * in order to do this test safely.
807 if (!can_use_console(cpu)) {
813 printk_cpu = UINT_MAX;
816 raw_spin_unlock(&logbuf_lock);
819 static const char recursion_bug_msg [] =
820 KERN_CRIT "BUG: recent printk recursion!\n";
821 static int recursion_bug;
822 static int new_text_line = 1;
823 static char printk_buf[1024];
825 int printk_delay_msec __read_mostly;
827 static inline void printk_delay(void)
829 if (unlikely(printk_delay_msec)) {
830 int m = printk_delay_msec;
834 touch_nmi_watchdog();
839 asmlinkage int vprintk(const char *fmt, va_list args)
842 int current_log_level = default_message_loglevel;
852 /* This stops the holder of console_sem just where we want him */
853 local_irq_save(flags);
854 this_cpu = smp_processor_id();
857 * Ouch, printk recursed into itself!
859 if (unlikely(printk_cpu == this_cpu)) {
861 * If a crash is occurring during printk() on this CPU,
862 * then try to get the crash message out but make sure
863 * we can't deadlock. Otherwise just return to avoid the
864 * recursion and return - but flag the recursion so that
865 * it can be printed at the next appropriate moment:
867 if (!oops_in_progress && !lockdep_recursing(current)) {
869 goto out_restore_irqs;
875 raw_spin_lock(&logbuf_lock);
876 printk_cpu = this_cpu;
880 strcpy(printk_buf, recursion_bug_msg);
881 printed_len = strlen(recursion_bug_msg);
883 /* Emit the output into the temporary buffer */
884 printed_len += vscnprintf(printk_buf + printed_len,
885 sizeof(printk_buf) - printed_len, fmt, args);
889 /* Read log level and handle special printk prefix */
890 plen = log_prefix(p, ¤t_log_level, &special);
895 case 'c': /* Strip <c> KERN_CONT, continue line */
898 case 'd': /* Strip <d> KERN_DEFAULT, start new line */
901 if (!new_text_line) {
909 * Copy the output into log_buf. If the caller didn't provide
910 * the appropriate log prefix, we insert them here
917 /* Copy original log prefix */
920 for (i = 0; i < plen; i++)
921 emit_log_char(printk_buf[i]);
926 emit_log_char(current_log_level + '0');
932 /* Add the current time stamp */
935 unsigned long long t;
936 unsigned long nanosec_rem;
938 t = cpu_clock(printk_cpu);
939 nanosec_rem = do_div(t, 1000000000);
940 tlen = sprintf(tbuf, "[%5lu.%06lu] ",
944 for (tp = tbuf; tp < tbuf + tlen; tp++)
959 * Try to acquire and then immediately release the
960 * console semaphore. The release will do all the
961 * actual magic (print out buffers, wake up klogd,
964 * The console_trylock_for_printk() function
965 * will release 'logbuf_lock' regardless of whether it
966 * actually gets the semaphore or not.
968 if (console_trylock_for_printk(this_cpu))
973 local_irq_restore(flags);
977 EXPORT_SYMBOL(printk);
978 EXPORT_SYMBOL(vprintk);
982 static void call_console_drivers(unsigned start, unsigned end)
988 static int __add_preferred_console(char *name, int idx, char *options,
991 struct console_cmdline *c;
995 * See if this tty is not yet registered, and
996 * if we have a slot free.
998 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
999 if (strcmp(console_cmdline[i].name, name) == 0 &&
1000 console_cmdline[i].index == idx) {
1002 selected_console = i;
1005 if (i == MAX_CMDLINECONSOLES)
1008 selected_console = i;
1009 c = &console_cmdline[i];
1010 strlcpy(c->name, name, sizeof(c->name));
1011 c->options = options;
1012 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1013 c->brl_options = brl_options;
1019 * Set up a list of consoles. Called from init/main.c
1021 static int __init console_setup(char *str)
1023 char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for index */
1024 char *s, *options, *brl_options = NULL;
1027 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1028 if (!memcmp(str, "brl,", 4)) {
1031 } else if (!memcmp(str, "brl=", 4)) {
1032 brl_options = str + 4;
1033 str = strchr(brl_options, ',');
1035 printk(KERN_ERR "need port name after brl=\n");
1043 * Decode str into name, index, options.
1045 if (str[0] >= '0' && str[0] <= '9') {
1046 strcpy(buf, "ttyS");
1047 strncpy(buf + 4, str, sizeof(buf) - 5);
1049 strncpy(buf, str, sizeof(buf) - 1);
1051 buf[sizeof(buf) - 1] = 0;
1052 if ((options = strchr(str, ',')) != NULL)
1055 if (!strcmp(str, "ttya"))
1056 strcpy(buf, "ttyS0");
1057 if (!strcmp(str, "ttyb"))
1058 strcpy(buf, "ttyS1");
1060 for (s = buf; *s; s++)
1061 if ((*s >= '0' && *s <= '9') || *s == ',')
1063 idx = simple_strtoul(s, NULL, 10);
1066 __add_preferred_console(buf, idx, options, brl_options);
1067 console_set_on_cmdline = 1;
1070 __setup("console=", console_setup);
1073 * add_preferred_console - add a device to the list of preferred consoles.
1074 * @name: device name
1075 * @idx: device index
1076 * @options: options for this console
1078 * The last preferred console added will be used for kernel messages
1079 * and stdin/out/err for init. Normally this is used by console_setup
1080 * above to handle user-supplied console arguments; however it can also
1081 * be used by arch-specific code either to override the user or more
1082 * commonly to provide a default console (ie from PROM variables) when
1083 * the user has not supplied one.
1085 int add_preferred_console(char *name, int idx, char *options)
1087 return __add_preferred_console(name, idx, options, NULL);
1090 int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options)
1092 struct console_cmdline *c;
1095 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
1096 if (strcmp(console_cmdline[i].name, name) == 0 &&
1097 console_cmdline[i].index == idx) {
1098 c = &console_cmdline[i];
1099 strlcpy(c->name, name_new, sizeof(c->name));
1100 c->name[sizeof(c->name) - 1] = 0;
1101 c->options = options;
1109 bool console_suspend_enabled = 1;
1110 EXPORT_SYMBOL(console_suspend_enabled);
1112 static int __init console_suspend_disable(char *str)
1114 console_suspend_enabled = 0;
1117 __setup("no_console_suspend", console_suspend_disable);
1118 module_param_named(console_suspend, console_suspend_enabled,
1119 bool, S_IRUGO | S_IWUSR);
1120 MODULE_PARM_DESC(console_suspend, "suspend console during suspend"
1121 " and hibernate operations");
1124 * suspend_console - suspend the console subsystem
1126 * This disables printk() while we go into suspend states
1128 void suspend_console(void)
1130 if (!console_suspend_enabled)
1132 printk("Suspending console(s) (use no_console_suspend to debug)\n");
1134 console_suspended = 1;
1138 void resume_console(void)
1140 if (!console_suspend_enabled)
1143 console_suspended = 0;
1148 * console_cpu_notify - print deferred console messages after CPU hotplug
1149 * @self: notifier struct
1150 * @action: CPU hotplug event
1153 * If printk() is called from a CPU that is not online yet, the messages
1154 * will be spooled but will not show up on the console. This function is
1155 * called when a new CPU comes online (or fails to come up), and ensures
1156 * that any such output gets printed.
1158 static int __cpuinit console_cpu_notify(struct notifier_block *self,
1159 unsigned long action, void *hcpu)
1165 case CPU_DOWN_FAILED:
1166 case CPU_UP_CANCELED:
1174 * console_lock - lock the console system for exclusive use.
1176 * Acquires a lock which guarantees that the caller has
1177 * exclusive access to the console system and the console_drivers list.
1179 * Can sleep, returns nothing.
1181 void console_lock(void)
1183 BUG_ON(in_interrupt());
1185 if (console_suspended)
1188 console_may_schedule = 1;
1190 EXPORT_SYMBOL(console_lock);
1193 * console_trylock - try to lock the console system for exclusive use.
1195 * Tried to acquire a lock which guarantees that the caller has
1196 * exclusive access to the console system and the console_drivers list.
1198 * returns 1 on success, and 0 on failure to acquire the lock.
1200 int console_trylock(void)
1202 if (down_trylock(&console_sem))
1204 if (console_suspended) {
1209 console_may_schedule = 0;
1212 EXPORT_SYMBOL(console_trylock);
1214 int is_console_locked(void)
1216 return console_locked;
1220 * Delayed printk facility, for scheduler-internal messages:
1222 #define PRINTK_BUF_SIZE 512
1224 #define PRINTK_PENDING_WAKEUP 0x01
1225 #define PRINTK_PENDING_SCHED 0x02
1227 static DEFINE_PER_CPU(int, printk_pending);
1228 static DEFINE_PER_CPU(char [PRINTK_BUF_SIZE], printk_sched_buf);
1230 void printk_tick(void)
1232 if (__this_cpu_read(printk_pending)) {
1233 int pending = __this_cpu_xchg(printk_pending, 0);
1234 if (pending & PRINTK_PENDING_SCHED) {
1235 char *buf = __get_cpu_var(printk_sched_buf);
1236 printk(KERN_WARNING "[sched_delayed] %s", buf);
1238 if (pending & PRINTK_PENDING_WAKEUP)
1239 wake_up_interruptible(&log_wait);
1243 int printk_needs_cpu(int cpu)
1245 if (cpu_is_offline(cpu))
1247 return __this_cpu_read(printk_pending);
1250 void wake_up_klogd(void)
1252 if (waitqueue_active(&log_wait))
1253 this_cpu_or(printk_pending, PRINTK_PENDING_WAKEUP);
1257 * console_unlock - unlock the console system
1259 * Releases the console_lock which the caller holds on the console system
1260 * and the console driver list.
1262 * While the console_lock was held, console output may have been buffered
1263 * by printk(). If this is the case, console_unlock(); emits
1264 * the output prior to releasing the lock.
1266 * If there is output waiting for klogd, we wake it up.
1268 * console_unlock(); may be called from any context.
1270 void console_unlock(void)
1272 unsigned long flags;
1273 unsigned _con_start, _log_end;
1274 unsigned wake_klogd = 0, retry = 0;
1276 if (console_suspended) {
1281 console_may_schedule = 0;
1285 raw_spin_lock_irqsave(&logbuf_lock, flags);
1286 wake_klogd |= log_start - log_end;
1287 if (con_start == log_end)
1288 break; /* Nothing to print */
1289 _con_start = con_start;
1291 con_start = log_end; /* Flush */
1292 raw_spin_unlock(&logbuf_lock);
1293 stop_critical_timings(); /* don't trace print latency */
1294 call_console_drivers(_con_start, _log_end);
1295 start_critical_timings();
1296 local_irq_restore(flags);
1300 /* Release the exclusive_console once it is used */
1301 if (unlikely(exclusive_console))
1302 exclusive_console = NULL;
1304 raw_spin_unlock(&logbuf_lock);
1309 * Someone could have filled up the buffer again, so re-check if there's
1310 * something to flush. In case we cannot trylock the console_sem again,
1311 * there's a new owner and the console_unlock() from them will do the
1312 * flush, no worries.
1314 raw_spin_lock(&logbuf_lock);
1315 if (con_start != log_end)
1317 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
1319 if (retry && console_trylock())
1325 EXPORT_SYMBOL(console_unlock);
1328 * console_conditional_schedule - yield the CPU if required
1330 * If the console code is currently allowed to sleep, and
1331 * if this CPU should yield the CPU to another task, do
1334 * Must be called within console_lock();.
1336 void __sched console_conditional_schedule(void)
1338 if (console_may_schedule)
1341 EXPORT_SYMBOL(console_conditional_schedule);
1343 void console_unblank(void)
1348 * console_unblank can no longer be called in interrupt context unless
1349 * oops_in_progress is set to 1..
1351 if (oops_in_progress) {
1352 if (down_trylock(&console_sem) != 0)
1358 console_may_schedule = 0;
1360 if ((c->flags & CON_ENABLED) && c->unblank)
1366 * Return the console tty driver structure and its associated index
1368 struct tty_driver *console_device(int *index)
1371 struct tty_driver *driver = NULL;
1374 for_each_console(c) {
1377 driver = c->device(c, index);
1386 * Prevent further output on the passed console device so that (for example)
1387 * serial drivers can disable console output before suspending a port, and can
1388 * re-enable output afterwards.
1390 void console_stop(struct console *console)
1393 console->flags &= ~CON_ENABLED;
1396 EXPORT_SYMBOL(console_stop);
1398 void console_start(struct console *console)
1401 console->flags |= CON_ENABLED;
1404 EXPORT_SYMBOL(console_start);
1406 static int __read_mostly keep_bootcon;
1408 static int __init keep_bootcon_setup(char *str)
1411 printk(KERN_INFO "debug: skip boot console de-registration.\n");
1416 early_param("keep_bootcon", keep_bootcon_setup);
1419 * The console driver calls this routine during kernel initialization
1420 * to register the console printing procedure with printk() and to
1421 * print any messages that were printed by the kernel before the
1422 * console driver was initialized.
1424 * This can happen pretty early during the boot process (because of
1425 * early_printk) - sometimes before setup_arch() completes - be careful
1426 * of what kernel features are used - they may not be initialised yet.
1428 * There are two types of consoles - bootconsoles (early_printk) and
1429 * "real" consoles (everything which is not a bootconsole) which are
1430 * handled differently.
1431 * - Any number of bootconsoles can be registered at any time.
1432 * - As soon as a "real" console is registered, all bootconsoles
1433 * will be unregistered automatically.
1434 * - Once a "real" console is registered, any attempt to register a
1435 * bootconsoles will be rejected
1437 void register_console(struct console *newcon)
1440 unsigned long flags;
1441 struct console *bcon = NULL;
1444 * before we register a new CON_BOOT console, make sure we don't
1445 * already have a valid console
1447 if (console_drivers && newcon->flags & CON_BOOT) {
1448 /* find the last or real console */
1449 for_each_console(bcon) {
1450 if (!(bcon->flags & CON_BOOT)) {
1451 printk(KERN_INFO "Too late to register bootconsole %s%d\n",
1452 newcon->name, newcon->index);
1458 if (console_drivers && console_drivers->flags & CON_BOOT)
1459 bcon = console_drivers;
1461 if (preferred_console < 0 || bcon || !console_drivers)
1462 preferred_console = selected_console;
1464 if (newcon->early_setup)
1465 newcon->early_setup();
1468 * See if we want to use this console driver. If we
1469 * didn't select a console we take the first one
1470 * that registers here.
1472 if (preferred_console < 0) {
1473 if (newcon->index < 0)
1475 if (newcon->setup == NULL ||
1476 newcon->setup(newcon, NULL) == 0) {
1477 newcon->flags |= CON_ENABLED;
1478 if (newcon->device) {
1479 newcon->flags |= CON_CONSDEV;
1480 preferred_console = 0;
1486 * See if this console matches one we selected on
1489 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0];
1491 if (strcmp(console_cmdline[i].name, newcon->name) != 0)
1493 if (newcon->index >= 0 &&
1494 newcon->index != console_cmdline[i].index)
1496 if (newcon->index < 0)
1497 newcon->index = console_cmdline[i].index;
1498 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1499 if (console_cmdline[i].brl_options) {
1500 newcon->flags |= CON_BRL;
1501 braille_register_console(newcon,
1502 console_cmdline[i].index,
1503 console_cmdline[i].options,
1504 console_cmdline[i].brl_options);
1508 if (newcon->setup &&
1509 newcon->setup(newcon, console_cmdline[i].options) != 0)
1511 newcon->flags |= CON_ENABLED;
1512 newcon->index = console_cmdline[i].index;
1513 if (i == selected_console) {
1514 newcon->flags |= CON_CONSDEV;
1515 preferred_console = selected_console;
1520 if (!(newcon->flags & CON_ENABLED))
1524 * If we have a bootconsole, and are switching to a real console,
1525 * don't print everything out again, since when the boot console, and
1526 * the real console are the same physical device, it's annoying to
1527 * see the beginning boot messages twice
1529 if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
1530 newcon->flags &= ~CON_PRINTBUFFER;
1533 * Put this console in the list - keep the
1534 * preferred driver at the head of the list.
1537 if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
1538 newcon->next = console_drivers;
1539 console_drivers = newcon;
1541 newcon->next->flags &= ~CON_CONSDEV;
1543 newcon->next = console_drivers->next;
1544 console_drivers->next = newcon;
1546 if (newcon->flags & CON_PRINTBUFFER) {
1548 * console_unlock(); will print out the buffered messages
1551 raw_spin_lock_irqsave(&logbuf_lock, flags);
1552 con_start = log_start;
1553 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
1555 * We're about to replay the log buffer. Only do this to the
1556 * just-registered console to avoid excessive message spam to
1557 * the already-registered consoles.
1559 exclusive_console = newcon;
1562 console_sysfs_notify();
1565 * By unregistering the bootconsoles after we enable the real console
1566 * we get the "console xxx enabled" message on all the consoles -
1567 * boot consoles, real consoles, etc - this is to ensure that end
1568 * users know there might be something in the kernel's log buffer that
1569 * went to the bootconsole (that they do not see on the real console)
1572 ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
1574 /* we need to iterate through twice, to make sure we print
1575 * everything out, before we unregister the console(s)
1577 printk(KERN_INFO "console [%s%d] enabled, bootconsole disabled\n",
1578 newcon->name, newcon->index);
1579 for_each_console(bcon)
1580 if (bcon->flags & CON_BOOT)
1581 unregister_console(bcon);
1583 printk(KERN_INFO "%sconsole [%s%d] enabled\n",
1584 (newcon->flags & CON_BOOT) ? "boot" : "" ,
1585 newcon->name, newcon->index);
1588 EXPORT_SYMBOL(register_console);
1590 int unregister_console(struct console *console)
1592 struct console *a, *b;
1595 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1596 if (console->flags & CON_BRL)
1597 return braille_unregister_console(console);
1601 if (console_drivers == console) {
1602 console_drivers=console->next;
1604 } else if (console_drivers) {
1605 for (a=console_drivers->next, b=console_drivers ;
1606 a; b=a, a=b->next) {
1616 * If this isn't the last console and it has CON_CONSDEV set, we
1617 * need to set it on the next preferred console.
1619 if (console_drivers != NULL && console->flags & CON_CONSDEV)
1620 console_drivers->flags |= CON_CONSDEV;
1623 console_sysfs_notify();
1626 EXPORT_SYMBOL(unregister_console);
1628 static int __init printk_late_init(void)
1630 struct console *con;
1632 for_each_console(con) {
1633 if (!keep_bootcon && con->flags & CON_BOOT) {
1634 printk(KERN_INFO "turn off boot console %s%d\n",
1635 con->name, con->index);
1636 unregister_console(con);
1639 hotcpu_notifier(console_cpu_notify, 0);
1642 late_initcall(printk_late_init);
1644 #if defined CONFIG_PRINTK
1646 int printk_sched(const char *fmt, ...)
1648 unsigned long flags;
1653 local_irq_save(flags);
1654 buf = __get_cpu_var(printk_sched_buf);
1656 va_start(args, fmt);
1657 r = vsnprintf(buf, PRINTK_BUF_SIZE, fmt, args);
1660 __this_cpu_or(printk_pending, PRINTK_PENDING_SCHED);
1661 local_irq_restore(flags);
1667 * printk rate limiting, lifted from the networking subsystem.
1669 * This enforces a rate limit: not more than 10 kernel messages
1670 * every 5s to make a denial-of-service attack impossible.
1672 DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
1674 int __printk_ratelimit(const char *func)
1676 return ___ratelimit(&printk_ratelimit_state, func);
1678 EXPORT_SYMBOL(__printk_ratelimit);
1681 * printk_timed_ratelimit - caller-controlled printk ratelimiting
1682 * @caller_jiffies: pointer to caller's state
1683 * @interval_msecs: minimum interval between prints
1685 * printk_timed_ratelimit() returns true if more than @interval_msecs
1686 * milliseconds have elapsed since the last time printk_timed_ratelimit()
1689 bool printk_timed_ratelimit(unsigned long *caller_jiffies,
1690 unsigned int interval_msecs)
1692 if (*caller_jiffies == 0
1693 || !time_in_range(jiffies, *caller_jiffies,
1695 + msecs_to_jiffies(interval_msecs))) {
1696 *caller_jiffies = jiffies;
1701 EXPORT_SYMBOL(printk_timed_ratelimit);
1703 static DEFINE_SPINLOCK(dump_list_lock);
1704 static LIST_HEAD(dump_list);
1707 * kmsg_dump_register - register a kernel log dumper.
1708 * @dumper: pointer to the kmsg_dumper structure
1710 * Adds a kernel log dumper to the system. The dump callback in the
1711 * structure will be called when the kernel oopses or panics and must be
1712 * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
1714 int kmsg_dump_register(struct kmsg_dumper *dumper)
1716 unsigned long flags;
1719 /* The dump callback needs to be set */
1723 spin_lock_irqsave(&dump_list_lock, flags);
1724 /* Don't allow registering multiple times */
1725 if (!dumper->registered) {
1726 dumper->registered = 1;
1727 list_add_tail_rcu(&dumper->list, &dump_list);
1730 spin_unlock_irqrestore(&dump_list_lock, flags);
1734 EXPORT_SYMBOL_GPL(kmsg_dump_register);
1737 * kmsg_dump_unregister - unregister a kmsg dumper.
1738 * @dumper: pointer to the kmsg_dumper structure
1740 * Removes a dump device from the system. Returns zero on success and
1741 * %-EINVAL otherwise.
1743 int kmsg_dump_unregister(struct kmsg_dumper *dumper)
1745 unsigned long flags;
1748 spin_lock_irqsave(&dump_list_lock, flags);
1749 if (dumper->registered) {
1750 dumper->registered = 0;
1751 list_del_rcu(&dumper->list);
1754 spin_unlock_irqrestore(&dump_list_lock, flags);
1759 EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
1762 * kmsg_dump - dump kernel log to kernel message dumpers.
1763 * @reason: the reason (oops, panic etc) for dumping
1765 * Iterate through each of the dump devices and call the oops/panic
1766 * callbacks with the log buffer.
1768 void kmsg_dump(enum kmsg_dump_reason reason)
1772 struct kmsg_dumper *dumper;
1773 const char *s1, *s2;
1774 unsigned long l1, l2;
1775 unsigned long flags;
1777 if ((reason > KMSG_DUMP_OOPS) && !always_kmsg_dump)
1780 /* Theoretically, the log could move on after we do this, but
1781 there's not a lot we can do about that. The new messages
1782 will overwrite the start of what we dump. */
1783 raw_spin_lock_irqsave(&logbuf_lock, flags);
1784 end = log_end & LOG_BUF_MASK;
1785 chars = logged_chars;
1786 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
1789 s1 = log_buf + log_buf_len - chars + end;
1798 s2 = log_buf + end - chars;
1803 list_for_each_entry_rcu(dumper, &dump_list, list)
1804 dumper->dump(dumper, reason, s1, l1, s2, l2);