blob: 87f1a8f4e0f939cf374392b21d4956ffe8f04143 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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.
Jesper Juhl40dc5652005-10-30 15:02:46 -080013 * Fixed SMP synchronization, 08/08/99, Manfred Spraul
Christian Kujau624dffc2006-01-15 02:43:54 +010014 * manfred@colorfullife.com
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 * Rewrote bits to get rid of console_lock
Francois Camie1f8e872008-10-15 22:01:59 -070016 * 01Mar01 Andrew Morton
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
18
19#include <linux/kernel.h>
20#include <linux/mm.h>
21#include <linux/tty.h>
22#include <linux/tty_driver.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/console.h>
24#include <linux/init.h>
Randy Dunlapbfe8df32007-10-16 01:23:46 -070025#include <linux/jiffies.h>
26#include <linux/nmi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/module.h>
Jan Engelhardt3b9c0412006-06-25 05:48:15 -070028#include <linux/moduleparam.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/delay.h>
30#include <linux/smp.h>
31#include <linux/security.h>
32#include <linux/bootmem.h>
Mike Travis162a7e72011-05-24 17:13:20 -070033#include <linux/memblock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/syscalls.h>
Hari Bathini692f66f2017-05-08 15:56:18 -070035#include <linux/crash_core.h>
Jason Wesseld37d39a2010-05-20 21:04:27 -050036#include <linux/kdb.h>
Ingo Molnar3fff4c42009-09-22 16:18:09 +020037#include <linux/ratelimit.h>
Simon Kagstrom456b5652009-10-16 14:09:18 +020038#include <linux/kmsg_dump.h>
Kees Cook00234592010-02-03 15:36:43 -080039#include <linux/syslog.h>
Kevin Cernekee034260d2010-06-03 22:11:25 -070040#include <linux/cpu.h>
41#include <linux/notifier.h>
Huang Yingfb842b002011-01-12 16:59:43 -080042#include <linux/rculist.h>
Kay Sieverse11fea922012-05-03 02:29:41 +020043#include <linux/poll.h>
Frederic Weisbecker74876a92012-10-12 18:00:23 +020044#include <linux/irq_work.h>
Tejun Heo196779b2013-04-30 15:27:12 -070045#include <linux/utsname.h>
Alex Elder249771b2014-08-06 16:09:08 -070046#include <linux/ctype.h>
Christoph Hellwige2e40f22015-02-22 08:58:50 -080047#include <linux/uio.h>
Ingo Molnare6017572017-02-01 16:36:40 +010048#include <linux/sched/clock.h>
Ingo Molnarb17b0152017-02-08 18:51:35 +010049#include <linux/sched/debug.h>
Ingo Molnar68db0cf2017-02-08 18:51:37 +010050#include <linux/sched/task_stack.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080052#include <linux/uaccess.h>
Christoph Hellwig40a7d9f2016-08-02 14:03:59 -070053#include <asm/sections.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Johannes Berg95100352011-11-24 20:03:08 +010055#define CREATE_TRACE_POINTS
56#include <trace/events/printk.h>
57
Joe Perchesd197c432013-07-31 13:53:44 -070058#include "console_cmdline.h"
Joe Perchesbbeddf52013-07-31 13:53:45 -070059#include "braille.h"
Petr Mladek42a0bb32016-05-20 17:00:33 -070060#include "internal.h"
Joe Perchesd197c432013-07-31 13:53:44 -070061
Linus Torvalds1da177e2005-04-16 15:20:36 -070062int console_printk[4] = {
Borislav Petkova8fe19e2014-06-04 16:11:46 -070063 CONSOLE_LOGLEVEL_DEFAULT, /* console_loglevel */
Alex Elder42a9dc02014-08-06 16:09:01 -070064 MESSAGE_LOGLEVEL_DEFAULT, /* default_message_loglevel */
Borislav Petkova8fe19e2014-06-04 16:11:46 -070065 CONSOLE_LOGLEVEL_MIN, /* minimum_console_loglevel */
66 CONSOLE_LOGLEVEL_DEFAULT, /* default_console_loglevel */
Linus Torvalds1da177e2005-04-16 15:20:36 -070067};
68
Linus Torvalds1da177e2005-04-16 15:20:36 -070069/*
Patrick Pletscher0bbfb7c2007-02-17 20:10:16 +010070 * Low level drivers may need that to know if they can schedule in
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 * their unblank() callback or not. So let's export it.
72 */
73int oops_in_progress;
74EXPORT_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 */
Thomas Gleixner5b8c4f22010-09-07 14:33:43 +000081static DEFINE_SEMAPHORE(console_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082struct console *console_drivers;
Ingo Molnara29d1cf2008-06-02 13:19:08 +020083EXPORT_SYMBOL_GPL(console_drivers);
84
Daniel Vetterdaee7792012-09-22 19:52:11 +020085#ifdef CONFIG_LOCKDEP
86static struct lockdep_map console_lock_dep_map = {
87 .name = "console_lock"
88};
89#endif
90
Borislav Petkov750afe72016-08-02 14:04:07 -070091enum devkmsg_log_bits {
92 __DEVKMSG_LOG_BIT_ON = 0,
93 __DEVKMSG_LOG_BIT_OFF,
94 __DEVKMSG_LOG_BIT_LOCK,
95};
96
97enum devkmsg_log_masks {
98 DEVKMSG_LOG_MASK_ON = BIT(__DEVKMSG_LOG_BIT_ON),
99 DEVKMSG_LOG_MASK_OFF = BIT(__DEVKMSG_LOG_BIT_OFF),
100 DEVKMSG_LOG_MASK_LOCK = BIT(__DEVKMSG_LOG_BIT_LOCK),
101};
102
103/* Keep both the 'on' and 'off' bits clear, i.e. ratelimit by default: */
104#define DEVKMSG_LOG_MASK_DEFAULT 0
105
106static unsigned int __read_mostly devkmsg_log = DEVKMSG_LOG_MASK_DEFAULT;
107
108static int __control_devkmsg(char *str)
109{
110 if (!str)
111 return -EINVAL;
112
113 if (!strncmp(str, "on", 2)) {
114 devkmsg_log = DEVKMSG_LOG_MASK_ON;
115 return 2;
116 } else if (!strncmp(str, "off", 3)) {
117 devkmsg_log = DEVKMSG_LOG_MASK_OFF;
118 return 3;
119 } else if (!strncmp(str, "ratelimit", 9)) {
120 devkmsg_log = DEVKMSG_LOG_MASK_DEFAULT;
121 return 9;
122 }
123 return -EINVAL;
124}
125
126static int __init control_devkmsg(char *str)
127{
128 if (__control_devkmsg(str) < 0)
129 return 1;
130
131 /*
132 * Set sysctl string accordingly:
133 */
134 if (devkmsg_log == DEVKMSG_LOG_MASK_ON) {
135 memset(devkmsg_log_str, 0, DEVKMSG_STR_MAX_SIZE);
136 strncpy(devkmsg_log_str, "on", 2);
137 } else if (devkmsg_log == DEVKMSG_LOG_MASK_OFF) {
138 memset(devkmsg_log_str, 0, DEVKMSG_STR_MAX_SIZE);
139 strncpy(devkmsg_log_str, "off", 3);
140 }
141 /* else "ratelimit" which is set by default. */
142
143 /*
144 * Sysctl cannot change it anymore. The kernel command line setting of
145 * this parameter is to force the setting to be permanent throughout the
146 * runtime of the system. This is a precation measure against userspace
147 * trying to be a smarta** and attempting to change it up on us.
148 */
149 devkmsg_log |= DEVKMSG_LOG_MASK_LOCK;
150
151 return 0;
152}
153__setup("printk.devkmsg=", control_devkmsg);
154
155char devkmsg_log_str[DEVKMSG_STR_MAX_SIZE] = "ratelimit";
156
157int devkmsg_sysctl_set_loglvl(struct ctl_table *table, int write,
158 void __user *buffer, size_t *lenp, loff_t *ppos)
159{
160 char old_str[DEVKMSG_STR_MAX_SIZE];
161 unsigned int old;
162 int err;
163
164 if (write) {
165 if (devkmsg_log & DEVKMSG_LOG_MASK_LOCK)
166 return -EINVAL;
167
168 old = devkmsg_log;
169 strncpy(old_str, devkmsg_log_str, DEVKMSG_STR_MAX_SIZE);
170 }
171
172 err = proc_dostring(table, write, buffer, lenp, ppos);
173 if (err)
174 return err;
175
176 if (write) {
177 err = __control_devkmsg(devkmsg_log_str);
178
179 /*
180 * Do not accept an unknown string OR a known string with
181 * trailing crap...
182 */
183 if (err < 0 || (err + 1 != *lenp)) {
184
185 /* ... and restore old setting. */
186 devkmsg_log = old;
187 strncpy(devkmsg_log_str, old_str, DEVKMSG_STR_MAX_SIZE);
188
189 return -EINVAL;
190 }
191 }
192
193 return 0;
194}
195
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196/*
Tejun Heo6fe29352015-06-25 15:01:30 -0700197 * Number of registered extended console drivers.
198 *
199 * If extended consoles are present, in-kernel cont reassembly is disabled
200 * and each fragment is stored as a separate log entry with proper
201 * continuation flag so that every emitted message has full metadata. This
202 * doesn't change the result for regular consoles or /proc/kmsg. For
203 * /dev/kmsg, as long as the reader concatenates messages according to
204 * consecutive continuation flags, the end result should be the same too.
205 */
206static int nr_ext_console_drivers;
207
208/*
Jan Karabd8d7cf2014-06-04 16:11:36 -0700209 * Helper macros to handle lockdep when locking/unlocking console_sem. We use
210 * macros instead of functions so that _RET_IP_ contains useful information.
211 */
212#define down_console_sem() do { \
213 down(&console_sem);\
214 mutex_acquire(&console_lock_dep_map, 0, 0, _RET_IP_);\
215} while (0)
216
217static int __down_trylock_console_sem(unsigned long ip)
218{
Sergey Senozhatskyf9752372016-12-27 23:16:09 +0900219 int lock_failed;
220 unsigned long flags;
221
222 /*
223 * Here and in __up_console_sem() we need to be in safe mode,
224 * because spindump/WARN/etc from under console ->lock will
225 * deadlock in printk()->down_trylock_console_sem() otherwise.
226 */
227 printk_safe_enter_irqsave(flags);
228 lock_failed = down_trylock(&console_sem);
229 printk_safe_exit_irqrestore(flags);
230
231 if (lock_failed)
Jan Karabd8d7cf2014-06-04 16:11:36 -0700232 return 1;
233 mutex_acquire(&console_lock_dep_map, 0, 1, ip);
234 return 0;
235}
236#define down_trylock_console_sem() __down_trylock_console_sem(_RET_IP_)
237
Sergey Senozhatskyf9752372016-12-27 23:16:09 +0900238static void __up_console_sem(unsigned long ip)
239{
240 unsigned long flags;
241
242 mutex_release(&console_lock_dep_map, 1, ip);
243
244 printk_safe_enter_irqsave(flags);
245 up(&console_sem);
246 printk_safe_exit_irqrestore(flags);
247}
248#define up_console_sem() __up_console_sem(_RET_IP_)
Jan Karabd8d7cf2014-06-04 16:11:36 -0700249
250/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 * This is used for debugging the mess that is the VT code by
252 * keeping track if we have the console semaphore held. It's
253 * definitely not the perfect debug tool (we don't know if _WE_
Alex Elder0b90fec2014-08-06 16:09:03 -0700254 * hold it and are racing, but it helps tracking those weird code
255 * paths in the console code where we end up in places I want
256 * locked without the console sempahore held).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 */
Linus Torvalds557240b2006-06-19 18:16:01 -0700258static int console_locked, console_suspended;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
260/*
Feng Tangfe3d8ad2011-03-22 16:34:21 -0700261 * If exclusive_console is non-NULL then only this console is to be printed to.
262 */
263static struct console *exclusive_console;
264
265/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 * Array of consoles built from command line options (console=)
267 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
269#define MAX_CMDLINECONSOLES 8
270
271static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
Joe Perchesd197c432013-07-31 13:53:44 -0700272
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273static int preferred_console = -1;
Markus Armbruster9e124fe2008-05-26 23:31:07 +0100274int console_set_on_cmdline;
275EXPORT_SYMBOL(console_set_on_cmdline);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
277/* Flag: console code may call schedule() */
278static int console_may_schedule;
279
Kay Sievers7ff95542012-05-03 02:29:13 +0200280/*
281 * The printk log buffer consists of a chain of concatenated variable
282 * length records. Every record starts with a record header, containing
283 * the overall length of the record.
284 *
285 * The heads to the first and last entry in the buffer, as well as the
Alex Elder0b90fec2014-08-06 16:09:03 -0700286 * sequence numbers of these entries are maintained when messages are
287 * stored.
Kay Sievers7ff95542012-05-03 02:29:13 +0200288 *
289 * If the heads indicate available messages, the length in the header
290 * tells the start next message. A length == 0 for the next message
291 * indicates a wrap-around to the beginning of the buffer.
292 *
293 * Every record carries the monotonic timestamp in microseconds, as well as
294 * the standard userspace syslog level and syslog facility. The usual
295 * kernel messages use LOG_KERN; userspace-injected messages always carry
296 * a matching syslog facility, by default LOG_USER. The origin of every
297 * message can be reliably determined that way.
298 *
299 * The human readable log message directly follows the message header. The
300 * length of the message text is stored in the header, the stored message
301 * is not terminated.
302 *
Kay Sieverse11fea922012-05-03 02:29:41 +0200303 * Optionally, a message can carry a dictionary of properties (key/value pairs),
304 * to provide userspace with a machine-readable message context.
305 *
306 * Examples for well-defined, commonly used property names are:
307 * DEVICE=b12:8 device identifier
308 * b12:8 block dev_t
309 * c127:3 char dev_t
310 * n8 netdev ifindex
311 * +sound:card0 subsystem:devname
312 * SUBSYSTEM=pci driver-core subsystem name
313 *
314 * Valid characters in property names are [a-zA-Z0-9.-_]. The plain text value
315 * follows directly after a '=' character. Every property is terminated by
316 * a '\0' character. The last property is not terminated.
317 *
318 * Example of a message structure:
319 * 0000 ff 8f 00 00 00 00 00 00 monotonic time in nsec
320 * 0008 34 00 record is 52 bytes long
321 * 000a 0b 00 text is 11 bytes long
322 * 000c 1f 00 dictionary is 23 bytes long
323 * 000e 03 00 LOG_KERN (facility) LOG_ERR (level)
324 * 0010 69 74 27 73 20 61 20 6c "it's a l"
325 * 69 6e 65 "ine"
326 * 001b 44 45 56 49 43 "DEVIC"
327 * 45 3d 62 38 3a 32 00 44 "E=b8:2\0D"
328 * 52 49 56 45 52 3d 62 75 "RIVER=bu"
329 * 67 "g"
330 * 0032 00 00 00 padding to next message header
331 *
Joe Perches62e32ac2013-07-31 13:53:47 -0700332 * The 'struct printk_log' buffer header must never be directly exported to
Kay Sieverse11fea922012-05-03 02:29:41 +0200333 * userspace, it is a kernel-private implementation detail that might
334 * need to be changed in the future, when the requirements change.
335 *
336 * /dev/kmsg exports the structured data in the following line format:
Antonio Ospiteb3896452015-06-30 14:59:03 -0700337 * "<level>,<sequnum>,<timestamp>,<contflag>[,additional_values, ... ];<message text>\n"
338 *
339 * Users of the export format should ignore possible additional values
340 * separated by ',', and find the message after the ';' character.
Kay Sieverse11fea922012-05-03 02:29:41 +0200341 *
342 * The optional key/value pairs are attached as continuation lines starting
343 * with a space character and terminated by a newline. All possible
344 * non-prinatable characters are escaped in the "\xff" notation.
Kay Sievers7ff95542012-05-03 02:29:13 +0200345 */
Matt Mackalld59745c2005-05-01 08:59:02 -0700346
Kay Sievers084681d2012-06-28 09:38:53 +0200347enum log_flags {
Kay Sievers5becfb12012-07-09 12:15:42 -0700348 LOG_NOCONS = 1, /* already flushed, do not print to console */
349 LOG_NEWLINE = 2, /* text ended with a newline */
350 LOG_PREFIX = 4, /* text started with a prefix */
351 LOG_CONT = 8, /* text is a fragment of a continuation line */
Kay Sievers084681d2012-06-28 09:38:53 +0200352};
353
Joe Perches62e32ac2013-07-31 13:53:47 -0700354struct printk_log {
Kay Sievers7ff95542012-05-03 02:29:13 +0200355 u64 ts_nsec; /* timestamp in nanoseconds */
356 u16 len; /* length of entire record */
357 u16 text_len; /* length of text buffer */
358 u16 dict_len; /* length of dictionary buffer */
Kay Sievers084681d2012-06-28 09:38:53 +0200359 u8 facility; /* syslog facility */
360 u8 flags:5; /* internal record flags */
361 u8 level:3; /* syslog level */
Andrey Ryabinin5c9cf8a2016-01-20 15:00:48 -0800362}
363#ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
364__packed __aligned(4)
365#endif
366;
Kay Sievers7ff95542012-05-03 02:29:13 +0200367
368/*
Steven Rostedt458df9f2014-06-04 16:11:38 -0700369 * The logbuf_lock protects kmsg buffer, indices, counters. This can be taken
370 * within the scheduler's rq lock. It must be released before calling
371 * console_unlock() or anything else that might wake up a process.
Kay Sievers7ff95542012-05-03 02:29:13 +0200372 */
Petr Mladekcf9b1102016-05-20 17:00:42 -0700373DEFINE_RAW_SPINLOCK(logbuf_lock);
Kay Sievers7ff95542012-05-03 02:29:13 +0200374
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +0900375/*
376 * Helper macros to lock/unlock logbuf_lock and switch between
377 * printk-safe/unsafe modes.
378 */
379#define logbuf_lock_irq() \
380 do { \
381 printk_safe_enter_irq(); \
382 raw_spin_lock(&logbuf_lock); \
383 } while (0)
384
385#define logbuf_unlock_irq() \
386 do { \
387 raw_spin_unlock(&logbuf_lock); \
388 printk_safe_exit_irq(); \
389 } while (0)
390
391#define logbuf_lock_irqsave(flags) \
392 do { \
393 printk_safe_enter_irqsave(flags); \
394 raw_spin_lock(&logbuf_lock); \
395 } while (0)
396
397#define logbuf_unlock_irqrestore(flags) \
398 do { \
399 raw_spin_unlock(&logbuf_lock); \
400 printk_safe_exit_irqrestore(flags); \
401 } while (0)
402
Kay Sievers96efedf2012-07-16 18:35:29 -0700403#ifdef CONFIG_PRINTK
Frederic Weisbeckerdc72c322013-03-22 15:04:39 -0700404DECLARE_WAIT_QUEUE_HEAD(log_wait);
Kay Sievers7f3a7812012-05-09 01:37:51 +0200405/* the next printk record to read by syslog(READ) or /proc/kmsg */
406static u64 syslog_seq;
407static u32 syslog_idx;
Kay Sieverseb02dac2012-07-09 10:05:10 -0700408static size_t syslog_partial;
Kay Sievers7f3a7812012-05-09 01:37:51 +0200409
410/* index and sequence number of the first record stored in the buffer */
411static u64 log_first_seq;
412static u32 log_first_idx;
413
414/* index and sequence number of the next record to store in the buffer */
415static u64 log_next_seq;
Kay Sievers7f3a7812012-05-09 01:37:51 +0200416static u32 log_next_idx;
417
Kay Sieverseab07262012-07-16 18:35:30 -0700418/* the next printk record to write to the console */
419static u64 console_seq;
420static u32 console_idx;
Kay Sieverseab07262012-07-16 18:35:30 -0700421
Kay Sievers7f3a7812012-05-09 01:37:51 +0200422/* the next printk record to read after the last 'clear' command */
423static u64 clear_seq;
424static u32 clear_idx;
Kay Sievers7ff95542012-05-03 02:29:13 +0200425
Kay Sievers70498252012-07-16 18:35:29 -0700426#define PREFIX_MAX 32
Alex Elder249771b2014-08-06 16:09:08 -0700427#define LOG_LINE_MAX (1024 - PREFIX_MAX)
Kay Sievers7ff95542012-05-03 02:29:13 +0200428
Mathias Krause38246572015-11-06 16:30:38 -0800429#define LOG_LEVEL(v) ((v) & 0x07)
430#define LOG_FACILITY(v) ((v) >> 3 & 0xff)
431
Kay Sievers7ff95542012-05-03 02:29:13 +0200432/* record buffer */
Joe Perches62e32ac2013-07-31 13:53:47 -0700433#define LOG_ALIGN __alignof__(struct printk_log)
Kay Sievers7ff95542012-05-03 02:29:13 +0200434#define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
Stephen Warrenf8450fc2012-05-10 16:14:33 -0600435static char __log_buf[__LOG_BUF_LEN] __aligned(LOG_ALIGN);
Matt Mackalld59745c2005-05-01 08:59:02 -0700436static char *log_buf = __log_buf;
Kay Sievers7ff95542012-05-03 02:29:13 +0200437static u32 log_buf_len = __LOG_BUF_LEN;
438
Vasant Hegde14c40002014-08-09 11:15:30 +0530439/* Return log buffer address */
440char *log_buf_addr_get(void)
441{
442 return log_buf;
443}
444
445/* Return log buffer size */
446u32 log_buf_len_get(void)
447{
448 return log_buf_len;
449}
450
Kay Sievers7ff95542012-05-03 02:29:13 +0200451/* human readable text of the record */
Joe Perches62e32ac2013-07-31 13:53:47 -0700452static char *log_text(const struct printk_log *msg)
Kay Sievers7ff95542012-05-03 02:29:13 +0200453{
Joe Perches62e32ac2013-07-31 13:53:47 -0700454 return (char *)msg + sizeof(struct printk_log);
Kay Sievers7ff95542012-05-03 02:29:13 +0200455}
456
457/* optional key/value pair dictionary attached to the record */
Joe Perches62e32ac2013-07-31 13:53:47 -0700458static char *log_dict(const struct printk_log *msg)
Kay Sievers7ff95542012-05-03 02:29:13 +0200459{
Joe Perches62e32ac2013-07-31 13:53:47 -0700460 return (char *)msg + sizeof(struct printk_log) + msg->text_len;
Kay Sievers7ff95542012-05-03 02:29:13 +0200461}
462
463/* get record by index; idx must point to valid msg */
Joe Perches62e32ac2013-07-31 13:53:47 -0700464static struct printk_log *log_from_idx(u32 idx)
Kay Sievers7ff95542012-05-03 02:29:13 +0200465{
Joe Perches62e32ac2013-07-31 13:53:47 -0700466 struct printk_log *msg = (struct printk_log *)(log_buf + idx);
Kay Sievers7ff95542012-05-03 02:29:13 +0200467
468 /*
469 * A length == 0 record is the end of buffer marker. Wrap around and
470 * read the message at the start of the buffer.
471 */
472 if (!msg->len)
Joe Perches62e32ac2013-07-31 13:53:47 -0700473 return (struct printk_log *)log_buf;
Kay Sievers7ff95542012-05-03 02:29:13 +0200474 return msg;
475}
476
477/* get next record; idx must point to valid msg */
478static u32 log_next(u32 idx)
479{
Joe Perches62e32ac2013-07-31 13:53:47 -0700480 struct printk_log *msg = (struct printk_log *)(log_buf + idx);
Kay Sievers7ff95542012-05-03 02:29:13 +0200481
482 /* length == 0 indicates the end of the buffer; wrap */
483 /*
484 * A length == 0 record is the end of buffer marker. Wrap around and
485 * read the message at the start of the buffer as *this* one, and
486 * return the one after that.
487 */
488 if (!msg->len) {
Joe Perches62e32ac2013-07-31 13:53:47 -0700489 msg = (struct printk_log *)log_buf;
Kay Sievers7ff95542012-05-03 02:29:13 +0200490 return msg->len;
491 }
492 return idx + msg->len;
493}
494
Petr Mladekf40e4b9f2014-06-04 16:11:30 -0700495/*
496 * Check whether there is enough free space for the given message.
497 *
498 * The same values of first_idx and next_idx mean that the buffer
499 * is either empty or full.
500 *
501 * If the buffer is empty, we must respect the position of the indexes.
502 * They cannot be reset to the beginning of the buffer.
503 */
504static int logbuf_has_space(u32 msg_size, bool empty)
Petr Mladek0a581692014-06-04 16:11:28 -0700505{
506 u32 free;
507
Petr Mladekf40e4b9f2014-06-04 16:11:30 -0700508 if (log_next_idx > log_first_idx || empty)
Petr Mladek0a581692014-06-04 16:11:28 -0700509 free = max(log_buf_len - log_next_idx, log_first_idx);
510 else
511 free = log_first_idx - log_next_idx;
512
513 /*
514 * We need space also for an empty header that signalizes wrapping
515 * of the buffer.
516 */
517 return free >= msg_size + sizeof(struct printk_log);
518}
519
Petr Mladekf40e4b9f2014-06-04 16:11:30 -0700520static int log_make_free_space(u32 msg_size)
Petr Mladek0a581692014-06-04 16:11:28 -0700521{
Ivan Delalandef4689082016-03-17 14:21:30 -0700522 while (log_first_seq < log_next_seq &&
523 !logbuf_has_space(msg_size, false)) {
Alex Elder0b90fec2014-08-06 16:09:03 -0700524 /* drop old messages until we have enough contiguous space */
Petr Mladek0a581692014-06-04 16:11:28 -0700525 log_first_idx = log_next(log_first_idx);
526 log_first_seq++;
527 }
Petr Mladekf40e4b9f2014-06-04 16:11:30 -0700528
Ivan Delalandef4689082016-03-17 14:21:30 -0700529 if (clear_seq < log_first_seq) {
530 clear_seq = log_first_seq;
531 clear_idx = log_first_idx;
532 }
533
Petr Mladekf40e4b9f2014-06-04 16:11:30 -0700534 /* sequence numbers are equal, so the log buffer is empty */
Ivan Delalandef4689082016-03-17 14:21:30 -0700535 if (logbuf_has_space(msg_size, log_first_seq == log_next_seq))
Petr Mladekf40e4b9f2014-06-04 16:11:30 -0700536 return 0;
537
538 return -ENOMEM;
Petr Mladek0a581692014-06-04 16:11:28 -0700539}
540
Petr Mladek85c870432014-06-04 16:11:31 -0700541/* compute the message size including the padding bytes */
542static u32 msg_used_size(u16 text_len, u16 dict_len, u32 *pad_len)
543{
544 u32 size;
545
546 size = sizeof(struct printk_log) + text_len + dict_len;
547 *pad_len = (-size) & (LOG_ALIGN - 1);
548 size += *pad_len;
549
550 return size;
551}
552
Petr Mladek55bd53a2014-06-04 16:11:32 -0700553/*
554 * Define how much of the log buffer we could take at maximum. The value
555 * must be greater than two. Note that only half of the buffer is available
556 * when the index points to the middle.
557 */
558#define MAX_LOG_TAKE_PART 4
559static const char trunc_msg[] = "<truncated>";
560
561static u32 truncate_msg(u16 *text_len, u16 *trunc_msg_len,
562 u16 *dict_len, u32 *pad_len)
563{
564 /*
565 * The message should not take the whole buffer. Otherwise, it might
566 * get removed too soon.
567 */
568 u32 max_text_len = log_buf_len / MAX_LOG_TAKE_PART;
569 if (*text_len > max_text_len)
570 *text_len = max_text_len;
571 /* enable the warning message */
572 *trunc_msg_len = strlen(trunc_msg);
573 /* disable the "dict" completely */
574 *dict_len = 0;
575 /* compute the size again, count also the warning message */
576 return msg_used_size(*text_len + *trunc_msg_len, 0, pad_len);
577}
578
Kay Sievers7ff95542012-05-03 02:29:13 +0200579/* insert record into the buffer, discard old ones, update heads */
Petr Mladek034633c2014-06-04 16:11:33 -0700580static int log_store(int facility, int level,
581 enum log_flags flags, u64 ts_nsec,
582 const char *dict, u16 dict_len,
583 const char *text, u16 text_len)
Kay Sievers7ff95542012-05-03 02:29:13 +0200584{
Joe Perches62e32ac2013-07-31 13:53:47 -0700585 struct printk_log *msg;
Kay Sievers7ff95542012-05-03 02:29:13 +0200586 u32 size, pad_len;
Petr Mladek55bd53a2014-06-04 16:11:32 -0700587 u16 trunc_msg_len = 0;
Kay Sievers7ff95542012-05-03 02:29:13 +0200588
589 /* number of '\0' padding bytes to next message */
Petr Mladek85c870432014-06-04 16:11:31 -0700590 size = msg_used_size(text_len, dict_len, &pad_len);
Kay Sievers7ff95542012-05-03 02:29:13 +0200591
Petr Mladek55bd53a2014-06-04 16:11:32 -0700592 if (log_make_free_space(size)) {
593 /* truncate the message if it is too long for empty buffer */
594 size = truncate_msg(&text_len, &trunc_msg_len,
595 &dict_len, &pad_len);
596 /* survive when the log buffer is too small for trunc_msg */
597 if (log_make_free_space(size))
Petr Mladek034633c2014-06-04 16:11:33 -0700598 return 0;
Petr Mladek55bd53a2014-06-04 16:11:32 -0700599 }
Kay Sievers7ff95542012-05-03 02:29:13 +0200600
Petr Mladek39b25102014-04-03 14:48:42 -0700601 if (log_next_idx + size + sizeof(struct printk_log) > log_buf_len) {
Kay Sievers7ff95542012-05-03 02:29:13 +0200602 /*
603 * This message + an additional empty header does not fit
604 * at the end of the buffer. Add an empty header with len == 0
605 * to signify a wrap around.
606 */
Joe Perches62e32ac2013-07-31 13:53:47 -0700607 memset(log_buf + log_next_idx, 0, sizeof(struct printk_log));
Kay Sievers7ff95542012-05-03 02:29:13 +0200608 log_next_idx = 0;
609 }
610
611 /* fill message */
Joe Perches62e32ac2013-07-31 13:53:47 -0700612 msg = (struct printk_log *)(log_buf + log_next_idx);
Kay Sievers7ff95542012-05-03 02:29:13 +0200613 memcpy(log_text(msg), text, text_len);
614 msg->text_len = text_len;
Petr Mladek55bd53a2014-06-04 16:11:32 -0700615 if (trunc_msg_len) {
616 memcpy(log_text(msg) + text_len, trunc_msg, trunc_msg_len);
617 msg->text_len += trunc_msg_len;
618 }
Kay Sievers7ff95542012-05-03 02:29:13 +0200619 memcpy(log_dict(msg), dict, dict_len);
620 msg->dict_len = dict_len;
Kay Sievers084681d2012-06-28 09:38:53 +0200621 msg->facility = facility;
622 msg->level = level & 7;
623 msg->flags = flags & 0x1f;
624 if (ts_nsec > 0)
625 msg->ts_nsec = ts_nsec;
626 else
627 msg->ts_nsec = local_clock();
Kay Sievers7ff95542012-05-03 02:29:13 +0200628 memset(log_dict(msg) + dict_len, 0, pad_len);
Petr Mladekfce6e032014-04-03 14:48:43 -0700629 msg->len = size;
Kay Sievers7ff95542012-05-03 02:29:13 +0200630
631 /* insert message */
632 log_next_idx += msg->len;
633 log_next_seq++;
Petr Mladek034633c2014-06-04 16:11:33 -0700634
635 return msg->text_len;
Kay Sievers7ff95542012-05-03 02:29:13 +0200636}
Matt Mackalld59745c2005-05-01 08:59:02 -0700637
Alex Eldere99aa462014-08-06 16:09:05 -0700638int dmesg_restrict = IS_ENABLED(CONFIG_SECURITY_DMESG_RESTRICT);
Kees Cook637241a2013-06-12 14:04:39 -0700639
640static int syslog_action_restricted(int type)
641{
642 if (dmesg_restrict)
643 return 1;
644 /*
645 * Unless restricted, we allow "read all" and "get buffer size"
646 * for everybody.
647 */
648 return type != SYSLOG_ACTION_READ_ALL &&
649 type != SYSLOG_ACTION_SIZE_BUFFER;
650}
651
Vasily Averin3ea43312015-06-25 15:01:47 -0700652int check_syslog_permissions(int type, int source)
Kees Cook637241a2013-06-12 14:04:39 -0700653{
654 /*
655 * If this is from /proc/kmsg and we've already opened it, then we've
656 * already done the capabilities checks at open time.
657 */
Vasily Averin3ea43312015-06-25 15:01:47 -0700658 if (source == SYSLOG_FROM_PROC && type != SYSLOG_ACTION_OPEN)
Vasily Averind194e5d2015-06-25 15:01:44 -0700659 goto ok;
Kees Cook637241a2013-06-12 14:04:39 -0700660
661 if (syslog_action_restricted(type)) {
662 if (capable(CAP_SYSLOG))
Vasily Averind194e5d2015-06-25 15:01:44 -0700663 goto ok;
Kees Cook637241a2013-06-12 14:04:39 -0700664 /*
665 * For historical reasons, accept CAP_SYS_ADMIN too, with
666 * a warning.
667 */
668 if (capable(CAP_SYS_ADMIN)) {
669 pr_warn_once("%s (%d): Attempt to access syslog with "
670 "CAP_SYS_ADMIN but no CAP_SYSLOG "
671 "(deprecated).\n",
672 current->comm, task_pid_nr(current));
Vasily Averind194e5d2015-06-25 15:01:44 -0700673 goto ok;
Kees Cook637241a2013-06-12 14:04:39 -0700674 }
675 return -EPERM;
676 }
Vasily Averind194e5d2015-06-25 15:01:44 -0700677ok:
Kees Cook637241a2013-06-12 14:04:39 -0700678 return security_syslog(type);
679}
Geliang Tangee1d2672015-10-20 00:39:03 -0700680EXPORT_SYMBOL_GPL(check_syslog_permissions);
Kees Cook637241a2013-06-12 14:04:39 -0700681
Tejun Heod43ff432015-06-25 15:01:24 -0700682static void append_char(char **pp, char *e, char c)
683{
684 if (*pp < e)
685 *(*pp)++ = c;
686}
Kees Cook637241a2013-06-12 14:04:39 -0700687
Tejun Heo0a295e672015-06-25 15:01:27 -0700688static ssize_t msg_print_ext_header(char *buf, size_t size,
Linus Torvalds5aa068e2016-10-25 11:27:31 -0700689 struct printk_log *msg, u64 seq)
Tejun Heo0a295e672015-06-25 15:01:27 -0700690{
691 u64 ts_usec = msg->ts_nsec;
Tejun Heo0a295e672015-06-25 15:01:27 -0700692
693 do_div(ts_usec, 1000);
694
Tejun Heo0a295e672015-06-25 15:01:27 -0700695 return scnprintf(buf, size, "%u,%llu,%llu,%c;",
Linus Torvalds5aa068e2016-10-25 11:27:31 -0700696 (msg->facility << 3) | msg->level, seq, ts_usec,
697 msg->flags & LOG_CONT ? 'c' : '-');
Tejun Heo0a295e672015-06-25 15:01:27 -0700698}
699
700static ssize_t msg_print_ext_body(char *buf, size_t size,
701 char *dict, size_t dict_len,
702 char *text, size_t text_len)
703{
704 char *p = buf, *e = buf + size;
705 size_t i;
706
707 /* escape non-printable characters */
708 for (i = 0; i < text_len; i++) {
709 unsigned char c = text[i];
710
711 if (c < ' ' || c >= 127 || c == '\\')
712 p += scnprintf(p, e - p, "\\x%02x", c);
713 else
714 append_char(&p, e, c);
715 }
716 append_char(&p, e, '\n');
717
718 if (dict_len) {
719 bool line = true;
720
721 for (i = 0; i < dict_len; i++) {
722 unsigned char c = dict[i];
723
724 if (line) {
725 append_char(&p, e, ' ');
726 line = false;
727 }
728
729 if (c == '\0') {
730 append_char(&p, e, '\n');
731 line = true;
732 continue;
733 }
734
735 if (c < ' ' || c >= 127 || c == '\\') {
736 p += scnprintf(p, e - p, "\\x%02x", c);
737 continue;
738 }
739
740 append_char(&p, e, c);
741 }
742 append_char(&p, e, '\n');
743 }
744
745 return p - buf;
746}
747
Kay Sieverse11fea922012-05-03 02:29:41 +0200748/* /dev/kmsg - userspace message inject/listen interface */
749struct devkmsg_user {
750 u64 seq;
751 u32 idx;
Borislav Petkov750afe72016-08-02 14:04:07 -0700752 struct ratelimit_state rs;
Kay Sieverse11fea922012-05-03 02:29:41 +0200753 struct mutex lock;
Tejun Heod43ff432015-06-25 15:01:24 -0700754 char buf[CONSOLE_EXT_LOG_MAX];
Kay Sieverse11fea922012-05-03 02:29:41 +0200755};
756
Al Viro849f3122014-08-23 12:23:53 -0400757static ssize_t devkmsg_write(struct kiocb *iocb, struct iov_iter *from)
Kay Sieverse11fea922012-05-03 02:29:41 +0200758{
759 char *buf, *line;
Kay Sieverse11fea922012-05-03 02:29:41 +0200760 int level = default_message_loglevel;
761 int facility = 1; /* LOG_USER */
Borislav Petkov750afe72016-08-02 14:04:07 -0700762 struct file *file = iocb->ki_filp;
763 struct devkmsg_user *user = file->private_data;
Christoph Hellwig66ee59a2015-02-11 19:56:46 +0100764 size_t len = iov_iter_count(from);
Kay Sieverse11fea922012-05-03 02:29:41 +0200765 ssize_t ret = len;
766
Borislav Petkov750afe72016-08-02 14:04:07 -0700767 if (!user || len > LOG_LINE_MAX)
Kay Sieverse11fea922012-05-03 02:29:41 +0200768 return -EINVAL;
Borislav Petkov750afe72016-08-02 14:04:07 -0700769
770 /* Ignore when user logging is disabled. */
771 if (devkmsg_log & DEVKMSG_LOG_MASK_OFF)
772 return len;
773
774 /* Ratelimit when not explicitly enabled. */
775 if (!(devkmsg_log & DEVKMSG_LOG_MASK_ON)) {
776 if (!___ratelimit(&user->rs, current->comm))
777 return ret;
778 }
779
Kay Sieverse11fea922012-05-03 02:29:41 +0200780 buf = kmalloc(len+1, GFP_KERNEL);
781 if (buf == NULL)
782 return -ENOMEM;
783
Al Viro849f3122014-08-23 12:23:53 -0400784 buf[len] = '\0';
Al Virocbbd26b2016-11-01 22:09:04 -0400785 if (!copy_from_iter_full(buf, len, from)) {
Al Viro849f3122014-08-23 12:23:53 -0400786 kfree(buf);
787 return -EFAULT;
Kay Sieverse11fea922012-05-03 02:29:41 +0200788 }
789
790 /*
791 * Extract and skip the syslog prefix <[0-9]*>. Coming from userspace
792 * the decimal value represents 32bit, the lower 3 bit are the log
793 * level, the rest are the log facility.
794 *
795 * If no prefix or no userspace facility is specified, we
796 * enforce LOG_USER, to be able to reliably distinguish
797 * kernel-generated messages from userspace-injected ones.
798 */
799 line = buf;
800 if (line[0] == '<') {
801 char *endp = NULL;
Mathias Krause38246572015-11-06 16:30:38 -0800802 unsigned int u;
Kay Sieverse11fea922012-05-03 02:29:41 +0200803
Mathias Krause38246572015-11-06 16:30:38 -0800804 u = simple_strtoul(line + 1, &endp, 10);
Kay Sieverse11fea922012-05-03 02:29:41 +0200805 if (endp && endp[0] == '>') {
Mathias Krause38246572015-11-06 16:30:38 -0800806 level = LOG_LEVEL(u);
807 if (LOG_FACILITY(u) != 0)
808 facility = LOG_FACILITY(u);
Kay Sieverse11fea922012-05-03 02:29:41 +0200809 endp++;
810 len -= endp - line;
811 line = endp;
812 }
813 }
Kay Sieverse11fea922012-05-03 02:29:41 +0200814
815 printk_emit(facility, level, NULL, 0, "%s", line);
Kay Sieverse11fea922012-05-03 02:29:41 +0200816 kfree(buf);
817 return ret;
818}
819
820static ssize_t devkmsg_read(struct file *file, char __user *buf,
821 size_t count, loff_t *ppos)
822{
823 struct devkmsg_user *user = file->private_data;
Joe Perches62e32ac2013-07-31 13:53:47 -0700824 struct printk_log *msg;
Kay Sieverse11fea922012-05-03 02:29:41 +0200825 size_t len;
826 ssize_t ret;
827
828 if (!user)
829 return -EBADF;
830
Yuanhan Liu4a77a5a2012-06-16 21:21:51 +0800831 ret = mutex_lock_interruptible(&user->lock);
832 if (ret)
833 return ret;
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +0900834
835 logbuf_lock_irq();
Kay Sieverse11fea922012-05-03 02:29:41 +0200836 while (user->seq == log_next_seq) {
837 if (file->f_flags & O_NONBLOCK) {
838 ret = -EAGAIN;
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +0900839 logbuf_unlock_irq();
Kay Sieverse11fea922012-05-03 02:29:41 +0200840 goto out;
841 }
842
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +0900843 logbuf_unlock_irq();
Kay Sieverse11fea922012-05-03 02:29:41 +0200844 ret = wait_event_interruptible(log_wait,
845 user->seq != log_next_seq);
846 if (ret)
847 goto out;
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +0900848 logbuf_lock_irq();
Kay Sieverse11fea922012-05-03 02:29:41 +0200849 }
850
851 if (user->seq < log_first_seq) {
852 /* our last seen message is gone, return error and reset */
853 user->idx = log_first_idx;
854 user->seq = log_first_seq;
855 ret = -EPIPE;
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +0900856 logbuf_unlock_irq();
Kay Sieverse11fea922012-05-03 02:29:41 +0200857 goto out;
858 }
859
860 msg = log_from_idx(user->idx);
Tejun Heo0a295e672015-06-25 15:01:27 -0700861 len = msg_print_ext_header(user->buf, sizeof(user->buf),
Linus Torvalds5aa068e2016-10-25 11:27:31 -0700862 msg, user->seq);
Tejun Heo0a295e672015-06-25 15:01:27 -0700863 len += msg_print_ext_body(user->buf + len, sizeof(user->buf) - len,
864 log_dict(msg), msg->dict_len,
865 log_text(msg), msg->text_len);
Kay Sieversd39f3d72012-07-16 18:35:30 -0700866
Kay Sieverse11fea922012-05-03 02:29:41 +0200867 user->idx = log_next(user->idx);
868 user->seq++;
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +0900869 logbuf_unlock_irq();
Kay Sieverse11fea922012-05-03 02:29:41 +0200870
871 if (len > count) {
872 ret = -EINVAL;
873 goto out;
874 }
875
876 if (copy_to_user(buf, user->buf, len)) {
877 ret = -EFAULT;
878 goto out;
879 }
880 ret = len;
881out:
882 mutex_unlock(&user->lock);
883 return ret;
884}
885
886static loff_t devkmsg_llseek(struct file *file, loff_t offset, int whence)
887{
888 struct devkmsg_user *user = file->private_data;
889 loff_t ret = 0;
890
891 if (!user)
892 return -EBADF;
893 if (offset)
894 return -ESPIPE;
895
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +0900896 logbuf_lock_irq();
Kay Sieverse11fea922012-05-03 02:29:41 +0200897 switch (whence) {
898 case SEEK_SET:
899 /* the first record */
900 user->idx = log_first_idx;
901 user->seq = log_first_seq;
902 break;
903 case SEEK_DATA:
904 /*
905 * The first record after the last SYSLOG_ACTION_CLEAR,
906 * like issued by 'dmesg -c'. Reading /dev/kmsg itself
907 * changes no global state, and does not clear anything.
908 */
909 user->idx = clear_idx;
910 user->seq = clear_seq;
911 break;
912 case SEEK_END:
913 /* after the last record */
914 user->idx = log_next_idx;
915 user->seq = log_next_seq;
916 break;
917 default:
918 ret = -EINVAL;
919 }
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +0900920 logbuf_unlock_irq();
Kay Sieverse11fea922012-05-03 02:29:41 +0200921 return ret;
922}
923
924static unsigned int devkmsg_poll(struct file *file, poll_table *wait)
925{
926 struct devkmsg_user *user = file->private_data;
927 int ret = 0;
928
929 if (!user)
930 return POLLERR|POLLNVAL;
931
932 poll_wait(file, &log_wait, wait);
933
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +0900934 logbuf_lock_irq();
Kay Sieverse11fea922012-05-03 02:29:41 +0200935 if (user->seq < log_next_seq) {
936 /* return error when data has vanished underneath us */
937 if (user->seq < log_first_seq)
938 ret = POLLIN|POLLRDNORM|POLLERR|POLLPRI;
Nicolas Kaiser0a285312013-04-29 16:17:20 -0700939 else
940 ret = POLLIN|POLLRDNORM;
Kay Sieverse11fea922012-05-03 02:29:41 +0200941 }
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +0900942 logbuf_unlock_irq();
Kay Sieverse11fea922012-05-03 02:29:41 +0200943
944 return ret;
945}
946
947static int devkmsg_open(struct inode *inode, struct file *file)
948{
949 struct devkmsg_user *user;
950 int err;
951
Borislav Petkov750afe72016-08-02 14:04:07 -0700952 if (devkmsg_log & DEVKMSG_LOG_MASK_OFF)
953 return -EPERM;
Kay Sieverse11fea922012-05-03 02:29:41 +0200954
Borislav Petkov750afe72016-08-02 14:04:07 -0700955 /* write-only does not need any file context */
956 if ((file->f_flags & O_ACCMODE) != O_WRONLY) {
957 err = check_syslog_permissions(SYSLOG_ACTION_READ_ALL,
958 SYSLOG_FROM_READER);
959 if (err)
960 return err;
961 }
Kay Sieverse11fea922012-05-03 02:29:41 +0200962
963 user = kmalloc(sizeof(struct devkmsg_user), GFP_KERNEL);
964 if (!user)
965 return -ENOMEM;
966
Borislav Petkov750afe72016-08-02 14:04:07 -0700967 ratelimit_default_init(&user->rs);
968 ratelimit_set_flags(&user->rs, RATELIMIT_MSG_ON_RELEASE);
969
Kay Sieverse11fea922012-05-03 02:29:41 +0200970 mutex_init(&user->lock);
971
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +0900972 logbuf_lock_irq();
Kay Sieverse11fea922012-05-03 02:29:41 +0200973 user->idx = log_first_idx;
974 user->seq = log_first_seq;
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +0900975 logbuf_unlock_irq();
Kay Sieverse11fea922012-05-03 02:29:41 +0200976
977 file->private_data = user;
978 return 0;
979}
980
981static int devkmsg_release(struct inode *inode, struct file *file)
982{
983 struct devkmsg_user *user = file->private_data;
984
985 if (!user)
986 return 0;
987
Borislav Petkov750afe72016-08-02 14:04:07 -0700988 ratelimit_state_exit(&user->rs);
989
Kay Sieverse11fea922012-05-03 02:29:41 +0200990 mutex_destroy(&user->lock);
991 kfree(user);
992 return 0;
993}
994
995const struct file_operations kmsg_fops = {
996 .open = devkmsg_open,
997 .read = devkmsg_read,
Al Viro849f3122014-08-23 12:23:53 -0400998 .write_iter = devkmsg_write,
Kay Sieverse11fea922012-05-03 02:29:41 +0200999 .llseek = devkmsg_llseek,
1000 .poll = devkmsg_poll,
1001 .release = devkmsg_release,
1002};
1003
Hari Bathini692f66f2017-05-08 15:56:18 -07001004#ifdef CONFIG_CRASH_CORE
Neil Horman04d491a2009-04-02 16:58:57 -07001005/*
Dirk Gouders4c1ace62013-11-12 15:08:54 -08001006 * This appends the listed symbols to /proc/vmcore
Neil Horman04d491a2009-04-02 16:58:57 -07001007 *
Dirk Gouders4c1ace62013-11-12 15:08:54 -08001008 * /proc/vmcore is used by various utilities, like crash and makedumpfile to
Neil Horman04d491a2009-04-02 16:58:57 -07001009 * obtain access to symbols that are otherwise very difficult to locate. These
1010 * symbols are specifically used so that utilities can access and extract the
1011 * dmesg log from a vmcore file after a crash.
1012 */
Hari Bathini692f66f2017-05-08 15:56:18 -07001013void log_buf_vmcoreinfo_setup(void)
Neil Horman04d491a2009-04-02 16:58:57 -07001014{
1015 VMCOREINFO_SYMBOL(log_buf);
Neil Horman04d491a2009-04-02 16:58:57 -07001016 VMCOREINFO_SYMBOL(log_buf_len);
Kay Sievers7ff95542012-05-03 02:29:13 +02001017 VMCOREINFO_SYMBOL(log_first_idx);
Ivan Delalandef4689082016-03-17 14:21:30 -07001018 VMCOREINFO_SYMBOL(clear_idx);
Kay Sievers7ff95542012-05-03 02:29:13 +02001019 VMCOREINFO_SYMBOL(log_next_idx);
Vivek Goyal67914572012-07-18 13:18:12 -04001020 /*
Joe Perches62e32ac2013-07-31 13:53:47 -07001021 * Export struct printk_log size and field offsets. User space tools can
Vivek Goyal67914572012-07-18 13:18:12 -04001022 * parse it and detect any changes to structure down the line.
1023 */
Joe Perches62e32ac2013-07-31 13:53:47 -07001024 VMCOREINFO_STRUCT_SIZE(printk_log);
1025 VMCOREINFO_OFFSET(printk_log, ts_nsec);
1026 VMCOREINFO_OFFSET(printk_log, len);
1027 VMCOREINFO_OFFSET(printk_log, text_len);
1028 VMCOREINFO_OFFSET(printk_log, dict_len);
Neil Horman04d491a2009-04-02 16:58:57 -07001029}
1030#endif
1031
Mike Travis162a7e72011-05-24 17:13:20 -07001032/* requested log_buf_len from kernel cmdline */
1033static unsigned long __initdata new_log_buf_len;
1034
Luis R. Rodriguezc0a318a2014-08-06 16:08:52 -07001035/* we practice scaling the ring buffer by powers of 2 */
1036static void __init log_buf_len_update(unsigned size)
1037{
1038 if (size)
1039 size = roundup_pow_of_two(size);
1040 if (size > log_buf_len)
1041 new_log_buf_len = size;
1042}
1043
Mike Travis162a7e72011-05-24 17:13:20 -07001044/* save requested log_buf_len since it's too early to process it */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045static int __init log_buf_len_setup(char *str)
1046{
Denys Vlasenkoeed4a2a2008-02-06 01:37:02 -08001047 unsigned size = memparse(str, &str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048
Luis R. Rodriguezc0a318a2014-08-06 16:08:52 -07001049 log_buf_len_update(size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050
Mike Travis162a7e72011-05-24 17:13:20 -07001051 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052}
Mike Travis162a7e72011-05-24 17:13:20 -07001053early_param("log_buf_len", log_buf_len_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054
Geert Uytterhoeven2240a312014-10-13 15:51:11 -07001055#ifdef CONFIG_SMP
1056#define __LOG_CPU_MAX_BUF_LEN (1 << CONFIG_LOG_CPU_MAX_BUF_SHIFT)
1057
Luis R. Rodriguez23b28992014-08-06 16:08:56 -07001058static void __init log_buf_add_cpu(void)
1059{
1060 unsigned int cpu_extra;
1061
1062 /*
1063 * archs should set up cpu_possible_bits properly with
1064 * set_cpu_possible() after setup_arch() but just in
1065 * case lets ensure this is valid.
1066 */
1067 if (num_possible_cpus() == 1)
1068 return;
1069
1070 cpu_extra = (num_possible_cpus() - 1) * __LOG_CPU_MAX_BUF_LEN;
1071
1072 /* by default this will only continue through for large > 64 CPUs */
1073 if (cpu_extra <= __LOG_BUF_LEN / 2)
1074 return;
1075
1076 pr_info("log_buf_len individual max cpu contribution: %d bytes\n",
1077 __LOG_CPU_MAX_BUF_LEN);
1078 pr_info("log_buf_len total cpu_extra contributions: %d bytes\n",
1079 cpu_extra);
1080 pr_info("log_buf_len min size: %d bytes\n", __LOG_BUF_LEN);
1081
1082 log_buf_len_update(cpu_extra + __LOG_BUF_LEN);
1083}
Geert Uytterhoeven2240a312014-10-13 15:51:11 -07001084#else /* !CONFIG_SMP */
1085static inline void log_buf_add_cpu(void) {}
1086#endif /* CONFIG_SMP */
Luis R. Rodriguez23b28992014-08-06 16:08:56 -07001087
Mike Travis162a7e72011-05-24 17:13:20 -07001088void __init setup_log_buf(int early)
1089{
1090 unsigned long flags;
Mike Travis162a7e72011-05-24 17:13:20 -07001091 char *new_log_buf;
1092 int free;
1093
Luis R. Rodriguez23b28992014-08-06 16:08:56 -07001094 if (log_buf != __log_buf)
1095 return;
1096
1097 if (!early && !new_log_buf_len)
1098 log_buf_add_cpu();
1099
Mike Travis162a7e72011-05-24 17:13:20 -07001100 if (!new_log_buf_len)
1101 return;
1102
1103 if (early) {
Santosh Shilimkar9da791d2014-01-21 15:50:23 -08001104 new_log_buf =
Luis R. Rodriguez70300172014-08-06 16:08:49 -07001105 memblock_virt_alloc(new_log_buf_len, LOG_ALIGN);
Mike Travis162a7e72011-05-24 17:13:20 -07001106 } else {
Luis R. Rodriguez70300172014-08-06 16:08:49 -07001107 new_log_buf = memblock_virt_alloc_nopanic(new_log_buf_len,
1108 LOG_ALIGN);
Mike Travis162a7e72011-05-24 17:13:20 -07001109 }
1110
1111 if (unlikely(!new_log_buf)) {
1112 pr_err("log_buf_len: %ld bytes not available\n",
1113 new_log_buf_len);
1114 return;
1115 }
1116
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09001117 logbuf_lock_irqsave(flags);
Mike Travis162a7e72011-05-24 17:13:20 -07001118 log_buf_len = new_log_buf_len;
1119 log_buf = new_log_buf;
1120 new_log_buf_len = 0;
Kay Sievers7ff95542012-05-03 02:29:13 +02001121 free = __LOG_BUF_LEN - log_next_idx;
1122 memcpy(log_buf, __log_buf, __LOG_BUF_LEN);
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09001123 logbuf_unlock_irqrestore(flags);
Mike Travis162a7e72011-05-24 17:13:20 -07001124
Luis R. Rodriguezf5405172014-08-06 16:08:54 -07001125 pr_info("log_buf_len: %d bytes\n", log_buf_len);
Mike Travis162a7e72011-05-24 17:13:20 -07001126 pr_info("early log buf free: %d(%d%%)\n",
1127 free, (free * 100) / __LOG_BUF_LEN);
1128}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129
Andrew Cooks2fa72c82012-12-17 15:59:56 -08001130static bool __read_mostly ignore_loglevel;
1131
1132static int __init ignore_loglevel_setup(char *str)
1133{
Neil Zhangd25d9fe2014-08-06 16:09:12 -07001134 ignore_loglevel = true;
Andrew Morton27083ba2013-11-12 15:08:50 -08001135 pr_info("debug: ignoring loglevel setting.\n");
Andrew Cooks2fa72c82012-12-17 15:59:56 -08001136
1137 return 0;
1138}
1139
1140early_param("ignore_loglevel", ignore_loglevel_setup);
1141module_param(ignore_loglevel, bool, S_IRUGO | S_IWUSR);
Joe Perches205bd3d2015-02-12 15:01:34 -08001142MODULE_PARM_DESC(ignore_loglevel,
1143 "ignore loglevel setting (prints all kernel messages to the console)");
Andrew Cooks2fa72c82012-12-17 15:59:56 -08001144
Sergey Senozhatskycf775442016-08-02 14:03:56 -07001145static bool suppress_message_printing(int level)
1146{
1147 return (level >= console_loglevel && !ignore_loglevel);
1148}
1149
Randy Dunlapbfe8df32007-10-16 01:23:46 -07001150#ifdef CONFIG_BOOT_PRINTK_DELAY
1151
Namhyung Kim674dff62010-10-26 14:22:48 -07001152static int boot_delay; /* msecs delay after each printk during bootup */
Dave Young3a3b6ed2009-09-22 16:43:31 -07001153static unsigned long long loops_per_msec; /* based on boot_delay */
Randy Dunlapbfe8df32007-10-16 01:23:46 -07001154
1155static int __init boot_delay_setup(char *str)
1156{
1157 unsigned long lpj;
Randy Dunlapbfe8df32007-10-16 01:23:46 -07001158
1159 lpj = preset_lpj ? preset_lpj : 1000000; /* some guess */
1160 loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
1161
1162 get_option(&str, &boot_delay);
1163 if (boot_delay > 10 * 1000)
1164 boot_delay = 0;
1165
Dave Young3a3b6ed2009-09-22 16:43:31 -07001166 pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
1167 "HZ: %d, loops_per_msec: %llu\n",
1168 boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
Dave Young29e9d222013-11-12 15:08:53 -08001169 return 0;
Randy Dunlapbfe8df32007-10-16 01:23:46 -07001170}
Dave Young29e9d222013-11-12 15:08:53 -08001171early_param("boot_delay", boot_delay_setup);
Randy Dunlapbfe8df32007-10-16 01:23:46 -07001172
Andrew Cooks2fa72c82012-12-17 15:59:56 -08001173static void boot_delay_msec(int level)
Randy Dunlapbfe8df32007-10-16 01:23:46 -07001174{
1175 unsigned long long k;
1176 unsigned long timeout;
1177
Thomas Gleixnerff48cd22017-05-16 20:42:45 +02001178 if ((boot_delay == 0 || system_state >= SYSTEM_RUNNING)
Sergey Senozhatskycf775442016-08-02 14:03:56 -07001179 || suppress_message_printing(level)) {
Randy Dunlapbfe8df32007-10-16 01:23:46 -07001180 return;
Andrew Cooks2fa72c82012-12-17 15:59:56 -08001181 }
Randy Dunlapbfe8df32007-10-16 01:23:46 -07001182
Dave Young3a3b6ed2009-09-22 16:43:31 -07001183 k = (unsigned long long)loops_per_msec * boot_delay;
Randy Dunlapbfe8df32007-10-16 01:23:46 -07001184
1185 timeout = jiffies + msecs_to_jiffies(boot_delay);
1186 while (k) {
1187 k--;
1188 cpu_relax();
1189 /*
1190 * use (volatile) jiffies to prevent
1191 * compiler reduction; loop termination via jiffies
1192 * is secondary and may or may not happen.
1193 */
1194 if (time_after(jiffies, timeout))
1195 break;
1196 touch_nmi_watchdog();
1197 }
1198}
1199#else
Andrew Cooks2fa72c82012-12-17 15:59:56 -08001200static inline void boot_delay_msec(int level)
Randy Dunlapbfe8df32007-10-16 01:23:46 -07001201{
1202}
1203#endif
1204
Alex Eldere99aa462014-08-06 16:09:05 -07001205static bool printk_time = IS_ENABLED(CONFIG_PRINTK_TIME);
Kay Sievers7ff95542012-05-03 02:29:13 +02001206module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
1207
Kay Sievers084681d2012-06-28 09:38:53 +02001208static size_t print_time(u64 ts, char *buf)
1209{
1210 unsigned long rem_nsec;
1211
1212 if (!printk_time)
1213 return 0;
1214
Kay Sievers084681d2012-06-28 09:38:53 +02001215 rem_nsec = do_div(ts, 1000000000);
Roland Dreier35dac272013-01-04 15:35:50 -08001216
1217 if (!buf)
1218 return snprintf(NULL, 0, "[%5lu.000000] ", (unsigned long)ts);
1219
Kay Sievers084681d2012-06-28 09:38:53 +02001220 return sprintf(buf, "[%5lu.%06lu] ",
1221 (unsigned long)ts, rem_nsec / 1000);
1222}
1223
Joe Perches62e32ac2013-07-31 13:53:47 -07001224static size_t print_prefix(const struct printk_log *msg, bool syslog, char *buf)
Kay Sievers649e6ee2012-05-10 04:30:45 +02001225{
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001226 size_t len = 0;
Kay Sievers43a73a52012-07-06 09:50:09 -07001227 unsigned int prefix = (msg->facility << 3) | msg->level;
Kay Sievers649e6ee2012-05-10 04:30:45 +02001228
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001229 if (syslog) {
1230 if (buf) {
Kay Sievers43a73a52012-07-06 09:50:09 -07001231 len += sprintf(buf, "<%u>", prefix);
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001232 } else {
1233 len += 3;
Kay Sievers43a73a52012-07-06 09:50:09 -07001234 if (prefix > 999)
1235 len += 3;
1236 else if (prefix > 99)
1237 len += 2;
1238 else if (prefix > 9)
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001239 len++;
1240 }
Kay Sievers7ff95542012-05-03 02:29:13 +02001241 }
1242
Kay Sievers084681d2012-06-28 09:38:53 +02001243 len += print_time(msg->ts_nsec, buf ? buf + len : NULL);
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001244 return len;
1245}
1246
Linus Torvalds5aa068e2016-10-25 11:27:31 -07001247static size_t msg_print_text(const struct printk_log *msg, bool syslog, char *buf, size_t size)
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001248{
1249 const char *text = log_text(msg);
1250 size_t text_size = msg->text_len;
1251 size_t len = 0;
1252
1253 do {
1254 const char *next = memchr(text, '\n', text_size);
1255 size_t text_len;
1256
1257 if (next) {
1258 text_len = next - text;
1259 next++;
1260 text_size -= next - text;
1261 } else {
1262 text_len = text_size;
1263 }
1264
1265 if (buf) {
1266 if (print_prefix(msg, syslog, NULL) +
Kay Sievers70498252012-07-16 18:35:29 -07001267 text_len + 1 >= size - len)
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001268 break;
1269
Linus Torvalds5aa068e2016-10-25 11:27:31 -07001270 len += print_prefix(msg, syslog, buf + len);
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001271 memcpy(buf + len, text, text_len);
1272 len += text_len;
Linus Torvalds5aa068e2016-10-25 11:27:31 -07001273 buf[len++] = '\n';
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001274 } else {
1275 /* SYSLOG_ACTION_* buffer size only calculation */
Linus Torvalds5aa068e2016-10-25 11:27:31 -07001276 len += print_prefix(msg, syslog, NULL);
Kay Sievers5becfb12012-07-09 12:15:42 -07001277 len += text_len;
Linus Torvalds5aa068e2016-10-25 11:27:31 -07001278 len++;
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001279 }
1280
1281 text = next;
1282 } while (text);
1283
Kay Sievers7ff95542012-05-03 02:29:13 +02001284 return len;
1285}
1286
1287static int syslog_print(char __user *buf, int size)
1288{
1289 char *text;
Joe Perches62e32ac2013-07-31 13:53:47 -07001290 struct printk_log *msg;
Jan Beulich116e90b2012-06-22 16:36:09 +01001291 int len = 0;
Kay Sievers7ff95542012-05-03 02:29:13 +02001292
Kay Sievers70498252012-07-16 18:35:29 -07001293 text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
Kay Sievers7ff95542012-05-03 02:29:13 +02001294 if (!text)
1295 return -ENOMEM;
1296
Jan Beulich116e90b2012-06-22 16:36:09 +01001297 while (size > 0) {
1298 size_t n;
Kay Sieverseb02dac2012-07-09 10:05:10 -07001299 size_t skip;
Kay Sievers7ff95542012-05-03 02:29:13 +02001300
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09001301 logbuf_lock_irq();
Jan Beulich116e90b2012-06-22 16:36:09 +01001302 if (syslog_seq < log_first_seq) {
1303 /* messages are gone, move to first one */
1304 syslog_seq = log_first_seq;
1305 syslog_idx = log_first_idx;
Kay Sieverseb02dac2012-07-09 10:05:10 -07001306 syslog_partial = 0;
Jan Beulich116e90b2012-06-22 16:36:09 +01001307 }
1308 if (syslog_seq == log_next_seq) {
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09001309 logbuf_unlock_irq();
Jan Beulich116e90b2012-06-22 16:36:09 +01001310 break;
1311 }
Kay Sieverseb02dac2012-07-09 10:05:10 -07001312
1313 skip = syslog_partial;
Jan Beulich116e90b2012-06-22 16:36:09 +01001314 msg = log_from_idx(syslog_idx);
Linus Torvalds5aa068e2016-10-25 11:27:31 -07001315 n = msg_print_text(msg, true, text, LOG_LINE_MAX + PREFIX_MAX);
Kay Sieverseb02dac2012-07-09 10:05:10 -07001316 if (n - syslog_partial <= size) {
1317 /* message fits into buffer, move forward */
Jan Beulich116e90b2012-06-22 16:36:09 +01001318 syslog_idx = log_next(syslog_idx);
1319 syslog_seq++;
Kay Sieverseb02dac2012-07-09 10:05:10 -07001320 n -= syslog_partial;
1321 syslog_partial = 0;
1322 } else if (!len){
1323 /* partial read(), remember position */
1324 n = size;
1325 syslog_partial += n;
Jan Beulich116e90b2012-06-22 16:36:09 +01001326 } else
1327 n = 0;
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09001328 logbuf_unlock_irq();
Jan Beulich116e90b2012-06-22 16:36:09 +01001329
1330 if (!n)
1331 break;
1332
Kay Sieverseb02dac2012-07-09 10:05:10 -07001333 if (copy_to_user(buf, text + skip, n)) {
Jan Beulich116e90b2012-06-22 16:36:09 +01001334 if (!len)
1335 len = -EFAULT;
1336 break;
1337 }
Kay Sieverseb02dac2012-07-09 10:05:10 -07001338
1339 len += n;
1340 size -= n;
1341 buf += n;
Jan Beulich116e90b2012-06-22 16:36:09 +01001342 }
Kay Sievers7ff95542012-05-03 02:29:13 +02001343
1344 kfree(text);
1345 return len;
1346}
1347
1348static int syslog_print_all(char __user *buf, int size, bool clear)
1349{
1350 char *text;
1351 int len = 0;
1352
Kay Sievers70498252012-07-16 18:35:29 -07001353 text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
Kay Sievers7ff95542012-05-03 02:29:13 +02001354 if (!text)
1355 return -ENOMEM;
1356
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09001357 logbuf_lock_irq();
Kay Sievers7ff95542012-05-03 02:29:13 +02001358 if (buf) {
1359 u64 next_seq;
1360 u64 seq;
1361 u32 idx;
1362
Kay Sievers7ff95542012-05-03 02:29:13 +02001363 /*
1364 * Find first record that fits, including all following records,
1365 * into the user-provided buffer for this dump.
Kay Sieverse2ae7152012-06-15 14:07:51 +02001366 */
Kay Sievers7ff95542012-05-03 02:29:13 +02001367 seq = clear_seq;
1368 idx = clear_idx;
1369 while (seq < log_next_seq) {
Joe Perches62e32ac2013-07-31 13:53:47 -07001370 struct printk_log *msg = log_from_idx(idx);
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001371
Linus Torvalds5aa068e2016-10-25 11:27:31 -07001372 len += msg_print_text(msg, true, NULL, 0);
Kay Sievers7ff95542012-05-03 02:29:13 +02001373 idx = log_next(idx);
1374 seq++;
1375 }
Kay Sieverse2ae7152012-06-15 14:07:51 +02001376
1377 /* move first record forward until length fits into the buffer */
Kay Sievers7ff95542012-05-03 02:29:13 +02001378 seq = clear_seq;
1379 idx = clear_idx;
1380 while (len > size && seq < log_next_seq) {
Joe Perches62e32ac2013-07-31 13:53:47 -07001381 struct printk_log *msg = log_from_idx(idx);
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001382
Linus Torvalds5aa068e2016-10-25 11:27:31 -07001383 len -= msg_print_text(msg, true, NULL, 0);
Kay Sievers7ff95542012-05-03 02:29:13 +02001384 idx = log_next(idx);
1385 seq++;
1386 }
1387
Kay Sieverse2ae7152012-06-15 14:07:51 +02001388 /* last message fitting into this dump */
Kay Sievers7ff95542012-05-03 02:29:13 +02001389 next_seq = log_next_seq;
1390
1391 len = 0;
1392 while (len >= 0 && seq < next_seq) {
Joe Perches62e32ac2013-07-31 13:53:47 -07001393 struct printk_log *msg = log_from_idx(idx);
Kay Sievers7ff95542012-05-03 02:29:13 +02001394 int textlen;
1395
Linus Torvalds5aa068e2016-10-25 11:27:31 -07001396 textlen = msg_print_text(msg, true, text,
Kay Sievers70498252012-07-16 18:35:29 -07001397 LOG_LINE_MAX + PREFIX_MAX);
Kay Sievers7ff95542012-05-03 02:29:13 +02001398 if (textlen < 0) {
1399 len = textlen;
1400 break;
1401 }
1402 idx = log_next(idx);
1403 seq++;
1404
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09001405 logbuf_unlock_irq();
Kay Sievers7ff95542012-05-03 02:29:13 +02001406 if (copy_to_user(buf + len, text, textlen))
1407 len = -EFAULT;
1408 else
1409 len += textlen;
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09001410 logbuf_lock_irq();
Kay Sievers7ff95542012-05-03 02:29:13 +02001411
1412 if (seq < log_first_seq) {
1413 /* messages are gone, move to next one */
1414 seq = log_first_seq;
1415 idx = log_first_idx;
1416 }
1417 }
1418 }
1419
1420 if (clear) {
1421 clear_seq = log_next_seq;
1422 clear_idx = log_next_idx;
1423 }
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09001424 logbuf_unlock_irq();
Kay Sievers7ff95542012-05-03 02:29:13 +02001425
1426 kfree(text);
1427 return len;
1428}
1429
Vasily Averin3ea43312015-06-25 15:01:47 -07001430int do_syslog(int type, char __user *buf, int len, int source)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431{
Kay Sievers7ff95542012-05-03 02:29:13 +02001432 bool clear = false;
Joe Perchesa39d4a82014-12-10 15:50:15 -08001433 static int saved_console_loglevel = LOGLEVEL_DEFAULT;
Linus Torvaldsee24aeb2011-02-10 17:53:55 -08001434 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435
Vasily Averin3ea43312015-06-25 15:01:47 -07001436 error = check_syslog_permissions(type, source);
Linus Torvaldsee24aeb2011-02-10 17:53:55 -08001437 if (error)
1438 goto out;
Eric Paris12b30522010-11-15 18:36:29 -05001439
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 switch (type) {
Kees Cookd78ca3c2010-02-03 15:37:13 -08001441 case SYSLOG_ACTION_CLOSE: /* Close log */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001443 case SYSLOG_ACTION_OPEN: /* Open log */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001445 case SYSLOG_ACTION_READ: /* Read from log */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 error = -EINVAL;
1447 if (!buf || len < 0)
1448 goto out;
1449 error = 0;
1450 if (!len)
1451 goto out;
1452 if (!access_ok(VERIFY_WRITE, buf, len)) {
1453 error = -EFAULT;
1454 goto out;
1455 }
Yuanhan Liu4a77a5a2012-06-16 21:21:51 +08001456 error = wait_event_interruptible(log_wait,
1457 syslog_seq != log_next_seq);
Kay Sieverscb424ff2012-07-06 09:50:09 -07001458 if (error)
Yuanhan Liu4a77a5a2012-06-16 21:21:51 +08001459 goto out;
Kay Sievers7ff95542012-05-03 02:29:13 +02001460 error = syslog_print(buf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001462 /* Read/clear last kernel messages */
1463 case SYSLOG_ACTION_READ_CLEAR:
Kay Sievers7ff95542012-05-03 02:29:13 +02001464 clear = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 /* FALL THRU */
Kees Cookd78ca3c2010-02-03 15:37:13 -08001466 /* Read last kernel messages */
1467 case SYSLOG_ACTION_READ_ALL:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 error = -EINVAL;
1469 if (!buf || len < 0)
1470 goto out;
1471 error = 0;
1472 if (!len)
1473 goto out;
1474 if (!access_ok(VERIFY_WRITE, buf, len)) {
1475 error = -EFAULT;
1476 goto out;
1477 }
Kay Sievers7ff95542012-05-03 02:29:13 +02001478 error = syslog_print_all(buf, len, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001480 /* Clear ring buffer */
1481 case SYSLOG_ACTION_CLEAR:
Kay Sievers7ff95542012-05-03 02:29:13 +02001482 syslog_print_all(NULL, 0, true);
Alan Stern4661e352012-06-22 17:12:19 -04001483 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001484 /* Disable logging to console */
1485 case SYSLOG_ACTION_CONSOLE_OFF:
Joe Perchesa39d4a82014-12-10 15:50:15 -08001486 if (saved_console_loglevel == LOGLEVEL_DEFAULT)
Frans Pop1aaad492009-07-06 13:31:48 +02001487 saved_console_loglevel = console_loglevel;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 console_loglevel = minimum_console_loglevel;
1489 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001490 /* Enable logging to console */
1491 case SYSLOG_ACTION_CONSOLE_ON:
Joe Perchesa39d4a82014-12-10 15:50:15 -08001492 if (saved_console_loglevel != LOGLEVEL_DEFAULT) {
Frans Pop1aaad492009-07-06 13:31:48 +02001493 console_loglevel = saved_console_loglevel;
Joe Perchesa39d4a82014-12-10 15:50:15 -08001494 saved_console_loglevel = LOGLEVEL_DEFAULT;
Frans Pop1aaad492009-07-06 13:31:48 +02001495 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001497 /* Set level of messages printed to console */
1498 case SYSLOG_ACTION_CONSOLE_LEVEL:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 error = -EINVAL;
1500 if (len < 1 || len > 8)
1501 goto out;
1502 if (len < minimum_console_loglevel)
1503 len = minimum_console_loglevel;
1504 console_loglevel = len;
Frans Pop1aaad492009-07-06 13:31:48 +02001505 /* Implicitly re-enable logging to console */
Joe Perchesa39d4a82014-12-10 15:50:15 -08001506 saved_console_loglevel = LOGLEVEL_DEFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 error = 0;
1508 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001509 /* Number of chars in the log buffer */
1510 case SYSLOG_ACTION_SIZE_UNREAD:
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09001511 logbuf_lock_irq();
Kay Sievers7ff95542012-05-03 02:29:13 +02001512 if (syslog_seq < log_first_seq) {
1513 /* messages are gone, move to first one */
1514 syslog_seq = log_first_seq;
1515 syslog_idx = log_first_idx;
Kay Sieverseb02dac2012-07-09 10:05:10 -07001516 syslog_partial = 0;
Kay Sievers7ff95542012-05-03 02:29:13 +02001517 }
Vasily Averin3ea43312015-06-25 15:01:47 -07001518 if (source == SYSLOG_FROM_PROC) {
Kay Sievers7ff95542012-05-03 02:29:13 +02001519 /*
1520 * Short-cut for poll(/"proc/kmsg") which simply checks
1521 * for pending data, not the size; return the count of
1522 * records, not the length.
1523 */
Alex Eldere97e1262014-08-06 16:08:59 -07001524 error = log_next_seq - syslog_seq;
Kay Sievers7ff95542012-05-03 02:29:13 +02001525 } else {
Kay Sievers5becfb12012-07-09 12:15:42 -07001526 u64 seq = syslog_seq;
1527 u32 idx = syslog_idx;
Kay Sievers7ff95542012-05-03 02:29:13 +02001528
1529 error = 0;
Kay Sievers7ff95542012-05-03 02:29:13 +02001530 while (seq < log_next_seq) {
Joe Perches62e32ac2013-07-31 13:53:47 -07001531 struct printk_log *msg = log_from_idx(idx);
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001532
Linus Torvalds5aa068e2016-10-25 11:27:31 -07001533 error += msg_print_text(msg, true, NULL, 0);
Kay Sievers7ff95542012-05-03 02:29:13 +02001534 idx = log_next(idx);
1535 seq++;
1536 }
Kay Sieverseb02dac2012-07-09 10:05:10 -07001537 error -= syslog_partial;
Kay Sievers7ff95542012-05-03 02:29:13 +02001538 }
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09001539 logbuf_unlock_irq();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001541 /* Size of the log buffer */
1542 case SYSLOG_ACTION_SIZE_BUFFER:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 error = log_buf_len;
1544 break;
1545 default:
1546 error = -EINVAL;
1547 break;
1548 }
1549out:
1550 return error;
1551}
1552
Heiko Carstens1e7bfb22009-01-14 14:14:29 +01001553SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554{
Kees Cook637241a2013-06-12 14:04:39 -07001555 return do_syslog(type, buf, len, SYSLOG_FROM_READER);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556}
1557
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 * Call the console drivers, asking them to write out
1560 * log_buf[start] to log_buf[end - 1].
Torben Hohnac751ef2011-01-25 15:07:35 -08001561 * The console_lock must be held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 */
Sergey Senozhatskyd9c23522016-12-24 23:09:01 +09001563static void call_console_drivers(const char *ext_text, size_t ext_len,
Tejun Heo6fe29352015-06-25 15:01:30 -07001564 const char *text, size_t len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565{
Kay Sievers7ff95542012-05-03 02:29:13 +02001566 struct console *con;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
Sergey Senozhatskyfc98c3c2017-02-18 03:42:54 -08001568 trace_console_rcuidle(text, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569
Kay Sievers7ff95542012-05-03 02:29:13 +02001570 if (!console_drivers)
1571 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572
Kay Sievers7ff95542012-05-03 02:29:13 +02001573 for_each_console(con) {
1574 if (exclusive_console && con != exclusive_console)
1575 continue;
1576 if (!(con->flags & CON_ENABLED))
1577 continue;
1578 if (!con->write)
1579 continue;
1580 if (!cpu_online(smp_processor_id()) &&
1581 !(con->flags & CON_ANYTIME))
1582 continue;
Tejun Heo6fe29352015-06-25 15:01:30 -07001583 if (con->flags & CON_EXTENDED)
1584 con->write(con, ext_text, ext_len);
1585 else
1586 con->write(con, text, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588}
1589
Dave Youngaf913222009-09-22 16:43:33 -07001590int printk_delay_msec __read_mostly;
1591
1592static inline void printk_delay(void)
1593{
1594 if (unlikely(printk_delay_msec)) {
1595 int m = printk_delay_msec;
1596
1597 while (m--) {
1598 mdelay(1);
1599 touch_nmi_watchdog();
1600 }
1601 }
1602}
1603
Kay Sievers084681d2012-06-28 09:38:53 +02001604/*
1605 * Continuation lines are buffered, and not committed to the record buffer
1606 * until the line is complete, or a race forces it. The line fragments
1607 * though, are printed immediately to the consoles to ensure everything has
1608 * reached the console in case of a kernel crash.
1609 */
1610static struct cont {
1611 char buf[LOG_LINE_MAX];
1612 size_t len; /* length == 0 means unused buffer */
Kay Sievers084681d2012-06-28 09:38:53 +02001613 struct task_struct *owner; /* task of first print*/
1614 u64 ts_nsec; /* time of first print */
1615 u8 level; /* log level of first message */
Alex Elder0b90fec2014-08-06 16:09:03 -07001616 u8 facility; /* log facility of first message */
Kay Sieverseab07262012-07-16 18:35:30 -07001617 enum log_flags flags; /* prefix, newline flags */
Kay Sievers084681d2012-06-28 09:38:53 +02001618} cont;
1619
Linus Torvalds5e467652016-10-09 11:53:00 -07001620static void cont_flush(void)
Kay Sievers084681d2012-06-28 09:38:53 +02001621{
Kay Sievers084681d2012-06-28 09:38:53 +02001622 if (cont.len == 0)
1623 return;
Linus Torvalds5c2992e2016-10-25 11:27:31 -07001624
1625 log_store(cont.facility, cont.level, cont.flags, cont.ts_nsec,
1626 NULL, 0, cont.buf, cont.len);
1627 cont.len = 0;
Kay Sievers084681d2012-06-28 09:38:53 +02001628}
1629
Linus Torvalds5e467652016-10-09 11:53:00 -07001630static bool cont_add(int facility, int level, enum log_flags flags, const char *text, size_t len)
Kay Sievers084681d2012-06-28 09:38:53 +02001631{
Tejun Heo6fe29352015-06-25 15:01:30 -07001632 /*
1633 * If ext consoles are present, flush and skip in-kernel
1634 * continuation. See nr_ext_console_drivers definition. Also, if
1635 * the line gets too long, split it up in separate records.
1636 */
1637 if (nr_ext_console_drivers || cont.len + len > sizeof(cont.buf)) {
Linus Torvalds5e467652016-10-09 11:53:00 -07001638 cont_flush();
Kay Sievers084681d2012-06-28 09:38:53 +02001639 return false;
1640 }
1641
1642 if (!cont.len) {
1643 cont.facility = facility;
1644 cont.level = level;
1645 cont.owner = current;
1646 cont.ts_nsec = local_clock();
Linus Torvalds5e467652016-10-09 11:53:00 -07001647 cont.flags = flags;
Kay Sievers084681d2012-06-28 09:38:53 +02001648 }
1649
1650 memcpy(cont.buf + cont.len, text, len);
1651 cont.len += len;
Kay Sieverseab07262012-07-16 18:35:30 -07001652
Linus Torvalds5e467652016-10-09 11:53:00 -07001653 // The original flags come from the first line,
1654 // but later continuations can add a newline.
1655 if (flags & LOG_NEWLINE) {
1656 cont.flags |= LOG_NEWLINE;
1657 cont_flush();
1658 }
1659
Kay Sieverseab07262012-07-16 18:35:30 -07001660 if (cont.len > (sizeof(cont.buf) * 80) / 100)
Linus Torvalds5e467652016-10-09 11:53:00 -07001661 cont_flush();
Kay Sieverseab07262012-07-16 18:35:30 -07001662
Kay Sievers084681d2012-06-28 09:38:53 +02001663 return true;
1664}
1665
Linus Torvaldsc362c7f2016-10-08 22:02:09 -07001666static size_t log_output(int facility, int level, enum log_flags lflags, const char *dict, size_t dictlen, char *text, size_t text_len)
1667{
Linus Torvaldsc362c7f2016-10-08 22:02:09 -07001668 /*
Linus Torvalds5e467652016-10-09 11:53:00 -07001669 * If an earlier line was buffered, and we're a continuation
1670 * write from the same process, try to add it to the buffer.
Linus Torvaldsc362c7f2016-10-08 22:02:09 -07001671 */
1672 if (cont.len) {
Linus Torvalds5e467652016-10-09 11:53:00 -07001673 if (cont.owner == current && (lflags & LOG_CONT)) {
1674 if (cont_add(facility, level, lflags, text, text_len))
1675 return text_len;
1676 }
1677 /* Otherwise, make sure it's flushed */
1678 cont_flush();
1679 }
Linus Torvaldsc362c7f2016-10-08 22:02:09 -07001680
Linus Torvalds8835ca52016-10-19 09:11:24 -07001681 /* Skip empty continuation lines that couldn't be added - they just flush */
1682 if (!text_len && (lflags & LOG_CONT))
1683 return 0;
1684
Linus Torvalds5e467652016-10-09 11:53:00 -07001685 /* If it doesn't end in a newline, try to buffer the current line */
1686 if (!(lflags & LOG_NEWLINE)) {
1687 if (cont_add(facility, level, lflags, text, text_len))
Linus Torvaldsc362c7f2016-10-08 22:02:09 -07001688 return text_len;
1689 }
1690
Linus Torvalds5e467652016-10-09 11:53:00 -07001691 /* Store it in the record log */
Linus Torvaldsc362c7f2016-10-08 22:02:09 -07001692 return log_store(facility, level, lflags, 0, dict, dictlen, text, text_len);
1693}
1694
Kay Sievers7ff95542012-05-03 02:29:13 +02001695asmlinkage int vprintk_emit(int facility, int level,
1696 const char *dict, size_t dictlen,
1697 const char *fmt, va_list args)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698{
Kay Sievers7ff95542012-05-03 02:29:13 +02001699 static char textbuf[LOG_LINE_MAX];
1700 char *text = textbuf;
Pierre Kuoaec47ca2017-07-11 14:40:55 +08001701 size_t text_len;
Kay Sievers5becfb12012-07-09 12:15:42 -07001702 enum log_flags lflags = 0;
Nick Andrewac60ad72008-05-12 21:21:04 +02001703 unsigned long flags;
Pierre Kuoaec47ca2017-07-11 14:40:55 +08001704 int printed_len;
Steven Rostedt458df9f2014-06-04 16:11:38 -07001705 bool in_sched = false;
Jan Kara608873c2014-06-04 16:11:35 -07001706
Joe Perchesa39d4a82014-12-10 15:50:15 -08001707 if (level == LOGLEVEL_SCHED) {
1708 level = LOGLEVEL_DEFAULT;
Steven Rostedt458df9f2014-06-04 16:11:38 -07001709 in_sched = true;
1710 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711
Andrew Cooks2fa72c82012-12-17 15:59:56 -08001712 boot_delay_msec(level);
Dave Youngaf913222009-09-22 16:43:33 -07001713 printk_delay();
Randy Dunlapbfe8df32007-10-16 01:23:46 -07001714
Sergey Senozhatskya8199372016-03-17 14:21:20 -07001715 /* This stops the holder of console_sem just where we want him */
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09001716 logbuf_lock_irqsave(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717 /*
Kay Sievers7ff95542012-05-03 02:29:13 +02001718 * The printf needs to come first; we need the syslog
1719 * prefix which might be passed-in as a parameter.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720 */
Markus Trippelsdorf98e35f52014-10-13 15:51:13 -07001721 text_len = vscnprintf(text, sizeof(textbuf), fmt, args);
Nick Andrewac60ad72008-05-12 21:21:04 +02001722
Kay Sievers7ff95542012-05-03 02:29:13 +02001723 /* mark and strip a trailing newline */
Kay Sieversc313af12012-05-14 20:46:27 +02001724 if (text_len && text[text_len-1] == '\n') {
1725 text_len--;
Kay Sievers5becfb12012-07-09 12:15:42 -07001726 lflags |= LOG_NEWLINE;
Kay Sievers7ff95542012-05-03 02:29:13 +02001727 }
Kay Sievers9d90c8d2011-03-13 03:19:51 +01001728
Joe Perches088a52a2012-07-30 14:40:19 -07001729 /* strip kernel syslog prefix and extract log level or control flags */
1730 if (facility == 0) {
Linus Torvalds4bcc5952016-10-08 20:32:40 -07001731 int kern_level;
Joe Perches088a52a2012-07-30 14:40:19 -07001732
Linus Torvalds4bcc5952016-10-08 20:32:40 -07001733 while ((kern_level = printk_get_level(text)) != 0) {
Joe Perches088a52a2012-07-30 14:40:19 -07001734 switch (kern_level) {
1735 case '0' ... '7':
Joe Perchesa39d4a82014-12-10 15:50:15 -08001736 if (level == LOGLEVEL_DEFAULT)
Joe Perches088a52a2012-07-30 14:40:19 -07001737 level = kern_level - '0';
Joe Perchesa39d4a82014-12-10 15:50:15 -08001738 /* fallthrough */
Joe Perches088a52a2012-07-30 14:40:19 -07001739 case 'd': /* KERN_DEFAULT */
1740 lflags |= LOG_PREFIX;
Linus Torvalds4bcc5952016-10-08 20:32:40 -07001741 break;
1742 case 'c': /* KERN_CONT */
1743 lflags |= LOG_CONT;
Joe Perches088a52a2012-07-30 14:40:19 -07001744 }
Linus Torvalds4bcc5952016-10-08 20:32:40 -07001745
1746 text_len -= 2;
1747 text += 2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 }
Kay Sievers7ff95542012-05-03 02:29:13 +02001749 }
Nick Andrewac60ad72008-05-12 21:21:04 +02001750
Joe Perchesa39d4a82014-12-10 15:50:15 -08001751 if (level == LOGLEVEL_DEFAULT)
Kay Sieversc313af12012-05-14 20:46:27 +02001752 level = default_message_loglevel;
1753
Kay Sievers5becfb12012-07-09 12:15:42 -07001754 if (dict)
1755 lflags |= LOG_PREFIX|LOG_NEWLINE;
Kay Sievers7ff95542012-05-03 02:29:13 +02001756
Pierre Kuoaec47ca2017-07-11 14:40:55 +08001757 printed_len = log_output(facility, level, lflags, dict, dictlen, text, text_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09001759 logbuf_unlock_irqrestore(flags);
Jan Kara939f04b2014-06-04 16:11:37 -07001760
Steven Rostedt458df9f2014-06-04 16:11:38 -07001761 /* If called from the scheduler, we can not call up(). */
Andrew Mortond18bbc22014-07-02 15:22:38 -07001762 if (!in_sched) {
Jan Kara5874af22014-08-06 16:09:10 -07001763 /*
Andrew Mortond18bbc22014-07-02 15:22:38 -07001764 * Try to acquire and then immediately release the console
1765 * semaphore. The release will print out buffers and wake up
1766 * /dev/kmsg and syslog() users.
1767 */
Sergey Senozhatskya8199372016-03-17 14:21:20 -07001768 if (console_trylock())
Andrew Mortond18bbc22014-07-02 15:22:38 -07001769 console_unlock();
1770 }
Steven Rostedt458df9f2014-06-04 16:11:38 -07001771
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 return printed_len;
1773}
Kay Sievers7ff95542012-05-03 02:29:13 +02001774EXPORT_SYMBOL(vprintk_emit);
1775
1776asmlinkage int vprintk(const char *fmt, va_list args)
1777{
Sergey Senozhatskybd66a892016-12-27 23:16:04 +09001778 return vprintk_func(fmt, args);
Kay Sievers7ff95542012-05-03 02:29:13 +02001779}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780EXPORT_SYMBOL(vprintk);
1781
Kay Sievers7ff95542012-05-03 02:29:13 +02001782asmlinkage int printk_emit(int facility, int level,
1783 const char *dict, size_t dictlen,
1784 const char *fmt, ...)
1785{
1786 va_list args;
1787 int r;
1788
1789 va_start(args, fmt);
1790 r = vprintk_emit(facility, level, dict, dictlen, fmt, args);
1791 va_end(args);
1792
1793 return r;
1794}
1795EXPORT_SYMBOL(printk_emit);
1796
Linus Torvaldsa0cba212016-08-09 10:48:18 -07001797int vprintk_default(const char *fmt, va_list args)
Steven Rostedt (Red Hat)afdc34a2014-06-19 17:33:31 -04001798{
1799 int r;
1800
1801#ifdef CONFIG_KGDB_KDB
Petr Mladek34aaff42016-12-14 15:05:58 -08001802 /* Allow to pass printk() to kdb but avoid a recursion. */
1803 if (unlikely(kdb_trap_printk && kdb_printf_cpu < 0)) {
Daniel Thompsonf7d4ca82014-11-07 18:37:57 +00001804 r = vkdb_printf(KDB_MSGSRC_PRINTK, fmt, args);
Steven Rostedt (Red Hat)afdc34a2014-06-19 17:33:31 -04001805 return r;
1806 }
1807#endif
Linus Torvaldsa0cba212016-08-09 10:48:18 -07001808 r = vprintk_emit(0, LOGLEVEL_DEFAULT, NULL, 0, fmt, args);
Steven Rostedt (Red Hat)afdc34a2014-06-19 17:33:31 -04001809
1810 return r;
1811}
1812EXPORT_SYMBOL_GPL(vprintk_default);
1813
Kay Sievers7ff95542012-05-03 02:29:13 +02001814/**
1815 * printk - print a kernel message
1816 * @fmt: format string
1817 *
1818 * This is printk(). It can be called from any context. We want it to work.
1819 *
1820 * We try to grab the console_lock. If we succeed, it's easy - we log the
1821 * output and call the console drivers. If we fail to get the semaphore, we
1822 * place the output into the log buffer and return. The current holder of
1823 * the console_sem will notice the new output in console_unlock(); and will
1824 * send it to the consoles before releasing the lock.
1825 *
1826 * One effect of this deferred printing is that code which calls printk() and
1827 * then changes console_loglevel may break. This is because console_loglevel
1828 * is inspected when the actual printing occurs.
1829 *
1830 * See also:
1831 * printf(3)
1832 *
1833 * See the vsnprintf() documentation for format string extensions over C99.
1834 */
Andi Kleen722a9f92014-05-02 00:44:38 +02001835asmlinkage __visible int printk(const char *fmt, ...)
Kay Sievers7ff95542012-05-03 02:29:13 +02001836{
1837 va_list args;
1838 int r;
1839
Kay Sievers7ff95542012-05-03 02:29:13 +02001840 va_start(args, fmt);
Linus Torvaldsa0cba212016-08-09 10:48:18 -07001841 r = vprintk_func(fmt, args);
Kay Sievers7ff95542012-05-03 02:29:13 +02001842 va_end(args);
1843
1844 return r;
1845}
1846EXPORT_SYMBOL(printk);
Kay Sievers7f3a7812012-05-09 01:37:51 +02001847
Kay Sievers96efedf2012-07-16 18:35:29 -07001848#else /* CONFIG_PRINTK */
Matt Mackalld59745c2005-05-01 08:59:02 -07001849
Kay Sievers70498252012-07-16 18:35:29 -07001850#define LOG_LINE_MAX 0
1851#define PREFIX_MAX 0
Alex Elder249771b2014-08-06 16:09:08 -07001852
Kay Sievers96efedf2012-07-16 18:35:29 -07001853static u64 syslog_seq;
1854static u32 syslog_idx;
Kay Sieverseab07262012-07-16 18:35:30 -07001855static u64 console_seq;
1856static u32 console_idx;
Kay Sievers96efedf2012-07-16 18:35:29 -07001857static u64 log_first_seq;
1858static u32 log_first_idx;
1859static u64 log_next_seq;
Tejun Heo6fe29352015-06-25 15:01:30 -07001860static char *log_text(const struct printk_log *msg) { return NULL; }
1861static char *log_dict(const struct printk_log *msg) { return NULL; }
Joe Perches62e32ac2013-07-31 13:53:47 -07001862static struct printk_log *log_from_idx(u32 idx) { return NULL; }
Kay Sievers7f3a7812012-05-09 01:37:51 +02001863static u32 log_next(u32 idx) { return 0; }
Tejun Heo6fe29352015-06-25 15:01:30 -07001864static ssize_t msg_print_ext_header(char *buf, size_t size,
Linus Torvalds5aa068e2016-10-25 11:27:31 -07001865 struct printk_log *msg,
1866 u64 seq) { return 0; }
Tejun Heo6fe29352015-06-25 15:01:30 -07001867static ssize_t msg_print_ext_body(char *buf, size_t size,
1868 char *dict, size_t dict_len,
1869 char *text, size_t text_len) { return 0; }
Sergey Senozhatskyd9c23522016-12-24 23:09:01 +09001870static void call_console_drivers(const char *ext_text, size_t ext_len,
Tejun Heo6fe29352015-06-25 15:01:30 -07001871 const char *text, size_t len) {}
Linus Torvalds5aa068e2016-10-25 11:27:31 -07001872static size_t msg_print_text(const struct printk_log *msg,
Kay Sievers5becfb12012-07-09 12:15:42 -07001873 bool syslog, char *buf, size_t size) { return 0; }
Sergey Senozhatskycf775442016-08-02 14:03:56 -07001874static bool suppress_message_printing(int level) { return false; }
Matt Mackalld59745c2005-05-01 08:59:02 -07001875
Kay Sievers7f3a7812012-05-09 01:37:51 +02001876#endif /* CONFIG_PRINTK */
Matt Mackalld59745c2005-05-01 08:59:02 -07001877
Thomas Gleixnerd0380e62013-04-29 16:17:18 -07001878#ifdef CONFIG_EARLY_PRINTK
1879struct console *early_console;
1880
Andi Kleen722a9f92014-05-02 00:44:38 +02001881asmlinkage __visible void early_printk(const char *fmt, ...)
Thomas Gleixnerd0380e62013-04-29 16:17:18 -07001882{
1883 va_list ap;
Joe Perches1dc62442014-12-10 15:45:53 -08001884 char buf[512];
1885 int n;
1886
1887 if (!early_console)
1888 return;
Thomas Gleixnerd0380e62013-04-29 16:17:18 -07001889
1890 va_start(ap, fmt);
Joe Perches1dc62442014-12-10 15:45:53 -08001891 n = vscnprintf(buf, sizeof(buf), fmt, ap);
Thomas Gleixnerd0380e62013-04-29 16:17:18 -07001892 va_end(ap);
Joe Perches1dc62442014-12-10 15:45:53 -08001893
1894 early_console->write(early_console, buf, n);
Thomas Gleixnerd0380e62013-04-29 16:17:18 -07001895}
1896#endif
1897
Samuel Thibaultf7511d52008-04-30 00:54:51 -07001898static int __add_preferred_console(char *name, int idx, char *options,
1899 char *brl_options)
1900{
1901 struct console_cmdline *c;
1902 int i;
1903
1904 /*
1905 * See if this tty is not yet registered, and
1906 * if we have a slot free.
1907 */
Petr Mladekdac8bbb2017-06-08 12:01:30 +02001908 for (i = 0, c = console_cmdline;
1909 i < MAX_CMDLINECONSOLES && c->name[0];
1910 i++, c++) {
Joe Perches23475402013-07-31 13:53:46 -07001911 if (strcmp(c->name, name) == 0 && c->index == idx) {
Petr Mladekdac8bbb2017-06-08 12:01:30 +02001912 if (!brl_options)
1913 preferred_console = i;
Joe Perches23475402013-07-31 13:53:46 -07001914 return 0;
Samuel Thibaultf7511d52008-04-30 00:54:51 -07001915 }
Joe Perches23475402013-07-31 13:53:46 -07001916 }
Samuel Thibaultf7511d52008-04-30 00:54:51 -07001917 if (i == MAX_CMDLINECONSOLES)
1918 return -E2BIG;
1919 if (!brl_options)
Aleksey Makarovad86ee22017-03-15 13:28:51 +03001920 preferred_console = i;
Samuel Thibaultf7511d52008-04-30 00:54:51 -07001921 strlcpy(c->name, name, sizeof(c->name));
1922 c->options = options;
Joe Perchesbbeddf52013-07-31 13:53:45 -07001923 braille_set_options(c, brl_options);
1924
Samuel Thibaultf7511d52008-04-30 00:54:51 -07001925 c->index = idx;
1926 return 0;
1927}
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001928/*
Alex Elder0b90fec2014-08-06 16:09:03 -07001929 * Set up a console. Called via do_early_param() in init/main.c
1930 * for each "console=" parameter in the boot command line.
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001931 */
1932static int __init console_setup(char *str)
1933{
Alex Elder0b90fec2014-08-06 16:09:03 -07001934 char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for "ttyS" */
Samuel Thibaultf7511d52008-04-30 00:54:51 -07001935 char *s, *options, *brl_options = NULL;
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001936 int idx;
1937
Joe Perchesbbeddf52013-07-31 13:53:45 -07001938 if (_braille_console_setup(&str, &brl_options))
1939 return 1;
Samuel Thibaultf7511d52008-04-30 00:54:51 -07001940
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001941 /*
1942 * Decode str into name, index, options.
1943 */
1944 if (str[0] >= '0' && str[0] <= '9') {
Yinghai Lueaa944a2007-07-15 23:37:27 -07001945 strcpy(buf, "ttyS");
1946 strncpy(buf + 4, str, sizeof(buf) - 5);
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001947 } else {
Yinghai Lueaa944a2007-07-15 23:37:27 -07001948 strncpy(buf, str, sizeof(buf) - 1);
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001949 }
Yinghai Lueaa944a2007-07-15 23:37:27 -07001950 buf[sizeof(buf) - 1] = 0;
Alex Elder249771b2014-08-06 16:09:08 -07001951 options = strchr(str, ',');
1952 if (options)
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001953 *(options++) = 0;
1954#ifdef __sparc__
1955 if (!strcmp(str, "ttya"))
Yinghai Lueaa944a2007-07-15 23:37:27 -07001956 strcpy(buf, "ttyS0");
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001957 if (!strcmp(str, "ttyb"))
Yinghai Lueaa944a2007-07-15 23:37:27 -07001958 strcpy(buf, "ttyS1");
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001959#endif
Yinghai Lueaa944a2007-07-15 23:37:27 -07001960 for (s = buf; *s; s++)
Alex Elder249771b2014-08-06 16:09:08 -07001961 if (isdigit(*s) || *s == ',')
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001962 break;
1963 idx = simple_strtoul(s, NULL, 10);
1964 *s = 0;
1965
Samuel Thibaultf7511d52008-04-30 00:54:51 -07001966 __add_preferred_console(buf, idx, options, brl_options);
Markus Armbruster9e124fe2008-05-26 23:31:07 +01001967 console_set_on_cmdline = 1;
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001968 return 1;
1969}
1970__setup("console=", console_setup);
1971
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972/**
Matt Mackall3c0547b2005-05-16 21:53:47 -07001973 * add_preferred_console - add a device to the list of preferred consoles.
Martin Waitzddad86c2005-11-13 16:08:14 -08001974 * @name: device name
1975 * @idx: device index
1976 * @options: options for this console
Matt Mackall3c0547b2005-05-16 21:53:47 -07001977 *
1978 * The last preferred console added will be used for kernel messages
1979 * and stdin/out/err for init. Normally this is used by console_setup
1980 * above to handle user-supplied console arguments; however it can also
1981 * be used by arch-specific code either to override the user or more
1982 * commonly to provide a default console (ie from PROM variables) when
1983 * the user has not supplied one.
1984 */
David S. Millerfb445ee2007-12-29 01:19:49 -08001985int add_preferred_console(char *name, int idx, char *options)
Matt Mackall3c0547b2005-05-16 21:53:47 -07001986{
Samuel Thibaultf7511d52008-04-30 00:54:51 -07001987 return __add_preferred_console(name, idx, options, NULL);
Matt Mackall3c0547b2005-05-16 21:53:47 -07001988}
1989
Neil Zhangd25d9fe2014-08-06 16:09:12 -07001990bool console_suspend_enabled = true;
Andres Salomon8f4ce8c2007-10-18 03:04:50 -07001991EXPORT_SYMBOL(console_suspend_enabled);
1992
1993static int __init console_suspend_disable(char *str)
1994{
Neil Zhangd25d9fe2014-08-06 16:09:12 -07001995 console_suspend_enabled = false;
Andres Salomon8f4ce8c2007-10-18 03:04:50 -07001996 return 1;
1997}
1998__setup("no_console_suspend", console_suspend_disable);
Yanmin Zhang134620f2011-10-31 17:11:27 -07001999module_param_named(console_suspend, console_suspend_enabled,
2000 bool, S_IRUGO | S_IWUSR);
2001MODULE_PARM_DESC(console_suspend, "suspend console during suspend"
2002 " and hibernate operations");
Andres Salomon8f4ce8c2007-10-18 03:04:50 -07002003
Matt Mackall3c0547b2005-05-16 21:53:47 -07002004/**
Linus Torvalds557240b2006-06-19 18:16:01 -07002005 * suspend_console - suspend the console subsystem
2006 *
2007 * This disables printk() while we go into suspend states
2008 */
2009void suspend_console(void)
2010{
Andres Salomon8f4ce8c2007-10-18 03:04:50 -07002011 if (!console_suspend_enabled)
2012 return;
Pavel Machek0d630812008-07-23 21:28:32 -07002013 printk("Suspending console(s) (use no_console_suspend to debug)\n");
Torben Hohnac751ef2011-01-25 15:07:35 -08002014 console_lock();
Linus Torvalds557240b2006-06-19 18:16:01 -07002015 console_suspended = 1;
Jan Karabd8d7cf2014-06-04 16:11:36 -07002016 up_console_sem();
Linus Torvalds557240b2006-06-19 18:16:01 -07002017}
2018
2019void resume_console(void)
2020{
Andres Salomon8f4ce8c2007-10-18 03:04:50 -07002021 if (!console_suspend_enabled)
2022 return;
Jan Karabd8d7cf2014-06-04 16:11:36 -07002023 down_console_sem();
Linus Torvalds557240b2006-06-19 18:16:01 -07002024 console_suspended = 0;
Torben Hohnac751ef2011-01-25 15:07:35 -08002025 console_unlock();
Linus Torvalds557240b2006-06-19 18:16:01 -07002026}
2027
2028/**
Kevin Cernekee034260d2010-06-03 22:11:25 -07002029 * console_cpu_notify - print deferred console messages after CPU hotplug
Sebastian Andrzej Siewior90b14882016-11-03 15:49:58 +01002030 * @cpu: unused
Kevin Cernekee034260d2010-06-03 22:11:25 -07002031 *
2032 * If printk() is called from a CPU that is not online yet, the messages
Sergey Senozhatsky64ca7522017-01-21 19:47:29 +09002033 * will be printed on the console only if there are CON_ANYTIME consoles.
2034 * This function is called when a new CPU comes online (or fails to come
2035 * up) or goes offline.
Kevin Cernekee034260d2010-06-03 22:11:25 -07002036 */
Sebastian Andrzej Siewior90b14882016-11-03 15:49:58 +01002037static int console_cpu_notify(unsigned int cpu)
Kevin Cernekee034260d2010-06-03 22:11:25 -07002038{
Thomas Gleixnerf97960f2016-11-17 17:31:55 +01002039 if (!cpuhp_tasks_frozen) {
Sergey Senozhatsky64ca7522017-01-21 19:47:29 +09002040 /* If trylock fails, someone else is doing the printing */
2041 if (console_trylock())
2042 console_unlock();
Kevin Cernekee034260d2010-06-03 22:11:25 -07002043 }
Sebastian Andrzej Siewior90b14882016-11-03 15:49:58 +01002044 return 0;
Kevin Cernekee034260d2010-06-03 22:11:25 -07002045}
2046
2047/**
Torben Hohnac751ef2011-01-25 15:07:35 -08002048 * console_lock - lock the console system for exclusive use.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049 *
Torben Hohnac751ef2011-01-25 15:07:35 -08002050 * Acquires a lock which guarantees that the caller has
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 * exclusive access to the console system and the console_drivers list.
2052 *
2053 * Can sleep, returns nothing.
2054 */
Torben Hohnac751ef2011-01-25 15:07:35 -08002055void console_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056{
Daniel Vetter6b898c02012-09-17 23:03:31 +00002057 might_sleep();
2058
Jan Karabd8d7cf2014-06-04 16:11:36 -07002059 down_console_sem();
Arve Hjønnevåg403f3072009-02-14 02:07:24 +01002060 if (console_suspended)
2061 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062 console_locked = 1;
2063 console_may_schedule = 1;
2064}
Torben Hohnac751ef2011-01-25 15:07:35 -08002065EXPORT_SYMBOL(console_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066
Torben Hohnac751ef2011-01-25 15:07:35 -08002067/**
2068 * console_trylock - try to lock the console system for exclusive use.
2069 *
Alex Elder0b90fec2014-08-06 16:09:03 -07002070 * Try to acquire a lock which guarantees that the caller has exclusive
2071 * access to the console system and the console_drivers list.
Torben Hohnac751ef2011-01-25 15:07:35 -08002072 *
2073 * returns 1 on success, and 0 on failure to acquire the lock.
2074 */
2075int console_trylock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076{
Jan Karabd8d7cf2014-06-04 16:11:36 -07002077 if (down_trylock_console_sem())
Torben Hohnac751ef2011-01-25 15:07:35 -08002078 return 0;
Arve Hjønnevåg403f3072009-02-14 02:07:24 +01002079 if (console_suspended) {
Jan Karabd8d7cf2014-06-04 16:11:36 -07002080 up_console_sem();
Torben Hohnac751ef2011-01-25 15:07:35 -08002081 return 0;
Arve Hjønnevåg403f3072009-02-14 02:07:24 +01002082 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 console_locked = 1;
Sergey Senozhatsky6b97a202016-03-17 14:21:23 -07002084 /*
2085 * When PREEMPT_COUNT disabled we can't reliably detect if it's
2086 * safe to schedule (e.g. calling printk while holding a spin_lock),
2087 * because preempt_disable()/preempt_enable() are just barriers there
2088 * and preempt_count() is always 0.
2089 *
2090 * RCU read sections have a separate preemption counter when
2091 * PREEMPT_RCU enabled thus we must take extra care and check
2092 * rcu_preempt_depth(), otherwise RCU read sections modify
2093 * preempt_count().
2094 */
2095 console_may_schedule = !oops_in_progress &&
2096 preemptible() &&
2097 !rcu_preempt_depth();
Torben Hohnac751ef2011-01-25 15:07:35 -08002098 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099}
Torben Hohnac751ef2011-01-25 15:07:35 -08002100EXPORT_SYMBOL(console_trylock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101
2102int is_console_locked(void)
2103{
2104 return console_locked;
2105}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106
Sergey Senozhatskya8199372016-03-17 14:21:20 -07002107/*
2108 * Check if we have any console that is capable of printing while cpu is
2109 * booting or shutting down. Requires console_sem.
2110 */
2111static int have_callable_console(void)
2112{
2113 struct console *con;
2114
2115 for_each_console(con)
Sergey Senozhatskyadaf6592016-03-17 14:21:27 -07002116 if ((con->flags & CON_ENABLED) &&
2117 (con->flags & CON_ANYTIME))
Sergey Senozhatskya8199372016-03-17 14:21:20 -07002118 return 1;
2119
2120 return 0;
2121}
2122
2123/*
2124 * Can we actually use the console at this time on this cpu?
2125 *
2126 * Console drivers may assume that per-cpu resources have been allocated. So
2127 * unless they're explicitly marked as being able to cope (CON_ANYTIME) don't
2128 * call them until this CPU is officially up.
2129 */
2130static inline int can_use_console(void)
2131{
2132 return cpu_online(raw_smp_processor_id()) || have_callable_console();
2133}
2134
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135/**
Torben Hohnac751ef2011-01-25 15:07:35 -08002136 * console_unlock - unlock the console system
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 *
Torben Hohnac751ef2011-01-25 15:07:35 -08002138 * Releases the console_lock which the caller holds on the console system
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 * and the console driver list.
2140 *
Torben Hohnac751ef2011-01-25 15:07:35 -08002141 * While the console_lock was held, console output may have been buffered
2142 * by printk(). If this is the case, console_unlock(); emits
2143 * the output prior to releasing the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 *
Kay Sievers7f3a7812012-05-09 01:37:51 +02002145 * If there is output waiting, we wake /dev/kmsg and syslog() users.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 *
Torben Hohnac751ef2011-01-25 15:07:35 -08002147 * console_unlock(); may be called from any context.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148 */
Torben Hohnac751ef2011-01-25 15:07:35 -08002149void console_unlock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150{
Tejun Heo6fe29352015-06-25 15:01:30 -07002151 static char ext_text[CONSOLE_EXT_LOG_MAX];
Kay Sievers70498252012-07-16 18:35:29 -07002152 static char text[LOG_LINE_MAX + PREFIX_MAX];
Kay Sievers7ff95542012-05-03 02:29:13 +02002153 static u64 seen_seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 unsigned long flags;
Kay Sievers7ff95542012-05-03 02:29:13 +02002155 bool wake_klogd = false;
Tejun Heo8d91f8b2016-01-15 16:58:24 -08002156 bool do_cond_resched, retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157
Linus Torvalds557240b2006-06-19 18:16:01 -07002158 if (console_suspended) {
Jan Karabd8d7cf2014-06-04 16:11:36 -07002159 up_console_sem();
Linus Torvalds557240b2006-06-19 18:16:01 -07002160 return;
2161 }
Antonino A. Daplas78944e542006-08-05 12:14:16 -07002162
Tejun Heo8d91f8b2016-01-15 16:58:24 -08002163 /*
Petr Mladek257ab442017-03-24 17:14:05 +01002164 * Console drivers are called with interrupts disabled, so
Tejun Heo8d91f8b2016-01-15 16:58:24 -08002165 * @console_may_schedule should be cleared before; however, we may
2166 * end up dumping a lot of lines, for example, if called from
2167 * console registration path, and should invoke cond_resched()
2168 * between lines if allowable. Not doing so can cause a very long
2169 * scheduling stall on a slow console leading to RCU stall and
2170 * softlockup warnings which exacerbate the issue with more
2171 * messages practically incapacitating the system.
Petr Mladek257ab442017-03-24 17:14:05 +01002172 *
2173 * console_trylock() is not able to detect the preemptive
2174 * context reliably. Therefore the value must be stored before
2175 * and cleared after the the "again" goto label.
Tejun Heo8d91f8b2016-01-15 16:58:24 -08002176 */
2177 do_cond_resched = console_may_schedule;
Petr Mladek257ab442017-03-24 17:14:05 +01002178again:
Antonino A. Daplas78944e542006-08-05 12:14:16 -07002179 console_may_schedule = 0;
2180
Sergey Senozhatskya8199372016-03-17 14:21:20 -07002181 /*
2182 * We released the console_sem lock, so we need to recheck if
2183 * cpu is online and (if not) is there at least one CON_ANYTIME
2184 * console.
2185 */
2186 if (!can_use_console()) {
2187 console_locked = 0;
2188 up_console_sem();
2189 return;
2190 }
2191
Kay Sievers7ff95542012-05-03 02:29:13 +02002192 for (;;) {
Joe Perches62e32ac2013-07-31 13:53:47 -07002193 struct printk_log *msg;
Tejun Heo6fe29352015-06-25 15:01:30 -07002194 size_t ext_len = 0;
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02002195 size_t len;
Kay Sievers7ff95542012-05-03 02:29:13 +02002196
Sergey Senozhatskyf9752372016-12-27 23:16:09 +09002197 printk_safe_enter_irqsave(flags);
2198 raw_spin_lock(&logbuf_lock);
Kay Sievers7ff95542012-05-03 02:29:13 +02002199 if (seen_seq != log_next_seq) {
2200 wake_klogd = true;
2201 seen_seq = log_next_seq;
2202 }
2203
2204 if (console_seq < log_first_seq) {
Will Deacon84b5ec82014-06-04 16:11:45 -07002205 len = sprintf(text, "** %u printk messages dropped ** ",
2206 (unsigned)(log_first_seq - console_seq));
2207
Kay Sievers7ff95542012-05-03 02:29:13 +02002208 /* messages are gone, move to first one */
2209 console_seq = log_first_seq;
2210 console_idx = log_first_idx;
Will Deacon84b5ec82014-06-04 16:11:45 -07002211 } else {
2212 len = 0;
Kay Sievers7ff95542012-05-03 02:29:13 +02002213 }
Kay Sievers084681d2012-06-28 09:38:53 +02002214skip:
Kay Sievers7ff95542012-05-03 02:29:13 +02002215 if (console_seq == log_next_seq)
2216 break;
2217
2218 msg = log_from_idx(console_idx);
Sergey Senozhatskyd9c23522016-12-24 23:09:01 +09002219 if (suppress_message_printing(msg->level)) {
Kay Sievers084681d2012-06-28 09:38:53 +02002220 /*
2221 * Skip record we have buffered and already printed
Sergey Senozhatskycf775442016-08-02 14:03:56 -07002222 * directly to the console when we received it, and
2223 * record that has level above the console loglevel.
Kay Sievers084681d2012-06-28 09:38:53 +02002224 */
2225 console_idx = log_next(console_idx);
2226 console_seq++;
2227 goto skip;
2228 }
Kay Sievers649e6ee2012-05-10 04:30:45 +02002229
Linus Torvalds5aa068e2016-10-25 11:27:31 -07002230 len += msg_print_text(msg, false, text + len, sizeof(text) - len);
Tejun Heo6fe29352015-06-25 15:01:30 -07002231 if (nr_ext_console_drivers) {
2232 ext_len = msg_print_ext_header(ext_text,
2233 sizeof(ext_text),
Linus Torvalds5aa068e2016-10-25 11:27:31 -07002234 msg, console_seq);
Tejun Heo6fe29352015-06-25 15:01:30 -07002235 ext_len += msg_print_ext_body(ext_text + ext_len,
2236 sizeof(ext_text) - ext_len,
2237 log_dict(msg), msg->dict_len,
2238 log_text(msg), msg->text_len);
2239 }
Kay Sievers7ff95542012-05-03 02:29:13 +02002240 console_idx = log_next(console_idx);
2241 console_seq++;
Thomas Gleixner07354eb2009-07-25 17:50:36 +02002242 raw_spin_unlock(&logbuf_lock);
Kay Sievers7ff95542012-05-03 02:29:13 +02002243
Steven Rostedt81d68a92008-05-12 21:20:42 +02002244 stop_critical_timings(); /* don't trace print latency */
Sergey Senozhatskyd9c23522016-12-24 23:09:01 +09002245 call_console_drivers(ext_text, ext_len, text, len);
Steven Rostedt81d68a92008-05-12 21:20:42 +02002246 start_critical_timings();
Sergey Senozhatskyf9752372016-12-27 23:16:09 +09002247 printk_safe_exit_irqrestore(flags);
Tejun Heo8d91f8b2016-01-15 16:58:24 -08002248
2249 if (do_cond_resched)
2250 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251 }
2252 console_locked = 0;
Feng Tangfe3d8ad2011-03-22 16:34:21 -07002253
2254 /* Release the exclusive_console once it is used */
2255 if (unlikely(exclusive_console))
2256 exclusive_console = NULL;
2257
Thomas Gleixner07354eb2009-07-25 17:50:36 +02002258 raw_spin_unlock(&logbuf_lock);
Peter Zijlstra4f2a8d32011-06-22 11:20:09 +02002259
Jan Karabd8d7cf2014-06-04 16:11:36 -07002260 up_console_sem();
Peter Zijlstra4f2a8d32011-06-22 11:20:09 +02002261
2262 /*
2263 * Someone could have filled up the buffer again, so re-check if there's
2264 * something to flush. In case we cannot trylock the console_sem again,
2265 * there's a new owner and the console_unlock() from them will do the
2266 * flush, no worries.
2267 */
Thomas Gleixner07354eb2009-07-25 17:50:36 +02002268 raw_spin_lock(&logbuf_lock);
Kay Sievers7ff95542012-05-03 02:29:13 +02002269 retry = console_seq != log_next_seq;
Sergey Senozhatskyf9752372016-12-27 23:16:09 +09002270 raw_spin_unlock(&logbuf_lock);
2271 printk_safe_exit_irqrestore(flags);
Peter Zijlstra09dc3cf2011-12-08 14:34:13 -08002272
Peter Zijlstra4f2a8d32011-06-22 11:20:09 +02002273 if (retry && console_trylock())
2274 goto again;
2275
Kirill Korotaeve3e8a752007-02-10 01:46:19 -08002276 if (wake_klogd)
2277 wake_up_klogd();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278}
Torben Hohnac751ef2011-01-25 15:07:35 -08002279EXPORT_SYMBOL(console_unlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280
Martin Waitzddad86c2005-11-13 16:08:14 -08002281/**
2282 * console_conditional_schedule - yield the CPU if required
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283 *
2284 * If the console code is currently allowed to sleep, and
2285 * if this CPU should yield the CPU to another task, do
2286 * so here.
2287 *
Torben Hohnac751ef2011-01-25 15:07:35 -08002288 * Must be called within console_lock();.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 */
2290void __sched console_conditional_schedule(void)
2291{
2292 if (console_may_schedule)
2293 cond_resched();
2294}
2295EXPORT_SYMBOL(console_conditional_schedule);
2296
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297void console_unblank(void)
2298{
2299 struct console *c;
2300
2301 /*
2302 * console_unblank can no longer be called in interrupt context unless
2303 * oops_in_progress is set to 1..
2304 */
2305 if (oops_in_progress) {
Jan Karabd8d7cf2014-06-04 16:11:36 -07002306 if (down_trylock_console_sem() != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 return;
2308 } else
Torben Hohnac751ef2011-01-25 15:07:35 -08002309 console_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310
2311 console_locked = 1;
2312 console_may_schedule = 0;
Robin Getz4d091612009-07-01 21:08:37 -04002313 for_each_console(c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 if ((c->flags & CON_ENABLED) && c->unblank)
2315 c->unblank();
Torben Hohnac751ef2011-01-25 15:07:35 -08002316 console_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318
Tejun Heo8d91f8b2016-01-15 16:58:24 -08002319/**
2320 * console_flush_on_panic - flush console content on panic
2321 *
2322 * Immediately output all pending messages no matter what.
2323 */
2324void console_flush_on_panic(void)
2325{
2326 /*
2327 * If someone else is holding the console lock, trylock will fail
2328 * and may_schedule may be set. Ignore and proceed to unlock so
2329 * that messages are flushed out. As this can be called from any
2330 * context and we don't want to get preempted while flushing,
2331 * ensure may_schedule is cleared.
2332 */
2333 console_trylock();
2334 console_may_schedule = 0;
2335 console_unlock();
2336}
2337
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338/*
2339 * Return the console tty driver structure and its associated index
2340 */
2341struct tty_driver *console_device(int *index)
2342{
2343 struct console *c;
2344 struct tty_driver *driver = NULL;
2345
Torben Hohnac751ef2011-01-25 15:07:35 -08002346 console_lock();
Robin Getz4d091612009-07-01 21:08:37 -04002347 for_each_console(c) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002348 if (!c->device)
2349 continue;
2350 driver = c->device(c, index);
2351 if (driver)
2352 break;
2353 }
Torben Hohnac751ef2011-01-25 15:07:35 -08002354 console_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355 return driver;
2356}
2357
2358/*
2359 * Prevent further output on the passed console device so that (for example)
2360 * serial drivers can disable console output before suspending a port, and can
2361 * re-enable output afterwards.
2362 */
2363void console_stop(struct console *console)
2364{
Torben Hohnac751ef2011-01-25 15:07:35 -08002365 console_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366 console->flags &= ~CON_ENABLED;
Torben Hohnac751ef2011-01-25 15:07:35 -08002367 console_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368}
2369EXPORT_SYMBOL(console_stop);
2370
2371void console_start(struct console *console)
2372{
Torben Hohnac751ef2011-01-25 15:07:35 -08002373 console_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 console->flags |= CON_ENABLED;
Torben Hohnac751ef2011-01-25 15:07:35 -08002375 console_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376}
2377EXPORT_SYMBOL(console_start);
2378
Fabio M. Di Nitto7bf69392011-03-22 16:34:20 -07002379static int __read_mostly keep_bootcon;
2380
2381static int __init keep_bootcon_setup(char *str)
2382{
2383 keep_bootcon = 1;
Andrew Morton27083ba2013-11-12 15:08:50 -08002384 pr_info("debug: skip boot console de-registration.\n");
Fabio M. Di Nitto7bf69392011-03-22 16:34:20 -07002385
2386 return 0;
2387}
2388
2389early_param("keep_bootcon", keep_bootcon_setup);
2390
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391/*
2392 * The console driver calls this routine during kernel initialization
2393 * to register the console printing procedure with printk() and to
2394 * print any messages that were printed by the kernel before the
2395 * console driver was initialized.
Robin Getz4d091612009-07-01 21:08:37 -04002396 *
2397 * This can happen pretty early during the boot process (because of
2398 * early_printk) - sometimes before setup_arch() completes - be careful
2399 * of what kernel features are used - they may not be initialised yet.
2400 *
2401 * There are two types of consoles - bootconsoles (early_printk) and
2402 * "real" consoles (everything which is not a bootconsole) which are
2403 * handled differently.
2404 * - Any number of bootconsoles can be registered at any time.
2405 * - As soon as a "real" console is registered, all bootconsoles
2406 * will be unregistered automatically.
2407 * - Once a "real" console is registered, any attempt to register a
2408 * bootconsoles will be rejected
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 */
Robin Getz4d091612009-07-01 21:08:37 -04002410void register_console(struct console *newcon)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411{
Jesper Juhl40dc5652005-10-30 15:02:46 -08002412 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 unsigned long flags;
Robin Getz4d091612009-07-01 21:08:37 -04002414 struct console *bcon = NULL;
Joe Perches23475402013-07-31 13:53:46 -07002415 struct console_cmdline *c;
Aleksey Makarovb077baf2017-03-15 13:28:50 +03002416 static bool has_preferred;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417
Andreas Bießmann16cf48a2013-08-02 12:23:34 +02002418 if (console_drivers)
2419 for_each_console(bcon)
2420 if (WARN(bcon == newcon,
2421 "console '%s%d' already registered\n",
2422 bcon->name, bcon->index))
2423 return;
2424
Robin Getz4d091612009-07-01 21:08:37 -04002425 /*
2426 * before we register a new CON_BOOT console, make sure we don't
2427 * already have a valid console
2428 */
2429 if (console_drivers && newcon->flags & CON_BOOT) {
2430 /* find the last or real console */
2431 for_each_console(bcon) {
2432 if (!(bcon->flags & CON_BOOT)) {
Andrew Morton27083ba2013-11-12 15:08:50 -08002433 pr_info("Too late to register bootconsole %s%d\n",
Robin Getz4d091612009-07-01 21:08:37 -04002434 newcon->name, newcon->index);
2435 return;
2436 }
2437 }
Gerd Hoffmann69331af2007-05-08 00:26:49 -07002438 }
2439
Robin Getz4d091612009-07-01 21:08:37 -04002440 if (console_drivers && console_drivers->flags & CON_BOOT)
2441 bcon = console_drivers;
2442
Aleksey Makarovb077baf2017-03-15 13:28:50 +03002443 if (!has_preferred || bcon || !console_drivers)
Aleksey Makarovad86ee22017-03-15 13:28:51 +03002444 has_preferred = preferred_console >= 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445
2446 /*
2447 * See if we want to use this console driver. If we
2448 * didn't select a console we take the first one
2449 * that registers here.
2450 */
Aleksey Makarovb077baf2017-03-15 13:28:50 +03002451 if (!has_preferred) {
Robin Getz4d091612009-07-01 21:08:37 -04002452 if (newcon->index < 0)
2453 newcon->index = 0;
2454 if (newcon->setup == NULL ||
2455 newcon->setup(newcon, NULL) == 0) {
2456 newcon->flags |= CON_ENABLED;
2457 if (newcon->device) {
2458 newcon->flags |= CON_CONSDEV;
Aleksey Makarovb077baf2017-03-15 13:28:50 +03002459 has_preferred = true;
Jan Kiszkacd3a1b82008-05-12 21:21:04 +02002460 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461 }
2462 }
2463
2464 /*
Petr Mladekdac8bbb2017-06-08 12:01:30 +02002465 * See if this console matches one we selected on
2466 * the command line.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467 */
Petr Mladekdac8bbb2017-06-08 12:01:30 +02002468 for (i = 0, c = console_cmdline;
2469 i < MAX_CMDLINECONSOLES && c->name[0];
2470 i++, c++) {
Peter Hurleyc7cef0a2015-03-09 16:27:12 -04002471 if (!newcon->match ||
2472 newcon->match(newcon, c->name, c->index, c->options) != 0) {
2473 /* default matching */
2474 BUILD_BUG_ON(sizeof(c->name) != sizeof(newcon->name));
2475 if (strcmp(c->name, newcon->name) != 0)
2476 continue;
2477 if (newcon->index >= 0 &&
2478 newcon->index != c->index)
2479 continue;
2480 if (newcon->index < 0)
2481 newcon->index = c->index;
Joe Perchesbbeddf52013-07-31 13:53:45 -07002482
Peter Hurleyc7cef0a2015-03-09 16:27:12 -04002483 if (_braille_register_console(newcon, c))
2484 return;
Joe Perchesbbeddf52013-07-31 13:53:45 -07002485
Peter Hurleyc7cef0a2015-03-09 16:27:12 -04002486 if (newcon->setup &&
2487 newcon->setup(newcon, c->options) != 0)
2488 break;
2489 }
2490
Robin Getz4d091612009-07-01 21:08:37 -04002491 newcon->flags |= CON_ENABLED;
Aleksey Makarovad86ee22017-03-15 13:28:51 +03002492 if (i == preferred_console) {
Robin Getz4d091612009-07-01 21:08:37 -04002493 newcon->flags |= CON_CONSDEV;
Aleksey Makarovb077baf2017-03-15 13:28:50 +03002494 has_preferred = true;
Greg Edwardsab4af032005-06-23 00:09:05 -07002495 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496 break;
2497 }
2498
Robin Getz4d091612009-07-01 21:08:37 -04002499 if (!(newcon->flags & CON_ENABLED))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002500 return;
2501
Robin Getz8259cf42009-07-09 13:08:37 -04002502 /*
2503 * If we have a bootconsole, and are switching to a real console,
2504 * don't print everything out again, since when the boot console, and
2505 * the real console are the same physical device, it's annoying to
2506 * see the beginning boot messages twice
2507 */
2508 if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
Robin Getz4d091612009-07-01 21:08:37 -04002509 newcon->flags &= ~CON_PRINTBUFFER;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510
2511 /*
2512 * Put this console in the list - keep the
2513 * preferred driver at the head of the list.
2514 */
Torben Hohnac751ef2011-01-25 15:07:35 -08002515 console_lock();
Robin Getz4d091612009-07-01 21:08:37 -04002516 if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
2517 newcon->next = console_drivers;
2518 console_drivers = newcon;
2519 if (newcon->next)
2520 newcon->next->flags &= ~CON_CONSDEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521 } else {
Robin Getz4d091612009-07-01 21:08:37 -04002522 newcon->next = console_drivers->next;
2523 console_drivers->next = newcon;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002524 }
Tejun Heo6fe29352015-06-25 15:01:30 -07002525
2526 if (newcon->flags & CON_EXTENDED)
2527 if (!nr_ext_console_drivers++)
2528 pr_info("printk: continuation disabled due to ext consoles, expect more fragments in /dev/kmsg\n");
2529
Robin Getz4d091612009-07-01 21:08:37 -04002530 if (newcon->flags & CON_PRINTBUFFER) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531 /*
Torben Hohnac751ef2011-01-25 15:07:35 -08002532 * console_unlock(); will print out the buffered messages
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 * for us.
2534 */
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09002535 logbuf_lock_irqsave(flags);
Kay Sievers7ff95542012-05-03 02:29:13 +02002536 console_seq = syslog_seq;
2537 console_idx = syslog_idx;
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09002538 logbuf_unlock_irqrestore(flags);
Feng Tangfe3d8ad2011-03-22 16:34:21 -07002539 /*
2540 * We're about to replay the log buffer. Only do this to the
2541 * just-registered console to avoid excessive message spam to
2542 * the already-registered consoles.
2543 */
2544 exclusive_console = newcon;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545 }
Torben Hohnac751ef2011-01-25 15:07:35 -08002546 console_unlock();
Kay Sieversfbc92a32010-12-01 18:51:05 +01002547 console_sysfs_notify();
Robin Getz8259cf42009-07-09 13:08:37 -04002548
2549 /*
2550 * By unregistering the bootconsoles after we enable the real console
2551 * we get the "console xxx enabled" message on all the consoles -
2552 * boot consoles, real consoles, etc - this is to ensure that end
2553 * users know there might be something in the kernel's log buffer that
2554 * went to the bootconsole (that they do not see on the real console)
2555 */
Andrew Morton27083ba2013-11-12 15:08:50 -08002556 pr_info("%sconsole [%s%d] enabled\n",
Kees Cook6b802392013-11-12 15:08:49 -08002557 (newcon->flags & CON_BOOT) ? "boot" : "" ,
2558 newcon->name, newcon->index);
Fabio M. Di Nitto7bf69392011-03-22 16:34:20 -07002559 if (bcon &&
2560 ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
2561 !keep_bootcon) {
Kees Cook6b802392013-11-12 15:08:49 -08002562 /* We need to iterate through all boot consoles, to make
2563 * sure we print everything out, before we unregister them.
Robin Getz8259cf42009-07-09 13:08:37 -04002564 */
Robin Getz8259cf42009-07-09 13:08:37 -04002565 for_each_console(bcon)
2566 if (bcon->flags & CON_BOOT)
2567 unregister_console(bcon);
Robin Getz8259cf42009-07-09 13:08:37 -04002568 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569}
2570EXPORT_SYMBOL(register_console);
2571
Jesper Juhl40dc5652005-10-30 15:02:46 -08002572int unregister_console(struct console *console)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573{
Jesper Juhl40dc5652005-10-30 15:02:46 -08002574 struct console *a, *b;
Joe Perchesbbeddf52013-07-31 13:53:45 -07002575 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576
Andrew Morton27083ba2013-11-12 15:08:50 -08002577 pr_info("%sconsole [%s%d] disabled\n",
Kees Cook6b802392013-11-12 15:08:49 -08002578 (console->flags & CON_BOOT) ? "boot" : "" ,
2579 console->name, console->index);
2580
Joe Perchesbbeddf52013-07-31 13:53:45 -07002581 res = _braille_unregister_console(console);
2582 if (res)
2583 return res;
Samuel Thibaultf7511d52008-04-30 00:54:51 -07002584
Joe Perchesbbeddf52013-07-31 13:53:45 -07002585 res = 1;
Torben Hohnac751ef2011-01-25 15:07:35 -08002586 console_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002587 if (console_drivers == console) {
2588 console_drivers=console->next;
2589 res = 0;
Benjamin Herrenschmidte9b15b52005-11-23 13:37:44 -08002590 } else if (console_drivers) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591 for (a=console_drivers->next, b=console_drivers ;
2592 a; b=a, a=b->next) {
2593 if (a == console) {
2594 b->next = a->next;
2595 res = 0;
2596 break;
Jesper Juhl40dc5652005-10-30 15:02:46 -08002597 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598 }
2599 }
Jesper Juhl40dc5652005-10-30 15:02:46 -08002600
Tejun Heo6fe29352015-06-25 15:01:30 -07002601 if (!res && (console->flags & CON_EXTENDED))
2602 nr_ext_console_drivers--;
2603
Gerd Hoffmann69331af2007-05-08 00:26:49 -07002604 /*
Greg Edwardsab4af032005-06-23 00:09:05 -07002605 * If this isn't the last console and it has CON_CONSDEV set, we
2606 * need to set it on the next preferred console.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607 */
Gerd Hoffmann69331af2007-05-08 00:26:49 -07002608 if (console_drivers != NULL && console->flags & CON_CONSDEV)
Greg Edwardsab4af032005-06-23 00:09:05 -07002609 console_drivers->flags |= CON_CONSDEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002610
Stephen Chivers7fa21dd2014-05-14 08:04:39 +10002611 console->flags &= ~CON_ENABLED;
Torben Hohnac751ef2011-01-25 15:07:35 -08002612 console_unlock();
Kay Sieversfbc92a32010-12-01 18:51:05 +01002613 console_sysfs_notify();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002614 return res;
2615}
2616EXPORT_SYMBOL(unregister_console);
Matt Mackalld59745c2005-05-01 08:59:02 -07002617
Thierry Reding81cc26f2016-01-15 16:58:21 -08002618/*
Nicolas Pitre0c688612017-04-12 18:37:14 -04002619 * Initialize the console device. This is called *early*, so
2620 * we can't necessarily depend on lots of kernel help here.
2621 * Just do some early initializations, and do the complex setup
2622 * later.
2623 */
2624void __init console_init(void)
2625{
2626 initcall_t *call;
2627
2628 /* Setup the default TTY line discipline. */
2629 n_tty_init();
2630
2631 /*
2632 * set up the console device so that later boot sequences can
2633 * inform about problems etc..
2634 */
2635 call = __con_initcall_start;
2636 while (call < __con_initcall_end) {
2637 (*call)();
2638 call++;
2639 }
2640}
2641
2642/*
Thierry Reding81cc26f2016-01-15 16:58:21 -08002643 * Some boot consoles access data that is in the init section and which will
2644 * be discarded after the initcalls have been run. To make sure that no code
2645 * will access this data, unregister the boot consoles in a late initcall.
2646 *
2647 * If for some reason, such as deferred probe or the driver being a loadable
2648 * module, the real console hasn't registered yet at this point, there will
2649 * be a brief interval in which no messages are logged to the console, which
2650 * makes it difficult to diagnose problems that occur during this time.
2651 *
2652 * To mitigate this problem somewhat, only unregister consoles whose memory
Matt Redfearn2b1be682017-07-14 14:51:12 +02002653 * intersects with the init section. Note that all other boot consoles will
2654 * get unregistred when the real preferred console is registered.
Thierry Reding81cc26f2016-01-15 16:58:21 -08002655 */
Kevin Cernekee034260d2010-06-03 22:11:25 -07002656static int __init printk_late_init(void)
Robin Getz0c5564b2007-08-20 15:22:47 -04002657{
Robin Getz4d091612009-07-01 21:08:37 -04002658 struct console *con;
Sebastian Andrzej Siewior90b14882016-11-03 15:49:58 +01002659 int ret;
Robin Getz4d091612009-07-01 21:08:37 -04002660
2661 for_each_console(con) {
Petr Mladek5a814232017-07-14 14:51:13 +02002662 if (!(con->flags & CON_BOOT))
2663 continue;
2664
2665 /* Check addresses that might be used for enabled consoles. */
2666 if (init_section_intersects(con, sizeof(*con)) ||
2667 init_section_contains(con->write, 0) ||
2668 init_section_contains(con->read, 0) ||
2669 init_section_contains(con->device, 0) ||
2670 init_section_contains(con->unblank, 0) ||
2671 init_section_contains(con->data, 0)) {
Thierry Reding81cc26f2016-01-15 16:58:21 -08002672 /*
Matt Redfearn2b1be682017-07-14 14:51:12 +02002673 * Please, consider moving the reported consoles out
2674 * of the init section.
Thierry Reding81cc26f2016-01-15 16:58:21 -08002675 */
Matt Redfearn2b1be682017-07-14 14:51:12 +02002676 pr_warn("bootconsole [%s%d] uses init memory and must be disabled even before the real one is ready\n",
2677 con->name, con->index);
2678 unregister_console(con);
Robin Getzcb00e992007-08-21 23:14:58 -04002679 }
Robin Getz0c5564b2007-08-20 15:22:47 -04002680 }
Sebastian Andrzej Siewior90b14882016-11-03 15:49:58 +01002681 ret = cpuhp_setup_state_nocalls(CPUHP_PRINTK_DEAD, "printk:dead", NULL,
2682 console_cpu_notify);
2683 WARN_ON(ret < 0);
2684 ret = cpuhp_setup_state_nocalls(CPUHP_AP_ONLINE_DYN, "printk:online",
2685 console_cpu_notify, NULL);
2686 WARN_ON(ret < 0);
Robin Getz0c5564b2007-08-20 15:22:47 -04002687 return 0;
2688}
Kevin Cernekee034260d2010-06-03 22:11:25 -07002689late_initcall(printk_late_init);
Robin Getz0c5564b2007-08-20 15:22:47 -04002690
Joe Perches7ef3d2f2008-02-08 04:21:25 -08002691#if defined CONFIG_PRINTK
Frederic Weisbeckerdc72c322013-03-22 15:04:39 -07002692/*
2693 * Delayed printk version, for scheduler-internal messages:
2694 */
Frederic Weisbeckerdc72c322013-03-22 15:04:39 -07002695#define PRINTK_PENDING_WAKEUP 0x01
Steven Rostedt458df9f2014-06-04 16:11:38 -07002696#define PRINTK_PENDING_OUTPUT 0x02
Frederic Weisbeckerdc72c322013-03-22 15:04:39 -07002697
2698static DEFINE_PER_CPU(int, printk_pending);
Frederic Weisbeckerdc72c322013-03-22 15:04:39 -07002699
2700static void wake_up_klogd_work_func(struct irq_work *irq_work)
2701{
2702 int pending = __this_cpu_xchg(printk_pending, 0);
2703
Steven Rostedt458df9f2014-06-04 16:11:38 -07002704 if (pending & PRINTK_PENDING_OUTPUT) {
2705 /* If trylock fails, someone else is doing the printing */
2706 if (console_trylock())
2707 console_unlock();
Frederic Weisbeckerdc72c322013-03-22 15:04:39 -07002708 }
2709
2710 if (pending & PRINTK_PENDING_WAKEUP)
2711 wake_up_interruptible(&log_wait);
2712}
2713
2714static DEFINE_PER_CPU(struct irq_work, wake_up_klogd_work) = {
2715 .func = wake_up_klogd_work_func,
2716 .flags = IRQ_WORK_LAZY,
2717};
2718
2719void wake_up_klogd(void)
2720{
2721 preempt_disable();
2722 if (waitqueue_active(&log_wait)) {
2723 this_cpu_or(printk_pending, PRINTK_PENDING_WAKEUP);
Christoph Lameterbb964a92014-08-17 12:30:24 -05002724 irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
Frederic Weisbeckerdc72c322013-03-22 15:04:39 -07002725 }
2726 preempt_enable();
2727}
Dave Young717115e2008-07-25 01:45:58 -07002728
Petr Mladek719f6a72017-04-20 10:52:31 +02002729int vprintk_deferred(const char *fmt, va_list args)
2730{
2731 int r;
2732
2733 r = vprintk_emit(0, LOGLEVEL_SCHED, NULL, 0, fmt, args);
2734
2735 preempt_disable();
2736 __this_cpu_or(printk_pending, PRINTK_PENDING_OUTPUT);
2737 irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2738 preempt_enable();
2739
2740 return r;
2741}
2742
John Stultzaac74dc2014-06-04 16:11:40 -07002743int printk_deferred(const char *fmt, ...)
Peter Zijlstra600e1452012-03-15 12:35:37 +01002744{
Peter Zijlstra600e1452012-03-15 12:35:37 +01002745 va_list args;
Peter Zijlstra600e1452012-03-15 12:35:37 +01002746 int r;
2747
Peter Zijlstra600e1452012-03-15 12:35:37 +01002748 va_start(args, fmt);
Petr Mladek719f6a72017-04-20 10:52:31 +02002749 r = vprintk_deferred(fmt, args);
Peter Zijlstra600e1452012-03-15 12:35:37 +01002750 va_end(args);
2751
Peter Zijlstra600e1452012-03-15 12:35:37 +01002752 return r;
2753}
2754
Linus Torvalds1da177e2005-04-16 15:20:36 -07002755/*
2756 * printk rate limiting, lifted from the networking subsystem.
2757 *
Uwe Kleine-König641de9d2008-07-29 22:33:38 -07002758 * This enforces a rate limit: not more than 10 kernel messages
2759 * every 5s to make a denial-of-service attack impossible.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002760 */
Uwe Kleine-König641de9d2008-07-29 22:33:38 -07002761DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
2762
Christian Borntraeger5c828712009-10-23 14:58:11 +02002763int __printk_ratelimit(const char *func)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764{
Christian Borntraeger5c828712009-10-23 14:58:11 +02002765 return ___ratelimit(&printk_ratelimit_state, func);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766}
Christian Borntraeger5c828712009-10-23 14:58:11 +02002767EXPORT_SYMBOL(__printk_ratelimit);
Andrew Mortonf46c4832006-11-02 22:07:16 -08002768
2769/**
2770 * printk_timed_ratelimit - caller-controlled printk ratelimiting
2771 * @caller_jiffies: pointer to caller's state
2772 * @interval_msecs: minimum interval between prints
2773 *
2774 * printk_timed_ratelimit() returns true if more than @interval_msecs
2775 * milliseconds have elapsed since the last time printk_timed_ratelimit()
2776 * returned true.
2777 */
2778bool printk_timed_ratelimit(unsigned long *caller_jiffies,
2779 unsigned int interval_msecs)
2780{
Alex Elder249771b2014-08-06 16:09:08 -07002781 unsigned long elapsed = jiffies - *caller_jiffies;
2782
2783 if (*caller_jiffies && elapsed <= msecs_to_jiffies(interval_msecs))
2784 return false;
2785
2786 *caller_jiffies = jiffies;
2787 return true;
Andrew Mortonf46c4832006-11-02 22:07:16 -08002788}
2789EXPORT_SYMBOL(printk_timed_ratelimit);
Simon Kagstrom456b5652009-10-16 14:09:18 +02002790
2791static DEFINE_SPINLOCK(dump_list_lock);
2792static LIST_HEAD(dump_list);
2793
2794/**
2795 * kmsg_dump_register - register a kernel log dumper.
Randy Dunlap64855362009-12-17 15:27:27 -08002796 * @dumper: pointer to the kmsg_dumper structure
Simon Kagstrom456b5652009-10-16 14:09:18 +02002797 *
2798 * Adds a kernel log dumper to the system. The dump callback in the
2799 * structure will be called when the kernel oopses or panics and must be
2800 * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
2801 */
2802int kmsg_dump_register(struct kmsg_dumper *dumper)
2803{
2804 unsigned long flags;
2805 int err = -EBUSY;
2806
2807 /* The dump callback needs to be set */
2808 if (!dumper->dump)
2809 return -EINVAL;
2810
2811 spin_lock_irqsave(&dump_list_lock, flags);
2812 /* Don't allow registering multiple times */
2813 if (!dumper->registered) {
2814 dumper->registered = 1;
Huang Yingfb842b002011-01-12 16:59:43 -08002815 list_add_tail_rcu(&dumper->list, &dump_list);
Simon Kagstrom456b5652009-10-16 14:09:18 +02002816 err = 0;
2817 }
2818 spin_unlock_irqrestore(&dump_list_lock, flags);
2819
2820 return err;
2821}
2822EXPORT_SYMBOL_GPL(kmsg_dump_register);
2823
2824/**
2825 * kmsg_dump_unregister - unregister a kmsg dumper.
Randy Dunlap64855362009-12-17 15:27:27 -08002826 * @dumper: pointer to the kmsg_dumper structure
Simon Kagstrom456b5652009-10-16 14:09:18 +02002827 *
2828 * Removes a dump device from the system. Returns zero on success and
2829 * %-EINVAL otherwise.
2830 */
2831int kmsg_dump_unregister(struct kmsg_dumper *dumper)
2832{
2833 unsigned long flags;
2834 int err = -EINVAL;
2835
2836 spin_lock_irqsave(&dump_list_lock, flags);
2837 if (dumper->registered) {
2838 dumper->registered = 0;
Huang Yingfb842b002011-01-12 16:59:43 -08002839 list_del_rcu(&dumper->list);
Simon Kagstrom456b5652009-10-16 14:09:18 +02002840 err = 0;
2841 }
2842 spin_unlock_irqrestore(&dump_list_lock, flags);
Huang Yingfb842b002011-01-12 16:59:43 -08002843 synchronize_rcu();
Simon Kagstrom456b5652009-10-16 14:09:18 +02002844
2845 return err;
2846}
2847EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
2848
Kay Sievers7ff95542012-05-03 02:29:13 +02002849static bool always_kmsg_dump;
2850module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);
2851
Simon Kagstrom456b5652009-10-16 14:09:18 +02002852/**
2853 * kmsg_dump - dump kernel log to kernel message dumpers.
2854 * @reason: the reason (oops, panic etc) for dumping
2855 *
Kay Sieverse2ae7152012-06-15 14:07:51 +02002856 * Call each of the registered dumper's dump() callback, which can
2857 * retrieve the kmsg records with kmsg_dump_get_line() or
2858 * kmsg_dump_get_buffer().
Simon Kagstrom456b5652009-10-16 14:09:18 +02002859 */
2860void kmsg_dump(enum kmsg_dump_reason reason)
2861{
Simon Kagstrom456b5652009-10-16 14:09:18 +02002862 struct kmsg_dumper *dumper;
Simon Kagstrom456b5652009-10-16 14:09:18 +02002863 unsigned long flags;
2864
Matthew Garrettc22ab3322012-03-05 14:59:10 -08002865 if ((reason > KMSG_DUMP_OOPS) && !always_kmsg_dump)
2866 return;
2867
Huang Yingfb842b002011-01-12 16:59:43 -08002868 rcu_read_lock();
Kay Sieverse2ae7152012-06-15 14:07:51 +02002869 list_for_each_entry_rcu(dumper, &dump_list, list) {
2870 if (dumper->max_reason && reason > dumper->max_reason)
2871 continue;
2872
2873 /* initialize iterator with data about the stored records */
2874 dumper->active = true;
2875
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09002876 logbuf_lock_irqsave(flags);
Kay Sieverse2ae7152012-06-15 14:07:51 +02002877 dumper->cur_seq = clear_seq;
2878 dumper->cur_idx = clear_idx;
2879 dumper->next_seq = log_next_seq;
2880 dumper->next_idx = log_next_idx;
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09002881 logbuf_unlock_irqrestore(flags);
Kay Sieverse2ae7152012-06-15 14:07:51 +02002882
2883 /* invoke dumper which will iterate over records */
2884 dumper->dump(dumper, reason);
2885
2886 /* reset iterator */
2887 dumper->active = false;
2888 }
Huang Yingfb842b002011-01-12 16:59:43 -08002889 rcu_read_unlock();
Simon Kagstrom456b5652009-10-16 14:09:18 +02002890}
Kay Sieverse2ae7152012-06-15 14:07:51 +02002891
2892/**
Anton Vorontsov533827c2012-07-20 17:28:07 -07002893 * kmsg_dump_get_line_nolock - retrieve one kmsg log line (unlocked version)
2894 * @dumper: registered kmsg dumper
2895 * @syslog: include the "<4>" prefixes
2896 * @line: buffer to copy the line to
2897 * @size: maximum size of the buffer
2898 * @len: length of line placed into buffer
2899 *
2900 * Start at the beginning of the kmsg buffer, with the oldest kmsg
2901 * record, and copy one record into the provided buffer.
2902 *
2903 * Consecutive calls will return the next available record moving
2904 * towards the end of the buffer with the youngest messages.
2905 *
2906 * A return value of FALSE indicates that there are no more records to
2907 * read.
2908 *
2909 * The function is similar to kmsg_dump_get_line(), but grabs no locks.
2910 */
2911bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper, bool syslog,
2912 char *line, size_t size, size_t *len)
2913{
Joe Perches62e32ac2013-07-31 13:53:47 -07002914 struct printk_log *msg;
Anton Vorontsov533827c2012-07-20 17:28:07 -07002915 size_t l = 0;
2916 bool ret = false;
2917
2918 if (!dumper->active)
2919 goto out;
2920
2921 if (dumper->cur_seq < log_first_seq) {
2922 /* messages are gone, move to first available one */
2923 dumper->cur_seq = log_first_seq;
2924 dumper->cur_idx = log_first_idx;
2925 }
2926
2927 /* last entry */
2928 if (dumper->cur_seq >= log_next_seq)
2929 goto out;
2930
2931 msg = log_from_idx(dumper->cur_idx);
Linus Torvalds5aa068e2016-10-25 11:27:31 -07002932 l = msg_print_text(msg, syslog, line, size);
Anton Vorontsov533827c2012-07-20 17:28:07 -07002933
2934 dumper->cur_idx = log_next(dumper->cur_idx);
2935 dumper->cur_seq++;
2936 ret = true;
2937out:
2938 if (len)
2939 *len = l;
2940 return ret;
2941}
2942
2943/**
Kay Sieverse2ae7152012-06-15 14:07:51 +02002944 * kmsg_dump_get_line - retrieve one kmsg log line
2945 * @dumper: registered kmsg dumper
2946 * @syslog: include the "<4>" prefixes
2947 * @line: buffer to copy the line to
2948 * @size: maximum size of the buffer
2949 * @len: length of line placed into buffer
2950 *
2951 * Start at the beginning of the kmsg buffer, with the oldest kmsg
2952 * record, and copy one record into the provided buffer.
2953 *
2954 * Consecutive calls will return the next available record moving
2955 * towards the end of the buffer with the youngest messages.
2956 *
2957 * A return value of FALSE indicates that there are no more records to
2958 * read.
2959 */
2960bool kmsg_dump_get_line(struct kmsg_dumper *dumper, bool syslog,
2961 char *line, size_t size, size_t *len)
2962{
2963 unsigned long flags;
Anton Vorontsov533827c2012-07-20 17:28:07 -07002964 bool ret;
Kay Sieverse2ae7152012-06-15 14:07:51 +02002965
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09002966 logbuf_lock_irqsave(flags);
Anton Vorontsov533827c2012-07-20 17:28:07 -07002967 ret = kmsg_dump_get_line_nolock(dumper, syslog, line, size, len);
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09002968 logbuf_unlock_irqrestore(flags);
Anton Vorontsov533827c2012-07-20 17:28:07 -07002969
Kay Sieverse2ae7152012-06-15 14:07:51 +02002970 return ret;
2971}
2972EXPORT_SYMBOL_GPL(kmsg_dump_get_line);
2973
2974/**
2975 * kmsg_dump_get_buffer - copy kmsg log lines
2976 * @dumper: registered kmsg dumper
2977 * @syslog: include the "<4>" prefixes
Randy Dunlap4f0f4af2012-06-30 15:37:24 -07002978 * @buf: buffer to copy the line to
Kay Sieverse2ae7152012-06-15 14:07:51 +02002979 * @size: maximum size of the buffer
2980 * @len: length of line placed into buffer
2981 *
2982 * Start at the end of the kmsg buffer and fill the provided buffer
2983 * with as many of the the *youngest* kmsg records that fit into it.
2984 * If the buffer is large enough, all available kmsg records will be
2985 * copied with a single call.
2986 *
2987 * Consecutive calls will fill the buffer with the next block of
2988 * available older records, not including the earlier retrieved ones.
2989 *
2990 * A return value of FALSE indicates that there are no more records to
2991 * read.
2992 */
2993bool kmsg_dump_get_buffer(struct kmsg_dumper *dumper, bool syslog,
2994 char *buf, size_t size, size_t *len)
2995{
2996 unsigned long flags;
2997 u64 seq;
2998 u32 idx;
2999 u64 next_seq;
3000 u32 next_idx;
3001 size_t l = 0;
3002 bool ret = false;
3003
3004 if (!dumper->active)
3005 goto out;
3006
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09003007 logbuf_lock_irqsave(flags);
Kay Sieverse2ae7152012-06-15 14:07:51 +02003008 if (dumper->cur_seq < log_first_seq) {
3009 /* messages are gone, move to first available one */
3010 dumper->cur_seq = log_first_seq;
3011 dumper->cur_idx = log_first_idx;
3012 }
3013
3014 /* last entry */
3015 if (dumper->cur_seq >= dumper->next_seq) {
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09003016 logbuf_unlock_irqrestore(flags);
Kay Sieverse2ae7152012-06-15 14:07:51 +02003017 goto out;
3018 }
3019
3020 /* calculate length of entire buffer */
3021 seq = dumper->cur_seq;
3022 idx = dumper->cur_idx;
3023 while (seq < dumper->next_seq) {
Joe Perches62e32ac2013-07-31 13:53:47 -07003024 struct printk_log *msg = log_from_idx(idx);
Kay Sieverse2ae7152012-06-15 14:07:51 +02003025
Linus Torvalds5aa068e2016-10-25 11:27:31 -07003026 l += msg_print_text(msg, true, NULL, 0);
Kay Sieverse2ae7152012-06-15 14:07:51 +02003027 idx = log_next(idx);
3028 seq++;
3029 }
3030
3031 /* move first record forward until length fits into the buffer */
3032 seq = dumper->cur_seq;
3033 idx = dumper->cur_idx;
3034 while (l > size && seq < dumper->next_seq) {
Joe Perches62e32ac2013-07-31 13:53:47 -07003035 struct printk_log *msg = log_from_idx(idx);
Kay Sieverse2ae7152012-06-15 14:07:51 +02003036
Linus Torvalds5aa068e2016-10-25 11:27:31 -07003037 l -= msg_print_text(msg, true, NULL, 0);
Kay Sieverse2ae7152012-06-15 14:07:51 +02003038 idx = log_next(idx);
3039 seq++;
3040 }
3041
3042 /* last message in next interation */
3043 next_seq = seq;
3044 next_idx = idx;
3045
3046 l = 0;
3047 while (seq < dumper->next_seq) {
Joe Perches62e32ac2013-07-31 13:53:47 -07003048 struct printk_log *msg = log_from_idx(idx);
Kay Sieverse2ae7152012-06-15 14:07:51 +02003049
Linus Torvalds5aa068e2016-10-25 11:27:31 -07003050 l += msg_print_text(msg, syslog, buf + l, size - l);
Kay Sieverse2ae7152012-06-15 14:07:51 +02003051 idx = log_next(idx);
3052 seq++;
3053 }
3054
3055 dumper->next_seq = next_seq;
3056 dumper->next_idx = next_idx;
3057 ret = true;
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09003058 logbuf_unlock_irqrestore(flags);
Kay Sieverse2ae7152012-06-15 14:07:51 +02003059out:
3060 if (len)
3061 *len = l;
3062 return ret;
3063}
3064EXPORT_SYMBOL_GPL(kmsg_dump_get_buffer);
3065
3066/**
Anton Vorontsov533827c2012-07-20 17:28:07 -07003067 * kmsg_dump_rewind_nolock - reset the interator (unlocked version)
3068 * @dumper: registered kmsg dumper
3069 *
3070 * Reset the dumper's iterator so that kmsg_dump_get_line() and
3071 * kmsg_dump_get_buffer() can be called again and used multiple
3072 * times within the same dumper.dump() callback.
3073 *
3074 * The function is similar to kmsg_dump_rewind(), but grabs no locks.
3075 */
3076void kmsg_dump_rewind_nolock(struct kmsg_dumper *dumper)
3077{
3078 dumper->cur_seq = clear_seq;
3079 dumper->cur_idx = clear_idx;
3080 dumper->next_seq = log_next_seq;
3081 dumper->next_idx = log_next_idx;
3082}
3083
3084/**
Kay Sieverse2ae7152012-06-15 14:07:51 +02003085 * kmsg_dump_rewind - reset the interator
3086 * @dumper: registered kmsg dumper
3087 *
3088 * Reset the dumper's iterator so that kmsg_dump_get_line() and
3089 * kmsg_dump_get_buffer() can be called again and used multiple
3090 * times within the same dumper.dump() callback.
3091 */
3092void kmsg_dump_rewind(struct kmsg_dumper *dumper)
3093{
3094 unsigned long flags;
3095
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09003096 logbuf_lock_irqsave(flags);
Anton Vorontsov533827c2012-07-20 17:28:07 -07003097 kmsg_dump_rewind_nolock(dumper);
Sergey Senozhatskyde6fcbd2016-12-27 23:16:11 +09003098 logbuf_unlock_irqrestore(flags);
Kay Sieverse2ae7152012-06-15 14:07:51 +02003099}
3100EXPORT_SYMBOL_GPL(kmsg_dump_rewind);
Tejun Heo196779b2013-04-30 15:27:12 -07003101
Tejun Heo98e5e1b2013-04-30 15:27:15 -07003102static char dump_stack_arch_desc_str[128];
3103
3104/**
3105 * dump_stack_set_arch_desc - set arch-specific str to show with task dumps
3106 * @fmt: printf-style format string
3107 * @...: arguments for the format string
3108 *
3109 * The configured string will be printed right after utsname during task
3110 * dumps. Usually used to add arch-specific system identifiers. If an
3111 * arch wants to make use of such an ID string, it should initialize this
3112 * as soon as possible during boot.
3113 */
3114void __init dump_stack_set_arch_desc(const char *fmt, ...)
3115{
3116 va_list args;
3117
3118 va_start(args, fmt);
3119 vsnprintf(dump_stack_arch_desc_str, sizeof(dump_stack_arch_desc_str),
3120 fmt, args);
3121 va_end(args);
3122}
3123
Tejun Heo196779b2013-04-30 15:27:12 -07003124/**
3125 * dump_stack_print_info - print generic debug info for dump_stack()
3126 * @log_lvl: log level
3127 *
3128 * Arch-specific dump_stack() implementations can use this function to
3129 * print out the same debug information as the generic dump_stack().
3130 */
3131void dump_stack_print_info(const char *log_lvl)
3132{
3133 printk("%sCPU: %d PID: %d Comm: %.20s %s %s %.*s\n",
3134 log_lvl, raw_smp_processor_id(), current->pid, current->comm,
3135 print_tainted(), init_utsname()->release,
3136 (int)strcspn(init_utsname()->version, " "),
3137 init_utsname()->version);
Tejun Heo98e5e1b2013-04-30 15:27:15 -07003138
3139 if (dump_stack_arch_desc_str[0] != '\0')
3140 printk("%sHardware name: %s\n",
3141 log_lvl, dump_stack_arch_desc_str);
Tejun Heo3d1cb202013-04-30 15:27:22 -07003142
3143 print_worker_info(log_lvl, current);
Tejun Heo196779b2013-04-30 15:27:12 -07003144}
3145
Tejun Heoa43cb952013-04-30 15:27:17 -07003146/**
3147 * show_regs_print_info - print generic debug info for show_regs()
3148 * @log_lvl: log level
3149 *
3150 * show_regs() implementations can use this function to print out generic
3151 * debug information.
3152 */
3153void show_regs_print_info(const char *log_lvl)
3154{
3155 dump_stack_print_info(log_lvl);
3156
Andy Lutomirski8b70ca62016-07-28 15:48:23 -07003157 printk("%stask: %p task.stack: %p\n",
3158 log_lvl, current, task_stack_page(current));
Tejun Heoa43cb952013-04-30 15:27:17 -07003159}
3160
Joe Perches7ef3d2f2008-02-08 04:21:25 -08003161#endif