irq_work.h: fix warning when CONFIG_IRQ_WORK=n
[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>
162a7e75 34#include <linux/memblock.h>
1da177e4 35#include <linux/syscalls.h>
04d491ab 36#include <linux/kexec.h>
d37d39ae 37#include <linux/kdb.h>
3fff4c42 38#include <linux/ratelimit.h>
456b565c 39#include <linux/kmsg_dump.h>
00234592 40#include <linux/syslog.h>
034260d6
KC
41#include <linux/cpu.h>
42#include <linux/notifier.h>
fb842b00 43#include <linux/rculist.h>
e11fea92 44#include <linux/poll.h>
74876a98 45#include <linux/irq_work.h>
1da177e4
LT
46
47#include <asm/uaccess.h>
48
95100358
JB
49#define CREATE_TRACE_POINTS
50#include <trace/events/printk.h>
51
076f9776
IM
52/*
53 * Architectures can override it:
54 */
e17ba73b 55void asmlinkage __attribute__((weak)) early_printk(const char *fmt, ...)
076f9776
IM
56{
57}
58
1da177e4 59/* printk's without a loglevel use this.. */
5af5bcb8 60#define DEFAULT_MESSAGE_LOGLEVEL CONFIG_DEFAULT_MESSAGE_LOGLEVEL
1da177e4
LT
61
62/* We show everything that is MORE important than this.. */
63#define MINIMUM_CONSOLE_LOGLEVEL 1 /* Minimum loglevel we let people use */
64#define DEFAULT_CONSOLE_LOGLEVEL 7 /* anything MORE serious than KERN_DEBUG */
65
66DECLARE_WAIT_QUEUE_HEAD(log_wait);
67
68int console_printk[4] = {
69 DEFAULT_CONSOLE_LOGLEVEL, /* console_loglevel */
70 DEFAULT_MESSAGE_LOGLEVEL, /* default_message_loglevel */
71 MINIMUM_CONSOLE_LOGLEVEL, /* minimum_console_loglevel */
72 DEFAULT_CONSOLE_LOGLEVEL, /* default_console_loglevel */
73};
74
1da177e4 75/*
0bbfb7c2 76 * Low level drivers may need that to know if they can schedule in
1da177e4
LT
77 * their unblank() callback or not. So let's export it.
78 */
79int oops_in_progress;
80EXPORT_SYMBOL(oops_in_progress);
81
82/*
83 * console_sem protects the console_drivers list, and also
84 * provides serialisation for access to the entire console
85 * driver system.
86 */
5b8c4f23 87static DEFINE_SEMAPHORE(console_sem);
1da177e4 88struct console *console_drivers;
a29d1cfe
IM
89EXPORT_SYMBOL_GPL(console_drivers);
90
daee7797
DV
91#ifdef CONFIG_LOCKDEP
92static struct lockdep_map console_lock_dep_map = {
93 .name = "console_lock"
94};
95#endif
96
1da177e4
LT
97/*
98 * This is used for debugging the mess that is the VT code by
99 * keeping track if we have the console semaphore held. It's
100 * definitely not the perfect debug tool (we don't know if _WE_
101 * hold it are racing, but it helps tracking those weird code
102 * path in the console code where we end up in places I want
103 * locked without the console sempahore held
104 */
557240b4 105static int console_locked, console_suspended;
1da177e4 106
fe3d8ad3
FT
107/*
108 * If exclusive_console is non-NULL then only this console is to be printed to.
109 */
110static struct console *exclusive_console;
111
1da177e4
LT
112/*
113 * Array of consoles built from command line options (console=)
114 */
115struct console_cmdline
116{
117 char name[8]; /* Name of the driver */
118 int index; /* Minor dev. to use */
119 char *options; /* Options for the driver */
f7511d5f
ST
120#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
121 char *brl_options; /* Options for braille driver */
122#endif
1da177e4
LT
123};
124
125#define MAX_CMDLINECONSOLES 8
126
127static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
128static int selected_console = -1;
129static int preferred_console = -1;
9e124fe1
MA
130int console_set_on_cmdline;
131EXPORT_SYMBOL(console_set_on_cmdline);
1da177e4
LT
132
133/* Flag: console code may call schedule() */
134static int console_may_schedule;
135
7ff9554b
KS
136/*
137 * The printk log buffer consists of a chain of concatenated variable
138 * length records. Every record starts with a record header, containing
139 * the overall length of the record.
140 *
141 * The heads to the first and last entry in the buffer, as well as the
142 * sequence numbers of these both entries are maintained when messages
143 * are stored..
144 *
145 * If the heads indicate available messages, the length in the header
146 * tells the start next message. A length == 0 for the next message
147 * indicates a wrap-around to the beginning of the buffer.
148 *
149 * Every record carries the monotonic timestamp in microseconds, as well as
150 * the standard userspace syslog level and syslog facility. The usual
151 * kernel messages use LOG_KERN; userspace-injected messages always carry
152 * a matching syslog facility, by default LOG_USER. The origin of every
153 * message can be reliably determined that way.
154 *
155 * The human readable log message directly follows the message header. The
156 * length of the message text is stored in the header, the stored message
157 * is not terminated.
158 *
e11fea92
KS
159 * Optionally, a message can carry a dictionary of properties (key/value pairs),
160 * to provide userspace with a machine-readable message context.
161 *
162 * Examples for well-defined, commonly used property names are:
163 * DEVICE=b12:8 device identifier
164 * b12:8 block dev_t
165 * c127:3 char dev_t
166 * n8 netdev ifindex
167 * +sound:card0 subsystem:devname
168 * SUBSYSTEM=pci driver-core subsystem name
169 *
170 * Valid characters in property names are [a-zA-Z0-9.-_]. The plain text value
171 * follows directly after a '=' character. Every property is terminated by
172 * a '\0' character. The last property is not terminated.
173 *
174 * Example of a message structure:
175 * 0000 ff 8f 00 00 00 00 00 00 monotonic time in nsec
176 * 0008 34 00 record is 52 bytes long
177 * 000a 0b 00 text is 11 bytes long
178 * 000c 1f 00 dictionary is 23 bytes long
179 * 000e 03 00 LOG_KERN (facility) LOG_ERR (level)
180 * 0010 69 74 27 73 20 61 20 6c "it's a l"
181 * 69 6e 65 "ine"
182 * 001b 44 45 56 49 43 "DEVIC"
183 * 45 3d 62 38 3a 32 00 44 "E=b8:2\0D"
184 * 52 49 56 45 52 3d 62 75 "RIVER=bu"
185 * 67 "g"
186 * 0032 00 00 00 padding to next message header
187 *
188 * The 'struct log' buffer header must never be directly exported to
189 * userspace, it is a kernel-private implementation detail that might
190 * need to be changed in the future, when the requirements change.
191 *
192 * /dev/kmsg exports the structured data in the following line format:
193 * "level,sequnum,timestamp;<message text>\n"
194 *
195 * The optional key/value pairs are attached as continuation lines starting
196 * with a space character and terminated by a newline. All possible
197 * non-prinatable characters are escaped in the "\xff" notation.
198 *
199 * Users of the export format should ignore possible additional values
200 * separated by ',', and find the message after the ';' character.
7ff9554b
KS
201 */
202
084681d1 203enum log_flags {
5becfb1d
KS
204 LOG_NOCONS = 1, /* already flushed, do not print to console */
205 LOG_NEWLINE = 2, /* text ended with a newline */
206 LOG_PREFIX = 4, /* text started with a prefix */
207 LOG_CONT = 8, /* text is a fragment of a continuation line */
084681d1
KS
208};
209
7ff9554b
KS
210struct log {
211 u64 ts_nsec; /* timestamp in nanoseconds */
212 u16 len; /* length of entire record */
213 u16 text_len; /* length of text buffer */
214 u16 dict_len; /* length of dictionary buffer */
084681d1
KS
215 u8 facility; /* syslog facility */
216 u8 flags:5; /* internal record flags */
217 u8 level:3; /* syslog level */
7ff9554b
KS
218};
219
220/*
221 * The logbuf_lock protects kmsg buffer, indices, counters. It is also
222 * used in interesting ways to provide interlocking in console_unlock();
223 */
224static DEFINE_RAW_SPINLOCK(logbuf_lock);
d59745ce 225
96efedf1 226#ifdef CONFIG_PRINTK
7f3a781d
KS
227/* the next printk record to read by syslog(READ) or /proc/kmsg */
228static u64 syslog_seq;
229static u32 syslog_idx;
5becfb1d 230static enum log_flags syslog_prev;
eb02dac9 231static size_t syslog_partial;
7ff9554b
KS
232
233/* index and sequence number of the first record stored in the buffer */
234static u64 log_first_seq;
235static u32 log_first_idx;
236
237/* index and sequence number of the next record to store in the buffer */
238static u64 log_next_seq;
239static u32 log_next_idx;
240
eab07260
KS
241/* the next printk record to write to the console */
242static u64 console_seq;
243static u32 console_idx;
244static enum log_flags console_prev;
245
7ff9554b
KS
246/* the next printk record to read after the last 'clear' command */
247static u64 clear_seq;
248static u32 clear_idx;
249
70498253
KS
250#define PREFIX_MAX 32
251#define LOG_LINE_MAX 1024 - PREFIX_MAX
7f3a781d
KS
252
253/* record buffer */
6ebb017d 254#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
f8450fca
SW
255#define LOG_ALIGN 4
256#else
6ebb017d 257#define LOG_ALIGN __alignof__(struct log)
f8450fca 258#endif
7f3a781d 259#define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
f8450fca 260static char __log_buf[__LOG_BUF_LEN] __aligned(LOG_ALIGN);
7f3a781d
KS
261static char *log_buf = __log_buf;
262static u32 log_buf_len = __LOG_BUF_LEN;
263
264/* cpu currently holding logbuf_lock */
265static volatile unsigned int logbuf_cpu = UINT_MAX;
7ff9554b
KS
266
267/* human readable text of the record */
268static char *log_text(const struct log *msg)
269{
270 return (char *)msg + sizeof(struct log);
271}
272
273/* optional key/value pair dictionary attached to the record */
274static char *log_dict(const struct log *msg)
275{
276 return (char *)msg + sizeof(struct log) + msg->text_len;
277}
278
279/* get record by index; idx must point to valid msg */
280static struct log *log_from_idx(u32 idx)
281{
282 struct log *msg = (struct log *)(log_buf + idx);
283
284 /*
285 * A length == 0 record is the end of buffer marker. Wrap around and
286 * read the message at the start of the buffer.
287 */
288 if (!msg->len)
289 return (struct log *)log_buf;
290 return msg;
291}
292
293/* get next record; idx must point to valid msg */
294static u32 log_next(u32 idx)
295{
296 struct log *msg = (struct log *)(log_buf + idx);
297
298 /* length == 0 indicates the end of the buffer; wrap */
299 /*
300 * A length == 0 record is the end of buffer marker. Wrap around and
301 * read the message at the start of the buffer as *this* one, and
302 * return the one after that.
303 */
304 if (!msg->len) {
305 msg = (struct log *)log_buf;
306 return msg->len;
307 }
308 return idx + msg->len;
309}
310
7ff9554b
KS
311/* insert record into the buffer, discard old ones, update heads */
312static void log_store(int facility, int level,
084681d1 313 enum log_flags flags, u64 ts_nsec,
7ff9554b
KS
314 const char *dict, u16 dict_len,
315 const char *text, u16 text_len)
316{
317 struct log *msg;
318 u32 size, pad_len;
319
320 /* number of '\0' padding bytes to next message */
321 size = sizeof(struct log) + text_len + dict_len;
322 pad_len = (-size) & (LOG_ALIGN - 1);
323 size += pad_len;
324
325 while (log_first_seq < log_next_seq) {
326 u32 free;
327
328 if (log_next_idx > log_first_idx)
329 free = max(log_buf_len - log_next_idx, log_first_idx);
330 else
331 free = log_first_idx - log_next_idx;
332
333 if (free > size + sizeof(struct log))
334 break;
335
336 /* drop old messages until we have enough contiuous space */
337 log_first_idx = log_next(log_first_idx);
338 log_first_seq++;
339 }
340
341 if (log_next_idx + size + sizeof(struct log) >= log_buf_len) {
342 /*
343 * This message + an additional empty header does not fit
344 * at the end of the buffer. Add an empty header with len == 0
345 * to signify a wrap around.
346 */
347 memset(log_buf + log_next_idx, 0, sizeof(struct log));
348 log_next_idx = 0;
349 }
350
351 /* fill message */
352 msg = (struct log *)(log_buf + log_next_idx);
353 memcpy(log_text(msg), text, text_len);
354 msg->text_len = text_len;
355 memcpy(log_dict(msg), dict, dict_len);
356 msg->dict_len = dict_len;
084681d1
KS
357 msg->facility = facility;
358 msg->level = level & 7;
359 msg->flags = flags & 0x1f;
360 if (ts_nsec > 0)
361 msg->ts_nsec = ts_nsec;
362 else
363 msg->ts_nsec = local_clock();
7ff9554b
KS
364 memset(log_dict(msg) + dict_len, 0, pad_len);
365 msg->len = sizeof(struct log) + text_len + dict_len + pad_len;
366
367 /* insert message */
368 log_next_idx += msg->len;
369 log_next_seq++;
370}
d59745ce 371
e11fea92
KS
372/* /dev/kmsg - userspace message inject/listen interface */
373struct devkmsg_user {
374 u64 seq;
375 u32 idx;
d39f3d77 376 enum log_flags prev;
e11fea92
KS
377 struct mutex lock;
378 char buf[8192];
379};
380
381static ssize_t devkmsg_writev(struct kiocb *iocb, const struct iovec *iv,
382 unsigned long count, loff_t pos)
383{
384 char *buf, *line;
385 int i;
386 int level = default_message_loglevel;
387 int facility = 1; /* LOG_USER */
388 size_t len = iov_length(iv, count);
389 ssize_t ret = len;
390
391 if (len > LOG_LINE_MAX)
392 return -EINVAL;
393 buf = kmalloc(len+1, GFP_KERNEL);
394 if (buf == NULL)
395 return -ENOMEM;
396
397 line = buf;
398 for (i = 0; i < count; i++) {
cdf53441
KS
399 if (copy_from_user(line, iv[i].iov_base, iv[i].iov_len)) {
400 ret = -EFAULT;
e11fea92 401 goto out;
cdf53441 402 }
e11fea92
KS
403 line += iv[i].iov_len;
404 }
405
406 /*
407 * Extract and skip the syslog prefix <[0-9]*>. Coming from userspace
408 * the decimal value represents 32bit, the lower 3 bit are the log
409 * level, the rest are the log facility.
410 *
411 * If no prefix or no userspace facility is specified, we
412 * enforce LOG_USER, to be able to reliably distinguish
413 * kernel-generated messages from userspace-injected ones.
414 */
415 line = buf;
416 if (line[0] == '<') {
417 char *endp = NULL;
418
419 i = simple_strtoul(line+1, &endp, 10);
420 if (endp && endp[0] == '>') {
421 level = i & 7;
422 if (i >> 3)
423 facility = i >> 3;
424 endp++;
425 len -= endp - line;
426 line = endp;
427 }
428 }
429 line[len] = '\0';
430
431 printk_emit(facility, level, NULL, 0, "%s", line);
432out:
433 kfree(buf);
434 return ret;
435}
436
437static ssize_t devkmsg_read(struct file *file, char __user *buf,
438 size_t count, loff_t *ppos)
439{
440 struct devkmsg_user *user = file->private_data;
441 struct log *msg;
5fc32490 442 u64 ts_usec;
e11fea92 443 size_t i;
d39f3d77 444 char cont = '-';
e11fea92
KS
445 size_t len;
446 ssize_t ret;
447
448 if (!user)
449 return -EBADF;
450
4a77a5a0
YL
451 ret = mutex_lock_interruptible(&user->lock);
452 if (ret)
453 return ret;
5c53d819 454 raw_spin_lock_irq(&logbuf_lock);
e11fea92
KS
455 while (user->seq == log_next_seq) {
456 if (file->f_flags & O_NONBLOCK) {
457 ret = -EAGAIN;
5c53d819 458 raw_spin_unlock_irq(&logbuf_lock);
e11fea92
KS
459 goto out;
460 }
461
5c53d819 462 raw_spin_unlock_irq(&logbuf_lock);
e11fea92
KS
463 ret = wait_event_interruptible(log_wait,
464 user->seq != log_next_seq);
465 if (ret)
466 goto out;
5c53d819 467 raw_spin_lock_irq(&logbuf_lock);
e11fea92
KS
468 }
469
470 if (user->seq < log_first_seq) {
471 /* our last seen message is gone, return error and reset */
472 user->idx = log_first_idx;
473 user->seq = log_first_seq;
474 ret = -EPIPE;
5c53d819 475 raw_spin_unlock_irq(&logbuf_lock);
e11fea92
KS
476 goto out;
477 }
478
479 msg = log_from_idx(user->idx);
5fc32490
KS
480 ts_usec = msg->ts_nsec;
481 do_div(ts_usec, 1000);
d39f3d77
KS
482
483 /*
484 * If we couldn't merge continuation line fragments during the print,
485 * export the stored flags to allow an optional external merge of the
486 * records. Merging the records isn't always neccessarily correct, like
487 * when we hit a race during printing. In most cases though, it produces
488 * better readable output. 'c' in the record flags mark the first
489 * fragment of a line, '+' the following.
490 */
491 if (msg->flags & LOG_CONT && !(user->prev & LOG_CONT))
492 cont = 'c';
493 else if ((msg->flags & LOG_CONT) ||
494 ((user->prev & LOG_CONT) && !(msg->flags & LOG_PREFIX)))
495 cont = '+';
496
497 len = sprintf(user->buf, "%u,%llu,%llu,%c;",
498 (msg->facility << 3) | msg->level,
499 user->seq, ts_usec, cont);
500 user->prev = msg->flags;
e11fea92
KS
501
502 /* escape non-printable characters */
503 for (i = 0; i < msg->text_len; i++) {
3ce9a7c0 504 unsigned char c = log_text(msg)[i];
e11fea92 505
e3f5a5f2 506 if (c < ' ' || c >= 127 || c == '\\')
e11fea92
KS
507 len += sprintf(user->buf + len, "\\x%02x", c);
508 else
509 user->buf[len++] = c;
510 }
511 user->buf[len++] = '\n';
512
513 if (msg->dict_len) {
514 bool line = true;
515
516 for (i = 0; i < msg->dict_len; i++) {
3ce9a7c0 517 unsigned char c = log_dict(msg)[i];
e11fea92
KS
518
519 if (line) {
520 user->buf[len++] = ' ';
521 line = false;
522 }
523
524 if (c == '\0') {
525 user->buf[len++] = '\n';
526 line = true;
527 continue;
528 }
529
e3f5a5f2 530 if (c < ' ' || c >= 127 || c == '\\') {
e11fea92
KS
531 len += sprintf(user->buf + len, "\\x%02x", c);
532 continue;
533 }
534
535 user->buf[len++] = c;
536 }
537 user->buf[len++] = '\n';
538 }
539
540 user->idx = log_next(user->idx);
541 user->seq++;
5c53d819 542 raw_spin_unlock_irq(&logbuf_lock);
e11fea92
KS
543
544 if (len > count) {
545 ret = -EINVAL;
546 goto out;
547 }
548
549 if (copy_to_user(buf, user->buf, len)) {
550 ret = -EFAULT;
551 goto out;
552 }
553 ret = len;
554out:
555 mutex_unlock(&user->lock);
556 return ret;
557}
558
559static loff_t devkmsg_llseek(struct file *file, loff_t offset, int whence)
560{
561 struct devkmsg_user *user = file->private_data;
562 loff_t ret = 0;
563
564 if (!user)
565 return -EBADF;
566 if (offset)
567 return -ESPIPE;
568
5c53d819 569 raw_spin_lock_irq(&logbuf_lock);
e11fea92
KS
570 switch (whence) {
571 case SEEK_SET:
572 /* the first record */
573 user->idx = log_first_idx;
574 user->seq = log_first_seq;
575 break;
576 case SEEK_DATA:
577 /*
578 * The first record after the last SYSLOG_ACTION_CLEAR,
579 * like issued by 'dmesg -c'. Reading /dev/kmsg itself
580 * changes no global state, and does not clear anything.
581 */
582 user->idx = clear_idx;
583 user->seq = clear_seq;
584 break;
585 case SEEK_END:
586 /* after the last record */
587 user->idx = log_next_idx;
588 user->seq = log_next_seq;
589 break;
590 default:
591 ret = -EINVAL;
592 }
5c53d819 593 raw_spin_unlock_irq(&logbuf_lock);
e11fea92
KS
594 return ret;
595}
596
597static unsigned int devkmsg_poll(struct file *file, poll_table *wait)
598{
599 struct devkmsg_user *user = file->private_data;
600 int ret = 0;
601
602 if (!user)
603 return POLLERR|POLLNVAL;
604
605 poll_wait(file, &log_wait, wait);
606
5c53d819 607 raw_spin_lock_irq(&logbuf_lock);
e11fea92
KS
608 if (user->seq < log_next_seq) {
609 /* return error when data has vanished underneath us */
610 if (user->seq < log_first_seq)
611 ret = POLLIN|POLLRDNORM|POLLERR|POLLPRI;
612 ret = POLLIN|POLLRDNORM;
613 }
5c53d819 614 raw_spin_unlock_irq(&logbuf_lock);
e11fea92
KS
615
616 return ret;
617}
618
619static int devkmsg_open(struct inode *inode, struct file *file)
620{
621 struct devkmsg_user *user;
622 int err;
623
624 /* write-only does not need any file context */
625 if ((file->f_flags & O_ACCMODE) == O_WRONLY)
626 return 0;
627
628 err = security_syslog(SYSLOG_ACTION_READ_ALL);
629 if (err)
630 return err;
631
632 user = kmalloc(sizeof(struct devkmsg_user), GFP_KERNEL);
633 if (!user)
634 return -ENOMEM;
635
636 mutex_init(&user->lock);
637
5c53d819 638 raw_spin_lock_irq(&logbuf_lock);
e11fea92
KS
639 user->idx = log_first_idx;
640 user->seq = log_first_seq;
5c53d819 641 raw_spin_unlock_irq(&logbuf_lock);
e11fea92
KS
642
643 file->private_data = user;
644 return 0;
645}
646
647static int devkmsg_release(struct inode *inode, struct file *file)
648{
649 struct devkmsg_user *user = file->private_data;
650
651 if (!user)
652 return 0;
653
654 mutex_destroy(&user->lock);
655 kfree(user);
656 return 0;
657}
658
659const struct file_operations kmsg_fops = {
660 .open = devkmsg_open,
661 .read = devkmsg_read,
662 .aio_write = devkmsg_writev,
663 .llseek = devkmsg_llseek,
664 .poll = devkmsg_poll,
665 .release = devkmsg_release,
666};
667
04d491ab
NH
668#ifdef CONFIG_KEXEC
669/*
670 * This appends the listed symbols to /proc/vmcoreinfo
671 *
672 * /proc/vmcoreinfo is used by various utiilties, like crash and makedumpfile to
673 * obtain access to symbols that are otherwise very difficult to locate. These
674 * symbols are specifically used so that utilities can access and extract the
675 * dmesg log from a vmcore file after a crash.
676 */
677void log_buf_kexec_setup(void)
678{
679 VMCOREINFO_SYMBOL(log_buf);
04d491ab 680 VMCOREINFO_SYMBOL(log_buf_len);
7ff9554b
KS
681 VMCOREINFO_SYMBOL(log_first_idx);
682 VMCOREINFO_SYMBOL(log_next_idx);
6791457a
VG
683 /*
684 * Export struct log size and field offsets. User space tools can
685 * parse it and detect any changes to structure down the line.
686 */
687 VMCOREINFO_STRUCT_SIZE(log);
688 VMCOREINFO_OFFSET(log, ts_nsec);
689 VMCOREINFO_OFFSET(log, len);
690 VMCOREINFO_OFFSET(log, text_len);
691 VMCOREINFO_OFFSET(log, dict_len);
04d491ab
NH
692}
693#endif
694
162a7e75
MT
695/* requested log_buf_len from kernel cmdline */
696static unsigned long __initdata new_log_buf_len;
697
698/* save requested log_buf_len since it's too early to process it */
1da177e4
LT
699static int __init log_buf_len_setup(char *str)
700{
eed4a2ab 701 unsigned size = memparse(str, &str);
1da177e4
LT
702
703 if (size)
704 size = roundup_pow_of_two(size);
162a7e75
MT
705 if (size > log_buf_len)
706 new_log_buf_len = size;
707
708 return 0;
1da177e4 709}
162a7e75
MT
710early_param("log_buf_len", log_buf_len_setup);
711
712void __init setup_log_buf(int early)
713{
714 unsigned long flags;
162a7e75
MT
715 char *new_log_buf;
716 int free;
717
718 if (!new_log_buf_len)
719 return;
1da177e4 720
162a7e75
MT
721 if (early) {
722 unsigned long mem;
723
724 mem = memblock_alloc(new_log_buf_len, PAGE_SIZE);
1f5026a7 725 if (!mem)
162a7e75
MT
726 return;
727 new_log_buf = __va(mem);
728 } else {
729 new_log_buf = alloc_bootmem_nopanic(new_log_buf_len);
730 }
731
732 if (unlikely(!new_log_buf)) {
733 pr_err("log_buf_len: %ld bytes not available\n",
734 new_log_buf_len);
735 return;
736 }
737
07354eb1 738 raw_spin_lock_irqsave(&logbuf_lock, flags);
162a7e75
MT
739 log_buf_len = new_log_buf_len;
740 log_buf = new_log_buf;
741 new_log_buf_len = 0;
7ff9554b
KS
742 free = __LOG_BUF_LEN - log_next_idx;
743 memcpy(log_buf, __log_buf, __LOG_BUF_LEN);
07354eb1 744 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
162a7e75
MT
745
746 pr_info("log_buf_len: %d\n", log_buf_len);
747 pr_info("early log buf free: %d(%d%%)\n",
748 free, (free * 100) / __LOG_BUF_LEN);
749}
1da177e4 750
2fa72c8f
AC
751static bool __read_mostly ignore_loglevel;
752
753static int __init ignore_loglevel_setup(char *str)
754{
755 ignore_loglevel = 1;
756 printk(KERN_INFO "debug: ignoring loglevel setting.\n");
757
758 return 0;
759}
760
761early_param("ignore_loglevel", ignore_loglevel_setup);
762module_param(ignore_loglevel, bool, S_IRUGO | S_IWUSR);
763MODULE_PARM_DESC(ignore_loglevel, "ignore loglevel setting, to"
764 "print all kernel messages to the console.");
765
bfe8df3d
RD
766#ifdef CONFIG_BOOT_PRINTK_DELAY
767
674dff65 768static int boot_delay; /* msecs delay after each printk during bootup */
3a3b6ed2 769static unsigned long long loops_per_msec; /* based on boot_delay */
bfe8df3d
RD
770
771static int __init boot_delay_setup(char *str)
772{
773 unsigned long lpj;
bfe8df3d
RD
774
775 lpj = preset_lpj ? preset_lpj : 1000000; /* some guess */
776 loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
777
778 get_option(&str, &boot_delay);
779 if (boot_delay > 10 * 1000)
780 boot_delay = 0;
781
3a3b6ed2
DY
782 pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
783 "HZ: %d, loops_per_msec: %llu\n",
784 boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
bfe8df3d
RD
785 return 1;
786}
787__setup("boot_delay=", boot_delay_setup);
788
2fa72c8f 789static void boot_delay_msec(int level)
bfe8df3d
RD
790{
791 unsigned long long k;
792 unsigned long timeout;
793
2fa72c8f
AC
794 if ((boot_delay == 0 || system_state != SYSTEM_BOOTING)
795 || (level >= console_loglevel && !ignore_loglevel)) {
bfe8df3d 796 return;
2fa72c8f 797 }
bfe8df3d 798
3a3b6ed2 799 k = (unsigned long long)loops_per_msec * boot_delay;
bfe8df3d
RD
800
801 timeout = jiffies + msecs_to_jiffies(boot_delay);
802 while (k) {
803 k--;
804 cpu_relax();
805 /*
806 * use (volatile) jiffies to prevent
807 * compiler reduction; loop termination via jiffies
808 * is secondary and may or may not happen.
809 */
810 if (time_after(jiffies, timeout))
811 break;
812 touch_nmi_watchdog();
813 }
814}
815#else
2fa72c8f 816static inline void boot_delay_msec(int level)
bfe8df3d
RD
817{
818}
819#endif
820
eaf06b24
DR
821#ifdef CONFIG_SECURITY_DMESG_RESTRICT
822int dmesg_restrict = 1;
823#else
824int dmesg_restrict;
825#endif
826
ee24aebf
LT
827static int syslog_action_restricted(int type)
828{
829 if (dmesg_restrict)
830 return 1;
831 /* Unless restricted, we allow "read all" and "get buffer size" for everybody */
832 return type != SYSLOG_ACTION_READ_ALL && type != SYSLOG_ACTION_SIZE_BUFFER;
833}
834
835static int check_syslog_permissions(int type, bool from_file)
836{
837 /*
838 * If this is from /proc/kmsg and we've already opened it, then we've
839 * already done the capabilities checks at open time.
840 */
841 if (from_file && type != SYSLOG_ACTION_OPEN)
842 return 0;
843
844 if (syslog_action_restricted(type)) {
845 if (capable(CAP_SYSLOG))
846 return 0;
847 /* For historical reasons, accept CAP_SYS_ADMIN too, with a warning */
848 if (capable(CAP_SYS_ADMIN)) {
f2c0d026
JN
849 printk_once(KERN_WARNING "%s (%d): "
850 "Attempt to access syslog with CAP_SYS_ADMIN "
851 "but no CAP_SYSLOG (deprecated).\n",
852 current->comm, task_pid_nr(current));
ee24aebf
LT
853 return 0;
854 }
855 return -EPERM;
856 }
857 return 0;
858}
859
7ff9554b
KS
860#if defined(CONFIG_PRINTK_TIME)
861static bool printk_time = 1;
862#else
863static bool printk_time;
864#endif
865module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
866
084681d1
KS
867static size_t print_time(u64 ts, char *buf)
868{
869 unsigned long rem_nsec;
870
871 if (!printk_time)
872 return 0;
873
35dac27c
RD
874 rem_nsec = do_div(ts, 1000000000);
875
084681d1 876 if (!buf)
35dac27c 877 return snprintf(NULL, 0, "[%5lu.000000] ", (unsigned long)ts);
084681d1 878
084681d1
KS
879 return sprintf(buf, "[%5lu.%06lu] ",
880 (unsigned long)ts, rem_nsec / 1000);
881}
882
3ce9a7c0 883static size_t print_prefix(const struct log *msg, bool syslog, char *buf)
649e6ee3 884{
3ce9a7c0 885 size_t len = 0;
43a73a50 886 unsigned int prefix = (msg->facility << 3) | msg->level;
649e6ee3 887
3ce9a7c0
KS
888 if (syslog) {
889 if (buf) {
43a73a50 890 len += sprintf(buf, "<%u>", prefix);
3ce9a7c0
KS
891 } else {
892 len += 3;
43a73a50
KS
893 if (prefix > 999)
894 len += 3;
895 else if (prefix > 99)
896 len += 2;
897 else if (prefix > 9)
3ce9a7c0
KS
898 len++;
899 }
900 }
649e6ee3 901
084681d1 902 len += print_time(msg->ts_nsec, buf ? buf + len : NULL);
3ce9a7c0 903 return len;
649e6ee3
KS
904}
905
5becfb1d
KS
906static size_t msg_print_text(const struct log *msg, enum log_flags prev,
907 bool syslog, char *buf, size_t size)
7ff9554b 908{
3ce9a7c0
KS
909 const char *text = log_text(msg);
910 size_t text_size = msg->text_len;
5becfb1d
KS
911 bool prefix = true;
912 bool newline = true;
3ce9a7c0
KS
913 size_t len = 0;
914
5becfb1d
KS
915 if ((prev & LOG_CONT) && !(msg->flags & LOG_PREFIX))
916 prefix = false;
917
918 if (msg->flags & LOG_CONT) {
919 if ((prev & LOG_CONT) && !(prev & LOG_NEWLINE))
920 prefix = false;
921
922 if (!(msg->flags & LOG_NEWLINE))
923 newline = false;
924 }
925
3ce9a7c0
KS
926 do {
927 const char *next = memchr(text, '\n', text_size);
928 size_t text_len;
929
930 if (next) {
931 text_len = next - text;
932 next++;
933 text_size -= next - text;
934 } else {
935 text_len = text_size;
936 }
7ff9554b 937
3ce9a7c0
KS
938 if (buf) {
939 if (print_prefix(msg, syslog, NULL) +
70498253 940 text_len + 1 >= size - len)
3ce9a7c0 941 break;
7ff9554b 942
5becfb1d
KS
943 if (prefix)
944 len += print_prefix(msg, syslog, buf + len);
3ce9a7c0
KS
945 memcpy(buf + len, text, text_len);
946 len += text_len;
5becfb1d
KS
947 if (next || newline)
948 buf[len++] = '\n';
3ce9a7c0
KS
949 } else {
950 /* SYSLOG_ACTION_* buffer size only calculation */
5becfb1d
KS
951 if (prefix)
952 len += print_prefix(msg, syslog, NULL);
953 len += text_len;
954 if (next || newline)
955 len++;
3ce9a7c0 956 }
7ff9554b 957
5becfb1d 958 prefix = true;
3ce9a7c0
KS
959 text = next;
960 } while (text);
7ff9554b 961
7ff9554b
KS
962 return len;
963}
964
965static int syslog_print(char __user *buf, int size)
966{
967 char *text;
3ce9a7c0 968 struct log *msg;
116e90b2 969 int len = 0;
7ff9554b 970
70498253 971 text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
7ff9554b
KS
972 if (!text)
973 return -ENOMEM;
974
116e90b2
JB
975 while (size > 0) {
976 size_t n;
eb02dac9 977 size_t skip;
116e90b2
JB
978
979 raw_spin_lock_irq(&logbuf_lock);
980 if (syslog_seq < log_first_seq) {
981 /* messages are gone, move to first one */
982 syslog_seq = log_first_seq;
983 syslog_idx = log_first_idx;
5becfb1d 984 syslog_prev = 0;
eb02dac9 985 syslog_partial = 0;
116e90b2
JB
986 }
987 if (syslog_seq == log_next_seq) {
988 raw_spin_unlock_irq(&logbuf_lock);
989 break;
990 }
eb02dac9
KS
991
992 skip = syslog_partial;
116e90b2 993 msg = log_from_idx(syslog_idx);
70498253
KS
994 n = msg_print_text(msg, syslog_prev, true, text,
995 LOG_LINE_MAX + PREFIX_MAX);
eb02dac9
KS
996 if (n - syslog_partial <= size) {
997 /* message fits into buffer, move forward */
116e90b2
JB
998 syslog_idx = log_next(syslog_idx);
999 syslog_seq++;
5becfb1d 1000 syslog_prev = msg->flags;
eb02dac9
KS
1001 n -= syslog_partial;
1002 syslog_partial = 0;
1003 } else if (!len){
1004 /* partial read(), remember position */
1005 n = size;
1006 syslog_partial += n;
116e90b2
JB
1007 } else
1008 n = 0;
1009 raw_spin_unlock_irq(&logbuf_lock);
1010
1011 if (!n)
1012 break;
1013
eb02dac9 1014 if (copy_to_user(buf, text + skip, n)) {
116e90b2
JB
1015 if (!len)
1016 len = -EFAULT;
1017 break;
1018 }
eb02dac9
KS
1019
1020 len += n;
1021 size -= n;
1022 buf += n;
7ff9554b 1023 }
7ff9554b
KS
1024
1025 kfree(text);
1026 return len;
1027}
1028
1029static int syslog_print_all(char __user *buf, int size, bool clear)
1030{
1031 char *text;
1032 int len = 0;
1033
70498253 1034 text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
7ff9554b
KS
1035 if (!text)
1036 return -ENOMEM;
1037
1038 raw_spin_lock_irq(&logbuf_lock);
1039 if (buf) {
1040 u64 next_seq;
1041 u64 seq;
1042 u32 idx;
5becfb1d 1043 enum log_flags prev;
7ff9554b
KS
1044
1045 if (clear_seq < log_first_seq) {
1046 /* messages are gone, move to first available one */
1047 clear_seq = log_first_seq;
1048 clear_idx = log_first_idx;
1049 }
1050
1051 /*
1052 * Find first record that fits, including all following records,
1053 * into the user-provided buffer for this dump.
e2ae715d 1054 */
7ff9554b
KS
1055 seq = clear_seq;
1056 idx = clear_idx;
5becfb1d 1057 prev = 0;
7ff9554b 1058 while (seq < log_next_seq) {
3ce9a7c0
KS
1059 struct log *msg = log_from_idx(idx);
1060
5becfb1d 1061 len += msg_print_text(msg, prev, true, NULL, 0);
e3756477 1062 prev = msg->flags;
7ff9554b
KS
1063 idx = log_next(idx);
1064 seq++;
1065 }
e2ae715d
KS
1066
1067 /* move first record forward until length fits into the buffer */
7ff9554b
KS
1068 seq = clear_seq;
1069 idx = clear_idx;
5becfb1d 1070 prev = 0;
7ff9554b 1071 while (len > size && seq < log_next_seq) {
3ce9a7c0
KS
1072 struct log *msg = log_from_idx(idx);
1073
5becfb1d 1074 len -= msg_print_text(msg, prev, true, NULL, 0);
e3756477 1075 prev = msg->flags;
7ff9554b
KS
1076 idx = log_next(idx);
1077 seq++;
1078 }
1079
e2ae715d 1080 /* last message fitting into this dump */
7ff9554b
KS
1081 next_seq = log_next_seq;
1082
1083 len = 0;
5becfb1d 1084 prev = 0;
7ff9554b 1085 while (len >= 0 && seq < next_seq) {
3ce9a7c0 1086 struct log *msg = log_from_idx(idx);
7ff9554b
KS
1087 int textlen;
1088
70498253
KS
1089 textlen = msg_print_text(msg, prev, true, text,
1090 LOG_LINE_MAX + PREFIX_MAX);
7ff9554b
KS
1091 if (textlen < 0) {
1092 len = textlen;
1093 break;
1094 }
1095 idx = log_next(idx);
1096 seq++;
5becfb1d 1097 prev = msg->flags;
7ff9554b
KS
1098
1099 raw_spin_unlock_irq(&logbuf_lock);
1100 if (copy_to_user(buf + len, text, textlen))
1101 len = -EFAULT;
1102 else
1103 len += textlen;
1104 raw_spin_lock_irq(&logbuf_lock);
1105
1106 if (seq < log_first_seq) {
1107 /* messages are gone, move to next one */
1108 seq = log_first_seq;
1109 idx = log_first_idx;
5becfb1d 1110 prev = 0;
7ff9554b
KS
1111 }
1112 }
1113 }
1114
1115 if (clear) {
1116 clear_seq = log_next_seq;
1117 clear_idx = log_next_idx;
1118 }
1119 raw_spin_unlock_irq(&logbuf_lock);
1120
1121 kfree(text);
1122 return len;
1123}
1124
00234592 1125int do_syslog(int type, char __user *buf, int len, bool from_file)
1da177e4 1126{
7ff9554b
KS
1127 bool clear = false;
1128 static int saved_console_loglevel = -1;
ee24aebf 1129 int error;
1da177e4 1130
ee24aebf
LT
1131 error = check_syslog_permissions(type, from_file);
1132 if (error)
1133 goto out;
12b3052c
EP
1134
1135 error = security_syslog(type);
1da177e4
LT
1136 if (error)
1137 return error;
1138
1139 switch (type) {
d78ca3cd 1140 case SYSLOG_ACTION_CLOSE: /* Close log */
1da177e4 1141 break;
d78ca3cd 1142 case SYSLOG_ACTION_OPEN: /* Open log */
1da177e4 1143 break;
d78ca3cd 1144 case SYSLOG_ACTION_READ: /* Read from log */
1da177e4
LT
1145 error = -EINVAL;
1146 if (!buf || len < 0)
1147 goto out;
1148 error = 0;
1149 if (!len)
1150 goto out;
1151 if (!access_ok(VERIFY_WRITE, buf, len)) {
1152 error = -EFAULT;
1153 goto out;
1154 }
40dc5651 1155 error = wait_event_interruptible(log_wait,
7ff9554b 1156 syslog_seq != log_next_seq);
cb424ffe 1157 if (error)
1da177e4 1158 goto out;
7ff9554b 1159 error = syslog_print(buf, len);
1da177e4 1160 break;
d78ca3cd
KC
1161 /* Read/clear last kernel messages */
1162 case SYSLOG_ACTION_READ_CLEAR:
7ff9554b 1163 clear = true;
1da177e4 1164 /* FALL THRU */
d78ca3cd
KC
1165 /* Read last kernel messages */
1166 case SYSLOG_ACTION_READ_ALL:
1da177e4
LT
1167 error = -EINVAL;
1168 if (!buf || len < 0)
1169 goto out;
1170 error = 0;
1171 if (!len)
1172 goto out;
1173 if (!access_ok(VERIFY_WRITE, buf, len)) {
1174 error = -EFAULT;
1175 goto out;
1176 }
7ff9554b 1177 error = syslog_print_all(buf, len, clear);
1da177e4 1178 break;
d78ca3cd
KC
1179 /* Clear ring buffer */
1180 case SYSLOG_ACTION_CLEAR:
7ff9554b 1181 syslog_print_all(NULL, 0, true);
4661e356 1182 break;
d78ca3cd
KC
1183 /* Disable logging to console */
1184 case SYSLOG_ACTION_CONSOLE_OFF:
1aaad49e
FP
1185 if (saved_console_loglevel == -1)
1186 saved_console_loglevel = console_loglevel;
1da177e4
LT
1187 console_loglevel = minimum_console_loglevel;
1188 break;
d78ca3cd
KC
1189 /* Enable logging to console */
1190 case SYSLOG_ACTION_CONSOLE_ON:
1aaad49e
FP
1191 if (saved_console_loglevel != -1) {
1192 console_loglevel = saved_console_loglevel;
1193 saved_console_loglevel = -1;
1194 }
1da177e4 1195 break;
d78ca3cd
KC
1196 /* Set level of messages printed to console */
1197 case SYSLOG_ACTION_CONSOLE_LEVEL:
1da177e4
LT
1198 error = -EINVAL;
1199 if (len < 1 || len > 8)
1200 goto out;
1201 if (len < minimum_console_loglevel)
1202 len = minimum_console_loglevel;
1203 console_loglevel = len;
1aaad49e
FP
1204 /* Implicitly re-enable logging to console */
1205 saved_console_loglevel = -1;
1da177e4
LT
1206 error = 0;
1207 break;
d78ca3cd
KC
1208 /* Number of chars in the log buffer */
1209 case SYSLOG_ACTION_SIZE_UNREAD:
7ff9554b
KS
1210 raw_spin_lock_irq(&logbuf_lock);
1211 if (syslog_seq < log_first_seq) {
1212 /* messages are gone, move to first one */
1213 syslog_seq = log_first_seq;
1214 syslog_idx = log_first_idx;
5becfb1d 1215 syslog_prev = 0;
eb02dac9 1216 syslog_partial = 0;
7ff9554b
KS
1217 }
1218 if (from_file) {
1219 /*
1220 * Short-cut for poll(/"proc/kmsg") which simply checks
1221 * for pending data, not the size; return the count of
1222 * records, not the length.
1223 */
1224 error = log_next_idx - syslog_idx;
1225 } else {
5becfb1d
KS
1226 u64 seq = syslog_seq;
1227 u32 idx = syslog_idx;
1228 enum log_flags prev = syslog_prev;
7ff9554b
KS
1229
1230 error = 0;
7ff9554b 1231 while (seq < log_next_seq) {
3ce9a7c0
KS
1232 struct log *msg = log_from_idx(idx);
1233
5becfb1d 1234 error += msg_print_text(msg, prev, true, NULL, 0);
7ff9554b
KS
1235 idx = log_next(idx);
1236 seq++;
5becfb1d 1237 prev = msg->flags;
7ff9554b 1238 }
eb02dac9 1239 error -= syslog_partial;
7ff9554b
KS
1240 }
1241 raw_spin_unlock_irq(&logbuf_lock);
1da177e4 1242 break;
d78ca3cd
KC
1243 /* Size of the log buffer */
1244 case SYSLOG_ACTION_SIZE_BUFFER:
1da177e4
LT
1245 error = log_buf_len;
1246 break;
1247 default:
1248 error = -EINVAL;
1249 break;
1250 }
1251out:
1252 return error;
1253}
1254
1e7bfb21 1255SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
1da177e4 1256{
00234592 1257 return do_syslog(type, buf, len, SYSLOG_FROM_CALL);
1da177e4
LT
1258}
1259
1da177e4
LT
1260/*
1261 * Call the console drivers, asking them to write out
1262 * log_buf[start] to log_buf[end - 1].
ac751efa 1263 * The console_lock must be held.
1da177e4 1264 */
7ff9554b 1265static void call_console_drivers(int level, const char *text, size_t len)
1da177e4 1266{
7ff9554b 1267 struct console *con;
1da177e4 1268
7ff9554b
KS
1269 trace_console(text, 0, len, len);
1270
1271 if (level >= console_loglevel && !ignore_loglevel)
1272 return;
1273 if (!console_drivers)
1274 return;
1275
1276 for_each_console(con) {
1277 if (exclusive_console && con != exclusive_console)
1278 continue;
1279 if (!(con->flags & CON_ENABLED))
1280 continue;
1281 if (!con->write)
1282 continue;
1283 if (!cpu_online(smp_processor_id()) &&
1284 !(con->flags & CON_ANYTIME))
1285 continue;
1286 con->write(con, text, len);
1287 }
1da177e4
LT
1288}
1289
1290/*
1291 * Zap console related locks when oopsing. Only zap at most once
1292 * every 10 seconds, to leave time for slow consoles to print a
1293 * full oops.
1294 */
1295static void zap_locks(void)
1296{
1297 static unsigned long oops_timestamp;
1298
1299 if (time_after_eq(jiffies, oops_timestamp) &&
40dc5651 1300 !time_after(jiffies, oops_timestamp + 30 * HZ))
1da177e4
LT
1301 return;
1302
1303 oops_timestamp = jiffies;
1304
94d24fc4 1305 debug_locks_off();
1da177e4 1306 /* If a crash is occurring, make sure we can't deadlock */
07354eb1 1307 raw_spin_lock_init(&logbuf_lock);
1da177e4 1308 /* And make sure that we print immediately */
5b8c4f23 1309 sema_init(&console_sem, 1);
1da177e4
LT
1310}
1311
76a8ad29
ME
1312/* Check if we have any console registered that can be called early in boot. */
1313static int have_callable_console(void)
1314{
1315 struct console *con;
1316
4d091611 1317 for_each_console(con)
76a8ad29
ME
1318 if (con->flags & CON_ANYTIME)
1319 return 1;
1320
1321 return 0;
1322}
1323
266c2e0a
LT
1324/*
1325 * Can we actually use the console at this time on this cpu?
1326 *
1327 * Console drivers may assume that per-cpu resources have
1328 * been allocated. So unless they're explicitly marked as
1329 * being able to cope (CON_ANYTIME) don't call them until
1330 * this CPU is officially up.
1331 */
1332static inline int can_use_console(unsigned int cpu)
1333{
1334 return cpu_online(cpu) || have_callable_console();
1335}
1336
1337/*
1338 * Try to get console ownership to actually show the kernel
1339 * messages from a 'printk'. Return true (and with the
ac751efa 1340 * console_lock held, and 'console_locked' set) if it
266c2e0a
LT
1341 * is successful, false otherwise.
1342 *
1343 * This gets called with the 'logbuf_lock' spinlock held and
1344 * interrupts disabled. It should return with 'lockbuf_lock'
1345 * released but interrupts still disabled.
1346 */
ac751efa 1347static int console_trylock_for_printk(unsigned int cpu)
8155c02a 1348 __releases(&logbuf_lock)
266c2e0a 1349{
0b5e1c52 1350 int retval = 0, wake = 0;
266c2e0a 1351
ac751efa 1352 if (console_trylock()) {
093a07e2
LT
1353 retval = 1;
1354
1355 /*
1356 * If we can't use the console, we need to release
1357 * the console semaphore by hand to avoid flushing
1358 * the buffer. We need to hold the console semaphore
1359 * in order to do this test safely.
1360 */
1361 if (!can_use_console(cpu)) {
1362 console_locked = 0;
0b5e1c52 1363 wake = 1;
093a07e2
LT
1364 retval = 0;
1365 }
1366 }
7ff9554b 1367 logbuf_cpu = UINT_MAX;
0b5e1c52
PZ
1368 if (wake)
1369 up(&console_sem);
07354eb1 1370 raw_spin_unlock(&logbuf_lock);
266c2e0a
LT
1371 return retval;
1372}
32a76006 1373
af91322e
DY
1374int printk_delay_msec __read_mostly;
1375
1376static inline void printk_delay(void)
1377{
1378 if (unlikely(printk_delay_msec)) {
1379 int m = printk_delay_msec;
1380
1381 while (m--) {
1382 mdelay(1);
1383 touch_nmi_watchdog();
1384 }
1385 }
1386}
1387
084681d1
KS
1388/*
1389 * Continuation lines are buffered, and not committed to the record buffer
1390 * until the line is complete, or a race forces it. The line fragments
1391 * though, are printed immediately to the consoles to ensure everything has
1392 * reached the console in case of a kernel crash.
1393 */
1394static struct cont {
1395 char buf[LOG_LINE_MAX];
1396 size_t len; /* length == 0 means unused buffer */
1397 size_t cons; /* bytes written to console */
1398 struct task_struct *owner; /* task of first print*/
1399 u64 ts_nsec; /* time of first print */
1400 u8 level; /* log level of first message */
1401 u8 facility; /* log level of first message */
eab07260 1402 enum log_flags flags; /* prefix, newline flags */
084681d1
KS
1403 bool flushed:1; /* buffer sealed and committed */
1404} cont;
1405
70498253 1406static void cont_flush(enum log_flags flags)
084681d1
KS
1407{
1408 if (cont.flushed)
1409 return;
1410 if (cont.len == 0)
1411 return;
1412
eab07260
KS
1413 if (cont.cons) {
1414 /*
1415 * If a fragment of this line was directly flushed to the
1416 * console; wait for the console to pick up the rest of the
1417 * line. LOG_NOCONS suppresses a duplicated output.
1418 */
1419 log_store(cont.facility, cont.level, flags | LOG_NOCONS,
1420 cont.ts_nsec, NULL, 0, cont.buf, cont.len);
1421 cont.flags = flags;
1422 cont.flushed = true;
1423 } else {
1424 /*
1425 * If no fragment of this line ever reached the console,
1426 * just submit it to the store and free the buffer.
1427 */
1428 log_store(cont.facility, cont.level, flags, 0,
1429 NULL, 0, cont.buf, cont.len);
1430 cont.len = 0;
1431 }
084681d1
KS
1432}
1433
1434static bool cont_add(int facility, int level, const char *text, size_t len)
1435{
1436 if (cont.len && cont.flushed)
1437 return false;
1438
1439 if (cont.len + len > sizeof(cont.buf)) {
70498253
KS
1440 /* the line gets too long, split it up in separate records */
1441 cont_flush(LOG_CONT);
084681d1
KS
1442 return false;
1443 }
1444
1445 if (!cont.len) {
1446 cont.facility = facility;
1447 cont.level = level;
1448 cont.owner = current;
1449 cont.ts_nsec = local_clock();
eab07260 1450 cont.flags = 0;
084681d1
KS
1451 cont.cons = 0;
1452 cont.flushed = false;
1453 }
1454
1455 memcpy(cont.buf + cont.len, text, len);
1456 cont.len += len;
eab07260
KS
1457
1458 if (cont.len > (sizeof(cont.buf) * 80) / 100)
1459 cont_flush(LOG_CONT);
1460
084681d1
KS
1461 return true;
1462}
1463
1464static size_t cont_print_text(char *text, size_t size)
1465{
1466 size_t textlen = 0;
1467 size_t len;
1468
eab07260 1469 if (cont.cons == 0 && (console_prev & LOG_NEWLINE)) {
084681d1
KS
1470 textlen += print_time(cont.ts_nsec, text);
1471 size -= textlen;
1472 }
1473
1474 len = cont.len - cont.cons;
1475 if (len > 0) {
1476 if (len+1 > size)
1477 len = size-1;
1478 memcpy(text + textlen, cont.buf + cont.cons, len);
1479 textlen += len;
1480 cont.cons = cont.len;
1481 }
1482
1483 if (cont.flushed) {
eab07260
KS
1484 if (cont.flags & LOG_NEWLINE)
1485 text[textlen++] = '\n';
084681d1
KS
1486 /* got everything, release buffer */
1487 cont.len = 0;
1488 }
1489 return textlen;
1490}
1491
7ff9554b
KS
1492asmlinkage int vprintk_emit(int facility, int level,
1493 const char *dict, size_t dictlen,
1494 const char *fmt, va_list args)
1da177e4 1495{
7ff9554b 1496 static int recursion_bug;
7ff9554b
KS
1497 static char textbuf[LOG_LINE_MAX];
1498 char *text = textbuf;
c313af14 1499 size_t text_len;
5becfb1d 1500 enum log_flags lflags = 0;
ac60ad74 1501 unsigned long flags;
32a76006 1502 int this_cpu;
7ff9554b 1503 int printed_len = 0;
1da177e4 1504
2fa72c8f 1505 boot_delay_msec(level);
af91322e 1506 printk_delay();
bfe8df3d 1507
1da177e4 1508 /* This stops the holder of console_sem just where we want him */
1a9a8aef 1509 local_irq_save(flags);
32a76006
IM
1510 this_cpu = smp_processor_id();
1511
1512 /*
1513 * Ouch, printk recursed into itself!
1514 */
7ff9554b 1515 if (unlikely(logbuf_cpu == this_cpu)) {
32a76006
IM
1516 /*
1517 * If a crash is occurring during printk() on this CPU,
1518 * then try to get the crash message out but make sure
1519 * we can't deadlock. Otherwise just return to avoid the
1520 * recursion and return - but flag the recursion so that
1521 * it can be printed at the next appropriate moment:
1522 */
94d24fc4 1523 if (!oops_in_progress && !lockdep_recursing(current)) {
3b8945e8 1524 recursion_bug = 1;
32a76006
IM
1525 goto out_restore_irqs;
1526 }
1527 zap_locks();
1528 }
1529
a0f1ccfd 1530 lockdep_off();
07354eb1 1531 raw_spin_lock(&logbuf_lock);
7ff9554b 1532 logbuf_cpu = this_cpu;
1da177e4 1533
3b8945e8 1534 if (recursion_bug) {
7ff9554b
KS
1535 static const char recursion_msg[] =
1536 "BUG: recent printk recursion!";
1537
3b8945e8 1538 recursion_bug = 0;
7ff9554b
KS
1539 printed_len += strlen(recursion_msg);
1540 /* emit KERN_CRIT message */
5becfb1d 1541 log_store(0, 2, LOG_PREFIX|LOG_NEWLINE, 0,
084681d1 1542 NULL, 0, recursion_msg, printed_len);
32a76006 1543 }
1da177e4 1544
7ff9554b
KS
1545 /*
1546 * The printf needs to come first; we need the syslog
1547 * prefix which might be passed-in as a parameter.
1548 */
c313af14 1549 text_len = vscnprintf(text, sizeof(textbuf), fmt, args);
5fd29d6c 1550
7ff9554b 1551 /* mark and strip a trailing newline */
c313af14
KS
1552 if (text_len && text[text_len-1] == '\n') {
1553 text_len--;
5becfb1d 1554 lflags |= LOG_NEWLINE;
7ff9554b 1555 }
9d90c8d9 1556
088a52aa
JP
1557 /* strip kernel syslog prefix and extract log level or control flags */
1558 if (facility == 0) {
1559 int kern_level = printk_get_level(text);
1560
1561 if (kern_level) {
1562 const char *end_of_header = printk_skip_level(text);
1563 switch (kern_level) {
1564 case '0' ... '7':
1565 if (level == -1)
1566 level = kern_level - '0';
1567 case 'd': /* KERN_DEFAULT */
1568 lflags |= LOG_PREFIX;
1569 case 'c': /* KERN_CONT */
1570 break;
1571 }
1572 text_len -= end_of_header - text;
1573 text = (char *)end_of_header;
5fd29d6c
LT
1574 }
1575 }
1576
c313af14
KS
1577 if (level == -1)
1578 level = default_message_loglevel;
9d90c8d9 1579
5becfb1d
KS
1580 if (dict)
1581 lflags |= LOG_PREFIX|LOG_NEWLINE;
ac60ad74 1582
5becfb1d 1583 if (!(lflags & LOG_NEWLINE)) {
084681d1
KS
1584 /*
1585 * Flush the conflicting buffer. An earlier newline was missing,
1586 * or another task also prints continuation lines.
1587 */
5becfb1d 1588 if (cont.len && (lflags & LOG_PREFIX || cont.owner != current))
eab07260 1589 cont_flush(LOG_NEWLINE);
c313af14 1590
084681d1
KS
1591 /* buffer line if possible, otherwise store it right away */
1592 if (!cont_add(facility, level, text, text_len))
5becfb1d 1593 log_store(facility, level, lflags | LOG_CONT, 0,
084681d1 1594 dict, dictlen, text, text_len);
5c5d5ca5 1595 } else {
084681d1 1596 bool stored = false;
c313af14 1597
084681d1 1598 /*
d3620822
SR
1599 * If an earlier newline was missing and it was the same task,
1600 * either merge it with the current buffer and flush, or if
1601 * there was a race with interrupts (prefix == true) then just
1602 * flush it out and store this line separately.
084681d1 1603 */
084681d1 1604 if (cont.len && cont.owner == current) {
5becfb1d 1605 if (!(lflags & LOG_PREFIX))
d3620822 1606 stored = cont_add(facility, level, text, text_len);
eab07260 1607 cont_flush(LOG_NEWLINE);
c313af14 1608 }
084681d1
KS
1609
1610 if (!stored)
5becfb1d 1611 log_store(facility, level, lflags, 0,
084681d1 1612 dict, dictlen, text, text_len);
1da177e4 1613 }
084681d1 1614 printed_len += text_len;
1da177e4 1615
266c2e0a 1616 /*
7ff9554b
KS
1617 * Try to acquire and then immediately release the console semaphore.
1618 * The release will print out buffers and wake up /dev/kmsg and syslog()
1619 * users.
266c2e0a 1620 *
7ff9554b
KS
1621 * The console_trylock_for_printk() function will release 'logbuf_lock'
1622 * regardless of whether it actually gets the console semaphore or not.
266c2e0a 1623 */
ac751efa
TH
1624 if (console_trylock_for_printk(this_cpu))
1625 console_unlock();
76a8ad29 1626
266c2e0a 1627 lockdep_on();
32a76006 1628out_restore_irqs:
1a9a8aef 1629 local_irq_restore(flags);
76a8ad29 1630
1da177e4
LT
1631 return printed_len;
1632}
7ff9554b
KS
1633EXPORT_SYMBOL(vprintk_emit);
1634
1635asmlinkage int vprintk(const char *fmt, va_list args)
1636{
1637 return vprintk_emit(0, -1, NULL, 0, fmt, args);
1638}
1da177e4
LT
1639EXPORT_SYMBOL(vprintk);
1640
7ff9554b
KS
1641asmlinkage int printk_emit(int facility, int level,
1642 const char *dict, size_t dictlen,
1643 const char *fmt, ...)
1644{
1645 va_list args;
1646 int r;
1647
1648 va_start(args, fmt);
1649 r = vprintk_emit(facility, level, dict, dictlen, fmt, args);
1650 va_end(args);
1651
1652 return r;
1653}
1654EXPORT_SYMBOL(printk_emit);
1655
1656/**
1657 * printk - print a kernel message
1658 * @fmt: format string
1659 *
1660 * This is printk(). It can be called from any context. We want it to work.
1661 *
1662 * We try to grab the console_lock. If we succeed, it's easy - we log the
1663 * output and call the console drivers. If we fail to get the semaphore, we
1664 * place the output into the log buffer and return. The current holder of
1665 * the console_sem will notice the new output in console_unlock(); and will
1666 * send it to the consoles before releasing the lock.
1667 *
1668 * One effect of this deferred printing is that code which calls printk() and
1669 * then changes console_loglevel may break. This is because console_loglevel
1670 * is inspected when the actual printing occurs.
1671 *
1672 * See also:
1673 * printf(3)
1674 *
1675 * See the vsnprintf() documentation for format string extensions over C99.
1676 */
1677asmlinkage int printk(const char *fmt, ...)
1678{
1679 va_list args;
1680 int r;
1681
1682#ifdef CONFIG_KGDB_KDB
1683 if (unlikely(kdb_trap_printk)) {
1684 va_start(args, fmt);
1685 r = vkdb_printf(fmt, args);
1686 va_end(args);
1687 return r;
1688 }
1689#endif
1690 va_start(args, fmt);
1691 r = vprintk_emit(0, -1, NULL, 0, fmt, args);
1692 va_end(args);
1693
1694 return r;
1695}
1696EXPORT_SYMBOL(printk);
7f3a781d 1697
96efedf1 1698#else /* CONFIG_PRINTK */
d59745ce 1699
70498253
KS
1700#define LOG_LINE_MAX 0
1701#define PREFIX_MAX 0
7f3a781d 1702#define LOG_LINE_MAX 0
96efedf1
KS
1703static u64 syslog_seq;
1704static u32 syslog_idx;
eab07260
KS
1705static u64 console_seq;
1706static u32 console_idx;
96efedf1
KS
1707static enum log_flags syslog_prev;
1708static u64 log_first_seq;
1709static u32 log_first_idx;
1710static u64 log_next_seq;
eab07260 1711static enum log_flags console_prev;
084681d1
KS
1712static struct cont {
1713 size_t len;
1714 size_t cons;
1715 u8 level;
1716 bool flushed:1;
1717} cont;
7f3a781d
KS
1718static struct log *log_from_idx(u32 idx) { return NULL; }
1719static u32 log_next(u32 idx) { return 0; }
7f3a781d 1720static void call_console_drivers(int level, const char *text, size_t len) {}
5becfb1d
KS
1721static size_t msg_print_text(const struct log *msg, enum log_flags prev,
1722 bool syslog, char *buf, size_t size) { return 0; }
084681d1 1723static size_t cont_print_text(char *text, size_t size) { return 0; }
d59745ce 1724
7f3a781d 1725#endif /* CONFIG_PRINTK */
d59745ce 1726
f7511d5f
ST
1727static int __add_preferred_console(char *name, int idx, char *options,
1728 char *brl_options)
1729{
1730 struct console_cmdline *c;
1731 int i;
1732
1733 /*
1734 * See if this tty is not yet registered, and
1735 * if we have a slot free.
1736 */
1737 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
1738 if (strcmp(console_cmdline[i].name, name) == 0 &&
1739 console_cmdline[i].index == idx) {
1740 if (!brl_options)
1741 selected_console = i;
1742 return 0;
1743 }
1744 if (i == MAX_CMDLINECONSOLES)
1745 return -E2BIG;
1746 if (!brl_options)
1747 selected_console = i;
1748 c = &console_cmdline[i];
1749 strlcpy(c->name, name, sizeof(c->name));
1750 c->options = options;
1751#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1752 c->brl_options = brl_options;
1753#endif
1754 c->index = idx;
1755 return 0;
1756}
2ea1c539
JB
1757/*
1758 * Set up a list of consoles. Called from init/main.c
1759 */
1760static int __init console_setup(char *str)
1761{
eaa944af 1762 char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for index */
f7511d5f 1763 char *s, *options, *brl_options = NULL;
2ea1c539
JB
1764 int idx;
1765
f7511d5f
ST
1766#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1767 if (!memcmp(str, "brl,", 4)) {
1768 brl_options = "";
1769 str += 4;
1770 } else if (!memcmp(str, "brl=", 4)) {
1771 brl_options = str + 4;
1772 str = strchr(brl_options, ',');
1773 if (!str) {
1774 printk(KERN_ERR "need port name after brl=\n");
1775 return 1;
1776 }
1777 *(str++) = 0;
1778 }
1779#endif
1780
2ea1c539
JB
1781 /*
1782 * Decode str into name, index, options.
1783 */
1784 if (str[0] >= '0' && str[0] <= '9') {
eaa944af
YL
1785 strcpy(buf, "ttyS");
1786 strncpy(buf + 4, str, sizeof(buf) - 5);
2ea1c539 1787 } else {
eaa944af 1788 strncpy(buf, str, sizeof(buf) - 1);
2ea1c539 1789 }
eaa944af 1790 buf[sizeof(buf) - 1] = 0;
2ea1c539
JB
1791 if ((options = strchr(str, ',')) != NULL)
1792 *(options++) = 0;
1793#ifdef __sparc__
1794 if (!strcmp(str, "ttya"))
eaa944af 1795 strcpy(buf, "ttyS0");
2ea1c539 1796 if (!strcmp(str, "ttyb"))
eaa944af 1797 strcpy(buf, "ttyS1");
2ea1c539 1798#endif
eaa944af 1799 for (s = buf; *s; s++)
2ea1c539
JB
1800 if ((*s >= '0' && *s <= '9') || *s == ',')
1801 break;
1802 idx = simple_strtoul(s, NULL, 10);
1803 *s = 0;
1804
f7511d5f 1805 __add_preferred_console(buf, idx, options, brl_options);
9e124fe1 1806 console_set_on_cmdline = 1;
2ea1c539
JB
1807 return 1;
1808}
1809__setup("console=", console_setup);
1810
3c0547ba
MM
1811/**
1812 * add_preferred_console - add a device to the list of preferred consoles.
ddad86c2
MW
1813 * @name: device name
1814 * @idx: device index
1815 * @options: options for this console
3c0547ba
MM
1816 *
1817 * The last preferred console added will be used for kernel messages
1818 * and stdin/out/err for init. Normally this is used by console_setup
1819 * above to handle user-supplied console arguments; however it can also
1820 * be used by arch-specific code either to override the user or more
1821 * commonly to provide a default console (ie from PROM variables) when
1822 * the user has not supplied one.
1823 */
fb445ee5 1824int add_preferred_console(char *name, int idx, char *options)
3c0547ba 1825{
f7511d5f 1826 return __add_preferred_console(name, idx, options, NULL);
3c0547ba
MM
1827}
1828
b6b1d877 1829int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options)
18a8bd94
YL
1830{
1831 struct console_cmdline *c;
1832 int i;
1833
1834 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
1835 if (strcmp(console_cmdline[i].name, name) == 0 &&
1836 console_cmdline[i].index == idx) {
1837 c = &console_cmdline[i];
f735295b 1838 strlcpy(c->name, name_new, sizeof(c->name));
18a8bd94
YL
1839 c->name[sizeof(c->name) - 1] = 0;
1840 c->options = options;
1841 c->index = idx_new;
1842 return i;
1843 }
1844 /* not found */
1845 return -1;
1846}
1847
2329abfa 1848bool console_suspend_enabled = 1;
8f4ce8c3
AS
1849EXPORT_SYMBOL(console_suspend_enabled);
1850
1851static int __init console_suspend_disable(char *str)
1852{
1853 console_suspend_enabled = 0;
1854 return 1;
1855}
1856__setup("no_console_suspend", console_suspend_disable);
134620f7
YZ
1857module_param_named(console_suspend, console_suspend_enabled,
1858 bool, S_IRUGO | S_IWUSR);
1859MODULE_PARM_DESC(console_suspend, "suspend console during suspend"
1860 " and hibernate operations");
8f4ce8c3 1861
557240b4
LT
1862/**
1863 * suspend_console - suspend the console subsystem
1864 *
1865 * This disables printk() while we go into suspend states
1866 */
1867void suspend_console(void)
1868{
8f4ce8c3
AS
1869 if (!console_suspend_enabled)
1870 return;
0d63081d 1871 printk("Suspending console(s) (use no_console_suspend to debug)\n");
ac751efa 1872 console_lock();
557240b4 1873 console_suspended = 1;
403f3075 1874 up(&console_sem);
557240b4
LT
1875}
1876
1877void resume_console(void)
1878{
8f4ce8c3
AS
1879 if (!console_suspend_enabled)
1880 return;
403f3075 1881 down(&console_sem);
557240b4 1882 console_suspended = 0;
ac751efa 1883 console_unlock();
557240b4
LT
1884}
1885
034260d6
KC
1886/**
1887 * console_cpu_notify - print deferred console messages after CPU hotplug
1888 * @self: notifier struct
1889 * @action: CPU hotplug event
1890 * @hcpu: unused
1891 *
1892 * If printk() is called from a CPU that is not online yet, the messages
1893 * will be spooled but will not show up on the console. This function is
1894 * called when a new CPU comes online (or fails to come up), and ensures
1895 * that any such output gets printed.
1896 */
1897static int __cpuinit console_cpu_notify(struct notifier_block *self,
1898 unsigned long action, void *hcpu)
1899{
1900 switch (action) {
1901 case CPU_ONLINE:
1902 case CPU_DEAD:
034260d6
KC
1903 case CPU_DOWN_FAILED:
1904 case CPU_UP_CANCELED:
ac751efa
TH
1905 console_lock();
1906 console_unlock();
034260d6
KC
1907 }
1908 return NOTIFY_OK;
1909}
1910
1da177e4 1911/**
ac751efa 1912 * console_lock - lock the console system for exclusive use.
1da177e4 1913 *
ac751efa 1914 * Acquires a lock which guarantees that the caller has
1da177e4
LT
1915 * exclusive access to the console system and the console_drivers list.
1916 *
1917 * Can sleep, returns nothing.
1918 */
ac751efa 1919void console_lock(void)
1da177e4 1920{
6b898c07
DV
1921 might_sleep();
1922
1da177e4 1923 down(&console_sem);
403f3075
AH
1924 if (console_suspended)
1925 return;
1da177e4
LT
1926 console_locked = 1;
1927 console_may_schedule = 1;
daee7797 1928 mutex_acquire(&console_lock_dep_map, 0, 0, _RET_IP_);
1da177e4 1929}
ac751efa 1930EXPORT_SYMBOL(console_lock);
1da177e4 1931
ac751efa
TH
1932/**
1933 * console_trylock - try to lock the console system for exclusive use.
1934 *
1935 * Tried to acquire a lock which guarantees that the caller has
1936 * exclusive access to the console system and the console_drivers list.
1937 *
1938 * returns 1 on success, and 0 on failure to acquire the lock.
1939 */
1940int console_trylock(void)
1da177e4
LT
1941{
1942 if (down_trylock(&console_sem))
ac751efa 1943 return 0;
403f3075
AH
1944 if (console_suspended) {
1945 up(&console_sem);
ac751efa 1946 return 0;
403f3075 1947 }
1da177e4
LT
1948 console_locked = 1;
1949 console_may_schedule = 0;
daee7797 1950 mutex_acquire(&console_lock_dep_map, 0, 1, _RET_IP_);
ac751efa 1951 return 1;
1da177e4 1952}
ac751efa 1953EXPORT_SYMBOL(console_trylock);
1da177e4
LT
1954
1955int is_console_locked(void)
1956{
1957 return console_locked;
1958}
1da177e4 1959
3ccf3e83 1960/*
7ff9554b 1961 * Delayed printk version, for scheduler-internal messages:
3ccf3e83
PZ
1962 */
1963#define PRINTK_BUF_SIZE 512
1964
1965#define PRINTK_PENDING_WAKEUP 0x01
1966#define PRINTK_PENDING_SCHED 0x02
1967
b845b517 1968static DEFINE_PER_CPU(int, printk_pending);
3ccf3e83 1969static DEFINE_PER_CPU(char [PRINTK_BUF_SIZE], printk_sched_buf);
b845b517 1970
74876a98 1971static void wake_up_klogd_work_func(struct irq_work *irq_work)
e3e8a75d 1972{
74876a98
FW
1973 int pending = __this_cpu_xchg(printk_pending, 0);
1974
1975 if (pending & PRINTK_PENDING_SCHED) {
1976 char *buf = __get_cpu_var(printk_sched_buf);
1977 printk(KERN_WARNING "[sched_delayed] %s", buf);
b845b517 1978 }
b845b517 1979
74876a98
FW
1980 if (pending & PRINTK_PENDING_WAKEUP)
1981 wake_up_interruptible(&log_wait);
b845b517
PZ
1982}
1983
74876a98
FW
1984static DEFINE_PER_CPU(struct irq_work, wake_up_klogd_work) = {
1985 .func = wake_up_klogd_work_func,
1986 .flags = IRQ_WORK_LAZY,
1987};
1988
b845b517
PZ
1989void wake_up_klogd(void)
1990{
74876a98
FW
1991 preempt_disable();
1992 if (waitqueue_active(&log_wait)) {
3ccf3e83 1993 this_cpu_or(printk_pending, PRINTK_PENDING_WAKEUP);
74876a98
FW
1994 irq_work_queue(&__get_cpu_var(wake_up_klogd_work));
1995 }
1996 preempt_enable();
e3e8a75d
KK
1997}
1998
eab07260
KS
1999static void console_cont_flush(char *text, size_t size)
2000{
2001 unsigned long flags;
2002 size_t len;
2003
2004 raw_spin_lock_irqsave(&logbuf_lock, flags);
2005
2006 if (!cont.len)
2007 goto out;
2008
2009 /*
2010 * We still queue earlier records, likely because the console was
2011 * busy. The earlier ones need to be printed before this one, we
2012 * did not flush any fragment so far, so just let it queue up.
2013 */
2014 if (console_seq < log_next_seq && !cont.cons)
2015 goto out;
2016
2017 len = cont_print_text(text, size);
2018 raw_spin_unlock(&logbuf_lock);
2019 stop_critical_timings();
2020 call_console_drivers(cont.level, text, len);
2021 start_critical_timings();
2022 local_irq_restore(flags);
2023 return;
2024out:
2025 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2026}
7ff9554b 2027
1da177e4 2028/**
ac751efa 2029 * console_unlock - unlock the console system
1da177e4 2030 *
ac751efa 2031 * Releases the console_lock which the caller holds on the console system
1da177e4
LT
2032 * and the console driver list.
2033 *
ac751efa
TH
2034 * While the console_lock was held, console output may have been buffered
2035 * by printk(). If this is the case, console_unlock(); emits
2036 * the output prior to releasing the lock.
1da177e4 2037 *
7f3a781d 2038 * If there is output waiting, we wake /dev/kmsg and syslog() users.
1da177e4 2039 *
ac751efa 2040 * console_unlock(); may be called from any context.
1da177e4 2041 */
ac751efa 2042void console_unlock(void)
1da177e4 2043{
70498253 2044 static char text[LOG_LINE_MAX + PREFIX_MAX];
7ff9554b 2045 static u64 seen_seq;
1da177e4 2046 unsigned long flags;
7ff9554b
KS
2047 bool wake_klogd = false;
2048 bool retry;
1da177e4 2049
557240b4 2050 if (console_suspended) {
403f3075 2051 up(&console_sem);
557240b4
LT
2052 return;
2053 }
78944e54
AD
2054
2055 console_may_schedule = 0;
2056
084681d1 2057 /* flush buffered message fragment immediately to console */
eab07260 2058 console_cont_flush(text, sizeof(text));
4f2a8d3c 2059again:
7ff9554b
KS
2060 for (;;) {
2061 struct log *msg;
3ce9a7c0 2062 size_t len;
7ff9554b
KS
2063 int level;
2064
07354eb1 2065 raw_spin_lock_irqsave(&logbuf_lock, flags);
7ff9554b
KS
2066 if (seen_seq != log_next_seq) {
2067 wake_klogd = true;
2068 seen_seq = log_next_seq;
2069 }
2070
2071 if (console_seq < log_first_seq) {
2072 /* messages are gone, move to first one */
2073 console_seq = log_first_seq;
2074 console_idx = log_first_idx;
5becfb1d 2075 console_prev = 0;
7ff9554b 2076 }
084681d1 2077skip:
7ff9554b
KS
2078 if (console_seq == log_next_seq)
2079 break;
2080
2081 msg = log_from_idx(console_idx);
084681d1
KS
2082 if (msg->flags & LOG_NOCONS) {
2083 /*
2084 * Skip record we have buffered and already printed
2085 * directly to the console when we received it.
2086 */
2087 console_idx = log_next(console_idx);
2088 console_seq++;
68b6507d
KS
2089 /*
2090 * We will get here again when we register a new
2091 * CON_PRINTBUFFER console. Clear the flag so we
2092 * will properly dump everything later.
2093 */
2094 msg->flags &= ~LOG_NOCONS;
eab07260 2095 console_prev = msg->flags;
084681d1
KS
2096 goto skip;
2097 }
649e6ee3 2098
084681d1 2099 level = msg->level;
5becfb1d
KS
2100 len = msg_print_text(msg, console_prev, false,
2101 text, sizeof(text));
7ff9554b
KS
2102 console_idx = log_next(console_idx);
2103 console_seq++;
5becfb1d 2104 console_prev = msg->flags;
07354eb1 2105 raw_spin_unlock(&logbuf_lock);
7ff9554b 2106
81d68a96 2107 stop_critical_timings(); /* don't trace print latency */
7ff9554b 2108 call_console_drivers(level, text, len);
81d68a96 2109 start_critical_timings();
1da177e4
LT
2110 local_irq_restore(flags);
2111 }
2112 console_locked = 0;
daee7797 2113 mutex_release(&console_lock_dep_map, 1, _RET_IP_);
fe3d8ad3
FT
2114
2115 /* Release the exclusive_console once it is used */
2116 if (unlikely(exclusive_console))
2117 exclusive_console = NULL;
2118
07354eb1 2119 raw_spin_unlock(&logbuf_lock);
4f2a8d3c 2120
0b5e1c52 2121 up(&console_sem);
4f2a8d3c
PZ
2122
2123 /*
2124 * Someone could have filled up the buffer again, so re-check if there's
2125 * something to flush. In case we cannot trylock the console_sem again,
2126 * there's a new owner and the console_unlock() from them will do the
2127 * flush, no worries.
2128 */
07354eb1 2129 raw_spin_lock(&logbuf_lock);
7ff9554b 2130 retry = console_seq != log_next_seq;
09dc3cf9
PZ
2131 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2132
4f2a8d3c
PZ
2133 if (retry && console_trylock())
2134 goto again;
2135
e3e8a75d
KK
2136 if (wake_klogd)
2137 wake_up_klogd();
1da177e4 2138}
ac751efa 2139EXPORT_SYMBOL(console_unlock);
1da177e4 2140
ddad86c2
MW
2141/**
2142 * console_conditional_schedule - yield the CPU if required
1da177e4
LT
2143 *
2144 * If the console code is currently allowed to sleep, and
2145 * if this CPU should yield the CPU to another task, do
2146 * so here.
2147 *
ac751efa 2148 * Must be called within console_lock();.
1da177e4
LT
2149 */
2150void __sched console_conditional_schedule(void)
2151{
2152 if (console_may_schedule)
2153 cond_resched();
2154}
2155EXPORT_SYMBOL(console_conditional_schedule);
2156
1da177e4
LT
2157void console_unblank(void)
2158{
2159 struct console *c;
2160
2161 /*
2162 * console_unblank can no longer be called in interrupt context unless
2163 * oops_in_progress is set to 1..
2164 */
2165 if (oops_in_progress) {
2166 if (down_trylock(&console_sem) != 0)
2167 return;
2168 } else
ac751efa 2169 console_lock();
1da177e4
LT
2170
2171 console_locked = 1;
2172 console_may_schedule = 0;
4d091611 2173 for_each_console(c)
1da177e4
LT
2174 if ((c->flags & CON_ENABLED) && c->unblank)
2175 c->unblank();
ac751efa 2176 console_unlock();
1da177e4 2177}
1da177e4
LT
2178
2179/*
2180 * Return the console tty driver structure and its associated index
2181 */
2182struct tty_driver *console_device(int *index)
2183{
2184 struct console *c;
2185 struct tty_driver *driver = NULL;
2186
ac751efa 2187 console_lock();
4d091611 2188 for_each_console(c) {
1da177e4
LT
2189 if (!c->device)
2190 continue;
2191 driver = c->device(c, index);
2192 if (driver)
2193 break;
2194 }
ac751efa 2195 console_unlock();
1da177e4
LT
2196 return driver;
2197}
2198
2199/*
2200 * Prevent further output on the passed console device so that (for example)
2201 * serial drivers can disable console output before suspending a port, and can
2202 * re-enable output afterwards.
2203 */
2204void console_stop(struct console *console)
2205{
ac751efa 2206 console_lock();
1da177e4 2207 console->flags &= ~CON_ENABLED;
ac751efa 2208 console_unlock();
1da177e4
LT
2209}
2210EXPORT_SYMBOL(console_stop);
2211
2212void console_start(struct console *console)
2213{
ac751efa 2214 console_lock();
1da177e4 2215 console->flags |= CON_ENABLED;
ac751efa 2216 console_unlock();
1da177e4
LT
2217}
2218EXPORT_SYMBOL(console_start);
2219
7bf69395
FDN
2220static int __read_mostly keep_bootcon;
2221
2222static int __init keep_bootcon_setup(char *str)
2223{
2224 keep_bootcon = 1;
2225 printk(KERN_INFO "debug: skip boot console de-registration.\n");
2226
2227 return 0;
2228}
2229
2230early_param("keep_bootcon", keep_bootcon_setup);
2231
1da177e4
LT
2232/*
2233 * The console driver calls this routine during kernel initialization
2234 * to register the console printing procedure with printk() and to
2235 * print any messages that were printed by the kernel before the
2236 * console driver was initialized.
4d091611
RG
2237 *
2238 * This can happen pretty early during the boot process (because of
2239 * early_printk) - sometimes before setup_arch() completes - be careful
2240 * of what kernel features are used - they may not be initialised yet.
2241 *
2242 * There are two types of consoles - bootconsoles (early_printk) and
2243 * "real" consoles (everything which is not a bootconsole) which are
2244 * handled differently.
2245 * - Any number of bootconsoles can be registered at any time.
2246 * - As soon as a "real" console is registered, all bootconsoles
2247 * will be unregistered automatically.
2248 * - Once a "real" console is registered, any attempt to register a
2249 * bootconsoles will be rejected
1da177e4 2250 */
4d091611 2251void register_console(struct console *newcon)
1da177e4 2252{
40dc5651 2253 int i;
1da177e4 2254 unsigned long flags;
4d091611 2255 struct console *bcon = NULL;
1da177e4 2256
4d091611
RG
2257 /*
2258 * before we register a new CON_BOOT console, make sure we don't
2259 * already have a valid console
2260 */
2261 if (console_drivers && newcon->flags & CON_BOOT) {
2262 /* find the last or real console */
2263 for_each_console(bcon) {
2264 if (!(bcon->flags & CON_BOOT)) {
2265 printk(KERN_INFO "Too late to register bootconsole %s%d\n",
2266 newcon->name, newcon->index);
2267 return;
2268 }
2269 }
69331af7
GH
2270 }
2271
4d091611
RG
2272 if (console_drivers && console_drivers->flags & CON_BOOT)
2273 bcon = console_drivers;
2274
2275 if (preferred_console < 0 || bcon || !console_drivers)
1da177e4
LT
2276 preferred_console = selected_console;
2277
4d091611
RG
2278 if (newcon->early_setup)
2279 newcon->early_setup();
18a8bd94 2280
1da177e4
LT
2281 /*
2282 * See if we want to use this console driver. If we
2283 * didn't select a console we take the first one
2284 * that registers here.
2285 */
2286 if (preferred_console < 0) {
4d091611
RG
2287 if (newcon->index < 0)
2288 newcon->index = 0;
2289 if (newcon->setup == NULL ||
2290 newcon->setup(newcon, NULL) == 0) {
2291 newcon->flags |= CON_ENABLED;
2292 if (newcon->device) {
2293 newcon->flags |= CON_CONSDEV;
cd3a1b85
JK
2294 preferred_console = 0;
2295 }
1da177e4
LT
2296 }
2297 }
2298
2299 /*
2300 * See if this console matches one we selected on
2301 * the command line.
2302 */
40dc5651
JJ
2303 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0];
2304 i++) {
4d091611 2305 if (strcmp(console_cmdline[i].name, newcon->name) != 0)
1da177e4 2306 continue;
4d091611
RG
2307 if (newcon->index >= 0 &&
2308 newcon->index != console_cmdline[i].index)
1da177e4 2309 continue;
4d091611
RG
2310 if (newcon->index < 0)
2311 newcon->index = console_cmdline[i].index;
f7511d5f
ST
2312#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
2313 if (console_cmdline[i].brl_options) {
4d091611
RG
2314 newcon->flags |= CON_BRL;
2315 braille_register_console(newcon,
f7511d5f
ST
2316 console_cmdline[i].index,
2317 console_cmdline[i].options,
2318 console_cmdline[i].brl_options);
2319 return;
2320 }
2321#endif
4d091611
RG
2322 if (newcon->setup &&
2323 newcon->setup(newcon, console_cmdline[i].options) != 0)
1da177e4 2324 break;
4d091611
RG
2325 newcon->flags |= CON_ENABLED;
2326 newcon->index = console_cmdline[i].index;
ab4af03a 2327 if (i == selected_console) {
4d091611 2328 newcon->flags |= CON_CONSDEV;
ab4af03a
GE
2329 preferred_console = selected_console;
2330 }
1da177e4
LT
2331 break;
2332 }
2333
4d091611 2334 if (!(newcon->flags & CON_ENABLED))
1da177e4
LT
2335 return;
2336
8259cf43
RG
2337 /*
2338 * If we have a bootconsole, and are switching to a real console,
2339 * don't print everything out again, since when the boot console, and
2340 * the real console are the same physical device, it's annoying to
2341 * see the beginning boot messages twice
2342 */
2343 if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
4d091611 2344 newcon->flags &= ~CON_PRINTBUFFER;
1da177e4
LT
2345
2346 /*
2347 * Put this console in the list - keep the
2348 * preferred driver at the head of the list.
2349 */
ac751efa 2350 console_lock();
4d091611
RG
2351 if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
2352 newcon->next = console_drivers;
2353 console_drivers = newcon;
2354 if (newcon->next)
2355 newcon->next->flags &= ~CON_CONSDEV;
1da177e4 2356 } else {
4d091611
RG
2357 newcon->next = console_drivers->next;
2358 console_drivers->next = newcon;
1da177e4 2359 }
4d091611 2360 if (newcon->flags & CON_PRINTBUFFER) {
1da177e4 2361 /*
ac751efa 2362 * console_unlock(); will print out the buffered messages
1da177e4
LT
2363 * for us.
2364 */
07354eb1 2365 raw_spin_lock_irqsave(&logbuf_lock, flags);
7ff9554b
KS
2366 console_seq = syslog_seq;
2367 console_idx = syslog_idx;
5becfb1d 2368 console_prev = syslog_prev;
07354eb1 2369 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
fe3d8ad3
FT
2370 /*
2371 * We're about to replay the log buffer. Only do this to the
2372 * just-registered console to avoid excessive message spam to
2373 * the already-registered consoles.
2374 */
2375 exclusive_console = newcon;
1da177e4 2376 }
ac751efa 2377 console_unlock();
fbc92a34 2378 console_sysfs_notify();
8259cf43
RG
2379
2380 /*
2381 * By unregistering the bootconsoles after we enable the real console
2382 * we get the "console xxx enabled" message on all the consoles -
2383 * boot consoles, real consoles, etc - this is to ensure that end
2384 * users know there might be something in the kernel's log buffer that
2385 * went to the bootconsole (that they do not see on the real console)
2386 */
7bf69395
FDN
2387 if (bcon &&
2388 ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
2389 !keep_bootcon) {
8259cf43
RG
2390 /* we need to iterate through twice, to make sure we print
2391 * everything out, before we unregister the console(s)
2392 */
2393 printk(KERN_INFO "console [%s%d] enabled, bootconsole disabled\n",
2394 newcon->name, newcon->index);
2395 for_each_console(bcon)
2396 if (bcon->flags & CON_BOOT)
2397 unregister_console(bcon);
2398 } else {
2399 printk(KERN_INFO "%sconsole [%s%d] enabled\n",
2400 (newcon->flags & CON_BOOT) ? "boot" : "" ,
2401 newcon->name, newcon->index);
2402 }
1da177e4
LT
2403}
2404EXPORT_SYMBOL(register_console);
2405
40dc5651 2406int unregister_console(struct console *console)
1da177e4 2407{
40dc5651 2408 struct console *a, *b;
1da177e4
LT
2409 int res = 1;
2410
f7511d5f
ST
2411#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
2412 if (console->flags & CON_BRL)
2413 return braille_unregister_console(console);
2414#endif
2415
ac751efa 2416 console_lock();
1da177e4
LT
2417 if (console_drivers == console) {
2418 console_drivers=console->next;
2419 res = 0;
e9b15b54 2420 } else if (console_drivers) {
1da177e4
LT
2421 for (a=console_drivers->next, b=console_drivers ;
2422 a; b=a, a=b->next) {
2423 if (a == console) {
2424 b->next = a->next;
2425 res = 0;
2426 break;
40dc5651 2427 }
1da177e4
LT
2428 }
2429 }
40dc5651 2430
69331af7 2431 /*
ab4af03a
GE
2432 * If this isn't the last console and it has CON_CONSDEV set, we
2433 * need to set it on the next preferred console.
1da177e4 2434 */
69331af7 2435 if (console_drivers != NULL && console->flags & CON_CONSDEV)
ab4af03a 2436 console_drivers->flags |= CON_CONSDEV;
1da177e4 2437
ac751efa 2438 console_unlock();
fbc92a34 2439 console_sysfs_notify();
1da177e4
LT
2440 return res;
2441}
2442EXPORT_SYMBOL(unregister_console);
d59745ce 2443
034260d6 2444static int __init printk_late_init(void)
0c5564bd 2445{
4d091611
RG
2446 struct console *con;
2447
2448 for_each_console(con) {
4c30c6f5 2449 if (!keep_bootcon && con->flags & CON_BOOT) {
cb00e99c 2450 printk(KERN_INFO "turn off boot console %s%d\n",
4d091611 2451 con->name, con->index);
42c2c8c8 2452 unregister_console(con);
cb00e99c 2453 }
0c5564bd 2454 }
034260d6 2455 hotcpu_notifier(console_cpu_notify, 0);
0c5564bd
RG
2456 return 0;
2457}
034260d6 2458late_initcall(printk_late_init);
0c5564bd 2459
7ef3d2fd 2460#if defined CONFIG_PRINTK
717115e1 2461
600e1458
PZ
2462int printk_sched(const char *fmt, ...)
2463{
2464 unsigned long flags;
2465 va_list args;
2466 char *buf;
2467 int r;
2468
2469 local_irq_save(flags);
2470 buf = __get_cpu_var(printk_sched_buf);
2471
2472 va_start(args, fmt);
2473 r = vsnprintf(buf, PRINTK_BUF_SIZE, fmt, args);
2474 va_end(args);
2475
2476 __this_cpu_or(printk_pending, PRINTK_PENDING_SCHED);
74876a98 2477 irq_work_queue(&__get_cpu_var(wake_up_klogd_work));
600e1458
PZ
2478 local_irq_restore(flags);
2479
2480 return r;
2481}
2482
1da177e4
LT
2483/*
2484 * printk rate limiting, lifted from the networking subsystem.
2485 *
641de9d8
UKK
2486 * This enforces a rate limit: not more than 10 kernel messages
2487 * every 5s to make a denial-of-service attack impossible.
1da177e4 2488 */
641de9d8
UKK
2489DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
2490
5c828713 2491int __printk_ratelimit(const char *func)
1da177e4 2492{
5c828713 2493 return ___ratelimit(&printk_ratelimit_state, func);
1da177e4 2494}
5c828713 2495EXPORT_SYMBOL(__printk_ratelimit);
f46c4833
AM
2496
2497/**
2498 * printk_timed_ratelimit - caller-controlled printk ratelimiting
2499 * @caller_jiffies: pointer to caller's state
2500 * @interval_msecs: minimum interval between prints
2501 *
2502 * printk_timed_ratelimit() returns true if more than @interval_msecs
2503 * milliseconds have elapsed since the last time printk_timed_ratelimit()
2504 * returned true.
2505 */
2506bool printk_timed_ratelimit(unsigned long *caller_jiffies,
2507 unsigned int interval_msecs)
2508{
f2d28a2e
GK
2509 if (*caller_jiffies == 0
2510 || !time_in_range(jiffies, *caller_jiffies,
2511 *caller_jiffies
2512 + msecs_to_jiffies(interval_msecs))) {
2513 *caller_jiffies = jiffies;
f46c4833
AM
2514 return true;
2515 }
2516 return false;
2517}
2518EXPORT_SYMBOL(printk_timed_ratelimit);
456b565c
SK
2519
2520static DEFINE_SPINLOCK(dump_list_lock);
2521static LIST_HEAD(dump_list);
2522
2523/**
2524 * kmsg_dump_register - register a kernel log dumper.
6485536b 2525 * @dumper: pointer to the kmsg_dumper structure
456b565c
SK
2526 *
2527 * Adds a kernel log dumper to the system. The dump callback in the
2528 * structure will be called when the kernel oopses or panics and must be
2529 * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
2530 */
2531int kmsg_dump_register(struct kmsg_dumper *dumper)
2532{
2533 unsigned long flags;
2534 int err = -EBUSY;
2535
2536 /* The dump callback needs to be set */
2537 if (!dumper->dump)
2538 return -EINVAL;
2539
2540 spin_lock_irqsave(&dump_list_lock, flags);
2541 /* Don't allow registering multiple times */
2542 if (!dumper->registered) {
2543 dumper->registered = 1;
fb842b00 2544 list_add_tail_rcu(&dumper->list, &dump_list);
456b565c
SK
2545 err = 0;
2546 }
2547 spin_unlock_irqrestore(&dump_list_lock, flags);
2548
2549 return err;
2550}
2551EXPORT_SYMBOL_GPL(kmsg_dump_register);
2552
2553/**
2554 * kmsg_dump_unregister - unregister a kmsg dumper.
6485536b 2555 * @dumper: pointer to the kmsg_dumper structure
456b565c
SK
2556 *
2557 * Removes a dump device from the system. Returns zero on success and
2558 * %-EINVAL otherwise.
2559 */
2560int kmsg_dump_unregister(struct kmsg_dumper *dumper)
2561{
2562 unsigned long flags;
2563 int err = -EINVAL;
2564
2565 spin_lock_irqsave(&dump_list_lock, flags);
2566 if (dumper->registered) {
2567 dumper->registered = 0;
fb842b00 2568 list_del_rcu(&dumper->list);
456b565c
SK
2569 err = 0;
2570 }
2571 spin_unlock_irqrestore(&dump_list_lock, flags);
fb842b00 2572 synchronize_rcu();
456b565c
SK
2573
2574 return err;
2575}
2576EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
2577
7ff9554b
KS
2578static bool always_kmsg_dump;
2579module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);
2580
456b565c
SK
2581/**
2582 * kmsg_dump - dump kernel log to kernel message dumpers.
2583 * @reason: the reason (oops, panic etc) for dumping
2584 *
e2ae715d
KS
2585 * Call each of the registered dumper's dump() callback, which can
2586 * retrieve the kmsg records with kmsg_dump_get_line() or
2587 * kmsg_dump_get_buffer().
456b565c
SK
2588 */
2589void kmsg_dump(enum kmsg_dump_reason reason)
2590{
456b565c 2591 struct kmsg_dumper *dumper;
456b565c
SK
2592 unsigned long flags;
2593
c22ab332
MG
2594 if ((reason > KMSG_DUMP_OOPS) && !always_kmsg_dump)
2595 return;
2596
e2ae715d
KS
2597 rcu_read_lock();
2598 list_for_each_entry_rcu(dumper, &dump_list, list) {
2599 if (dumper->max_reason && reason > dumper->max_reason)
2600 continue;
2601
2602 /* initialize iterator with data about the stored records */
2603 dumper->active = true;
2604
2605 raw_spin_lock_irqsave(&logbuf_lock, flags);
2606 dumper->cur_seq = clear_seq;
2607 dumper->cur_idx = clear_idx;
2608 dumper->next_seq = log_next_seq;
2609 dumper->next_idx = log_next_idx;
2610 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2611
2612 /* invoke dumper which will iterate over records */
2613 dumper->dump(dumper, reason);
2614
2615 /* reset iterator */
2616 dumper->active = false;
2617 }
2618 rcu_read_unlock();
2619}
2620
2621/**
533827c9 2622 * kmsg_dump_get_line_nolock - retrieve one kmsg log line (unlocked version)
e2ae715d
KS
2623 * @dumper: registered kmsg dumper
2624 * @syslog: include the "<4>" prefixes
2625 * @line: buffer to copy the line to
2626 * @size: maximum size of the buffer
2627 * @len: length of line placed into buffer
2628 *
2629 * Start at the beginning of the kmsg buffer, with the oldest kmsg
2630 * record, and copy one record into the provided buffer.
2631 *
2632 * Consecutive calls will return the next available record moving
2633 * towards the end of the buffer with the youngest messages.
2634 *
2635 * A return value of FALSE indicates that there are no more records to
2636 * read.
533827c9
AV
2637 *
2638 * The function is similar to kmsg_dump_get_line(), but grabs no locks.
e2ae715d 2639 */
533827c9
AV
2640bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper, bool syslog,
2641 char *line, size_t size, size_t *len)
e2ae715d 2642{
e2ae715d
KS
2643 struct log *msg;
2644 size_t l = 0;
2645 bool ret = false;
2646
2647 if (!dumper->active)
2648 goto out;
7ff9554b 2649
e2ae715d
KS
2650 if (dumper->cur_seq < log_first_seq) {
2651 /* messages are gone, move to first available one */
2652 dumper->cur_seq = log_first_seq;
2653 dumper->cur_idx = log_first_idx;
2654 }
456b565c 2655
e2ae715d 2656 /* last entry */
533827c9 2657 if (dumper->cur_seq >= log_next_seq)
e2ae715d 2658 goto out;
456b565c 2659
e2ae715d 2660 msg = log_from_idx(dumper->cur_idx);
5becfb1d 2661 l = msg_print_text(msg, 0, syslog, line, size);
e2ae715d
KS
2662
2663 dumper->cur_idx = log_next(dumper->cur_idx);
2664 dumper->cur_seq++;
2665 ret = true;
e2ae715d
KS
2666out:
2667 if (len)
2668 *len = l;
2669 return ret;
2670}
533827c9
AV
2671
2672/**
2673 * kmsg_dump_get_line - retrieve one kmsg log line
2674 * @dumper: registered kmsg dumper
2675 * @syslog: include the "<4>" prefixes
2676 * @line: buffer to copy the line to
2677 * @size: maximum size of the buffer
2678 * @len: length of line placed into buffer
2679 *
2680 * Start at the beginning of the kmsg buffer, with the oldest kmsg
2681 * record, and copy one record into the provided buffer.
2682 *
2683 * Consecutive calls will return the next available record moving
2684 * towards the end of the buffer with the youngest messages.
2685 *
2686 * A return value of FALSE indicates that there are no more records to
2687 * read.
2688 */
2689bool kmsg_dump_get_line(struct kmsg_dumper *dumper, bool syslog,
2690 char *line, size_t size, size_t *len)
2691{
2692 unsigned long flags;
2693 bool ret;
2694
2695 raw_spin_lock_irqsave(&logbuf_lock, flags);
2696 ret = kmsg_dump_get_line_nolock(dumper, syslog, line, size, len);
2697 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2698
2699 return ret;
2700}
e2ae715d
KS
2701EXPORT_SYMBOL_GPL(kmsg_dump_get_line);
2702
2703/**
2704 * kmsg_dump_get_buffer - copy kmsg log lines
2705 * @dumper: registered kmsg dumper
2706 * @syslog: include the "<4>" prefixes
4f0f4af5 2707 * @buf: buffer to copy the line to
e2ae715d
KS
2708 * @size: maximum size of the buffer
2709 * @len: length of line placed into buffer
2710 *
2711 * Start at the end of the kmsg buffer and fill the provided buffer
2712 * with as many of the the *youngest* kmsg records that fit into it.
2713 * If the buffer is large enough, all available kmsg records will be
2714 * copied with a single call.
2715 *
2716 * Consecutive calls will fill the buffer with the next block of
2717 * available older records, not including the earlier retrieved ones.
2718 *
2719 * A return value of FALSE indicates that there are no more records to
2720 * read.
2721 */
2722bool kmsg_dump_get_buffer(struct kmsg_dumper *dumper, bool syslog,
2723 char *buf, size_t size, size_t *len)
2724{
2725 unsigned long flags;
2726 u64 seq;
2727 u32 idx;
2728 u64 next_seq;
2729 u32 next_idx;
5becfb1d 2730 enum log_flags prev;
e2ae715d
KS
2731 size_t l = 0;
2732 bool ret = false;
2733
2734 if (!dumper->active)
2735 goto out;
2736
2737 raw_spin_lock_irqsave(&logbuf_lock, flags);
2738 if (dumper->cur_seq < log_first_seq) {
2739 /* messages are gone, move to first available one */
2740 dumper->cur_seq = log_first_seq;
2741 dumper->cur_idx = log_first_idx;
2742 }
2743
2744 /* last entry */
2745 if (dumper->cur_seq >= dumper->next_seq) {
2746 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2747 goto out;
2748 }
2749
2750 /* calculate length of entire buffer */
2751 seq = dumper->cur_seq;
2752 idx = dumper->cur_idx;
5becfb1d 2753 prev = 0;
e2ae715d
KS
2754 while (seq < dumper->next_seq) {
2755 struct log *msg = log_from_idx(idx);
2756
5becfb1d 2757 l += msg_print_text(msg, prev, true, NULL, 0);
e2ae715d
KS
2758 idx = log_next(idx);
2759 seq++;
5becfb1d 2760 prev = msg->flags;
e2ae715d
KS
2761 }
2762
2763 /* move first record forward until length fits into the buffer */
2764 seq = dumper->cur_seq;
2765 idx = dumper->cur_idx;
5becfb1d 2766 prev = 0;
e2ae715d
KS
2767 while (l > size && seq < dumper->next_seq) {
2768 struct log *msg = log_from_idx(idx);
456b565c 2769
5becfb1d 2770 l -= msg_print_text(msg, prev, true, NULL, 0);
e2ae715d
KS
2771 idx = log_next(idx);
2772 seq++;
5becfb1d 2773 prev = msg->flags;
456b565c 2774 }
e2ae715d
KS
2775
2776 /* last message in next interation */
2777 next_seq = seq;
2778 next_idx = idx;
2779
2780 l = 0;
5becfb1d 2781 prev = 0;
e2ae715d
KS
2782 while (seq < dumper->next_seq) {
2783 struct log *msg = log_from_idx(idx);
2784
5becfb1d 2785 l += msg_print_text(msg, prev, syslog, buf + l, size - l);
e2ae715d
KS
2786 idx = log_next(idx);
2787 seq++;
5becfb1d 2788 prev = msg->flags;
e2ae715d
KS
2789 }
2790
2791 dumper->next_seq = next_seq;
2792 dumper->next_idx = next_idx;
2793 ret = true;
7ff9554b 2794 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
e2ae715d
KS
2795out:
2796 if (len)
2797 *len = l;
2798 return ret;
2799}
2800EXPORT_SYMBOL_GPL(kmsg_dump_get_buffer);
456b565c 2801
533827c9
AV
2802/**
2803 * kmsg_dump_rewind_nolock - reset the interator (unlocked version)
2804 * @dumper: registered kmsg dumper
2805 *
2806 * Reset the dumper's iterator so that kmsg_dump_get_line() and
2807 * kmsg_dump_get_buffer() can be called again and used multiple
2808 * times within the same dumper.dump() callback.
2809 *
2810 * The function is similar to kmsg_dump_rewind(), but grabs no locks.
2811 */
2812void kmsg_dump_rewind_nolock(struct kmsg_dumper *dumper)
2813{
2814 dumper->cur_seq = clear_seq;
2815 dumper->cur_idx = clear_idx;
2816 dumper->next_seq = log_next_seq;
2817 dumper->next_idx = log_next_idx;
2818}
2819
e2ae715d
KS
2820/**
2821 * kmsg_dump_rewind - reset the interator
2822 * @dumper: registered kmsg dumper
2823 *
2824 * Reset the dumper's iterator so that kmsg_dump_get_line() and
2825 * kmsg_dump_get_buffer() can be called again and used multiple
2826 * times within the same dumper.dump() callback.
2827 */
2828void kmsg_dump_rewind(struct kmsg_dumper *dumper)
2829{
2830 unsigned long flags;
2831
2832 raw_spin_lock_irqsave(&logbuf_lock, flags);
533827c9 2833 kmsg_dump_rewind_nolock(dumper);
e2ae715d 2834 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
456b565c 2835}
e2ae715d 2836EXPORT_SYMBOL_GPL(kmsg_dump_rewind);
7ef3d2fd 2837#endif