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
);
196 size
= roundup_pow_of_two(size
);
197 if (size
> log_buf_len
) {
198 unsigned long start
, dest_idx
, offset
;
201 new_log_buf
= alloc_bootmem(size
);
203 printk("log_buf_len: allocation failed\n");
207 spin_lock_irqsave(&logbuf_lock
, flags
);
209 log_buf
= new_log_buf
;
211 offset
= start
= min(con_start
, log_start
);
213 while (start
!= log_end
) {
214 log_buf
[dest_idx
] = __log_buf
[start
& (__LOG_BUF_LEN
- 1)];
221 spin_unlock_irqrestore(&logbuf_lock
, flags
);
223 printk("log_buf_len: %d\n", log_buf_len
);
230 __setup("log_buf_len=", log_buf_len_setup
);
233 * Commands to do_syslog:
235 * 0 -- Close the log. Currently a NOP.
236 * 1 -- Open the log. Currently a NOP.
237 * 2 -- Read from the log.
238 * 3 -- Read all messages remaining in the ring buffer.
239 * 4 -- Read and clear all messages remaining in the ring buffer
240 * 5 -- Clear ring buffer.
241 * 6 -- Disable printk's to console
242 * 7 -- Enable printk's to console
243 * 8 -- Set level of messages printed to console
244 * 9 -- Return number of unread characters in the log buffer
245 * 10 -- Return size of the log buffer
247 int do_syslog(int type
, char __user
* buf
, int len
)
249 unsigned long i
, j
, limit
, count
;
254 error
= security_syslog(type
);
259 case 0: /* Close log */
261 case 1: /* Open log */
263 case 2: /* Read from log */
270 error
= verify_area(VERIFY_WRITE
,buf
,len
);
273 error
= wait_event_interruptible(log_wait
, (log_start
- log_end
));
277 spin_lock_irq(&logbuf_lock
);
278 while (!error
&& (log_start
!= log_end
) && i
< len
) {
279 c
= LOG_BUF(log_start
);
281 spin_unlock_irq(&logbuf_lock
);
282 error
= __put_user(c
,buf
);
285 spin_lock_irq(&logbuf_lock
);
287 spin_unlock_irq(&logbuf_lock
);
291 case 4: /* Read/clear last kernel messages */
294 case 3: /* Read last kernel messages */
301 error
= verify_area(VERIFY_WRITE
,buf
,len
);
305 if (count
> log_buf_len
)
307 spin_lock_irq(&logbuf_lock
);
308 if (count
> logged_chars
)
309 count
= logged_chars
;
314 * __put_user() could sleep, and while we sleep
315 * printk() could overwrite the messages
316 * we try to copy to user space. Therefore
317 * the messages are copied in reverse. <manfreds>
319 for(i
= 0; i
< count
&& !error
; i
++) {
321 if (j
+ log_buf_len
< log_end
)
324 spin_unlock_irq(&logbuf_lock
);
325 error
= __put_user(c
,&buf
[count
-1-i
]);
326 spin_lock_irq(&logbuf_lock
);
328 spin_unlock_irq(&logbuf_lock
);
333 int offset
= count
-error
;
334 /* buffer overflow during copy, correct user buffer. */
335 for(i
=0;i
<error
;i
++) {
336 if (__get_user(c
,&buf
[i
+offset
]) ||
337 __put_user(c
,&buf
[i
])) {
344 case 5: /* Clear ring buffer */
347 case 6: /* Disable logging to console */
348 console_loglevel
= minimum_console_loglevel
;
350 case 7: /* Enable logging to console */
351 console_loglevel
= default_console_loglevel
;
353 case 8: /* Set level of messages printed to console */
355 if (len
< 1 || len
> 8)
357 if (len
< minimum_console_loglevel
)
358 len
= minimum_console_loglevel
;
359 console_loglevel
= len
;
362 case 9: /* Number of chars in the log buffer */
363 error
= log_end
- log_start
;
365 case 10: /* Size of the log buffer */
376 asmlinkage
long sys_syslog(int type
, char __user
* buf
, int len
)
378 return do_syslog(type
, buf
, len
);
382 * Call the console drivers on a range of log_buf
384 static void __call_console_drivers(unsigned long start
, unsigned long end
)
388 for (con
= console_drivers
; con
; con
= con
->next
) {
389 if ((con
->flags
& CON_ENABLED
) && con
->write
)
390 con
->write(con
, &LOG_BUF(start
), end
- start
);
395 * Write out chars from start to end - 1 inclusive
397 static void _call_console_drivers(unsigned long start
,
398 unsigned long end
, int msg_log_level
)
400 if (msg_log_level
< console_loglevel
&&
401 console_drivers
&& start
!= end
) {
402 if ((start
& LOG_BUF_MASK
) > (end
& LOG_BUF_MASK
)) {
404 __call_console_drivers(start
& LOG_BUF_MASK
,
406 __call_console_drivers(0, end
& LOG_BUF_MASK
);
408 __call_console_drivers(start
, end
);
414 * Call the console drivers, asking them to write out
415 * log_buf[start] to log_buf[end - 1].
416 * The console_sem must be held.
418 static void call_console_drivers(unsigned long start
, unsigned long end
)
420 unsigned long cur_index
, start_print
;
421 static int msg_level
= -1;
423 if (((long)(start
- end
)) > 0)
428 while (cur_index
!= end
) {
429 if ( msg_level
< 0 &&
430 ((end
- cur_index
) > 2) &&
431 LOG_BUF(cur_index
+ 0) == '<' &&
432 LOG_BUF(cur_index
+ 1) >= '0' &&
433 LOG_BUF(cur_index
+ 1) <= '7' &&
434 LOG_BUF(cur_index
+ 2) == '>')
436 msg_level
= LOG_BUF(cur_index
+ 1) - '0';
438 start_print
= cur_index
;
440 while (cur_index
!= end
) {
441 char c
= LOG_BUF(cur_index
);
447 * printk() has already given us loglevel tags in
448 * the buffer. This code is here in case the
449 * log buffer has wrapped right round and scribbled
452 msg_level
= default_message_loglevel
;
454 _call_console_drivers(start_print
, cur_index
, msg_level
);
456 start_print
= cur_index
;
461 _call_console_drivers(start_print
, end
, msg_level
);
464 static void emit_log_char(char c
)
466 LOG_BUF(log_end
) = c
;
468 if (log_end
- log_start
> log_buf_len
)
469 log_start
= log_end
- log_buf_len
;
470 if (log_end
- con_start
> log_buf_len
)
471 con_start
= log_end
- log_buf_len
;
472 if (logged_chars
< log_buf_len
)
477 * Zap console related locks when oopsing. Only zap at most once
478 * every 10 seconds, to leave time for slow consoles to print a
481 static void zap_locks(void)
483 static unsigned long oops_timestamp
;
485 if (time_after_eq(jiffies
, oops_timestamp
) &&
486 !time_after(jiffies
, oops_timestamp
+ 30*HZ
))
489 oops_timestamp
= jiffies
;
491 /* If a crash is occurring, make sure we can't deadlock */
492 spin_lock_init(&logbuf_lock
);
493 /* And make sure that we print immediately */
494 init_MUTEX(&console_sem
);
498 * This is printk. It can be called from any context. We want it to work.
500 * We try to grab the console_sem. If we succeed, it's easy - we log the output and
501 * call the console drivers. If we fail to get the semaphore we place the output
502 * into the log buffer and return. The current holder of the console_sem will
503 * notice the new output in release_console_sem() and will send it to the
504 * consoles before releasing the semaphore.
506 * One effect of this deferred printing is that code which calls printk() and
507 * then changes console_loglevel may break. This is because console_loglevel
508 * is inspected when the actual printing occurs.
510 asmlinkage
int printk(const char *fmt
, ...)
516 r
= vprintk(fmt
, args
);
522 asmlinkage
int vprintk(const char *fmt
, va_list args
)
527 static char printk_buf
[1024];
528 static int log_level_unknown
= 1;
530 if (unlikely(oops_in_progress
))
533 /* This stops the holder of console_sem just where we want him */
534 spin_lock_irqsave(&logbuf_lock
, flags
);
536 /* Emit the output into the temporary buffer */
537 printed_len
= vscnprintf(printk_buf
, sizeof(printk_buf
), fmt
, args
);
540 * Copy the output into log_buf. If the caller didn't provide
541 * appropriate log level tags, we insert them here
543 for (p
= printk_buf
; *p
; p
++) {
544 if (log_level_unknown
) {
545 if (p
[0] != '<' || p
[1] < '0' || p
[1] > '7' || p
[2] != '>') {
547 emit_log_char(default_message_loglevel
+ '0');
550 log_level_unknown
= 0;
554 log_level_unknown
= 1;
557 if (!cpu_online(smp_processor_id()) &&
558 system_state
!= SYSTEM_RUNNING
) {
560 * Some console drivers may assume that per-cpu resources have
561 * been allocated. So don't allow them to be called by this
562 * CPU until it is officially up. We shouldn't be calling into
563 * random console drivers on a CPU which doesn't exist yet..
565 spin_unlock_irqrestore(&logbuf_lock
, flags
);
568 if (!down_trylock(&console_sem
)) {
571 * We own the drivers. We can drop the spinlock and let
572 * release_console_sem() print the text
574 spin_unlock_irqrestore(&logbuf_lock
, flags
);
575 console_may_schedule
= 0;
576 release_console_sem();
579 * Someone else owns the drivers. We drop the spinlock, which
580 * allows the semaphore holder to proceed and to call the
581 * console drivers with the output which we just produced.
583 spin_unlock_irqrestore(&logbuf_lock
, flags
);
588 EXPORT_SYMBOL(printk
);
589 EXPORT_SYMBOL(vprintk
);
592 * acquire_console_sem - lock the console system for exclusive use.
594 * Acquires a semaphore which guarantees that the caller has
595 * exclusive access to the console system and the console_drivers list.
597 * Can sleep, returns nothing.
599 void acquire_console_sem(void)
605 console_may_schedule
= 1;
607 EXPORT_SYMBOL(acquire_console_sem
);
609 int is_console_locked(void)
611 return console_locked
;
613 EXPORT_SYMBOL(is_console_locked
);
616 * release_console_sem - unlock the console system
618 * Releases the semaphore which the caller holds on the console system
619 * and the console driver list.
621 * While the semaphore was held, console output may have been buffered
622 * by printk(). If this is the case, release_console_sem() emits
623 * the output prior to releasing the semaphore.
625 * If there is output waiting for klogd, we wake it up.
627 * release_console_sem() may be called from any context.
629 void release_console_sem(void)
632 unsigned long _con_start
, _log_end
;
633 unsigned long wake_klogd
= 0;
636 spin_lock_irqsave(&logbuf_lock
, flags
);
637 wake_klogd
|= log_start
- log_end
;
638 if (con_start
== log_end
)
639 break; /* Nothing to print */
640 _con_start
= con_start
;
642 con_start
= log_end
; /* Flush */
643 spin_unlock_irqrestore(&logbuf_lock
, flags
);
644 call_console_drivers(_con_start
, _log_end
);
647 console_may_schedule
= 0;
649 spin_unlock_irqrestore(&logbuf_lock
, flags
);
650 if (wake_klogd
&& !oops_in_progress
&& waitqueue_active(&log_wait
))
651 wake_up_interruptible(&log_wait
);
653 EXPORT_SYMBOL(release_console_sem
);
655 /** console_conditional_schedule - yield the CPU if required
657 * If the console code is currently allowed to sleep, and
658 * if this CPU should yield the CPU to another task, do
661 * Must be called within acquire_console_sem().
663 void console_conditional_schedule(void)
665 if (console_may_schedule
&& need_resched()) {
666 set_current_state(TASK_RUNNING
);
670 EXPORT_SYMBOL(console_conditional_schedule
);
672 void console_print(const char *s
)
674 printk(KERN_EMERG
"%s", s
);
676 EXPORT_SYMBOL(console_print
);
678 void console_unblank(void)
683 * Try to get the console semaphore. If someone else owns it
684 * we have to return without unblanking because console_unblank
685 * may be called in interrupt context.
687 if (down_trylock(&console_sem
) != 0)
690 console_may_schedule
= 0;
691 for (c
= console_drivers
; c
!= NULL
; c
= c
->next
)
692 if ((c
->flags
& CON_ENABLED
) && c
->unblank
)
694 release_console_sem();
696 EXPORT_SYMBOL(console_unblank
);
699 * Return the console tty driver structure and its associated index
701 struct tty_driver
*console_device(int *index
)
704 struct tty_driver
*driver
= NULL
;
706 acquire_console_sem();
707 for (c
= console_drivers
; c
!= NULL
; c
= c
->next
) {
710 driver
= c
->device(c
, index
);
714 release_console_sem();
719 * Prevent further output on the passed console device so that (for example)
720 * serial drivers can disable console output before suspending a port, and can
721 * re-enable output afterwards.
723 void console_stop(struct console
*console
)
725 acquire_console_sem();
726 console
->flags
&= ~CON_ENABLED
;
727 release_console_sem();
729 EXPORT_SYMBOL(console_stop
);
731 void console_start(struct console
*console
)
733 acquire_console_sem();
734 console
->flags
|= CON_ENABLED
;
735 release_console_sem();
737 EXPORT_SYMBOL(console_start
);
740 * The console driver calls this routine during kernel initialization
741 * to register the console printing procedure with printk() and to
742 * print any messages that were printed by the kernel before the
743 * console driver was initialized.
745 void register_console(struct console
* console
)
751 * See if we want to use this console driver. If we
752 * didn't select a console we take the first one
753 * that registers here.
755 if (preferred_console
< 0) {
756 if (console
->index
< 0)
758 if (console
->setup
== NULL
||
759 console
->setup(console
, NULL
) == 0) {
760 console
->flags
|= CON_ENABLED
| CON_CONSDEV
;
761 preferred_console
= 0;
766 * See if this console matches one we selected on
769 for(i
= 0; i
< MAX_CMDLINECONSOLES
&& console_cmdline
[i
].name
[0]; i
++) {
770 if (strcmp(console_cmdline
[i
].name
, console
->name
) != 0)
772 if (console
->index
>= 0 &&
773 console
->index
!= console_cmdline
[i
].index
)
775 if (console
->index
< 0)
776 console
->index
= console_cmdline
[i
].index
;
777 if (console
->setup
&&
778 console
->setup(console
, console_cmdline
[i
].options
) != 0)
780 console
->flags
|= CON_ENABLED
;
781 console
->index
= console_cmdline
[i
].index
;
782 if (i
== preferred_console
)
783 console
->flags
|= CON_CONSDEV
;
787 if (!(console
->flags
& CON_ENABLED
))
791 * Put this console in the list - keep the
792 * preferred driver at the head of the list.
794 acquire_console_sem();
795 if ((console
->flags
& CON_CONSDEV
) || console_drivers
== NULL
) {
796 console
->next
= console_drivers
;
797 console_drivers
= console
;
799 console
->next
= console_drivers
->next
;
800 console_drivers
->next
= console
;
802 if (console
->flags
& CON_PRINTBUFFER
) {
804 * release_console_sem() will print out the buffered messages
807 spin_lock_irqsave(&logbuf_lock
, flags
);
808 con_start
= log_start
;
809 spin_unlock_irqrestore(&logbuf_lock
, flags
);
811 release_console_sem();
813 EXPORT_SYMBOL(register_console
);
815 int unregister_console(struct console
* console
)
817 struct console
*a
,*b
;
820 acquire_console_sem();
821 if (console_drivers
== console
) {
822 console_drivers
=console
->next
;
825 for (a
=console_drivers
->next
, b
=console_drivers
;
835 /* If last console is removed, we re-enable picking the first
836 * one that gets registered. Without that, pmac early boot console
837 * would prevent fbcon from taking over.
839 if (console_drivers
== NULL
)
840 preferred_console
= -1;
843 release_console_sem();
846 EXPORT_SYMBOL(unregister_console
);
849 * tty_write_message - write a message to a certain tty, not just the console.
851 * This is used for messages that need to be redirected to a specific tty.
852 * We don't put it into the syslog queue right now maybe in the future if
855 void tty_write_message(struct tty_struct
*tty
, char *msg
)
857 if (tty
&& tty
->driver
->write
)
858 tty
->driver
->write(tty
, 0, msg
, strlen(msg
));
863 * printk rate limiting, lifted from the networking subsystem.
865 * This enforces a rate limit: not more than one kernel message
866 * every printk_ratelimit_jiffies to make a denial-of-service
869 int __printk_ratelimit(int ratelimit_jiffies
, int ratelimit_burst
)
871 static spinlock_t ratelimit_lock
= SPIN_LOCK_UNLOCKED
;
872 static unsigned long toks
= 10*5*HZ
;
873 static unsigned long last_msg
;
876 unsigned long now
= jiffies
;
878 spin_lock_irqsave(&ratelimit_lock
, flags
);
879 toks
+= now
- last_msg
;
881 if (toks
> (ratelimit_burst
* ratelimit_jiffies
))
882 toks
= ratelimit_burst
* ratelimit_jiffies
;
883 if (toks
>= ratelimit_jiffies
) {
886 toks
-= ratelimit_jiffies
;
887 spin_unlock_irqrestore(&ratelimit_lock
, flags
);
889 printk(KERN_WARNING
"printk: %d messages suppressed.\n", lost
);
893 spin_unlock_irqrestore(&ratelimit_lock
, flags
);
896 EXPORT_SYMBOL(__printk_ratelimit
);
898 /* minimum time in jiffies between messages */
899 int printk_ratelimit_jiffies
= 5*HZ
;
901 /* number of messages we send before ratelimiting */
902 int printk_ratelimit_burst
= 10;
904 int printk_ratelimit(void)
906 return __printk_ratelimit(printk_ratelimit_jiffies
,
907 printk_ratelimit_burst
);
909 EXPORT_SYMBOL(printk_ratelimit
);