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