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