[PATCH] s390: channel tape fixes
[linux-block.git] / kernel / printk.c
CommitLineData
1da177e4
LT
1/*
2 * linux/kernel/printk.c
3 *
4 * Copyright (C) 1991, 1992 Linus Torvalds
5 *
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 * manfreds@colorfullife.com
15 * Rewrote bits to get rid of console_lock
16 * 01Mar01 Andrew Morton <andrewm@uow.edu.au>
17 */
18
19#include <linux/kernel.h>
20#include <linux/mm.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>
33#include <linux/syscalls.h>
34
35#include <asm/uaccess.h>
36
37#define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
38
39/* printk's without a loglevel use this.. */
40#define DEFAULT_MESSAGE_LOGLEVEL 4 /* KERN_WARNING */
41
42/* We show everything that is MORE important than this.. */
43#define MINIMUM_CONSOLE_LOGLEVEL 1 /* Minimum loglevel we let people use */
44#define DEFAULT_CONSOLE_LOGLEVEL 7 /* anything MORE serious than KERN_DEBUG */
45
46DECLARE_WAIT_QUEUE_HEAD(log_wait);
47
48int console_printk[4] = {
49 DEFAULT_CONSOLE_LOGLEVEL, /* console_loglevel */
50 DEFAULT_MESSAGE_LOGLEVEL, /* default_message_loglevel */
51 MINIMUM_CONSOLE_LOGLEVEL, /* minimum_console_loglevel */
52 DEFAULT_CONSOLE_LOGLEVEL, /* default_console_loglevel */
53};
54
55EXPORT_SYMBOL(console_printk);
56
57/*
58 * Low lever drivers may need that to know if they can schedule in
59 * their unblank() callback or not. So let's export it.
60 */
61int oops_in_progress;
62EXPORT_SYMBOL(oops_in_progress);
63
64/*
65 * console_sem protects the console_drivers list, and also
66 * provides serialisation for access to the entire console
67 * driver system.
68 */
69static DECLARE_MUTEX(console_sem);
70struct console *console_drivers;
71/*
72 * This is used for debugging the mess that is the VT code by
73 * keeping track if we have the console semaphore held. It's
74 * definitely not the perfect debug tool (we don't know if _WE_
75 * hold it are racing, but it helps tracking those weird code
76 * path in the console code where we end up in places I want
77 * locked without the console sempahore held
78 */
79static int console_locked;
80
81/*
82 * logbuf_lock protects log_buf, log_start, log_end, con_start and logged_chars
83 * It is also used in interesting ways to provide interlocking in
84 * release_console_sem().
85 */
86static DEFINE_SPINLOCK(logbuf_lock);
87
1da177e4
LT
88#define LOG_BUF_MASK (log_buf_len-1)
89#define LOG_BUF(idx) (log_buf[(idx) & LOG_BUF_MASK])
90
91/*
92 * The indices into log_buf are not constrained to log_buf_len - they
93 * must be masked before subscripting
94 */
95static unsigned long log_start; /* Index into log_buf: next char to be read by syslog() */
96static unsigned long con_start; /* Index into log_buf: next char to be sent to consoles */
97static unsigned long log_end; /* Index into log_buf: most-recently-written-char + 1 */
1da177e4
LT
98
99/*
100 * Array of consoles built from command line options (console=)
101 */
102struct console_cmdline
103{
104 char name[8]; /* Name of the driver */
105 int index; /* Minor dev. to use */
106 char *options; /* Options for the driver */
107};
108
109#define MAX_CMDLINECONSOLES 8
110
111static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
112static int selected_console = -1;
113static int preferred_console = -1;
114
115/* Flag: console code may call schedule() */
116static int console_may_schedule;
117
d59745ce
MM
118#ifdef CONFIG_PRINTK
119
120static char __log_buf[__LOG_BUF_LEN];
121static char *log_buf = __log_buf;
122static int log_buf_len = __LOG_BUF_LEN;
123static unsigned long logged_chars; /* Number of chars produced since last read+clear operation */
124
1da177e4
LT
125/*
126 * Setup a list of consoles. Called from init/main.c
127 */
128static int __init console_setup(char *str)
129{
130 char name[sizeof(console_cmdline[0].name)];
131 char *s, *options;
132 int idx;
133
134 /*
135 * Decode str into name, index, options.
136 */
137 if (str[0] >= '0' && str[0] <= '9') {
138 strcpy(name, "ttyS");
139 strncpy(name + 4, str, sizeof(name) - 5);
140 } else
141 strncpy(name, str, sizeof(name) - 1);
142 name[sizeof(name) - 1] = 0;
143 if ((options = strchr(str, ',')) != NULL)
144 *(options++) = 0;
145#ifdef __sparc__
146 if (!strcmp(str, "ttya"))
147 strcpy(name, "ttyS0");
148 if (!strcmp(str, "ttyb"))
149 strcpy(name, "ttyS1");
150#endif
151 for(s = name; *s; s++)
152 if ((*s >= '0' && *s <= '9') || *s == ',')
153 break;
154 idx = simple_strtoul(s, NULL, 10);
155 *s = 0;
156
157 add_preferred_console(name, idx, options);
158 return 1;
159}
160
161__setup("console=", console_setup);
162
1da177e4
LT
163static int __init log_buf_len_setup(char *str)
164{
165 unsigned long size = memparse(str, &str);
166 unsigned long flags;
167
168 if (size)
169 size = roundup_pow_of_two(size);
170 if (size > log_buf_len) {
171 unsigned long start, dest_idx, offset;
172 char * new_log_buf;
173
174 new_log_buf = alloc_bootmem(size);
175 if (!new_log_buf) {
176 printk("log_buf_len: allocation failed\n");
177 goto out;
178 }
179
180 spin_lock_irqsave(&logbuf_lock, flags);
181 log_buf_len = size;
182 log_buf = new_log_buf;
183
184 offset = start = min(con_start, log_start);
185 dest_idx = 0;
186 while (start != log_end) {
187 log_buf[dest_idx] = __log_buf[start & (__LOG_BUF_LEN - 1)];
188 start++;
189 dest_idx++;
190 }
191 log_start -= offset;
192 con_start -= offset;
193 log_end -= offset;
194 spin_unlock_irqrestore(&logbuf_lock, flags);
195
196 printk("log_buf_len: %d\n", log_buf_len);
197 }
198out:
199
200 return 1;
201}
202
203__setup("log_buf_len=", log_buf_len_setup);
204
205/*
206 * Commands to do_syslog:
207 *
208 * 0 -- Close the log. Currently a NOP.
209 * 1 -- Open the log. Currently a NOP.
210 * 2 -- Read from the log.
211 * 3 -- Read all messages remaining in the ring buffer.
212 * 4 -- Read and clear all messages remaining in the ring buffer
213 * 5 -- Clear ring buffer.
214 * 6 -- Disable printk's to console
215 * 7 -- Enable printk's to console
216 * 8 -- Set level of messages printed to console
217 * 9 -- Return number of unread characters in the log buffer
218 * 10 -- Return size of the log buffer
219 */
220int do_syslog(int type, char __user * buf, int len)
221{
222 unsigned long i, j, limit, count;
223 int do_clear = 0;
224 char c;
225 int error = 0;
226
227 error = security_syslog(type);
228 if (error)
229 return error;
230
231 switch (type) {
232 case 0: /* Close log */
233 break;
234 case 1: /* Open log */
235 break;
236 case 2: /* Read from log */
237 error = -EINVAL;
238 if (!buf || len < 0)
239 goto out;
240 error = 0;
241 if (!len)
242 goto out;
243 if (!access_ok(VERIFY_WRITE, buf, len)) {
244 error = -EFAULT;
245 goto out;
246 }
247 error = wait_event_interruptible(log_wait, (log_start - log_end));
248 if (error)
249 goto out;
250 i = 0;
251 spin_lock_irq(&logbuf_lock);
252 while (!error && (log_start != log_end) && i < len) {
253 c = LOG_BUF(log_start);
254 log_start++;
255 spin_unlock_irq(&logbuf_lock);
256 error = __put_user(c,buf);
257 buf++;
258 i++;
259 cond_resched();
260 spin_lock_irq(&logbuf_lock);
261 }
262 spin_unlock_irq(&logbuf_lock);
263 if (!error)
264 error = i;
265 break;
266 case 4: /* Read/clear last kernel messages */
267 do_clear = 1;
268 /* FALL THRU */
269 case 3: /* Read last kernel messages */
270 error = -EINVAL;
271 if (!buf || len < 0)
272 goto out;
273 error = 0;
274 if (!len)
275 goto out;
276 if (!access_ok(VERIFY_WRITE, buf, len)) {
277 error = -EFAULT;
278 goto out;
279 }
280 count = len;
281 if (count > log_buf_len)
282 count = log_buf_len;
283 spin_lock_irq(&logbuf_lock);
284 if (count > logged_chars)
285 count = logged_chars;
286 if (do_clear)
287 logged_chars = 0;
288 limit = log_end;
289 /*
290 * __put_user() could sleep, and while we sleep
291 * printk() could overwrite the messages
292 * we try to copy to user space. Therefore
293 * the messages are copied in reverse. <manfreds>
294 */
295 for(i = 0; i < count && !error; i++) {
296 j = limit-1-i;
297 if (j + log_buf_len < log_end)
298 break;
299 c = LOG_BUF(j);
300 spin_unlock_irq(&logbuf_lock);
301 error = __put_user(c,&buf[count-1-i]);
302 cond_resched();
303 spin_lock_irq(&logbuf_lock);
304 }
305 spin_unlock_irq(&logbuf_lock);
306 if (error)
307 break;
308 error = i;
309 if(i != count) {
310 int offset = count-error;
311 /* buffer overflow during copy, correct user buffer. */
312 for(i=0;i<error;i++) {
313 if (__get_user(c,&buf[i+offset]) ||
314 __put_user(c,&buf[i])) {
315 error = -EFAULT;
316 break;
317 }
318 cond_resched();
319 }
320 }
321 break;
322 case 5: /* Clear ring buffer */
323 logged_chars = 0;
324 break;
325 case 6: /* Disable logging to console */
326 console_loglevel = minimum_console_loglevel;
327 break;
328 case 7: /* Enable logging to console */
329 console_loglevel = default_console_loglevel;
330 break;
331 case 8: /* Set level of messages printed to console */
332 error = -EINVAL;
333 if (len < 1 || len > 8)
334 goto out;
335 if (len < minimum_console_loglevel)
336 len = minimum_console_loglevel;
337 console_loglevel = len;
338 error = 0;
339 break;
340 case 9: /* Number of chars in the log buffer */
341 error = log_end - log_start;
342 break;
343 case 10: /* Size of the log buffer */
344 error = log_buf_len;
345 break;
346 default:
347 error = -EINVAL;
348 break;
349 }
350out:
351 return error;
352}
353
354asmlinkage long sys_syslog(int type, char __user * buf, int len)
355{
356 return do_syslog(type, buf, len);
357}
358
359/*
360 * Call the console drivers on a range of log_buf
361 */
362static void __call_console_drivers(unsigned long start, unsigned long end)
363{
364 struct console *con;
365
366 for (con = console_drivers; con; con = con->next) {
367 if ((con->flags & CON_ENABLED) && con->write)
368 con->write(con, &LOG_BUF(start), end - start);
369 }
370}
371
372/*
373 * Write out chars from start to end - 1 inclusive
374 */
375static void _call_console_drivers(unsigned long start,
376 unsigned long end, int msg_log_level)
377{
378 if (msg_log_level < console_loglevel &&
379 console_drivers && start != end) {
380 if ((start & LOG_BUF_MASK) > (end & LOG_BUF_MASK)) {
381 /* wrapped write */
382 __call_console_drivers(start & LOG_BUF_MASK,
383 log_buf_len);
384 __call_console_drivers(0, end & LOG_BUF_MASK);
385 } else {
386 __call_console_drivers(start, end);
387 }
388 }
389}
390
391/*
392 * Call the console drivers, asking them to write out
393 * log_buf[start] to log_buf[end - 1].
394 * The console_sem must be held.
395 */
396static void call_console_drivers(unsigned long start, unsigned long end)
397{
398 unsigned long cur_index, start_print;
399 static int msg_level = -1;
400
401 if (((long)(start - end)) > 0)
402 BUG();
403
404 cur_index = start;
405 start_print = start;
406 while (cur_index != end) {
407 if ( msg_level < 0 &&
408 ((end - cur_index) > 2) &&
409 LOG_BUF(cur_index + 0) == '<' &&
410 LOG_BUF(cur_index + 1) >= '0' &&
411 LOG_BUF(cur_index + 1) <= '7' &&
412 LOG_BUF(cur_index + 2) == '>')
413 {
414 msg_level = LOG_BUF(cur_index + 1) - '0';
415 cur_index += 3;
416 start_print = cur_index;
417 }
418 while (cur_index != end) {
419 char c = LOG_BUF(cur_index);
420 cur_index++;
421
422 if (c == '\n') {
423 if (msg_level < 0) {
424 /*
425 * printk() has already given us loglevel tags in
426 * the buffer. This code is here in case the
427 * log buffer has wrapped right round and scribbled
428 * on those tags
429 */
430 msg_level = default_message_loglevel;
431 }
432 _call_console_drivers(start_print, cur_index, msg_level);
433 msg_level = -1;
434 start_print = cur_index;
435 break;
436 }
437 }
438 }
439 _call_console_drivers(start_print, end, msg_level);
440}
441
442static void emit_log_char(char c)
443{
444 LOG_BUF(log_end) = c;
445 log_end++;
446 if (log_end - log_start > log_buf_len)
447 log_start = log_end - log_buf_len;
448 if (log_end - con_start > log_buf_len)
449 con_start = log_end - log_buf_len;
450 if (logged_chars < log_buf_len)
451 logged_chars++;
452}
453
454/*
455 * Zap console related locks when oopsing. Only zap at most once
456 * every 10 seconds, to leave time for slow consoles to print a
457 * full oops.
458 */
459static void zap_locks(void)
460{
461 static unsigned long oops_timestamp;
462
463 if (time_after_eq(jiffies, oops_timestamp) &&
464 !time_after(jiffies, oops_timestamp + 30*HZ))
465 return;
466
467 oops_timestamp = jiffies;
468
469 /* If a crash is occurring, make sure we can't deadlock */
470 spin_lock_init(&logbuf_lock);
471 /* And make sure that we print immediately */
472 init_MUTEX(&console_sem);
473}
474
475#if defined(CONFIG_PRINTK_TIME)
476static int printk_time = 1;
477#else
478static int printk_time = 0;
479#endif
480
481static int __init printk_time_setup(char *str)
482{
483 if (*str)
484 return 0;
485 printk_time = 1;
486 return 1;
487}
488
489__setup("time", printk_time_setup);
490
491/*
492 * This is printk. It can be called from any context. We want it to work.
493 *
494 * We try to grab the console_sem. If we succeed, it's easy - we log the output and
495 * call the console drivers. If we fail to get the semaphore we place the output
496 * into the log buffer and return. The current holder of the console_sem will
497 * notice the new output in release_console_sem() and will send it to the
498 * consoles before releasing the semaphore.
499 *
500 * One effect of this deferred printing is that code which calls printk() and
501 * then changes console_loglevel may break. This is because console_loglevel
502 * is inspected when the actual printing occurs.
503 */
d59745ce 504
1da177e4
LT
505asmlinkage int printk(const char *fmt, ...)
506{
507 va_list args;
508 int r;
509
510 va_start(args, fmt);
511 r = vprintk(fmt, args);
512 va_end(args);
513
514 return r;
515}
516
517asmlinkage int vprintk(const char *fmt, va_list args)
518{
519 unsigned long flags;
520 int printed_len;
521 char *p;
522 static char printk_buf[1024];
523 static int log_level_unknown = 1;
524
525 if (unlikely(oops_in_progress))
526 zap_locks();
527
528 /* This stops the holder of console_sem just where we want him */
529 spin_lock_irqsave(&logbuf_lock, flags);
530
531 /* Emit the output into the temporary buffer */
532 printed_len = vscnprintf(printk_buf, sizeof(printk_buf), fmt, args);
533
534 /*
535 * Copy the output into log_buf. If the caller didn't provide
536 * appropriate log level tags, we insert them here
537 */
538 for (p = printk_buf; *p; p++) {
539 if (log_level_unknown) {
540 /* log_level_unknown signals the start of a new line */
541 if (printk_time) {
542 int loglev_char;
543 char tbuf[50], *tp;
544 unsigned tlen;
545 unsigned long long t;
546 unsigned long nanosec_rem;
547
548 /*
549 * force the log level token to be
550 * before the time output.
551 */
552 if (p[0] == '<' && p[1] >='0' &&
553 p[1] <= '7' && p[2] == '>') {
554 loglev_char = p[1];
555 p += 3;
556 printed_len += 3;
557 } else {
558 loglev_char = default_message_loglevel
559 + '0';
560 }
561 t = sched_clock();
562 nanosec_rem = do_div(t, 1000000000);
563 tlen = sprintf(tbuf,
564 "<%c>[%5lu.%06lu] ",
565 loglev_char,
566 (unsigned long)t,
567 nanosec_rem/1000);
568
569 for (tp = tbuf; tp < tbuf + tlen; tp++)
570 emit_log_char(*tp);
571 printed_len += tlen - 3;
572 } else {
573 if (p[0] != '<' || p[1] < '0' ||
574 p[1] > '7' || p[2] != '>') {
575 emit_log_char('<');
576 emit_log_char(default_message_loglevel
577 + '0');
578 emit_log_char('>');
579 }
580 printed_len += 3;
581 }
582 log_level_unknown = 0;
583 if (!*p)
584 break;
585 }
586 emit_log_char(*p);
587 if (*p == '\n')
588 log_level_unknown = 1;
589 }
590
ac255752 591 if (!cpu_online(smp_processor_id())) {
1da177e4
LT
592 /*
593 * Some console drivers may assume that per-cpu resources have
594 * been allocated. So don't allow them to be called by this
595 * CPU until it is officially up. We shouldn't be calling into
596 * random console drivers on a CPU which doesn't exist yet..
597 */
598 spin_unlock_irqrestore(&logbuf_lock, flags);
599 goto out;
600 }
601 if (!down_trylock(&console_sem)) {
602 console_locked = 1;
603 /*
604 * We own the drivers. We can drop the spinlock and let
605 * release_console_sem() print the text
606 */
607 spin_unlock_irqrestore(&logbuf_lock, flags);
608 console_may_schedule = 0;
609 release_console_sem();
610 } else {
611 /*
612 * Someone else owns the drivers. We drop the spinlock, which
613 * allows the semaphore holder to proceed and to call the
614 * console drivers with the output which we just produced.
615 */
616 spin_unlock_irqrestore(&logbuf_lock, flags);
617 }
618out:
619 return printed_len;
620}
621EXPORT_SYMBOL(printk);
622EXPORT_SYMBOL(vprintk);
623
d59745ce
MM
624#else
625
626asmlinkage long sys_syslog(int type, char __user * buf, int len)
627{
628 return 0;
629}
630
631int do_syslog(int type, char __user * buf, int len) { return 0; }
632static void call_console_drivers(unsigned long start, unsigned long end) {}
633
634#endif
635
3c0547ba
MM
636/**
637 * add_preferred_console - add a device to the list of preferred consoles.
638 *
639 * The last preferred console added will be used for kernel messages
640 * and stdin/out/err for init. Normally this is used by console_setup
641 * above to handle user-supplied console arguments; however it can also
642 * be used by arch-specific code either to override the user or more
643 * commonly to provide a default console (ie from PROM variables) when
644 * the user has not supplied one.
645 */
646int __init add_preferred_console(char *name, int idx, char *options)
647{
648 struct console_cmdline *c;
649 int i;
650
651 /*
652 * See if this tty is not yet registered, and
653 * if we have a slot free.
654 */
655 for(i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
656 if (strcmp(console_cmdline[i].name, name) == 0 &&
657 console_cmdline[i].index == idx) {
658 selected_console = i;
659 return 0;
660 }
661 if (i == MAX_CMDLINECONSOLES)
662 return -E2BIG;
663 selected_console = i;
664 c = &console_cmdline[i];
665 memcpy(c->name, name, sizeof(c->name));
666 c->name[sizeof(c->name) - 1] = 0;
667 c->options = options;
668 c->index = idx;
669 return 0;
670}
671
1da177e4
LT
672/**
673 * acquire_console_sem - lock the console system for exclusive use.
674 *
675 * Acquires a semaphore which guarantees that the caller has
676 * exclusive access to the console system and the console_drivers list.
677 *
678 * Can sleep, returns nothing.
679 */
680void acquire_console_sem(void)
681{
682 if (in_interrupt())
683 BUG();
684 down(&console_sem);
685 console_locked = 1;
686 console_may_schedule = 1;
687}
688EXPORT_SYMBOL(acquire_console_sem);
689
690int try_acquire_console_sem(void)
691{
692 if (down_trylock(&console_sem))
693 return -1;
694 console_locked = 1;
695 console_may_schedule = 0;
696 return 0;
697}
698EXPORT_SYMBOL(try_acquire_console_sem);
699
700int is_console_locked(void)
701{
702 return console_locked;
703}
704EXPORT_SYMBOL(is_console_locked);
705
706/**
707 * release_console_sem - unlock the console system
708 *
709 * Releases the semaphore which the caller holds on the console system
710 * and the console driver list.
711 *
712 * While the semaphore was held, console output may have been buffered
713 * by printk(). If this is the case, release_console_sem() emits
714 * the output prior to releasing the semaphore.
715 *
716 * If there is output waiting for klogd, we wake it up.
717 *
718 * release_console_sem() may be called from any context.
719 */
720void release_console_sem(void)
721{
722 unsigned long flags;
723 unsigned long _con_start, _log_end;
724 unsigned long wake_klogd = 0;
725
726 for ( ; ; ) {
727 spin_lock_irqsave(&logbuf_lock, flags);
728 wake_klogd |= log_start - log_end;
729 if (con_start == log_end)
730 break; /* Nothing to print */
731 _con_start = con_start;
732 _log_end = log_end;
733 con_start = log_end; /* Flush */
734 spin_unlock(&logbuf_lock);
735 call_console_drivers(_con_start, _log_end);
736 local_irq_restore(flags);
737 }
738 console_locked = 0;
739 console_may_schedule = 0;
740 up(&console_sem);
741 spin_unlock_irqrestore(&logbuf_lock, flags);
742 if (wake_klogd && !oops_in_progress && waitqueue_active(&log_wait))
743 wake_up_interruptible(&log_wait);
744}
745EXPORT_SYMBOL(release_console_sem);
746
747/** console_conditional_schedule - yield the CPU if required
748 *
749 * If the console code is currently allowed to sleep, and
750 * if this CPU should yield the CPU to another task, do
751 * so here.
752 *
753 * Must be called within acquire_console_sem().
754 */
755void __sched console_conditional_schedule(void)
756{
757 if (console_may_schedule)
758 cond_resched();
759}
760EXPORT_SYMBOL(console_conditional_schedule);
761
762void console_print(const char *s)
763{
764 printk(KERN_EMERG "%s", s);
765}
766EXPORT_SYMBOL(console_print);
767
768void console_unblank(void)
769{
770 struct console *c;
771
772 /*
773 * console_unblank can no longer be called in interrupt context unless
774 * oops_in_progress is set to 1..
775 */
776 if (oops_in_progress) {
777 if (down_trylock(&console_sem) != 0)
778 return;
779 } else
780 acquire_console_sem();
781
782 console_locked = 1;
783 console_may_schedule = 0;
784 for (c = console_drivers; c != NULL; c = c->next)
785 if ((c->flags & CON_ENABLED) && c->unblank)
786 c->unblank();
787 release_console_sem();
788}
789EXPORT_SYMBOL(console_unblank);
790
791/*
792 * Return the console tty driver structure and its associated index
793 */
794struct tty_driver *console_device(int *index)
795{
796 struct console *c;
797 struct tty_driver *driver = NULL;
798
799 acquire_console_sem();
800 for (c = console_drivers; c != NULL; c = c->next) {
801 if (!c->device)
802 continue;
803 driver = c->device(c, index);
804 if (driver)
805 break;
806 }
807 release_console_sem();
808 return driver;
809}
810
811/*
812 * Prevent further output on the passed console device so that (for example)
813 * serial drivers can disable console output before suspending a port, and can
814 * re-enable output afterwards.
815 */
816void console_stop(struct console *console)
817{
818 acquire_console_sem();
819 console->flags &= ~CON_ENABLED;
820 release_console_sem();
821}
822EXPORT_SYMBOL(console_stop);
823
824void console_start(struct console *console)
825{
826 acquire_console_sem();
827 console->flags |= CON_ENABLED;
828 release_console_sem();
829}
830EXPORT_SYMBOL(console_start);
831
832/*
833 * The console driver calls this routine during kernel initialization
834 * to register the console printing procedure with printk() and to
835 * print any messages that were printed by the kernel before the
836 * console driver was initialized.
837 */
838void register_console(struct console * console)
839{
840 int i;
841 unsigned long flags;
842
843 if (preferred_console < 0)
844 preferred_console = selected_console;
845
846 /*
847 * See if we want to use this console driver. If we
848 * didn't select a console we take the first one
849 * that registers here.
850 */
851 if (preferred_console < 0) {
852 if (console->index < 0)
853 console->index = 0;
854 if (console->setup == NULL ||
855 console->setup(console, NULL) == 0) {
856 console->flags |= CON_ENABLED | CON_CONSDEV;
857 preferred_console = 0;
858 }
859 }
860
861 /*
862 * See if this console matches one we selected on
863 * the command line.
864 */
865 for(i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++) {
866 if (strcmp(console_cmdline[i].name, console->name) != 0)
867 continue;
868 if (console->index >= 0 &&
869 console->index != console_cmdline[i].index)
870 continue;
871 if (console->index < 0)
872 console->index = console_cmdline[i].index;
873 if (console->setup &&
874 console->setup(console, console_cmdline[i].options) != 0)
875 break;
876 console->flags |= CON_ENABLED;
877 console->index = console_cmdline[i].index;
ab4af03a 878 if (i == selected_console) {
1da177e4 879 console->flags |= CON_CONSDEV;
ab4af03a
GE
880 preferred_console = selected_console;
881 }
1da177e4
LT
882 break;
883 }
884
885 if (!(console->flags & CON_ENABLED))
886 return;
887
888 if (console_drivers && (console_drivers->flags & CON_BOOT)) {
889 unregister_console(console_drivers);
890 console->flags &= ~CON_PRINTBUFFER;
891 }
892
893 /*
894 * Put this console in the list - keep the
895 * preferred driver at the head of the list.
896 */
897 acquire_console_sem();
898 if ((console->flags & CON_CONSDEV) || console_drivers == NULL) {
899 console->next = console_drivers;
900 console_drivers = console;
ab4af03a
GE
901 if (console->next)
902 console->next->flags &= ~CON_CONSDEV;
1da177e4
LT
903 } else {
904 console->next = console_drivers->next;
905 console_drivers->next = console;
906 }
907 if (console->flags & CON_PRINTBUFFER) {
908 /*
909 * release_console_sem() will print out the buffered messages
910 * for us.
911 */
912 spin_lock_irqsave(&logbuf_lock, flags);
913 con_start = log_start;
914 spin_unlock_irqrestore(&logbuf_lock, flags);
915 }
916 release_console_sem();
917}
918EXPORT_SYMBOL(register_console);
919
920int unregister_console(struct console * console)
921{
922 struct console *a,*b;
923 int res = 1;
924
925 acquire_console_sem();
926 if (console_drivers == console) {
927 console_drivers=console->next;
928 res = 0;
929 } else {
930 for (a=console_drivers->next, b=console_drivers ;
931 a; b=a, a=b->next) {
932 if (a == console) {
933 b->next = a->next;
934 res = 0;
935 break;
936 }
937 }
938 }
939
940 /* If last console is removed, we re-enable picking the first
941 * one that gets registered. Without that, pmac early boot console
942 * would prevent fbcon from taking over.
ab4af03a
GE
943 *
944 * If this isn't the last console and it has CON_CONSDEV set, we
945 * need to set it on the next preferred console.
1da177e4
LT
946 */
947 if (console_drivers == NULL)
948 preferred_console = selected_console;
ab4af03a
GE
949 else if (console->flags & CON_CONSDEV)
950 console_drivers->flags |= CON_CONSDEV;
1da177e4
LT
951
952 release_console_sem();
953 return res;
954}
955EXPORT_SYMBOL(unregister_console);
d59745ce 956
1da177e4
LT
957/**
958 * tty_write_message - write a message to a certain tty, not just the console.
959 *
960 * This is used for messages that need to be redirected to a specific tty.
961 * We don't put it into the syslog queue right now maybe in the future if
962 * really needed.
963 */
964void tty_write_message(struct tty_struct *tty, char *msg)
965{
966 if (tty && tty->driver->write)
967 tty->driver->write(tty, msg, strlen(msg));
968 return;
969}
970
971/*
972 * printk rate limiting, lifted from the networking subsystem.
973 *
974 * This enforces a rate limit: not more than one kernel message
975 * every printk_ratelimit_jiffies to make a denial-of-service
976 * attack impossible.
977 */
978int __printk_ratelimit(int ratelimit_jiffies, int ratelimit_burst)
979{
980 static DEFINE_SPINLOCK(ratelimit_lock);
981 static unsigned long toks = 10*5*HZ;
982 static unsigned long last_msg;
983 static int missed;
984 unsigned long flags;
985 unsigned long now = jiffies;
986
987 spin_lock_irqsave(&ratelimit_lock, flags);
988 toks += now - last_msg;
989 last_msg = now;
990 if (toks > (ratelimit_burst * ratelimit_jiffies))
991 toks = ratelimit_burst * ratelimit_jiffies;
992 if (toks >= ratelimit_jiffies) {
993 int lost = missed;
994 missed = 0;
995 toks -= ratelimit_jiffies;
996 spin_unlock_irqrestore(&ratelimit_lock, flags);
997 if (lost)
998 printk(KERN_WARNING "printk: %d messages suppressed.\n", lost);
999 return 1;
1000 }
1001 missed++;
1002 spin_unlock_irqrestore(&ratelimit_lock, flags);
1003 return 0;
1004}
1005EXPORT_SYMBOL(__printk_ratelimit);
1006
1007/* minimum time in jiffies between messages */
1008int printk_ratelimit_jiffies = 5*HZ;
1009
1010/* number of messages we send before ratelimiting */
1011int printk_ratelimit_burst = 10;
1012
1013int printk_ratelimit(void)
1014{
1015 return __printk_ratelimit(printk_ratelimit_jiffies,
1016 printk_ratelimit_burst);
1017}
1018EXPORT_SYMBOL(printk_ratelimit);