• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  *  linux/kernel/printk.c
4  *
5  *  Copyright (C) 1991, 1992  Linus Torvalds
6  *
7  * Modified to make sys_syslog() more flexible: added commands to
8  * return the last 4k of kernel messages, regardless of whether
9  * they've been read or not.  Added option to suppress kernel printk's
10  * to the console.  Added hook for sending the console messages
11  * elsewhere, in preparation for a serial line console (someday).
12  * Ted Ts'o, 2/11/93.
13  * Modified for sysctl support, 1/8/97, Chris Horn.
14  * Fixed SMP synchronization, 08/08/99, Manfred Spraul
15  *     manfred@colorfullife.com
16  * Rewrote bits to get rid of console_lock
17  *	01Mar01 Andrew Morton
18  */
19 
20 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
21 
22 #include <linux/kernel.h>
23 #include <linux/mm.h>
24 #include <linux/tty.h>
25 #include <linux/tty_driver.h>
26 #include <linux/console.h>
27 #include <linux/init.h>
28 #include <linux/jiffies.h>
29 #include <linux/nmi.h>
30 #include <linux/module.h>
31 #include <linux/moduleparam.h>
32 #include <linux/delay.h>
33 #include <linux/smp.h>
34 #include <linux/security.h>
35 #include <linux/memblock.h>
36 #include <linux/syscalls.h>
37 #include <linux/crash_core.h>
38 #include <linux/ratelimit.h>
39 #include <linux/kmsg_dump.h>
40 #include <linux/syslog.h>
41 #include <linux/cpu.h>
42 #include <linux/rculist.h>
43 #include <linux/poll.h>
44 #include <linux/irq_work.h>
45 #include <linux/ctype.h>
46 #include <linux/uio.h>
47 #include <linux/sched/clock.h>
48 #include <linux/sched/debug.h>
49 #include <linux/sched/task_stack.h>
50 
51 #include <linux/uaccess.h>
52 #include <asm/sections.h>
53 
54 #include <trace/events/initcall.h>
55 #define CREATE_TRACE_POINTS
56 #include <trace/events/printk.h>
57 
58 #include "printk_ringbuffer.h"
59 #include "console_cmdline.h"
60 #include "braille.h"
61 #include "internal.h"
62 
63 int console_printk[4] = {
64 	CONSOLE_LOGLEVEL_DEFAULT,	/* console_loglevel */
65 	MESSAGE_LOGLEVEL_DEFAULT,	/* default_message_loglevel */
66 	CONSOLE_LOGLEVEL_MIN,		/* minimum_console_loglevel */
67 	CONSOLE_LOGLEVEL_DEFAULT,	/* default_console_loglevel */
68 };
69 EXPORT_SYMBOL_GPL(console_printk);
70 
71 atomic_t ignore_console_lock_warning __read_mostly = ATOMIC_INIT(0);
72 EXPORT_SYMBOL(ignore_console_lock_warning);
73 
74 /*
75  * Low level drivers may need that to know if they can schedule in
76  * their unblank() callback or not. So let's export it.
77  */
78 int oops_in_progress;
79 EXPORT_SYMBOL(oops_in_progress);
80 
81 /*
82  * console_sem protects the console_drivers list, and also
83  * provides serialisation for access to the entire console
84  * driver system.
85  */
86 static DEFINE_SEMAPHORE(console_sem);
87 struct console *console_drivers;
88 EXPORT_SYMBOL_GPL(console_drivers);
89 
90 /*
91  * System may need to suppress printk message under certain
92  * circumstances, like after kernel panic happens.
93  */
94 int __read_mostly suppress_printk;
95 
96 #ifdef CONFIG_LOCKDEP
97 static struct lockdep_map console_lock_dep_map = {
98 	.name = "console_lock"
99 };
100 #endif
101 
102 enum devkmsg_log_bits {
103 	__DEVKMSG_LOG_BIT_ON = 0,
104 	__DEVKMSG_LOG_BIT_OFF,
105 	__DEVKMSG_LOG_BIT_LOCK,
106 };
107 
108 enum devkmsg_log_masks {
109 	DEVKMSG_LOG_MASK_ON             = BIT(__DEVKMSG_LOG_BIT_ON),
110 	DEVKMSG_LOG_MASK_OFF            = BIT(__DEVKMSG_LOG_BIT_OFF),
111 	DEVKMSG_LOG_MASK_LOCK           = BIT(__DEVKMSG_LOG_BIT_LOCK),
112 };
113 
114 /* Keep both the 'on' and 'off' bits clear, i.e. ratelimit by default: */
115 #define DEVKMSG_LOG_MASK_DEFAULT	0
116 
117 static unsigned int __read_mostly devkmsg_log = DEVKMSG_LOG_MASK_DEFAULT;
118 
__control_devkmsg(char * str)119 static int __control_devkmsg(char *str)
120 {
121 	size_t len;
122 
123 	if (!str)
124 		return -EINVAL;
125 
126 	len = str_has_prefix(str, "on");
127 	if (len) {
128 		devkmsg_log = DEVKMSG_LOG_MASK_ON;
129 		return len;
130 	}
131 
132 	len = str_has_prefix(str, "off");
133 	if (len) {
134 		devkmsg_log = DEVKMSG_LOG_MASK_OFF;
135 		return len;
136 	}
137 
138 	len = str_has_prefix(str, "ratelimit");
139 	if (len) {
140 		devkmsg_log = DEVKMSG_LOG_MASK_DEFAULT;
141 		return len;
142 	}
143 
144 	return -EINVAL;
145 }
146 
control_devkmsg(char * str)147 static int __init control_devkmsg(char *str)
148 {
149 	if (__control_devkmsg(str) < 0)
150 		return 1;
151 
152 	/*
153 	 * Set sysctl string accordingly:
154 	 */
155 	if (devkmsg_log == DEVKMSG_LOG_MASK_ON)
156 		strcpy(devkmsg_log_str, "on");
157 	else if (devkmsg_log == DEVKMSG_LOG_MASK_OFF)
158 		strcpy(devkmsg_log_str, "off");
159 	/* else "ratelimit" which is set by default. */
160 
161 	/*
162 	 * Sysctl cannot change it anymore. The kernel command line setting of
163 	 * this parameter is to force the setting to be permanent throughout the
164 	 * runtime of the system. This is a precation measure against userspace
165 	 * trying to be a smarta** and attempting to change it up on us.
166 	 */
167 	devkmsg_log |= DEVKMSG_LOG_MASK_LOCK;
168 
169 	return 0;
170 }
171 __setup("printk.devkmsg=", control_devkmsg);
172 
173 char devkmsg_log_str[DEVKMSG_STR_MAX_SIZE] = "ratelimit";
174 
devkmsg_sysctl_set_loglvl(struct ctl_table * table,int write,void * buffer,size_t * lenp,loff_t * ppos)175 int devkmsg_sysctl_set_loglvl(struct ctl_table *table, int write,
176 			      void *buffer, size_t *lenp, loff_t *ppos)
177 {
178 	char old_str[DEVKMSG_STR_MAX_SIZE];
179 	unsigned int old;
180 	int err;
181 
182 	if (write) {
183 		if (devkmsg_log & DEVKMSG_LOG_MASK_LOCK)
184 			return -EINVAL;
185 
186 		old = devkmsg_log;
187 		strncpy(old_str, devkmsg_log_str, DEVKMSG_STR_MAX_SIZE);
188 	}
189 
190 	err = proc_dostring(table, write, buffer, lenp, ppos);
191 	if (err)
192 		return err;
193 
194 	if (write) {
195 		err = __control_devkmsg(devkmsg_log_str);
196 
197 		/*
198 		 * Do not accept an unknown string OR a known string with
199 		 * trailing crap...
200 		 */
201 		if (err < 0 || (err + 1 != *lenp)) {
202 
203 			/* ... and restore old setting. */
204 			devkmsg_log = old;
205 			strncpy(devkmsg_log_str, old_str, DEVKMSG_STR_MAX_SIZE);
206 
207 			return -EINVAL;
208 		}
209 	}
210 
211 	return 0;
212 }
213 
214 /* Number of registered extended console drivers. */
215 static int nr_ext_console_drivers;
216 
217 /*
218  * Helper macros to handle lockdep when locking/unlocking console_sem. We use
219  * macros instead of functions so that _RET_IP_ contains useful information.
220  */
221 #define down_console_sem() do { \
222 	down(&console_sem);\
223 	mutex_acquire(&console_lock_dep_map, 0, 0, _RET_IP_);\
224 } while (0)
225 
__down_trylock_console_sem(unsigned long ip)226 static int __down_trylock_console_sem(unsigned long ip)
227 {
228 	int lock_failed;
229 	unsigned long flags;
230 
231 	/*
232 	 * Here and in __up_console_sem() we need to be in safe mode,
233 	 * because spindump/WARN/etc from under console ->lock will
234 	 * deadlock in printk()->down_trylock_console_sem() otherwise.
235 	 */
236 	printk_safe_enter_irqsave(flags);
237 	lock_failed = down_trylock(&console_sem);
238 	printk_safe_exit_irqrestore(flags);
239 
240 	if (lock_failed)
241 		return 1;
242 	mutex_acquire(&console_lock_dep_map, 0, 1, ip);
243 	return 0;
244 }
245 #define down_trylock_console_sem() __down_trylock_console_sem(_RET_IP_)
246 
__up_console_sem(unsigned long ip)247 static void __up_console_sem(unsigned long ip)
248 {
249 	unsigned long flags;
250 
251 	mutex_release(&console_lock_dep_map, ip);
252 
253 	printk_safe_enter_irqsave(flags);
254 	up(&console_sem);
255 	printk_safe_exit_irqrestore(flags);
256 }
257 #define up_console_sem() __up_console_sem(_RET_IP_)
258 
259 /*
260  * This is used for debugging the mess that is the VT code by
261  * keeping track if we have the console semaphore held. It's
262  * definitely not the perfect debug tool (we don't know if _WE_
263  * hold it and are racing, but it helps tracking those weird code
264  * paths in the console code where we end up in places I want
265  * locked without the console sempahore held).
266  */
267 static int console_locked, console_suspended;
268 
269 /*
270  * If exclusive_console is non-NULL then only this console is to be printed to.
271  */
272 static struct console *exclusive_console;
273 
274 /*
275  *	Array of consoles built from command line options (console=)
276  */
277 
278 #define MAX_CMDLINECONSOLES 8
279 
280 static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
281 
282 static int preferred_console = -1;
283 static bool has_preferred_console;
284 int console_set_on_cmdline;
285 EXPORT_SYMBOL(console_set_on_cmdline);
286 
287 /* Flag: console code may call schedule() */
288 static int console_may_schedule;
289 
290 enum con_msg_format_flags {
291 	MSG_FORMAT_DEFAULT	= 0,
292 	MSG_FORMAT_SYSLOG	= (1 << 0),
293 };
294 
295 static int console_msg_format = MSG_FORMAT_DEFAULT;
296 
297 /*
298  * The printk log buffer consists of a sequenced collection of records, each
299  * containing variable length message text. Every record also contains its
300  * own meta-data (@info).
301  *
302  * Every record meta-data carries the timestamp in microseconds, as well as
303  * the standard userspace syslog level and syslog facility. The usual kernel
304  * messages use LOG_KERN; userspace-injected messages always carry a matching
305  * syslog facility, by default LOG_USER. The origin of every message can be
306  * reliably determined that way.
307  *
308  * The human readable log message of a record is available in @text, the
309  * length of the message text in @text_len. The stored message is not
310  * terminated.
311  *
312  * Optionally, a record can carry a dictionary of properties (key/value
313  * pairs), to provide userspace with a machine-readable message context.
314  *
315  * Examples for well-defined, commonly used property names are:
316  *   DEVICE=b12:8               device identifier
317  *                                b12:8         block dev_t
318  *                                c127:3        char dev_t
319  *                                n8            netdev ifindex
320  *                                +sound:card0  subsystem:devname
321  *   SUBSYSTEM=pci              driver-core subsystem name
322  *
323  * Valid characters in property names are [a-zA-Z0-9.-_]. Property names
324  * and values are terminated by a '\0' character.
325  *
326  * Example of record values:
327  *   record.text_buf                = "it's a line" (unterminated)
328  *   record.info.seq                = 56
329  *   record.info.ts_nsec            = 36863
330  *   record.info.text_len           = 11
331  *   record.info.facility           = 0 (LOG_KERN)
332  *   record.info.flags              = 0
333  *   record.info.level              = 3 (LOG_ERR)
334  *   record.info.caller_id          = 299 (task 299)
335  *   record.info.dev_info.subsystem = "pci" (terminated)
336  *   record.info.dev_info.device    = "+pci:0000:00:01.0" (terminated)
337  *
338  * The 'struct printk_info' buffer must never be directly exported to
339  * userspace, it is a kernel-private implementation detail that might
340  * need to be changed in the future, when the requirements change.
341  *
342  * /dev/kmsg exports the structured data in the following line format:
343  *   "<level>,<sequnum>,<timestamp>,<contflag>[,additional_values, ... ];<message text>\n"
344  *
345  * Users of the export format should ignore possible additional values
346  * separated by ',', and find the message after the ';' character.
347  *
348  * The optional key/value pairs are attached as continuation lines starting
349  * with a space character and terminated by a newline. All possible
350  * non-prinatable characters are escaped in the "\xff" notation.
351  */
352 
353 enum log_flags {
354 	LOG_NEWLINE	= 2,	/* text ended with a newline */
355 	LOG_CONT	= 8,	/* text is a fragment of a continuation line */
356 };
357 
358 /*
359  * The logbuf_lock protects kmsg buffer, indices, counters.  This can be taken
360  * within the scheduler's rq lock. It must be released before calling
361  * console_unlock() or anything else that might wake up a process.
362  */
363 DEFINE_RAW_SPINLOCK(logbuf_lock);
364 
365 /*
366  * Helper macros to lock/unlock logbuf_lock and switch between
367  * printk-safe/unsafe modes.
368  */
369 #define logbuf_lock_irq()				\
370 	do {						\
371 		printk_safe_enter_irq();		\
372 		raw_spin_lock(&logbuf_lock);		\
373 	} while (0)
374 
375 #define logbuf_unlock_irq()				\
376 	do {						\
377 		raw_spin_unlock(&logbuf_lock);		\
378 		printk_safe_exit_irq();			\
379 	} while (0)
380 
381 #define logbuf_lock_irqsave(flags)			\
382 	do {						\
383 		printk_safe_enter_irqsave(flags);	\
384 		raw_spin_lock(&logbuf_lock);		\
385 	} while (0)
386 
387 #define logbuf_unlock_irqrestore(flags)		\
388 	do {						\
389 		raw_spin_unlock(&logbuf_lock);		\
390 		printk_safe_exit_irqrestore(flags);	\
391 	} while (0)
392 
393 #ifdef CONFIG_PRINTK
394 DECLARE_WAIT_QUEUE_HEAD(log_wait);
395 /* the next printk record to read by syslog(READ) or /proc/kmsg */
396 static u64 syslog_seq;
397 static size_t syslog_partial;
398 static bool syslog_time;
399 
400 /* the next printk record to write to the console */
401 static u64 console_seq;
402 static u64 exclusive_console_stop_seq;
403 static unsigned long console_dropped;
404 
405 /* the next printk record to read after the last 'clear' command */
406 static u64 clear_seq;
407 
408 #ifdef CONFIG_PRINTK_CALLER
409 #define PREFIX_MAX		48
410 #else
411 #define PREFIX_MAX		32
412 #endif
413 #define LOG_LINE_MAX		(1024 - PREFIX_MAX)
414 
415 #define LOG_LEVEL(v)		((v) & 0x07)
416 #define LOG_FACILITY(v)		((v) >> 3 & 0xff)
417 
418 /* record buffer */
419 #define LOG_ALIGN __alignof__(unsigned long)
420 #define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
421 #define LOG_BUF_LEN_MAX (u32)(1 << 31)
422 static char __log_buf[__LOG_BUF_LEN] __aligned(LOG_ALIGN);
423 static char *log_buf = __log_buf;
424 static u32 log_buf_len = __LOG_BUF_LEN;
425 
426 /*
427  * Define the average message size. This only affects the number of
428  * descriptors that will be available. Underestimating is better than
429  * overestimating (too many available descriptors is better than not enough).
430  */
431 #define PRB_AVGBITS 5	/* 32 character average length */
432 
433 #if CONFIG_LOG_BUF_SHIFT <= PRB_AVGBITS
434 #error CONFIG_LOG_BUF_SHIFT value too small.
435 #endif
436 _DEFINE_PRINTKRB(printk_rb_static, CONFIG_LOG_BUF_SHIFT - PRB_AVGBITS,
437 		 PRB_AVGBITS, &__log_buf[0]);
438 
439 static struct printk_ringbuffer printk_rb_dynamic;
440 
441 static struct printk_ringbuffer *prb = &printk_rb_static;
442 
443 /*
444  * We cannot access per-CPU data (e.g. per-CPU flush irq_work) before
445  * per_cpu_areas are initialised. This variable is set to true when
446  * it's safe to access per-CPU data.
447  */
448 static bool __printk_percpu_data_ready __read_mostly;
449 
printk_percpu_data_ready(void)450 bool printk_percpu_data_ready(void)
451 {
452 	return __printk_percpu_data_ready;
453 }
454 
455 /* Return log buffer address */
log_buf_addr_get(void)456 char *log_buf_addr_get(void)
457 {
458 	return log_buf;
459 }
460 
461 /* Return log buffer size */
log_buf_len_get(void)462 u32 log_buf_len_get(void)
463 {
464 	return log_buf_len;
465 }
466 
467 /*
468  * Define how much of the log buffer we could take at maximum. The value
469  * must be greater than two. Note that only half of the buffer is available
470  * when the index points to the middle.
471  */
472 #define MAX_LOG_TAKE_PART 4
473 static const char trunc_msg[] = "<truncated>";
474 
truncate_msg(u16 * text_len,u16 * trunc_msg_len)475 static void truncate_msg(u16 *text_len, u16 *trunc_msg_len)
476 {
477 	/*
478 	 * The message should not take the whole buffer. Otherwise, it might
479 	 * get removed too soon.
480 	 */
481 	u32 max_text_len = log_buf_len / MAX_LOG_TAKE_PART;
482 
483 	if (*text_len > max_text_len)
484 		*text_len = max_text_len;
485 
486 	/* enable the warning message (if there is room) */
487 	*trunc_msg_len = strlen(trunc_msg);
488 	if (*text_len >= *trunc_msg_len)
489 		*text_len -= *trunc_msg_len;
490 	else
491 		*trunc_msg_len = 0;
492 }
493 
494 /* insert record into the buffer, discard old ones, update heads */
log_store(u32 caller_id,int facility,int level,enum log_flags flags,u64 ts_nsec,const struct dev_printk_info * dev_info,const char * text,u16 text_len)495 static int log_store(u32 caller_id, int facility, int level,
496 		     enum log_flags flags, u64 ts_nsec,
497 		     const struct dev_printk_info *dev_info,
498 		     const char *text, u16 text_len)
499 {
500 	struct prb_reserved_entry e;
501 	struct printk_record r;
502 	u16 trunc_msg_len = 0;
503 
504 	prb_rec_init_wr(&r, text_len);
505 
506 	if (!prb_reserve(&e, prb, &r)) {
507 		/* truncate the message if it is too long for empty buffer */
508 		truncate_msg(&text_len, &trunc_msg_len);
509 		prb_rec_init_wr(&r, text_len + trunc_msg_len);
510 		/* survive when the log buffer is too small for trunc_msg */
511 		if (!prb_reserve(&e, prb, &r))
512 			return 0;
513 	}
514 
515 	/* fill message */
516 	memcpy(&r.text_buf[0], text, text_len);
517 	if (trunc_msg_len)
518 		memcpy(&r.text_buf[text_len], trunc_msg, trunc_msg_len);
519 	r.info->text_len = text_len + trunc_msg_len;
520 	r.info->facility = facility;
521 	r.info->level = level & 7;
522 	r.info->flags = flags & 0x1f;
523 	if (ts_nsec > 0)
524 		r.info->ts_nsec = ts_nsec;
525 	else
526 		r.info->ts_nsec = local_clock();
527 	r.info->caller_id = caller_id;
528 	if (dev_info)
529 		memcpy(&r.info->dev_info, dev_info, sizeof(r.info->dev_info));
530 
531 	/* A message without a trailing newline can be continued. */
532 	if (!(flags & LOG_NEWLINE))
533 		prb_commit(&e);
534 	else
535 		prb_final_commit(&e);
536 
537 	return (text_len + trunc_msg_len);
538 }
539 
540 int dmesg_restrict = IS_ENABLED(CONFIG_SECURITY_DMESG_RESTRICT);
541 
syslog_action_restricted(int type)542 static int syslog_action_restricted(int type)
543 {
544 	if (dmesg_restrict)
545 		return 1;
546 	/*
547 	 * Unless restricted, we allow "read all" and "get buffer size"
548 	 * for everybody.
549 	 */
550 	return type != SYSLOG_ACTION_READ_ALL &&
551 	       type != SYSLOG_ACTION_SIZE_BUFFER;
552 }
553 
check_syslog_permissions(int type,int source)554 static int check_syslog_permissions(int type, int source)
555 {
556 	/*
557 	 * If this is from /proc/kmsg and we've already opened it, then we've
558 	 * already done the capabilities checks at open time.
559 	 */
560 	if (source == SYSLOG_FROM_PROC && type != SYSLOG_ACTION_OPEN)
561 		goto ok;
562 
563 	if (syslog_action_restricted(type)) {
564 		if (capable(CAP_SYSLOG))
565 			goto ok;
566 		/*
567 		 * For historical reasons, accept CAP_SYS_ADMIN too, with
568 		 * a warning.
569 		 */
570 		if (capable(CAP_SYS_ADMIN)) {
571 			pr_warn_once("%s (%d): Attempt to access syslog with "
572 				     "CAP_SYS_ADMIN but no CAP_SYSLOG "
573 				     "(deprecated).\n",
574 				 current->comm, task_pid_nr(current));
575 			goto ok;
576 		}
577 		return -EPERM;
578 	}
579 ok:
580 	return security_syslog(type);
581 }
582 
append_char(char ** pp,char * e,char c)583 static void append_char(char **pp, char *e, char c)
584 {
585 	if (*pp < e)
586 		*(*pp)++ = c;
587 }
588 
info_print_ext_header(char * buf,size_t size,struct printk_info * info)589 static ssize_t info_print_ext_header(char *buf, size_t size,
590 				     struct printk_info *info)
591 {
592 	u64 ts_usec = info->ts_nsec;
593 	char caller[20];
594 #ifdef CONFIG_PRINTK_CALLER
595 	u32 id = info->caller_id;
596 
597 	snprintf(caller, sizeof(caller), ",caller=%c%u",
598 		 id & 0x80000000 ? 'C' : 'T', id & ~0x80000000);
599 #else
600 	caller[0] = '\0';
601 #endif
602 
603 	do_div(ts_usec, 1000);
604 
605 	return scnprintf(buf, size, "%u,%llu,%llu,%c%s;",
606 			 (info->facility << 3) | info->level, info->seq,
607 			 ts_usec, info->flags & LOG_CONT ? 'c' : '-', caller);
608 }
609 
msg_add_ext_text(char * buf,size_t size,const char * text,size_t text_len,unsigned char endc)610 static ssize_t msg_add_ext_text(char *buf, size_t size,
611 				const char *text, size_t text_len,
612 				unsigned char endc)
613 {
614 	char *p = buf, *e = buf + size;
615 	size_t i;
616 
617 	/* escape non-printable characters */
618 	for (i = 0; i < text_len; i++) {
619 		unsigned char c = text[i];
620 
621 		if (c < ' ' || c >= 127 || c == '\\')
622 			p += scnprintf(p, e - p, "\\x%02x", c);
623 		else
624 			append_char(&p, e, c);
625 	}
626 	append_char(&p, e, endc);
627 
628 	return p - buf;
629 }
630 
msg_add_dict_text(char * buf,size_t size,const char * key,const char * val)631 static ssize_t msg_add_dict_text(char *buf, size_t size,
632 				 const char *key, const char *val)
633 {
634 	size_t val_len = strlen(val);
635 	ssize_t len;
636 
637 	if (!val_len)
638 		return 0;
639 
640 	len = msg_add_ext_text(buf, size, "", 0, ' ');	/* dict prefix */
641 	len += msg_add_ext_text(buf + len, size - len, key, strlen(key), '=');
642 	len += msg_add_ext_text(buf + len, size - len, val, val_len, '\n');
643 
644 	return len;
645 }
646 
msg_print_ext_body(char * buf,size_t size,char * text,size_t text_len,struct dev_printk_info * dev_info)647 static ssize_t msg_print_ext_body(char *buf, size_t size,
648 				  char *text, size_t text_len,
649 				  struct dev_printk_info *dev_info)
650 {
651 	ssize_t len;
652 
653 	len = msg_add_ext_text(buf, size, text, text_len, '\n');
654 
655 	if (!dev_info)
656 		goto out;
657 
658 	len += msg_add_dict_text(buf + len, size - len, "SUBSYSTEM",
659 				 dev_info->subsystem);
660 	len += msg_add_dict_text(buf + len, size - len, "DEVICE",
661 				 dev_info->device);
662 out:
663 	return len;
664 }
665 
666 /* /dev/kmsg - userspace message inject/listen interface */
667 struct devkmsg_user {
668 	u64 seq;
669 	struct ratelimit_state rs;
670 	struct mutex lock;
671 	char buf[CONSOLE_EXT_LOG_MAX];
672 
673 	struct printk_info info;
674 	char text_buf[CONSOLE_EXT_LOG_MAX];
675 	struct printk_record record;
676 };
677 
678 static __printf(3, 4) __cold
devkmsg_emit(int facility,int level,const char * fmt,...)679 int devkmsg_emit(int facility, int level, const char *fmt, ...)
680 {
681 	va_list args;
682 	int r;
683 
684 	va_start(args, fmt);
685 	r = vprintk_emit(facility, level, NULL, fmt, args);
686 	va_end(args);
687 
688 	return r;
689 }
690 
devkmsg_write(struct kiocb * iocb,struct iov_iter * from)691 static ssize_t devkmsg_write(struct kiocb *iocb, struct iov_iter *from)
692 {
693 	char *buf, *line;
694 	int level = default_message_loglevel;
695 	int facility = 1;	/* LOG_USER */
696 	struct file *file = iocb->ki_filp;
697 	struct devkmsg_user *user = file->private_data;
698 	size_t len = iov_iter_count(from);
699 	ssize_t ret = len;
700 
701 	if (!user || len > LOG_LINE_MAX)
702 		return -EINVAL;
703 
704 	/* Ignore when user logging is disabled. */
705 	if (devkmsg_log & DEVKMSG_LOG_MASK_OFF)
706 		return len;
707 
708 	/* Ratelimit when not explicitly enabled. */
709 	if (!(devkmsg_log & DEVKMSG_LOG_MASK_ON)) {
710 		if (!___ratelimit(&user->rs, current->comm))
711 			return ret;
712 	}
713 
714 	buf = kmalloc(len+1, GFP_KERNEL);
715 	if (buf == NULL)
716 		return -ENOMEM;
717 
718 	buf[len] = '\0';
719 	if (!copy_from_iter_full(buf, len, from)) {
720 		kfree(buf);
721 		return -EFAULT;
722 	}
723 
724 	/*
725 	 * Extract and skip the syslog prefix <[0-9]*>. Coming from userspace
726 	 * the decimal value represents 32bit, the lower 3 bit are the log
727 	 * level, the rest are the log facility.
728 	 *
729 	 * If no prefix or no userspace facility is specified, we
730 	 * enforce LOG_USER, to be able to reliably distinguish
731 	 * kernel-generated messages from userspace-injected ones.
732 	 */
733 	line = buf;
734 	if (line[0] == '<') {
735 		char *endp = NULL;
736 		unsigned int u;
737 
738 		u = simple_strtoul(line + 1, &endp, 10);
739 		if (endp && endp[0] == '>') {
740 			level = LOG_LEVEL(u);
741 			if (LOG_FACILITY(u) != 0)
742 				facility = LOG_FACILITY(u);
743 			endp++;
744 			len -= endp - line;
745 			line = endp;
746 		}
747 	}
748 
749 	devkmsg_emit(facility, level, "%s", line);
750 	kfree(buf);
751 	return ret;
752 }
753 
devkmsg_read(struct file * file,char __user * buf,size_t count,loff_t * ppos)754 static ssize_t devkmsg_read(struct file *file, char __user *buf,
755 			    size_t count, loff_t *ppos)
756 {
757 	struct devkmsg_user *user = file->private_data;
758 	struct printk_record *r = &user->record;
759 	size_t len;
760 	ssize_t ret;
761 
762 	if (!user)
763 		return -EBADF;
764 
765 	ret = mutex_lock_interruptible(&user->lock);
766 	if (ret)
767 		return ret;
768 
769 	logbuf_lock_irq();
770 	if (!prb_read_valid(prb, user->seq, r)) {
771 		if (file->f_flags & O_NONBLOCK) {
772 			ret = -EAGAIN;
773 			logbuf_unlock_irq();
774 			goto out;
775 		}
776 
777 		logbuf_unlock_irq();
778 		ret = wait_event_interruptible(log_wait,
779 					prb_read_valid(prb, user->seq, r));
780 		if (ret)
781 			goto out;
782 		logbuf_lock_irq();
783 	}
784 
785 	if (r->info->seq != user->seq) {
786 		/* our last seen message is gone, return error and reset */
787 		user->seq = r->info->seq;
788 		ret = -EPIPE;
789 		logbuf_unlock_irq();
790 		goto out;
791 	}
792 
793 	len = info_print_ext_header(user->buf, sizeof(user->buf), r->info);
794 	len += msg_print_ext_body(user->buf + len, sizeof(user->buf) - len,
795 				  &r->text_buf[0], r->info->text_len,
796 				  &r->info->dev_info);
797 
798 	user->seq = r->info->seq + 1;
799 	logbuf_unlock_irq();
800 
801 	if (len > count) {
802 		ret = -EINVAL;
803 		goto out;
804 	}
805 
806 	if (copy_to_user(buf, user->buf, len)) {
807 		ret = -EFAULT;
808 		goto out;
809 	}
810 	ret = len;
811 out:
812 	mutex_unlock(&user->lock);
813 	return ret;
814 }
815 
816 /*
817  * Be careful when modifying this function!!!
818  *
819  * Only few operations are supported because the device works only with the
820  * entire variable length messages (records). Non-standard values are
821  * returned in the other cases and has been this way for quite some time.
822  * User space applications might depend on this behavior.
823  */
devkmsg_llseek(struct file * file,loff_t offset,int whence)824 static loff_t devkmsg_llseek(struct file *file, loff_t offset, int whence)
825 {
826 	struct devkmsg_user *user = file->private_data;
827 	loff_t ret = 0;
828 
829 	if (!user)
830 		return -EBADF;
831 	if (offset)
832 		return -ESPIPE;
833 
834 	logbuf_lock_irq();
835 	switch (whence) {
836 	case SEEK_SET:
837 		/* the first record */
838 		user->seq = prb_first_valid_seq(prb);
839 		break;
840 	case SEEK_DATA:
841 		/*
842 		 * The first record after the last SYSLOG_ACTION_CLEAR,
843 		 * like issued by 'dmesg -c'. Reading /dev/kmsg itself
844 		 * changes no global state, and does not clear anything.
845 		 */
846 		user->seq = clear_seq;
847 		break;
848 	case SEEK_END:
849 		/* after the last record */
850 		user->seq = prb_next_seq(prb);
851 		break;
852 	default:
853 		ret = -EINVAL;
854 	}
855 	logbuf_unlock_irq();
856 	return ret;
857 }
858 
devkmsg_poll(struct file * file,poll_table * wait)859 static __poll_t devkmsg_poll(struct file *file, poll_table *wait)
860 {
861 	struct devkmsg_user *user = file->private_data;
862 	struct printk_info info;
863 	__poll_t ret = 0;
864 
865 	if (!user)
866 		return EPOLLERR|EPOLLNVAL;
867 
868 	poll_wait(file, &log_wait, wait);
869 
870 	logbuf_lock_irq();
871 	if (prb_read_valid_info(prb, user->seq, &info, NULL)) {
872 		/* return error when data has vanished underneath us */
873 		if (info.seq != user->seq)
874 			ret = EPOLLIN|EPOLLRDNORM|EPOLLERR|EPOLLPRI;
875 		else
876 			ret = EPOLLIN|EPOLLRDNORM;
877 	}
878 	logbuf_unlock_irq();
879 
880 	return ret;
881 }
882 
devkmsg_open(struct inode * inode,struct file * file)883 static int devkmsg_open(struct inode *inode, struct file *file)
884 {
885 	struct devkmsg_user *user;
886 	int err;
887 
888 	if (devkmsg_log & DEVKMSG_LOG_MASK_OFF)
889 		return -EPERM;
890 
891 	/* write-only does not need any file context */
892 	if ((file->f_flags & O_ACCMODE) != O_WRONLY) {
893 		err = check_syslog_permissions(SYSLOG_ACTION_READ_ALL,
894 					       SYSLOG_FROM_READER);
895 		if (err)
896 			return err;
897 	}
898 
899 	user = kmalloc(sizeof(struct devkmsg_user), GFP_KERNEL);
900 	if (!user)
901 		return -ENOMEM;
902 
903 	ratelimit_default_init(&user->rs);
904 	ratelimit_set_flags(&user->rs, RATELIMIT_MSG_ON_RELEASE);
905 
906 	mutex_init(&user->lock);
907 
908 	prb_rec_init_rd(&user->record, &user->info,
909 			&user->text_buf[0], sizeof(user->text_buf));
910 
911 	logbuf_lock_irq();
912 	user->seq = prb_first_valid_seq(prb);
913 	logbuf_unlock_irq();
914 
915 	file->private_data = user;
916 	return 0;
917 }
918 
devkmsg_release(struct inode * inode,struct file * file)919 static int devkmsg_release(struct inode *inode, struct file *file)
920 {
921 	struct devkmsg_user *user = file->private_data;
922 
923 	if (!user)
924 		return 0;
925 
926 	ratelimit_state_exit(&user->rs);
927 
928 	mutex_destroy(&user->lock);
929 	kfree(user);
930 	return 0;
931 }
932 
933 const struct file_operations kmsg_fops = {
934 	.open = devkmsg_open,
935 	.read = devkmsg_read,
936 	.write_iter = devkmsg_write,
937 	.llseek = devkmsg_llseek,
938 	.poll = devkmsg_poll,
939 	.release = devkmsg_release,
940 };
941 
942 #ifdef CONFIG_CRASH_CORE
943 /*
944  * This appends the listed symbols to /proc/vmcore
945  *
946  * /proc/vmcore is used by various utilities, like crash and makedumpfile to
947  * obtain access to symbols that are otherwise very difficult to locate.  These
948  * symbols are specifically used so that utilities can access and extract the
949  * dmesg log from a vmcore file after a crash.
950  */
log_buf_vmcoreinfo_setup(void)951 void log_buf_vmcoreinfo_setup(void)
952 {
953 	struct dev_printk_info *dev_info = NULL;
954 
955 	VMCOREINFO_SYMBOL(prb);
956 	VMCOREINFO_SYMBOL(printk_rb_static);
957 	VMCOREINFO_SYMBOL(clear_seq);
958 
959 	/*
960 	 * Export struct size and field offsets. User space tools can
961 	 * parse it and detect any changes to structure down the line.
962 	 */
963 
964 	VMCOREINFO_STRUCT_SIZE(printk_ringbuffer);
965 	VMCOREINFO_OFFSET(printk_ringbuffer, desc_ring);
966 	VMCOREINFO_OFFSET(printk_ringbuffer, text_data_ring);
967 	VMCOREINFO_OFFSET(printk_ringbuffer, fail);
968 
969 	VMCOREINFO_STRUCT_SIZE(prb_desc_ring);
970 	VMCOREINFO_OFFSET(prb_desc_ring, count_bits);
971 	VMCOREINFO_OFFSET(prb_desc_ring, descs);
972 	VMCOREINFO_OFFSET(prb_desc_ring, infos);
973 	VMCOREINFO_OFFSET(prb_desc_ring, head_id);
974 	VMCOREINFO_OFFSET(prb_desc_ring, tail_id);
975 
976 	VMCOREINFO_STRUCT_SIZE(prb_desc);
977 	VMCOREINFO_OFFSET(prb_desc, state_var);
978 	VMCOREINFO_OFFSET(prb_desc, text_blk_lpos);
979 
980 	VMCOREINFO_STRUCT_SIZE(prb_data_blk_lpos);
981 	VMCOREINFO_OFFSET(prb_data_blk_lpos, begin);
982 	VMCOREINFO_OFFSET(prb_data_blk_lpos, next);
983 
984 	VMCOREINFO_STRUCT_SIZE(printk_info);
985 	VMCOREINFO_OFFSET(printk_info, seq);
986 	VMCOREINFO_OFFSET(printk_info, ts_nsec);
987 	VMCOREINFO_OFFSET(printk_info, text_len);
988 	VMCOREINFO_OFFSET(printk_info, caller_id);
989 	VMCOREINFO_OFFSET(printk_info, dev_info);
990 
991 	VMCOREINFO_STRUCT_SIZE(dev_printk_info);
992 	VMCOREINFO_OFFSET(dev_printk_info, subsystem);
993 	VMCOREINFO_LENGTH(printk_info_subsystem, sizeof(dev_info->subsystem));
994 	VMCOREINFO_OFFSET(dev_printk_info, device);
995 	VMCOREINFO_LENGTH(printk_info_device, sizeof(dev_info->device));
996 
997 	VMCOREINFO_STRUCT_SIZE(prb_data_ring);
998 	VMCOREINFO_OFFSET(prb_data_ring, size_bits);
999 	VMCOREINFO_OFFSET(prb_data_ring, data);
1000 	VMCOREINFO_OFFSET(prb_data_ring, head_lpos);
1001 	VMCOREINFO_OFFSET(prb_data_ring, tail_lpos);
1002 
1003 	VMCOREINFO_SIZE(atomic_long_t);
1004 	VMCOREINFO_TYPE_OFFSET(atomic_long_t, counter);
1005 }
1006 #endif
1007 
1008 /* requested log_buf_len from kernel cmdline */
1009 static unsigned long __initdata new_log_buf_len;
1010 
1011 /* we practice scaling the ring buffer by powers of 2 */
log_buf_len_update(u64 size)1012 static void __init log_buf_len_update(u64 size)
1013 {
1014 	if (size > (u64)LOG_BUF_LEN_MAX) {
1015 		size = (u64)LOG_BUF_LEN_MAX;
1016 		pr_err("log_buf over 2G is not supported.\n");
1017 	}
1018 
1019 	if (size)
1020 		size = roundup_pow_of_two(size);
1021 	if (size > log_buf_len)
1022 		new_log_buf_len = (unsigned long)size;
1023 }
1024 
1025 /* save requested log_buf_len since it's too early to process it */
log_buf_len_setup(char * str)1026 static int __init log_buf_len_setup(char *str)
1027 {
1028 	u64 size;
1029 
1030 	if (!str)
1031 		return -EINVAL;
1032 
1033 	size = memparse(str, &str);
1034 
1035 	log_buf_len_update(size);
1036 
1037 	return 0;
1038 }
1039 early_param("log_buf_len", log_buf_len_setup);
1040 
1041 #ifdef CONFIG_SMP
1042 #define __LOG_CPU_MAX_BUF_LEN (1 << CONFIG_LOG_CPU_MAX_BUF_SHIFT)
1043 
log_buf_add_cpu(void)1044 static void __init log_buf_add_cpu(void)
1045 {
1046 	unsigned int cpu_extra;
1047 
1048 	/*
1049 	 * archs should set up cpu_possible_bits properly with
1050 	 * set_cpu_possible() after setup_arch() but just in
1051 	 * case lets ensure this is valid.
1052 	 */
1053 	if (num_possible_cpus() == 1)
1054 		return;
1055 
1056 	cpu_extra = (num_possible_cpus() - 1) * __LOG_CPU_MAX_BUF_LEN;
1057 
1058 	/* by default this will only continue through for large > 64 CPUs */
1059 	if (cpu_extra <= __LOG_BUF_LEN / 2)
1060 		return;
1061 
1062 	pr_info("log_buf_len individual max cpu contribution: %d bytes\n",
1063 		__LOG_CPU_MAX_BUF_LEN);
1064 	pr_info("log_buf_len total cpu_extra contributions: %d bytes\n",
1065 		cpu_extra);
1066 	pr_info("log_buf_len min size: %d bytes\n", __LOG_BUF_LEN);
1067 
1068 	log_buf_len_update(cpu_extra + __LOG_BUF_LEN);
1069 }
1070 #else /* !CONFIG_SMP */
log_buf_add_cpu(void)1071 static inline void log_buf_add_cpu(void) {}
1072 #endif /* CONFIG_SMP */
1073 
set_percpu_data_ready(void)1074 static void __init set_percpu_data_ready(void)
1075 {
1076 	printk_safe_init();
1077 	/* Make sure we set this flag only after printk_safe() init is done */
1078 	barrier();
1079 	__printk_percpu_data_ready = true;
1080 }
1081 
add_to_rb(struct printk_ringbuffer * rb,struct printk_record * r)1082 static unsigned int __init add_to_rb(struct printk_ringbuffer *rb,
1083 				     struct printk_record *r)
1084 {
1085 	struct prb_reserved_entry e;
1086 	struct printk_record dest_r;
1087 
1088 	prb_rec_init_wr(&dest_r, r->info->text_len);
1089 
1090 	if (!prb_reserve(&e, rb, &dest_r))
1091 		return 0;
1092 
1093 	memcpy(&dest_r.text_buf[0], &r->text_buf[0], r->info->text_len);
1094 	dest_r.info->text_len = r->info->text_len;
1095 	dest_r.info->facility = r->info->facility;
1096 	dest_r.info->level = r->info->level;
1097 	dest_r.info->flags = r->info->flags;
1098 	dest_r.info->ts_nsec = r->info->ts_nsec;
1099 	dest_r.info->caller_id = r->info->caller_id;
1100 	memcpy(&dest_r.info->dev_info, &r->info->dev_info, sizeof(dest_r.info->dev_info));
1101 
1102 	prb_final_commit(&e);
1103 
1104 	return prb_record_text_space(&e);
1105 }
1106 
1107 static char setup_text_buf[LOG_LINE_MAX] __initdata;
1108 
setup_log_buf(int early)1109 void __init setup_log_buf(int early)
1110 {
1111 	struct printk_info *new_infos;
1112 	unsigned int new_descs_count;
1113 	struct prb_desc *new_descs;
1114 	struct printk_info info;
1115 	struct printk_record r;
1116 	size_t new_descs_size;
1117 	size_t new_infos_size;
1118 	unsigned long flags;
1119 	char *new_log_buf;
1120 	unsigned int free;
1121 	u64 seq;
1122 
1123 	/*
1124 	 * Some archs call setup_log_buf() multiple times - first is very
1125 	 * early, e.g. from setup_arch(), and second - when percpu_areas
1126 	 * are initialised.
1127 	 */
1128 	if (!early)
1129 		set_percpu_data_ready();
1130 
1131 	if (log_buf != __log_buf)
1132 		return;
1133 
1134 	if (!early && !new_log_buf_len)
1135 		log_buf_add_cpu();
1136 
1137 	if (!new_log_buf_len)
1138 		return;
1139 
1140 	new_descs_count = new_log_buf_len >> PRB_AVGBITS;
1141 	if (new_descs_count == 0) {
1142 		pr_err("new_log_buf_len: %lu too small\n", new_log_buf_len);
1143 		return;
1144 	}
1145 
1146 	new_log_buf = memblock_alloc(new_log_buf_len, LOG_ALIGN);
1147 	if (unlikely(!new_log_buf)) {
1148 		pr_err("log_buf_len: %lu text bytes not available\n",
1149 		       new_log_buf_len);
1150 		return;
1151 	}
1152 
1153 	new_descs_size = new_descs_count * sizeof(struct prb_desc);
1154 	new_descs = memblock_alloc(new_descs_size, LOG_ALIGN);
1155 	if (unlikely(!new_descs)) {
1156 		pr_err("log_buf_len: %zu desc bytes not available\n",
1157 		       new_descs_size);
1158 		goto err_free_log_buf;
1159 	}
1160 
1161 	new_infos_size = new_descs_count * sizeof(struct printk_info);
1162 	new_infos = memblock_alloc(new_infos_size, LOG_ALIGN);
1163 	if (unlikely(!new_infos)) {
1164 		pr_err("log_buf_len: %zu info bytes not available\n",
1165 		       new_infos_size);
1166 		goto err_free_descs;
1167 	}
1168 
1169 	prb_rec_init_rd(&r, &info, &setup_text_buf[0], sizeof(setup_text_buf));
1170 
1171 	prb_init(&printk_rb_dynamic,
1172 		 new_log_buf, ilog2(new_log_buf_len),
1173 		 new_descs, ilog2(new_descs_count),
1174 		 new_infos);
1175 
1176 	logbuf_lock_irqsave(flags);
1177 
1178 	log_buf_len = new_log_buf_len;
1179 	log_buf = new_log_buf;
1180 	new_log_buf_len = 0;
1181 
1182 	free = __LOG_BUF_LEN;
1183 	prb_for_each_record(0, &printk_rb_static, seq, &r)
1184 		free -= add_to_rb(&printk_rb_dynamic, &r);
1185 
1186 	/*
1187 	 * This is early enough that everything is still running on the
1188 	 * boot CPU and interrupts are disabled. So no new messages will
1189 	 * appear during the transition to the dynamic buffer.
1190 	 */
1191 	prb = &printk_rb_dynamic;
1192 
1193 	logbuf_unlock_irqrestore(flags);
1194 
1195 	if (seq != prb_next_seq(&printk_rb_static)) {
1196 		pr_err("dropped %llu messages\n",
1197 		       prb_next_seq(&printk_rb_static) - seq);
1198 	}
1199 
1200 	pr_info("log_buf_len: %u bytes\n", log_buf_len);
1201 	pr_info("early log buf free: %u(%u%%)\n",
1202 		free, (free * 100) / __LOG_BUF_LEN);
1203 	return;
1204 
1205 err_free_descs:
1206 	memblock_free(__pa(new_descs), new_descs_size);
1207 err_free_log_buf:
1208 	memblock_free(__pa(new_log_buf), new_log_buf_len);
1209 }
1210 
1211 static bool __read_mostly ignore_loglevel;
1212 
ignore_loglevel_setup(char * str)1213 static int __init ignore_loglevel_setup(char *str)
1214 {
1215 	ignore_loglevel = true;
1216 	pr_info("debug: ignoring loglevel setting.\n");
1217 
1218 	return 0;
1219 }
1220 
1221 early_param("ignore_loglevel", ignore_loglevel_setup);
1222 module_param(ignore_loglevel, bool, S_IRUGO | S_IWUSR);
1223 MODULE_PARM_DESC(ignore_loglevel,
1224 		 "ignore loglevel setting (prints all kernel messages to the console)");
1225 
suppress_message_printing(int level)1226 static bool suppress_message_printing(int level)
1227 {
1228 	return (level >= console_loglevel && !ignore_loglevel);
1229 }
1230 
1231 #ifdef CONFIG_BOOT_PRINTK_DELAY
1232 
1233 static int boot_delay; /* msecs delay after each printk during bootup */
1234 static unsigned long long loops_per_msec;	/* based on boot_delay */
1235 
boot_delay_setup(char * str)1236 static int __init boot_delay_setup(char *str)
1237 {
1238 	unsigned long lpj;
1239 
1240 	lpj = preset_lpj ? preset_lpj : 1000000;	/* some guess */
1241 	loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
1242 
1243 	get_option(&str, &boot_delay);
1244 	if (boot_delay > 10 * 1000)
1245 		boot_delay = 0;
1246 
1247 	pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
1248 		"HZ: %d, loops_per_msec: %llu\n",
1249 		boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
1250 	return 0;
1251 }
1252 early_param("boot_delay", boot_delay_setup);
1253 
boot_delay_msec(int level)1254 static void boot_delay_msec(int level)
1255 {
1256 	unsigned long long k;
1257 	unsigned long timeout;
1258 
1259 	if ((boot_delay == 0 || system_state >= SYSTEM_RUNNING)
1260 		|| suppress_message_printing(level)) {
1261 		return;
1262 	}
1263 
1264 	k = (unsigned long long)loops_per_msec * boot_delay;
1265 
1266 	timeout = jiffies + msecs_to_jiffies(boot_delay);
1267 	while (k) {
1268 		k--;
1269 		cpu_relax();
1270 		/*
1271 		 * use (volatile) jiffies to prevent
1272 		 * compiler reduction; loop termination via jiffies
1273 		 * is secondary and may or may not happen.
1274 		 */
1275 		if (time_after(jiffies, timeout))
1276 			break;
1277 		touch_nmi_watchdog();
1278 	}
1279 }
1280 #else
boot_delay_msec(int level)1281 static inline void boot_delay_msec(int level)
1282 {
1283 }
1284 #endif
1285 
1286 static bool printk_time = IS_ENABLED(CONFIG_PRINTK_TIME);
1287 module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
1288 
print_syslog(unsigned int level,char * buf)1289 static size_t print_syslog(unsigned int level, char *buf)
1290 {
1291 	return sprintf(buf, "<%u>", level);
1292 }
1293 
print_time(u64 ts,char * buf)1294 static size_t print_time(u64 ts, char *buf)
1295 {
1296 	unsigned long rem_nsec = do_div(ts, 1000000000);
1297 
1298 	return sprintf(buf, "[%5lu.%06lu]",
1299 		       (unsigned long)ts, rem_nsec / 1000);
1300 }
1301 
1302 #ifdef CONFIG_PRINTK_CALLER
print_caller(u32 id,char * buf)1303 static size_t print_caller(u32 id, char *buf)
1304 {
1305 	char caller[12];
1306 
1307 	snprintf(caller, sizeof(caller), "%c%u",
1308 		 id & 0x80000000 ? 'C' : 'T', id & ~0x80000000);
1309 	return sprintf(buf, "[%6s]", caller);
1310 }
1311 #else
1312 #define print_caller(id, buf) 0
1313 #endif
1314 
info_print_prefix(const struct printk_info * info,bool syslog,bool time,char * buf)1315 static size_t info_print_prefix(const struct printk_info  *info, bool syslog,
1316 				bool time, char *buf)
1317 {
1318 	size_t len = 0;
1319 
1320 	if (syslog)
1321 		len = print_syslog((info->facility << 3) | info->level, buf);
1322 
1323 	if (time)
1324 		len += print_time(info->ts_nsec, buf + len);
1325 
1326 	len += print_caller(info->caller_id, buf + len);
1327 
1328 	if (IS_ENABLED(CONFIG_PRINTK_CALLER) || time) {
1329 		buf[len++] = ' ';
1330 		buf[len] = '\0';
1331 	}
1332 
1333 	return len;
1334 }
1335 
1336 /*
1337  * Prepare the record for printing. The text is shifted within the given
1338  * buffer to avoid a need for another one. The following operations are
1339  * done:
1340  *
1341  *   - Add prefix for each line.
1342  *   - Drop truncated lines that no longer fit into the buffer.
1343  *   - Add the trailing newline that has been removed in vprintk_store().
1344  *   - Add a string terminator.
1345  *
1346  * Since the produced string is always terminated, the maximum possible
1347  * return value is @r->text_buf_size - 1;
1348  *
1349  * Return: The length of the updated/prepared text, including the added
1350  * prefixes and the newline. The terminator is not counted. The dropped
1351  * line(s) are not counted.
1352  */
record_print_text(struct printk_record * r,bool syslog,bool time)1353 static size_t record_print_text(struct printk_record *r, bool syslog,
1354 				bool time)
1355 {
1356 	size_t text_len = r->info->text_len;
1357 	size_t buf_size = r->text_buf_size;
1358 	char *text = r->text_buf;
1359 	char prefix[PREFIX_MAX];
1360 	bool truncated = false;
1361 	size_t prefix_len;
1362 	size_t line_len;
1363 	size_t len = 0;
1364 	char *next;
1365 
1366 	/*
1367 	 * If the message was truncated because the buffer was not large
1368 	 * enough, treat the available text as if it were the full text.
1369 	 */
1370 	if (text_len > buf_size)
1371 		text_len = buf_size;
1372 
1373 	prefix_len = info_print_prefix(r->info, syslog, time, prefix);
1374 
1375 	/*
1376 	 * @text_len: bytes of unprocessed text
1377 	 * @line_len: bytes of current line _without_ newline
1378 	 * @text:     pointer to beginning of current line
1379 	 * @len:      number of bytes prepared in r->text_buf
1380 	 */
1381 	for (;;) {
1382 		next = memchr(text, '\n', text_len);
1383 		if (next) {
1384 			line_len = next - text;
1385 		} else {
1386 			/* Drop truncated line(s). */
1387 			if (truncated)
1388 				break;
1389 			line_len = text_len;
1390 		}
1391 
1392 		/*
1393 		 * Truncate the text if there is not enough space to add the
1394 		 * prefix and a trailing newline and a terminator.
1395 		 */
1396 		if (len + prefix_len + text_len + 1 + 1 > buf_size) {
1397 			/* Drop even the current line if no space. */
1398 			if (len + prefix_len + line_len + 1 + 1 > buf_size)
1399 				break;
1400 
1401 			text_len = buf_size - len - prefix_len - 1 - 1;
1402 			truncated = true;
1403 		}
1404 
1405 		memmove(text + prefix_len, text, text_len);
1406 		memcpy(text, prefix, prefix_len);
1407 
1408 		/*
1409 		 * Increment the prepared length to include the text and
1410 		 * prefix that were just moved+copied. Also increment for the
1411 		 * newline at the end of this line. If this is the last line,
1412 		 * there is no newline, but it will be added immediately below.
1413 		 */
1414 		len += prefix_len + line_len + 1;
1415 		if (text_len == line_len) {
1416 			/*
1417 			 * This is the last line. Add the trailing newline
1418 			 * removed in vprintk_store().
1419 			 */
1420 			text[prefix_len + line_len] = '\n';
1421 			break;
1422 		}
1423 
1424 		/*
1425 		 * Advance beyond the added prefix and the related line with
1426 		 * its newline.
1427 		 */
1428 		text += prefix_len + line_len + 1;
1429 
1430 		/*
1431 		 * The remaining text has only decreased by the line with its
1432 		 * newline.
1433 		 *
1434 		 * Note that @text_len can become zero. It happens when @text
1435 		 * ended with a newline (either due to truncation or the
1436 		 * original string ending with "\n\n"). The loop is correctly
1437 		 * repeated and (if not truncated) an empty line with a prefix
1438 		 * will be prepared.
1439 		 */
1440 		text_len -= line_len + 1;
1441 	}
1442 
1443 	/*
1444 	 * If a buffer was provided, it will be terminated. Space for the
1445 	 * string terminator is guaranteed to be available. The terminator is
1446 	 * not counted in the return value.
1447 	 */
1448 	if (buf_size > 0)
1449 		r->text_buf[len] = 0;
1450 
1451 	return len;
1452 }
1453 
get_record_print_text_size(struct printk_info * info,unsigned int line_count,bool syslog,bool time)1454 static size_t get_record_print_text_size(struct printk_info *info,
1455 					 unsigned int line_count,
1456 					 bool syslog, bool time)
1457 {
1458 	char prefix[PREFIX_MAX];
1459 	size_t prefix_len;
1460 
1461 	prefix_len = info_print_prefix(info, syslog, time, prefix);
1462 
1463 	/*
1464 	 * Each line will be preceded with a prefix. The intermediate
1465 	 * newlines are already within the text, but a final trailing
1466 	 * newline will be added.
1467 	 */
1468 	return ((prefix_len * line_count) + info->text_len + 1);
1469 }
1470 
syslog_print(char __user * buf,int size)1471 static int syslog_print(char __user *buf, int size)
1472 {
1473 	struct printk_info info;
1474 	struct printk_record r;
1475 	char *text;
1476 	int len = 0;
1477 
1478 	text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1479 	if (!text)
1480 		return -ENOMEM;
1481 
1482 	prb_rec_init_rd(&r, &info, text, LOG_LINE_MAX + PREFIX_MAX);
1483 
1484 	while (size > 0) {
1485 		size_t n;
1486 		size_t skip;
1487 
1488 		logbuf_lock_irq();
1489 		if (!prb_read_valid(prb, syslog_seq, &r)) {
1490 			logbuf_unlock_irq();
1491 			break;
1492 		}
1493 		if (r.info->seq != syslog_seq) {
1494 			/* message is gone, move to next valid one */
1495 			syslog_seq = r.info->seq;
1496 			syslog_partial = 0;
1497 		}
1498 
1499 		/*
1500 		 * To keep reading/counting partial line consistent,
1501 		 * use printk_time value as of the beginning of a line.
1502 		 */
1503 		if (!syslog_partial)
1504 			syslog_time = printk_time;
1505 
1506 		skip = syslog_partial;
1507 		n = record_print_text(&r, true, syslog_time);
1508 		if (n - syslog_partial <= size) {
1509 			/* message fits into buffer, move forward */
1510 			syslog_seq = r.info->seq + 1;
1511 			n -= syslog_partial;
1512 			syslog_partial = 0;
1513 		} else if (!len){
1514 			/* partial read(), remember position */
1515 			n = size;
1516 			syslog_partial += n;
1517 		} else
1518 			n = 0;
1519 		logbuf_unlock_irq();
1520 
1521 		if (!n)
1522 			break;
1523 
1524 		if (copy_to_user(buf, text + skip, n)) {
1525 			if (!len)
1526 				len = -EFAULT;
1527 			break;
1528 		}
1529 
1530 		len += n;
1531 		size -= n;
1532 		buf += n;
1533 	}
1534 
1535 	kfree(text);
1536 	return len;
1537 }
1538 
syslog_print_all(char __user * buf,int size,bool clear)1539 static int syslog_print_all(char __user *buf, int size, bool clear)
1540 {
1541 	struct printk_info info;
1542 	unsigned int line_count;
1543 	struct printk_record r;
1544 	char *text;
1545 	int len = 0;
1546 	u64 seq;
1547 	bool time;
1548 
1549 	text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1550 	if (!text)
1551 		return -ENOMEM;
1552 
1553 	time = printk_time;
1554 	logbuf_lock_irq();
1555 	/*
1556 	 * Find first record that fits, including all following records,
1557 	 * into the user-provided buffer for this dump.
1558 	 */
1559 	prb_for_each_info(clear_seq, prb, seq, &info, &line_count)
1560 		len += get_record_print_text_size(&info, line_count, true, time);
1561 
1562 	/* move first record forward until length fits into the buffer */
1563 	prb_for_each_info(clear_seq, prb, seq, &info, &line_count) {
1564 		if (len <= size)
1565 			break;
1566 		len -= get_record_print_text_size(&info, line_count, true, time);
1567 	}
1568 
1569 	prb_rec_init_rd(&r, &info, text, LOG_LINE_MAX + PREFIX_MAX);
1570 
1571 	len = 0;
1572 	prb_for_each_record(seq, prb, seq, &r) {
1573 		int textlen;
1574 
1575 		textlen = record_print_text(&r, true, time);
1576 
1577 		if (len + textlen > size) {
1578 			seq--;
1579 			break;
1580 		}
1581 
1582 		logbuf_unlock_irq();
1583 		if (copy_to_user(buf + len, text, textlen))
1584 			len = -EFAULT;
1585 		else
1586 			len += textlen;
1587 		logbuf_lock_irq();
1588 
1589 		if (len < 0)
1590 			break;
1591 	}
1592 
1593 	if (clear)
1594 		clear_seq = seq;
1595 	logbuf_unlock_irq();
1596 
1597 	kfree(text);
1598 	return len;
1599 }
1600 
syslog_clear(void)1601 static void syslog_clear(void)
1602 {
1603 	logbuf_lock_irq();
1604 	clear_seq = prb_next_seq(prb);
1605 	logbuf_unlock_irq();
1606 }
1607 
do_syslog(int type,char __user * buf,int len,int source)1608 int do_syslog(int type, char __user *buf, int len, int source)
1609 {
1610 	struct printk_info info;
1611 	bool clear = false;
1612 	static int saved_console_loglevel = LOGLEVEL_DEFAULT;
1613 	int error;
1614 
1615 	error = check_syslog_permissions(type, source);
1616 	if (error)
1617 		return error;
1618 
1619 	switch (type) {
1620 	case SYSLOG_ACTION_CLOSE:	/* Close log */
1621 		break;
1622 	case SYSLOG_ACTION_OPEN:	/* Open log */
1623 		break;
1624 	case SYSLOG_ACTION_READ:	/* Read from log */
1625 		if (!buf || len < 0)
1626 			return -EINVAL;
1627 		if (!len)
1628 			return 0;
1629 		if (!access_ok(buf, len))
1630 			return -EFAULT;
1631 		error = wait_event_interruptible(log_wait,
1632 				prb_read_valid(prb, syslog_seq, NULL));
1633 		if (error)
1634 			return error;
1635 		error = syslog_print(buf, len);
1636 		break;
1637 	/* Read/clear last kernel messages */
1638 	case SYSLOG_ACTION_READ_CLEAR:
1639 		clear = true;
1640 		fallthrough;
1641 	/* Read last kernel messages */
1642 	case SYSLOG_ACTION_READ_ALL:
1643 		if (!buf || len < 0)
1644 			return -EINVAL;
1645 		if (!len)
1646 			return 0;
1647 		if (!access_ok(buf, len))
1648 			return -EFAULT;
1649 		error = syslog_print_all(buf, len, clear);
1650 		break;
1651 	/* Clear ring buffer */
1652 	case SYSLOG_ACTION_CLEAR:
1653 		syslog_clear();
1654 		break;
1655 	/* Disable logging to console */
1656 	case SYSLOG_ACTION_CONSOLE_OFF:
1657 		if (saved_console_loglevel == LOGLEVEL_DEFAULT)
1658 			saved_console_loglevel = console_loglevel;
1659 		console_loglevel = minimum_console_loglevel;
1660 		break;
1661 	/* Enable logging to console */
1662 	case SYSLOG_ACTION_CONSOLE_ON:
1663 		if (saved_console_loglevel != LOGLEVEL_DEFAULT) {
1664 			console_loglevel = saved_console_loglevel;
1665 			saved_console_loglevel = LOGLEVEL_DEFAULT;
1666 		}
1667 		break;
1668 	/* Set level of messages printed to console */
1669 	case SYSLOG_ACTION_CONSOLE_LEVEL:
1670 		if (len < 1 || len > 8)
1671 			return -EINVAL;
1672 		if (len < minimum_console_loglevel)
1673 			len = minimum_console_loglevel;
1674 		console_loglevel = len;
1675 		/* Implicitly re-enable logging to console */
1676 		saved_console_loglevel = LOGLEVEL_DEFAULT;
1677 		break;
1678 	/* Number of chars in the log buffer */
1679 	case SYSLOG_ACTION_SIZE_UNREAD:
1680 		logbuf_lock_irq();
1681 		if (!prb_read_valid_info(prb, syslog_seq, &info, NULL)) {
1682 			/* No unread messages. */
1683 			logbuf_unlock_irq();
1684 			return 0;
1685 		}
1686 		if (info.seq != syslog_seq) {
1687 			/* messages are gone, move to first one */
1688 			syslog_seq = info.seq;
1689 			syslog_partial = 0;
1690 		}
1691 		if (source == SYSLOG_FROM_PROC) {
1692 			/*
1693 			 * Short-cut for poll(/"proc/kmsg") which simply checks
1694 			 * for pending data, not the size; return the count of
1695 			 * records, not the length.
1696 			 */
1697 			error = prb_next_seq(prb) - syslog_seq;
1698 		} else {
1699 			bool time = syslog_partial ? syslog_time : printk_time;
1700 			unsigned int line_count;
1701 			u64 seq;
1702 
1703 			prb_for_each_info(syslog_seq, prb, seq, &info,
1704 					  &line_count) {
1705 				error += get_record_print_text_size(&info, line_count,
1706 								    true, time);
1707 				time = printk_time;
1708 			}
1709 			error -= syslog_partial;
1710 		}
1711 		logbuf_unlock_irq();
1712 		break;
1713 	/* Size of the log buffer */
1714 	case SYSLOG_ACTION_SIZE_BUFFER:
1715 		error = log_buf_len;
1716 		break;
1717 	default:
1718 		error = -EINVAL;
1719 		break;
1720 	}
1721 
1722 	return error;
1723 }
1724 
SYSCALL_DEFINE3(syslog,int,type,char __user *,buf,int,len)1725 SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
1726 {
1727 	return do_syslog(type, buf, len, SYSLOG_FROM_READER);
1728 }
1729 
1730 /*
1731  * Special console_lock variants that help to reduce the risk of soft-lockups.
1732  * They allow to pass console_lock to another printk() call using a busy wait.
1733  */
1734 
1735 #ifdef CONFIG_LOCKDEP
1736 static struct lockdep_map console_owner_dep_map = {
1737 	.name = "console_owner"
1738 };
1739 #endif
1740 
1741 static DEFINE_RAW_SPINLOCK(console_owner_lock);
1742 static struct task_struct *console_owner;
1743 static bool console_waiter;
1744 
1745 /**
1746  * console_lock_spinning_enable - mark beginning of code where another
1747  *	thread might safely busy wait
1748  *
1749  * This basically converts console_lock into a spinlock. This marks
1750  * the section where the console_lock owner can not sleep, because
1751  * there may be a waiter spinning (like a spinlock). Also it must be
1752  * ready to hand over the lock at the end of the section.
1753  */
console_lock_spinning_enable(void)1754 static void console_lock_spinning_enable(void)
1755 {
1756 	raw_spin_lock(&console_owner_lock);
1757 	console_owner = current;
1758 	raw_spin_unlock(&console_owner_lock);
1759 
1760 	/* The waiter may spin on us after setting console_owner */
1761 	spin_acquire(&console_owner_dep_map, 0, 0, _THIS_IP_);
1762 }
1763 
1764 /**
1765  * console_lock_spinning_disable_and_check - mark end of code where another
1766  *	thread was able to busy wait and check if there is a waiter
1767  *
1768  * This is called at the end of the section where spinning is allowed.
1769  * It has two functions. First, it is a signal that it is no longer
1770  * safe to start busy waiting for the lock. Second, it checks if
1771  * there is a busy waiter and passes the lock rights to her.
1772  *
1773  * Important: Callers lose the lock if there was a busy waiter.
1774  *	They must not touch items synchronized by console_lock
1775  *	in this case.
1776  *
1777  * Return: 1 if the lock rights were passed, 0 otherwise.
1778  */
console_lock_spinning_disable_and_check(void)1779 static int console_lock_spinning_disable_and_check(void)
1780 {
1781 	int waiter;
1782 
1783 	raw_spin_lock(&console_owner_lock);
1784 	waiter = READ_ONCE(console_waiter);
1785 	console_owner = NULL;
1786 	raw_spin_unlock(&console_owner_lock);
1787 
1788 	if (!waiter) {
1789 		spin_release(&console_owner_dep_map, _THIS_IP_);
1790 		return 0;
1791 	}
1792 
1793 	/* The waiter is now free to continue */
1794 	WRITE_ONCE(console_waiter, false);
1795 
1796 	spin_release(&console_owner_dep_map, _THIS_IP_);
1797 
1798 	/*
1799 	 * Hand off console_lock to waiter. The waiter will perform
1800 	 * the up(). After this, the waiter is the console_lock owner.
1801 	 */
1802 	mutex_release(&console_lock_dep_map, _THIS_IP_);
1803 	return 1;
1804 }
1805 
1806 /**
1807  * console_trylock_spinning - try to get console_lock by busy waiting
1808  *
1809  * This allows to busy wait for the console_lock when the current
1810  * owner is running in specially marked sections. It means that
1811  * the current owner is running and cannot reschedule until it
1812  * is ready to lose the lock.
1813  *
1814  * Return: 1 if we got the lock, 0 othrewise
1815  */
console_trylock_spinning(void)1816 static int console_trylock_spinning(void)
1817 {
1818 	struct task_struct *owner = NULL;
1819 	bool waiter;
1820 	bool spin = false;
1821 	unsigned long flags;
1822 
1823 	if (console_trylock())
1824 		return 1;
1825 
1826 	printk_safe_enter_irqsave(flags);
1827 
1828 	raw_spin_lock(&console_owner_lock);
1829 	owner = READ_ONCE(console_owner);
1830 	waiter = READ_ONCE(console_waiter);
1831 	if (!waiter && owner && owner != current) {
1832 		WRITE_ONCE(console_waiter, true);
1833 		spin = true;
1834 	}
1835 	raw_spin_unlock(&console_owner_lock);
1836 
1837 	/*
1838 	 * If there is an active printk() writing to the
1839 	 * consoles, instead of having it write our data too,
1840 	 * see if we can offload that load from the active
1841 	 * printer, and do some printing ourselves.
1842 	 * Go into a spin only if there isn't already a waiter
1843 	 * spinning, and there is an active printer, and
1844 	 * that active printer isn't us (recursive printk?).
1845 	 */
1846 	if (!spin) {
1847 		printk_safe_exit_irqrestore(flags);
1848 		return 0;
1849 	}
1850 
1851 	/* We spin waiting for the owner to release us */
1852 	spin_acquire(&console_owner_dep_map, 0, 0, _THIS_IP_);
1853 	/* Owner will clear console_waiter on hand off */
1854 	while (READ_ONCE(console_waiter))
1855 		cpu_relax();
1856 	spin_release(&console_owner_dep_map, _THIS_IP_);
1857 
1858 	printk_safe_exit_irqrestore(flags);
1859 	/*
1860 	 * The owner passed the console lock to us.
1861 	 * Since we did not spin on console lock, annotate
1862 	 * this as a trylock. Otherwise lockdep will
1863 	 * complain.
1864 	 */
1865 	mutex_acquire(&console_lock_dep_map, 0, 1, _THIS_IP_);
1866 
1867 	return 1;
1868 }
1869 
1870 /*
1871  * Call the console drivers, asking them to write out
1872  * log_buf[start] to log_buf[end - 1].
1873  * The console_lock must be held.
1874  */
call_console_drivers(const char * ext_text,size_t ext_len,const char * text,size_t len)1875 static void call_console_drivers(const char *ext_text, size_t ext_len,
1876 				 const char *text, size_t len)
1877 {
1878 	static char dropped_text[64];
1879 	size_t dropped_len = 0;
1880 	struct console *con;
1881 
1882 	trace_console_rcuidle(text, len);
1883 
1884 	if (!console_drivers)
1885 		return;
1886 
1887 	if (console_dropped) {
1888 		dropped_len = snprintf(dropped_text, sizeof(dropped_text),
1889 				       "** %lu printk messages dropped **\n",
1890 				       console_dropped);
1891 		console_dropped = 0;
1892 	}
1893 
1894 	for_each_console(con) {
1895 		if (exclusive_console && con != exclusive_console)
1896 			continue;
1897 		if (!(con->flags & CON_ENABLED))
1898 			continue;
1899 		if (!con->write)
1900 			continue;
1901 		if (!cpu_online(smp_processor_id()) &&
1902 		    !(con->flags & CON_ANYTIME))
1903 			continue;
1904 		if (con->flags & CON_EXTENDED)
1905 			con->write(con, ext_text, ext_len);
1906 		else {
1907 			if (dropped_len)
1908 				con->write(con, dropped_text, dropped_len);
1909 			con->write(con, text, len);
1910 		}
1911 	}
1912 }
1913 
1914 int printk_delay_msec __read_mostly;
1915 
printk_delay(void)1916 static inline void printk_delay(void)
1917 {
1918 	if (unlikely(printk_delay_msec)) {
1919 		int m = printk_delay_msec;
1920 
1921 		while (m--) {
1922 			mdelay(1);
1923 			touch_nmi_watchdog();
1924 		}
1925 	}
1926 }
1927 
printk_caller_id(void)1928 static inline u32 printk_caller_id(void)
1929 {
1930 	return in_task() ? task_pid_nr(current) :
1931 		0x80000000 + raw_smp_processor_id();
1932 }
1933 
log_output(int facility,int level,enum log_flags lflags,const struct dev_printk_info * dev_info,char * text,size_t text_len)1934 static size_t log_output(int facility, int level, enum log_flags lflags,
1935 			 const struct dev_printk_info *dev_info,
1936 			 char *text, size_t text_len)
1937 {
1938 	const u32 caller_id = printk_caller_id();
1939 
1940 	if (lflags & LOG_CONT) {
1941 		struct prb_reserved_entry e;
1942 		struct printk_record r;
1943 
1944 		prb_rec_init_wr(&r, text_len);
1945 		if (prb_reserve_in_last(&e, prb, &r, caller_id, LOG_LINE_MAX)) {
1946 			memcpy(&r.text_buf[r.info->text_len], text, text_len);
1947 			r.info->text_len += text_len;
1948 			if (lflags & LOG_NEWLINE) {
1949 				r.info->flags |= LOG_NEWLINE;
1950 				prb_final_commit(&e);
1951 			} else {
1952 				prb_commit(&e);
1953 			}
1954 			return text_len;
1955 		}
1956 	}
1957 
1958 	/* Store it in the record log */
1959 	return log_store(caller_id, facility, level, lflags, 0,
1960 			 dev_info, text, text_len);
1961 }
1962 
1963 /* Must be called under logbuf_lock. */
vprintk_store(int facility,int level,const struct dev_printk_info * dev_info,const char * fmt,va_list args)1964 int vprintk_store(int facility, int level,
1965 		  const struct dev_printk_info *dev_info,
1966 		  const char *fmt, va_list args)
1967 {
1968 	static char textbuf[LOG_LINE_MAX];
1969 	char *text = textbuf;
1970 	size_t text_len;
1971 	enum log_flags lflags = 0;
1972 
1973 	/*
1974 	 * The printf needs to come first; we need the syslog
1975 	 * prefix which might be passed-in as a parameter.
1976 	 */
1977 	text_len = vscnprintf(text, sizeof(textbuf), fmt, args);
1978 
1979 	/* mark and strip a trailing newline */
1980 	if (text_len && text[text_len-1] == '\n') {
1981 		text_len--;
1982 		lflags |= LOG_NEWLINE;
1983 	}
1984 
1985 	/* strip kernel syslog prefix and extract log level or control flags */
1986 	if (facility == 0) {
1987 		int kern_level;
1988 
1989 		while ((kern_level = printk_get_level(text)) != 0) {
1990 			switch (kern_level) {
1991 			case '0' ... '7':
1992 				if (level == LOGLEVEL_DEFAULT)
1993 					level = kern_level - '0';
1994 				break;
1995 			case 'c':	/* KERN_CONT */
1996 				lflags |= LOG_CONT;
1997 			}
1998 
1999 			text_len -= 2;
2000 			text += 2;
2001 		}
2002 	}
2003 
2004 	if (level == LOGLEVEL_DEFAULT)
2005 		level = default_message_loglevel;
2006 
2007 	if (dev_info)
2008 		lflags |= LOG_NEWLINE;
2009 
2010 	return log_output(facility, level, lflags, dev_info, text, text_len);
2011 }
2012 
vprintk_emit(int facility,int level,const struct dev_printk_info * dev_info,const char * fmt,va_list args)2013 asmlinkage int vprintk_emit(int facility, int level,
2014 			    const struct dev_printk_info *dev_info,
2015 			    const char *fmt, va_list args)
2016 {
2017 	int printed_len;
2018 	bool in_sched = false;
2019 	unsigned long flags;
2020 
2021 	/* Suppress unimportant messages after panic happens */
2022 	if (unlikely(suppress_printk))
2023 		return 0;
2024 
2025 	if (level == LOGLEVEL_SCHED) {
2026 		level = LOGLEVEL_DEFAULT;
2027 		in_sched = true;
2028 	}
2029 
2030 	boot_delay_msec(level);
2031 	printk_delay();
2032 
2033 	/* This stops the holder of console_sem just where we want him */
2034 	logbuf_lock_irqsave(flags);
2035 	printed_len = vprintk_store(facility, level, dev_info, fmt, args);
2036 	logbuf_unlock_irqrestore(flags);
2037 
2038 	/* If called from the scheduler, we can not call up(). */
2039 	if (!in_sched) {
2040 		/*
2041 		 * Disable preemption to avoid being preempted while holding
2042 		 * console_sem which would prevent anyone from printing to
2043 		 * console
2044 		 */
2045 		preempt_disable();
2046 		/*
2047 		 * Try to acquire and then immediately release the console
2048 		 * semaphore.  The release will print out buffers and wake up
2049 		 * /dev/kmsg and syslog() users.
2050 		 */
2051 		if (console_trylock_spinning())
2052 			console_unlock();
2053 		preempt_enable();
2054 	}
2055 
2056 	wake_up_klogd();
2057 	return printed_len;
2058 }
2059 EXPORT_SYMBOL(vprintk_emit);
2060 
vprintk(const char * fmt,va_list args)2061 asmlinkage int vprintk(const char *fmt, va_list args)
2062 {
2063 	return vprintk_func(fmt, args);
2064 }
2065 EXPORT_SYMBOL(vprintk);
2066 
vprintk_default(const char * fmt,va_list args)2067 int vprintk_default(const char *fmt, va_list args)
2068 {
2069 	return vprintk_emit(0, LOGLEVEL_DEFAULT, NULL, fmt, args);
2070 }
2071 EXPORT_SYMBOL_GPL(vprintk_default);
2072 
2073 /**
2074  * printk - print a kernel message
2075  * @fmt: format string
2076  *
2077  * This is printk(). It can be called from any context. We want it to work.
2078  *
2079  * We try to grab the console_lock. If we succeed, it's easy - we log the
2080  * output and call the console drivers.  If we fail to get the semaphore, we
2081  * place the output into the log buffer and return. The current holder of
2082  * the console_sem will notice the new output in console_unlock(); and will
2083  * send it to the consoles before releasing the lock.
2084  *
2085  * One effect of this deferred printing is that code which calls printk() and
2086  * then changes console_loglevel may break. This is because console_loglevel
2087  * is inspected when the actual printing occurs.
2088  *
2089  * See also:
2090  * printf(3)
2091  *
2092  * See the vsnprintf() documentation for format string extensions over C99.
2093  */
printk(const char * fmt,...)2094 asmlinkage __visible int printk(const char *fmt, ...)
2095 {
2096 	va_list args;
2097 	int r;
2098 
2099 	va_start(args, fmt);
2100 	r = vprintk_func(fmt, args);
2101 	va_end(args);
2102 
2103 	return r;
2104 }
2105 EXPORT_SYMBOL(printk);
2106 
2107 #else /* CONFIG_PRINTK */
2108 
2109 #define LOG_LINE_MAX		0
2110 #define PREFIX_MAX		0
2111 #define printk_time		false
2112 
2113 #define prb_read_valid(rb, seq, r)	false
2114 #define prb_first_valid_seq(rb)		0
2115 
2116 static u64 syslog_seq;
2117 static u64 console_seq;
2118 static u64 exclusive_console_stop_seq;
2119 static unsigned long console_dropped;
2120 
record_print_text(const struct printk_record * r,bool syslog,bool time)2121 static size_t record_print_text(const struct printk_record *r,
2122 				bool syslog, bool time)
2123 {
2124 	return 0;
2125 }
info_print_ext_header(char * buf,size_t size,struct printk_info * info)2126 static ssize_t info_print_ext_header(char *buf, size_t size,
2127 				     struct printk_info *info)
2128 {
2129 	return 0;
2130 }
msg_print_ext_body(char * buf,size_t size,char * text,size_t text_len,struct dev_printk_info * dev_info)2131 static ssize_t msg_print_ext_body(char *buf, size_t size,
2132 				  char *text, size_t text_len,
2133 				  struct dev_printk_info *dev_info) { return 0; }
console_lock_spinning_enable(void)2134 static void console_lock_spinning_enable(void) { }
console_lock_spinning_disable_and_check(void)2135 static int console_lock_spinning_disable_and_check(void) { return 0; }
call_console_drivers(const char * ext_text,size_t ext_len,const char * text,size_t len)2136 static void call_console_drivers(const char *ext_text, size_t ext_len,
2137 				 const char *text, size_t len) {}
suppress_message_printing(int level)2138 static bool suppress_message_printing(int level) { return false; }
2139 
2140 #endif /* CONFIG_PRINTK */
2141 
2142 #ifdef CONFIG_EARLY_PRINTK
2143 struct console *early_console;
2144 
early_printk(const char * fmt,...)2145 asmlinkage __visible void early_printk(const char *fmt, ...)
2146 {
2147 	va_list ap;
2148 	char buf[512];
2149 	int n;
2150 
2151 	if (!early_console)
2152 		return;
2153 
2154 	va_start(ap, fmt);
2155 	n = vscnprintf(buf, sizeof(buf), fmt, ap);
2156 	va_end(ap);
2157 
2158 	early_console->write(early_console, buf, n);
2159 }
2160 #endif
2161 
__add_preferred_console(char * name,int idx,char * options,char * brl_options,bool user_specified)2162 static int __add_preferred_console(char *name, int idx, char *options,
2163 				   char *brl_options, bool user_specified)
2164 {
2165 	struct console_cmdline *c;
2166 	int i;
2167 
2168 	/*
2169 	 *	See if this tty is not yet registered, and
2170 	 *	if we have a slot free.
2171 	 */
2172 	for (i = 0, c = console_cmdline;
2173 	     i < MAX_CMDLINECONSOLES && c->name[0];
2174 	     i++, c++) {
2175 		if (strcmp(c->name, name) == 0 && c->index == idx) {
2176 			if (!brl_options)
2177 				preferred_console = i;
2178 			if (user_specified)
2179 				c->user_specified = true;
2180 			return 0;
2181 		}
2182 	}
2183 	if (i == MAX_CMDLINECONSOLES)
2184 		return -E2BIG;
2185 	if (!brl_options)
2186 		preferred_console = i;
2187 	strlcpy(c->name, name, sizeof(c->name));
2188 	c->options = options;
2189 	c->user_specified = user_specified;
2190 	braille_set_options(c, brl_options);
2191 
2192 	c->index = idx;
2193 	return 0;
2194 }
2195 
console_msg_format_setup(char * str)2196 static int __init console_msg_format_setup(char *str)
2197 {
2198 	if (!strcmp(str, "syslog"))
2199 		console_msg_format = MSG_FORMAT_SYSLOG;
2200 	if (!strcmp(str, "default"))
2201 		console_msg_format = MSG_FORMAT_DEFAULT;
2202 	return 1;
2203 }
2204 __setup("console_msg_format=", console_msg_format_setup);
2205 
2206 /*
2207  * Set up a console.  Called via do_early_param() in init/main.c
2208  * for each "console=" parameter in the boot command line.
2209  */
console_setup(char * str)2210 static int __init console_setup(char *str)
2211 {
2212 	char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for "ttyS" */
2213 	char *s, *options, *brl_options = NULL;
2214 	int idx;
2215 
2216 	/*
2217 	 * console="" or console=null have been suggested as a way to
2218 	 * disable console output. Use ttynull that has been created
2219 	 * for exacly this purpose.
2220 	 */
2221 	if (str[0] == 0 || strcmp(str, "null") == 0) {
2222 		__add_preferred_console("ttynull", 0, NULL, NULL, true);
2223 		return 1;
2224 	}
2225 
2226 	if (_braille_console_setup(&str, &brl_options))
2227 		return 1;
2228 
2229 	/*
2230 	 * Decode str into name, index, options.
2231 	 */
2232 	if (str[0] >= '0' && str[0] <= '9') {
2233 		strcpy(buf, "ttyS");
2234 		strncpy(buf + 4, str, sizeof(buf) - 5);
2235 	} else {
2236 		strncpy(buf, str, sizeof(buf) - 1);
2237 	}
2238 	buf[sizeof(buf) - 1] = 0;
2239 	options = strchr(str, ',');
2240 	if (options)
2241 		*(options++) = 0;
2242 #ifdef __sparc__
2243 	if (!strcmp(str, "ttya"))
2244 		strcpy(buf, "ttyS0");
2245 	if (!strcmp(str, "ttyb"))
2246 		strcpy(buf, "ttyS1");
2247 #endif
2248 	for (s = buf; *s; s++)
2249 		if (isdigit(*s) || *s == ',')
2250 			break;
2251 	idx = simple_strtoul(s, NULL, 10);
2252 	*s = 0;
2253 
2254 	__add_preferred_console(buf, idx, options, brl_options, true);
2255 	console_set_on_cmdline = 1;
2256 	return 1;
2257 }
2258 __setup("console=", console_setup);
2259 
2260 /**
2261  * add_preferred_console - add a device to the list of preferred consoles.
2262  * @name: device name
2263  * @idx: device index
2264  * @options: options for this console
2265  *
2266  * The last preferred console added will be used for kernel messages
2267  * and stdin/out/err for init.  Normally this is used by console_setup
2268  * above to handle user-supplied console arguments; however it can also
2269  * be used by arch-specific code either to override the user or more
2270  * commonly to provide a default console (ie from PROM variables) when
2271  * the user has not supplied one.
2272  */
add_preferred_console(char * name,int idx,char * options)2273 int add_preferred_console(char *name, int idx, char *options)
2274 {
2275 	return __add_preferred_console(name, idx, options, NULL, false);
2276 }
2277 
2278 bool console_suspend_enabled = true;
2279 EXPORT_SYMBOL(console_suspend_enabled);
2280 
console_suspend_disable(char * str)2281 static int __init console_suspend_disable(char *str)
2282 {
2283 	console_suspend_enabled = false;
2284 	return 1;
2285 }
2286 __setup("no_console_suspend", console_suspend_disable);
2287 module_param_named(console_suspend, console_suspend_enabled,
2288 		bool, S_IRUGO | S_IWUSR);
2289 MODULE_PARM_DESC(console_suspend, "suspend console during suspend"
2290 	" and hibernate operations");
2291 
2292 /**
2293  * suspend_console - suspend the console subsystem
2294  *
2295  * This disables printk() while we go into suspend states
2296  */
suspend_console(void)2297 void suspend_console(void)
2298 {
2299 	if (!console_suspend_enabled)
2300 		return;
2301 	pr_info("Suspending console(s) (use no_console_suspend to debug)\n");
2302 	console_lock();
2303 	console_suspended = 1;
2304 	up_console_sem();
2305 }
2306 
resume_console(void)2307 void resume_console(void)
2308 {
2309 	if (!console_suspend_enabled)
2310 		return;
2311 	down_console_sem();
2312 	console_suspended = 0;
2313 	console_unlock();
2314 }
2315 
2316 /**
2317  * console_cpu_notify - print deferred console messages after CPU hotplug
2318  * @cpu: unused
2319  *
2320  * If printk() is called from a CPU that is not online yet, the messages
2321  * will be printed on the console only if there are CON_ANYTIME consoles.
2322  * This function is called when a new CPU comes online (or fails to come
2323  * up) or goes offline.
2324  */
console_cpu_notify(unsigned int cpu)2325 static int console_cpu_notify(unsigned int cpu)
2326 {
2327 	if (!cpuhp_tasks_frozen) {
2328 		/* If trylock fails, someone else is doing the printing */
2329 		if (console_trylock())
2330 			console_unlock();
2331 	}
2332 	return 0;
2333 }
2334 
2335 /**
2336  * console_lock - lock the console system for exclusive use.
2337  *
2338  * Acquires a lock which guarantees that the caller has
2339  * exclusive access to the console system and the console_drivers list.
2340  *
2341  * Can sleep, returns nothing.
2342  */
console_lock(void)2343 void console_lock(void)
2344 {
2345 	might_sleep();
2346 
2347 	down_console_sem();
2348 	if (console_suspended)
2349 		return;
2350 	console_locked = 1;
2351 	console_may_schedule = 1;
2352 }
2353 EXPORT_SYMBOL(console_lock);
2354 
2355 /**
2356  * console_trylock - try to lock the console system for exclusive use.
2357  *
2358  * Try to acquire a lock which guarantees that the caller has exclusive
2359  * access to the console system and the console_drivers list.
2360  *
2361  * returns 1 on success, and 0 on failure to acquire the lock.
2362  */
console_trylock(void)2363 int console_trylock(void)
2364 {
2365 	if (down_trylock_console_sem())
2366 		return 0;
2367 	if (console_suspended) {
2368 		up_console_sem();
2369 		return 0;
2370 	}
2371 	console_locked = 1;
2372 	console_may_schedule = 0;
2373 	return 1;
2374 }
2375 EXPORT_SYMBOL(console_trylock);
2376 
is_console_locked(void)2377 int is_console_locked(void)
2378 {
2379 	return console_locked;
2380 }
2381 EXPORT_SYMBOL(is_console_locked);
2382 
2383 /*
2384  * Check if we have any console that is capable of printing while cpu is
2385  * booting or shutting down. Requires console_sem.
2386  */
have_callable_console(void)2387 static int have_callable_console(void)
2388 {
2389 	struct console *con;
2390 
2391 	for_each_console(con)
2392 		if ((con->flags & CON_ENABLED) &&
2393 				(con->flags & CON_ANYTIME))
2394 			return 1;
2395 
2396 	return 0;
2397 }
2398 
2399 /*
2400  * Can we actually use the console at this time on this cpu?
2401  *
2402  * Console drivers may assume that per-cpu resources have been allocated. So
2403  * unless they're explicitly marked as being able to cope (CON_ANYTIME) don't
2404  * call them until this CPU is officially up.
2405  */
can_use_console(void)2406 static inline int can_use_console(void)
2407 {
2408 	return cpu_online(raw_smp_processor_id()) || have_callable_console();
2409 }
2410 
2411 /**
2412  * console_unlock - unlock the console system
2413  *
2414  * Releases the console_lock which the caller holds on the console system
2415  * and the console driver list.
2416  *
2417  * While the console_lock was held, console output may have been buffered
2418  * by printk().  If this is the case, console_unlock(); emits
2419  * the output prior to releasing the lock.
2420  *
2421  * If there is output waiting, we wake /dev/kmsg and syslog() users.
2422  *
2423  * console_unlock(); may be called from any context.
2424  */
console_unlock(void)2425 void console_unlock(void)
2426 {
2427 	static char ext_text[CONSOLE_EXT_LOG_MAX];
2428 	static char text[LOG_LINE_MAX + PREFIX_MAX];
2429 	unsigned long flags;
2430 	bool do_cond_resched, retry;
2431 	struct printk_info info;
2432 	struct printk_record r;
2433 
2434 	if (console_suspended) {
2435 		up_console_sem();
2436 		return;
2437 	}
2438 
2439 	prb_rec_init_rd(&r, &info, text, sizeof(text));
2440 
2441 	/*
2442 	 * Console drivers are called with interrupts disabled, so
2443 	 * @console_may_schedule should be cleared before; however, we may
2444 	 * end up dumping a lot of lines, for example, if called from
2445 	 * console registration path, and should invoke cond_resched()
2446 	 * between lines if allowable.  Not doing so can cause a very long
2447 	 * scheduling stall on a slow console leading to RCU stall and
2448 	 * softlockup warnings which exacerbate the issue with more
2449 	 * messages practically incapacitating the system.
2450 	 *
2451 	 * console_trylock() is not able to detect the preemptive
2452 	 * context reliably. Therefore the value must be stored before
2453 	 * and cleared after the "again" goto label.
2454 	 */
2455 	do_cond_resched = console_may_schedule;
2456 again:
2457 	console_may_schedule = 0;
2458 
2459 	/*
2460 	 * We released the console_sem lock, so we need to recheck if
2461 	 * cpu is online and (if not) is there at least one CON_ANYTIME
2462 	 * console.
2463 	 */
2464 	if (!can_use_console()) {
2465 		console_locked = 0;
2466 		up_console_sem();
2467 		return;
2468 	}
2469 
2470 	for (;;) {
2471 		size_t ext_len = 0;
2472 		size_t len;
2473 
2474 		printk_safe_enter_irqsave(flags);
2475 		raw_spin_lock(&logbuf_lock);
2476 skip:
2477 		if (!prb_read_valid(prb, console_seq, &r))
2478 			break;
2479 
2480 		if (console_seq != r.info->seq) {
2481 			console_dropped += r.info->seq - console_seq;
2482 			console_seq = r.info->seq;
2483 		}
2484 
2485 		if (suppress_message_printing(r.info->level)) {
2486 			/*
2487 			 * Skip record we have buffered and already printed
2488 			 * directly to the console when we received it, and
2489 			 * record that has level above the console loglevel.
2490 			 */
2491 			console_seq++;
2492 			goto skip;
2493 		}
2494 
2495 		/* Output to all consoles once old messages replayed. */
2496 		if (unlikely(exclusive_console &&
2497 			     console_seq >= exclusive_console_stop_seq)) {
2498 			exclusive_console = NULL;
2499 		}
2500 
2501 		/*
2502 		 * Handle extended console text first because later
2503 		 * record_print_text() will modify the record buffer in-place.
2504 		 */
2505 		if (nr_ext_console_drivers) {
2506 			ext_len = info_print_ext_header(ext_text,
2507 						sizeof(ext_text),
2508 						r.info);
2509 			ext_len += msg_print_ext_body(ext_text + ext_len,
2510 						sizeof(ext_text) - ext_len,
2511 						&r.text_buf[0],
2512 						r.info->text_len,
2513 						&r.info->dev_info);
2514 		}
2515 		len = record_print_text(&r,
2516 				console_msg_format & MSG_FORMAT_SYSLOG,
2517 				printk_time);
2518 		console_seq++;
2519 		raw_spin_unlock(&logbuf_lock);
2520 
2521 		/*
2522 		 * While actively printing out messages, if another printk()
2523 		 * were to occur on another CPU, it may wait for this one to
2524 		 * finish. This task can not be preempted if there is a
2525 		 * waiter waiting to take over.
2526 		 */
2527 		console_lock_spinning_enable();
2528 
2529 		stop_critical_timings();	/* don't trace print latency */
2530 		call_console_drivers(ext_text, ext_len, text, len);
2531 		start_critical_timings();
2532 
2533 		if (console_lock_spinning_disable_and_check()) {
2534 			printk_safe_exit_irqrestore(flags);
2535 			return;
2536 		}
2537 
2538 		printk_safe_exit_irqrestore(flags);
2539 
2540 		if (do_cond_resched)
2541 			cond_resched();
2542 	}
2543 
2544 	console_locked = 0;
2545 
2546 	raw_spin_unlock(&logbuf_lock);
2547 
2548 	up_console_sem();
2549 
2550 	/*
2551 	 * Someone could have filled up the buffer again, so re-check if there's
2552 	 * something to flush. In case we cannot trylock the console_sem again,
2553 	 * there's a new owner and the console_unlock() from them will do the
2554 	 * flush, no worries.
2555 	 */
2556 	raw_spin_lock(&logbuf_lock);
2557 	retry = prb_read_valid(prb, console_seq, NULL);
2558 	raw_spin_unlock(&logbuf_lock);
2559 	printk_safe_exit_irqrestore(flags);
2560 
2561 	if (retry && console_trylock())
2562 		goto again;
2563 }
2564 EXPORT_SYMBOL(console_unlock);
2565 
2566 /**
2567  * console_conditional_schedule - yield the CPU if required
2568  *
2569  * If the console code is currently allowed to sleep, and
2570  * if this CPU should yield the CPU to another task, do
2571  * so here.
2572  *
2573  * Must be called within console_lock();.
2574  */
console_conditional_schedule(void)2575 void __sched console_conditional_schedule(void)
2576 {
2577 	if (console_may_schedule)
2578 		cond_resched();
2579 }
2580 EXPORT_SYMBOL(console_conditional_schedule);
2581 
console_unblank(void)2582 void console_unblank(void)
2583 {
2584 	struct console *c;
2585 
2586 	/*
2587 	 * console_unblank can no longer be called in interrupt context unless
2588 	 * oops_in_progress is set to 1..
2589 	 */
2590 	if (oops_in_progress) {
2591 		if (down_trylock_console_sem() != 0)
2592 			return;
2593 	} else
2594 		console_lock();
2595 
2596 	console_locked = 1;
2597 	console_may_schedule = 0;
2598 	for_each_console(c)
2599 		if ((c->flags & CON_ENABLED) && c->unblank)
2600 			c->unblank();
2601 	console_unlock();
2602 }
2603 
2604 /**
2605  * console_flush_on_panic - flush console content on panic
2606  * @mode: flush all messages in buffer or just the pending ones
2607  *
2608  * Immediately output all pending messages no matter what.
2609  */
console_flush_on_panic(enum con_flush_mode mode)2610 void console_flush_on_panic(enum con_flush_mode mode)
2611 {
2612 	/*
2613 	 * If someone else is holding the console lock, trylock will fail
2614 	 * and may_schedule may be set.  Ignore and proceed to unlock so
2615 	 * that messages are flushed out.  As this can be called from any
2616 	 * context and we don't want to get preempted while flushing,
2617 	 * ensure may_schedule is cleared.
2618 	 */
2619 	console_trylock();
2620 	console_may_schedule = 0;
2621 
2622 	if (mode == CONSOLE_REPLAY_ALL) {
2623 		unsigned long flags;
2624 
2625 		logbuf_lock_irqsave(flags);
2626 		console_seq = prb_first_valid_seq(prb);
2627 		logbuf_unlock_irqrestore(flags);
2628 	}
2629 	console_unlock();
2630 }
2631 
2632 /*
2633  * Return the console tty driver structure and its associated index
2634  */
console_device(int * index)2635 struct tty_driver *console_device(int *index)
2636 {
2637 	struct console *c;
2638 	struct tty_driver *driver = NULL;
2639 
2640 	console_lock();
2641 	for_each_console(c) {
2642 		if (!c->device)
2643 			continue;
2644 		driver = c->device(c, index);
2645 		if (driver)
2646 			break;
2647 	}
2648 	console_unlock();
2649 	return driver;
2650 }
2651 
2652 /*
2653  * Prevent further output on the passed console device so that (for example)
2654  * serial drivers can disable console output before suspending a port, and can
2655  * re-enable output afterwards.
2656  */
console_stop(struct console * console)2657 void console_stop(struct console *console)
2658 {
2659 	console_lock();
2660 	console->flags &= ~CON_ENABLED;
2661 	console_unlock();
2662 }
2663 EXPORT_SYMBOL(console_stop);
2664 
console_start(struct console * console)2665 void console_start(struct console *console)
2666 {
2667 	console_lock();
2668 	console->flags |= CON_ENABLED;
2669 	console_unlock();
2670 }
2671 EXPORT_SYMBOL(console_start);
2672 
2673 static int __read_mostly keep_bootcon;
2674 
keep_bootcon_setup(char * str)2675 static int __init keep_bootcon_setup(char *str)
2676 {
2677 	keep_bootcon = 1;
2678 	pr_info("debug: skip boot console de-registration.\n");
2679 
2680 	return 0;
2681 }
2682 
2683 early_param("keep_bootcon", keep_bootcon_setup);
2684 
2685 /*
2686  * This is called by register_console() to try to match
2687  * the newly registered console with any of the ones selected
2688  * by either the command line or add_preferred_console() and
2689  * setup/enable it.
2690  *
2691  * Care need to be taken with consoles that are statically
2692  * enabled such as netconsole
2693  */
try_enable_new_console(struct console * newcon,bool user_specified)2694 static int try_enable_new_console(struct console *newcon, bool user_specified)
2695 {
2696 	struct console_cmdline *c;
2697 	int i, err;
2698 
2699 	for (i = 0, c = console_cmdline;
2700 	     i < MAX_CMDLINECONSOLES && c->name[0];
2701 	     i++, c++) {
2702 		if (c->user_specified != user_specified)
2703 			continue;
2704 		if (!newcon->match ||
2705 		    newcon->match(newcon, c->name, c->index, c->options) != 0) {
2706 			/* default matching */
2707 			BUILD_BUG_ON(sizeof(c->name) != sizeof(newcon->name));
2708 			if (strcmp(c->name, newcon->name) != 0)
2709 				continue;
2710 			if (newcon->index >= 0 &&
2711 			    newcon->index != c->index)
2712 				continue;
2713 			if (newcon->index < 0)
2714 				newcon->index = c->index;
2715 
2716 			if (_braille_register_console(newcon, c))
2717 				return 0;
2718 
2719 			if (newcon->setup &&
2720 			    (err = newcon->setup(newcon, c->options)) != 0)
2721 				return err;
2722 		}
2723 		newcon->flags |= CON_ENABLED;
2724 		if (i == preferred_console) {
2725 			newcon->flags |= CON_CONSDEV;
2726 			has_preferred_console = true;
2727 		}
2728 		return 0;
2729 	}
2730 
2731 	/*
2732 	 * Some consoles, such as pstore and netconsole, can be enabled even
2733 	 * without matching. Accept the pre-enabled consoles only when match()
2734 	 * and setup() had a chance to be called.
2735 	 */
2736 	if (newcon->flags & CON_ENABLED && c->user_specified ==	user_specified)
2737 		return 0;
2738 
2739 	return -ENOENT;
2740 }
2741 
2742 /*
2743  * The console driver calls this routine during kernel initialization
2744  * to register the console printing procedure with printk() and to
2745  * print any messages that were printed by the kernel before the
2746  * console driver was initialized.
2747  *
2748  * This can happen pretty early during the boot process (because of
2749  * early_printk) - sometimes before setup_arch() completes - be careful
2750  * of what kernel features are used - they may not be initialised yet.
2751  *
2752  * There are two types of consoles - bootconsoles (early_printk) and
2753  * "real" consoles (everything which is not a bootconsole) which are
2754  * handled differently.
2755  *  - Any number of bootconsoles can be registered at any time.
2756  *  - As soon as a "real" console is registered, all bootconsoles
2757  *    will be unregistered automatically.
2758  *  - Once a "real" console is registered, any attempt to register a
2759  *    bootconsoles will be rejected
2760  */
register_console(struct console * newcon)2761 void register_console(struct console *newcon)
2762 {
2763 	unsigned long flags;
2764 	struct console *bcon = NULL;
2765 	int err;
2766 
2767 	for_each_console(bcon) {
2768 		if (WARN(bcon == newcon, "console '%s%d' already registered\n",
2769 					 bcon->name, bcon->index))
2770 			return;
2771 	}
2772 
2773 	/*
2774 	 * before we register a new CON_BOOT console, make sure we don't
2775 	 * already have a valid console
2776 	 */
2777 	if (newcon->flags & CON_BOOT) {
2778 		for_each_console(bcon) {
2779 			if (!(bcon->flags & CON_BOOT)) {
2780 				pr_info("Too late to register bootconsole %s%d\n",
2781 					newcon->name, newcon->index);
2782 				return;
2783 			}
2784 		}
2785 	}
2786 
2787 	if (console_drivers && console_drivers->flags & CON_BOOT)
2788 		bcon = console_drivers;
2789 
2790 	if (!has_preferred_console || bcon || !console_drivers)
2791 		has_preferred_console = preferred_console >= 0;
2792 
2793 	/*
2794 	 *	See if we want to use this console driver. If we
2795 	 *	didn't select a console we take the first one
2796 	 *	that registers here.
2797 	 */
2798 	if (!has_preferred_console) {
2799 		if (newcon->index < 0)
2800 			newcon->index = 0;
2801 		if (newcon->setup == NULL ||
2802 		    newcon->setup(newcon, NULL) == 0) {
2803 			newcon->flags |= CON_ENABLED;
2804 			if (newcon->device) {
2805 				newcon->flags |= CON_CONSDEV;
2806 				has_preferred_console = true;
2807 			}
2808 		}
2809 	}
2810 
2811 	/* See if this console matches one we selected on the command line */
2812 	err = try_enable_new_console(newcon, true);
2813 
2814 	/* If not, try to match against the platform default(s) */
2815 	if (err == -ENOENT)
2816 		err = try_enable_new_console(newcon, false);
2817 
2818 	/* printk() messages are not printed to the Braille console. */
2819 	if (err || newcon->flags & CON_BRL)
2820 		return;
2821 
2822 	/*
2823 	 * If we have a bootconsole, and are switching to a real console,
2824 	 * don't print everything out again, since when the boot console, and
2825 	 * the real console are the same physical device, it's annoying to
2826 	 * see the beginning boot messages twice
2827 	 */
2828 	if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
2829 		newcon->flags &= ~CON_PRINTBUFFER;
2830 
2831 	/*
2832 	 *	Put this console in the list - keep the
2833 	 *	preferred driver at the head of the list.
2834 	 */
2835 	console_lock();
2836 	if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
2837 		newcon->next = console_drivers;
2838 		console_drivers = newcon;
2839 		if (newcon->next)
2840 			newcon->next->flags &= ~CON_CONSDEV;
2841 		/* Ensure this flag is always set for the head of the list */
2842 		newcon->flags |= CON_CONSDEV;
2843 	} else {
2844 		newcon->next = console_drivers->next;
2845 		console_drivers->next = newcon;
2846 	}
2847 
2848 	if (newcon->flags & CON_EXTENDED)
2849 		nr_ext_console_drivers++;
2850 
2851 	if (newcon->flags & CON_PRINTBUFFER) {
2852 		/*
2853 		 * console_unlock(); will print out the buffered messages
2854 		 * for us.
2855 		 */
2856 		logbuf_lock_irqsave(flags);
2857 		/*
2858 		 * We're about to replay the log buffer.  Only do this to the
2859 		 * just-registered console to avoid excessive message spam to
2860 		 * the already-registered consoles.
2861 		 *
2862 		 * Set exclusive_console with disabled interrupts to reduce
2863 		 * race window with eventual console_flush_on_panic() that
2864 		 * ignores console_lock.
2865 		 */
2866 		exclusive_console = newcon;
2867 		exclusive_console_stop_seq = console_seq;
2868 		console_seq = syslog_seq;
2869 		logbuf_unlock_irqrestore(flags);
2870 	}
2871 	console_unlock();
2872 	console_sysfs_notify();
2873 
2874 	/*
2875 	 * By unregistering the bootconsoles after we enable the real console
2876 	 * we get the "console xxx enabled" message on all the consoles -
2877 	 * boot consoles, real consoles, etc - this is to ensure that end
2878 	 * users know there might be something in the kernel's log buffer that
2879 	 * went to the bootconsole (that they do not see on the real console)
2880 	 */
2881 	pr_info("%sconsole [%s%d] enabled\n",
2882 		(newcon->flags & CON_BOOT) ? "boot" : "" ,
2883 		newcon->name, newcon->index);
2884 	if (bcon &&
2885 	    ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
2886 	    !keep_bootcon) {
2887 		/* We need to iterate through all boot consoles, to make
2888 		 * sure we print everything out, before we unregister them.
2889 		 */
2890 		for_each_console(bcon)
2891 			if (bcon->flags & CON_BOOT)
2892 				unregister_console(bcon);
2893 	}
2894 }
2895 EXPORT_SYMBOL(register_console);
2896 
unregister_console(struct console * console)2897 int unregister_console(struct console *console)
2898 {
2899 	struct console *con;
2900 	int res;
2901 
2902 	pr_info("%sconsole [%s%d] disabled\n",
2903 		(console->flags & CON_BOOT) ? "boot" : "" ,
2904 		console->name, console->index);
2905 
2906 	res = _braille_unregister_console(console);
2907 	if (res < 0)
2908 		return res;
2909 	if (res > 0)
2910 		return 0;
2911 
2912 	res = -ENODEV;
2913 	console_lock();
2914 	if (console_drivers == console) {
2915 		console_drivers=console->next;
2916 		res = 0;
2917 	} else {
2918 		for_each_console(con) {
2919 			if (con->next == console) {
2920 				con->next = console->next;
2921 				res = 0;
2922 				break;
2923 			}
2924 		}
2925 	}
2926 
2927 	if (res)
2928 		goto out_disable_unlock;
2929 
2930 	if (console->flags & CON_EXTENDED)
2931 		nr_ext_console_drivers--;
2932 
2933 	/*
2934 	 * If this isn't the last console and it has CON_CONSDEV set, we
2935 	 * need to set it on the next preferred console.
2936 	 */
2937 	if (console_drivers != NULL && console->flags & CON_CONSDEV)
2938 		console_drivers->flags |= CON_CONSDEV;
2939 
2940 	console->flags &= ~CON_ENABLED;
2941 	console_unlock();
2942 	console_sysfs_notify();
2943 
2944 	if (console->exit)
2945 		res = console->exit(console);
2946 
2947 	return res;
2948 
2949 out_disable_unlock:
2950 	console->flags &= ~CON_ENABLED;
2951 	console_unlock();
2952 
2953 	return res;
2954 }
2955 EXPORT_SYMBOL(unregister_console);
2956 
2957 /*
2958  * Initialize the console device. This is called *early*, so
2959  * we can't necessarily depend on lots of kernel help here.
2960  * Just do some early initializations, and do the complex setup
2961  * later.
2962  */
console_init(void)2963 void __init console_init(void)
2964 {
2965 	int ret;
2966 	initcall_t call;
2967 	initcall_entry_t *ce;
2968 
2969 	/* Setup the default TTY line discipline. */
2970 	n_tty_init();
2971 
2972 	/*
2973 	 * set up the console device so that later boot sequences can
2974 	 * inform about problems etc..
2975 	 */
2976 	ce = __con_initcall_start;
2977 	trace_initcall_level("console");
2978 	while (ce < __con_initcall_end) {
2979 		call = initcall_from_entry(ce);
2980 		trace_initcall_start(call);
2981 		ret = call();
2982 		trace_initcall_finish(call, ret);
2983 		ce++;
2984 	}
2985 }
2986 
2987 /*
2988  * Some boot consoles access data that is in the init section and which will
2989  * be discarded after the initcalls have been run. To make sure that no code
2990  * will access this data, unregister the boot consoles in a late initcall.
2991  *
2992  * If for some reason, such as deferred probe or the driver being a loadable
2993  * module, the real console hasn't registered yet at this point, there will
2994  * be a brief interval in which no messages are logged to the console, which
2995  * makes it difficult to diagnose problems that occur during this time.
2996  *
2997  * To mitigate this problem somewhat, only unregister consoles whose memory
2998  * intersects with the init section. Note that all other boot consoles will
2999  * get unregistred when the real preferred console is registered.
3000  */
printk_late_init(void)3001 static int __init printk_late_init(void)
3002 {
3003 	struct console *con;
3004 	int ret;
3005 
3006 	for_each_console(con) {
3007 		if (!(con->flags & CON_BOOT))
3008 			continue;
3009 
3010 		/* Check addresses that might be used for enabled consoles. */
3011 		if (init_section_intersects(con, sizeof(*con)) ||
3012 		    init_section_contains(con->write, 0) ||
3013 		    init_section_contains(con->read, 0) ||
3014 		    init_section_contains(con->device, 0) ||
3015 		    init_section_contains(con->unblank, 0) ||
3016 		    init_section_contains(con->data, 0)) {
3017 			/*
3018 			 * Please, consider moving the reported consoles out
3019 			 * of the init section.
3020 			 */
3021 			pr_warn("bootconsole [%s%d] uses init memory and must be disabled even before the real one is ready\n",
3022 				con->name, con->index);
3023 			unregister_console(con);
3024 		}
3025 	}
3026 	ret = cpuhp_setup_state_nocalls(CPUHP_PRINTK_DEAD, "printk:dead", NULL,
3027 					console_cpu_notify);
3028 	WARN_ON(ret < 0);
3029 	ret = cpuhp_setup_state_nocalls(CPUHP_AP_ONLINE_DYN, "printk:online",
3030 					console_cpu_notify, NULL);
3031 	WARN_ON(ret < 0);
3032 	return 0;
3033 }
3034 late_initcall(printk_late_init);
3035 
3036 #if defined CONFIG_PRINTK
3037 /*
3038  * Delayed printk version, for scheduler-internal messages:
3039  */
3040 #define PRINTK_PENDING_WAKEUP	0x01
3041 #define PRINTK_PENDING_OUTPUT	0x02
3042 
3043 static DEFINE_PER_CPU(int, printk_pending);
3044 
wake_up_klogd_work_func(struct irq_work * irq_work)3045 static void wake_up_klogd_work_func(struct irq_work *irq_work)
3046 {
3047 	int pending = __this_cpu_xchg(printk_pending, 0);
3048 
3049 	if (pending & PRINTK_PENDING_OUTPUT) {
3050 		/* If trylock fails, someone else is doing the printing */
3051 		if (console_trylock())
3052 			console_unlock();
3053 	}
3054 
3055 	if (pending & PRINTK_PENDING_WAKEUP)
3056 		wake_up_interruptible(&log_wait);
3057 }
3058 
3059 static DEFINE_PER_CPU(struct irq_work, wake_up_klogd_work) = {
3060 	.func = wake_up_klogd_work_func,
3061 	.flags = ATOMIC_INIT(IRQ_WORK_LAZY),
3062 };
3063 
wake_up_klogd(void)3064 void wake_up_klogd(void)
3065 {
3066 	if (!printk_percpu_data_ready())
3067 		return;
3068 
3069 	preempt_disable();
3070 	if (waitqueue_active(&log_wait)) {
3071 		this_cpu_or(printk_pending, PRINTK_PENDING_WAKEUP);
3072 		irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
3073 	}
3074 	preempt_enable();
3075 }
3076 
defer_console_output(void)3077 void defer_console_output(void)
3078 {
3079 	if (!printk_percpu_data_ready())
3080 		return;
3081 
3082 	preempt_disable();
3083 	__this_cpu_or(printk_pending, PRINTK_PENDING_OUTPUT);
3084 	irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
3085 	preempt_enable();
3086 }
3087 
vprintk_deferred(const char * fmt,va_list args)3088 int vprintk_deferred(const char *fmt, va_list args)
3089 {
3090 	int r;
3091 
3092 	r = vprintk_emit(0, LOGLEVEL_SCHED, NULL, fmt, args);
3093 	defer_console_output();
3094 
3095 	return r;
3096 }
3097 
printk_deferred(const char * fmt,...)3098 int printk_deferred(const char *fmt, ...)
3099 {
3100 	va_list args;
3101 	int r;
3102 
3103 	va_start(args, fmt);
3104 	r = vprintk_deferred(fmt, args);
3105 	va_end(args);
3106 
3107 	return r;
3108 }
3109 
3110 /*
3111  * printk rate limiting, lifted from the networking subsystem.
3112  *
3113  * This enforces a rate limit: not more than 10 kernel messages
3114  * every 5s to make a denial-of-service attack impossible.
3115  */
3116 DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
3117 
__printk_ratelimit(const char * func)3118 int __printk_ratelimit(const char *func)
3119 {
3120 	return ___ratelimit(&printk_ratelimit_state, func);
3121 }
3122 EXPORT_SYMBOL(__printk_ratelimit);
3123 
3124 /**
3125  * printk_timed_ratelimit - caller-controlled printk ratelimiting
3126  * @caller_jiffies: pointer to caller's state
3127  * @interval_msecs: minimum interval between prints
3128  *
3129  * printk_timed_ratelimit() returns true if more than @interval_msecs
3130  * milliseconds have elapsed since the last time printk_timed_ratelimit()
3131  * returned true.
3132  */
printk_timed_ratelimit(unsigned long * caller_jiffies,unsigned int interval_msecs)3133 bool printk_timed_ratelimit(unsigned long *caller_jiffies,
3134 			unsigned int interval_msecs)
3135 {
3136 	unsigned long elapsed = jiffies - *caller_jiffies;
3137 
3138 	if (*caller_jiffies && elapsed <= msecs_to_jiffies(interval_msecs))
3139 		return false;
3140 
3141 	*caller_jiffies = jiffies;
3142 	return true;
3143 }
3144 EXPORT_SYMBOL(printk_timed_ratelimit);
3145 
3146 static DEFINE_SPINLOCK(dump_list_lock);
3147 static LIST_HEAD(dump_list);
3148 
3149 /**
3150  * kmsg_dump_register - register a kernel log dumper.
3151  * @dumper: pointer to the kmsg_dumper structure
3152  *
3153  * Adds a kernel log dumper to the system. The dump callback in the
3154  * structure will be called when the kernel oopses or panics and must be
3155  * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
3156  */
kmsg_dump_register(struct kmsg_dumper * dumper)3157 int kmsg_dump_register(struct kmsg_dumper *dumper)
3158 {
3159 	unsigned long flags;
3160 	int err = -EBUSY;
3161 
3162 	/* The dump callback needs to be set */
3163 	if (!dumper->dump)
3164 		return -EINVAL;
3165 
3166 	spin_lock_irqsave(&dump_list_lock, flags);
3167 	/* Don't allow registering multiple times */
3168 	if (!dumper->registered) {
3169 		dumper->registered = 1;
3170 		list_add_tail_rcu(&dumper->list, &dump_list);
3171 		err = 0;
3172 	}
3173 	spin_unlock_irqrestore(&dump_list_lock, flags);
3174 
3175 	return err;
3176 }
3177 EXPORT_SYMBOL_GPL(kmsg_dump_register);
3178 
3179 /**
3180  * kmsg_dump_unregister - unregister a kmsg dumper.
3181  * @dumper: pointer to the kmsg_dumper structure
3182  *
3183  * Removes a dump device from the system. Returns zero on success and
3184  * %-EINVAL otherwise.
3185  */
kmsg_dump_unregister(struct kmsg_dumper * dumper)3186 int kmsg_dump_unregister(struct kmsg_dumper *dumper)
3187 {
3188 	unsigned long flags;
3189 	int err = -EINVAL;
3190 
3191 	spin_lock_irqsave(&dump_list_lock, flags);
3192 	if (dumper->registered) {
3193 		dumper->registered = 0;
3194 		list_del_rcu(&dumper->list);
3195 		err = 0;
3196 	}
3197 	spin_unlock_irqrestore(&dump_list_lock, flags);
3198 	synchronize_rcu();
3199 
3200 	return err;
3201 }
3202 EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
3203 
3204 static bool always_kmsg_dump;
3205 module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);
3206 
kmsg_dump_reason_str(enum kmsg_dump_reason reason)3207 const char *kmsg_dump_reason_str(enum kmsg_dump_reason reason)
3208 {
3209 	switch (reason) {
3210 	case KMSG_DUMP_PANIC:
3211 		return "Panic";
3212 	case KMSG_DUMP_OOPS:
3213 		return "Oops";
3214 	case KMSG_DUMP_EMERG:
3215 		return "Emergency";
3216 	case KMSG_DUMP_SHUTDOWN:
3217 		return "Shutdown";
3218 	default:
3219 		return "Unknown";
3220 	}
3221 }
3222 EXPORT_SYMBOL_GPL(kmsg_dump_reason_str);
3223 
3224 /**
3225  * kmsg_dump - dump kernel log to kernel message dumpers.
3226  * @reason: the reason (oops, panic etc) for dumping
3227  *
3228  * Call each of the registered dumper's dump() callback, which can
3229  * retrieve the kmsg records with kmsg_dump_get_line() or
3230  * kmsg_dump_get_buffer().
3231  */
kmsg_dump(enum kmsg_dump_reason reason)3232 void kmsg_dump(enum kmsg_dump_reason reason)
3233 {
3234 	struct kmsg_dumper *dumper;
3235 	unsigned long flags;
3236 
3237 	rcu_read_lock();
3238 	list_for_each_entry_rcu(dumper, &dump_list, list) {
3239 		enum kmsg_dump_reason max_reason = dumper->max_reason;
3240 
3241 		/*
3242 		 * If client has not provided a specific max_reason, default
3243 		 * to KMSG_DUMP_OOPS, unless always_kmsg_dump was set.
3244 		 */
3245 		if (max_reason == KMSG_DUMP_UNDEF) {
3246 			max_reason = always_kmsg_dump ? KMSG_DUMP_MAX :
3247 							KMSG_DUMP_OOPS;
3248 		}
3249 		if (reason > max_reason)
3250 			continue;
3251 
3252 		/* initialize iterator with data about the stored records */
3253 		dumper->active = true;
3254 
3255 		logbuf_lock_irqsave(flags);
3256 		dumper->cur_seq = clear_seq;
3257 		dumper->next_seq = prb_next_seq(prb);
3258 		logbuf_unlock_irqrestore(flags);
3259 
3260 		/* invoke dumper which will iterate over records */
3261 		dumper->dump(dumper, reason);
3262 
3263 		/* reset iterator */
3264 		dumper->active = false;
3265 	}
3266 	rcu_read_unlock();
3267 }
3268 
3269 /**
3270  * kmsg_dump_get_line_nolock - retrieve one kmsg log line (unlocked version)
3271  * @dumper: registered kmsg dumper
3272  * @syslog: include the "<4>" prefixes
3273  * @line: buffer to copy the line to
3274  * @size: maximum size of the buffer
3275  * @len: length of line placed into buffer
3276  *
3277  * Start at the beginning of the kmsg buffer, with the oldest kmsg
3278  * record, and copy one record into the provided buffer.
3279  *
3280  * Consecutive calls will return the next available record moving
3281  * towards the end of the buffer with the youngest messages.
3282  *
3283  * A return value of FALSE indicates that there are no more records to
3284  * read.
3285  *
3286  * The function is similar to kmsg_dump_get_line(), but grabs no locks.
3287  */
kmsg_dump_get_line_nolock(struct kmsg_dumper * dumper,bool syslog,char * line,size_t size,size_t * len)3288 bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper, bool syslog,
3289 			       char *line, size_t size, size_t *len)
3290 {
3291 	struct printk_info info;
3292 	unsigned int line_count;
3293 	struct printk_record r;
3294 	size_t l = 0;
3295 	bool ret = false;
3296 
3297 	prb_rec_init_rd(&r, &info, line, size);
3298 
3299 	if (!dumper->active)
3300 		goto out;
3301 
3302 	/* Read text or count text lines? */
3303 	if (line) {
3304 		if (!prb_read_valid(prb, dumper->cur_seq, &r))
3305 			goto out;
3306 		l = record_print_text(&r, syslog, printk_time);
3307 	} else {
3308 		if (!prb_read_valid_info(prb, dumper->cur_seq,
3309 					 &info, &line_count)) {
3310 			goto out;
3311 		}
3312 		l = get_record_print_text_size(&info, line_count, syslog,
3313 					       printk_time);
3314 
3315 	}
3316 
3317 	dumper->cur_seq = r.info->seq + 1;
3318 	ret = true;
3319 out:
3320 	if (len)
3321 		*len = l;
3322 	return ret;
3323 }
3324 
3325 /**
3326  * kmsg_dump_get_line - retrieve one kmsg log line
3327  * @dumper: registered kmsg dumper
3328  * @syslog: include the "<4>" prefixes
3329  * @line: buffer to copy the line to
3330  * @size: maximum size of the buffer
3331  * @len: length of line placed into buffer
3332  *
3333  * Start at the beginning of the kmsg buffer, with the oldest kmsg
3334  * record, and copy one record into the provided buffer.
3335  *
3336  * Consecutive calls will return the next available record moving
3337  * towards the end of the buffer with the youngest messages.
3338  *
3339  * A return value of FALSE indicates that there are no more records to
3340  * read.
3341  */
kmsg_dump_get_line(struct kmsg_dumper * dumper,bool syslog,char * line,size_t size,size_t * len)3342 bool kmsg_dump_get_line(struct kmsg_dumper *dumper, bool syslog,
3343 			char *line, size_t size, size_t *len)
3344 {
3345 	unsigned long flags;
3346 	bool ret;
3347 
3348 	logbuf_lock_irqsave(flags);
3349 	ret = kmsg_dump_get_line_nolock(dumper, syslog, line, size, len);
3350 	logbuf_unlock_irqrestore(flags);
3351 
3352 	return ret;
3353 }
3354 EXPORT_SYMBOL_GPL(kmsg_dump_get_line);
3355 
3356 /**
3357  * kmsg_dump_get_buffer - copy kmsg log lines
3358  * @dumper: registered kmsg dumper
3359  * @syslog: include the "<4>" prefixes
3360  * @buf: buffer to copy the line to
3361  * @size: maximum size of the buffer
3362  * @len: length of line placed into buffer
3363  *
3364  * Start at the end of the kmsg buffer and fill the provided buffer
3365  * with as many of the *youngest* kmsg records that fit into it.
3366  * If the buffer is large enough, all available kmsg records will be
3367  * copied with a single call.
3368  *
3369  * Consecutive calls will fill the buffer with the next block of
3370  * available older records, not including the earlier retrieved ones.
3371  *
3372  * A return value of FALSE indicates that there are no more records to
3373  * read.
3374  */
kmsg_dump_get_buffer(struct kmsg_dumper * dumper,bool syslog,char * buf,size_t size,size_t * len)3375 bool kmsg_dump_get_buffer(struct kmsg_dumper *dumper, bool syslog,
3376 			  char *buf, size_t size, size_t *len)
3377 {
3378 	struct printk_info info;
3379 	unsigned int line_count;
3380 	struct printk_record r;
3381 	unsigned long flags;
3382 	u64 seq;
3383 	u64 next_seq;
3384 	size_t l = 0;
3385 	bool ret = false;
3386 	bool time = printk_time;
3387 
3388 	prb_rec_init_rd(&r, &info, buf, size);
3389 
3390 	if (!dumper->active || !buf || !size)
3391 		goto out;
3392 
3393 	logbuf_lock_irqsave(flags);
3394 	if (prb_read_valid_info(prb, dumper->cur_seq, &info, NULL)) {
3395 		if (info.seq != dumper->cur_seq) {
3396 			/* messages are gone, move to first available one */
3397 			dumper->cur_seq = info.seq;
3398 		}
3399 	}
3400 
3401 	/* last entry */
3402 	if (dumper->cur_seq >= dumper->next_seq) {
3403 		logbuf_unlock_irqrestore(flags);
3404 		goto out;
3405 	}
3406 
3407 	/* calculate length of entire buffer */
3408 	seq = dumper->cur_seq;
3409 	while (prb_read_valid_info(prb, seq, &info, &line_count)) {
3410 		if (r.info->seq >= dumper->next_seq)
3411 			break;
3412 		l += get_record_print_text_size(&info, line_count, syslog, time);
3413 		seq = r.info->seq + 1;
3414 	}
3415 
3416 	/* move first record forward until length fits into the buffer */
3417 	seq = dumper->cur_seq;
3418 	while (l >= size && prb_read_valid_info(prb, seq,
3419 						&info, &line_count)) {
3420 		if (r.info->seq >= dumper->next_seq)
3421 			break;
3422 		l -= get_record_print_text_size(&info, line_count, syslog, time);
3423 		seq = r.info->seq + 1;
3424 	}
3425 
3426 	/* last message in next interation */
3427 	next_seq = seq;
3428 
3429 	/* actually read text into the buffer now */
3430 	l = 0;
3431 	while (prb_read_valid(prb, seq, &r)) {
3432 		if (r.info->seq >= dumper->next_seq)
3433 			break;
3434 
3435 		l += record_print_text(&r, syslog, time);
3436 
3437 		/* adjust record to store to remaining buffer space */
3438 		prb_rec_init_rd(&r, &info, buf + l, size - l);
3439 
3440 		seq = r.info->seq + 1;
3441 	}
3442 
3443 	dumper->next_seq = next_seq;
3444 	ret = true;
3445 	logbuf_unlock_irqrestore(flags);
3446 out:
3447 	if (len)
3448 		*len = l;
3449 	return ret;
3450 }
3451 EXPORT_SYMBOL_GPL(kmsg_dump_get_buffer);
3452 
3453 /**
3454  * kmsg_dump_rewind_nolock - reset the iterator (unlocked version)
3455  * @dumper: registered kmsg dumper
3456  *
3457  * Reset the dumper's iterator so that kmsg_dump_get_line() and
3458  * kmsg_dump_get_buffer() can be called again and used multiple
3459  * times within the same dumper.dump() callback.
3460  *
3461  * The function is similar to kmsg_dump_rewind(), but grabs no locks.
3462  */
kmsg_dump_rewind_nolock(struct kmsg_dumper * dumper)3463 void kmsg_dump_rewind_nolock(struct kmsg_dumper *dumper)
3464 {
3465 	dumper->cur_seq = clear_seq;
3466 	dumper->next_seq = prb_next_seq(prb);
3467 }
3468 
3469 /**
3470  * kmsg_dump_rewind - reset the iterator
3471  * @dumper: registered kmsg dumper
3472  *
3473  * Reset the dumper's iterator so that kmsg_dump_get_line() and
3474  * kmsg_dump_get_buffer() can be called again and used multiple
3475  * times within the same dumper.dump() callback.
3476  */
kmsg_dump_rewind(struct kmsg_dumper * dumper)3477 void kmsg_dump_rewind(struct kmsg_dumper *dumper)
3478 {
3479 	unsigned long flags;
3480 
3481 	logbuf_lock_irqsave(flags);
3482 	kmsg_dump_rewind_nolock(dumper);
3483 	logbuf_unlock_irqrestore(flags);
3484 }
3485 EXPORT_SYMBOL_GPL(kmsg_dump_rewind);
3486 
3487 #endif
3488