OSDN Git Service

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