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