mac80211: fix two issues in debugfs
[linux/fpc-iii.git] / kernel / printk.c
blobb51b1567bb5570dfc5b4a19bffd5af865d254e77
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 <andrewm@uow.edu.au>
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>
36 #include <asm/uaccess.h>
39 * Architectures can override it:
41 void asmlinkage __attribute__((weak)) early_printk(const char *fmt, ...)
45 #define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
47 /* printk's without a loglevel use this.. */
48 #define DEFAULT_MESSAGE_LOGLEVEL 4 /* KERN_WARNING */
50 /* We show everything that is MORE important than this.. */
51 #define MINIMUM_CONSOLE_LOGLEVEL 1 /* Minimum loglevel we let people use */
52 #define DEFAULT_CONSOLE_LOGLEVEL 7 /* anything MORE serious than KERN_DEBUG */
54 DECLARE_WAIT_QUEUE_HEAD(log_wait);
56 int console_printk[4] = {
57 DEFAULT_CONSOLE_LOGLEVEL, /* console_loglevel */
58 DEFAULT_MESSAGE_LOGLEVEL, /* default_message_loglevel */
59 MINIMUM_CONSOLE_LOGLEVEL, /* minimum_console_loglevel */
60 DEFAULT_CONSOLE_LOGLEVEL, /* default_console_loglevel */
64 * Low level drivers may need that to know if they can schedule in
65 * their unblank() callback or not. So let's export it.
67 int oops_in_progress;
68 EXPORT_SYMBOL(oops_in_progress);
71 * console_sem protects the console_drivers list, and also
72 * provides serialisation for access to the entire console
73 * driver system.
75 static DECLARE_MUTEX(console_sem);
76 static DECLARE_MUTEX(secondary_console_sem);
77 struct console *console_drivers;
78 EXPORT_SYMBOL_GPL(console_drivers);
81 * This is used for debugging the mess that is the VT code by
82 * keeping track if we have the console semaphore held. It's
83 * definitely not the perfect debug tool (we don't know if _WE_
84 * hold it are racing, but it helps tracking those weird code
85 * path in the console code where we end up in places I want
86 * locked without the console sempahore held
88 static int console_locked, console_suspended;
91 * logbuf_lock protects log_buf, log_start, log_end, con_start and logged_chars
92 * It is also used in interesting ways to provide interlocking in
93 * release_console_sem().
95 static DEFINE_SPINLOCK(logbuf_lock);
97 #define LOG_BUF_MASK (log_buf_len-1)
98 #define LOG_BUF(idx) (log_buf[(idx) & LOG_BUF_MASK])
101 * The indices into log_buf are not constrained to log_buf_len - they
102 * must be masked before subscripting
104 static unsigned log_start; /* Index into log_buf: next char to be read by syslog() */
105 static unsigned con_start; /* Index into log_buf: next char to be sent to consoles */
106 static unsigned log_end; /* Index into log_buf: most-recently-written-char + 1 */
109 * Array of consoles built from command line options (console=)
111 struct console_cmdline
113 char name[8]; /* Name of the driver */
114 int index; /* Minor dev. to use */
115 char *options; /* Options for the driver */
116 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
117 char *brl_options; /* Options for braille driver */
118 #endif
121 #define MAX_CMDLINECONSOLES 8
123 static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
124 static int selected_console = -1;
125 static int preferred_console = -1;
126 int console_set_on_cmdline;
127 EXPORT_SYMBOL(console_set_on_cmdline);
129 /* Flag: console code may call schedule() */
130 static int console_may_schedule;
132 #ifdef CONFIG_PRINTK
134 static char __log_buf[__LOG_BUF_LEN];
135 static char *log_buf = __log_buf;
136 static int log_buf_len = __LOG_BUF_LEN;
137 static unsigned logged_chars; /* Number of chars produced since last read+clear operation */
139 static int __init log_buf_len_setup(char *str)
141 unsigned size = memparse(str, &str);
142 unsigned long flags;
144 if (size)
145 size = roundup_pow_of_two(size);
146 if (size > log_buf_len) {
147 unsigned start, dest_idx, offset;
148 char *new_log_buf;
150 new_log_buf = alloc_bootmem(size);
151 if (!new_log_buf) {
152 printk(KERN_WARNING "log_buf_len: allocation failed\n");
153 goto out;
156 spin_lock_irqsave(&logbuf_lock, flags);
157 log_buf_len = size;
158 log_buf = new_log_buf;
160 offset = start = min(con_start, log_start);
161 dest_idx = 0;
162 while (start != log_end) {
163 log_buf[dest_idx] = __log_buf[start & (__LOG_BUF_LEN - 1)];
164 start++;
165 dest_idx++;
167 log_start -= offset;
168 con_start -= offset;
169 log_end -= offset;
170 spin_unlock_irqrestore(&logbuf_lock, flags);
172 printk(KERN_NOTICE "log_buf_len: %d\n", log_buf_len);
174 out:
175 return 1;
178 __setup("log_buf_len=", log_buf_len_setup);
180 #ifdef CONFIG_BOOT_PRINTK_DELAY
182 static unsigned int boot_delay; /* msecs delay after each printk during bootup */
183 static unsigned long long printk_delay_msec; /* per msec, based on boot_delay */
185 static int __init boot_delay_setup(char *str)
187 unsigned long lpj;
188 unsigned long long loops_per_msec;
190 lpj = preset_lpj ? preset_lpj : 1000000; /* some guess */
191 loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
193 get_option(&str, &boot_delay);
194 if (boot_delay > 10 * 1000)
195 boot_delay = 0;
197 printk_delay_msec = loops_per_msec;
198 printk(KERN_DEBUG "boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
199 "HZ: %d, printk_delay_msec: %llu\n",
200 boot_delay, preset_lpj, lpj, HZ, printk_delay_msec);
201 return 1;
203 __setup("boot_delay=", boot_delay_setup);
205 static void boot_delay_msec(void)
207 unsigned long long k;
208 unsigned long timeout;
210 if (boot_delay == 0 || system_state != SYSTEM_BOOTING)
211 return;
213 k = (unsigned long long)printk_delay_msec * boot_delay;
215 timeout = jiffies + msecs_to_jiffies(boot_delay);
216 while (k) {
217 k--;
218 cpu_relax();
220 * use (volatile) jiffies to prevent
221 * compiler reduction; loop termination via jiffies
222 * is secondary and may or may not happen.
224 if (time_after(jiffies, timeout))
225 break;
226 touch_nmi_watchdog();
229 #else
230 static inline void boot_delay_msec(void)
233 #endif
236 * Return the number of unread characters in the log buffer.
238 static int log_buf_get_len(void)
240 return logged_chars;
244 * Copy a range of characters from the log buffer.
246 int log_buf_copy(char *dest, int idx, int len)
248 int ret, max;
249 bool took_lock = false;
251 if (!oops_in_progress) {
252 spin_lock_irq(&logbuf_lock);
253 took_lock = true;
256 max = log_buf_get_len();
257 if (idx < 0 || idx >= max) {
258 ret = -1;
259 } else {
260 if (len > max)
261 len = max;
262 ret = len;
263 idx += (log_end - max);
264 while (len-- > 0)
265 dest[len] = LOG_BUF(idx + len);
268 if (took_lock)
269 spin_unlock_irq(&logbuf_lock);
271 return ret;
275 * Commands to do_syslog:
277 * 0 -- Close the log. Currently a NOP.
278 * 1 -- Open the log. Currently a NOP.
279 * 2 -- Read from the log.
280 * 3 -- Read all messages remaining in the ring buffer.
281 * 4 -- Read and clear all messages remaining in the ring buffer
282 * 5 -- Clear ring buffer.
283 * 6 -- Disable printk's to console
284 * 7 -- Enable printk's to console
285 * 8 -- Set level of messages printed to console
286 * 9 -- Return number of unread characters in the log buffer
287 * 10 -- Return size of the log buffer
289 int do_syslog(int type, char __user *buf, int len)
291 unsigned i, j, limit, count;
292 int do_clear = 0;
293 char c;
294 int error = 0;
296 error = security_syslog(type);
297 if (error)
298 return error;
300 switch (type) {
301 case 0: /* Close log */
302 break;
303 case 1: /* Open log */
304 break;
305 case 2: /* Read from log */
306 error = -EINVAL;
307 if (!buf || len < 0)
308 goto out;
309 error = 0;
310 if (!len)
311 goto out;
312 if (!access_ok(VERIFY_WRITE, buf, len)) {
313 error = -EFAULT;
314 goto out;
316 error = wait_event_interruptible(log_wait,
317 (log_start - log_end));
318 if (error)
319 goto out;
320 i = 0;
321 spin_lock_irq(&logbuf_lock);
322 while (!error && (log_start != log_end) && i < len) {
323 c = LOG_BUF(log_start);
324 log_start++;
325 spin_unlock_irq(&logbuf_lock);
326 error = __put_user(c,buf);
327 buf++;
328 i++;
329 cond_resched();
330 spin_lock_irq(&logbuf_lock);
332 spin_unlock_irq(&logbuf_lock);
333 if (!error)
334 error = i;
335 break;
336 case 4: /* Read/clear last kernel messages */
337 do_clear = 1;
338 /* FALL THRU */
339 case 3: /* Read last kernel messages */
340 error = -EINVAL;
341 if (!buf || len < 0)
342 goto out;
343 error = 0;
344 if (!len)
345 goto out;
346 if (!access_ok(VERIFY_WRITE, buf, len)) {
347 error = -EFAULT;
348 goto out;
350 count = len;
351 if (count > log_buf_len)
352 count = log_buf_len;
353 spin_lock_irq(&logbuf_lock);
354 if (count > logged_chars)
355 count = logged_chars;
356 if (do_clear)
357 logged_chars = 0;
358 limit = log_end;
360 * __put_user() could sleep, and while we sleep
361 * printk() could overwrite the messages
362 * we try to copy to user space. Therefore
363 * the messages are copied in reverse. <manfreds>
365 for (i = 0; i < count && !error; i++) {
366 j = limit-1-i;
367 if (j + log_buf_len < log_end)
368 break;
369 c = LOG_BUF(j);
370 spin_unlock_irq(&logbuf_lock);
371 error = __put_user(c,&buf[count-1-i]);
372 cond_resched();
373 spin_lock_irq(&logbuf_lock);
375 spin_unlock_irq(&logbuf_lock);
376 if (error)
377 break;
378 error = i;
379 if (i != count) {
380 int offset = count-error;
381 /* buffer overflow during copy, correct user buffer. */
382 for (i = 0; i < error; i++) {
383 if (__get_user(c,&buf[i+offset]) ||
384 __put_user(c,&buf[i])) {
385 error = -EFAULT;
386 break;
388 cond_resched();
391 break;
392 case 5: /* Clear ring buffer */
393 logged_chars = 0;
394 break;
395 case 6: /* Disable logging to console */
396 console_loglevel = minimum_console_loglevel;
397 break;
398 case 7: /* Enable logging to console */
399 console_loglevel = default_console_loglevel;
400 break;
401 case 8: /* Set level of messages printed to console */
402 error = -EINVAL;
403 if (len < 1 || len > 8)
404 goto out;
405 if (len < minimum_console_loglevel)
406 len = minimum_console_loglevel;
407 console_loglevel = len;
408 error = 0;
409 break;
410 case 9: /* Number of chars in the log buffer */
411 error = log_end - log_start;
412 break;
413 case 10: /* Size of the log buffer */
414 error = log_buf_len;
415 break;
416 default:
417 error = -EINVAL;
418 break;
420 out:
421 return error;
424 asmlinkage long sys_syslog(int type, char __user *buf, int len)
426 return do_syslog(type, buf, len);
430 * Call the console drivers on a range of log_buf
432 static void __call_console_drivers(unsigned start, unsigned end)
434 struct console *con;
436 for (con = console_drivers; con; con = con->next) {
437 if ((con->flags & CON_ENABLED) && con->write &&
438 (cpu_online(smp_processor_id()) ||
439 (con->flags & CON_ANYTIME)))
440 con->write(con, &LOG_BUF(start), end - start);
444 static int __read_mostly ignore_loglevel;
446 static int __init ignore_loglevel_setup(char *str)
448 ignore_loglevel = 1;
449 printk(KERN_INFO "debug: ignoring loglevel setting.\n");
451 return 0;
454 early_param("ignore_loglevel", ignore_loglevel_setup);
457 * Write out chars from start to end - 1 inclusive
459 static void _call_console_drivers(unsigned start,
460 unsigned end, int msg_log_level)
462 if ((msg_log_level < console_loglevel || ignore_loglevel) &&
463 console_drivers && start != end) {
464 if ((start & LOG_BUF_MASK) > (end & LOG_BUF_MASK)) {
465 /* wrapped write */
466 __call_console_drivers(start & LOG_BUF_MASK,
467 log_buf_len);
468 __call_console_drivers(0, end & LOG_BUF_MASK);
469 } else {
470 __call_console_drivers(start, end);
476 * Call the console drivers, asking them to write out
477 * log_buf[start] to log_buf[end - 1].
478 * The console_sem must be held.
480 static void call_console_drivers(unsigned start, unsigned end)
482 unsigned cur_index, start_print;
483 static int msg_level = -1;
485 BUG_ON(((int)(start - end)) > 0);
487 cur_index = start;
488 start_print = start;
489 while (cur_index != end) {
490 if (msg_level < 0 && ((end - cur_index) > 2) &&
491 LOG_BUF(cur_index + 0) == '<' &&
492 LOG_BUF(cur_index + 1) >= '0' &&
493 LOG_BUF(cur_index + 1) <= '7' &&
494 LOG_BUF(cur_index + 2) == '>') {
495 msg_level = LOG_BUF(cur_index + 1) - '0';
496 cur_index += 3;
497 start_print = cur_index;
499 while (cur_index != end) {
500 char c = LOG_BUF(cur_index);
502 cur_index++;
503 if (c == '\n') {
504 if (msg_level < 0) {
506 * printk() has already given us loglevel tags in
507 * the buffer. This code is here in case the
508 * log buffer has wrapped right round and scribbled
509 * on those tags
511 msg_level = default_message_loglevel;
513 _call_console_drivers(start_print, cur_index, msg_level);
514 msg_level = -1;
515 start_print = cur_index;
516 break;
520 _call_console_drivers(start_print, end, msg_level);
523 static void emit_log_char(char c)
525 LOG_BUF(log_end) = c;
526 log_end++;
527 if (log_end - log_start > log_buf_len)
528 log_start = log_end - log_buf_len;
529 if (log_end - con_start > log_buf_len)
530 con_start = log_end - log_buf_len;
531 if (logged_chars < log_buf_len)
532 logged_chars++;
536 * Zap console related locks when oopsing. Only zap at most once
537 * every 10 seconds, to leave time for slow consoles to print a
538 * full oops.
540 static void zap_locks(void)
542 static unsigned long oops_timestamp;
544 if (time_after_eq(jiffies, oops_timestamp) &&
545 !time_after(jiffies, oops_timestamp + 30 * HZ))
546 return;
548 oops_timestamp = jiffies;
550 /* If a crash is occurring, make sure we can't deadlock */
551 spin_lock_init(&logbuf_lock);
552 /* And make sure that we print immediately */
553 init_MUTEX(&console_sem);
556 #if defined(CONFIG_PRINTK_TIME)
557 static int printk_time = 1;
558 #else
559 static int printk_time = 0;
560 #endif
561 module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
563 /* Check if we have any console registered that can be called early in boot. */
564 static int have_callable_console(void)
566 struct console *con;
568 for (con = console_drivers; con; con = con->next)
569 if (con->flags & CON_ANYTIME)
570 return 1;
572 return 0;
576 * printk - print a kernel message
577 * @fmt: format string
579 * This is printk(). It can be called from any context. We want it to work.
580 * Be aware of the fact that if oops_in_progress is not set, we might try to
581 * wake klogd up which could deadlock on runqueue lock if printk() is called
582 * from scheduler code.
584 * We try to grab the console_sem. If we succeed, it's easy - we log the output and
585 * call the console drivers. If we fail to get the semaphore we place the output
586 * into the log buffer and return. The current holder of the console_sem will
587 * notice the new output in release_console_sem() and will send it to the
588 * consoles before releasing the semaphore.
590 * One effect of this deferred printing is that code which calls printk() and
591 * then changes console_loglevel may break. This is because console_loglevel
592 * is inspected when the actual printing occurs.
594 * See also:
595 * printf(3)
598 asmlinkage int printk(const char *fmt, ...)
600 va_list args;
601 int r;
603 va_start(args, fmt);
604 r = vprintk(fmt, args);
605 va_end(args);
607 return r;
610 /* cpu currently holding logbuf_lock */
611 static volatile unsigned int printk_cpu = UINT_MAX;
614 * Can we actually use the console at this time on this cpu?
616 * Console drivers may assume that per-cpu resources have
617 * been allocated. So unless they're explicitly marked as
618 * being able to cope (CON_ANYTIME) don't call them until
619 * this CPU is officially up.
621 static inline int can_use_console(unsigned int cpu)
623 return cpu_online(cpu) || have_callable_console();
627 * Try to get console ownership to actually show the kernel
628 * messages from a 'printk'. Return true (and with the
629 * console_semaphore held, and 'console_locked' set) if it
630 * is successful, false otherwise.
632 * This gets called with the 'logbuf_lock' spinlock held and
633 * interrupts disabled. It should return with 'lockbuf_lock'
634 * released but interrupts still disabled.
636 static int acquire_console_semaphore_for_printk(unsigned int cpu)
638 int retval = 0;
640 if (!try_acquire_console_sem()) {
641 retval = 1;
644 * If we can't use the console, we need to release
645 * the console semaphore by hand to avoid flushing
646 * the buffer. We need to hold the console semaphore
647 * in order to do this test safely.
649 if (!can_use_console(cpu)) {
650 console_locked = 0;
651 up(&console_sem);
652 retval = 0;
655 printk_cpu = UINT_MAX;
656 spin_unlock(&logbuf_lock);
657 return retval;
659 static const char recursion_bug_msg [] =
660 KERN_CRIT "BUG: recent printk recursion!\n";
661 static int recursion_bug;
662 static int new_text_line = 1;
663 static char printk_buf[1024];
665 asmlinkage int vprintk(const char *fmt, va_list args)
667 int printed_len = 0;
668 int current_log_level = default_message_loglevel;
669 unsigned long flags;
670 int this_cpu;
671 char *p;
673 boot_delay_msec();
675 preempt_disable();
676 /* This stops the holder of console_sem just where we want him */
677 raw_local_irq_save(flags);
678 this_cpu = smp_processor_id();
681 * Ouch, printk recursed into itself!
683 if (unlikely(printk_cpu == this_cpu)) {
685 * If a crash is occurring during printk() on this CPU,
686 * then try to get the crash message out but make sure
687 * we can't deadlock. Otherwise just return to avoid the
688 * recursion and return - but flag the recursion so that
689 * it can be printed at the next appropriate moment:
691 if (!oops_in_progress) {
692 recursion_bug = 1;
693 goto out_restore_irqs;
695 zap_locks();
698 lockdep_off();
699 spin_lock(&logbuf_lock);
700 printk_cpu = this_cpu;
702 if (recursion_bug) {
703 recursion_bug = 0;
704 strcpy(printk_buf, recursion_bug_msg);
705 printed_len = sizeof(recursion_bug_msg);
707 /* Emit the output into the temporary buffer */
708 printed_len += vscnprintf(printk_buf + printed_len,
709 sizeof(printk_buf) - printed_len, fmt, args);
713 * Copy the output into log_buf. If the caller didn't provide
714 * appropriate log level tags, we insert them here
716 for (p = printk_buf; *p; p++) {
717 if (new_text_line) {
718 /* If a token, set current_log_level and skip over */
719 if (p[0] == '<' && p[1] >= '0' && p[1] <= '7' &&
720 p[2] == '>') {
721 current_log_level = p[1] - '0';
722 p += 3;
723 printed_len -= 3;
726 /* Always output the token */
727 emit_log_char('<');
728 emit_log_char(current_log_level + '0');
729 emit_log_char('>');
730 printed_len += 3;
731 new_text_line = 0;
733 if (printk_time) {
734 /* Follow the token with the time */
735 char tbuf[50], *tp;
736 unsigned tlen;
737 unsigned long long t;
738 unsigned long nanosec_rem;
740 t = cpu_clock(printk_cpu);
741 nanosec_rem = do_div(t, 1000000000);
742 tlen = sprintf(tbuf, "[%5lu.%06lu] ",
743 (unsigned long) t,
744 nanosec_rem / 1000);
746 for (tp = tbuf; tp < tbuf + tlen; tp++)
747 emit_log_char(*tp);
748 printed_len += tlen;
751 if (!*p)
752 break;
755 emit_log_char(*p);
756 if (*p == '\n')
757 new_text_line = 1;
761 * Try to acquire and then immediately release the
762 * console semaphore. The release will do all the
763 * actual magic (print out buffers, wake up klogd,
764 * etc).
766 * The acquire_console_semaphore_for_printk() function
767 * will release 'logbuf_lock' regardless of whether it
768 * actually gets the semaphore or not.
770 if (acquire_console_semaphore_for_printk(this_cpu))
771 release_console_sem();
773 lockdep_on();
774 out_restore_irqs:
775 raw_local_irq_restore(flags);
777 preempt_enable();
778 return printed_len;
780 EXPORT_SYMBOL(printk);
781 EXPORT_SYMBOL(vprintk);
783 #else
785 asmlinkage long sys_syslog(int type, char __user *buf, int len)
787 return -ENOSYS;
790 static void call_console_drivers(unsigned start, unsigned end)
794 #endif
796 static int __add_preferred_console(char *name, int idx, char *options,
797 char *brl_options)
799 struct console_cmdline *c;
800 int i;
803 * See if this tty is not yet registered, and
804 * if we have a slot free.
806 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
807 if (strcmp(console_cmdline[i].name, name) == 0 &&
808 console_cmdline[i].index == idx) {
809 if (!brl_options)
810 selected_console = i;
811 return 0;
813 if (i == MAX_CMDLINECONSOLES)
814 return -E2BIG;
815 if (!brl_options)
816 selected_console = i;
817 c = &console_cmdline[i];
818 strlcpy(c->name, name, sizeof(c->name));
819 c->options = options;
820 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
821 c->brl_options = brl_options;
822 #endif
823 c->index = idx;
824 return 0;
827 * Set up a list of consoles. Called from init/main.c
829 static int __init console_setup(char *str)
831 char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for index */
832 char *s, *options, *brl_options = NULL;
833 int idx;
835 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
836 if (!memcmp(str, "brl,", 4)) {
837 brl_options = "";
838 str += 4;
839 } else if (!memcmp(str, "brl=", 4)) {
840 brl_options = str + 4;
841 str = strchr(brl_options, ',');
842 if (!str) {
843 printk(KERN_ERR "need port name after brl=\n");
844 return 1;
846 *(str++) = 0;
848 #endif
851 * Decode str into name, index, options.
853 if (str[0] >= '0' && str[0] <= '9') {
854 strcpy(buf, "ttyS");
855 strncpy(buf + 4, str, sizeof(buf) - 5);
856 } else {
857 strncpy(buf, str, sizeof(buf) - 1);
859 buf[sizeof(buf) - 1] = 0;
860 if ((options = strchr(str, ',')) != NULL)
861 *(options++) = 0;
862 #ifdef __sparc__
863 if (!strcmp(str, "ttya"))
864 strcpy(buf, "ttyS0");
865 if (!strcmp(str, "ttyb"))
866 strcpy(buf, "ttyS1");
867 #endif
868 for (s = buf; *s; s++)
869 if ((*s >= '0' && *s <= '9') || *s == ',')
870 break;
871 idx = simple_strtoul(s, NULL, 10);
872 *s = 0;
874 __add_preferred_console(buf, idx, options, brl_options);
875 console_set_on_cmdline = 1;
876 return 1;
878 __setup("console=", console_setup);
881 * add_preferred_console - add a device to the list of preferred consoles.
882 * @name: device name
883 * @idx: device index
884 * @options: options for this console
886 * The last preferred console added will be used for kernel messages
887 * and stdin/out/err for init. Normally this is used by console_setup
888 * above to handle user-supplied console arguments; however it can also
889 * be used by arch-specific code either to override the user or more
890 * commonly to provide a default console (ie from PROM variables) when
891 * the user has not supplied one.
893 int add_preferred_console(char *name, int idx, char *options)
895 return __add_preferred_console(name, idx, options, NULL);
898 int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options)
900 struct console_cmdline *c;
901 int i;
903 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
904 if (strcmp(console_cmdline[i].name, name) == 0 &&
905 console_cmdline[i].index == idx) {
906 c = &console_cmdline[i];
907 strlcpy(c->name, name_new, sizeof(c->name));
908 c->name[sizeof(c->name) - 1] = 0;
909 c->options = options;
910 c->index = idx_new;
911 return i;
913 /* not found */
914 return -1;
917 int console_suspend_enabled = 1;
918 EXPORT_SYMBOL(console_suspend_enabled);
920 static int __init console_suspend_disable(char *str)
922 console_suspend_enabled = 0;
923 return 1;
925 __setup("no_console_suspend", console_suspend_disable);
928 * suspend_console - suspend the console subsystem
930 * This disables printk() while we go into suspend states
932 void suspend_console(void)
934 if (!console_suspend_enabled)
935 return;
936 printk("Suspending console(s) (use no_console_suspend to debug)\n");
937 acquire_console_sem();
938 console_suspended = 1;
941 void resume_console(void)
943 if (!console_suspend_enabled)
944 return;
945 console_suspended = 0;
946 release_console_sem();
950 * acquire_console_sem - lock the console system for exclusive use.
952 * Acquires a semaphore which guarantees that the caller has
953 * exclusive access to the console system and the console_drivers list.
955 * Can sleep, returns nothing.
957 void acquire_console_sem(void)
959 BUG_ON(in_interrupt());
960 if (console_suspended) {
961 down(&secondary_console_sem);
962 return;
964 down(&console_sem);
965 console_locked = 1;
966 console_may_schedule = 1;
968 EXPORT_SYMBOL(acquire_console_sem);
970 int try_acquire_console_sem(void)
972 if (down_trylock(&console_sem))
973 return -1;
974 console_locked = 1;
975 console_may_schedule = 0;
976 return 0;
978 EXPORT_SYMBOL(try_acquire_console_sem);
980 int is_console_locked(void)
982 return console_locked;
985 void wake_up_klogd(void)
987 if (!oops_in_progress && waitqueue_active(&log_wait))
988 wake_up_interruptible(&log_wait);
992 * release_console_sem - unlock the console system
994 * Releases the semaphore which the caller holds on the console system
995 * and the console driver list.
997 * While the semaphore was held, console output may have been buffered
998 * by printk(). If this is the case, release_console_sem() emits
999 * the output prior to releasing the semaphore.
1001 * If there is output waiting for klogd, we wake it up.
1003 * release_console_sem() may be called from any context.
1005 void release_console_sem(void)
1007 unsigned long flags;
1008 unsigned _con_start, _log_end;
1009 unsigned wake_klogd = 0;
1011 if (console_suspended) {
1012 up(&secondary_console_sem);
1013 return;
1016 console_may_schedule = 0;
1018 for ( ; ; ) {
1019 spin_lock_irqsave(&logbuf_lock, flags);
1020 wake_klogd |= log_start - log_end;
1021 if (con_start == log_end)
1022 break; /* Nothing to print */
1023 _con_start = con_start;
1024 _log_end = log_end;
1025 con_start = log_end; /* Flush */
1026 spin_unlock(&logbuf_lock);
1027 stop_critical_timings(); /* don't trace print latency */
1028 call_console_drivers(_con_start, _log_end);
1029 start_critical_timings();
1030 local_irq_restore(flags);
1032 console_locked = 0;
1033 up(&console_sem);
1034 spin_unlock_irqrestore(&logbuf_lock, flags);
1035 if (wake_klogd)
1036 wake_up_klogd();
1038 EXPORT_SYMBOL(release_console_sem);
1041 * console_conditional_schedule - yield the CPU if required
1043 * If the console code is currently allowed to sleep, and
1044 * if this CPU should yield the CPU to another task, do
1045 * so here.
1047 * Must be called within acquire_console_sem().
1049 void __sched console_conditional_schedule(void)
1051 if (console_may_schedule)
1052 cond_resched();
1054 EXPORT_SYMBOL(console_conditional_schedule);
1056 void console_print(const char *s)
1058 printk(KERN_EMERG "%s", s);
1060 EXPORT_SYMBOL(console_print);
1062 void console_unblank(void)
1064 struct console *c;
1067 * console_unblank can no longer be called in interrupt context unless
1068 * oops_in_progress is set to 1..
1070 if (oops_in_progress) {
1071 if (down_trylock(&console_sem) != 0)
1072 return;
1073 } else
1074 acquire_console_sem();
1076 console_locked = 1;
1077 console_may_schedule = 0;
1078 for (c = console_drivers; c != NULL; c = c->next)
1079 if ((c->flags & CON_ENABLED) && c->unblank)
1080 c->unblank();
1081 release_console_sem();
1085 * Return the console tty driver structure and its associated index
1087 struct tty_driver *console_device(int *index)
1089 struct console *c;
1090 struct tty_driver *driver = NULL;
1092 acquire_console_sem();
1093 for (c = console_drivers; c != NULL; c = c->next) {
1094 if (!c->device)
1095 continue;
1096 driver = c->device(c, index);
1097 if (driver)
1098 break;
1100 release_console_sem();
1101 return driver;
1105 * Prevent further output on the passed console device so that (for example)
1106 * serial drivers can disable console output before suspending a port, and can
1107 * re-enable output afterwards.
1109 void console_stop(struct console *console)
1111 acquire_console_sem();
1112 console->flags &= ~CON_ENABLED;
1113 release_console_sem();
1115 EXPORT_SYMBOL(console_stop);
1117 void console_start(struct console *console)
1119 acquire_console_sem();
1120 console->flags |= CON_ENABLED;
1121 release_console_sem();
1123 EXPORT_SYMBOL(console_start);
1126 * The console driver calls this routine during kernel initialization
1127 * to register the console printing procedure with printk() and to
1128 * print any messages that were printed by the kernel before the
1129 * console driver was initialized.
1131 void register_console(struct console *console)
1133 int i;
1134 unsigned long flags;
1135 struct console *bootconsole = NULL;
1137 if (console_drivers) {
1138 if (console->flags & CON_BOOT)
1139 return;
1140 if (console_drivers->flags & CON_BOOT)
1141 bootconsole = console_drivers;
1144 if (preferred_console < 0 || bootconsole || !console_drivers)
1145 preferred_console = selected_console;
1147 if (console->early_setup)
1148 console->early_setup();
1151 * See if we want to use this console driver. If we
1152 * didn't select a console we take the first one
1153 * that registers here.
1155 if (preferred_console < 0) {
1156 if (console->index < 0)
1157 console->index = 0;
1158 if (console->setup == NULL ||
1159 console->setup(console, NULL) == 0) {
1160 console->flags |= CON_ENABLED;
1161 if (console->device) {
1162 console->flags |= CON_CONSDEV;
1163 preferred_console = 0;
1169 * See if this console matches one we selected on
1170 * the command line.
1172 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0];
1173 i++) {
1174 if (strcmp(console_cmdline[i].name, console->name) != 0)
1175 continue;
1176 if (console->index >= 0 &&
1177 console->index != console_cmdline[i].index)
1178 continue;
1179 if (console->index < 0)
1180 console->index = console_cmdline[i].index;
1181 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1182 if (console_cmdline[i].brl_options) {
1183 console->flags |= CON_BRL;
1184 braille_register_console(console,
1185 console_cmdline[i].index,
1186 console_cmdline[i].options,
1187 console_cmdline[i].brl_options);
1188 return;
1190 #endif
1191 if (console->setup &&
1192 console->setup(console, console_cmdline[i].options) != 0)
1193 break;
1194 console->flags |= CON_ENABLED;
1195 console->index = console_cmdline[i].index;
1196 if (i == selected_console) {
1197 console->flags |= CON_CONSDEV;
1198 preferred_console = selected_console;
1200 break;
1203 if (!(console->flags & CON_ENABLED))
1204 return;
1206 if (bootconsole && (console->flags & CON_CONSDEV)) {
1207 printk(KERN_INFO "console handover: boot [%s%d] -> real [%s%d]\n",
1208 bootconsole->name, bootconsole->index,
1209 console->name, console->index);
1210 unregister_console(bootconsole);
1211 console->flags &= ~CON_PRINTBUFFER;
1212 } else {
1213 printk(KERN_INFO "console [%s%d] enabled\n",
1214 console->name, console->index);
1218 * Put this console in the list - keep the
1219 * preferred driver at the head of the list.
1221 acquire_console_sem();
1222 if ((console->flags & CON_CONSDEV) || console_drivers == NULL) {
1223 console->next = console_drivers;
1224 console_drivers = console;
1225 if (console->next)
1226 console->next->flags &= ~CON_CONSDEV;
1227 } else {
1228 console->next = console_drivers->next;
1229 console_drivers->next = console;
1231 if (console->flags & CON_PRINTBUFFER) {
1233 * release_console_sem() will print out the buffered messages
1234 * for us.
1236 spin_lock_irqsave(&logbuf_lock, flags);
1237 con_start = log_start;
1238 spin_unlock_irqrestore(&logbuf_lock, flags);
1240 release_console_sem();
1242 EXPORT_SYMBOL(register_console);
1244 int unregister_console(struct console *console)
1246 struct console *a, *b;
1247 int res = 1;
1249 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1250 if (console->flags & CON_BRL)
1251 return braille_unregister_console(console);
1252 #endif
1254 acquire_console_sem();
1255 if (console_drivers == console) {
1256 console_drivers=console->next;
1257 res = 0;
1258 } else if (console_drivers) {
1259 for (a=console_drivers->next, b=console_drivers ;
1260 a; b=a, a=b->next) {
1261 if (a == console) {
1262 b->next = a->next;
1263 res = 0;
1264 break;
1270 * If this isn't the last console and it has CON_CONSDEV set, we
1271 * need to set it on the next preferred console.
1273 if (console_drivers != NULL && console->flags & CON_CONSDEV)
1274 console_drivers->flags |= CON_CONSDEV;
1276 release_console_sem();
1277 return res;
1279 EXPORT_SYMBOL(unregister_console);
1281 static int __init disable_boot_consoles(void)
1283 if (console_drivers != NULL) {
1284 if (console_drivers->flags & CON_BOOT) {
1285 printk(KERN_INFO "turn off boot console %s%d\n",
1286 console_drivers->name, console_drivers->index);
1287 return unregister_console(console_drivers);
1290 return 0;
1292 late_initcall(disable_boot_consoles);
1295 * tty_write_message - write a message to a certain tty, not just the console.
1296 * @tty: the destination tty_struct
1297 * @msg: the message to write
1299 * This is used for messages that need to be redirected to a specific tty.
1300 * We don't put it into the syslog queue right now maybe in the future if
1301 * really needed.
1303 void tty_write_message(struct tty_struct *tty, char *msg)
1305 if (tty && tty->ops->write)
1306 tty->ops->write(tty, msg, strlen(msg));
1307 return;
1310 #if defined CONFIG_PRINTK
1313 * printk rate limiting, lifted from the networking subsystem.
1315 * This enforces a rate limit: not more than 10 kernel messages
1316 * every 5s to make a denial-of-service attack impossible.
1318 DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
1320 int printk_ratelimit(void)
1322 return __ratelimit(&printk_ratelimit_state);
1324 EXPORT_SYMBOL(printk_ratelimit);
1327 * printk_timed_ratelimit - caller-controlled printk ratelimiting
1328 * @caller_jiffies: pointer to caller's state
1329 * @interval_msecs: minimum interval between prints
1331 * printk_timed_ratelimit() returns true if more than @interval_msecs
1332 * milliseconds have elapsed since the last time printk_timed_ratelimit()
1333 * returned true.
1335 bool printk_timed_ratelimit(unsigned long *caller_jiffies,
1336 unsigned int interval_msecs)
1338 if (*caller_jiffies == 0 || time_after(jiffies, *caller_jiffies)) {
1339 *caller_jiffies = jiffies + msecs_to_jiffies(interval_msecs);
1340 return true;
1342 return false;
1344 EXPORT_SYMBOL(printk_timed_ratelimit);
1345 #endif