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