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