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