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 * manfred@colorfullife.com
15 * Rewrote bits to get rid of console_lock
16 * 01Mar01 Andrew Morton
19 #include <linux/kernel.h>
21 #include <linux/tty.h>
22 #include <linux/tty_driver.h>
23 #include <linux/console.h>
24 #include <linux/init.h>
25 #include <linux/jiffies.h>
26 #include <linux/nmi.h>
27 #include <linux/module.h>
28 #include <linux/moduleparam.h>
29 #include <linux/interrupt.h> /* For in_interrupt() */
30 #include <linux/delay.h>
31 #include <linux/smp.h>
32 #include <linux/security.h>
33 #include <linux/bootmem.h>
34 #include <linux/syscalls.h>
35 #include <linux/kexec.h>
36 #include <linux/kdb.h>
37 #include <linux/ratelimit.h>
38 #include <linux/kmsg_dump.h>
39 #include <linux/syslog.h>
40 #include <linux/cpu.h>
41 #include <linux/notifier.h>
42 #include <linux/rculist.h>
44 #include <asm/uaccess.h>
47 * Architectures can override it:
49 void asmlinkage
__attribute__((weak
)) early_printk(const char *fmt
, ...)
53 #define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
55 /* printk's without a loglevel use this.. */
56 #define DEFAULT_MESSAGE_LOGLEVEL 4 /* KERN_WARNING */
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 */
62 DECLARE_WAIT_QUEUE_HEAD(log_wait
);
64 int 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 */
72 * Low level drivers may need that to know if they can schedule in
73 * their unblank() callback or not. So let's export it.
76 EXPORT_SYMBOL(oops_in_progress
);
79 * console_sem protects the console_drivers list, and also
80 * provides serialisation for access to the entire console
83 static DEFINE_SEMAPHORE(console_sem
);
84 struct console
*console_drivers
;
85 EXPORT_SYMBOL_GPL(console_drivers
);
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
95 static int console_locked
, console_suspended
;
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
102 static DEFINE_SPINLOCK(logbuf_lock
);
104 #define LOG_BUF_MASK (log_buf_len-1)
105 #define LOG_BUF(idx) (log_buf[(idx) & LOG_BUF_MASK])
108 * The indices into log_buf are not constrained to log_buf_len - they
109 * must be masked before subscripting
111 static unsigned log_start
; /* Index into log_buf: next char to be read by syslog() */
112 static unsigned con_start
; /* Index into log_buf: next char to be sent to consoles */
113 static unsigned log_end
; /* Index into log_buf: most-recently-written-char + 1 */
116 * Array of consoles built from command line options (console=)
118 struct console_cmdline
120 char name
[8]; /* Name of the driver */
121 int index
; /* Minor dev. to use */
122 char *options
; /* Options for the driver */
123 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
124 char *brl_options
; /* Options for braille driver */
128 #define MAX_CMDLINECONSOLES 8
130 static struct console_cmdline console_cmdline
[MAX_CMDLINECONSOLES
];
131 static int selected_console
= -1;
132 static int preferred_console
= -1;
133 int console_set_on_cmdline
;
134 EXPORT_SYMBOL(console_set_on_cmdline
);
136 /* Flag: console code may call schedule() */
137 static int console_may_schedule
;
141 static char __log_buf
[__LOG_BUF_LEN
];
142 static char *log_buf
= __log_buf
;
143 static int log_buf_len
= __LOG_BUF_LEN
;
144 static unsigned logged_chars
; /* Number of chars produced since last read+clear operation */
145 static int saved_console_loglevel
= -1;
149 * This appends the listed symbols to /proc/vmcoreinfo
151 * /proc/vmcoreinfo is used by various utiilties, like crash and makedumpfile to
152 * obtain access to symbols that are otherwise very difficult to locate. These
153 * symbols are specifically used so that utilities can access and extract the
154 * dmesg log from a vmcore file after a crash.
156 void log_buf_kexec_setup(void)
158 VMCOREINFO_SYMBOL(log_buf
);
159 VMCOREINFO_SYMBOL(log_end
);
160 VMCOREINFO_SYMBOL(log_buf_len
);
161 VMCOREINFO_SYMBOL(logged_chars
);
165 static int __init
log_buf_len_setup(char *str
)
167 unsigned size
= memparse(str
, &str
);
171 size
= roundup_pow_of_two(size
);
172 if (size
> log_buf_len
) {
173 unsigned start
, dest_idx
, offset
;
176 new_log_buf
= alloc_bootmem(size
);
178 printk(KERN_WARNING
"log_buf_len: allocation failed\n");
182 spin_lock_irqsave(&logbuf_lock
, flags
);
184 log_buf
= new_log_buf
;
186 offset
= start
= min(con_start
, log_start
);
188 while (start
!= log_end
) {
189 log_buf
[dest_idx
] = __log_buf
[start
& (__LOG_BUF_LEN
- 1)];
196 spin_unlock_irqrestore(&logbuf_lock
, flags
);
198 printk(KERN_NOTICE
"log_buf_len: %d\n", log_buf_len
);
204 __setup("log_buf_len=", log_buf_len_setup
);
206 #ifdef CONFIG_BOOT_PRINTK_DELAY
208 static int boot_delay
; /* msecs delay after each printk during bootup */
209 static unsigned long long loops_per_msec
; /* based on boot_delay */
211 static int __init
boot_delay_setup(char *str
)
215 lpj
= preset_lpj
? preset_lpj
: 1000000; /* some guess */
216 loops_per_msec
= (unsigned long long)lpj
/ 1000 * HZ
;
218 get_option(&str
, &boot_delay
);
219 if (boot_delay
> 10 * 1000)
222 pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
223 "HZ: %d, loops_per_msec: %llu\n",
224 boot_delay
, preset_lpj
, lpj
, HZ
, loops_per_msec
);
227 __setup("boot_delay=", boot_delay_setup
);
229 static void boot_delay_msec(void)
231 unsigned long long k
;
232 unsigned long timeout
;
234 if (boot_delay
== 0 || system_state
!= SYSTEM_BOOTING
)
237 k
= (unsigned long long)loops_per_msec
* boot_delay
;
239 timeout
= jiffies
+ msecs_to_jiffies(boot_delay
);
244 * use (volatile) jiffies to prevent
245 * compiler reduction; loop termination via jiffies
246 * is secondary and may or may not happen.
248 if (time_after(jiffies
, timeout
))
250 touch_nmi_watchdog();
254 static inline void boot_delay_msec(void)
259 #ifdef CONFIG_SECURITY_DMESG_RESTRICT
260 int dmesg_restrict
= 1;
265 static int syslog_action_restricted(int type
)
269 /* Unless restricted, we allow "read all" and "get buffer size" for everybody */
270 return type
!= SYSLOG_ACTION_READ_ALL
&& type
!= SYSLOG_ACTION_SIZE_BUFFER
;
273 static int check_syslog_permissions(int type
, bool from_file
)
276 * If this is from /proc/kmsg and we've already opened it, then we've
277 * already done the capabilities checks at open time.
279 if (from_file
&& type
!= SYSLOG_ACTION_OPEN
)
282 if (syslog_action_restricted(type
)) {
283 if (capable(CAP_SYSLOG
))
285 /* For historical reasons, accept CAP_SYS_ADMIN too, with a warning */
286 if (capable(CAP_SYS_ADMIN
)) {
287 WARN_ONCE(1, "Attempt to access syslog with CAP_SYS_ADMIN "
288 "but no CAP_SYSLOG (deprecated).\n");
296 int do_syslog(int type
, char __user
*buf
, int len
, bool from_file
)
298 unsigned i
, j
, limit
, count
;
303 error
= check_syslog_permissions(type
, from_file
);
307 error
= security_syslog(type
);
312 case SYSLOG_ACTION_CLOSE
: /* Close log */
314 case SYSLOG_ACTION_OPEN
: /* Open log */
316 case SYSLOG_ACTION_READ
: /* Read from log */
323 if (!access_ok(VERIFY_WRITE
, buf
, len
)) {
327 error
= wait_event_interruptible(log_wait
,
328 (log_start
- log_end
));
332 spin_lock_irq(&logbuf_lock
);
333 while (!error
&& (log_start
!= log_end
) && i
< len
) {
334 c
= LOG_BUF(log_start
);
336 spin_unlock_irq(&logbuf_lock
);
337 error
= __put_user(c
,buf
);
341 spin_lock_irq(&logbuf_lock
);
343 spin_unlock_irq(&logbuf_lock
);
347 /* Read/clear last kernel messages */
348 case SYSLOG_ACTION_READ_CLEAR
:
351 /* Read last kernel messages */
352 case SYSLOG_ACTION_READ_ALL
:
359 if (!access_ok(VERIFY_WRITE
, buf
, len
)) {
364 if (count
> log_buf_len
)
366 spin_lock_irq(&logbuf_lock
);
367 if (count
> logged_chars
)
368 count
= logged_chars
;
373 * __put_user() could sleep, and while we sleep
374 * printk() could overwrite the messages
375 * we try to copy to user space. Therefore
376 * the messages are copied in reverse. <manfreds>
378 for (i
= 0; i
< count
&& !error
; i
++) {
380 if (j
+ log_buf_len
< log_end
)
383 spin_unlock_irq(&logbuf_lock
);
384 error
= __put_user(c
,&buf
[count
-1-i
]);
386 spin_lock_irq(&logbuf_lock
);
388 spin_unlock_irq(&logbuf_lock
);
393 int offset
= count
-error
;
394 /* buffer overflow during copy, correct user buffer. */
395 for (i
= 0; i
< error
; i
++) {
396 if (__get_user(c
,&buf
[i
+offset
]) ||
397 __put_user(c
,&buf
[i
])) {
405 /* Clear ring buffer */
406 case SYSLOG_ACTION_CLEAR
:
409 /* Disable logging to console */
410 case SYSLOG_ACTION_CONSOLE_OFF
:
411 if (saved_console_loglevel
== -1)
412 saved_console_loglevel
= console_loglevel
;
413 console_loglevel
= minimum_console_loglevel
;
415 /* Enable logging to console */
416 case SYSLOG_ACTION_CONSOLE_ON
:
417 if (saved_console_loglevel
!= -1) {
418 console_loglevel
= saved_console_loglevel
;
419 saved_console_loglevel
= -1;
422 /* Set level of messages printed to console */
423 case SYSLOG_ACTION_CONSOLE_LEVEL
:
425 if (len
< 1 || len
> 8)
427 if (len
< minimum_console_loglevel
)
428 len
= minimum_console_loglevel
;
429 console_loglevel
= len
;
430 /* Implicitly re-enable logging to console */
431 saved_console_loglevel
= -1;
434 /* Number of chars in the log buffer */
435 case SYSLOG_ACTION_SIZE_UNREAD
:
436 error
= log_end
- log_start
;
438 /* Size of the log buffer */
439 case SYSLOG_ACTION_SIZE_BUFFER
:
450 SYSCALL_DEFINE3(syslog
, int, type
, char __user
*, buf
, int, len
)
452 return do_syslog(type
, buf
, len
, SYSLOG_FROM_CALL
);
455 #ifdef CONFIG_KGDB_KDB
456 /* kdb dmesg command needs access to the syslog buffer. do_syslog()
457 * uses locks so it cannot be used during debugging. Just tell kdb
458 * where the start and end of the physical and logical logs are. This
459 * is equivalent to do_syslog(3).
461 void kdb_syslog_data(char *syslog_data
[4])
463 syslog_data
[0] = log_buf
;
464 syslog_data
[1] = log_buf
+ log_buf_len
;
465 syslog_data
[2] = log_buf
+ log_end
-
466 (logged_chars
< log_buf_len
? logged_chars
: log_buf_len
);
467 syslog_data
[3] = log_buf
+ log_end
;
469 #endif /* CONFIG_KGDB_KDB */
472 * Call the console drivers on a range of log_buf
474 static void __call_console_drivers(unsigned start
, unsigned end
)
478 for_each_console(con
) {
479 if ((con
->flags
& CON_ENABLED
) && con
->write
&&
480 (cpu_online(smp_processor_id()) ||
481 (con
->flags
& CON_ANYTIME
)))
482 con
->write(con
, &LOG_BUF(start
), end
- start
);
486 static int __read_mostly ignore_loglevel
;
488 static int __init
ignore_loglevel_setup(char *str
)
491 printk(KERN_INFO
"debug: ignoring loglevel setting.\n");
496 early_param("ignore_loglevel", ignore_loglevel_setup
);
499 * Write out chars from start to end - 1 inclusive
501 static void _call_console_drivers(unsigned start
,
502 unsigned end
, int msg_log_level
)
504 if ((msg_log_level
< console_loglevel
|| ignore_loglevel
) &&
505 console_drivers
&& start
!= end
) {
506 if ((start
& LOG_BUF_MASK
) > (end
& LOG_BUF_MASK
)) {
508 __call_console_drivers(start
& LOG_BUF_MASK
,
510 __call_console_drivers(0, end
& LOG_BUF_MASK
);
512 __call_console_drivers(start
, end
);
518 * Call the console drivers, asking them to write out
519 * log_buf[start] to log_buf[end - 1].
520 * The console_lock must be held.
522 static void call_console_drivers(unsigned start
, unsigned end
)
524 unsigned cur_index
, start_print
;
525 static int msg_level
= -1;
527 BUG_ON(((int)(start
- end
)) > 0);
531 while (cur_index
!= end
) {
532 if (msg_level
< 0 && ((end
- cur_index
) > 2) &&
533 LOG_BUF(cur_index
+ 0) == '<' &&
534 LOG_BUF(cur_index
+ 1) >= '0' &&
535 LOG_BUF(cur_index
+ 1) <= '7' &&
536 LOG_BUF(cur_index
+ 2) == '>') {
537 msg_level
= LOG_BUF(cur_index
+ 1) - '0';
539 start_print
= cur_index
;
541 while (cur_index
!= end
) {
542 char c
= LOG_BUF(cur_index
);
548 * printk() has already given us loglevel tags in
549 * the buffer. This code is here in case the
550 * log buffer has wrapped right round and scribbled
553 msg_level
= default_message_loglevel
;
555 _call_console_drivers(start_print
, cur_index
, msg_level
);
557 start_print
= cur_index
;
562 _call_console_drivers(start_print
, end
, msg_level
);
565 static void emit_log_char(char c
)
567 LOG_BUF(log_end
) = c
;
569 if (log_end
- log_start
> log_buf_len
)
570 log_start
= log_end
- log_buf_len
;
571 if (log_end
- con_start
> log_buf_len
)
572 con_start
= log_end
- log_buf_len
;
573 if (logged_chars
< log_buf_len
)
578 * Zap console related locks when oopsing. Only zap at most once
579 * every 10 seconds, to leave time for slow consoles to print a
582 static void zap_locks(void)
584 static unsigned long oops_timestamp
;
586 if (time_after_eq(jiffies
, oops_timestamp
) &&
587 !time_after(jiffies
, oops_timestamp
+ 30 * HZ
))
590 oops_timestamp
= jiffies
;
592 /* If a crash is occurring, make sure we can't deadlock */
593 spin_lock_init(&logbuf_lock
);
594 /* And make sure that we print immediately */
595 sema_init(&console_sem
, 1);
598 #if defined(CONFIG_PRINTK_TIME)
599 static int printk_time
= 1;
601 static int printk_time
= 0;
603 module_param_named(time
, printk_time
, bool, S_IRUGO
| S_IWUSR
);
605 /* Check if we have any console registered that can be called early in boot. */
606 static int have_callable_console(void)
610 for_each_console(con
)
611 if (con
->flags
& CON_ANYTIME
)
618 * printk - print a kernel message
619 * @fmt: format string
621 * This is printk(). It can be called from any context. We want it to work.
623 * We try to grab the console_lock. If we succeed, it's easy - we log the output and
624 * call the console drivers. If we fail to get the semaphore we place the output
625 * into the log buffer and return. The current holder of the console_sem will
626 * notice the new output in console_unlock(); and will send it to the
627 * consoles before releasing the lock.
629 * One effect of this deferred printing is that code which calls printk() and
630 * then changes console_loglevel may break. This is because console_loglevel
631 * is inspected when the actual printing occurs.
636 * See the vsnprintf() documentation for format string extensions over C99.
639 asmlinkage
int printk(const char *fmt
, ...)
644 #ifdef CONFIG_KGDB_KDB
645 if (unlikely(kdb_trap_printk
)) {
647 r
= vkdb_printf(fmt
, args
);
653 r
= vprintk(fmt
, args
);
659 /* cpu currently holding logbuf_lock */
660 static volatile unsigned int printk_cpu
= UINT_MAX
;
663 * Can we actually use the console at this time on this cpu?
665 * Console drivers may assume that per-cpu resources have
666 * been allocated. So unless they're explicitly marked as
667 * being able to cope (CON_ANYTIME) don't call them until
668 * this CPU is officially up.
670 static inline int can_use_console(unsigned int cpu
)
672 return cpu_online(cpu
) || have_callable_console();
676 * Try to get console ownership to actually show the kernel
677 * messages from a 'printk'. Return true (and with the
678 * console_lock held, and 'console_locked' set) if it
679 * is successful, false otherwise.
681 * This gets called with the 'logbuf_lock' spinlock held and
682 * interrupts disabled. It should return with 'lockbuf_lock'
683 * released but interrupts still disabled.
685 static int console_trylock_for_printk(unsigned int cpu
)
686 __releases(&logbuf_lock
)
690 if (console_trylock()) {
694 * If we can't use the console, we need to release
695 * the console semaphore by hand to avoid flushing
696 * the buffer. We need to hold the console semaphore
697 * in order to do this test safely.
699 if (!can_use_console(cpu
)) {
705 printk_cpu
= UINT_MAX
;
706 spin_unlock(&logbuf_lock
);
709 static const char recursion_bug_msg
[] =
710 KERN_CRIT
"BUG: recent printk recursion!\n";
711 static int recursion_bug
;
712 static int new_text_line
= 1;
713 static char printk_buf
[1024];
715 int printk_delay_msec __read_mostly
;
717 static inline void printk_delay(void)
719 if (unlikely(printk_delay_msec
)) {
720 int m
= printk_delay_msec
;
724 touch_nmi_watchdog();
729 asmlinkage
int vprintk(const char *fmt
, va_list args
)
732 int current_log_level
= default_message_loglevel
;
741 /* This stops the holder of console_sem just where we want him */
742 raw_local_irq_save(flags
);
743 this_cpu
= smp_processor_id();
746 * Ouch, printk recursed into itself!
748 if (unlikely(printk_cpu
== this_cpu
)) {
750 * If a crash is occurring during printk() on this CPU,
751 * then try to get the crash message out but make sure
752 * we can't deadlock. Otherwise just return to avoid the
753 * recursion and return - but flag the recursion so that
754 * it can be printed at the next appropriate moment:
756 if (!oops_in_progress
) {
758 goto out_restore_irqs
;
764 spin_lock(&logbuf_lock
);
765 printk_cpu
= this_cpu
;
769 strcpy(printk_buf
, recursion_bug_msg
);
770 printed_len
= strlen(recursion_bug_msg
);
772 /* Emit the output into the temporary buffer */
773 printed_len
+= vscnprintf(printk_buf
+ printed_len
,
774 sizeof(printk_buf
) - printed_len
, fmt
, args
);
779 /* Do we have a loglevel in the string? */
781 unsigned char c
= p
[1];
782 if (c
&& p
[2] == '>') {
784 case '0' ... '7': /* loglevel */
785 current_log_level
= c
- '0';
786 /* Fallthrough - make sure we're on a new line */
787 case 'd': /* KERN_DEFAULT */
788 if (!new_text_line
) {
792 /* Fallthrough - skip the loglevel */
793 case 'c': /* KERN_CONT */
801 * Copy the output into log_buf. If the caller didn't provide
802 * appropriate log level tags, we insert them here
806 /* Always output the token */
808 emit_log_char(current_log_level
+ '0');
814 /* Follow the token with the time */
817 unsigned long long t
;
818 unsigned long nanosec_rem
;
820 t
= cpu_clock(printk_cpu
);
821 nanosec_rem
= do_div(t
, 1000000000);
822 tlen
= sprintf(tbuf
, "[%5lu.%06lu] ",
826 for (tp
= tbuf
; tp
< tbuf
+ tlen
; tp
++)
841 * Try to acquire and then immediately release the
842 * console semaphore. The release will do all the
843 * actual magic (print out buffers, wake up klogd,
846 * The console_trylock_for_printk() function
847 * will release 'logbuf_lock' regardless of whether it
848 * actually gets the semaphore or not.
850 if (console_trylock_for_printk(this_cpu
))
855 raw_local_irq_restore(flags
);
860 EXPORT_SYMBOL(printk
);
861 EXPORT_SYMBOL(vprintk
);
865 static void call_console_drivers(unsigned start
, unsigned end
)
871 static int __add_preferred_console(char *name
, int idx
, char *options
,
874 struct console_cmdline
*c
;
878 * See if this tty is not yet registered, and
879 * if we have a slot free.
881 for (i
= 0; i
< MAX_CMDLINECONSOLES
&& console_cmdline
[i
].name
[0]; i
++)
882 if (strcmp(console_cmdline
[i
].name
, name
) == 0 &&
883 console_cmdline
[i
].index
== idx
) {
885 selected_console
= i
;
888 if (i
== MAX_CMDLINECONSOLES
)
891 selected_console
= i
;
892 c
= &console_cmdline
[i
];
893 strlcpy(c
->name
, name
, sizeof(c
->name
));
894 c
->options
= options
;
895 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
896 c
->brl_options
= brl_options
;
902 * Set up a list of consoles. Called from init/main.c
904 static int __init
console_setup(char *str
)
906 char buf
[sizeof(console_cmdline
[0].name
) + 4]; /* 4 for index */
907 char *s
, *options
, *brl_options
= NULL
;
910 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
911 if (!memcmp(str
, "brl,", 4)) {
914 } else if (!memcmp(str
, "brl=", 4)) {
915 brl_options
= str
+ 4;
916 str
= strchr(brl_options
, ',');
918 printk(KERN_ERR
"need port name after brl=\n");
926 * Decode str into name, index, options.
928 if (str
[0] >= '0' && str
[0] <= '9') {
930 strncpy(buf
+ 4, str
, sizeof(buf
) - 5);
932 strncpy(buf
, str
, sizeof(buf
) - 1);
934 buf
[sizeof(buf
) - 1] = 0;
935 if ((options
= strchr(str
, ',')) != NULL
)
938 if (!strcmp(str
, "ttya"))
939 strcpy(buf
, "ttyS0");
940 if (!strcmp(str
, "ttyb"))
941 strcpy(buf
, "ttyS1");
943 for (s
= buf
; *s
; s
++)
944 if ((*s
>= '0' && *s
<= '9') || *s
== ',')
946 idx
= simple_strtoul(s
, NULL
, 10);
949 __add_preferred_console(buf
, idx
, options
, brl_options
);
950 console_set_on_cmdline
= 1;
953 __setup("console=", console_setup
);
956 * add_preferred_console - add a device to the list of preferred consoles.
959 * @options: options for this console
961 * The last preferred console added will be used for kernel messages
962 * and stdin/out/err for init. Normally this is used by console_setup
963 * above to handle user-supplied console arguments; however it can also
964 * be used by arch-specific code either to override the user or more
965 * commonly to provide a default console (ie from PROM variables) when
966 * the user has not supplied one.
968 int add_preferred_console(char *name
, int idx
, char *options
)
970 return __add_preferred_console(name
, idx
, options
, NULL
);
973 int update_console_cmdline(char *name
, int idx
, char *name_new
, int idx_new
, char *options
)
975 struct console_cmdline
*c
;
978 for (i
= 0; i
< MAX_CMDLINECONSOLES
&& console_cmdline
[i
].name
[0]; i
++)
979 if (strcmp(console_cmdline
[i
].name
, name
) == 0 &&
980 console_cmdline
[i
].index
== idx
) {
981 c
= &console_cmdline
[i
];
982 strlcpy(c
->name
, name_new
, sizeof(c
->name
));
983 c
->name
[sizeof(c
->name
) - 1] = 0;
984 c
->options
= options
;
992 int console_suspend_enabled
= 1;
993 EXPORT_SYMBOL(console_suspend_enabled
);
995 static int __init
console_suspend_disable(char *str
)
997 console_suspend_enabled
= 0;
1000 __setup("no_console_suspend", console_suspend_disable
);
1003 * suspend_console - suspend the console subsystem
1005 * This disables printk() while we go into suspend states
1007 void suspend_console(void)
1009 if (!console_suspend_enabled
)
1011 printk("Suspending console(s) (use no_console_suspend to debug)\n");
1013 console_suspended
= 1;
1017 void resume_console(void)
1019 if (!console_suspend_enabled
)
1022 console_suspended
= 0;
1027 * console_cpu_notify - print deferred console messages after CPU hotplug
1028 * @self: notifier struct
1029 * @action: CPU hotplug event
1032 * If printk() is called from a CPU that is not online yet, the messages
1033 * will be spooled but will not show up on the console. This function is
1034 * called when a new CPU comes online (or fails to come up), and ensures
1035 * that any such output gets printed.
1037 static int __cpuinit
console_cpu_notify(struct notifier_block
*self
,
1038 unsigned long action
, void *hcpu
)
1044 case CPU_DOWN_FAILED
:
1045 case CPU_UP_CANCELED
:
1053 * console_lock - lock the console system for exclusive use.
1055 * Acquires a lock which guarantees that the caller has
1056 * exclusive access to the console system and the console_drivers list.
1058 * Can sleep, returns nothing.
1060 void console_lock(void)
1062 BUG_ON(in_interrupt());
1064 if (console_suspended
)
1067 console_may_schedule
= 1;
1069 EXPORT_SYMBOL(console_lock
);
1072 * console_trylock - try to lock the console system for exclusive use.
1074 * Tried to acquire a lock which guarantees that the caller has
1075 * exclusive access to the console system and the console_drivers list.
1077 * returns 1 on success, and 0 on failure to acquire the lock.
1079 int console_trylock(void)
1081 if (down_trylock(&console_sem
))
1083 if (console_suspended
) {
1088 console_may_schedule
= 0;
1091 EXPORT_SYMBOL(console_trylock
);
1093 int is_console_locked(void)
1095 return console_locked
;
1098 static DEFINE_PER_CPU(int, printk_pending
);
1100 void printk_tick(void)
1102 if (__this_cpu_read(printk_pending
)) {
1103 __this_cpu_write(printk_pending
, 0);
1104 wake_up_interruptible(&log_wait
);
1108 int printk_needs_cpu(int cpu
)
1110 if (cpu_is_offline(cpu
))
1112 return __this_cpu_read(printk_pending
);
1115 void wake_up_klogd(void)
1117 if (waitqueue_active(&log_wait
))
1118 this_cpu_write(printk_pending
, 1);
1122 * console_unlock - unlock the console system
1124 * Releases the console_lock which the caller holds on the console system
1125 * and the console driver list.
1127 * While the console_lock was held, console output may have been buffered
1128 * by printk(). If this is the case, console_unlock(); emits
1129 * the output prior to releasing the lock.
1131 * If there is output waiting for klogd, we wake it up.
1133 * console_unlock(); may be called from any context.
1135 void console_unlock(void)
1137 unsigned long flags
;
1138 unsigned _con_start
, _log_end
;
1139 unsigned wake_klogd
= 0;
1141 if (console_suspended
) {
1146 console_may_schedule
= 0;
1149 spin_lock_irqsave(&logbuf_lock
, flags
);
1150 wake_klogd
|= log_start
- log_end
;
1151 if (con_start
== log_end
)
1152 break; /* Nothing to print */
1153 _con_start
= con_start
;
1155 con_start
= log_end
; /* Flush */
1156 spin_unlock(&logbuf_lock
);
1157 stop_critical_timings(); /* don't trace print latency */
1158 call_console_drivers(_con_start
, _log_end
);
1159 start_critical_timings();
1160 local_irq_restore(flags
);
1164 spin_unlock_irqrestore(&logbuf_lock
, flags
);
1168 EXPORT_SYMBOL(console_unlock
);
1171 * console_conditional_schedule - yield the CPU if required
1173 * If the console code is currently allowed to sleep, and
1174 * if this CPU should yield the CPU to another task, do
1177 * Must be called within console_lock();.
1179 void __sched
console_conditional_schedule(void)
1181 if (console_may_schedule
)
1184 EXPORT_SYMBOL(console_conditional_schedule
);
1186 void console_unblank(void)
1191 * console_unblank can no longer be called in interrupt context unless
1192 * oops_in_progress is set to 1..
1194 if (oops_in_progress
) {
1195 if (down_trylock(&console_sem
) != 0)
1201 console_may_schedule
= 0;
1203 if ((c
->flags
& CON_ENABLED
) && c
->unblank
)
1209 * Return the console tty driver structure and its associated index
1211 struct tty_driver
*console_device(int *index
)
1214 struct tty_driver
*driver
= NULL
;
1217 for_each_console(c
) {
1220 driver
= c
->device(c
, index
);
1229 * Prevent further output on the passed console device so that (for example)
1230 * serial drivers can disable console output before suspending a port, and can
1231 * re-enable output afterwards.
1233 void console_stop(struct console
*console
)
1236 console
->flags
&= ~CON_ENABLED
;
1239 EXPORT_SYMBOL(console_stop
);
1241 void console_start(struct console
*console
)
1244 console
->flags
|= CON_ENABLED
;
1247 EXPORT_SYMBOL(console_start
);
1250 * The console driver calls this routine during kernel initialization
1251 * to register the console printing procedure with printk() and to
1252 * print any messages that were printed by the kernel before the
1253 * console driver was initialized.
1255 * This can happen pretty early during the boot process (because of
1256 * early_printk) - sometimes before setup_arch() completes - be careful
1257 * of what kernel features are used - they may not be initialised yet.
1259 * There are two types of consoles - bootconsoles (early_printk) and
1260 * "real" consoles (everything which is not a bootconsole) which are
1261 * handled differently.
1262 * - Any number of bootconsoles can be registered at any time.
1263 * - As soon as a "real" console is registered, all bootconsoles
1264 * will be unregistered automatically.
1265 * - Once a "real" console is registered, any attempt to register a
1266 * bootconsoles will be rejected
1268 void register_console(struct console
*newcon
)
1271 unsigned long flags
;
1272 struct console
*bcon
= NULL
;
1275 * before we register a new CON_BOOT console, make sure we don't
1276 * already have a valid console
1278 if (console_drivers
&& newcon
->flags
& CON_BOOT
) {
1279 /* find the last or real console */
1280 for_each_console(bcon
) {
1281 if (!(bcon
->flags
& CON_BOOT
)) {
1282 printk(KERN_INFO
"Too late to register bootconsole %s%d\n",
1283 newcon
->name
, newcon
->index
);
1289 if (console_drivers
&& console_drivers
->flags
& CON_BOOT
)
1290 bcon
= console_drivers
;
1292 if (preferred_console
< 0 || bcon
|| !console_drivers
)
1293 preferred_console
= selected_console
;
1295 if (newcon
->early_setup
)
1296 newcon
->early_setup();
1299 * See if we want to use this console driver. If we
1300 * didn't select a console we take the first one
1301 * that registers here.
1303 if (preferred_console
< 0) {
1304 if (newcon
->index
< 0)
1306 if (newcon
->setup
== NULL
||
1307 newcon
->setup(newcon
, NULL
) == 0) {
1308 newcon
->flags
|= CON_ENABLED
;
1309 if (newcon
->device
) {
1310 newcon
->flags
|= CON_CONSDEV
;
1311 preferred_console
= 0;
1317 * See if this console matches one we selected on
1320 for (i
= 0; i
< MAX_CMDLINECONSOLES
&& console_cmdline
[i
].name
[0];
1322 if (strcmp(console_cmdline
[i
].name
, newcon
->name
) != 0)
1324 if (newcon
->index
>= 0 &&
1325 newcon
->index
!= console_cmdline
[i
].index
)
1327 if (newcon
->index
< 0)
1328 newcon
->index
= console_cmdline
[i
].index
;
1329 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1330 if (console_cmdline
[i
].brl_options
) {
1331 newcon
->flags
|= CON_BRL
;
1332 braille_register_console(newcon
,
1333 console_cmdline
[i
].index
,
1334 console_cmdline
[i
].options
,
1335 console_cmdline
[i
].brl_options
);
1339 if (newcon
->setup
&&
1340 newcon
->setup(newcon
, console_cmdline
[i
].options
) != 0)
1342 newcon
->flags
|= CON_ENABLED
;
1343 newcon
->index
= console_cmdline
[i
].index
;
1344 if (i
== selected_console
) {
1345 newcon
->flags
|= CON_CONSDEV
;
1346 preferred_console
= selected_console
;
1351 if (!(newcon
->flags
& CON_ENABLED
))
1355 * If we have a bootconsole, and are switching to a real console,
1356 * don't print everything out again, since when the boot console, and
1357 * the real console are the same physical device, it's annoying to
1358 * see the beginning boot messages twice
1360 if (bcon
&& ((newcon
->flags
& (CON_CONSDEV
| CON_BOOT
)) == CON_CONSDEV
))
1361 newcon
->flags
&= ~CON_PRINTBUFFER
;
1364 * Put this console in the list - keep the
1365 * preferred driver at the head of the list.
1368 if ((newcon
->flags
& CON_CONSDEV
) || console_drivers
== NULL
) {
1369 newcon
->next
= console_drivers
;
1370 console_drivers
= newcon
;
1372 newcon
->next
->flags
&= ~CON_CONSDEV
;
1374 newcon
->next
= console_drivers
->next
;
1375 console_drivers
->next
= newcon
;
1377 if (newcon
->flags
& CON_PRINTBUFFER
) {
1379 * console_unlock(); will print out the buffered messages
1382 spin_lock_irqsave(&logbuf_lock
, flags
);
1383 con_start
= log_start
;
1384 spin_unlock_irqrestore(&logbuf_lock
, flags
);
1387 console_sysfs_notify();
1390 * By unregistering the bootconsoles after we enable the real console
1391 * we get the "console xxx enabled" message on all the consoles -
1392 * boot consoles, real consoles, etc - this is to ensure that end
1393 * users know there might be something in the kernel's log buffer that
1394 * went to the bootconsole (that they do not see on the real console)
1396 if (bcon
&& ((newcon
->flags
& (CON_CONSDEV
| CON_BOOT
)) == CON_CONSDEV
)) {
1397 /* we need to iterate through twice, to make sure we print
1398 * everything out, before we unregister the console(s)
1400 printk(KERN_INFO
"console [%s%d] enabled, bootconsole disabled\n",
1401 newcon
->name
, newcon
->index
);
1402 for_each_console(bcon
)
1403 if (bcon
->flags
& CON_BOOT
)
1404 unregister_console(bcon
);
1406 printk(KERN_INFO
"%sconsole [%s%d] enabled\n",
1407 (newcon
->flags
& CON_BOOT
) ? "boot" : "" ,
1408 newcon
->name
, newcon
->index
);
1411 EXPORT_SYMBOL(register_console
);
1413 int unregister_console(struct console
*console
)
1415 struct console
*a
, *b
;
1418 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1419 if (console
->flags
& CON_BRL
)
1420 return braille_unregister_console(console
);
1424 if (console_drivers
== console
) {
1425 console_drivers
=console
->next
;
1427 } else if (console_drivers
) {
1428 for (a
=console_drivers
->next
, b
=console_drivers
;
1429 a
; b
=a
, a
=b
->next
) {
1439 * If this isn't the last console and it has CON_CONSDEV set, we
1440 * need to set it on the next preferred console.
1442 if (console_drivers
!= NULL
&& console
->flags
& CON_CONSDEV
)
1443 console_drivers
->flags
|= CON_CONSDEV
;
1446 console_sysfs_notify();
1449 EXPORT_SYMBOL(unregister_console
);
1451 static int __init
printk_late_init(void)
1453 struct console
*con
;
1455 for_each_console(con
) {
1456 if (con
->flags
& CON_BOOT
) {
1457 printk(KERN_INFO
"turn off boot console %s%d\n",
1458 con
->name
, con
->index
);
1459 unregister_console(con
);
1462 hotcpu_notifier(console_cpu_notify
, 0);
1465 late_initcall(printk_late_init
);
1467 #if defined CONFIG_PRINTK
1470 * printk rate limiting, lifted from the networking subsystem.
1472 * This enforces a rate limit: not more than 10 kernel messages
1473 * every 5s to make a denial-of-service attack impossible.
1475 DEFINE_RATELIMIT_STATE(printk_ratelimit_state
, 5 * HZ
, 10);
1477 int __printk_ratelimit(const char *func
)
1479 return ___ratelimit(&printk_ratelimit_state
, func
);
1481 EXPORT_SYMBOL(__printk_ratelimit
);
1484 * printk_timed_ratelimit - caller-controlled printk ratelimiting
1485 * @caller_jiffies: pointer to caller's state
1486 * @interval_msecs: minimum interval between prints
1488 * printk_timed_ratelimit() returns true if more than @interval_msecs
1489 * milliseconds have elapsed since the last time printk_timed_ratelimit()
1492 bool printk_timed_ratelimit(unsigned long *caller_jiffies
,
1493 unsigned int interval_msecs
)
1495 if (*caller_jiffies
== 0
1496 || !time_in_range(jiffies
, *caller_jiffies
,
1498 + msecs_to_jiffies(interval_msecs
))) {
1499 *caller_jiffies
= jiffies
;
1504 EXPORT_SYMBOL(printk_timed_ratelimit
);
1506 static DEFINE_SPINLOCK(dump_list_lock
);
1507 static LIST_HEAD(dump_list
);
1510 * kmsg_dump_register - register a kernel log dumper.
1511 * @dumper: pointer to the kmsg_dumper structure
1513 * Adds a kernel log dumper to the system. The dump callback in the
1514 * structure will be called when the kernel oopses or panics and must be
1515 * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
1517 int kmsg_dump_register(struct kmsg_dumper
*dumper
)
1519 unsigned long flags
;
1522 /* The dump callback needs to be set */
1526 spin_lock_irqsave(&dump_list_lock
, flags
);
1527 /* Don't allow registering multiple times */
1528 if (!dumper
->registered
) {
1529 dumper
->registered
= 1;
1530 list_add_tail_rcu(&dumper
->list
, &dump_list
);
1533 spin_unlock_irqrestore(&dump_list_lock
, flags
);
1537 EXPORT_SYMBOL_GPL(kmsg_dump_register
);
1540 * kmsg_dump_unregister - unregister a kmsg dumper.
1541 * @dumper: pointer to the kmsg_dumper structure
1543 * Removes a dump device from the system. Returns zero on success and
1544 * %-EINVAL otherwise.
1546 int kmsg_dump_unregister(struct kmsg_dumper
*dumper
)
1548 unsigned long flags
;
1551 spin_lock_irqsave(&dump_list_lock
, flags
);
1552 if (dumper
->registered
) {
1553 dumper
->registered
= 0;
1554 list_del_rcu(&dumper
->list
);
1557 spin_unlock_irqrestore(&dump_list_lock
, flags
);
1562 EXPORT_SYMBOL_GPL(kmsg_dump_unregister
);
1565 * kmsg_dump - dump kernel log to kernel message dumpers.
1566 * @reason: the reason (oops, panic etc) for dumping
1568 * Iterate through each of the dump devices and call the oops/panic
1569 * callbacks with the log buffer.
1571 void kmsg_dump(enum kmsg_dump_reason reason
)
1575 struct kmsg_dumper
*dumper
;
1576 const char *s1
, *s2
;
1577 unsigned long l1
, l2
;
1578 unsigned long flags
;
1580 /* Theoretically, the log could move on after we do this, but
1581 there's not a lot we can do about that. The new messages
1582 will overwrite the start of what we dump. */
1583 spin_lock_irqsave(&logbuf_lock
, flags
);
1584 end
= log_end
& LOG_BUF_MASK
;
1585 chars
= logged_chars
;
1586 spin_unlock_irqrestore(&logbuf_lock
, flags
);
1589 s1
= log_buf
+ log_buf_len
- chars
+ end
;
1598 s2
= log_buf
+ end
- chars
;
1603 list_for_each_entry_rcu(dumper
, &dump_list
, list
)
1604 dumper
->dump(dumper
, reason
, s1
, l1
, s2
, l2
);