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