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 * manfreds@colorfullife.com
15 * Rewrote bits to get rid of console_lock
16 * 01Mar01 Andrew Morton <andrewm@uow.edu.au>
19 #include <linux/kernel.h>
21 #include <linux/tty.h>
22 #include <linux/tty_driver.h>
23 #include <linux/smp_lock.h>
24 #include <linux/console.h>
25 #include <linux/init.h>
26 #include <linux/module.h>
27 #include <linux/interrupt.h> /* For in_interrupt() */
28 #include <linux/config.h>
29 #include <linux/delay.h>
30 #include <linux/smp.h>
31 #include <linux/security.h>
32 #include <linux/bootmem.h>
34 #include <asm/uaccess.h>
36 #define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
38 /* printk's without a loglevel use this.. */
39 #define DEFAULT_MESSAGE_LOGLEVEL 4 /* KERN_WARNING */
41 /* We show everything that is MORE important than this.. */
42 #define MINIMUM_CONSOLE_LOGLEVEL 1 /* Minimum loglevel we let people use */
43 #define DEFAULT_CONSOLE_LOGLEVEL 7 /* anything MORE serious than KERN_DEBUG */
45 DECLARE_WAIT_QUEUE_HEAD(log_wait);
47 int console_printk[4] = {
48 DEFAULT_CONSOLE_LOGLEVEL, /* console_loglevel */
49 DEFAULT_MESSAGE_LOGLEVEL, /* default_message_loglevel */
50 MINIMUM_CONSOLE_LOGLEVEL, /* minimum_console_loglevel */
51 DEFAULT_CONSOLE_LOGLEVEL, /* default_console_loglevel */
54 EXPORT_SYMBOL(console_printk);
59 * console_sem protects the console_drivers list, and also
60 * provides serialisation for access to the entire console
63 static DECLARE_MUTEX(console_sem);
64 struct console *console_drivers;
66 * This is used for debugging the mess that is the VT code by
67 * keeping track if we have the console semaphore held. It's
68 * definitely not the perfect debug tool (we don't know if _WE_
69 * hold it are racing, but it helps tracking those weird code
70 * path in the console code where we end up in places I want
71 * locked without the console sempahore held
73 static int console_locked;
76 * logbuf_lock protects log_buf, log_start, log_end, con_start and logged_chars
77 * It is also used in interesting ways to provide interlocking in
78 * release_console_sem().
80 static spinlock_t logbuf_lock = SPIN_LOCK_UNLOCKED;
82 static char __log_buf[__LOG_BUF_LEN];
83 static char *log_buf = __log_buf;
84 static int log_buf_len = __LOG_BUF_LEN;
86 #define LOG_BUF_MASK (log_buf_len-1)
87 #define LOG_BUF(idx) (log_buf[(idx) & LOG_BUF_MASK])
90 * The indices into log_buf are not constrained to log_buf_len - they
91 * must be masked before subscripting
93 static unsigned long log_start; /* Index into log_buf: next char to be read by syslog() */
94 static unsigned long con_start; /* Index into log_buf: next char to be sent to consoles */
95 static unsigned long log_end; /* Index into log_buf: most-recently-written-char + 1 */
96 static unsigned long logged_chars; /* Number of chars produced since last read+clear operation */
99 * Array of consoles built from command line options (console=)
101 struct console_cmdline
103 char name[8]; /* Name of the driver */
104 int index; /* Minor dev. to use */
105 char *options; /* Options for the driver */
108 #define MAX_CMDLINECONSOLES 8
110 static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
111 static int preferred_console = -1;
113 /* Flag: console code may call schedule() */
114 static int console_may_schedule;
117 * Setup a list of consoles. Called from init/main.c
119 static int __init console_setup(char *str)
121 char name[sizeof(console_cmdline[0].name)];
126 * Decode str into name, index, options.
128 if (str[0] >= '0' && str[0] <= '9') {
129 strcpy(name, "ttyS");
130 strncpy(name + 4, str, sizeof(name) - 5);
132 strncpy(name, str, sizeof(name) - 1);
133 name[sizeof(name) - 1] = 0;
134 if ((options = strchr(str, ',')) != NULL)
137 if (!strcmp(str, "ttya"))
138 strcpy(name, "ttyS0");
139 if (!strcmp(str, "ttyb"))
140 strcpy(name, "ttyS1");
142 for(s = name; *s; s++)
143 if (*s >= '0' && *s <= '9')
145 idx = simple_strtoul(s, NULL, 10);
148 add_preferred_console(name, idx, options);
152 __setup("console=", console_setup);
155 * add_preferred_console - add a device to the list of preferred consoles.
157 * The last preferred console added will be used for kernel messages
158 * and stdin/out/err for init. Normally this is used by console_setup
159 * above to handle user-supplied console arguments; however it can also
160 * be used by arch-specific code either to override the user or more
161 * commonly to provide a default console (ie from PROM variables) when
162 * the user has not supplied one.
164 int __init add_preferred_console(char *name, int idx, char *options)
166 struct console_cmdline *c;
170 * See if this tty is not yet registered, and
171 * if we have a slot free.
173 for(i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
174 if (strcmp(console_cmdline[i].name, name) == 0 &&
175 console_cmdline[i].index == idx) {
176 preferred_console = i;
179 if (i == MAX_CMDLINECONSOLES)
181 preferred_console = i;
182 c = &console_cmdline[i];
183 memcpy(c->name, name, sizeof(c->name));
184 c->name[sizeof(c->name) - 1] = 0;
185 c->options = options;
190 static int __init log_buf_len_setup(char *str)
192 unsigned long size = memparse(str, &str);
195 if (size > log_buf_len) {
196 unsigned long start, dest_idx, offset;
199 new_log_buf = alloc_bootmem(size);
201 printk("log_buf_len: allocation failed\n");
205 spin_lock_irqsave(&logbuf_lock, flags);
207 log_buf = new_log_buf;
209 offset = start = min(con_start, log_start);
211 while (start != log_end) {
212 log_buf[dest_idx] = __log_buf[start & (__LOG_BUF_LEN - 1)];
219 spin_unlock_irqrestore(&logbuf_lock, flags);
221 printk("log_buf_len: %d\n", log_buf_len);
228 __setup("log_buf_len=", log_buf_len_setup);
231 * Commands to do_syslog:
233 * 0 -- Close the log. Currently a NOP.
234 * 1 -- Open the log. Currently a NOP.
235 * 2 -- Read from the log.
236 * 3 -- Read all messages remaining in the ring buffer.
237 * 4 -- Read and clear all messages remaining in the ring buffer
238 * 5 -- Clear ring buffer.
239 * 6 -- Disable printk's to console
240 * 7 -- Enable printk's to console
241 * 8 -- Set level of messages printed to console
242 * 9 -- Return number of unread characters in the log buffer
243 * 10 -- Return size of the log buffer
245 int do_syslog(int type, char __user * buf, int len)
247 unsigned long i, j, limit, count;
252 error = security_syslog(type);
257 case 0: /* Close log */
259 case 1: /* Open log */
261 case 2: /* Read from log */
268 error = verify_area(VERIFY_WRITE,buf,len);
271 error = wait_event_interruptible(log_wait, (log_start - log_end));
275 spin_lock_irq(&logbuf_lock);
276 while (!error && (log_start != log_end) && i < len) {
277 c = LOG_BUF(log_start);
279 spin_unlock_irq(&logbuf_lock);
280 error = __put_user(c,buf);
283 spin_lock_irq(&logbuf_lock);
285 spin_unlock_irq(&logbuf_lock);
289 case 4: /* Read/clear last kernel messages */
292 case 3: /* Read last kernel messages */
299 error = verify_area(VERIFY_WRITE,buf,len);
303 if (count > log_buf_len)
305 spin_lock_irq(&logbuf_lock);
306 if (count > logged_chars)
307 count = logged_chars;
312 * __put_user() could sleep, and while we sleep
313 * printk() could overwrite the messages
314 * we try to copy to user space. Therefore
315 * the messages are copied in reverse. <manfreds>
317 for(i = 0; i < count && !error; i++) {
319 if (j + log_buf_len < log_end)
322 spin_unlock_irq(&logbuf_lock);
323 error = __put_user(c,&buf[count-1-i]);
324 spin_lock_irq(&logbuf_lock);
326 spin_unlock_irq(&logbuf_lock);
331 int offset = count-error;
332 /* buffer overflow during copy, correct user buffer. */
333 for(i=0;i<error;i++) {
334 if (__get_user(c,&buf[i+offset]) ||
335 __put_user(c,&buf[i])) {
342 case 5: /* Clear ring buffer */
345 case 6: /* Disable logging to console */
346 console_loglevel = minimum_console_loglevel;
348 case 7: /* Enable logging to console */
349 console_loglevel = default_console_loglevel;
351 case 8: /* Set level of messages printed to console */
353 if (len < 1 || len > 8)
355 if (len < minimum_console_loglevel)
356 len = minimum_console_loglevel;
357 console_loglevel = len;
360 case 9: /* Number of chars in the log buffer */
361 error = log_end - log_start;
363 case 10: /* Size of the log buffer */
374 asmlinkage long sys_syslog(int type, char __user * buf, int len)
376 return do_syslog(type, buf, len);
380 * Call the console drivers on a range of log_buf
382 static void __call_console_drivers(unsigned long start, unsigned long end)
386 for (con = console_drivers; con; con = con->next) {
387 if ((con->flags & CON_ENABLED) && con->write)
388 con->write(con, &LOG_BUF(start), end - start);
393 * Write out chars from start to end - 1 inclusive
395 static void _call_console_drivers(unsigned long start,
396 unsigned long end, int msg_log_level)
398 if (msg_log_level < console_loglevel &&
399 console_drivers && start != end) {
400 if ((start & LOG_BUF_MASK) > (end & LOG_BUF_MASK)) {
402 __call_console_drivers(start & LOG_BUF_MASK,
404 __call_console_drivers(0, end & LOG_BUF_MASK);
406 __call_console_drivers(start, end);
412 * Call the console drivers, asking them to write out
413 * log_buf[start] to log_buf[end - 1].
414 * The console_sem must be held.
416 static void call_console_drivers(unsigned long start, unsigned long end)
418 unsigned long cur_index, start_print;
419 static int msg_level = -1;
421 if (((long)(start - end)) > 0)
426 while (cur_index != end) {
427 if ( msg_level < 0 &&
428 ((end - cur_index) > 2) &&
429 LOG_BUF(cur_index + 0) == '<' &&
430 LOG_BUF(cur_index + 1) >= '0' &&
431 LOG_BUF(cur_index + 1) <= '7' &&
432 LOG_BUF(cur_index + 2) == '>')
434 msg_level = LOG_BUF(cur_index + 1) - '0';
436 start_print = cur_index;
438 while (cur_index != end) {
439 char c = LOG_BUF(cur_index);
445 * printk() has already given us loglevel tags in
446 * the buffer. This code is here in case the
447 * log buffer has wrapped right round and scribbled
450 msg_level = default_message_loglevel;
452 _call_console_drivers(start_print, cur_index, msg_level);
454 start_print = cur_index;
459 _call_console_drivers(start_print, end, msg_level);
462 static void emit_log_char(char c)
464 LOG_BUF(log_end) = c;
466 if (log_end - log_start > log_buf_len)
467 log_start = log_end - log_buf_len;
468 if (log_end - con_start > log_buf_len)
469 con_start = log_end - log_buf_len;
470 if (logged_chars < log_buf_len)
475 * This is printk. It can be called from any context. We want it to work.
477 * We try to grab the console_sem. If we succeed, it's easy - we log the output and
478 * call the console drivers. If we fail to get the semaphore we place the output
479 * into the log buffer and return. The current holder of the console_sem will
480 * notice the new output in release_console_sem() and will send it to the
481 * consoles before releasing the semaphore.
483 * One effect of this deferred printing is that code which calls printk() and
484 * then changes console_loglevel may break. This is because console_loglevel
485 * is inspected when the actual printing occurs.
487 asmlinkage int printk(const char *fmt, ...)
493 static char printk_buf[1024];
494 static int log_level_unknown = 1;
496 if (oops_in_progress) {
497 /* If a crash is occurring, make sure we can't deadlock */
498 spin_lock_init(&logbuf_lock);
499 /* And make sure that we print immediately */
500 init_MUTEX(&console_sem);
503 /* This stops the holder of console_sem just where we want him */
504 spin_lock_irqsave(&logbuf_lock, flags);
506 /* Emit the output into the temporary buffer */
508 printed_len = vscnprintf(printk_buf, sizeof(printk_buf), fmt, args);
512 * Copy the output into log_buf. If the caller didn't provide
513 * appropriate log level tags, we insert them here
515 for (p = printk_buf; *p; p++) {
516 if (log_level_unknown) {
517 if (p[0] != '<' || p[1] < '0' || p[1] > '7' || p[2] != '>') {
519 emit_log_char(default_message_loglevel + '0');
522 log_level_unknown = 0;
526 log_level_unknown = 1;
529 if (!cpu_online(smp_processor_id()) &&
530 system_state != SYSTEM_RUNNING) {
532 * Some console drivers may assume that per-cpu resources have
533 * been allocated. So don't allow them to be called by this
534 * CPU until it is officially up. We shouldn't be calling into
535 * random console drivers on a CPU which doesn't exist yet..
537 spin_unlock_irqrestore(&logbuf_lock, flags);
540 if (!down_trylock(&console_sem)) {
543 * We own the drivers. We can drop the spinlock and let
544 * release_console_sem() print the text
546 spin_unlock_irqrestore(&logbuf_lock, flags);
547 console_may_schedule = 0;
548 release_console_sem();
551 * Someone else owns the drivers. We drop the spinlock, which
552 * allows the semaphore holder to proceed and to call the
553 * console drivers with the output which we just produced.
555 spin_unlock_irqrestore(&logbuf_lock, flags);
560 EXPORT_SYMBOL(printk);
563 * acquire_console_sem - lock the console system for exclusive use.
565 * Acquires a semaphore which guarantees that the caller has
566 * exclusive access to the console system and the console_drivers list.
568 * Can sleep, returns nothing.
570 void acquire_console_sem(void)
576 console_may_schedule = 1;
578 EXPORT_SYMBOL(acquire_console_sem);
580 int is_console_locked(void)
582 return console_locked;
584 EXPORT_SYMBOL(is_console_locked);
587 * release_console_sem - unlock the console system
589 * Releases the semaphore which the caller holds on the console system
590 * and the console driver list.
592 * While the semaphore was held, console output may have been buffered
593 * by printk(). If this is the case, release_console_sem() emits
594 * the output prior to releasing the semaphore.
596 * If there is output waiting for klogd, we wake it up.
598 * release_console_sem() may be called from any context.
600 void release_console_sem(void)
603 unsigned long _con_start, _log_end;
604 unsigned long wake_klogd = 0;
607 spin_lock_irqsave(&logbuf_lock, flags);
608 wake_klogd |= log_start - log_end;
609 if (con_start == log_end)
610 break; /* Nothing to print */
611 _con_start = con_start;
613 con_start = log_end; /* Flush */
614 spin_unlock_irqrestore(&logbuf_lock, flags);
615 call_console_drivers(_con_start, _log_end);
618 console_may_schedule = 0;
620 spin_unlock_irqrestore(&logbuf_lock, flags);
621 if (wake_klogd && !oops_in_progress && waitqueue_active(&log_wait))
622 wake_up_interruptible(&log_wait);
624 EXPORT_SYMBOL(release_console_sem);
626 /** console_conditional_schedule - yield the CPU if required
628 * If the console code is currently allowed to sleep, and
629 * if this CPU should yield the CPU to another task, do
632 * Must be called within acquire_console_sem().
634 void console_conditional_schedule(void)
636 if (console_may_schedule && need_resched()) {
637 set_current_state(TASK_RUNNING);
641 EXPORT_SYMBOL(console_conditional_schedule);
643 void console_print(const char *s)
645 printk(KERN_EMERG "%s", s);
647 EXPORT_SYMBOL(console_print);
649 void console_unblank(void)
654 * Try to get the console semaphore. If someone else owns it
655 * we have to return without unblanking because console_unblank
656 * may be called in interrupt context.
658 if (down_trylock(&console_sem) != 0)
661 console_may_schedule = 0;
662 for (c = console_drivers; c != NULL; c = c->next)
663 if ((c->flags & CON_ENABLED) && c->unblank)
665 release_console_sem();
667 EXPORT_SYMBOL(console_unblank);
670 * The console driver calls this routine during kernel initialization
671 * to register the console printing procedure with printk() and to
672 * print any messages that were printed by the kernel before the
673 * console driver was initialized.
675 void register_console(struct console * console)
681 * See if we want to use this console driver. If we
682 * didn't select a console we take the first one
683 * that registers here.
685 if (preferred_console < 0) {
686 if (console->index < 0)
688 if (console->setup == NULL ||
689 console->setup(console, NULL) == 0) {
690 console->flags |= CON_ENABLED | CON_CONSDEV;
691 preferred_console = 0;
696 * See if this console matches one we selected on
699 for(i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++) {
700 if (strcmp(console_cmdline[i].name, console->name) != 0)
702 if (console->index >= 0 &&
703 console->index != console_cmdline[i].index)
705 if (console->index < 0)
706 console->index = console_cmdline[i].index;
707 if (console->setup &&
708 console->setup(console, console_cmdline[i].options) != 0)
710 console->flags |= CON_ENABLED;
711 console->index = console_cmdline[i].index;
712 if (i == preferred_console)
713 console->flags |= CON_CONSDEV;
717 if (!(console->flags & CON_ENABLED))
721 * Put this console in the list - keep the
722 * preferred driver at the head of the list.
724 acquire_console_sem();
725 if ((console->flags & CON_CONSDEV) || console_drivers == NULL) {
726 console->next = console_drivers;
727 console_drivers = console;
729 console->next = console_drivers->next;
730 console_drivers->next = console;
732 if (console->flags & CON_PRINTBUFFER) {
734 * release_console_sem() will print out the buffered messages
737 spin_lock_irqsave(&logbuf_lock, flags);
738 con_start = log_start;
739 spin_unlock_irqrestore(&logbuf_lock, flags);
741 release_console_sem();
743 EXPORT_SYMBOL(register_console);
745 int unregister_console(struct console * console)
747 struct console *a,*b;
750 acquire_console_sem();
751 if (console_drivers == console) {
752 console_drivers=console->next;
755 for (a=console_drivers->next, b=console_drivers ;
765 /* If last console is removed, we re-enable picking the first
766 * one that gets registered. Without that, pmac early boot console
767 * would prevent fbcon from taking over.
769 if (console_drivers == NULL)
770 preferred_console = -1;
773 release_console_sem();
776 EXPORT_SYMBOL(unregister_console);
779 * tty_write_message - write a message to a certain tty, not just the console.
781 * This is used for messages that need to be redirected to a specific tty.
782 * We don't put it into the syslog queue right now maybe in the future if
785 void tty_write_message(struct tty_struct *tty, char *msg)
787 if (tty && tty->driver->write)
788 tty->driver->write(tty, 0, msg, strlen(msg));
793 * printk rate limiting, lifted from the networking subsystem.
795 * This enforces a rate limit: not more than one kernel message
796 * every printk_ratelimit_jiffies to make a denial-of-service
799 int __printk_ratelimit(int ratelimit_jiffies, int ratelimit_burst)
801 static spinlock_t ratelimit_lock = SPIN_LOCK_UNLOCKED;
802 static unsigned long toks = 10*5*HZ;
803 static unsigned long last_msg;
806 unsigned long now = jiffies;
808 spin_lock_irqsave(&ratelimit_lock, flags);
809 toks += now - last_msg;
811 if (toks > (ratelimit_burst * ratelimit_jiffies))
812 toks = ratelimit_burst * ratelimit_jiffies;
813 if (toks >= ratelimit_jiffies) {
816 toks -= ratelimit_jiffies;
817 spin_unlock_irqrestore(&ratelimit_lock, flags);
819 printk(KERN_WARNING "printk: %d messages suppressed.\n", lost);
823 spin_unlock_irqrestore(&ratelimit_lock, flags);
826 EXPORT_SYMBOL(__printk_ratelimit);
828 /* minimum time in jiffies between messages */
829 int printk_ratelimit_jiffies = 5*HZ;
831 /* number of messages we send before ratelimiting */
832 int printk_ratelimit_burst = 10;
834 int printk_ratelimit(void)
836 return __printk_ratelimit(printk_ratelimit_jiffies,
837 printk_ratelimit_burst);
839 EXPORT_SYMBOL(printk_ratelimit);