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