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