net: fix rds_iovec page count overflow
[wandboard.git] / kernel / printk.c
blobfd86add1c0a488935e101d3698418fd527e415a0
1 /*
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).
11 * Ted Ts'o, 2/11/93.
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>
20 #include <linux/mm.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/ratelimit.h>
37 #include <linux/kmsg_dump.h>
39 #include <asm/uaccess.h>
42 * for_each_console() allows you to iterate on each console
44 #define for_each_console(con) \
45 for (con = console_drivers; con != NULL; con = con->next)
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 4 /* KERN_WARNING */
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 */
72 static int saved_console_loglevel = -1;
75 * Low level drivers may need that to know if they can schedule in
76 * their unblank() callback or not. So let's export it.
78 int oops_in_progress;
79 EXPORT_SYMBOL(oops_in_progress);
82 * console_sem protects the console_drivers list, and also
83 * provides serialisation for access to the entire console
84 * driver system.
86 static DECLARE_MUTEX(console_sem);
87 struct console *console_drivers;
88 EXPORT_SYMBOL_GPL(console_drivers);
91 * This is used for debugging the mess that is the VT code by
92 * keeping track if we have the console semaphore held. It's
93 * definitely not the perfect debug tool (we don't know if _WE_
94 * hold it are racing, but it helps tracking those weird code
95 * path in the console code where we end up in places I want
96 * locked without the console sempahore held
98 static int console_locked, console_suspended;
101 * logbuf_lock protects log_buf, log_start, log_end, con_start and logged_chars
102 * It is also used in interesting ways to provide interlocking in
103 * release_console_sem().
105 static DEFINE_SPINLOCK(logbuf_lock);
107 #define LOG_BUF_MASK (log_buf_len-1)
108 #define LOG_BUF(idx) (log_buf[(idx) & LOG_BUF_MASK])
111 * The indices into log_buf are not constrained to log_buf_len - they
112 * must be masked before subscripting
114 static unsigned log_start; /* Index into log_buf: next char to be read by syslog() */
115 static unsigned con_start; /* Index into log_buf: next char to be sent to consoles */
116 static unsigned log_end; /* Index into log_buf: most-recently-written-char + 1 */
119 * Array of consoles built from command line options (console=)
121 struct console_cmdline
123 char name[8]; /* Name of the driver */
124 int index; /* Minor dev. to use */
125 char *options; /* Options for the driver */
126 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
127 char *brl_options; /* Options for braille driver */
128 #endif
131 #define MAX_CMDLINECONSOLES 8
133 static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
134 static int selected_console = -1;
135 static int preferred_console = -1;
136 int console_set_on_cmdline;
137 EXPORT_SYMBOL(console_set_on_cmdline);
139 /* Flag: console code may call schedule() */
140 static int console_may_schedule;
142 #ifdef CONFIG_PRINTK
144 static char __log_buf[__LOG_BUF_LEN];
145 static char *log_buf = __log_buf;
146 static int log_buf_len = __LOG_BUF_LEN;
147 static unsigned logged_chars; /* Number of chars produced since last read+clear operation */
149 #ifdef CONFIG_KEXEC
151 * This appends the listed symbols to /proc/vmcoreinfo
153 * /proc/vmcoreinfo is used by various utiilties, like crash and makedumpfile to
154 * obtain access to symbols that are otherwise very difficult to locate. These
155 * symbols are specifically used so that utilities can access and extract the
156 * dmesg log from a vmcore file after a crash.
158 void log_buf_kexec_setup(void)
160 VMCOREINFO_SYMBOL(log_buf);
161 VMCOREINFO_SYMBOL(log_end);
162 VMCOREINFO_SYMBOL(log_buf_len);
163 VMCOREINFO_SYMBOL(logged_chars);
165 #endif
167 static int __init log_buf_len_setup(char *str)
169 unsigned size = memparse(str, &str);
170 unsigned long flags;
172 if (size)
173 size = roundup_pow_of_two(size);
174 if (size > log_buf_len) {
175 unsigned start, dest_idx, offset;
176 char *new_log_buf;
178 new_log_buf = alloc_bootmem(size);
179 if (!new_log_buf) {
180 printk(KERN_WARNING "log_buf_len: allocation failed\n");
181 goto out;
184 spin_lock_irqsave(&logbuf_lock, flags);
185 log_buf_len = size;
186 log_buf = new_log_buf;
188 offset = start = min(con_start, log_start);
189 dest_idx = 0;
190 while (start != log_end) {
191 log_buf[dest_idx] = __log_buf[start & (__LOG_BUF_LEN - 1)];
192 start++;
193 dest_idx++;
195 log_start -= offset;
196 con_start -= offset;
197 log_end -= offset;
198 spin_unlock_irqrestore(&logbuf_lock, flags);
200 printk(KERN_NOTICE "log_buf_len: %d\n", log_buf_len);
202 out:
203 return 1;
206 __setup("log_buf_len=", log_buf_len_setup);
208 #ifdef CONFIG_BOOT_PRINTK_DELAY
210 static unsigned int boot_delay; /* msecs delay after each printk during bootup */
211 static unsigned long long loops_per_msec; /* based on boot_delay */
213 static int __init boot_delay_setup(char *str)
215 unsigned long lpj;
217 lpj = preset_lpj ? preset_lpj : 1000000; /* some guess */
218 loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
220 get_option(&str, &boot_delay);
221 if (boot_delay > 10 * 1000)
222 boot_delay = 0;
224 pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
225 "HZ: %d, loops_per_msec: %llu\n",
226 boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
227 return 1;
229 __setup("boot_delay=", boot_delay_setup);
231 static void boot_delay_msec(void)
233 unsigned long long k;
234 unsigned long timeout;
236 if (boot_delay == 0 || system_state != SYSTEM_BOOTING)
237 return;
239 k = (unsigned long long)loops_per_msec * boot_delay;
241 timeout = jiffies + msecs_to_jiffies(boot_delay);
242 while (k) {
243 k--;
244 cpu_relax();
246 * use (volatile) jiffies to prevent
247 * compiler reduction; loop termination via jiffies
248 * is secondary and may or may not happen.
250 if (time_after(jiffies, timeout))
251 break;
252 touch_nmi_watchdog();
255 #else
256 static inline void boot_delay_msec(void)
259 #endif
262 * Commands to do_syslog:
264 * 0 -- Close the log. Currently a NOP.
265 * 1 -- Open the log. Currently a NOP.
266 * 2 -- Read from the log.
267 * 3 -- Read all messages remaining in the ring buffer.
268 * 4 -- Read and clear all messages remaining in the ring buffer
269 * 5 -- Clear ring buffer.
270 * 6 -- Disable printk's to console
271 * 7 -- Enable printk's to console
272 * 8 -- Set level of messages printed to console
273 * 9 -- Return number of unread characters in the log buffer
274 * 10 -- Return size of the log buffer
276 int do_syslog(int type, char __user *buf, int len)
278 unsigned i, j, limit, count;
279 int do_clear = 0;
280 char c;
281 int error = 0;
283 error = security_syslog(type);
284 if (error)
285 return error;
287 switch (type) {
288 case 0: /* Close log */
289 break;
290 case 1: /* Open log */
291 break;
292 case 2: /* Read from log */
293 error = -EINVAL;
294 if (!buf || len < 0)
295 goto out;
296 error = 0;
297 if (!len)
298 goto out;
299 if (!access_ok(VERIFY_WRITE, buf, len)) {
300 error = -EFAULT;
301 goto out;
303 error = wait_event_interruptible(log_wait,
304 (log_start - log_end));
305 if (error)
306 goto out;
307 i = 0;
308 spin_lock_irq(&logbuf_lock);
309 while (!error && (log_start != log_end) && i < len) {
310 c = LOG_BUF(log_start);
311 log_start++;
312 spin_unlock_irq(&logbuf_lock);
313 error = __put_user(c,buf);
314 buf++;
315 i++;
316 cond_resched();
317 spin_lock_irq(&logbuf_lock);
319 spin_unlock_irq(&logbuf_lock);
320 if (!error)
321 error = i;
322 break;
323 case 4: /* Read/clear last kernel messages */
324 do_clear = 1;
325 /* FALL THRU */
326 case 3: /* Read last kernel messages */
327 error = -EINVAL;
328 if (!buf || len < 0)
329 goto out;
330 error = 0;
331 if (!len)
332 goto out;
333 if (!access_ok(VERIFY_WRITE, buf, len)) {
334 error = -EFAULT;
335 goto out;
337 count = len;
338 if (count > log_buf_len)
339 count = log_buf_len;
340 spin_lock_irq(&logbuf_lock);
341 if (count > logged_chars)
342 count = logged_chars;
343 if (do_clear)
344 logged_chars = 0;
345 limit = log_end;
347 * __put_user() could sleep, and while we sleep
348 * printk() could overwrite the messages
349 * we try to copy to user space. Therefore
350 * the messages are copied in reverse. <manfreds>
352 for (i = 0; i < count && !error; i++) {
353 j = limit-1-i;
354 if (j + log_buf_len < log_end)
355 break;
356 c = LOG_BUF(j);
357 spin_unlock_irq(&logbuf_lock);
358 error = __put_user(c,&buf[count-1-i]);
359 cond_resched();
360 spin_lock_irq(&logbuf_lock);
362 spin_unlock_irq(&logbuf_lock);
363 if (error)
364 break;
365 error = i;
366 if (i != count) {
367 int offset = count-error;
368 /* buffer overflow during copy, correct user buffer. */
369 for (i = 0; i < error; i++) {
370 if (__get_user(c,&buf[i+offset]) ||
371 __put_user(c,&buf[i])) {
372 error = -EFAULT;
373 break;
375 cond_resched();
378 break;
379 case 5: /* Clear ring buffer */
380 logged_chars = 0;
381 break;
382 case 6: /* Disable logging to console */
383 if (saved_console_loglevel == -1)
384 saved_console_loglevel = console_loglevel;
385 console_loglevel = minimum_console_loglevel;
386 break;
387 case 7: /* Enable logging to console */
388 if (saved_console_loglevel != -1) {
389 console_loglevel = saved_console_loglevel;
390 saved_console_loglevel = -1;
392 break;
393 case 8: /* Set level of messages printed to console */
394 error = -EINVAL;
395 if (len < 1 || len > 8)
396 goto out;
397 if (len < minimum_console_loglevel)
398 len = minimum_console_loglevel;
399 console_loglevel = len;
400 /* Implicitly re-enable logging to console */
401 saved_console_loglevel = -1;
402 error = 0;
403 break;
404 case 9: /* Number of chars in the log buffer */
405 error = log_end - log_start;
406 break;
407 case 10: /* Size of the log buffer */
408 error = log_buf_len;
409 break;
410 default:
411 error = -EINVAL;
412 break;
414 out:
415 return error;
418 SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
420 return do_syslog(type, buf, len);
424 * Call the console drivers on a range of log_buf
426 static void __call_console_drivers(unsigned start, unsigned end)
428 struct console *con;
430 for_each_console(con) {
431 if ((con->flags & CON_ENABLED) && con->write &&
432 (cpu_online(smp_processor_id()) ||
433 (con->flags & CON_ANYTIME)))
434 con->write(con, &LOG_BUF(start), end - start);
438 static int __read_mostly ignore_loglevel;
440 static int __init ignore_loglevel_setup(char *str)
442 ignore_loglevel = 1;
443 printk(KERN_INFO "debug: ignoring loglevel setting.\n");
445 return 0;
448 early_param("ignore_loglevel", ignore_loglevel_setup);
451 * Write out chars from start to end - 1 inclusive
453 static void _call_console_drivers(unsigned start,
454 unsigned end, int msg_log_level)
456 if ((msg_log_level < console_loglevel || ignore_loglevel) &&
457 console_drivers && start != end) {
458 if ((start & LOG_BUF_MASK) > (end & LOG_BUF_MASK)) {
459 /* wrapped write */
460 __call_console_drivers(start & LOG_BUF_MASK,
461 log_buf_len);
462 __call_console_drivers(0, end & LOG_BUF_MASK);
463 } else {
464 __call_console_drivers(start, end);
470 * Call the console drivers, asking them to write out
471 * log_buf[start] to log_buf[end - 1].
472 * The console_sem must be held.
474 static void call_console_drivers(unsigned start, unsigned end)
476 unsigned cur_index, start_print;
477 static int msg_level = -1;
479 BUG_ON(((int)(start - end)) > 0);
481 cur_index = start;
482 start_print = start;
483 while (cur_index != end) {
484 if (msg_level < 0 && ((end - cur_index) > 2) &&
485 LOG_BUF(cur_index + 0) == '<' &&
486 LOG_BUF(cur_index + 1) >= '0' &&
487 LOG_BUF(cur_index + 1) <= '7' &&
488 LOG_BUF(cur_index + 2) == '>') {
489 msg_level = LOG_BUF(cur_index + 1) - '0';
490 cur_index += 3;
491 start_print = cur_index;
493 while (cur_index != end) {
494 char c = LOG_BUF(cur_index);
496 cur_index++;
497 if (c == '\n') {
498 if (msg_level < 0) {
500 * printk() has already given us loglevel tags in
501 * the buffer. This code is here in case the
502 * log buffer has wrapped right round and scribbled
503 * on those tags
505 msg_level = default_message_loglevel;
507 _call_console_drivers(start_print, cur_index, msg_level);
508 msg_level = -1;
509 start_print = cur_index;
510 break;
514 _call_console_drivers(start_print, end, msg_level);
517 static void emit_log_char(char c)
519 LOG_BUF(log_end) = c;
520 log_end++;
521 if (log_end - log_start > log_buf_len)
522 log_start = log_end - log_buf_len;
523 if (log_end - con_start > log_buf_len)
524 con_start = log_end - log_buf_len;
525 if (logged_chars < log_buf_len)
526 logged_chars++;
530 * Zap console related locks when oopsing. Only zap at most once
531 * every 10 seconds, to leave time for slow consoles to print a
532 * full oops.
534 static void zap_locks(void)
536 static unsigned long oops_timestamp;
538 if (time_after_eq(jiffies, oops_timestamp) &&
539 !time_after(jiffies, oops_timestamp + 30 * HZ))
540 return;
542 oops_timestamp = jiffies;
544 /* If a crash is occurring, make sure we can't deadlock */
545 spin_lock_init(&logbuf_lock);
546 /* And make sure that we print immediately */
547 init_MUTEX(&console_sem);
550 #if defined(CONFIG_PRINTK_TIME)
551 static int printk_time = 1;
552 #else
553 static int printk_time = 0;
554 #endif
555 module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
557 /* Check if we have any console registered that can be called early in boot. */
558 static int have_callable_console(void)
560 struct console *con;
562 for_each_console(con)
563 if (con->flags & CON_ANYTIME)
564 return 1;
566 return 0;
570 * printk - print a kernel message
571 * @fmt: format string
573 * This is printk(). It can be called from any context. We want it to work.
575 * We try to grab the console_sem. If we succeed, it's easy - we log the output and
576 * call the console drivers. If we fail to get the semaphore we place the output
577 * into the log buffer and return. The current holder of the console_sem will
578 * notice the new output in release_console_sem() and will send it to the
579 * consoles before releasing the semaphore.
581 * One effect of this deferred printing is that code which calls printk() and
582 * then changes console_loglevel may break. This is because console_loglevel
583 * is inspected when the actual printing occurs.
585 * See also:
586 * printf(3)
588 * See the vsnprintf() documentation for format string extensions over C99.
591 asmlinkage int printk(const char *fmt, ...)
593 va_list args;
594 int r;
596 va_start(args, fmt);
597 r = vprintk(fmt, args);
598 va_end(args);
600 return r;
603 /* cpu currently holding logbuf_lock */
604 static volatile unsigned int printk_cpu = UINT_MAX;
607 * Can we actually use the console at this time on this cpu?
609 * Console drivers may assume that per-cpu resources have
610 * been allocated. So unless they're explicitly marked as
611 * being able to cope (CON_ANYTIME) don't call them until
612 * this CPU is officially up.
614 static inline int can_use_console(unsigned int cpu)
616 return cpu_online(cpu) || have_callable_console();
620 * Try to get console ownership to actually show the kernel
621 * messages from a 'printk'. Return true (and with the
622 * console_semaphore held, and 'console_locked' set) if it
623 * is successful, false otherwise.
625 * This gets called with the 'logbuf_lock' spinlock held and
626 * interrupts disabled. It should return with 'lockbuf_lock'
627 * released but interrupts still disabled.
629 static int acquire_console_semaphore_for_printk(unsigned int cpu)
631 int retval = 0;
633 if (!try_acquire_console_sem()) {
634 retval = 1;
637 * If we can't use the console, we need to release
638 * the console semaphore by hand to avoid flushing
639 * the buffer. We need to hold the console semaphore
640 * in order to do this test safely.
642 if (!can_use_console(cpu)) {
643 console_locked = 0;
644 up(&console_sem);
645 retval = 0;
648 printk_cpu = UINT_MAX;
649 spin_unlock(&logbuf_lock);
650 return retval;
652 static const char recursion_bug_msg [] =
653 KERN_CRIT "BUG: recent printk recursion!\n";
654 static int recursion_bug;
655 static int new_text_line = 1;
656 static char printk_buf[1024];
658 int printk_delay_msec __read_mostly;
660 static inline void printk_delay(void)
662 if (unlikely(printk_delay_msec)) {
663 int m = printk_delay_msec;
665 while (m--) {
666 mdelay(1);
667 touch_nmi_watchdog();
672 asmlinkage int vprintk(const char *fmt, va_list args)
674 int printed_len = 0;
675 int current_log_level = default_message_loglevel;
676 unsigned long flags;
677 int this_cpu;
678 char *p;
680 boot_delay_msec();
681 printk_delay();
683 preempt_disable();
684 /* This stops the holder of console_sem just where we want him */
685 raw_local_irq_save(flags);
686 this_cpu = smp_processor_id();
689 * Ouch, printk recursed into itself!
691 if (unlikely(printk_cpu == this_cpu)) {
693 * If a crash is occurring during printk() on this CPU,
694 * then try to get the crash message out but make sure
695 * we can't deadlock. Otherwise just return to avoid the
696 * recursion and return - but flag the recursion so that
697 * it can be printed at the next appropriate moment:
699 if (!oops_in_progress) {
700 recursion_bug = 1;
701 goto out_restore_irqs;
703 zap_locks();
706 lockdep_off();
707 spin_lock(&logbuf_lock);
708 printk_cpu = this_cpu;
710 if (recursion_bug) {
711 recursion_bug = 0;
712 strcpy(printk_buf, recursion_bug_msg);
713 printed_len = strlen(recursion_bug_msg);
715 /* Emit the output into the temporary buffer */
716 printed_len += vscnprintf(printk_buf + printed_len,
717 sizeof(printk_buf) - printed_len, fmt, args);
720 p = printk_buf;
722 /* Do we have a loglevel in the string? */
723 if (p[0] == '<') {
724 unsigned char c = p[1];
725 if (c && p[2] == '>') {
726 switch (c) {
727 case '0' ... '7': /* loglevel */
728 current_log_level = c - '0';
729 /* Fallthrough - make sure we're on a new line */
730 case 'd': /* KERN_DEFAULT */
731 if (!new_text_line) {
732 emit_log_char('\n');
733 new_text_line = 1;
735 /* Fallthrough - skip the loglevel */
736 case 'c': /* KERN_CONT */
737 p += 3;
738 break;
744 * Copy the output into log_buf. If the caller didn't provide
745 * appropriate log level tags, we insert them here
747 for ( ; *p; p++) {
748 if (new_text_line) {
749 /* Always output the token */
750 emit_log_char('<');
751 emit_log_char(current_log_level + '0');
752 emit_log_char('>');
753 printed_len += 3;
754 new_text_line = 0;
756 if (printk_time) {
757 /* Follow the token with the time */
758 char tbuf[50], *tp;
759 unsigned tlen;
760 unsigned long long t;
761 unsigned long nanosec_rem;
763 t = cpu_clock(printk_cpu);
764 nanosec_rem = do_div(t, 1000000000);
765 tlen = sprintf(tbuf, "[%5lu.%06lu] ",
766 (unsigned long) t,
767 nanosec_rem / 1000);
769 for (tp = tbuf; tp < tbuf + tlen; tp++)
770 emit_log_char(*tp);
771 printed_len += tlen;
774 if (!*p)
775 break;
778 emit_log_char(*p);
779 if (*p == '\n')
780 new_text_line = 1;
784 * Try to acquire and then immediately release the
785 * console semaphore. The release will do all the
786 * actual magic (print out buffers, wake up klogd,
787 * etc).
789 * The acquire_console_semaphore_for_printk() function
790 * will release 'logbuf_lock' regardless of whether it
791 * actually gets the semaphore or not.
793 if (acquire_console_semaphore_for_printk(this_cpu))
794 release_console_sem();
796 lockdep_on();
797 out_restore_irqs:
798 raw_local_irq_restore(flags);
800 preempt_enable();
801 return printed_len;
803 EXPORT_SYMBOL(printk);
804 EXPORT_SYMBOL(vprintk);
806 #else
808 static void call_console_drivers(unsigned start, unsigned end)
812 #endif
814 static int __add_preferred_console(char *name, int idx, char *options,
815 char *brl_options)
817 struct console_cmdline *c;
818 int i;
821 * See if this tty is not yet registered, and
822 * if we have a slot free.
824 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
825 if (strcmp(console_cmdline[i].name, name) == 0 &&
826 console_cmdline[i].index == idx) {
827 if (!brl_options)
828 selected_console = i;
829 return 0;
831 if (i == MAX_CMDLINECONSOLES)
832 return -E2BIG;
833 if (!brl_options)
834 selected_console = i;
835 c = &console_cmdline[i];
836 strlcpy(c->name, name, sizeof(c->name));
837 c->options = options;
838 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
839 c->brl_options = brl_options;
840 #endif
841 c->index = idx;
842 return 0;
845 * Set up a list of consoles. Called from init/main.c
847 static int __init console_setup(char *str)
849 char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for index */
850 char *s, *options, *brl_options = NULL;
851 int idx;
853 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
854 if (!memcmp(str, "brl,", 4)) {
855 brl_options = "";
856 str += 4;
857 } else if (!memcmp(str, "brl=", 4)) {
858 brl_options = str + 4;
859 str = strchr(brl_options, ',');
860 if (!str) {
861 printk(KERN_ERR "need port name after brl=\n");
862 return 1;
864 *(str++) = 0;
866 #endif
869 * Decode str into name, index, options.
871 if (str[0] >= '0' && str[0] <= '9') {
872 strcpy(buf, "ttyS");
873 strncpy(buf + 4, str, sizeof(buf) - 5);
874 } else {
875 strncpy(buf, str, sizeof(buf) - 1);
877 buf[sizeof(buf) - 1] = 0;
878 if ((options = strchr(str, ',')) != NULL)
879 *(options++) = 0;
880 #ifdef __sparc__
881 if (!strcmp(str, "ttya"))
882 strcpy(buf, "ttyS0");
883 if (!strcmp(str, "ttyb"))
884 strcpy(buf, "ttyS1");
885 #endif
886 for (s = buf; *s; s++)
887 if ((*s >= '0' && *s <= '9') || *s == ',')
888 break;
889 idx = simple_strtoul(s, NULL, 10);
890 *s = 0;
892 __add_preferred_console(buf, idx, options, brl_options);
893 console_set_on_cmdline = 1;
894 return 1;
896 __setup("console=", console_setup);
899 * add_preferred_console - add a device to the list of preferred consoles.
900 * @name: device name
901 * @idx: device index
902 * @options: options for this console
904 * The last preferred console added will be used for kernel messages
905 * and stdin/out/err for init. Normally this is used by console_setup
906 * above to handle user-supplied console arguments; however it can also
907 * be used by arch-specific code either to override the user or more
908 * commonly to provide a default console (ie from PROM variables) when
909 * the user has not supplied one.
911 int add_preferred_console(char *name, int idx, char *options)
913 return __add_preferred_console(name, idx, options, NULL);
916 int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options)
918 struct console_cmdline *c;
919 int i;
921 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
922 if (strcmp(console_cmdline[i].name, name) == 0 &&
923 console_cmdline[i].index == idx) {
924 c = &console_cmdline[i];
925 strlcpy(c->name, name_new, sizeof(c->name));
926 c->name[sizeof(c->name) - 1] = 0;
927 c->options = options;
928 c->index = idx_new;
929 return i;
931 /* not found */
932 return -1;
935 int console_suspend_enabled = 1;
936 EXPORT_SYMBOL(console_suspend_enabled);
938 static int __init console_suspend_disable(char *str)
940 console_suspend_enabled = 0;
941 return 1;
943 __setup("no_console_suspend", console_suspend_disable);
946 * suspend_console - suspend the console subsystem
948 * This disables printk() while we go into suspend states
950 void suspend_console(void)
952 if (!console_suspend_enabled)
953 return;
954 printk("Suspending console(s) (use no_console_suspend to debug)\n");
955 acquire_console_sem();
956 console_suspended = 1;
957 up(&console_sem);
960 void resume_console(void)
962 if (!console_suspend_enabled)
963 return;
964 down(&console_sem);
965 console_suspended = 0;
966 release_console_sem();
970 * acquire_console_sem - lock the console system for exclusive use.
972 * Acquires a semaphore which guarantees that the caller has
973 * exclusive access to the console system and the console_drivers list.
975 * Can sleep, returns nothing.
977 void acquire_console_sem(void)
979 BUG_ON(in_interrupt());
980 down(&console_sem);
981 if (console_suspended)
982 return;
983 console_locked = 1;
984 console_may_schedule = 1;
986 EXPORT_SYMBOL(acquire_console_sem);
988 int try_acquire_console_sem(void)
990 if (down_trylock(&console_sem))
991 return -1;
992 if (console_suspended) {
993 up(&console_sem);
994 return -1;
996 console_locked = 1;
997 console_may_schedule = 0;
998 return 0;
1000 EXPORT_SYMBOL(try_acquire_console_sem);
1002 int is_console_locked(void)
1004 return console_locked;
1007 static DEFINE_PER_CPU(int, printk_pending);
1009 void printk_tick(void)
1011 if (__get_cpu_var(printk_pending)) {
1012 __get_cpu_var(printk_pending) = 0;
1013 wake_up_interruptible(&log_wait);
1017 int printk_needs_cpu(int cpu)
1019 if (unlikely(cpu_is_offline(cpu)))
1020 printk_tick();
1021 return per_cpu(printk_pending, cpu);
1024 void wake_up_klogd(void)
1026 if (waitqueue_active(&log_wait))
1027 __raw_get_cpu_var(printk_pending) = 1;
1031 * release_console_sem - unlock the console system
1033 * Releases the semaphore which the caller holds on the console system
1034 * and the console driver list.
1036 * While the semaphore was held, console output may have been buffered
1037 * by printk(). If this is the case, release_console_sem() emits
1038 * the output prior to releasing the semaphore.
1040 * If there is output waiting for klogd, we wake it up.
1042 * release_console_sem() may be called from any context.
1044 void release_console_sem(void)
1046 unsigned long flags;
1047 unsigned _con_start, _log_end;
1048 unsigned wake_klogd = 0;
1050 if (console_suspended) {
1051 up(&console_sem);
1052 return;
1055 console_may_schedule = 0;
1057 for ( ; ; ) {
1058 spin_lock_irqsave(&logbuf_lock, flags);
1059 wake_klogd |= log_start - log_end;
1060 if (con_start == log_end)
1061 break; /* Nothing to print */
1062 _con_start = con_start;
1063 _log_end = log_end;
1064 con_start = log_end; /* Flush */
1065 spin_unlock(&logbuf_lock);
1066 stop_critical_timings(); /* don't trace print latency */
1067 call_console_drivers(_con_start, _log_end);
1068 start_critical_timings();
1069 local_irq_restore(flags);
1071 console_locked = 0;
1072 up(&console_sem);
1073 spin_unlock_irqrestore(&logbuf_lock, flags);
1074 if (wake_klogd)
1075 wake_up_klogd();
1077 EXPORT_SYMBOL(release_console_sem);
1080 * console_conditional_schedule - yield the CPU if required
1082 * If the console code is currently allowed to sleep, and
1083 * if this CPU should yield the CPU to another task, do
1084 * so here.
1086 * Must be called within acquire_console_sem().
1088 void __sched console_conditional_schedule(void)
1090 if (console_may_schedule)
1091 cond_resched();
1093 EXPORT_SYMBOL(console_conditional_schedule);
1095 void console_unblank(void)
1097 struct console *c;
1100 * console_unblank can no longer be called in interrupt context unless
1101 * oops_in_progress is set to 1..
1103 if (oops_in_progress) {
1104 if (down_trylock(&console_sem) != 0)
1105 return;
1106 } else
1107 acquire_console_sem();
1109 console_locked = 1;
1110 console_may_schedule = 0;
1111 for_each_console(c)
1112 if ((c->flags & CON_ENABLED) && c->unblank)
1113 c->unblank();
1114 release_console_sem();
1118 * Return the console tty driver structure and its associated index
1120 struct tty_driver *console_device(int *index)
1122 struct console *c;
1123 struct tty_driver *driver = NULL;
1125 acquire_console_sem();
1126 for_each_console(c) {
1127 if (!c->device)
1128 continue;
1129 driver = c->device(c, index);
1130 if (driver)
1131 break;
1133 release_console_sem();
1134 return driver;
1138 * Prevent further output on the passed console device so that (for example)
1139 * serial drivers can disable console output before suspending a port, and can
1140 * re-enable output afterwards.
1142 void console_stop(struct console *console)
1144 acquire_console_sem();
1145 console->flags &= ~CON_ENABLED;
1146 release_console_sem();
1148 EXPORT_SYMBOL(console_stop);
1150 void console_start(struct console *console)
1152 acquire_console_sem();
1153 console->flags |= CON_ENABLED;
1154 release_console_sem();
1156 EXPORT_SYMBOL(console_start);
1159 * The console driver calls this routine during kernel initialization
1160 * to register the console printing procedure with printk() and to
1161 * print any messages that were printed by the kernel before the
1162 * console driver was initialized.
1164 * This can happen pretty early during the boot process (because of
1165 * early_printk) - sometimes before setup_arch() completes - be careful
1166 * of what kernel features are used - they may not be initialised yet.
1168 * There are two types of consoles - bootconsoles (early_printk) and
1169 * "real" consoles (everything which is not a bootconsole) which are
1170 * handled differently.
1171 * - Any number of bootconsoles can be registered at any time.
1172 * - As soon as a "real" console is registered, all bootconsoles
1173 * will be unregistered automatically.
1174 * - Once a "real" console is registered, any attempt to register a
1175 * bootconsoles will be rejected
1177 void register_console(struct console *newcon)
1179 int i;
1180 unsigned long flags;
1181 struct console *bcon = NULL;
1184 * before we register a new CON_BOOT console, make sure we don't
1185 * already have a valid console
1187 if (console_drivers && newcon->flags & CON_BOOT) {
1188 /* find the last or real console */
1189 for_each_console(bcon) {
1190 if (!(bcon->flags & CON_BOOT)) {
1191 printk(KERN_INFO "Too late to register bootconsole %s%d\n",
1192 newcon->name, newcon->index);
1193 return;
1198 if (console_drivers && console_drivers->flags & CON_BOOT)
1199 bcon = console_drivers;
1201 if (preferred_console < 0 || bcon || !console_drivers)
1202 preferred_console = selected_console;
1204 if (newcon->early_setup)
1205 newcon->early_setup();
1208 * See if we want to use this console driver. If we
1209 * didn't select a console we take the first one
1210 * that registers here.
1212 if (preferred_console < 0) {
1213 if (newcon->index < 0)
1214 newcon->index = 0;
1215 if (newcon->setup == NULL ||
1216 newcon->setup(newcon, NULL) == 0) {
1217 newcon->flags |= CON_ENABLED;
1218 if (newcon->device) {
1219 newcon->flags |= CON_CONSDEV;
1220 preferred_console = 0;
1226 * See if this console matches one we selected on
1227 * the command line.
1229 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0];
1230 i++) {
1231 if (strcmp(console_cmdline[i].name, newcon->name) != 0)
1232 continue;
1233 if (newcon->index >= 0 &&
1234 newcon->index != console_cmdline[i].index)
1235 continue;
1236 if (newcon->index < 0)
1237 newcon->index = console_cmdline[i].index;
1238 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1239 if (console_cmdline[i].brl_options) {
1240 newcon->flags |= CON_BRL;
1241 braille_register_console(newcon,
1242 console_cmdline[i].index,
1243 console_cmdline[i].options,
1244 console_cmdline[i].brl_options);
1245 return;
1247 #endif
1248 if (newcon->setup &&
1249 newcon->setup(newcon, console_cmdline[i].options) != 0)
1250 break;
1251 newcon->flags |= CON_ENABLED;
1252 newcon->index = console_cmdline[i].index;
1253 if (i == selected_console) {
1254 newcon->flags |= CON_CONSDEV;
1255 preferred_console = selected_console;
1257 break;
1260 if (!(newcon->flags & CON_ENABLED))
1261 return;
1264 * If we have a bootconsole, and are switching to a real console,
1265 * don't print everything out again, since when the boot console, and
1266 * the real console are the same physical device, it's annoying to
1267 * see the beginning boot messages twice
1269 if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
1270 newcon->flags &= ~CON_PRINTBUFFER;
1273 * Put this console in the list - keep the
1274 * preferred driver at the head of the list.
1276 acquire_console_sem();
1277 if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
1278 newcon->next = console_drivers;
1279 console_drivers = newcon;
1280 if (newcon->next)
1281 newcon->next->flags &= ~CON_CONSDEV;
1282 } else {
1283 newcon->next = console_drivers->next;
1284 console_drivers->next = newcon;
1286 if (newcon->flags & CON_PRINTBUFFER) {
1288 * release_console_sem() will print out the buffered messages
1289 * for us.
1291 spin_lock_irqsave(&logbuf_lock, flags);
1292 con_start = log_start;
1293 spin_unlock_irqrestore(&logbuf_lock, flags);
1295 release_console_sem();
1298 * By unregistering the bootconsoles after we enable the real console
1299 * we get the "console xxx enabled" message on all the consoles -
1300 * boot consoles, real consoles, etc - this is to ensure that end
1301 * users know there might be something in the kernel's log buffer that
1302 * went to the bootconsole (that they do not see on the real console)
1304 if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV)) {
1305 /* we need to iterate through twice, to make sure we print
1306 * everything out, before we unregister the console(s)
1308 printk(KERN_INFO "console [%s%d] enabled, bootconsole disabled\n",
1309 newcon->name, newcon->index);
1310 for_each_console(bcon)
1311 if (bcon->flags & CON_BOOT)
1312 unregister_console(bcon);
1313 } else {
1314 printk(KERN_INFO "%sconsole [%s%d] enabled\n",
1315 (newcon->flags & CON_BOOT) ? "boot" : "" ,
1316 newcon->name, newcon->index);
1319 EXPORT_SYMBOL(register_console);
1321 int unregister_console(struct console *console)
1323 struct console *a, *b;
1324 int res = 1;
1326 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1327 if (console->flags & CON_BRL)
1328 return braille_unregister_console(console);
1329 #endif
1331 acquire_console_sem();
1332 if (console_drivers == console) {
1333 console_drivers=console->next;
1334 res = 0;
1335 } else if (console_drivers) {
1336 for (a=console_drivers->next, b=console_drivers ;
1337 a; b=a, a=b->next) {
1338 if (a == console) {
1339 b->next = a->next;
1340 res = 0;
1341 break;
1347 * If this isn't the last console and it has CON_CONSDEV set, we
1348 * need to set it on the next preferred console.
1350 if (console_drivers != NULL && console->flags & CON_CONSDEV)
1351 console_drivers->flags |= CON_CONSDEV;
1353 release_console_sem();
1354 return res;
1356 EXPORT_SYMBOL(unregister_console);
1358 static int __init disable_boot_consoles(void)
1360 struct console *con;
1362 for_each_console(con) {
1363 if (con->flags & CON_BOOT) {
1364 printk(KERN_INFO "turn off boot console %s%d\n",
1365 con->name, con->index);
1366 unregister_console(con);
1369 return 0;
1371 late_initcall(disable_boot_consoles);
1373 #if defined CONFIG_PRINTK
1376 * printk rate limiting, lifted from the networking subsystem.
1378 * This enforces a rate limit: not more than 10 kernel messages
1379 * every 5s to make a denial-of-service attack impossible.
1381 DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
1383 int __printk_ratelimit(const char *func)
1385 return ___ratelimit(&printk_ratelimit_state, func);
1387 EXPORT_SYMBOL(__printk_ratelimit);
1390 * printk_timed_ratelimit - caller-controlled printk ratelimiting
1391 * @caller_jiffies: pointer to caller's state
1392 * @interval_msecs: minimum interval between prints
1394 * printk_timed_ratelimit() returns true if more than @interval_msecs
1395 * milliseconds have elapsed since the last time printk_timed_ratelimit()
1396 * returned true.
1398 bool printk_timed_ratelimit(unsigned long *caller_jiffies,
1399 unsigned int interval_msecs)
1401 if (*caller_jiffies == 0
1402 || !time_in_range(jiffies, *caller_jiffies,
1403 *caller_jiffies
1404 + msecs_to_jiffies(interval_msecs))) {
1405 *caller_jiffies = jiffies;
1406 return true;
1408 return false;
1410 EXPORT_SYMBOL(printk_timed_ratelimit);
1412 static DEFINE_SPINLOCK(dump_list_lock);
1413 static LIST_HEAD(dump_list);
1416 * kmsg_dump_register - register a kernel log dumper.
1417 * @dumper: pointer to the kmsg_dumper structure
1419 * Adds a kernel log dumper to the system. The dump callback in the
1420 * structure will be called when the kernel oopses or panics and must be
1421 * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
1423 int kmsg_dump_register(struct kmsg_dumper *dumper)
1425 unsigned long flags;
1426 int err = -EBUSY;
1428 /* The dump callback needs to be set */
1429 if (!dumper->dump)
1430 return -EINVAL;
1432 spin_lock_irqsave(&dump_list_lock, flags);
1433 /* Don't allow registering multiple times */
1434 if (!dumper->registered) {
1435 dumper->registered = 1;
1436 list_add_tail(&dumper->list, &dump_list);
1437 err = 0;
1439 spin_unlock_irqrestore(&dump_list_lock, flags);
1441 return err;
1443 EXPORT_SYMBOL_GPL(kmsg_dump_register);
1446 * kmsg_dump_unregister - unregister a kmsg dumper.
1447 * @dumper: pointer to the kmsg_dumper structure
1449 * Removes a dump device from the system. Returns zero on success and
1450 * %-EINVAL otherwise.
1452 int kmsg_dump_unregister(struct kmsg_dumper *dumper)
1454 unsigned long flags;
1455 int err = -EINVAL;
1457 spin_lock_irqsave(&dump_list_lock, flags);
1458 if (dumper->registered) {
1459 dumper->registered = 0;
1460 list_del(&dumper->list);
1461 err = 0;
1463 spin_unlock_irqrestore(&dump_list_lock, flags);
1465 return err;
1467 EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
1469 static const char const *kmsg_reasons[] = {
1470 [KMSG_DUMP_OOPS] = "oops",
1471 [KMSG_DUMP_PANIC] = "panic",
1472 [KMSG_DUMP_KEXEC] = "kexec",
1475 static const char *kmsg_to_str(enum kmsg_dump_reason reason)
1477 if (reason >= ARRAY_SIZE(kmsg_reasons) || reason < 0)
1478 return "unknown";
1480 return kmsg_reasons[reason];
1484 * kmsg_dump - dump kernel log to kernel message dumpers.
1485 * @reason: the reason (oops, panic etc) for dumping
1487 * Iterate through each of the dump devices and call the oops/panic
1488 * callbacks with the log buffer.
1490 void kmsg_dump(enum kmsg_dump_reason reason)
1492 unsigned long end;
1493 unsigned chars;
1494 struct kmsg_dumper *dumper;
1495 const char *s1, *s2;
1496 unsigned long l1, l2;
1497 unsigned long flags;
1499 /* Theoretically, the log could move on after we do this, but
1500 there's not a lot we can do about that. The new messages
1501 will overwrite the start of what we dump. */
1502 spin_lock_irqsave(&logbuf_lock, flags);
1503 end = log_end & LOG_BUF_MASK;
1504 chars = logged_chars;
1505 spin_unlock_irqrestore(&logbuf_lock, flags);
1507 if (logged_chars > end) {
1508 s1 = log_buf + log_buf_len - logged_chars + end;
1509 l1 = logged_chars - end;
1511 s2 = log_buf;
1512 l2 = end;
1513 } else {
1514 s1 = "";
1515 l1 = 0;
1517 s2 = log_buf + end - logged_chars;
1518 l2 = logged_chars;
1521 if (!spin_trylock_irqsave(&dump_list_lock, flags)) {
1522 printk(KERN_ERR "dump_kmsg: dump list lock is held during %s, skipping dump\n",
1523 kmsg_to_str(reason));
1524 return;
1526 list_for_each_entry(dumper, &dump_list, list)
1527 dumper->dump(dumper, reason, s1, l1, s2, l2);
1528 spin_unlock_irqrestore(&dump_list_lock, flags);
1530 #endif