printk: use %pK for /proc/kallsyms and /proc/modules
[GitHub/mt8127/android_kernel_alcatel_ttab.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.
40dc5651 13 * Fixed SMP synchronization, 08/08/99, Manfred Spraul
624dffcb 14 * manfred@colorfullife.com
1da177e4 15 * Rewrote bits to get rid of console_lock
e1f8e874 16 * 01Mar01 Andrew Morton
1da177e4
LT
17 */
18
19#include <linux/kernel.h>
20#include <linux/mm.h>
21#include <linux/tty.h>
22#include <linux/tty_driver.h>
1da177e4
LT
23#include <linux/console.h>
24#include <linux/init.h>
bfe8df3d
RD
25#include <linux/jiffies.h>
26#include <linux/nmi.h>
1da177e4 27#include <linux/module.h>
3b9c0410 28#include <linux/moduleparam.h>
1da177e4 29#include <linux/interrupt.h> /* For in_interrupt() */
1da177e4
LT
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>
04d491ab 35#include <linux/kexec.h>
d37d39ae 36#include <linux/kdb.h>
3fff4c42 37#include <linux/ratelimit.h>
456b565c 38#include <linux/kmsg_dump.h>
00234592 39#include <linux/syslog.h>
034260d6
KC
40#include <linux/cpu.h>
41#include <linux/notifier.h>
fb842b00 42#include <linux/rculist.h>
1da177e4
LT
43
44#include <asm/uaccess.h>
45
076f9776
IM
46/*
47 * Architectures can override it:
48 */
e17ba73b 49void asmlinkage __attribute__((weak)) early_printk(const char *fmt, ...)
076f9776
IM
50{
51}
52
1da177e4
LT
53#define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
54
55/* printk's without a loglevel use this.. */
56#define DEFAULT_MESSAGE_LOGLEVEL 4 /* KERN_WARNING */
57
58/* We show everything that is MORE important than this.. */
59#define MINIMUM_CONSOLE_LOGLEVEL 1 /* Minimum loglevel we let people use */
60#define DEFAULT_CONSOLE_LOGLEVEL 7 /* anything MORE serious than KERN_DEBUG */
61
62DECLARE_WAIT_QUEUE_HEAD(log_wait);
63
64int console_printk[4] = {
65 DEFAULT_CONSOLE_LOGLEVEL, /* console_loglevel */
66 DEFAULT_MESSAGE_LOGLEVEL, /* default_message_loglevel */
67 MINIMUM_CONSOLE_LOGLEVEL, /* minimum_console_loglevel */
68 DEFAULT_CONSOLE_LOGLEVEL, /* default_console_loglevel */
69};
70
1da177e4 71/*
0bbfb7c2 72 * Low level drivers may need that to know if they can schedule in
1da177e4
LT
73 * their unblank() callback or not. So let's export it.
74 */
75int oops_in_progress;
76EXPORT_SYMBOL(oops_in_progress);
77
78/*
79 * console_sem protects the console_drivers list, and also
80 * provides serialisation for access to the entire console
81 * driver system.
82 */
5b8c4f23 83static DEFINE_SEMAPHORE(console_sem);
1da177e4 84struct console *console_drivers;
a29d1cfe
IM
85EXPORT_SYMBOL_GPL(console_drivers);
86
1da177e4
LT
87/*
88 * This is used for debugging the mess that is the VT code by
89 * keeping track if we have the console semaphore held. It's
90 * definitely not the perfect debug tool (we don't know if _WE_
91 * hold it are racing, but it helps tracking those weird code
92 * path in the console code where we end up in places I want
93 * locked without the console sempahore held
94 */
557240b4 95static int console_locked, console_suspended;
1da177e4
LT
96
97/*
98 * logbuf_lock protects log_buf, log_start, log_end, con_start and logged_chars
99 * It is also used in interesting ways to provide interlocking in
ac751efa 100 * console_unlock();.
1da177e4
LT
101 */
102static DEFINE_SPINLOCK(logbuf_lock);
103
eed4a2ab 104#define LOG_BUF_MASK (log_buf_len-1)
1da177e4
LT
105#define LOG_BUF(idx) (log_buf[(idx) & LOG_BUF_MASK])
106
107/*
108 * The indices into log_buf are not constrained to log_buf_len - they
109 * must be masked before subscripting
110 */
eed4a2ab
DV
111static unsigned log_start; /* Index into log_buf: next char to be read by syslog() */
112static unsigned con_start; /* Index into log_buf: next char to be sent to consoles */
113static unsigned log_end; /* Index into log_buf: most-recently-written-char + 1 */
1da177e4 114
fe3d8ad3
FT
115/*
116 * If exclusive_console is non-NULL then only this console is to be printed to.
117 */
118static struct console *exclusive_console;
119
1da177e4
LT
120/*
121 * Array of consoles built from command line options (console=)
122 */
123struct console_cmdline
124{
125 char name[8]; /* Name of the driver */
126 int index; /* Minor dev. to use */
127 char *options; /* Options for the driver */
f7511d5f
ST
128#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
129 char *brl_options; /* Options for braille driver */
130#endif
1da177e4
LT
131};
132
133#define MAX_CMDLINECONSOLES 8
134
135static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
136static int selected_console = -1;
137static int preferred_console = -1;
9e124fe1
MA
138int console_set_on_cmdline;
139EXPORT_SYMBOL(console_set_on_cmdline);
1da177e4
LT
140
141/* Flag: console code may call schedule() */
142static int console_may_schedule;
143
d59745ce
MM
144#ifdef CONFIG_PRINTK
145
146static char __log_buf[__LOG_BUF_LEN];
147static char *log_buf = __log_buf;
148static int log_buf_len = __LOG_BUF_LEN;
eed4a2ab 149static unsigned logged_chars; /* Number of chars produced since last read+clear operation */
cea83886 150static int saved_console_loglevel = -1;
d59745ce 151
04d491ab
NH
152#ifdef CONFIG_KEXEC
153/*
154 * This appends the listed symbols to /proc/vmcoreinfo
155 *
156 * /proc/vmcoreinfo is used by various utiilties, like crash and makedumpfile to
157 * obtain access to symbols that are otherwise very difficult to locate. These
158 * symbols are specifically used so that utilities can access and extract the
159 * dmesg log from a vmcore file after a crash.
160 */
161void log_buf_kexec_setup(void)
162{
163 VMCOREINFO_SYMBOL(log_buf);
164 VMCOREINFO_SYMBOL(log_end);
165 VMCOREINFO_SYMBOL(log_buf_len);
166 VMCOREINFO_SYMBOL(logged_chars);
167}
168#endif
169
1da177e4
LT
170static int __init log_buf_len_setup(char *str)
171{
eed4a2ab 172 unsigned size = memparse(str, &str);
1da177e4
LT
173 unsigned long flags;
174
175 if (size)
176 size = roundup_pow_of_two(size);
177 if (size > log_buf_len) {
eed4a2ab 178 unsigned start, dest_idx, offset;
40dc5651 179 char *new_log_buf;
1da177e4
LT
180
181 new_log_buf = alloc_bootmem(size);
182 if (!new_log_buf) {
40dc5651 183 printk(KERN_WARNING "log_buf_len: allocation failed\n");
1da177e4
LT
184 goto out;
185 }
186
187 spin_lock_irqsave(&logbuf_lock, flags);
188 log_buf_len = size;
189 log_buf = new_log_buf;
190
191 offset = start = min(con_start, log_start);
192 dest_idx = 0;
193 while (start != log_end) {
194 log_buf[dest_idx] = __log_buf[start & (__LOG_BUF_LEN - 1)];
195 start++;
196 dest_idx++;
197 }
198 log_start -= offset;
199 con_start -= offset;
200 log_end -= offset;
201 spin_unlock_irqrestore(&logbuf_lock, flags);
202
40dc5651 203 printk(KERN_NOTICE "log_buf_len: %d\n", log_buf_len);
1da177e4
LT
204 }
205out:
1da177e4
LT
206 return 1;
207}
208
209__setup("log_buf_len=", log_buf_len_setup);
210
bfe8df3d
RD
211#ifdef CONFIG_BOOT_PRINTK_DELAY
212
674dff65 213static int boot_delay; /* msecs delay after each printk during bootup */
3a3b6ed2 214static unsigned long long loops_per_msec; /* based on boot_delay */
bfe8df3d
RD
215
216static int __init boot_delay_setup(char *str)
217{
218 unsigned long lpj;
bfe8df3d
RD
219
220 lpj = preset_lpj ? preset_lpj : 1000000; /* some guess */
221 loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
222
223 get_option(&str, &boot_delay);
224 if (boot_delay > 10 * 1000)
225 boot_delay = 0;
226
3a3b6ed2
DY
227 pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
228 "HZ: %d, loops_per_msec: %llu\n",
229 boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
bfe8df3d
RD
230 return 1;
231}
232__setup("boot_delay=", boot_delay_setup);
233
234static void boot_delay_msec(void)
235{
236 unsigned long long k;
237 unsigned long timeout;
238
239 if (boot_delay == 0 || system_state != SYSTEM_BOOTING)
240 return;
241
3a3b6ed2 242 k = (unsigned long long)loops_per_msec * boot_delay;
bfe8df3d
RD
243
244 timeout = jiffies + msecs_to_jiffies(boot_delay);
245 while (k) {
246 k--;
247 cpu_relax();
248 /*
249 * use (volatile) jiffies to prevent
250 * compiler reduction; loop termination via jiffies
251 * is secondary and may or may not happen.
252 */
253 if (time_after(jiffies, timeout))
254 break;
255 touch_nmi_watchdog();
256 }
257}
258#else
259static inline void boot_delay_msec(void)
260{
261}
262#endif
263
eaf06b24
DR
264#ifdef CONFIG_SECURITY_DMESG_RESTRICT
265int dmesg_restrict = 1;
266#else
267int dmesg_restrict;
268#endif
269
ee24aebf
LT
270static int syslog_action_restricted(int type)
271{
272 if (dmesg_restrict)
273 return 1;
274 /* Unless restricted, we allow "read all" and "get buffer size" for everybody */
275 return type != SYSLOG_ACTION_READ_ALL && type != SYSLOG_ACTION_SIZE_BUFFER;
276}
277
278static int check_syslog_permissions(int type, bool from_file)
279{
280 /*
281 * If this is from /proc/kmsg and we've already opened it, then we've
282 * already done the capabilities checks at open time.
283 */
284 if (from_file && type != SYSLOG_ACTION_OPEN)
285 return 0;
286
287 if (syslog_action_restricted(type)) {
288 if (capable(CAP_SYSLOG))
289 return 0;
290 /* For historical reasons, accept CAP_SYS_ADMIN too, with a warning */
291 if (capable(CAP_SYS_ADMIN)) {
292 WARN_ONCE(1, "Attempt to access syslog with CAP_SYS_ADMIN "
293 "but no CAP_SYSLOG (deprecated).\n");
294 return 0;
295 }
296 return -EPERM;
297 }
298 return 0;
299}
300
00234592 301int do_syslog(int type, char __user *buf, int len, bool from_file)
1da177e4 302{
eed4a2ab 303 unsigned i, j, limit, count;
1da177e4
LT
304 int do_clear = 0;
305 char c;
ee24aebf 306 int error;
1da177e4 307
ee24aebf
LT
308 error = check_syslog_permissions(type, from_file);
309 if (error)
310 goto out;
12b3052c
EP
311
312 error = security_syslog(type);
1da177e4
LT
313 if (error)
314 return error;
315
316 switch (type) {
d78ca3cd 317 case SYSLOG_ACTION_CLOSE: /* Close log */
1da177e4 318 break;
d78ca3cd 319 case SYSLOG_ACTION_OPEN: /* Open log */
1da177e4 320 break;
d78ca3cd 321 case SYSLOG_ACTION_READ: /* Read from log */
1da177e4
LT
322 error = -EINVAL;
323 if (!buf || len < 0)
324 goto out;
325 error = 0;
326 if (!len)
327 goto out;
328 if (!access_ok(VERIFY_WRITE, buf, len)) {
329 error = -EFAULT;
330 goto out;
331 }
40dc5651
JJ
332 error = wait_event_interruptible(log_wait,
333 (log_start - log_end));
1da177e4
LT
334 if (error)
335 goto out;
336 i = 0;
337 spin_lock_irq(&logbuf_lock);
338 while (!error && (log_start != log_end) && i < len) {
339 c = LOG_BUF(log_start);
340 log_start++;
341 spin_unlock_irq(&logbuf_lock);
342 error = __put_user(c,buf);
343 buf++;
344 i++;
345 cond_resched();
346 spin_lock_irq(&logbuf_lock);
347 }
348 spin_unlock_irq(&logbuf_lock);
349 if (!error)
350 error = i;
351 break;
d78ca3cd
KC
352 /* Read/clear last kernel messages */
353 case SYSLOG_ACTION_READ_CLEAR:
40dc5651 354 do_clear = 1;
1da177e4 355 /* FALL THRU */
d78ca3cd
KC
356 /* Read last kernel messages */
357 case SYSLOG_ACTION_READ_ALL:
1da177e4
LT
358 error = -EINVAL;
359 if (!buf || len < 0)
360 goto out;
361 error = 0;
362 if (!len)
363 goto out;
364 if (!access_ok(VERIFY_WRITE, buf, len)) {
365 error = -EFAULT;
366 goto out;
367 }
368 count = len;
369 if (count > log_buf_len)
370 count = log_buf_len;
371 spin_lock_irq(&logbuf_lock);
372 if (count > logged_chars)
373 count = logged_chars;
374 if (do_clear)
375 logged_chars = 0;
376 limit = log_end;
377 /*
378 * __put_user() could sleep, and while we sleep
40dc5651 379 * printk() could overwrite the messages
1da177e4
LT
380 * we try to copy to user space. Therefore
381 * the messages are copied in reverse. <manfreds>
382 */
40dc5651 383 for (i = 0; i < count && !error; i++) {
1da177e4
LT
384 j = limit-1-i;
385 if (j + log_buf_len < log_end)
386 break;
387 c = LOG_BUF(j);
388 spin_unlock_irq(&logbuf_lock);
389 error = __put_user(c,&buf[count-1-i]);
390 cond_resched();
391 spin_lock_irq(&logbuf_lock);
392 }
393 spin_unlock_irq(&logbuf_lock);
394 if (error)
395 break;
396 error = i;
40dc5651 397 if (i != count) {
1da177e4
LT
398 int offset = count-error;
399 /* buffer overflow during copy, correct user buffer. */
40dc5651 400 for (i = 0; i < error; i++) {
1da177e4
LT
401 if (__get_user(c,&buf[i+offset]) ||
402 __put_user(c,&buf[i])) {
403 error = -EFAULT;
404 break;
405 }
406 cond_resched();
407 }
408 }
409 break;
d78ca3cd
KC
410 /* Clear ring buffer */
411 case SYSLOG_ACTION_CLEAR:
1da177e4
LT
412 logged_chars = 0;
413 break;
d78ca3cd
KC
414 /* Disable logging to console */
415 case SYSLOG_ACTION_CONSOLE_OFF:
1aaad49e
FP
416 if (saved_console_loglevel == -1)
417 saved_console_loglevel = console_loglevel;
1da177e4
LT
418 console_loglevel = minimum_console_loglevel;
419 break;
d78ca3cd
KC
420 /* Enable logging to console */
421 case SYSLOG_ACTION_CONSOLE_ON:
1aaad49e
FP
422 if (saved_console_loglevel != -1) {
423 console_loglevel = saved_console_loglevel;
424 saved_console_loglevel = -1;
425 }
1da177e4 426 break;
d78ca3cd
KC
427 /* Set level of messages printed to console */
428 case SYSLOG_ACTION_CONSOLE_LEVEL:
1da177e4
LT
429 error = -EINVAL;
430 if (len < 1 || len > 8)
431 goto out;
432 if (len < minimum_console_loglevel)
433 len = minimum_console_loglevel;
434 console_loglevel = len;
1aaad49e
FP
435 /* Implicitly re-enable logging to console */
436 saved_console_loglevel = -1;
1da177e4
LT
437 error = 0;
438 break;
d78ca3cd
KC
439 /* Number of chars in the log buffer */
440 case SYSLOG_ACTION_SIZE_UNREAD:
1da177e4
LT
441 error = log_end - log_start;
442 break;
d78ca3cd
KC
443 /* Size of the log buffer */
444 case SYSLOG_ACTION_SIZE_BUFFER:
1da177e4
LT
445 error = log_buf_len;
446 break;
447 default:
448 error = -EINVAL;
449 break;
450 }
451out:
452 return error;
453}
454
1e7bfb21 455SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
1da177e4 456{
00234592 457 return do_syslog(type, buf, len, SYSLOG_FROM_CALL);
1da177e4
LT
458}
459
67fc4e0c
JW
460#ifdef CONFIG_KGDB_KDB
461/* kdb dmesg command needs access to the syslog buffer. do_syslog()
462 * uses locks so it cannot be used during debugging. Just tell kdb
463 * where the start and end of the physical and logical logs are. This
464 * is equivalent to do_syslog(3).
465 */
466void kdb_syslog_data(char *syslog_data[4])
467{
468 syslog_data[0] = log_buf;
469 syslog_data[1] = log_buf + log_buf_len;
470 syslog_data[2] = log_buf + log_end -
471 (logged_chars < log_buf_len ? logged_chars : log_buf_len);
472 syslog_data[3] = log_buf + log_end;
473}
474#endif /* CONFIG_KGDB_KDB */
475
1da177e4
LT
476/*
477 * Call the console drivers on a range of log_buf
478 */
eed4a2ab 479static void __call_console_drivers(unsigned start, unsigned end)
1da177e4
LT
480{
481 struct console *con;
482
4d091611 483 for_each_console(con) {
fe3d8ad3
FT
484 if (exclusive_console && con != exclusive_console)
485 continue;
76a8ad29
ME
486 if ((con->flags & CON_ENABLED) && con->write &&
487 (cpu_online(smp_processor_id()) ||
488 (con->flags & CON_ANYTIME)))
1da177e4
LT
489 con->write(con, &LOG_BUF(start), end - start);
490 }
491}
492
79290822
IM
493static int __read_mostly ignore_loglevel;
494
99eea6a1 495static int __init ignore_loglevel_setup(char *str)
79290822
IM
496{
497 ignore_loglevel = 1;
498 printk(KERN_INFO "debug: ignoring loglevel setting.\n");
499
c4772d99 500 return 0;
79290822
IM
501}
502
c4772d99 503early_param("ignore_loglevel", ignore_loglevel_setup);
79290822 504
1da177e4
LT
505/*
506 * Write out chars from start to end - 1 inclusive
507 */
eed4a2ab
DV
508static void _call_console_drivers(unsigned start,
509 unsigned end, int msg_log_level)
1da177e4 510{
79290822 511 if ((msg_log_level < console_loglevel || ignore_loglevel) &&
1da177e4
LT
512 console_drivers && start != end) {
513 if ((start & LOG_BUF_MASK) > (end & LOG_BUF_MASK)) {
514 /* wrapped write */
515 __call_console_drivers(start & LOG_BUF_MASK,
516 log_buf_len);
517 __call_console_drivers(0, end & LOG_BUF_MASK);
518 } else {
519 __call_console_drivers(start, end);
520 }
521 }
522}
523
9d90c8d9
KS
524/*
525 * Parse the syslog header <[0-9]*>. The decimal value represents 32bit, the
526 * lower 3 bit are the log level, the rest are the log facility. In case
527 * userspace passes usual userspace syslog messages to /dev/kmsg or
528 * /dev/ttyprintk, the log prefix might contain the facility. Printk needs
529 * to extract the correct log level for in-kernel processing, and not mangle
530 * the original value.
531 *
532 * If a prefix is found, the length of the prefix is returned. If 'level' is
533 * passed, it will be filled in with the log level without a possible facility
534 * value. If 'special' is passed, the special printk prefix chars are accepted
535 * and returned. If no valid header is found, 0 is returned and the passed
536 * variables are not touched.
537 */
538static size_t log_prefix(const char *p, unsigned int *level, char *special)
539{
540 unsigned int lev = 0;
541 char sp = '\0';
542 size_t len;
543
544 if (p[0] != '<' || !p[1])
545 return 0;
546 if (p[2] == '>') {
547 /* usual single digit level number or special char */
548 switch (p[1]) {
549 case '0' ... '7':
550 lev = p[1] - '0';
551 break;
552 case 'c': /* KERN_CONT */
553 case 'd': /* KERN_DEFAULT */
554 sp = p[1];
555 break;
556 default:
557 return 0;
558 }
559 len = 3;
560 } else {
561 /* multi digit including the level and facility number */
562 char *endp = NULL;
563
564 if (p[1] < '0' && p[1] > '9')
565 return 0;
566
567 lev = (simple_strtoul(&p[1], &endp, 10) & 7);
568 if (endp == NULL || endp[0] != '>')
569 return 0;
570 len = (endp + 1) - p;
571 }
572
573 /* do not accept special char if not asked for */
574 if (sp && !special)
575 return 0;
576
577 if (special) {
578 *special = sp;
579 /* return special char, do not touch level */
580 if (sp)
581 return len;
582 }
583
584 if (level)
585 *level = lev;
586 return len;
587}
588
1da177e4
LT
589/*
590 * Call the console drivers, asking them to write out
591 * log_buf[start] to log_buf[end - 1].
ac751efa 592 * The console_lock must be held.
1da177e4 593 */
eed4a2ab 594static void call_console_drivers(unsigned start, unsigned end)
1da177e4 595{
eed4a2ab 596 unsigned cur_index, start_print;
1da177e4
LT
597 static int msg_level = -1;
598
eed4a2ab 599 BUG_ON(((int)(start - end)) > 0);
1da177e4
LT
600
601 cur_index = start;
602 start_print = start;
603 while (cur_index != end) {
9d90c8d9
KS
604 if (msg_level < 0 && ((end - cur_index) > 2)) {
605 /* strip log prefix */
606 cur_index += log_prefix(&LOG_BUF(cur_index), &msg_level, NULL);
1da177e4
LT
607 start_print = cur_index;
608 }
609 while (cur_index != end) {
610 char c = LOG_BUF(cur_index);
1da177e4 611
40dc5651 612 cur_index++;
1da177e4
LT
613 if (c == '\n') {
614 if (msg_level < 0) {
615 /*
616 * printk() has already given us loglevel tags in
617 * the buffer. This code is here in case the
618 * log buffer has wrapped right round and scribbled
619 * on those tags
620 */
621 msg_level = default_message_loglevel;
622 }
623 _call_console_drivers(start_print, cur_index, msg_level);
624 msg_level = -1;
625 start_print = cur_index;
626 break;
627 }
628 }
629 }
630 _call_console_drivers(start_print, end, msg_level);
631}
632
633static void emit_log_char(char c)
634{
635 LOG_BUF(log_end) = c;
636 log_end++;
637 if (log_end - log_start > log_buf_len)
638 log_start = log_end - log_buf_len;
639 if (log_end - con_start > log_buf_len)
640 con_start = log_end - log_buf_len;
641 if (logged_chars < log_buf_len)
642 logged_chars++;
643}
644
645/*
646 * Zap console related locks when oopsing. Only zap at most once
647 * every 10 seconds, to leave time for slow consoles to print a
648 * full oops.
649 */
650static void zap_locks(void)
651{
652 static unsigned long oops_timestamp;
653
654 if (time_after_eq(jiffies, oops_timestamp) &&
40dc5651 655 !time_after(jiffies, oops_timestamp + 30 * HZ))
1da177e4
LT
656 return;
657
658 oops_timestamp = jiffies;
659
660 /* If a crash is occurring, make sure we can't deadlock */
661 spin_lock_init(&logbuf_lock);
662 /* And make sure that we print immediately */
5b8c4f23 663 sema_init(&console_sem, 1);
1da177e4
LT
664}
665
666#if defined(CONFIG_PRINTK_TIME)
667static int printk_time = 1;
668#else
669static int printk_time = 0;
670#endif
e84845c4 671module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
1da177e4 672
76a8ad29
ME
673/* Check if we have any console registered that can be called early in boot. */
674static int have_callable_console(void)
675{
676 struct console *con;
677
4d091611 678 for_each_console(con)
76a8ad29
ME
679 if (con->flags & CON_ANYTIME)
680 return 1;
681
682 return 0;
683}
684
ddad86c2
MW
685/**
686 * printk - print a kernel message
687 * @fmt: format string
688 *
72fd4a35 689 * This is printk(). It can be called from any context. We want it to work.
40dc5651 690 *
ac751efa 691 * We try to grab the console_lock. If we succeed, it's easy - we log the output and
1da177e4
LT
692 * call the console drivers. If we fail to get the semaphore we place the output
693 * into the log buffer and return. The current holder of the console_sem will
ac751efa
TH
694 * notice the new output in console_unlock(); and will send it to the
695 * consoles before releasing the lock.
1da177e4
LT
696 *
697 * One effect of this deferred printing is that code which calls printk() and
698 * then changes console_loglevel may break. This is because console_loglevel
699 * is inspected when the actual printing occurs.
ddad86c2
MW
700 *
701 * See also:
702 * printf(3)
20036fdc
AK
703 *
704 * See the vsnprintf() documentation for format string extensions over C99.
1da177e4 705 */
d59745ce 706
1da177e4
LT
707asmlinkage int printk(const char *fmt, ...)
708{
709 va_list args;
710 int r;
711
d37d39ae
JW
712#ifdef CONFIG_KGDB_KDB
713 if (unlikely(kdb_trap_printk)) {
714 va_start(args, fmt);
715 r = vkdb_printf(fmt, args);
716 va_end(args);
717 return r;
718 }
719#endif
1da177e4
LT
720 va_start(args, fmt);
721 r = vprintk(fmt, args);
722 va_end(args);
723
724 return r;
725}
726
fe21773d
DH
727/* cpu currently holding logbuf_lock */
728static volatile unsigned int printk_cpu = UINT_MAX;
729
266c2e0a
LT
730/*
731 * Can we actually use the console at this time on this cpu?
732 *
733 * Console drivers may assume that per-cpu resources have
734 * been allocated. So unless they're explicitly marked as
735 * being able to cope (CON_ANYTIME) don't call them until
736 * this CPU is officially up.
737 */
738static inline int can_use_console(unsigned int cpu)
739{
740 return cpu_online(cpu) || have_callable_console();
741}
742
743/*
744 * Try to get console ownership to actually show the kernel
745 * messages from a 'printk'. Return true (and with the
ac751efa 746 * console_lock held, and 'console_locked' set) if it
266c2e0a
LT
747 * is successful, false otherwise.
748 *
749 * This gets called with the 'logbuf_lock' spinlock held and
750 * interrupts disabled. It should return with 'lockbuf_lock'
751 * released but interrupts still disabled.
752 */
ac751efa 753static int console_trylock_for_printk(unsigned int cpu)
8155c02a 754 __releases(&logbuf_lock)
266c2e0a
LT
755{
756 int retval = 0;
757
ac751efa 758 if (console_trylock()) {
093a07e2
LT
759 retval = 1;
760
761 /*
762 * If we can't use the console, we need to release
763 * the console semaphore by hand to avoid flushing
764 * the buffer. We need to hold the console semaphore
765 * in order to do this test safely.
766 */
767 if (!can_use_console(cpu)) {
768 console_locked = 0;
769 up(&console_sem);
770 retval = 0;
771 }
772 }
266c2e0a
LT
773 printk_cpu = UINT_MAX;
774 spin_unlock(&logbuf_lock);
775 return retval;
776}
3b8945e8
TH
777static const char recursion_bug_msg [] =
778 KERN_CRIT "BUG: recent printk recursion!\n";
779static int recursion_bug;
edb123e1 780static int new_text_line = 1;
3b8945e8 781static char printk_buf[1024];
32a76006 782
af91322e
DY
783int printk_delay_msec __read_mostly;
784
785static inline void printk_delay(void)
786{
787 if (unlikely(printk_delay_msec)) {
788 int m = printk_delay_msec;
789
790 while (m--) {
791 mdelay(1);
792 touch_nmi_watchdog();
793 }
794 }
795}
796
1da177e4
LT
797asmlinkage int vprintk(const char *fmt, va_list args)
798{
32a76006 799 int printed_len = 0;
09159308 800 int current_log_level = default_message_loglevel;
ac60ad74 801 unsigned long flags;
32a76006 802 int this_cpu;
1da177e4 803 char *p;
9d90c8d9
KS
804 size_t plen;
805 char special;
1da177e4 806
bfe8df3d 807 boot_delay_msec();
af91322e 808 printk_delay();
bfe8df3d 809
fe21773d 810 preempt_disable();
1da177e4 811 /* This stops the holder of console_sem just where we want him */
1efc5da3 812 raw_local_irq_save(flags);
32a76006
IM
813 this_cpu = smp_processor_id();
814
815 /*
816 * Ouch, printk recursed into itself!
817 */
818 if (unlikely(printk_cpu == this_cpu)) {
819 /*
820 * If a crash is occurring during printk() on this CPU,
821 * then try to get the crash message out but make sure
822 * we can't deadlock. Otherwise just return to avoid the
823 * recursion and return - but flag the recursion so that
824 * it can be printed at the next appropriate moment:
825 */
826 if (!oops_in_progress) {
3b8945e8 827 recursion_bug = 1;
32a76006
IM
828 goto out_restore_irqs;
829 }
830 zap_locks();
831 }
832
a0f1ccfd
IM
833 lockdep_off();
834 spin_lock(&logbuf_lock);
32a76006 835 printk_cpu = this_cpu;
1da177e4 836
3b8945e8
TH
837 if (recursion_bug) {
838 recursion_bug = 0;
839 strcpy(printk_buf, recursion_bug_msg);
26cc271d 840 printed_len = strlen(recursion_bug_msg);
32a76006 841 }
1da177e4 842 /* Emit the output into the temporary buffer */
32a76006 843 printed_len += vscnprintf(printk_buf + printed_len,
cf3680b9 844 sizeof(printk_buf) - printed_len, fmt, args);
1da177e4 845
5fd29d6c
LT
846 p = printk_buf;
847
9d90c8d9
KS
848 /* Read log level and handle special printk prefix */
849 plen = log_prefix(p, &current_log_level, &special);
850 if (plen) {
851 p += plen;
852
853 switch (special) {
854 case 'c': /* Strip <c> KERN_CONT, continue line */
855 plen = 0;
856 break;
857 case 'd': /* Strip <d> KERN_DEFAULT, start new line */
858 plen = 0;
859 default:
860 if (!new_text_line) {
861 emit_log_char('\n');
862 new_text_line = 1;
5fd29d6c
LT
863 }
864 }
865 }
866
1da177e4 867 /*
9d90c8d9
KS
868 * Copy the output into log_buf. If the caller didn't provide
869 * the appropriate log prefix, we insert them here
1da177e4 870 */
9d90c8d9 871 for (; *p; p++) {
ac60ad74 872 if (new_text_line) {
ac60ad74
NA
873 new_text_line = 0;
874
9d90c8d9
KS
875 if (plen) {
876 /* Copy original log prefix */
877 int i;
878
879 for (i = 0; i < plen; i++)
880 emit_log_char(printk_buf[i]);
881 printed_len += plen;
882 } else {
883 /* Add log prefix */
884 emit_log_char('<');
885 emit_log_char(current_log_level + '0');
886 emit_log_char('>');
887 printed_len += 3;
888 }
889
1da177e4 890 if (printk_time) {
9d90c8d9 891 /* Add the current time stamp */
1da177e4
LT
892 char tbuf[50], *tp;
893 unsigned tlen;
894 unsigned long long t;
895 unsigned long nanosec_rem;
896
326e96b9 897 t = cpu_clock(printk_cpu);
1da177e4 898 nanosec_rem = do_div(t, 1000000000);
ac60ad74
NA
899 tlen = sprintf(tbuf, "[%5lu.%06lu] ",
900 (unsigned long) t,
901 nanosec_rem / 1000);
1da177e4
LT
902
903 for (tp = tbuf; tp < tbuf + tlen; tp++)
904 emit_log_char(*tp);
025510cd 905 printed_len += tlen;
1da177e4 906 }
ac60ad74 907
1da177e4
LT
908 if (!*p)
909 break;
910 }
ac60ad74 911
1da177e4
LT
912 emit_log_char(*p);
913 if (*p == '\n')
ac60ad74 914 new_text_line = 1;
1da177e4
LT
915 }
916
266c2e0a
LT
917 /*
918 * Try to acquire and then immediately release the
919 * console semaphore. The release will do all the
920 * actual magic (print out buffers, wake up klogd,
921 * etc).
922 *
ac751efa 923 * The console_trylock_for_printk() function
266c2e0a
LT
924 * will release 'logbuf_lock' regardless of whether it
925 * actually gets the semaphore or not.
926 */
ac751efa
TH
927 if (console_trylock_for_printk(this_cpu))
928 console_unlock();
76a8ad29 929
266c2e0a 930 lockdep_on();
32a76006 931out_restore_irqs:
266c2e0a 932 raw_local_irq_restore(flags);
76a8ad29 933
fe21773d 934 preempt_enable();
1da177e4
LT
935 return printed_len;
936}
937EXPORT_SYMBOL(printk);
938EXPORT_SYMBOL(vprintk);
939
d59745ce
MM
940#else
941
eed4a2ab 942static void call_console_drivers(unsigned start, unsigned end)
40dc5651
JJ
943{
944}
d59745ce
MM
945
946#endif
947
f7511d5f
ST
948static int __add_preferred_console(char *name, int idx, char *options,
949 char *brl_options)
950{
951 struct console_cmdline *c;
952 int i;
953
954 /*
955 * See if this tty is not yet registered, and
956 * if we have a slot free.
957 */
958 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
959 if (strcmp(console_cmdline[i].name, name) == 0 &&
960 console_cmdline[i].index == idx) {
961 if (!brl_options)
962 selected_console = i;
963 return 0;
964 }
965 if (i == MAX_CMDLINECONSOLES)
966 return -E2BIG;
967 if (!brl_options)
968 selected_console = i;
969 c = &console_cmdline[i];
970 strlcpy(c->name, name, sizeof(c->name));
971 c->options = options;
972#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
973 c->brl_options = brl_options;
974#endif
975 c->index = idx;
976 return 0;
977}
2ea1c539
JB
978/*
979 * Set up a list of consoles. Called from init/main.c
980 */
981static int __init console_setup(char *str)
982{
eaa944af 983 char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for index */
f7511d5f 984 char *s, *options, *brl_options = NULL;
2ea1c539
JB
985 int idx;
986
f7511d5f
ST
987#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
988 if (!memcmp(str, "brl,", 4)) {
989 brl_options = "";
990 str += 4;
991 } else if (!memcmp(str, "brl=", 4)) {
992 brl_options = str + 4;
993 str = strchr(brl_options, ',');
994 if (!str) {
995 printk(KERN_ERR "need port name after brl=\n");
996 return 1;
997 }
998 *(str++) = 0;
999 }
1000#endif
1001
2ea1c539
JB
1002 /*
1003 * Decode str into name, index, options.
1004 */
1005 if (str[0] >= '0' && str[0] <= '9') {
eaa944af
YL
1006 strcpy(buf, "ttyS");
1007 strncpy(buf + 4, str, sizeof(buf) - 5);
2ea1c539 1008 } else {
eaa944af 1009 strncpy(buf, str, sizeof(buf) - 1);
2ea1c539 1010 }
eaa944af 1011 buf[sizeof(buf) - 1] = 0;
2ea1c539
JB
1012 if ((options = strchr(str, ',')) != NULL)
1013 *(options++) = 0;
1014#ifdef __sparc__
1015 if (!strcmp(str, "ttya"))
eaa944af 1016 strcpy(buf, "ttyS0");
2ea1c539 1017 if (!strcmp(str, "ttyb"))
eaa944af 1018 strcpy(buf, "ttyS1");
2ea1c539 1019#endif
eaa944af 1020 for (s = buf; *s; s++)
2ea1c539
JB
1021 if ((*s >= '0' && *s <= '9') || *s == ',')
1022 break;
1023 idx = simple_strtoul(s, NULL, 10);
1024 *s = 0;
1025
f7511d5f 1026 __add_preferred_console(buf, idx, options, brl_options);
9e124fe1 1027 console_set_on_cmdline = 1;
2ea1c539
JB
1028 return 1;
1029}
1030__setup("console=", console_setup);
1031
3c0547ba
MM
1032/**
1033 * add_preferred_console - add a device to the list of preferred consoles.
ddad86c2
MW
1034 * @name: device name
1035 * @idx: device index
1036 * @options: options for this console
3c0547ba
MM
1037 *
1038 * The last preferred console added will be used for kernel messages
1039 * and stdin/out/err for init. Normally this is used by console_setup
1040 * above to handle user-supplied console arguments; however it can also
1041 * be used by arch-specific code either to override the user or more
1042 * commonly to provide a default console (ie from PROM variables) when
1043 * the user has not supplied one.
1044 */
fb445ee5 1045int add_preferred_console(char *name, int idx, char *options)
3c0547ba 1046{
f7511d5f 1047 return __add_preferred_console(name, idx, options, NULL);
3c0547ba
MM
1048}
1049
b6b1d877 1050int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options)
18a8bd94
YL
1051{
1052 struct console_cmdline *c;
1053 int i;
1054
1055 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
1056 if (strcmp(console_cmdline[i].name, name) == 0 &&
1057 console_cmdline[i].index == idx) {
1058 c = &console_cmdline[i];
f735295b 1059 strlcpy(c->name, name_new, sizeof(c->name));
18a8bd94
YL
1060 c->name[sizeof(c->name) - 1] = 0;
1061 c->options = options;
1062 c->index = idx_new;
1063 return i;
1064 }
1065 /* not found */
1066 return -1;
1067}
1068
8f4ce8c3
AS
1069int console_suspend_enabled = 1;
1070EXPORT_SYMBOL(console_suspend_enabled);
1071
1072static int __init console_suspend_disable(char *str)
1073{
1074 console_suspend_enabled = 0;
1075 return 1;
1076}
1077__setup("no_console_suspend", console_suspend_disable);
1078
557240b4
LT
1079/**
1080 * suspend_console - suspend the console subsystem
1081 *
1082 * This disables printk() while we go into suspend states
1083 */
1084void suspend_console(void)
1085{
8f4ce8c3
AS
1086 if (!console_suspend_enabled)
1087 return;
0d63081d 1088 printk("Suspending console(s) (use no_console_suspend to debug)\n");
ac751efa 1089 console_lock();
557240b4 1090 console_suspended = 1;
403f3075 1091 up(&console_sem);
557240b4
LT
1092}
1093
1094void resume_console(void)
1095{
8f4ce8c3
AS
1096 if (!console_suspend_enabled)
1097 return;
403f3075 1098 down(&console_sem);
557240b4 1099 console_suspended = 0;
ac751efa 1100 console_unlock();
557240b4
LT
1101}
1102
034260d6
KC
1103/**
1104 * console_cpu_notify - print deferred console messages after CPU hotplug
1105 * @self: notifier struct
1106 * @action: CPU hotplug event
1107 * @hcpu: unused
1108 *
1109 * If printk() is called from a CPU that is not online yet, the messages
1110 * will be spooled but will not show up on the console. This function is
1111 * called when a new CPU comes online (or fails to come up), and ensures
1112 * that any such output gets printed.
1113 */
1114static int __cpuinit console_cpu_notify(struct notifier_block *self,
1115 unsigned long action, void *hcpu)
1116{
1117 switch (action) {
1118 case CPU_ONLINE:
1119 case CPU_DEAD:
1120 case CPU_DYING:
1121 case CPU_DOWN_FAILED:
1122 case CPU_UP_CANCELED:
ac751efa
TH
1123 console_lock();
1124 console_unlock();
034260d6
KC
1125 }
1126 return NOTIFY_OK;
1127}
1128
1da177e4 1129/**
ac751efa 1130 * console_lock - lock the console system for exclusive use.
1da177e4 1131 *
ac751efa 1132 * Acquires a lock which guarantees that the caller has
1da177e4
LT
1133 * exclusive access to the console system and the console_drivers list.
1134 *
1135 * Can sleep, returns nothing.
1136 */
ac751efa 1137void console_lock(void)
1da177e4 1138{
8abd8e29 1139 BUG_ON(in_interrupt());
1da177e4 1140 down(&console_sem);
403f3075
AH
1141 if (console_suspended)
1142 return;
1da177e4
LT
1143 console_locked = 1;
1144 console_may_schedule = 1;
1145}
ac751efa 1146EXPORT_SYMBOL(console_lock);
1da177e4 1147
ac751efa
TH
1148/**
1149 * console_trylock - try to lock the console system for exclusive use.
1150 *
1151 * Tried to acquire a lock which guarantees that the caller has
1152 * exclusive access to the console system and the console_drivers list.
1153 *
1154 * returns 1 on success, and 0 on failure to acquire the lock.
1155 */
1156int console_trylock(void)
1da177e4
LT
1157{
1158 if (down_trylock(&console_sem))
ac751efa 1159 return 0;
403f3075
AH
1160 if (console_suspended) {
1161 up(&console_sem);
ac751efa 1162 return 0;
403f3075 1163 }
1da177e4
LT
1164 console_locked = 1;
1165 console_may_schedule = 0;
ac751efa 1166 return 1;
1da177e4 1167}
ac751efa 1168EXPORT_SYMBOL(console_trylock);
1da177e4
LT
1169
1170int is_console_locked(void)
1171{
1172 return console_locked;
1173}
1da177e4 1174
b845b517
PZ
1175static DEFINE_PER_CPU(int, printk_pending);
1176
1177void printk_tick(void)
e3e8a75d 1178{
40dc11ff
ED
1179 if (__this_cpu_read(printk_pending)) {
1180 __this_cpu_write(printk_pending, 0);
e3e8a75d 1181 wake_up_interruptible(&log_wait);
b845b517
PZ
1182 }
1183}
1184
1185int printk_needs_cpu(int cpu)
1186{
40dc11ff 1187 if (cpu_is_offline(cpu))
61ab2544 1188 printk_tick();
40dc11ff 1189 return __this_cpu_read(printk_pending);
b845b517
PZ
1190}
1191
1192void wake_up_klogd(void)
1193{
1194 if (waitqueue_active(&log_wait))
49f41383 1195 this_cpu_write(printk_pending, 1);
e3e8a75d
KK
1196}
1197
1da177e4 1198/**
ac751efa 1199 * console_unlock - unlock the console system
1da177e4 1200 *
ac751efa 1201 * Releases the console_lock which the caller holds on the console system
1da177e4
LT
1202 * and the console driver list.
1203 *
ac751efa
TH
1204 * While the console_lock was held, console output may have been buffered
1205 * by printk(). If this is the case, console_unlock(); emits
1206 * the output prior to releasing the lock.
1da177e4
LT
1207 *
1208 * If there is output waiting for klogd, we wake it up.
1209 *
ac751efa 1210 * console_unlock(); may be called from any context.
1da177e4 1211 */
ac751efa 1212void console_unlock(void)
1da177e4
LT
1213{
1214 unsigned long flags;
eed4a2ab
DV
1215 unsigned _con_start, _log_end;
1216 unsigned wake_klogd = 0;
1da177e4 1217
557240b4 1218 if (console_suspended) {
403f3075 1219 up(&console_sem);
557240b4
LT
1220 return;
1221 }
78944e54
AD
1222
1223 console_may_schedule = 0;
1224
1da177e4
LT
1225 for ( ; ; ) {
1226 spin_lock_irqsave(&logbuf_lock, flags);
1227 wake_klogd |= log_start - log_end;
1228 if (con_start == log_end)
1229 break; /* Nothing to print */
1230 _con_start = con_start;
1231 _log_end = log_end;
1232 con_start = log_end; /* Flush */
1233 spin_unlock(&logbuf_lock);
81d68a96 1234 stop_critical_timings(); /* don't trace print latency */
1da177e4 1235 call_console_drivers(_con_start, _log_end);
81d68a96 1236 start_critical_timings();
1da177e4
LT
1237 local_irq_restore(flags);
1238 }
1239 console_locked = 0;
fe3d8ad3
FT
1240
1241 /* Release the exclusive_console once it is used */
1242 if (unlikely(exclusive_console))
1243 exclusive_console = NULL;
1244
1da177e4
LT
1245 up(&console_sem);
1246 spin_unlock_irqrestore(&logbuf_lock, flags);
e3e8a75d
KK
1247 if (wake_klogd)
1248 wake_up_klogd();
1da177e4 1249}
ac751efa 1250EXPORT_SYMBOL(console_unlock);
1da177e4 1251
ddad86c2
MW
1252/**
1253 * console_conditional_schedule - yield the CPU if required
1da177e4
LT
1254 *
1255 * If the console code is currently allowed to sleep, and
1256 * if this CPU should yield the CPU to another task, do
1257 * so here.
1258 *
ac751efa 1259 * Must be called within console_lock();.
1da177e4
LT
1260 */
1261void __sched console_conditional_schedule(void)
1262{
1263 if (console_may_schedule)
1264 cond_resched();
1265}
1266EXPORT_SYMBOL(console_conditional_schedule);
1267
1da177e4
LT
1268void console_unblank(void)
1269{
1270 struct console *c;
1271
1272 /*
1273 * console_unblank can no longer be called in interrupt context unless
1274 * oops_in_progress is set to 1..
1275 */
1276 if (oops_in_progress) {
1277 if (down_trylock(&console_sem) != 0)
1278 return;
1279 } else
ac751efa 1280 console_lock();
1da177e4
LT
1281
1282 console_locked = 1;
1283 console_may_schedule = 0;
4d091611 1284 for_each_console(c)
1da177e4
LT
1285 if ((c->flags & CON_ENABLED) && c->unblank)
1286 c->unblank();
ac751efa 1287 console_unlock();
1da177e4 1288}
1da177e4
LT
1289
1290/*
1291 * Return the console tty driver structure and its associated index
1292 */
1293struct tty_driver *console_device(int *index)
1294{
1295 struct console *c;
1296 struct tty_driver *driver = NULL;
1297
ac751efa 1298 console_lock();
4d091611 1299 for_each_console(c) {
1da177e4
LT
1300 if (!c->device)
1301 continue;
1302 driver = c->device(c, index);
1303 if (driver)
1304 break;
1305 }
ac751efa 1306 console_unlock();
1da177e4
LT
1307 return driver;
1308}
1309
1310/*
1311 * Prevent further output on the passed console device so that (for example)
1312 * serial drivers can disable console output before suspending a port, and can
1313 * re-enable output afterwards.
1314 */
1315void console_stop(struct console *console)
1316{
ac751efa 1317 console_lock();
1da177e4 1318 console->flags &= ~CON_ENABLED;
ac751efa 1319 console_unlock();
1da177e4
LT
1320}
1321EXPORT_SYMBOL(console_stop);
1322
1323void console_start(struct console *console)
1324{
ac751efa 1325 console_lock();
1da177e4 1326 console->flags |= CON_ENABLED;
ac751efa 1327 console_unlock();
1da177e4
LT
1328}
1329EXPORT_SYMBOL(console_start);
1330
7bf69395
FDN
1331static int __read_mostly keep_bootcon;
1332
1333static int __init keep_bootcon_setup(char *str)
1334{
1335 keep_bootcon = 1;
1336 printk(KERN_INFO "debug: skip boot console de-registration.\n");
1337
1338 return 0;
1339}
1340
1341early_param("keep_bootcon", keep_bootcon_setup);
1342
1da177e4
LT
1343/*
1344 * The console driver calls this routine during kernel initialization
1345 * to register the console printing procedure with printk() and to
1346 * print any messages that were printed by the kernel before the
1347 * console driver was initialized.
4d091611
RG
1348 *
1349 * This can happen pretty early during the boot process (because of
1350 * early_printk) - sometimes before setup_arch() completes - be careful
1351 * of what kernel features are used - they may not be initialised yet.
1352 *
1353 * There are two types of consoles - bootconsoles (early_printk) and
1354 * "real" consoles (everything which is not a bootconsole) which are
1355 * handled differently.
1356 * - Any number of bootconsoles can be registered at any time.
1357 * - As soon as a "real" console is registered, all bootconsoles
1358 * will be unregistered automatically.
1359 * - Once a "real" console is registered, any attempt to register a
1360 * bootconsoles will be rejected
1da177e4 1361 */
4d091611 1362void register_console(struct console *newcon)
1da177e4 1363{
40dc5651 1364 int i;
1da177e4 1365 unsigned long flags;
4d091611 1366 struct console *bcon = NULL;
1da177e4 1367
4d091611
RG
1368 /*
1369 * before we register a new CON_BOOT console, make sure we don't
1370 * already have a valid console
1371 */
1372 if (console_drivers && newcon->flags & CON_BOOT) {
1373 /* find the last or real console */
1374 for_each_console(bcon) {
1375 if (!(bcon->flags & CON_BOOT)) {
1376 printk(KERN_INFO "Too late to register bootconsole %s%d\n",
1377 newcon->name, newcon->index);
1378 return;
1379 }
1380 }
69331af7
GH
1381 }
1382
4d091611
RG
1383 if (console_drivers && console_drivers->flags & CON_BOOT)
1384 bcon = console_drivers;
1385
1386 if (preferred_console < 0 || bcon || !console_drivers)
1da177e4
LT
1387 preferred_console = selected_console;
1388
4d091611
RG
1389 if (newcon->early_setup)
1390 newcon->early_setup();
18a8bd94 1391
1da177e4
LT
1392 /*
1393 * See if we want to use this console driver. If we
1394 * didn't select a console we take the first one
1395 * that registers here.
1396 */
1397 if (preferred_console < 0) {
4d091611
RG
1398 if (newcon->index < 0)
1399 newcon->index = 0;
1400 if (newcon->setup == NULL ||
1401 newcon->setup(newcon, NULL) == 0) {
1402 newcon->flags |= CON_ENABLED;
1403 if (newcon->device) {
1404 newcon->flags |= CON_CONSDEV;
cd3a1b85
JK
1405 preferred_console = 0;
1406 }
1da177e4
LT
1407 }
1408 }
1409
1410 /*
1411 * See if this console matches one we selected on
1412 * the command line.
1413 */
40dc5651
JJ
1414 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0];
1415 i++) {
4d091611 1416 if (strcmp(console_cmdline[i].name, newcon->name) != 0)
1da177e4 1417 continue;
4d091611
RG
1418 if (newcon->index >= 0 &&
1419 newcon->index != console_cmdline[i].index)
1da177e4 1420 continue;
4d091611
RG
1421 if (newcon->index < 0)
1422 newcon->index = console_cmdline[i].index;
f7511d5f
ST
1423#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1424 if (console_cmdline[i].brl_options) {
4d091611
RG
1425 newcon->flags |= CON_BRL;
1426 braille_register_console(newcon,
f7511d5f
ST
1427 console_cmdline[i].index,
1428 console_cmdline[i].options,
1429 console_cmdline[i].brl_options);
1430 return;
1431 }
1432#endif
4d091611
RG
1433 if (newcon->setup &&
1434 newcon->setup(newcon, console_cmdline[i].options) != 0)
1da177e4 1435 break;
4d091611
RG
1436 newcon->flags |= CON_ENABLED;
1437 newcon->index = console_cmdline[i].index;
ab4af03a 1438 if (i == selected_console) {
4d091611 1439 newcon->flags |= CON_CONSDEV;
ab4af03a
GE
1440 preferred_console = selected_console;
1441 }
1da177e4
LT
1442 break;
1443 }
1444
4d091611 1445 if (!(newcon->flags & CON_ENABLED))
1da177e4
LT
1446 return;
1447
8259cf43
RG
1448 /*
1449 * If we have a bootconsole, and are switching to a real console,
1450 * don't print everything out again, since when the boot console, and
1451 * the real console are the same physical device, it's annoying to
1452 * see the beginning boot messages twice
1453 */
1454 if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
4d091611 1455 newcon->flags &= ~CON_PRINTBUFFER;
1da177e4
LT
1456
1457 /*
1458 * Put this console in the list - keep the
1459 * preferred driver at the head of the list.
1460 */
ac751efa 1461 console_lock();
4d091611
RG
1462 if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
1463 newcon->next = console_drivers;
1464 console_drivers = newcon;
1465 if (newcon->next)
1466 newcon->next->flags &= ~CON_CONSDEV;
1da177e4 1467 } else {
4d091611
RG
1468 newcon->next = console_drivers->next;
1469 console_drivers->next = newcon;
1da177e4 1470 }
4d091611 1471 if (newcon->flags & CON_PRINTBUFFER) {
1da177e4 1472 /*
ac751efa 1473 * console_unlock(); will print out the buffered messages
1da177e4
LT
1474 * for us.
1475 */
1476 spin_lock_irqsave(&logbuf_lock, flags);
1477 con_start = log_start;
1478 spin_unlock_irqrestore(&logbuf_lock, flags);
fe3d8ad3
FT
1479 /*
1480 * We're about to replay the log buffer. Only do this to the
1481 * just-registered console to avoid excessive message spam to
1482 * the already-registered consoles.
1483 */
1484 exclusive_console = newcon;
1da177e4 1485 }
ac751efa 1486 console_unlock();
fbc92a34 1487 console_sysfs_notify();
8259cf43
RG
1488
1489 /*
1490 * By unregistering the bootconsoles after we enable the real console
1491 * we get the "console xxx enabled" message on all the consoles -
1492 * boot consoles, real consoles, etc - this is to ensure that end
1493 * users know there might be something in the kernel's log buffer that
1494 * went to the bootconsole (that they do not see on the real console)
1495 */
7bf69395
FDN
1496 if (bcon &&
1497 ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
1498 !keep_bootcon) {
8259cf43
RG
1499 /* we need to iterate through twice, to make sure we print
1500 * everything out, before we unregister the console(s)
1501 */
1502 printk(KERN_INFO "console [%s%d] enabled, bootconsole disabled\n",
1503 newcon->name, newcon->index);
1504 for_each_console(bcon)
1505 if (bcon->flags & CON_BOOT)
1506 unregister_console(bcon);
1507 } else {
1508 printk(KERN_INFO "%sconsole [%s%d] enabled\n",
1509 (newcon->flags & CON_BOOT) ? "boot" : "" ,
1510 newcon->name, newcon->index);
1511 }
1da177e4
LT
1512}
1513EXPORT_SYMBOL(register_console);
1514
40dc5651 1515int unregister_console(struct console *console)
1da177e4 1516{
40dc5651 1517 struct console *a, *b;
1da177e4
LT
1518 int res = 1;
1519
f7511d5f
ST
1520#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1521 if (console->flags & CON_BRL)
1522 return braille_unregister_console(console);
1523#endif
1524
ac751efa 1525 console_lock();
1da177e4
LT
1526 if (console_drivers == console) {
1527 console_drivers=console->next;
1528 res = 0;
e9b15b54 1529 } else if (console_drivers) {
1da177e4
LT
1530 for (a=console_drivers->next, b=console_drivers ;
1531 a; b=a, a=b->next) {
1532 if (a == console) {
1533 b->next = a->next;
1534 res = 0;
1535 break;
40dc5651 1536 }
1da177e4
LT
1537 }
1538 }
40dc5651 1539
69331af7 1540 /*
ab4af03a
GE
1541 * If this isn't the last console and it has CON_CONSDEV set, we
1542 * need to set it on the next preferred console.
1da177e4 1543 */
69331af7 1544 if (console_drivers != NULL && console->flags & CON_CONSDEV)
ab4af03a 1545 console_drivers->flags |= CON_CONSDEV;
1da177e4 1546
ac751efa 1547 console_unlock();
fbc92a34 1548 console_sysfs_notify();
1da177e4
LT
1549 return res;
1550}
1551EXPORT_SYMBOL(unregister_console);
d59745ce 1552
034260d6 1553static int __init printk_late_init(void)
0c5564bd 1554{
4d091611
RG
1555 struct console *con;
1556
1557 for_each_console(con) {
1558 if (con->flags & CON_BOOT) {
cb00e99c 1559 printk(KERN_INFO "turn off boot console %s%d\n",
4d091611 1560 con->name, con->index);
42c2c8c8 1561 unregister_console(con);
cb00e99c 1562 }
0c5564bd 1563 }
034260d6 1564 hotcpu_notifier(console_cpu_notify, 0);
0c5564bd
RG
1565 return 0;
1566}
034260d6 1567late_initcall(printk_late_init);
0c5564bd 1568
7ef3d2fd 1569#if defined CONFIG_PRINTK
717115e1 1570
1da177e4
LT
1571/*
1572 * printk rate limiting, lifted from the networking subsystem.
1573 *
641de9d8
UKK
1574 * This enforces a rate limit: not more than 10 kernel messages
1575 * every 5s to make a denial-of-service attack impossible.
1da177e4 1576 */
641de9d8
UKK
1577DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
1578
5c828713 1579int __printk_ratelimit(const char *func)
1da177e4 1580{
5c828713 1581 return ___ratelimit(&printk_ratelimit_state, func);
1da177e4 1582}
5c828713 1583EXPORT_SYMBOL(__printk_ratelimit);
f46c4833
AM
1584
1585/**
1586 * printk_timed_ratelimit - caller-controlled printk ratelimiting
1587 * @caller_jiffies: pointer to caller's state
1588 * @interval_msecs: minimum interval between prints
1589 *
1590 * printk_timed_ratelimit() returns true if more than @interval_msecs
1591 * milliseconds have elapsed since the last time printk_timed_ratelimit()
1592 * returned true.
1593 */
1594bool printk_timed_ratelimit(unsigned long *caller_jiffies,
1595 unsigned int interval_msecs)
1596{
f2d28a2e
GK
1597 if (*caller_jiffies == 0
1598 || !time_in_range(jiffies, *caller_jiffies,
1599 *caller_jiffies
1600 + msecs_to_jiffies(interval_msecs))) {
1601 *caller_jiffies = jiffies;
f46c4833
AM
1602 return true;
1603 }
1604 return false;
1605}
1606EXPORT_SYMBOL(printk_timed_ratelimit);
456b565c
SK
1607
1608static DEFINE_SPINLOCK(dump_list_lock);
1609static LIST_HEAD(dump_list);
1610
1611/**
1612 * kmsg_dump_register - register a kernel log dumper.
6485536b 1613 * @dumper: pointer to the kmsg_dumper structure
456b565c
SK
1614 *
1615 * Adds a kernel log dumper to the system. The dump callback in the
1616 * structure will be called when the kernel oopses or panics and must be
1617 * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
1618 */
1619int kmsg_dump_register(struct kmsg_dumper *dumper)
1620{
1621 unsigned long flags;
1622 int err = -EBUSY;
1623
1624 /* The dump callback needs to be set */
1625 if (!dumper->dump)
1626 return -EINVAL;
1627
1628 spin_lock_irqsave(&dump_list_lock, flags);
1629 /* Don't allow registering multiple times */
1630 if (!dumper->registered) {
1631 dumper->registered = 1;
fb842b00 1632 list_add_tail_rcu(&dumper->list, &dump_list);
456b565c
SK
1633 err = 0;
1634 }
1635 spin_unlock_irqrestore(&dump_list_lock, flags);
1636
1637 return err;
1638}
1639EXPORT_SYMBOL_GPL(kmsg_dump_register);
1640
1641/**
1642 * kmsg_dump_unregister - unregister a kmsg dumper.
6485536b 1643 * @dumper: pointer to the kmsg_dumper structure
456b565c
SK
1644 *
1645 * Removes a dump device from the system. Returns zero on success and
1646 * %-EINVAL otherwise.
1647 */
1648int kmsg_dump_unregister(struct kmsg_dumper *dumper)
1649{
1650 unsigned long flags;
1651 int err = -EINVAL;
1652
1653 spin_lock_irqsave(&dump_list_lock, flags);
1654 if (dumper->registered) {
1655 dumper->registered = 0;
fb842b00 1656 list_del_rcu(&dumper->list);
456b565c
SK
1657 err = 0;
1658 }
1659 spin_unlock_irqrestore(&dump_list_lock, flags);
fb842b00 1660 synchronize_rcu();
456b565c
SK
1661
1662 return err;
1663}
1664EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
1665
456b565c
SK
1666/**
1667 * kmsg_dump - dump kernel log to kernel message dumpers.
1668 * @reason: the reason (oops, panic etc) for dumping
1669 *
1670 * Iterate through each of the dump devices and call the oops/panic
1671 * callbacks with the log buffer.
1672 */
1673void kmsg_dump(enum kmsg_dump_reason reason)
1674{
1675 unsigned long end;
1676 unsigned chars;
1677 struct kmsg_dumper *dumper;
1678 const char *s1, *s2;
1679 unsigned long l1, l2;
1680 unsigned long flags;
1681
1682 /* Theoretically, the log could move on after we do this, but
1683 there's not a lot we can do about that. The new messages
1684 will overwrite the start of what we dump. */
1685 spin_lock_irqsave(&logbuf_lock, flags);
1686 end = log_end & LOG_BUF_MASK;
1687 chars = logged_chars;
1688 spin_unlock_irqrestore(&logbuf_lock, flags);
1689
8c4af38e
AK
1690 if (chars > end) {
1691 s1 = log_buf + log_buf_len - chars + end;
1692 l1 = chars - end;
456b565c
SK
1693
1694 s2 = log_buf;
1695 l2 = end;
1696 } else {
1697 s1 = "";
1698 l1 = 0;
1699
8c4af38e
AK
1700 s2 = log_buf + end - chars;
1701 l2 = chars;
456b565c
SK
1702 }
1703
fb842b00
HY
1704 rcu_read_lock();
1705 list_for_each_entry_rcu(dumper, &dump_list, list)
456b565c 1706 dumper->dump(dumper, reason, s1, l1, s2, l2);
fb842b00 1707 rcu_read_unlock();
456b565c 1708}
7ef3d2fd 1709#endif