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