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>
48 * Architectures can override it:
50 void asmlinkage __attribute__((weak)) early_printk(const char *fmt, ...)
54 #define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
56 /* printk's without a loglevel use this.. */
57 #define DEFAULT_MESSAGE_LOGLEVEL CONFIG_DEFAULT_MESSAGE_LOGLEVEL
59 /* We show everything that is MORE important than this.. */
60 #define MINIMUM_CONSOLE_LOGLEVEL 1 /* Minimum loglevel we let people use */
61 #define DEFAULT_CONSOLE_LOGLEVEL 7 /* anything MORE serious than KERN_DEBUG */
63 DECLARE_WAIT_QUEUE_HEAD(log_wait);
65 int console_printk[4] = {
66 DEFAULT_CONSOLE_LOGLEVEL, /* console_loglevel */
67 DEFAULT_MESSAGE_LOGLEVEL, /* default_message_loglevel */
68 MINIMUM_CONSOLE_LOGLEVEL, /* minimum_console_loglevel */
69 DEFAULT_CONSOLE_LOGLEVEL, /* default_console_loglevel */
73 * Low level drivers may need that to know if they can schedule in
74 * their unblank() callback or not. So let's export it.
77 EXPORT_SYMBOL(oops_in_progress);
80 * console_sem protects the console_drivers list, and also
81 * provides serialisation for access to the entire console
84 static DEFINE_SEMAPHORE(console_sem);
85 struct console *console_drivers;
86 EXPORT_SYMBOL_GPL(console_drivers);
89 * This is used for debugging the mess that is the VT code by
90 * keeping track if we have the console semaphore held. It's
91 * definitely not the perfect debug tool (we don't know if _WE_
92 * hold it are racing, but it helps tracking those weird code
93 * path in the console code where we end up in places I want
94 * locked without the console sempahore held
96 static int console_locked, console_suspended;
99 * logbuf_lock protects log_buf, log_start, log_end, con_start and logged_chars
100 * It is also used in interesting ways to provide interlocking in
103 static DEFINE_RAW_SPINLOCK(logbuf_lock);
105 #define LOG_BUF_MASK (log_buf_len-1)
106 #define LOG_BUF(idx) (log_buf[(idx) & LOG_BUF_MASK])
109 * The indices into log_buf are not constrained to log_buf_len - they
110 * must be masked before subscripting
112 static unsigned log_start; /* Index into log_buf: next char to be read by syslog() */
113 static unsigned con_start; /* Index into log_buf: next char to be sent to consoles */
114 static unsigned log_end; /* Index into log_buf: most-recently-written-char + 1 */
117 * If exclusive_console is non-NULL then only this console is to be printed to.
119 static struct console *exclusive_console;
122 * Array of consoles built from command line options (console=)
124 struct console_cmdline
126 char name[8]; /* Name of the driver */
127 int index; /* Minor dev. to use */
128 char *options; /* Options for the driver */
129 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
130 char *brl_options; /* Options for braille driver */
134 #define MAX_CMDLINECONSOLES 8
136 static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
137 static int selected_console = -1;
138 static int preferred_console = -1;
139 int console_set_on_cmdline;
140 EXPORT_SYMBOL(console_set_on_cmdline);
142 /* Flag: console code may call schedule() */
143 static int console_may_schedule;
147 static char __log_buf[__LOG_BUF_LEN];
148 static char *log_buf = __log_buf;
149 static int log_buf_len = __LOG_BUF_LEN;
150 static unsigned logged_chars; /* Number of chars produced since last read+clear operation */
151 static int saved_console_loglevel = -1;
155 * This appends the listed symbols to /proc/vmcoreinfo
157 * /proc/vmcoreinfo is used by various utiilties, like crash and makedumpfile to
158 * obtain access to symbols that are otherwise very difficult to locate. These
159 * symbols are specifically used so that utilities can access and extract the
160 * dmesg log from a vmcore file after a crash.
162 void log_buf_kexec_setup(void)
164 VMCOREINFO_SYMBOL(log_buf);
165 VMCOREINFO_SYMBOL(log_end);
166 VMCOREINFO_SYMBOL(log_buf_len);
167 VMCOREINFO_SYMBOL(logged_chars);
171 /* requested log_buf_len from kernel cmdline */
172 static unsigned long __initdata new_log_buf_len;
174 /* save requested log_buf_len since it's too early to process it */
175 static int __init log_buf_len_setup(char *str)
177 unsigned size = memparse(str, &str);
180 size = roundup_pow_of_two(size);
181 if (size > log_buf_len)
182 new_log_buf_len = size;
186 early_param("log_buf_len", log_buf_len_setup);
188 void __init setup_log_buf(int early)
191 unsigned start, dest_idx, offset;
195 if (!new_log_buf_len)
201 mem = memblock_alloc(new_log_buf_len, PAGE_SIZE);
202 if (mem == MEMBLOCK_ERROR)
204 new_log_buf = __va(mem);
206 new_log_buf = alloc_bootmem_nopanic(new_log_buf_len);
209 if (unlikely(!new_log_buf)) {
210 pr_err("log_buf_len: %ld bytes not available\n",
215 raw_spin_lock_irqsave(&logbuf_lock, flags);
216 log_buf_len = new_log_buf_len;
217 log_buf = new_log_buf;
219 free = __LOG_BUF_LEN - log_end;
221 offset = start = min(con_start, log_start);
223 while (start != log_end) {
224 unsigned log_idx_mask = start & (__LOG_BUF_LEN - 1);
226 log_buf[dest_idx] = __log_buf[log_idx_mask];
233 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
235 pr_info("log_buf_len: %d\n", log_buf_len);
236 pr_info("early log buf free: %d(%d%%)\n",
237 free, (free * 100) / __LOG_BUF_LEN);
240 #ifdef CONFIG_BOOT_PRINTK_DELAY
242 static int boot_delay; /* msecs delay after each printk during bootup */
243 static unsigned long long loops_per_msec; /* based on boot_delay */
245 static int __init boot_delay_setup(char *str)
249 lpj = preset_lpj ? preset_lpj : 1000000; /* some guess */
250 loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
252 get_option(&str, &boot_delay);
253 if (boot_delay > 10 * 1000)
256 pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
257 "HZ: %d, loops_per_msec: %llu\n",
258 boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
261 __setup("boot_delay=", boot_delay_setup);
263 static void boot_delay_msec(void)
265 unsigned long long k;
266 unsigned long timeout;
268 if (boot_delay == 0 || system_state != SYSTEM_BOOTING)
271 k = (unsigned long long)loops_per_msec * boot_delay;
273 timeout = jiffies + msecs_to_jiffies(boot_delay);
278 * use (volatile) jiffies to prevent
279 * compiler reduction; loop termination via jiffies
280 * is secondary and may or may not happen.
282 if (time_after(jiffies, timeout))
284 touch_nmi_watchdog();
288 static inline void boot_delay_msec(void)
293 #ifdef CONFIG_SECURITY_DMESG_RESTRICT
294 int dmesg_restrict = 1;
299 static int syslog_action_restricted(int type)
303 /* Unless restricted, we allow "read all" and "get buffer size" for everybody */
304 return type != SYSLOG_ACTION_READ_ALL && type != SYSLOG_ACTION_SIZE_BUFFER;
307 static int check_syslog_permissions(int type, bool from_file)
310 * If this is from /proc/kmsg and we've already opened it, then we've
311 * already done the capabilities checks at open time.
313 if (from_file && type != SYSLOG_ACTION_OPEN)
316 if (syslog_action_restricted(type)) {
317 if (capable(CAP_SYSLOG))
319 /* For historical reasons, accept CAP_SYS_ADMIN too, with a warning */
320 if (capable(CAP_SYS_ADMIN)) {
321 printk_once(KERN_WARNING "%s (%d): "
322 "Attempt to access syslog with CAP_SYS_ADMIN "
323 "but no CAP_SYSLOG (deprecated).\n",
324 current->comm, task_pid_nr(current));
332 int do_syslog(int type, char __user *buf, int len, bool from_file)
334 unsigned i, j, limit, count;
339 error = check_syslog_permissions(type, from_file);
343 error = security_syslog(type);
348 case SYSLOG_ACTION_CLOSE: /* Close log */
350 case SYSLOG_ACTION_OPEN: /* Open log */
352 case SYSLOG_ACTION_READ: /* Read from log */
359 if (!access_ok(VERIFY_WRITE, buf, len)) {
363 error = wait_event_interruptible(log_wait,
364 (log_start - log_end));
368 raw_spin_lock_irq(&logbuf_lock);
369 while (!error && (log_start != log_end) && i < len) {
370 c = LOG_BUF(log_start);
372 raw_spin_unlock_irq(&logbuf_lock);
373 error = __put_user(c,buf);
377 raw_spin_lock_irq(&logbuf_lock);
379 raw_spin_unlock_irq(&logbuf_lock);
383 /* Read/clear last kernel messages */
384 case SYSLOG_ACTION_READ_CLEAR:
387 /* Read last kernel messages */
388 case SYSLOG_ACTION_READ_ALL:
395 if (!access_ok(VERIFY_WRITE, buf, len)) {
400 if (count > log_buf_len)
402 raw_spin_lock_irq(&logbuf_lock);
403 if (count > logged_chars)
404 count = logged_chars;
409 * __put_user() could sleep, and while we sleep
410 * printk() could overwrite the messages
411 * we try to copy to user space. Therefore
412 * the messages are copied in reverse. <manfreds>
414 for (i = 0; i < count && !error; i++) {
416 if (j + log_buf_len < log_end)
419 raw_spin_unlock_irq(&logbuf_lock);
420 error = __put_user(c,&buf[count-1-i]);
422 raw_spin_lock_irq(&logbuf_lock);
424 raw_spin_unlock_irq(&logbuf_lock);
429 int offset = count-error;
430 /* buffer overflow during copy, correct user buffer. */
431 for (i = 0; i < error; i++) {
432 if (__get_user(c,&buf[i+offset]) ||
433 __put_user(c,&buf[i])) {
441 /* Clear ring buffer */
442 case SYSLOG_ACTION_CLEAR:
445 /* Disable logging to console */
446 case SYSLOG_ACTION_CONSOLE_OFF:
447 if (saved_console_loglevel == -1)
448 saved_console_loglevel = console_loglevel;
449 console_loglevel = minimum_console_loglevel;
451 /* Enable logging to console */
452 case SYSLOG_ACTION_CONSOLE_ON:
453 if (saved_console_loglevel != -1) {
454 console_loglevel = saved_console_loglevel;
455 saved_console_loglevel = -1;
458 /* Set level of messages printed to console */
459 case SYSLOG_ACTION_CONSOLE_LEVEL:
461 if (len < 1 || len > 8)
463 if (len < minimum_console_loglevel)
464 len = minimum_console_loglevel;
465 console_loglevel = len;
466 /* Implicitly re-enable logging to console */
467 saved_console_loglevel = -1;
470 /* Number of chars in the log buffer */
471 case SYSLOG_ACTION_SIZE_UNREAD:
472 error = log_end - log_start;
474 /* Size of the log buffer */
475 case SYSLOG_ACTION_SIZE_BUFFER:
486 SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
488 return do_syslog(type, buf, len, SYSLOG_FROM_CALL);
491 #ifdef CONFIG_KGDB_KDB
492 /* kdb dmesg command needs access to the syslog buffer. do_syslog()
493 * uses locks so it cannot be used during debugging. Just tell kdb
494 * where the start and end of the physical and logical logs are. This
495 * is equivalent to do_syslog(3).
497 void kdb_syslog_data(char *syslog_data[4])
499 syslog_data[0] = log_buf;
500 syslog_data[1] = log_buf + log_buf_len;
501 syslog_data[2] = log_buf + log_end -
502 (logged_chars < log_buf_len ? logged_chars : log_buf_len);
503 syslog_data[3] = log_buf + log_end;
505 #endif /* CONFIG_KGDB_KDB */
508 * Call the console drivers on a range of log_buf
510 static void __call_console_drivers(unsigned start, unsigned end)
514 for_each_console(con) {
515 if (exclusive_console && con != exclusive_console)
517 if ((con->flags & CON_ENABLED) && con->write &&
518 (cpu_online(smp_processor_id()) ||
519 (con->flags & CON_ANYTIME)))
520 con->write(con, &LOG_BUF(start), end - start);
524 static int __read_mostly ignore_loglevel;
526 static int __init ignore_loglevel_setup(char *str)
529 printk(KERN_INFO "debug: ignoring loglevel setting.\n");
534 early_param("ignore_loglevel", ignore_loglevel_setup);
535 module_param_named(ignore_loglevel, ignore_loglevel, bool, S_IRUGO | S_IWUSR);
536 MODULE_PARM_DESC(ignore_loglevel, "ignore loglevel setting, to"
537 "print all kernel messages to the console.");
540 * Write out chars from start to end - 1 inclusive
542 static void _call_console_drivers(unsigned start,
543 unsigned end, int msg_log_level)
545 if ((msg_log_level < console_loglevel || ignore_loglevel) &&
546 console_drivers && start != end) {
547 if ((start & LOG_BUF_MASK) > (end & LOG_BUF_MASK)) {
549 __call_console_drivers(start & LOG_BUF_MASK,
551 __call_console_drivers(0, end & LOG_BUF_MASK);
553 __call_console_drivers(start, end);
559 * Parse the syslog header <[0-9]*>. The decimal value represents 32bit, the
560 * lower 3 bit are the log level, the rest are the log facility. In case
561 * userspace passes usual userspace syslog messages to /dev/kmsg or
562 * /dev/ttyprintk, the log prefix might contain the facility. Printk needs
563 * to extract the correct log level for in-kernel processing, and not mangle
564 * the original value.
566 * If a prefix is found, the length of the prefix is returned. If 'level' is
567 * passed, it will be filled in with the log level without a possible facility
568 * value. If 'special' is passed, the special printk prefix chars are accepted
569 * and returned. If no valid header is found, 0 is returned and the passed
570 * variables are not touched.
572 static size_t log_prefix(const char *p, unsigned int *level, char *special)
574 unsigned int lev = 0;
578 if (p[0] != '<' || !p[1])
581 /* usual single digit level number or special char */
586 case 'c': /* KERN_CONT */
587 case 'd': /* KERN_DEFAULT */
595 /* multi digit including the level and facility number */
598 lev = (simple_strtoul(&p[1], &endp, 10) & 7);
599 if (endp == NULL || endp[0] != '>')
601 len = (endp + 1) - p;
604 /* do not accept special char if not asked for */
610 /* return special char, do not touch level */
621 * Call the console drivers, asking them to write out
622 * log_buf[start] to log_buf[end - 1].
623 * The console_lock must be held.
625 static void call_console_drivers(unsigned start, unsigned end)
627 unsigned cur_index, start_print;
628 static int msg_level = -1;
630 BUG_ON(((int)(start - end)) > 0);
634 while (cur_index != end) {
635 if (msg_level < 0 && ((end - cur_index) > 2)) {
636 /* strip log prefix */
637 cur_index += log_prefix(&LOG_BUF(cur_index), &msg_level, NULL);
638 start_print = cur_index;
640 while (cur_index != end) {
641 char c = LOG_BUF(cur_index);
647 * printk() has already given us loglevel tags in
648 * the buffer. This code is here in case the
649 * log buffer has wrapped right round and scribbled
652 msg_level = default_message_loglevel;
654 _call_console_drivers(start_print, cur_index, msg_level);
656 start_print = cur_index;
661 _call_console_drivers(start_print, end, msg_level);
664 static void emit_log_char(char c)
666 LOG_BUF(log_end) = c;
668 if (log_end - log_start > log_buf_len)
669 log_start = log_end - log_buf_len;
670 if (log_end - con_start > log_buf_len)
671 con_start = log_end - log_buf_len;
672 if (logged_chars < log_buf_len)
677 * Zap console related locks when oopsing. Only zap at most once
678 * every 10 seconds, to leave time for slow consoles to print a
681 static void zap_locks(void)
683 static unsigned long oops_timestamp;
685 if (time_after_eq(jiffies, oops_timestamp) &&
686 !time_after(jiffies, oops_timestamp + 30 * HZ))
689 oops_timestamp = jiffies;
691 /* If a crash is occurring, make sure we can't deadlock */
692 raw_spin_lock_init(&logbuf_lock);
693 /* And make sure that we print immediately */
694 sema_init(&console_sem, 1);
697 #if defined(CONFIG_PRINTK_TIME)
698 static int printk_time = 1;
700 static int printk_time = 0;
702 module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
704 /* Check if we have any console registered that can be called early in boot. */
705 static int have_callable_console(void)
709 for_each_console(con)
710 if (con->flags & CON_ANYTIME)
717 * printk - print a kernel message
718 * @fmt: format string
720 * This is printk(). It can be called from any context. We want it to work.
722 * We try to grab the console_lock. If we succeed, it's easy - we log the output and
723 * call the console drivers. If we fail to get the semaphore we place the output
724 * into the log buffer and return. The current holder of the console_sem will
725 * notice the new output in console_unlock(); and will send it to the
726 * consoles before releasing the lock.
728 * One effect of this deferred printing is that code which calls printk() and
729 * then changes console_loglevel may break. This is because console_loglevel
730 * is inspected when the actual printing occurs.
735 * See the vsnprintf() documentation for format string extensions over C99.
738 asmlinkage int printk(const char *fmt, ...)
743 #ifdef CONFIG_KGDB_KDB
744 if (unlikely(kdb_trap_printk)) {
746 r = vkdb_printf(fmt, args);
752 r = vprintk(fmt, args);
758 /* cpu currently holding logbuf_lock */
759 static volatile unsigned int printk_cpu = UINT_MAX;
762 * Can we actually use the console at this time on this cpu?
764 * Console drivers may assume that per-cpu resources have
765 * been allocated. So unless they're explicitly marked as
766 * being able to cope (CON_ANYTIME) don't call them until
767 * this CPU is officially up.
769 static inline int can_use_console(unsigned int cpu)
771 return cpu_online(cpu) || have_callable_console();
775 * Try to get console ownership to actually show the kernel
776 * messages from a 'printk'. Return true (and with the
777 * console_lock held, and 'console_locked' set) if it
778 * is successful, false otherwise.
780 * This gets called with the 'logbuf_lock' spinlock held and
781 * interrupts disabled. It should return with 'lockbuf_lock'
782 * released but interrupts still disabled.
784 static int console_trylock_for_printk(unsigned int cpu)
785 __releases(&logbuf_lock)
787 int retval = 0, wake = 0;
789 if (console_trylock()) {
793 * If we can't use the console, we need to release
794 * the console semaphore by hand to avoid flushing
795 * the buffer. We need to hold the console semaphore
796 * in order to do this test safely.
798 if (!can_use_console(cpu)) {
804 printk_cpu = UINT_MAX;
807 raw_spin_unlock(&logbuf_lock);
810 static const char recursion_bug_msg [] =
811 KERN_CRIT "BUG: recent printk recursion!\n";
812 static int recursion_bug;
813 static int new_text_line = 1;
814 static char printk_buf[1024];
816 int printk_delay_msec __read_mostly;
818 static inline void printk_delay(void)
820 if (unlikely(printk_delay_msec)) {
821 int m = printk_delay_msec;
825 touch_nmi_watchdog();
830 asmlinkage int vprintk(const char *fmt, va_list args)
833 int current_log_level = default_message_loglevel;
844 /* This stops the holder of console_sem just where we want him */
845 raw_local_irq_save(flags);
846 this_cpu = smp_processor_id();
849 * Ouch, printk recursed into itself!
851 if (unlikely(printk_cpu == this_cpu)) {
853 * If a crash is occurring during printk() on this CPU,
854 * then try to get the crash message out but make sure
855 * we can't deadlock. Otherwise just return to avoid the
856 * recursion and return - but flag the recursion so that
857 * it can be printed at the next appropriate moment:
859 if (!oops_in_progress) {
861 goto out_restore_irqs;
867 raw_spin_lock(&logbuf_lock);
868 printk_cpu = this_cpu;
872 strcpy(printk_buf, recursion_bug_msg);
873 printed_len = strlen(recursion_bug_msg);
875 /* Emit the output into the temporary buffer */
876 printed_len += vscnprintf(printk_buf + printed_len,
877 sizeof(printk_buf) - printed_len, fmt, args);
881 /* Read log level and handle special printk prefix */
882 plen = log_prefix(p, ¤t_log_level, &special);
887 case 'c': /* Strip <c> KERN_CONT, continue line */
890 case 'd': /* Strip <d> KERN_DEFAULT, start new line */
893 if (!new_text_line) {
901 * Copy the output into log_buf. If the caller didn't provide
902 * the appropriate log prefix, we insert them here
909 /* Copy original log prefix */
912 for (i = 0; i < plen; i++)
913 emit_log_char(printk_buf[i]);
918 emit_log_char(current_log_level + '0');
924 /* Add the current time stamp */
927 unsigned long long t;
928 unsigned long nanosec_rem;
930 t = cpu_clock(printk_cpu);
931 nanosec_rem = do_div(t, 1000000000);
932 tlen = sprintf(tbuf, "[%5lu.%06lu] ",
936 for (tp = tbuf; tp < tbuf + tlen; tp++)
951 * Try to acquire and then immediately release the
952 * console semaphore. The release will do all the
953 * actual magic (print out buffers, wake up klogd,
956 * The console_trylock_for_printk() function
957 * will release 'logbuf_lock' regardless of whether it
958 * actually gets the semaphore or not.
960 if (console_trylock_for_printk(this_cpu))
965 raw_local_irq_restore(flags);
970 EXPORT_SYMBOL(printk);
971 EXPORT_SYMBOL(vprintk);
975 static void call_console_drivers(unsigned start, unsigned end)
981 static int __add_preferred_console(char *name, int idx, char *options,
984 struct console_cmdline *c;
988 * See if this tty is not yet registered, and
989 * if we have a slot free.
991 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
992 if (strcmp(console_cmdline[i].name, name) == 0 &&
993 console_cmdline[i].index == idx) {
995 selected_console = i;
998 if (i == MAX_CMDLINECONSOLES)
1001 selected_console = i;
1002 c = &console_cmdline[i];
1003 strlcpy(c->name, name, sizeof(c->name));
1004 c->options = options;
1005 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1006 c->brl_options = brl_options;
1012 * Set up a list of consoles. Called from init/main.c
1014 static int __init console_setup(char *str)
1016 char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for index */
1017 char *s, *options, *brl_options = NULL;
1020 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1021 if (!memcmp(str, "brl,", 4)) {
1024 } else if (!memcmp(str, "brl=", 4)) {
1025 brl_options = str + 4;
1026 str = strchr(brl_options, ',');
1028 printk(KERN_ERR "need port name after brl=\n");
1036 * Decode str into name, index, options.
1038 if (str[0] >= '0' && str[0] <= '9') {
1039 strcpy(buf, "ttyS");
1040 strncpy(buf + 4, str, sizeof(buf) - 5);
1042 strncpy(buf, str, sizeof(buf) - 1);
1044 buf[sizeof(buf) - 1] = 0;
1045 if ((options = strchr(str, ',')) != NULL)
1048 if (!strcmp(str, "ttya"))
1049 strcpy(buf, "ttyS0");
1050 if (!strcmp(str, "ttyb"))
1051 strcpy(buf, "ttyS1");
1053 for (s = buf; *s; s++)
1054 if ((*s >= '0' && *s <= '9') || *s == ',')
1056 idx = simple_strtoul(s, NULL, 10);
1059 __add_preferred_console(buf, idx, options, brl_options);
1060 console_set_on_cmdline = 1;
1063 __setup("console=", console_setup);
1066 * add_preferred_console - add a device to the list of preferred consoles.
1067 * @name: device name
1068 * @idx: device index
1069 * @options: options for this console
1071 * The last preferred console added will be used for kernel messages
1072 * and stdin/out/err for init. Normally this is used by console_setup
1073 * above to handle user-supplied console arguments; however it can also
1074 * be used by arch-specific code either to override the user or more
1075 * commonly to provide a default console (ie from PROM variables) when
1076 * the user has not supplied one.
1078 int add_preferred_console(char *name, int idx, char *options)
1080 return __add_preferred_console(name, idx, options, NULL);
1083 int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options)
1085 struct console_cmdline *c;
1088 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
1089 if (strcmp(console_cmdline[i].name, name) == 0 &&
1090 console_cmdline[i].index == idx) {
1091 c = &console_cmdline[i];
1092 strlcpy(c->name, name_new, sizeof(c->name));
1093 c->name[sizeof(c->name) - 1] = 0;
1094 c->options = options;
1102 int console_suspend_enabled = 1;
1103 EXPORT_SYMBOL(console_suspend_enabled);
1105 static int __init console_suspend_disable(char *str)
1107 console_suspend_enabled = 0;
1110 __setup("no_console_suspend", console_suspend_disable);
1111 module_param_named(console_suspend, console_suspend_enabled,
1112 bool, S_IRUGO | S_IWUSR);
1113 MODULE_PARM_DESC(console_suspend, "suspend console during suspend"
1114 " and hibernate operations");
1117 * suspend_console - suspend the console subsystem
1119 * This disables printk() while we go into suspend states
1121 void suspend_console(void)
1123 if (!console_suspend_enabled)
1125 printk("Suspending console(s) (use no_console_suspend to debug)\n");
1127 console_suspended = 1;
1131 void resume_console(void)
1133 if (!console_suspend_enabled)
1136 console_suspended = 0;
1141 * console_cpu_notify - print deferred console messages after CPU hotplug
1142 * @self: notifier struct
1143 * @action: CPU hotplug event
1146 * If printk() is called from a CPU that is not online yet, the messages
1147 * will be spooled but will not show up on the console. This function is
1148 * called when a new CPU comes online (or fails to come up), and ensures
1149 * that any such output gets printed.
1151 static int __cpuinit console_cpu_notify(struct notifier_block *self,
1152 unsigned long action, void *hcpu)
1158 case CPU_DOWN_FAILED:
1159 case CPU_UP_CANCELED:
1167 * console_lock - lock the console system for exclusive use.
1169 * Acquires a lock which guarantees that the caller has
1170 * exclusive access to the console system and the console_drivers list.
1172 * Can sleep, returns nothing.
1174 void console_lock(void)
1176 BUG_ON(in_interrupt());
1178 if (console_suspended)
1181 console_may_schedule = 1;
1183 EXPORT_SYMBOL(console_lock);
1186 * console_trylock - try to lock the console system for exclusive use.
1188 * Tried to acquire a lock which guarantees that the caller has
1189 * exclusive access to the console system and the console_drivers list.
1191 * returns 1 on success, and 0 on failure to acquire the lock.
1193 int console_trylock(void)
1195 if (down_trylock(&console_sem))
1197 if (console_suspended) {
1202 console_may_schedule = 0;
1205 EXPORT_SYMBOL(console_trylock);
1207 int is_console_locked(void)
1209 return console_locked;
1212 static DEFINE_PER_CPU(int, printk_pending);
1214 void printk_tick(void)
1216 if (__this_cpu_read(printk_pending)) {
1217 __this_cpu_write(printk_pending, 0);
1218 wake_up_interruptible(&log_wait);
1222 int printk_needs_cpu(int cpu)
1224 if (cpu_is_offline(cpu))
1226 return __this_cpu_read(printk_pending);
1229 void wake_up_klogd(void)
1231 if (waitqueue_active(&log_wait))
1232 this_cpu_write(printk_pending, 1);
1236 * console_unlock - unlock the console system
1238 * Releases the console_lock which the caller holds on the console system
1239 * and the console driver list.
1241 * While the console_lock was held, console output may have been buffered
1242 * by printk(). If this is the case, console_unlock(); emits
1243 * the output prior to releasing the lock.
1245 * If there is output waiting for klogd, we wake it up.
1247 * console_unlock(); may be called from any context.
1249 void console_unlock(void)
1251 unsigned long flags;
1252 unsigned _con_start, _log_end;
1253 unsigned wake_klogd = 0, retry = 0;
1255 if (console_suspended) {
1260 console_may_schedule = 0;
1264 raw_spin_lock_irqsave(&logbuf_lock, flags);
1265 wake_klogd |= log_start - log_end;
1266 if (con_start == log_end)
1267 break; /* Nothing to print */
1268 _con_start = con_start;
1270 con_start = log_end; /* Flush */
1271 raw_spin_unlock(&logbuf_lock);
1272 stop_critical_timings(); /* don't trace print latency */
1273 call_console_drivers(_con_start, _log_end);
1274 start_critical_timings();
1275 local_irq_restore(flags);
1279 /* Release the exclusive_console once it is used */
1280 if (unlikely(exclusive_console))
1281 exclusive_console = NULL;
1283 raw_spin_unlock(&logbuf_lock);
1288 * Someone could have filled up the buffer again, so re-check if there's
1289 * something to flush. In case we cannot trylock the console_sem again,
1290 * there's a new owner and the console_unlock() from them will do the
1291 * flush, no worries.
1293 raw_spin_lock(&logbuf_lock);
1294 if (con_start != log_end)
1296 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
1298 if (retry && console_trylock())
1304 EXPORT_SYMBOL(console_unlock);
1307 * console_conditional_schedule - yield the CPU if required
1309 * If the console code is currently allowed to sleep, and
1310 * if this CPU should yield the CPU to another task, do
1313 * Must be called within console_lock();.
1315 void __sched console_conditional_schedule(void)
1317 if (console_may_schedule)
1320 EXPORT_SYMBOL(console_conditional_schedule);
1322 void console_unblank(void)
1327 * console_unblank can no longer be called in interrupt context unless
1328 * oops_in_progress is set to 1..
1330 if (oops_in_progress) {
1331 if (down_trylock(&console_sem) != 0)
1337 console_may_schedule = 0;
1339 if ((c->flags & CON_ENABLED) && c->unblank)
1345 * Return the console tty driver structure and its associated index
1347 struct tty_driver *console_device(int *index)
1350 struct tty_driver *driver = NULL;
1353 for_each_console(c) {
1356 driver = c->device(c, index);
1365 * Prevent further output on the passed console device so that (for example)
1366 * serial drivers can disable console output before suspending a port, and can
1367 * re-enable output afterwards.
1369 void console_stop(struct console *console)
1372 console->flags &= ~CON_ENABLED;
1375 EXPORT_SYMBOL(console_stop);
1377 void console_start(struct console *console)
1380 console->flags |= CON_ENABLED;
1383 EXPORT_SYMBOL(console_start);
1385 static int __read_mostly keep_bootcon;
1387 static int __init keep_bootcon_setup(char *str)
1390 printk(KERN_INFO "debug: skip boot console de-registration.\n");
1395 early_param("keep_bootcon", keep_bootcon_setup);
1398 * The console driver calls this routine during kernel initialization
1399 * to register the console printing procedure with printk() and to
1400 * print any messages that were printed by the kernel before the
1401 * console driver was initialized.
1403 * This can happen pretty early during the boot process (because of
1404 * early_printk) - sometimes before setup_arch() completes - be careful
1405 * of what kernel features are used - they may not be initialised yet.
1407 * There are two types of consoles - bootconsoles (early_printk) and
1408 * "real" consoles (everything which is not a bootconsole) which are
1409 * handled differently.
1410 * - Any number of bootconsoles can be registered at any time.
1411 * - As soon as a "real" console is registered, all bootconsoles
1412 * will be unregistered automatically.
1413 * - Once a "real" console is registered, any attempt to register a
1414 * bootconsoles will be rejected
1416 void register_console(struct console *newcon)
1419 unsigned long flags;
1420 struct console *bcon = NULL;
1423 * before we register a new CON_BOOT console, make sure we don't
1424 * already have a valid console
1426 if (console_drivers && newcon->flags & CON_BOOT) {
1427 /* find the last or real console */
1428 for_each_console(bcon) {
1429 if (!(bcon->flags & CON_BOOT)) {
1430 printk(KERN_INFO "Too late to register bootconsole %s%d\n",
1431 newcon->name, newcon->index);
1437 if (console_drivers && console_drivers->flags & CON_BOOT)
1438 bcon = console_drivers;
1440 if (preferred_console < 0 || bcon || !console_drivers)
1441 preferred_console = selected_console;
1443 if (newcon->early_setup)
1444 newcon->early_setup();
1447 * See if we want to use this console driver. If we
1448 * didn't select a console we take the first one
1449 * that registers here.
1451 if (preferred_console < 0) {
1452 if (newcon->index < 0)
1454 if (newcon->setup == NULL ||
1455 newcon->setup(newcon, NULL) == 0) {
1456 newcon->flags |= CON_ENABLED;
1457 if (newcon->device) {
1458 newcon->flags |= CON_CONSDEV;
1459 preferred_console = 0;
1465 * See if this console matches one we selected on
1468 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0];
1470 if (strcmp(console_cmdline[i].name, newcon->name) != 0)
1472 if (newcon->index >= 0 &&
1473 newcon->index != console_cmdline[i].index)
1475 if (newcon->index < 0)
1476 newcon->index = console_cmdline[i].index;
1477 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1478 if (console_cmdline[i].brl_options) {
1479 newcon->flags |= CON_BRL;
1480 braille_register_console(newcon,
1481 console_cmdline[i].index,
1482 console_cmdline[i].options,
1483 console_cmdline[i].brl_options);
1487 if (newcon->setup &&
1488 newcon->setup(newcon, console_cmdline[i].options) != 0)
1490 newcon->flags |= CON_ENABLED;
1491 newcon->index = console_cmdline[i].index;
1492 if (i == selected_console) {
1493 newcon->flags |= CON_CONSDEV;
1494 preferred_console = selected_console;
1499 if (!(newcon->flags & CON_ENABLED))
1503 * If we have a bootconsole, and are switching to a real console,
1504 * don't print everything out again, since when the boot console, and
1505 * the real console are the same physical device, it's annoying to
1506 * see the beginning boot messages twice
1508 if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
1509 newcon->flags &= ~CON_PRINTBUFFER;
1512 * Put this console in the list - keep the
1513 * preferred driver at the head of the list.
1516 if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
1517 newcon->next = console_drivers;
1518 console_drivers = newcon;
1520 newcon->next->flags &= ~CON_CONSDEV;
1522 newcon->next = console_drivers->next;
1523 console_drivers->next = newcon;
1525 if (newcon->flags & CON_PRINTBUFFER) {
1527 * console_unlock(); will print out the buffered messages
1530 raw_spin_lock_irqsave(&logbuf_lock, flags);
1531 con_start = log_start;
1532 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
1534 * We're about to replay the log buffer. Only do this to the
1535 * just-registered console to avoid excessive message spam to
1536 * the already-registered consoles.
1538 exclusive_console = newcon;
1541 console_sysfs_notify();
1544 * By unregistering the bootconsoles after we enable the real console
1545 * we get the "console xxx enabled" message on all the consoles -
1546 * boot consoles, real consoles, etc - this is to ensure that end
1547 * users know there might be something in the kernel's log buffer that
1548 * went to the bootconsole (that they do not see on the real console)
1551 ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
1553 /* we need to iterate through twice, to make sure we print
1554 * everything out, before we unregister the console(s)
1556 printk(KERN_INFO "console [%s%d] enabled, bootconsole disabled\n",
1557 newcon->name, newcon->index);
1558 for_each_console(bcon)
1559 if (bcon->flags & CON_BOOT)
1560 unregister_console(bcon);
1562 printk(KERN_INFO "%sconsole [%s%d] enabled\n",
1563 (newcon->flags & CON_BOOT) ? "boot" : "" ,
1564 newcon->name, newcon->index);
1567 EXPORT_SYMBOL(register_console);
1569 int unregister_console(struct console *console)
1571 struct console *a, *b;
1574 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1575 if (console->flags & CON_BRL)
1576 return braille_unregister_console(console);
1580 if (console_drivers == console) {
1581 console_drivers=console->next;
1583 } else if (console_drivers) {
1584 for (a=console_drivers->next, b=console_drivers ;
1585 a; b=a, a=b->next) {
1595 * If this isn't the last console and it has CON_CONSDEV set, we
1596 * need to set it on the next preferred console.
1598 if (console_drivers != NULL && console->flags & CON_CONSDEV)
1599 console_drivers->flags |= CON_CONSDEV;
1602 console_sysfs_notify();
1605 EXPORT_SYMBOL(unregister_console);
1607 static int __init printk_late_init(void)
1609 struct console *con;
1611 for_each_console(con) {
1612 if (!keep_bootcon && con->flags & CON_BOOT) {
1613 printk(KERN_INFO "turn off boot console %s%d\n",
1614 con->name, con->index);
1615 unregister_console(con);
1618 hotcpu_notifier(console_cpu_notify, 0);
1621 late_initcall(printk_late_init);
1623 #if defined CONFIG_PRINTK
1626 * printk rate limiting, lifted from the networking subsystem.
1628 * This enforces a rate limit: not more than 10 kernel messages
1629 * every 5s to make a denial-of-service attack impossible.
1631 DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
1633 int __printk_ratelimit(const char *func)
1635 return ___ratelimit(&printk_ratelimit_state, func);
1637 EXPORT_SYMBOL(__printk_ratelimit);
1640 * printk_timed_ratelimit - caller-controlled printk ratelimiting
1641 * @caller_jiffies: pointer to caller's state
1642 * @interval_msecs: minimum interval between prints
1644 * printk_timed_ratelimit() returns true if more than @interval_msecs
1645 * milliseconds have elapsed since the last time printk_timed_ratelimit()
1648 bool printk_timed_ratelimit(unsigned long *caller_jiffies,
1649 unsigned int interval_msecs)
1651 if (*caller_jiffies == 0
1652 || !time_in_range(jiffies, *caller_jiffies,
1654 + msecs_to_jiffies(interval_msecs))) {
1655 *caller_jiffies = jiffies;
1660 EXPORT_SYMBOL(printk_timed_ratelimit);
1662 static DEFINE_SPINLOCK(dump_list_lock);
1663 static LIST_HEAD(dump_list);
1666 * kmsg_dump_register - register a kernel log dumper.
1667 * @dumper: pointer to the kmsg_dumper structure
1669 * Adds a kernel log dumper to the system. The dump callback in the
1670 * structure will be called when the kernel oopses or panics and must be
1671 * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
1673 int kmsg_dump_register(struct kmsg_dumper *dumper)
1675 unsigned long flags;
1678 /* The dump callback needs to be set */
1682 spin_lock_irqsave(&dump_list_lock, flags);
1683 /* Don't allow registering multiple times */
1684 if (!dumper->registered) {
1685 dumper->registered = 1;
1686 list_add_tail_rcu(&dumper->list, &dump_list);
1689 spin_unlock_irqrestore(&dump_list_lock, flags);
1693 EXPORT_SYMBOL_GPL(kmsg_dump_register);
1696 * kmsg_dump_unregister - unregister a kmsg dumper.
1697 * @dumper: pointer to the kmsg_dumper structure
1699 * Removes a dump device from the system. Returns zero on success and
1700 * %-EINVAL otherwise.
1702 int kmsg_dump_unregister(struct kmsg_dumper *dumper)
1704 unsigned long flags;
1707 spin_lock_irqsave(&dump_list_lock, flags);
1708 if (dumper->registered) {
1709 dumper->registered = 0;
1710 list_del_rcu(&dumper->list);
1713 spin_unlock_irqrestore(&dump_list_lock, flags);
1718 EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
1721 * kmsg_dump - dump kernel log to kernel message dumpers.
1722 * @reason: the reason (oops, panic etc) for dumping
1724 * Iterate through each of the dump devices and call the oops/panic
1725 * callbacks with the log buffer.
1727 void kmsg_dump(enum kmsg_dump_reason reason)
1731 struct kmsg_dumper *dumper;
1732 const char *s1, *s2;
1733 unsigned long l1, l2;
1734 unsigned long flags;
1736 /* Theoretically, the log could move on after we do this, but
1737 there's not a lot we can do about that. The new messages
1738 will overwrite the start of what we dump. */
1739 raw_spin_lock_irqsave(&logbuf_lock, flags);
1740 end = log_end & LOG_BUF_MASK;
1741 chars = logged_chars;
1742 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
1745 s1 = log_buf + log_buf_len - chars + end;
1754 s2 = log_buf + end - chars;
1759 list_for_each_entry_rcu(dumper, &dump_list, list)
1760 dumper->dump(dumper, reason, s1, l1, s2, l2);