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/syscalls.h>
35 #include <linux/kexec.h>
36 #include <linux/kdb.h>
37 #include <linux/ratelimit.h>
38 #include <linux/kmsg_dump.h>
39 #include <linux/syslog.h>
40 #include <linux/cpu.h>
41 #include <linux/notifier.h>
42 #include <linux/rculist.h>
44 #include <asm/uaccess.h>
47 * Architectures can override it:
49 void asmlinkage __attribute__((weak)) early_printk(const char *fmt, ...)
53 #define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
55 /* printk's without a loglevel use this.. */
56 #define DEFAULT_MESSAGE_LOGLEVEL CONFIG_DEFAULT_MESSAGE_LOGLEVEL
58 /* We show everything that is MORE important than this.. */
59 #define MINIMUM_CONSOLE_LOGLEVEL 1 /* Minimum loglevel we let people use */
60 #define DEFAULT_CONSOLE_LOGLEVEL 7 /* anything MORE serious than KERN_DEBUG */
62 DECLARE_WAIT_QUEUE_HEAD(log_wait);
64 int console_printk[4] = {
65 DEFAULT_CONSOLE_LOGLEVEL, /* console_loglevel */
66 DEFAULT_MESSAGE_LOGLEVEL, /* default_message_loglevel */
67 MINIMUM_CONSOLE_LOGLEVEL, /* minimum_console_loglevel */
68 DEFAULT_CONSOLE_LOGLEVEL, /* default_console_loglevel */
72 * Low level drivers may need that to know if they can schedule in
73 * their unblank() callback or not. So let's export it.
76 EXPORT_SYMBOL(oops_in_progress);
79 * console_sem protects the console_drivers list, and also
80 * provides serialisation for access to the entire console
83 static DEFINE_SEMAPHORE(console_sem);
84 struct console *console_drivers;
85 EXPORT_SYMBOL_GPL(console_drivers);
88 * This is used for debugging the mess that is the VT code by
89 * keeping track if we have the console semaphore held. It's
90 * definitely not the perfect debug tool (we don't know if _WE_
91 * hold it are racing, but it helps tracking those weird code
92 * path in the console code where we end up in places I want
93 * locked without the console sempahore held
95 static int console_locked, console_suspended;
98 * logbuf_lock protects log_buf, log_start, log_end, con_start and logged_chars
99 * It is also used in interesting ways to provide interlocking in
102 static DEFINE_SPINLOCK(logbuf_lock);
104 #define LOG_BUF_MASK (log_buf_len-1)
105 #define LOG_BUF(idx) (log_buf[(idx) & LOG_BUF_MASK])
108 * The indices into log_buf are not constrained to log_buf_len - they
109 * must be masked before subscripting
111 static unsigned log_start; /* Index into log_buf: next char to be read by syslog() */
112 static unsigned con_start; /* Index into log_buf: next char to be sent to consoles */
113 static unsigned log_end; /* Index into log_buf: most-recently-written-char + 1 */
116 * If exclusive_console is non-NULL then only this console is to be printed to.
118 static struct console *exclusive_console;
121 * Array of consoles built from command line options (console=)
123 struct console_cmdline
125 char name[8]; /* Name of the driver */
126 int index; /* Minor dev. to use */
127 char *options; /* Options for the driver */
128 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
129 char *brl_options; /* Options for braille driver */
133 #define MAX_CMDLINECONSOLES 8
135 static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
136 static int selected_console = -1;
137 static int preferred_console = -1;
138 int console_set_on_cmdline;
139 EXPORT_SYMBOL(console_set_on_cmdline);
141 /* Flag: console code may call schedule() */
142 static int console_may_schedule;
146 static char __log_buf[__LOG_BUF_LEN];
147 static char *log_buf = __log_buf;
148 static int log_buf_len = __LOG_BUF_LEN;
149 static unsigned logged_chars; /* Number of chars produced since last read+clear operation */
150 static int saved_console_loglevel = -1;
154 * This appends the listed symbols to /proc/vmcoreinfo
156 * /proc/vmcoreinfo is used by various utiilties, like crash and makedumpfile to
157 * obtain access to symbols that are otherwise very difficult to locate. These
158 * symbols are specifically used so that utilities can access and extract the
159 * dmesg log from a vmcore file after a crash.
161 void log_buf_kexec_setup(void)
163 VMCOREINFO_SYMBOL(log_buf);
164 VMCOREINFO_SYMBOL(log_end);
165 VMCOREINFO_SYMBOL(log_buf_len);
166 VMCOREINFO_SYMBOL(logged_chars);
170 static int __init log_buf_len_setup(char *str)
172 unsigned size = memparse(str, &str);
176 size = roundup_pow_of_two(size);
177 if (size > log_buf_len) {
178 unsigned start, dest_idx, offset;
181 new_log_buf = alloc_bootmem(size);
183 printk(KERN_WARNING "log_buf_len: allocation failed\n");
187 spin_lock_irqsave(&logbuf_lock, flags);
189 log_buf = new_log_buf;
191 offset = start = min(con_start, log_start);
193 while (start != log_end) {
194 log_buf[dest_idx] = __log_buf[start & (__LOG_BUF_LEN - 1)];
201 spin_unlock_irqrestore(&logbuf_lock, flags);
203 printk(KERN_NOTICE "log_buf_len: %d\n", log_buf_len);
209 __setup("log_buf_len=", log_buf_len_setup);
211 #ifdef CONFIG_BOOT_PRINTK_DELAY
213 static int boot_delay; /* msecs delay after each printk during bootup */
214 static unsigned long long loops_per_msec; /* based on boot_delay */
216 static int __init boot_delay_setup(char *str)
220 lpj = preset_lpj ? preset_lpj : 1000000; /* some guess */
221 loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
223 get_option(&str, &boot_delay);
224 if (boot_delay > 10 * 1000)
227 pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
228 "HZ: %d, loops_per_msec: %llu\n",
229 boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
232 __setup("boot_delay=", boot_delay_setup);
234 static void boot_delay_msec(void)
236 unsigned long long k;
237 unsigned long timeout;
239 if (boot_delay == 0 || system_state != SYSTEM_BOOTING)
242 k = (unsigned long long)loops_per_msec * boot_delay;
244 timeout = jiffies + msecs_to_jiffies(boot_delay);
249 * use (volatile) jiffies to prevent
250 * compiler reduction; loop termination via jiffies
251 * is secondary and may or may not happen.
253 if (time_after(jiffies, timeout))
255 touch_nmi_watchdog();
259 static inline void boot_delay_msec(void)
264 #ifdef CONFIG_SECURITY_DMESG_RESTRICT
265 int dmesg_restrict = 1;
270 static int syslog_action_restricted(int type)
274 /* Unless restricted, we allow "read all" and "get buffer size" for everybody */
275 return type != SYSLOG_ACTION_READ_ALL && type != SYSLOG_ACTION_SIZE_BUFFER;
278 static int check_syslog_permissions(int type, bool from_file)
281 * If this is from /proc/kmsg and we've already opened it, then we've
282 * already done the capabilities checks at open time.
284 if (from_file && type != SYSLOG_ACTION_OPEN)
287 if (syslog_action_restricted(type)) {
288 if (capable(CAP_SYSLOG))
290 /* For historical reasons, accept CAP_SYS_ADMIN too, with a warning */
291 if (capable(CAP_SYS_ADMIN)) {
292 WARN_ONCE(1, "Attempt to access syslog with CAP_SYS_ADMIN "
293 "but no CAP_SYSLOG (deprecated).\n");
301 int do_syslog(int type, char __user *buf, int len, bool from_file)
303 unsigned i, j, limit, count;
308 error = check_syslog_permissions(type, from_file);
312 error = security_syslog(type);
317 case SYSLOG_ACTION_CLOSE: /* Close log */
319 case SYSLOG_ACTION_OPEN: /* Open log */
321 case SYSLOG_ACTION_READ: /* Read from log */
328 if (!access_ok(VERIFY_WRITE, buf, len)) {
332 error = wait_event_interruptible(log_wait,
333 (log_start - log_end));
337 spin_lock_irq(&logbuf_lock);
338 while (!error && (log_start != log_end) && i < len) {
339 c = LOG_BUF(log_start);
341 spin_unlock_irq(&logbuf_lock);
342 error = __put_user(c,buf);
346 spin_lock_irq(&logbuf_lock);
348 spin_unlock_irq(&logbuf_lock);
352 /* Read/clear last kernel messages */
353 case SYSLOG_ACTION_READ_CLEAR:
356 /* Read last kernel messages */
357 case SYSLOG_ACTION_READ_ALL:
364 if (!access_ok(VERIFY_WRITE, buf, len)) {
369 if (count > log_buf_len)
371 spin_lock_irq(&logbuf_lock);
372 if (count > logged_chars)
373 count = logged_chars;
378 * __put_user() could sleep, and while we sleep
379 * printk() could overwrite the messages
380 * we try to copy to user space. Therefore
381 * the messages are copied in reverse. <manfreds>
383 for (i = 0; i < count && !error; i++) {
385 if (j + log_buf_len < log_end)
388 spin_unlock_irq(&logbuf_lock);
389 error = __put_user(c,&buf[count-1-i]);
391 spin_lock_irq(&logbuf_lock);
393 spin_unlock_irq(&logbuf_lock);
398 int offset = count-error;
399 /* buffer overflow during copy, correct user buffer. */
400 for (i = 0; i < error; i++) {
401 if (__get_user(c,&buf[i+offset]) ||
402 __put_user(c,&buf[i])) {
410 /* Clear ring buffer */
411 case SYSLOG_ACTION_CLEAR:
414 /* Disable logging to console */
415 case SYSLOG_ACTION_CONSOLE_OFF:
416 if (saved_console_loglevel == -1)
417 saved_console_loglevel = console_loglevel;
418 console_loglevel = minimum_console_loglevel;
420 /* Enable logging to console */
421 case SYSLOG_ACTION_CONSOLE_ON:
422 if (saved_console_loglevel != -1) {
423 console_loglevel = saved_console_loglevel;
424 saved_console_loglevel = -1;
427 /* Set level of messages printed to console */
428 case SYSLOG_ACTION_CONSOLE_LEVEL:
430 if (len < 1 || len > 8)
432 if (len < minimum_console_loglevel)
433 len = minimum_console_loglevel;
434 console_loglevel = len;
435 /* Implicitly re-enable logging to console */
436 saved_console_loglevel = -1;
439 /* Number of chars in the log buffer */
440 case SYSLOG_ACTION_SIZE_UNREAD:
441 error = log_end - log_start;
443 /* Size of the log buffer */
444 case SYSLOG_ACTION_SIZE_BUFFER:
455 SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
457 return do_syslog(type, buf, len, SYSLOG_FROM_CALL);
460 #ifdef CONFIG_KGDB_KDB
461 /* kdb dmesg command needs access to the syslog buffer. do_syslog()
462 * uses locks so it cannot be used during debugging. Just tell kdb
463 * where the start and end of the physical and logical logs are. This
464 * is equivalent to do_syslog(3).
466 void kdb_syslog_data(char *syslog_data[4])
468 syslog_data[0] = log_buf;
469 syslog_data[1] = log_buf + log_buf_len;
470 syslog_data[2] = log_buf + log_end -
471 (logged_chars < log_buf_len ? logged_chars : log_buf_len);
472 syslog_data[3] = log_buf + log_end;
474 #endif /* CONFIG_KGDB_KDB */
477 * Call the console drivers on a range of log_buf
479 static void __call_console_drivers(unsigned start, unsigned end)
483 for_each_console(con) {
484 if (exclusive_console && con != exclusive_console)
486 if ((con->flags & CON_ENABLED) && con->write &&
487 (cpu_online(smp_processor_id()) ||
488 (con->flags & CON_ANYTIME)))
489 con->write(con, &LOG_BUF(start), end - start);
493 static int __read_mostly ignore_loglevel;
495 static int __init ignore_loglevel_setup(char *str)
498 printk(KERN_INFO "debug: ignoring loglevel setting.\n");
503 early_param("ignore_loglevel", ignore_loglevel_setup);
506 * Write out chars from start to end - 1 inclusive
508 static void _call_console_drivers(unsigned start,
509 unsigned end, int msg_log_level)
511 if ((msg_log_level < console_loglevel || ignore_loglevel) &&
512 console_drivers && start != end) {
513 if ((start & LOG_BUF_MASK) > (end & LOG_BUF_MASK)) {
515 __call_console_drivers(start & LOG_BUF_MASK,
517 __call_console_drivers(0, end & LOG_BUF_MASK);
519 __call_console_drivers(start, end);
525 * Parse the syslog header <[0-9]*>. The decimal value represents 32bit, the
526 * lower 3 bit are the log level, the rest are the log facility. In case
527 * userspace passes usual userspace syslog messages to /dev/kmsg or
528 * /dev/ttyprintk, the log prefix might contain the facility. Printk needs
529 * to extract the correct log level for in-kernel processing, and not mangle
530 * the original value.
532 * If a prefix is found, the length of the prefix is returned. If 'level' is
533 * passed, it will be filled in with the log level without a possible facility
534 * value. If 'special' is passed, the special printk prefix chars are accepted
535 * and returned. If no valid header is found, 0 is returned and the passed
536 * variables are not touched.
538 static size_t log_prefix(const char *p, unsigned int *level, char *special)
540 unsigned int lev = 0;
544 if (p[0] != '<' || !p[1])
547 /* usual single digit level number or special char */
552 case 'c': /* KERN_CONT */
553 case 'd': /* KERN_DEFAULT */
561 /* multi digit including the level and facility number */
564 if (p[1] < '0' && p[1] > '9')
567 lev = (simple_strtoul(&p[1], &endp, 10) & 7);
568 if (endp == NULL || endp[0] != '>')
570 len = (endp + 1) - p;
573 /* do not accept special char if not asked for */
579 /* return special char, do not touch level */
590 * Call the console drivers, asking them to write out
591 * log_buf[start] to log_buf[end - 1].
592 * The console_lock must be held.
594 static void call_console_drivers(unsigned start, unsigned end)
596 unsigned cur_index, start_print;
597 static int msg_level = -1;
599 BUG_ON(((int)(start - end)) > 0);
603 while (cur_index != end) {
604 if (msg_level < 0 && ((end - cur_index) > 2)) {
605 /* strip log prefix */
606 cur_index += log_prefix(&LOG_BUF(cur_index), &msg_level, NULL);
607 start_print = cur_index;
609 while (cur_index != end) {
610 char c = LOG_BUF(cur_index);
616 * printk() has already given us loglevel tags in
617 * the buffer. This code is here in case the
618 * log buffer has wrapped right round and scribbled
621 msg_level = default_message_loglevel;
623 _call_console_drivers(start_print, cur_index, msg_level);
625 start_print = cur_index;
630 _call_console_drivers(start_print, end, msg_level);
633 static void emit_log_char(char c)
635 LOG_BUF(log_end) = c;
637 if (log_end - log_start > log_buf_len)
638 log_start = log_end - log_buf_len;
639 if (log_end - con_start > log_buf_len)
640 con_start = log_end - log_buf_len;
641 if (logged_chars < log_buf_len)
646 * Zap console related locks when oopsing. Only zap at most once
647 * every 10 seconds, to leave time for slow consoles to print a
650 static void zap_locks(void)
652 static unsigned long oops_timestamp;
654 if (time_after_eq(jiffies, oops_timestamp) &&
655 !time_after(jiffies, oops_timestamp + 30 * HZ))
658 oops_timestamp = jiffies;
660 /* If a crash is occurring, make sure we can't deadlock */
661 spin_lock_init(&logbuf_lock);
662 /* And make sure that we print immediately */
663 sema_init(&console_sem, 1);
666 #if defined(CONFIG_PRINTK_TIME)
667 static int printk_time = 1;
669 static int printk_time = 0;
671 module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
673 /* Check if we have any console registered that can be called early in boot. */
674 static int have_callable_console(void)
678 for_each_console(con)
679 if (con->flags & CON_ANYTIME)
686 * printk - print a kernel message
687 * @fmt: format string
689 * This is printk(). It can be called from any context. We want it to work.
691 * We try to grab the console_lock. If we succeed, it's easy - we log the output and
692 * call the console drivers. If we fail to get the semaphore we place the output
693 * into the log buffer and return. The current holder of the console_sem will
694 * notice the new output in console_unlock(); and will send it to the
695 * consoles before releasing the lock.
697 * One effect of this deferred printing is that code which calls printk() and
698 * then changes console_loglevel may break. This is because console_loglevel
699 * is inspected when the actual printing occurs.
704 * See the vsnprintf() documentation for format string extensions over C99.
707 asmlinkage int printk(const char *fmt, ...)
712 #ifdef CONFIG_KGDB_KDB
713 if (unlikely(kdb_trap_printk)) {
715 r = vkdb_printf(fmt, args);
721 r = vprintk(fmt, args);
727 /* cpu currently holding logbuf_lock */
728 static volatile unsigned int printk_cpu = UINT_MAX;
731 * Can we actually use the console at this time on this cpu?
733 * Console drivers may assume that per-cpu resources have
734 * been allocated. So unless they're explicitly marked as
735 * being able to cope (CON_ANYTIME) don't call them until
736 * this CPU is officially up.
738 static inline int can_use_console(unsigned int cpu)
740 return cpu_online(cpu) || have_callable_console();
744 * Try to get console ownership to actually show the kernel
745 * messages from a 'printk'. Return true (and with the
746 * console_lock held, and 'console_locked' set) if it
747 * is successful, false otherwise.
749 * This gets called with the 'logbuf_lock' spinlock held and
750 * interrupts disabled. It should return with 'lockbuf_lock'
751 * released but interrupts still disabled.
753 static int console_trylock_for_printk(unsigned int cpu)
754 __releases(&logbuf_lock)
758 if (console_trylock()) {
762 * If we can't use the console, we need to release
763 * the console semaphore by hand to avoid flushing
764 * the buffer. We need to hold the console semaphore
765 * in order to do this test safely.
767 if (!can_use_console(cpu)) {
773 printk_cpu = UINT_MAX;
774 spin_unlock(&logbuf_lock);
777 static const char recursion_bug_msg [] =
778 KERN_CRIT "BUG: recent printk recursion!\n";
779 static int recursion_bug;
780 static int new_text_line = 1;
781 static char printk_buf[1024];
783 int printk_delay_msec __read_mostly;
785 static inline void printk_delay(void)
787 if (unlikely(printk_delay_msec)) {
788 int m = printk_delay_msec;
792 touch_nmi_watchdog();
797 asmlinkage int vprintk(const char *fmt, va_list args)
800 int current_log_level = default_message_loglevel;
811 /* This stops the holder of console_sem just where we want him */
812 raw_local_irq_save(flags);
813 this_cpu = smp_processor_id();
816 * Ouch, printk recursed into itself!
818 if (unlikely(printk_cpu == this_cpu)) {
820 * If a crash is occurring during printk() on this CPU,
821 * then try to get the crash message out but make sure
822 * we can't deadlock. Otherwise just return to avoid the
823 * recursion and return - but flag the recursion so that
824 * it can be printed at the next appropriate moment:
826 if (!oops_in_progress) {
828 goto out_restore_irqs;
834 spin_lock(&logbuf_lock);
835 printk_cpu = this_cpu;
839 strcpy(printk_buf, recursion_bug_msg);
840 printed_len = strlen(recursion_bug_msg);
842 /* Emit the output into the temporary buffer */
843 printed_len += vscnprintf(printk_buf + printed_len,
844 sizeof(printk_buf) - printed_len, fmt, args);
848 /* Read log level and handle special printk prefix */
849 plen = log_prefix(p, ¤t_log_level, &special);
854 case 'c': /* Strip <c> KERN_CONT, continue line */
857 case 'd': /* Strip <d> KERN_DEFAULT, start new line */
860 if (!new_text_line) {
868 * Copy the output into log_buf. If the caller didn't provide
869 * the appropriate log prefix, we insert them here
876 /* Copy original log prefix */
879 for (i = 0; i < plen; i++)
880 emit_log_char(printk_buf[i]);
885 emit_log_char(current_log_level + '0');
891 /* Add the current time stamp */
894 unsigned long long t;
895 unsigned long nanosec_rem;
897 t = cpu_clock(printk_cpu);
898 nanosec_rem = do_div(t, 1000000000);
899 tlen = sprintf(tbuf, "[%5lu.%06lu] ",
903 for (tp = tbuf; tp < tbuf + tlen; tp++)
918 * Try to acquire and then immediately release the
919 * console semaphore. The release will do all the
920 * actual magic (print out buffers, wake up klogd,
923 * The console_trylock_for_printk() function
924 * will release 'logbuf_lock' regardless of whether it
925 * actually gets the semaphore or not.
927 if (console_trylock_for_printk(this_cpu))
932 raw_local_irq_restore(flags);
937 EXPORT_SYMBOL(printk);
938 EXPORT_SYMBOL(vprintk);
942 static void call_console_drivers(unsigned start, unsigned end)
948 static int __add_preferred_console(char *name, int idx, char *options,
951 struct console_cmdline *c;
955 * See if this tty is not yet registered, and
956 * if we have a slot free.
958 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
959 if (strcmp(console_cmdline[i].name, name) == 0 &&
960 console_cmdline[i].index == idx) {
962 selected_console = i;
965 if (i == MAX_CMDLINECONSOLES)
968 selected_console = i;
969 c = &console_cmdline[i];
970 strlcpy(c->name, name, sizeof(c->name));
971 c->options = options;
972 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
973 c->brl_options = brl_options;
979 * Set up a list of consoles. Called from init/main.c
981 static int __init console_setup(char *str)
983 char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for index */
984 char *s, *options, *brl_options = NULL;
987 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
988 if (!memcmp(str, "brl,", 4)) {
991 } else if (!memcmp(str, "brl=", 4)) {
992 brl_options = str + 4;
993 str = strchr(brl_options, ',');
995 printk(KERN_ERR "need port name after brl=\n");
1003 * Decode str into name, index, options.
1005 if (str[0] >= '0' && str[0] <= '9') {
1006 strcpy(buf, "ttyS");
1007 strncpy(buf + 4, str, sizeof(buf) - 5);
1009 strncpy(buf, str, sizeof(buf) - 1);
1011 buf[sizeof(buf) - 1] = 0;
1012 if ((options = strchr(str, ',')) != NULL)
1015 if (!strcmp(str, "ttya"))
1016 strcpy(buf, "ttyS0");
1017 if (!strcmp(str, "ttyb"))
1018 strcpy(buf, "ttyS1");
1020 for (s = buf; *s; s++)
1021 if ((*s >= '0' && *s <= '9') || *s == ',')
1023 idx = simple_strtoul(s, NULL, 10);
1026 __add_preferred_console(buf, idx, options, brl_options);
1027 console_set_on_cmdline = 1;
1030 __setup("console=", console_setup);
1033 * add_preferred_console - add a device to the list of preferred consoles.
1034 * @name: device name
1035 * @idx: device index
1036 * @options: options for this console
1038 * The last preferred console added will be used for kernel messages
1039 * and stdin/out/err for init. Normally this is used by console_setup
1040 * above to handle user-supplied console arguments; however it can also
1041 * be used by arch-specific code either to override the user or more
1042 * commonly to provide a default console (ie from PROM variables) when
1043 * the user has not supplied one.
1045 int add_preferred_console(char *name, int idx, char *options)
1047 return __add_preferred_console(name, idx, options, NULL);
1050 int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options)
1052 struct console_cmdline *c;
1055 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
1056 if (strcmp(console_cmdline[i].name, name) == 0 &&
1057 console_cmdline[i].index == idx) {
1058 c = &console_cmdline[i];
1059 strlcpy(c->name, name_new, sizeof(c->name));
1060 c->name[sizeof(c->name) - 1] = 0;
1061 c->options = options;
1069 int console_suspend_enabled = 1;
1070 EXPORT_SYMBOL(console_suspend_enabled);
1072 static int __init console_suspend_disable(char *str)
1074 console_suspend_enabled = 0;
1077 __setup("no_console_suspend", console_suspend_disable);
1080 * suspend_console - suspend the console subsystem
1082 * This disables printk() while we go into suspend states
1084 void suspend_console(void)
1086 if (!console_suspend_enabled)
1088 printk("Suspending console(s) (use no_console_suspend to debug)\n");
1090 console_suspended = 1;
1094 void resume_console(void)
1096 if (!console_suspend_enabled)
1099 console_suspended = 0;
1104 * console_cpu_notify - print deferred console messages after CPU hotplug
1105 * @self: notifier struct
1106 * @action: CPU hotplug event
1109 * If printk() is called from a CPU that is not online yet, the messages
1110 * will be spooled but will not show up on the console. This function is
1111 * called when a new CPU comes online (or fails to come up), and ensures
1112 * that any such output gets printed.
1114 static int __cpuinit console_cpu_notify(struct notifier_block *self,
1115 unsigned long action, void *hcpu)
1121 case CPU_DOWN_FAILED:
1122 case CPU_UP_CANCELED:
1130 * console_lock - lock the console system for exclusive use.
1132 * Acquires a lock which guarantees that the caller has
1133 * exclusive access to the console system and the console_drivers list.
1135 * Can sleep, returns nothing.
1137 void console_lock(void)
1139 BUG_ON(in_interrupt());
1141 if (console_suspended)
1144 console_may_schedule = 1;
1146 EXPORT_SYMBOL(console_lock);
1149 * console_trylock - try to lock the console system for exclusive use.
1151 * Tried to acquire a lock which guarantees that the caller has
1152 * exclusive access to the console system and the console_drivers list.
1154 * returns 1 on success, and 0 on failure to acquire the lock.
1156 int console_trylock(void)
1158 if (down_trylock(&console_sem))
1160 if (console_suspended) {
1165 console_may_schedule = 0;
1168 EXPORT_SYMBOL(console_trylock);
1170 int is_console_locked(void)
1172 return console_locked;
1175 static DEFINE_PER_CPU(int, printk_pending);
1177 void printk_tick(void)
1179 if (__this_cpu_read(printk_pending)) {
1180 __this_cpu_write(printk_pending, 0);
1181 wake_up_interruptible(&log_wait);
1185 int printk_needs_cpu(int cpu)
1187 if (cpu_is_offline(cpu))
1189 return __this_cpu_read(printk_pending);
1192 void wake_up_klogd(void)
1194 if (waitqueue_active(&log_wait))
1195 this_cpu_write(printk_pending, 1);
1199 * console_unlock - unlock the console system
1201 * Releases the console_lock which the caller holds on the console system
1202 * and the console driver list.
1204 * While the console_lock was held, console output may have been buffered
1205 * by printk(). If this is the case, console_unlock(); emits
1206 * the output prior to releasing the lock.
1208 * If there is output waiting for klogd, we wake it up.
1210 * console_unlock(); may be called from any context.
1212 void console_unlock(void)
1214 unsigned long flags;
1215 unsigned _con_start, _log_end;
1216 unsigned wake_klogd = 0;
1218 if (console_suspended) {
1223 console_may_schedule = 0;
1226 spin_lock_irqsave(&logbuf_lock, flags);
1227 wake_klogd |= log_start - log_end;
1228 if (con_start == log_end)
1229 break; /* Nothing to print */
1230 _con_start = con_start;
1232 con_start = log_end; /* Flush */
1233 spin_unlock(&logbuf_lock);
1234 stop_critical_timings(); /* don't trace print latency */
1235 call_console_drivers(_con_start, _log_end);
1236 start_critical_timings();
1237 local_irq_restore(flags);
1241 /* Release the exclusive_console once it is used */
1242 if (unlikely(exclusive_console))
1243 exclusive_console = NULL;
1246 spin_unlock_irqrestore(&logbuf_lock, flags);
1250 EXPORT_SYMBOL(console_unlock);
1253 * console_conditional_schedule - yield the CPU if required
1255 * If the console code is currently allowed to sleep, and
1256 * if this CPU should yield the CPU to another task, do
1259 * Must be called within console_lock();.
1261 void __sched console_conditional_schedule(void)
1263 if (console_may_schedule)
1266 EXPORT_SYMBOL(console_conditional_schedule);
1268 void console_unblank(void)
1273 * console_unblank can no longer be called in interrupt context unless
1274 * oops_in_progress is set to 1..
1276 if (oops_in_progress) {
1277 if (down_trylock(&console_sem) != 0)
1283 console_may_schedule = 0;
1285 if ((c->flags & CON_ENABLED) && c->unblank)
1291 * Return the console tty driver structure and its associated index
1293 struct tty_driver *console_device(int *index)
1296 struct tty_driver *driver = NULL;
1299 for_each_console(c) {
1302 driver = c->device(c, index);
1311 * Prevent further output on the passed console device so that (for example)
1312 * serial drivers can disable console output before suspending a port, and can
1313 * re-enable output afterwards.
1315 void console_stop(struct console *console)
1318 console->flags &= ~CON_ENABLED;
1321 EXPORT_SYMBOL(console_stop);
1323 void console_start(struct console *console)
1326 console->flags |= CON_ENABLED;
1329 EXPORT_SYMBOL(console_start);
1331 static int __read_mostly keep_bootcon;
1333 static int __init keep_bootcon_setup(char *str)
1336 printk(KERN_INFO "debug: skip boot console de-registration.\n");
1341 early_param("keep_bootcon", keep_bootcon_setup);
1344 * The console driver calls this routine during kernel initialization
1345 * to register the console printing procedure with printk() and to
1346 * print any messages that were printed by the kernel before the
1347 * console driver was initialized.
1349 * This can happen pretty early during the boot process (because of
1350 * early_printk) - sometimes before setup_arch() completes - be careful
1351 * of what kernel features are used - they may not be initialised yet.
1353 * There are two types of consoles - bootconsoles (early_printk) and
1354 * "real" consoles (everything which is not a bootconsole) which are
1355 * handled differently.
1356 * - Any number of bootconsoles can be registered at any time.
1357 * - As soon as a "real" console is registered, all bootconsoles
1358 * will be unregistered automatically.
1359 * - Once a "real" console is registered, any attempt to register a
1360 * bootconsoles will be rejected
1362 void register_console(struct console *newcon)
1365 unsigned long flags;
1366 struct console *bcon = NULL;
1369 * before we register a new CON_BOOT console, make sure we don't
1370 * already have a valid console
1372 if (console_drivers && newcon->flags & CON_BOOT) {
1373 /* find the last or real console */
1374 for_each_console(bcon) {
1375 if (!(bcon->flags & CON_BOOT)) {
1376 printk(KERN_INFO "Too late to register bootconsole %s%d\n",
1377 newcon->name, newcon->index);
1383 if (console_drivers && console_drivers->flags & CON_BOOT)
1384 bcon = console_drivers;
1386 if (preferred_console < 0 || bcon || !console_drivers)
1387 preferred_console = selected_console;
1389 if (newcon->early_setup)
1390 newcon->early_setup();
1393 * See if we want to use this console driver. If we
1394 * didn't select a console we take the first one
1395 * that registers here.
1397 if (preferred_console < 0) {
1398 if (newcon->index < 0)
1400 if (newcon->setup == NULL ||
1401 newcon->setup(newcon, NULL) == 0) {
1402 newcon->flags |= CON_ENABLED;
1403 if (newcon->device) {
1404 newcon->flags |= CON_CONSDEV;
1405 preferred_console = 0;
1411 * See if this console matches one we selected on
1414 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0];
1416 if (strcmp(console_cmdline[i].name, newcon->name) != 0)
1418 if (newcon->index >= 0 &&
1419 newcon->index != console_cmdline[i].index)
1421 if (newcon->index < 0)
1422 newcon->index = console_cmdline[i].index;
1423 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1424 if (console_cmdline[i].brl_options) {
1425 newcon->flags |= CON_BRL;
1426 braille_register_console(newcon,
1427 console_cmdline[i].index,
1428 console_cmdline[i].options,
1429 console_cmdline[i].brl_options);
1433 if (newcon->setup &&
1434 newcon->setup(newcon, console_cmdline[i].options) != 0)
1436 newcon->flags |= CON_ENABLED;
1437 newcon->index = console_cmdline[i].index;
1438 if (i == selected_console) {
1439 newcon->flags |= CON_CONSDEV;
1440 preferred_console = selected_console;
1445 if (!(newcon->flags & CON_ENABLED))
1449 * If we have a bootconsole, and are switching to a real console,
1450 * don't print everything out again, since when the boot console, and
1451 * the real console are the same physical device, it's annoying to
1452 * see the beginning boot messages twice
1454 if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
1455 newcon->flags &= ~CON_PRINTBUFFER;
1458 * Put this console in the list - keep the
1459 * preferred driver at the head of the list.
1462 if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
1463 newcon->next = console_drivers;
1464 console_drivers = newcon;
1466 newcon->next->flags &= ~CON_CONSDEV;
1468 newcon->next = console_drivers->next;
1469 console_drivers->next = newcon;
1471 if (newcon->flags & CON_PRINTBUFFER) {
1473 * console_unlock(); will print out the buffered messages
1476 spin_lock_irqsave(&logbuf_lock, flags);
1477 con_start = log_start;
1478 spin_unlock_irqrestore(&logbuf_lock, flags);
1480 * We're about to replay the log buffer. Only do this to the
1481 * just-registered console to avoid excessive message spam to
1482 * the already-registered consoles.
1484 exclusive_console = newcon;
1487 console_sysfs_notify();
1490 * By unregistering the bootconsoles after we enable the real console
1491 * we get the "console xxx enabled" message on all the consoles -
1492 * boot consoles, real consoles, etc - this is to ensure that end
1493 * users know there might be something in the kernel's log buffer that
1494 * went to the bootconsole (that they do not see on the real console)
1497 ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
1499 /* we need to iterate through twice, to make sure we print
1500 * everything out, before we unregister the console(s)
1502 printk(KERN_INFO "console [%s%d] enabled, bootconsole disabled\n",
1503 newcon->name, newcon->index);
1504 for_each_console(bcon)
1505 if (bcon->flags & CON_BOOT)
1506 unregister_console(bcon);
1508 printk(KERN_INFO "%sconsole [%s%d] enabled\n",
1509 (newcon->flags & CON_BOOT) ? "boot" : "" ,
1510 newcon->name, newcon->index);
1513 EXPORT_SYMBOL(register_console);
1515 int unregister_console(struct console *console)
1517 struct console *a, *b;
1520 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1521 if (console->flags & CON_BRL)
1522 return braille_unregister_console(console);
1526 if (console_drivers == console) {
1527 console_drivers=console->next;
1529 } else if (console_drivers) {
1530 for (a=console_drivers->next, b=console_drivers ;
1531 a; b=a, a=b->next) {
1541 * If this isn't the last console and it has CON_CONSDEV set, we
1542 * need to set it on the next preferred console.
1544 if (console_drivers != NULL && console->flags & CON_CONSDEV)
1545 console_drivers->flags |= CON_CONSDEV;
1548 console_sysfs_notify();
1551 EXPORT_SYMBOL(unregister_console);
1553 static int __init printk_late_init(void)
1555 struct console *con;
1557 for_each_console(con) {
1558 if (con->flags & CON_BOOT) {
1559 printk(KERN_INFO "turn off boot console %s%d\n",
1560 con->name, con->index);
1561 unregister_console(con);
1564 hotcpu_notifier(console_cpu_notify, 0);
1567 late_initcall(printk_late_init);
1569 #if defined CONFIG_PRINTK
1572 * printk rate limiting, lifted from the networking subsystem.
1574 * This enforces a rate limit: not more than 10 kernel messages
1575 * every 5s to make a denial-of-service attack impossible.
1577 DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
1579 int __printk_ratelimit(const char *func)
1581 return ___ratelimit(&printk_ratelimit_state, func);
1583 EXPORT_SYMBOL(__printk_ratelimit);
1586 * printk_timed_ratelimit - caller-controlled printk ratelimiting
1587 * @caller_jiffies: pointer to caller's state
1588 * @interval_msecs: minimum interval between prints
1590 * printk_timed_ratelimit() returns true if more than @interval_msecs
1591 * milliseconds have elapsed since the last time printk_timed_ratelimit()
1594 bool printk_timed_ratelimit(unsigned long *caller_jiffies,
1595 unsigned int interval_msecs)
1597 if (*caller_jiffies == 0
1598 || !time_in_range(jiffies, *caller_jiffies,
1600 + msecs_to_jiffies(interval_msecs))) {
1601 *caller_jiffies = jiffies;
1606 EXPORT_SYMBOL(printk_timed_ratelimit);
1608 static DEFINE_SPINLOCK(dump_list_lock);
1609 static LIST_HEAD(dump_list);
1612 * kmsg_dump_register - register a kernel log dumper.
1613 * @dumper: pointer to the kmsg_dumper structure
1615 * Adds a kernel log dumper to the system. The dump callback in the
1616 * structure will be called when the kernel oopses or panics and must be
1617 * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
1619 int kmsg_dump_register(struct kmsg_dumper *dumper)
1621 unsigned long flags;
1624 /* The dump callback needs to be set */
1628 spin_lock_irqsave(&dump_list_lock, flags);
1629 /* Don't allow registering multiple times */
1630 if (!dumper->registered) {
1631 dumper->registered = 1;
1632 list_add_tail_rcu(&dumper->list, &dump_list);
1635 spin_unlock_irqrestore(&dump_list_lock, flags);
1639 EXPORT_SYMBOL_GPL(kmsg_dump_register);
1642 * kmsg_dump_unregister - unregister a kmsg dumper.
1643 * @dumper: pointer to the kmsg_dumper structure
1645 * Removes a dump device from the system. Returns zero on success and
1646 * %-EINVAL otherwise.
1648 int kmsg_dump_unregister(struct kmsg_dumper *dumper)
1650 unsigned long flags;
1653 spin_lock_irqsave(&dump_list_lock, flags);
1654 if (dumper->registered) {
1655 dumper->registered = 0;
1656 list_del_rcu(&dumper->list);
1659 spin_unlock_irqrestore(&dump_list_lock, flags);
1664 EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
1667 * kmsg_dump - dump kernel log to kernel message dumpers.
1668 * @reason: the reason (oops, panic etc) for dumping
1670 * Iterate through each of the dump devices and call the oops/panic
1671 * callbacks with the log buffer.
1673 void kmsg_dump(enum kmsg_dump_reason reason)
1677 struct kmsg_dumper *dumper;
1678 const char *s1, *s2;
1679 unsigned long l1, l2;
1680 unsigned long flags;
1682 /* Theoretically, the log could move on after we do this, but
1683 there's not a lot we can do about that. The new messages
1684 will overwrite the start of what we dump. */
1685 spin_lock_irqsave(&logbuf_lock, flags);
1686 end = log_end & LOG_BUF_MASK;
1687 chars = logged_chars;
1688 spin_unlock_irqrestore(&logbuf_lock, flags);
1691 s1 = log_buf + log_buf_len - chars + end;
1700 s2 = log_buf + end - chars;
1705 list_for_each_entry_rcu(dumper, &dump_list, list)
1706 dumper->dump(dumper, reason, s1, l1, s2, l2);