blob: 37cde752cb8a1a15bb9cbef8b3770c5967706f97 [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/interrupt.h> /* For in_interrupt() */
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <linux/delay.h>
31#include <linux/smp.h>
32#include <linux/security.h>
33#include <linux/bootmem.h>
Mike Travis162a7e72011-05-24 17:13:20 -070034#include <linux/memblock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/syscalls.h>
Neil Horman04d491a2009-04-02 16:58:57 -070036#include <linux/kexec.h>
Jason Wesseld37d39a2010-05-20 21:04:27 -050037#include <linux/kdb.h>
Ingo Molnar3fff4c42009-09-22 16:18:09 +020038#include <linux/ratelimit.h>
Simon Kagstrom456b5652009-10-16 14:09:18 +020039#include <linux/kmsg_dump.h>
Kees Cook00234592010-02-03 15:36:43 -080040#include <linux/syslog.h>
Kevin Cernekee034260d2010-06-03 22:11:25 -070041#include <linux/cpu.h>
42#include <linux/notifier.h>
Huang Yingfb842b02011-01-12 16:59:43 -080043#include <linux/rculist.h>
Kay Sieverse11fea92012-05-03 02:29:41 +020044#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
46#include <asm/uaccess.h>
47
Johannes Berg95100352011-11-24 20:03:08 +010048#define CREATE_TRACE_POINTS
49#include <trace/events/printk.h>
50
Ingo Molnar076f9772008-01-30 13:33:06 +010051/*
52 * Architectures can override it:
53 */
Jiri Slabye17ba732008-05-12 15:44:40 +020054void asmlinkage __attribute__((weak)) early_printk(const char *fmt, ...)
Ingo Molnar076f9772008-01-30 13:33:06 +010055{
56}
57
Linus Torvalds1da177e2005-04-16 15:20:36 -070058/* printk's without a loglevel use this.. */
Mandeep Singh Baines5af5bcb2011-03-22 16:34:23 -070059#define DEFAULT_MESSAGE_LOGLEVEL CONFIG_DEFAULT_MESSAGE_LOGLEVEL
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61/* We show everything that is MORE important than this.. */
62#define MINIMUM_CONSOLE_LOGLEVEL 1 /* Minimum loglevel we let people use */
63#define DEFAULT_CONSOLE_LOGLEVEL 7 /* anything MORE serious than KERN_DEBUG */
64
65DECLARE_WAIT_QUEUE_HEAD(log_wait);
66
67int console_printk[4] = {
68 DEFAULT_CONSOLE_LOGLEVEL, /* console_loglevel */
69 DEFAULT_MESSAGE_LOGLEVEL, /* default_message_loglevel */
70 MINIMUM_CONSOLE_LOGLEVEL, /* minimum_console_loglevel */
71 DEFAULT_CONSOLE_LOGLEVEL, /* default_console_loglevel */
72};
73
Linus Torvalds1da177e2005-04-16 15:20:36 -070074/*
Patrick Pletscher0bbfb7c2007-02-17 20:10:16 +010075 * Low level drivers may need that to know if they can schedule in
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 * their unblank() callback or not. So let's export it.
77 */
78int oops_in_progress;
79EXPORT_SYMBOL(oops_in_progress);
80
81/*
82 * console_sem protects the console_drivers list, and also
83 * provides serialisation for access to the entire console
84 * driver system.
85 */
Thomas Gleixner5b8c4f22010-09-07 14:33:43 +000086static DEFINE_SEMAPHORE(console_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087struct console *console_drivers;
Ingo Molnara29d1cf2008-06-02 13:19:08 +020088EXPORT_SYMBOL_GPL(console_drivers);
89
Linus Torvalds1da177e2005-04-16 15:20:36 -070090/*
91 * This is used for debugging the mess that is the VT code by
92 * keeping track if we have the console semaphore held. It's
93 * definitely not the perfect debug tool (we don't know if _WE_
94 * hold it are racing, but it helps tracking those weird code
95 * path in the console code where we end up in places I want
96 * locked without the console sempahore held
97 */
Linus Torvalds557240b2006-06-19 18:16:01 -070098static int console_locked, console_suspended;
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
100/*
Feng Tangfe3d8ad2011-03-22 16:34:21 -0700101 * If exclusive_console is non-NULL then only this console is to be printed to.
102 */
103static struct console *exclusive_console;
104
105/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 * Array of consoles built from command line options (console=)
107 */
108struct console_cmdline
109{
110 char name[8]; /* Name of the driver */
111 int index; /* Minor dev. to use */
112 char *options; /* Options for the driver */
Samuel Thibaultf7511d52008-04-30 00:54:51 -0700113#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
114 char *brl_options; /* Options for braille driver */
115#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116};
117
118#define MAX_CMDLINECONSOLES 8
119
120static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
121static int selected_console = -1;
122static int preferred_console = -1;
Markus Armbruster9e124fe2008-05-26 23:31:07 +0100123int console_set_on_cmdline;
124EXPORT_SYMBOL(console_set_on_cmdline);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
126/* Flag: console code may call schedule() */
127static int console_may_schedule;
128
Kay Sievers7ff95542012-05-03 02:29:13 +0200129/*
130 * The printk log buffer consists of a chain of concatenated variable
131 * length records. Every record starts with a record header, containing
132 * the overall length of the record.
133 *
134 * The heads to the first and last entry in the buffer, as well as the
135 * sequence numbers of these both entries are maintained when messages
136 * are stored..
137 *
138 * If the heads indicate available messages, the length in the header
139 * tells the start next message. A length == 0 for the next message
140 * indicates a wrap-around to the beginning of the buffer.
141 *
142 * Every record carries the monotonic timestamp in microseconds, as well as
143 * the standard userspace syslog level and syslog facility. The usual
144 * kernel messages use LOG_KERN; userspace-injected messages always carry
145 * a matching syslog facility, by default LOG_USER. The origin of every
146 * message can be reliably determined that way.
147 *
148 * The human readable log message directly follows the message header. The
149 * length of the message text is stored in the header, the stored message
150 * is not terminated.
151 *
Kay Sieverse11fea92012-05-03 02:29:41 +0200152 * Optionally, a message can carry a dictionary of properties (key/value pairs),
153 * to provide userspace with a machine-readable message context.
154 *
155 * Examples for well-defined, commonly used property names are:
156 * DEVICE=b12:8 device identifier
157 * b12:8 block dev_t
158 * c127:3 char dev_t
159 * n8 netdev ifindex
160 * +sound:card0 subsystem:devname
161 * SUBSYSTEM=pci driver-core subsystem name
162 *
163 * Valid characters in property names are [a-zA-Z0-9.-_]. The plain text value
164 * follows directly after a '=' character. Every property is terminated by
165 * a '\0' character. The last property is not terminated.
166 *
167 * Example of a message structure:
168 * 0000 ff 8f 00 00 00 00 00 00 monotonic time in nsec
169 * 0008 34 00 record is 52 bytes long
170 * 000a 0b 00 text is 11 bytes long
171 * 000c 1f 00 dictionary is 23 bytes long
172 * 000e 03 00 LOG_KERN (facility) LOG_ERR (level)
173 * 0010 69 74 27 73 20 61 20 6c "it's a l"
174 * 69 6e 65 "ine"
175 * 001b 44 45 56 49 43 "DEVIC"
176 * 45 3d 62 38 3a 32 00 44 "E=b8:2\0D"
177 * 52 49 56 45 52 3d 62 75 "RIVER=bu"
178 * 67 "g"
179 * 0032 00 00 00 padding to next message header
180 *
181 * The 'struct log' buffer header must never be directly exported to
182 * userspace, it is a kernel-private implementation detail that might
183 * need to be changed in the future, when the requirements change.
184 *
185 * /dev/kmsg exports the structured data in the following line format:
186 * "level,sequnum,timestamp;<message text>\n"
187 *
188 * The optional key/value pairs are attached as continuation lines starting
189 * with a space character and terminated by a newline. All possible
190 * non-prinatable characters are escaped in the "\xff" notation.
191 *
192 * Users of the export format should ignore possible additional values
193 * separated by ',', and find the message after the ';' character.
Kay Sievers7ff95542012-05-03 02:29:13 +0200194 */
Matt Mackalld59745c2005-05-01 08:59:02 -0700195
Kay Sievers084681d2012-06-28 09:38:53 +0200196enum log_flags {
197 LOG_DEFAULT = 0,
198 LOG_NOCONS = 1, /* already flushed, do not print to console */
199};
200
Kay Sievers7ff95542012-05-03 02:29:13 +0200201struct log {
202 u64 ts_nsec; /* timestamp in nanoseconds */
203 u16 len; /* length of entire record */
204 u16 text_len; /* length of text buffer */
205 u16 dict_len; /* length of dictionary buffer */
Kay Sievers084681d2012-06-28 09:38:53 +0200206 u8 facility; /* syslog facility */
207 u8 flags:5; /* internal record flags */
208 u8 level:3; /* syslog level */
Kay Sievers7ff95542012-05-03 02:29:13 +0200209};
210
211/*
212 * The logbuf_lock protects kmsg buffer, indices, counters. It is also
213 * used in interesting ways to provide interlocking in console_unlock();
214 */
215static DEFINE_RAW_SPINLOCK(logbuf_lock);
216
Kay Sievers7f3a7812012-05-09 01:37:51 +0200217/* the next printk record to read by syslog(READ) or /proc/kmsg */
218static u64 syslog_seq;
219static u32 syslog_idx;
220
221/* index and sequence number of the first record stored in the buffer */
222static u64 log_first_seq;
223static u32 log_first_idx;
224
225/* index and sequence number of the next record to store in the buffer */
226static u64 log_next_seq;
227#ifdef CONFIG_PRINTK
228static u32 log_next_idx;
229
230/* the next printk record to read after the last 'clear' command */
231static u64 clear_seq;
232static u32 clear_idx;
Kay Sievers7ff95542012-05-03 02:29:13 +0200233
234#define LOG_LINE_MAX 1024
235
236/* record buffer */
Andrew Lunn6ebb0172012-06-05 08:52:34 +0200237#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
Stephen Warrenf8450fc2012-05-10 16:14:33 -0600238#define LOG_ALIGN 4
239#else
Andrew Lunn6ebb0172012-06-05 08:52:34 +0200240#define LOG_ALIGN __alignof__(struct log)
Stephen Warrenf8450fc2012-05-10 16:14:33 -0600241#endif
Kay Sievers7ff95542012-05-03 02:29:13 +0200242#define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
Stephen Warrenf8450fc2012-05-10 16:14:33 -0600243static char __log_buf[__LOG_BUF_LEN] __aligned(LOG_ALIGN);
Matt Mackalld59745c2005-05-01 08:59:02 -0700244static char *log_buf = __log_buf;
Kay Sievers7ff95542012-05-03 02:29:13 +0200245static u32 log_buf_len = __LOG_BUF_LEN;
246
Kay Sievers7f3a7812012-05-09 01:37:51 +0200247/* cpu currently holding logbuf_lock */
248static volatile unsigned int logbuf_cpu = UINT_MAX;
Kay Sievers7ff95542012-05-03 02:29:13 +0200249
250/* human readable text of the record */
251static char *log_text(const struct log *msg)
252{
253 return (char *)msg + sizeof(struct log);
254}
255
256/* optional key/value pair dictionary attached to the record */
257static char *log_dict(const struct log *msg)
258{
259 return (char *)msg + sizeof(struct log) + msg->text_len;
260}
261
262/* get record by index; idx must point to valid msg */
263static struct log *log_from_idx(u32 idx)
264{
265 struct log *msg = (struct log *)(log_buf + idx);
266
267 /*
268 * A length == 0 record is the end of buffer marker. Wrap around and
269 * read the message at the start of the buffer.
270 */
271 if (!msg->len)
272 return (struct log *)log_buf;
273 return msg;
274}
275
276/* get next record; idx must point to valid msg */
277static u32 log_next(u32 idx)
278{
279 struct log *msg = (struct log *)(log_buf + idx);
280
281 /* length == 0 indicates the end of the buffer; wrap */
282 /*
283 * A length == 0 record is the end of buffer marker. Wrap around and
284 * read the message at the start of the buffer as *this* one, and
285 * return the one after that.
286 */
287 if (!msg->len) {
288 msg = (struct log *)log_buf;
289 return msg->len;
290 }
291 return idx + msg->len;
292}
293
Kay Sievers7ff95542012-05-03 02:29:13 +0200294/* insert record into the buffer, discard old ones, update heads */
295static void log_store(int facility, int level,
Kay Sievers084681d2012-06-28 09:38:53 +0200296 enum log_flags flags, u64 ts_nsec,
Kay Sievers7ff95542012-05-03 02:29:13 +0200297 const char *dict, u16 dict_len,
298 const char *text, u16 text_len)
299{
300 struct log *msg;
301 u32 size, pad_len;
302
303 /* number of '\0' padding bytes to next message */
304 size = sizeof(struct log) + text_len + dict_len;
305 pad_len = (-size) & (LOG_ALIGN - 1);
306 size += pad_len;
307
308 while (log_first_seq < log_next_seq) {
309 u32 free;
310
311 if (log_next_idx > log_first_idx)
312 free = max(log_buf_len - log_next_idx, log_first_idx);
313 else
314 free = log_first_idx - log_next_idx;
315
316 if (free > size + sizeof(struct log))
317 break;
318
319 /* drop old messages until we have enough contiuous space */
320 log_first_idx = log_next(log_first_idx);
321 log_first_seq++;
322 }
323
324 if (log_next_idx + size + sizeof(struct log) >= log_buf_len) {
325 /*
326 * This message + an additional empty header does not fit
327 * at the end of the buffer. Add an empty header with len == 0
328 * to signify a wrap around.
329 */
330 memset(log_buf + log_next_idx, 0, sizeof(struct log));
331 log_next_idx = 0;
332 }
333
334 /* fill message */
335 msg = (struct log *)(log_buf + log_next_idx);
336 memcpy(log_text(msg), text, text_len);
337 msg->text_len = text_len;
338 memcpy(log_dict(msg), dict, dict_len);
339 msg->dict_len = dict_len;
Kay Sievers084681d2012-06-28 09:38:53 +0200340 msg->facility = facility;
341 msg->level = level & 7;
342 msg->flags = flags & 0x1f;
343 if (ts_nsec > 0)
344 msg->ts_nsec = ts_nsec;
345 else
346 msg->ts_nsec = local_clock();
Kay Sievers7ff95542012-05-03 02:29:13 +0200347 memset(log_dict(msg) + dict_len, 0, pad_len);
348 msg->len = sizeof(struct log) + text_len + dict_len + pad_len;
349
350 /* insert message */
351 log_next_idx += msg->len;
352 log_next_seq++;
353}
Matt Mackalld59745c2005-05-01 08:59:02 -0700354
Kay Sieverse11fea92012-05-03 02:29:41 +0200355/* /dev/kmsg - userspace message inject/listen interface */
356struct devkmsg_user {
357 u64 seq;
358 u32 idx;
359 struct mutex lock;
360 char buf[8192];
361};
362
363static ssize_t devkmsg_writev(struct kiocb *iocb, const struct iovec *iv,
364 unsigned long count, loff_t pos)
365{
366 char *buf, *line;
367 int i;
368 int level = default_message_loglevel;
369 int facility = 1; /* LOG_USER */
370 size_t len = iov_length(iv, count);
371 ssize_t ret = len;
372
373 if (len > LOG_LINE_MAX)
374 return -EINVAL;
375 buf = kmalloc(len+1, GFP_KERNEL);
376 if (buf == NULL)
377 return -ENOMEM;
378
379 line = buf;
380 for (i = 0; i < count; i++) {
381 if (copy_from_user(line, iv[i].iov_base, iv[i].iov_len))
382 goto out;
383 line += iv[i].iov_len;
384 }
385
386 /*
387 * Extract and skip the syslog prefix <[0-9]*>. Coming from userspace
388 * the decimal value represents 32bit, the lower 3 bit are the log
389 * level, the rest are the log facility.
390 *
391 * If no prefix or no userspace facility is specified, we
392 * enforce LOG_USER, to be able to reliably distinguish
393 * kernel-generated messages from userspace-injected ones.
394 */
395 line = buf;
396 if (line[0] == '<') {
397 char *endp = NULL;
398
399 i = simple_strtoul(line+1, &endp, 10);
400 if (endp && endp[0] == '>') {
401 level = i & 7;
402 if (i >> 3)
403 facility = i >> 3;
404 endp++;
405 len -= endp - line;
406 line = endp;
407 }
408 }
409 line[len] = '\0';
410
411 printk_emit(facility, level, NULL, 0, "%s", line);
412out:
413 kfree(buf);
414 return ret;
415}
416
417static ssize_t devkmsg_read(struct file *file, char __user *buf,
418 size_t count, loff_t *ppos)
419{
420 struct devkmsg_user *user = file->private_data;
421 struct log *msg;
Kay Sievers5fc324902012-05-08 13:04:17 +0200422 u64 ts_usec;
Kay Sieverse11fea92012-05-03 02:29:41 +0200423 size_t i;
424 size_t len;
425 ssize_t ret;
426
427 if (!user)
428 return -EBADF;
429
Yuanhan Liu4a77a5a2012-06-16 21:21:51 +0800430 ret = mutex_lock_interruptible(&user->lock);
431 if (ret)
432 return ret;
liu chuansheng5c53d812012-07-06 09:50:08 -0700433 raw_spin_lock_irq(&logbuf_lock);
Kay Sieverse11fea92012-05-03 02:29:41 +0200434 while (user->seq == log_next_seq) {
435 if (file->f_flags & O_NONBLOCK) {
436 ret = -EAGAIN;
liu chuansheng5c53d812012-07-06 09:50:08 -0700437 raw_spin_unlock_irq(&logbuf_lock);
Kay Sieverse11fea92012-05-03 02:29:41 +0200438 goto out;
439 }
440
liu chuansheng5c53d812012-07-06 09:50:08 -0700441 raw_spin_unlock_irq(&logbuf_lock);
Kay Sieverse11fea92012-05-03 02:29:41 +0200442 ret = wait_event_interruptible(log_wait,
443 user->seq != log_next_seq);
444 if (ret)
445 goto out;
liu chuansheng5c53d812012-07-06 09:50:08 -0700446 raw_spin_lock_irq(&logbuf_lock);
Kay Sieverse11fea92012-05-03 02:29:41 +0200447 }
448
449 if (user->seq < log_first_seq) {
450 /* our last seen message is gone, return error and reset */
451 user->idx = log_first_idx;
452 user->seq = log_first_seq;
453 ret = -EPIPE;
liu chuansheng5c53d812012-07-06 09:50:08 -0700454 raw_spin_unlock_irq(&logbuf_lock);
Kay Sieverse11fea92012-05-03 02:29:41 +0200455 goto out;
456 }
457
458 msg = log_from_idx(user->idx);
Kay Sievers5fc324902012-05-08 13:04:17 +0200459 ts_usec = msg->ts_nsec;
460 do_div(ts_usec, 1000);
Kay Sieverse11fea92012-05-03 02:29:41 +0200461 len = sprintf(user->buf, "%u,%llu,%llu;",
Kay Sievers084681d2012-06-28 09:38:53 +0200462 (msg->facility << 3) | msg->level, user->seq, ts_usec);
Kay Sieverse11fea92012-05-03 02:29:41 +0200463
464 /* escape non-printable characters */
465 for (i = 0; i < msg->text_len; i++) {
Kay Sievers3ce9a7c2012-05-13 23:30:46 +0200466 unsigned char c = log_text(msg)[i];
Kay Sieverse11fea92012-05-03 02:29:41 +0200467
Kay Sieverse3f5a5f2012-07-06 09:50:09 -0700468 if (c < ' ' || c >= 127 || c == '\\')
Kay Sieverse11fea92012-05-03 02:29:41 +0200469 len += sprintf(user->buf + len, "\\x%02x", c);
470 else
471 user->buf[len++] = c;
472 }
473 user->buf[len++] = '\n';
474
475 if (msg->dict_len) {
476 bool line = true;
477
478 for (i = 0; i < msg->dict_len; i++) {
Kay Sievers3ce9a7c2012-05-13 23:30:46 +0200479 unsigned char c = log_dict(msg)[i];
Kay Sieverse11fea92012-05-03 02:29:41 +0200480
481 if (line) {
482 user->buf[len++] = ' ';
483 line = false;
484 }
485
486 if (c == '\0') {
487 user->buf[len++] = '\n';
488 line = true;
489 continue;
490 }
491
Kay Sieverse3f5a5f2012-07-06 09:50:09 -0700492 if (c < ' ' || c >= 127 || c == '\\') {
Kay Sieverse11fea92012-05-03 02:29:41 +0200493 len += sprintf(user->buf + len, "\\x%02x", c);
494 continue;
495 }
496
497 user->buf[len++] = c;
498 }
499 user->buf[len++] = '\n';
500 }
501
502 user->idx = log_next(user->idx);
503 user->seq++;
liu chuansheng5c53d812012-07-06 09:50:08 -0700504 raw_spin_unlock_irq(&logbuf_lock);
Kay Sieverse11fea92012-05-03 02:29:41 +0200505
506 if (len > count) {
507 ret = -EINVAL;
508 goto out;
509 }
510
511 if (copy_to_user(buf, user->buf, len)) {
512 ret = -EFAULT;
513 goto out;
514 }
515 ret = len;
516out:
517 mutex_unlock(&user->lock);
518 return ret;
519}
520
521static loff_t devkmsg_llseek(struct file *file, loff_t offset, int whence)
522{
523 struct devkmsg_user *user = file->private_data;
524 loff_t ret = 0;
525
526 if (!user)
527 return -EBADF;
528 if (offset)
529 return -ESPIPE;
530
liu chuansheng5c53d812012-07-06 09:50:08 -0700531 raw_spin_lock_irq(&logbuf_lock);
Kay Sieverse11fea92012-05-03 02:29:41 +0200532 switch (whence) {
533 case SEEK_SET:
534 /* the first record */
535 user->idx = log_first_idx;
536 user->seq = log_first_seq;
537 break;
538 case SEEK_DATA:
539 /*
540 * The first record after the last SYSLOG_ACTION_CLEAR,
541 * like issued by 'dmesg -c'. Reading /dev/kmsg itself
542 * changes no global state, and does not clear anything.
543 */
544 user->idx = clear_idx;
545 user->seq = clear_seq;
546 break;
547 case SEEK_END:
548 /* after the last record */
549 user->idx = log_next_idx;
550 user->seq = log_next_seq;
551 break;
552 default:
553 ret = -EINVAL;
554 }
liu chuansheng5c53d812012-07-06 09:50:08 -0700555 raw_spin_unlock_irq(&logbuf_lock);
Kay Sieverse11fea92012-05-03 02:29:41 +0200556 return ret;
557}
558
559static unsigned int devkmsg_poll(struct file *file, poll_table *wait)
560{
561 struct devkmsg_user *user = file->private_data;
562 int ret = 0;
563
564 if (!user)
565 return POLLERR|POLLNVAL;
566
567 poll_wait(file, &log_wait, wait);
568
liu chuansheng5c53d812012-07-06 09:50:08 -0700569 raw_spin_lock_irq(&logbuf_lock);
Kay Sieverse11fea92012-05-03 02:29:41 +0200570 if (user->seq < log_next_seq) {
571 /* return error when data has vanished underneath us */
572 if (user->seq < log_first_seq)
573 ret = POLLIN|POLLRDNORM|POLLERR|POLLPRI;
574 ret = POLLIN|POLLRDNORM;
575 }
liu chuansheng5c53d812012-07-06 09:50:08 -0700576 raw_spin_unlock_irq(&logbuf_lock);
Kay Sieverse11fea92012-05-03 02:29:41 +0200577
578 return ret;
579}
580
581static int devkmsg_open(struct inode *inode, struct file *file)
582{
583 struct devkmsg_user *user;
584 int err;
585
586 /* write-only does not need any file context */
587 if ((file->f_flags & O_ACCMODE) == O_WRONLY)
588 return 0;
589
590 err = security_syslog(SYSLOG_ACTION_READ_ALL);
591 if (err)
592 return err;
593
594 user = kmalloc(sizeof(struct devkmsg_user), GFP_KERNEL);
595 if (!user)
596 return -ENOMEM;
597
598 mutex_init(&user->lock);
599
liu chuansheng5c53d812012-07-06 09:50:08 -0700600 raw_spin_lock_irq(&logbuf_lock);
Kay Sieverse11fea92012-05-03 02:29:41 +0200601 user->idx = log_first_idx;
602 user->seq = log_first_seq;
liu chuansheng5c53d812012-07-06 09:50:08 -0700603 raw_spin_unlock_irq(&logbuf_lock);
Kay Sieverse11fea92012-05-03 02:29:41 +0200604
605 file->private_data = user;
606 return 0;
607}
608
609static int devkmsg_release(struct inode *inode, struct file *file)
610{
611 struct devkmsg_user *user = file->private_data;
612
613 if (!user)
614 return 0;
615
616 mutex_destroy(&user->lock);
617 kfree(user);
618 return 0;
619}
620
621const struct file_operations kmsg_fops = {
622 .open = devkmsg_open,
623 .read = devkmsg_read,
624 .aio_write = devkmsg_writev,
625 .llseek = devkmsg_llseek,
626 .poll = devkmsg_poll,
627 .release = devkmsg_release,
628};
629
Neil Horman04d491a2009-04-02 16:58:57 -0700630#ifdef CONFIG_KEXEC
631/*
632 * This appends the listed symbols to /proc/vmcoreinfo
633 *
634 * /proc/vmcoreinfo is used by various utiilties, like crash and makedumpfile to
635 * obtain access to symbols that are otherwise very difficult to locate. These
636 * symbols are specifically used so that utilities can access and extract the
637 * dmesg log from a vmcore file after a crash.
638 */
639void log_buf_kexec_setup(void)
640{
641 VMCOREINFO_SYMBOL(log_buf);
Neil Horman04d491a2009-04-02 16:58:57 -0700642 VMCOREINFO_SYMBOL(log_buf_len);
Kay Sievers7ff95542012-05-03 02:29:13 +0200643 VMCOREINFO_SYMBOL(log_first_idx);
644 VMCOREINFO_SYMBOL(log_next_idx);
Neil Horman04d491a2009-04-02 16:58:57 -0700645}
646#endif
647
Mike Travis162a7e72011-05-24 17:13:20 -0700648/* requested log_buf_len from kernel cmdline */
649static unsigned long __initdata new_log_buf_len;
650
651/* save requested log_buf_len since it's too early to process it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652static int __init log_buf_len_setup(char *str)
653{
Denys Vlasenkoeed4a2a2008-02-06 01:37:02 -0800654 unsigned size = memparse(str, &str);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
656 if (size)
657 size = roundup_pow_of_two(size);
Mike Travis162a7e72011-05-24 17:13:20 -0700658 if (size > log_buf_len)
659 new_log_buf_len = size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
Mike Travis162a7e72011-05-24 17:13:20 -0700661 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662}
Mike Travis162a7e72011-05-24 17:13:20 -0700663early_param("log_buf_len", log_buf_len_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664
Mike Travis162a7e72011-05-24 17:13:20 -0700665void __init setup_log_buf(int early)
666{
667 unsigned long flags;
Mike Travis162a7e72011-05-24 17:13:20 -0700668 char *new_log_buf;
669 int free;
670
671 if (!new_log_buf_len)
672 return;
673
674 if (early) {
675 unsigned long mem;
676
677 mem = memblock_alloc(new_log_buf_len, PAGE_SIZE);
Tejun Heo1f5026a2011-07-12 09:58:09 +0200678 if (!mem)
Mike Travis162a7e72011-05-24 17:13:20 -0700679 return;
680 new_log_buf = __va(mem);
681 } else {
682 new_log_buf = alloc_bootmem_nopanic(new_log_buf_len);
683 }
684
685 if (unlikely(!new_log_buf)) {
686 pr_err("log_buf_len: %ld bytes not available\n",
687 new_log_buf_len);
688 return;
689 }
690
Thomas Gleixner07354eb2009-07-25 17:50:36 +0200691 raw_spin_lock_irqsave(&logbuf_lock, flags);
Mike Travis162a7e72011-05-24 17:13:20 -0700692 log_buf_len = new_log_buf_len;
693 log_buf = new_log_buf;
694 new_log_buf_len = 0;
Kay Sievers7ff95542012-05-03 02:29:13 +0200695 free = __LOG_BUF_LEN - log_next_idx;
696 memcpy(log_buf, __log_buf, __LOG_BUF_LEN);
Thomas Gleixner07354eb2009-07-25 17:50:36 +0200697 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
Mike Travis162a7e72011-05-24 17:13:20 -0700698
699 pr_info("log_buf_len: %d\n", log_buf_len);
700 pr_info("early log buf free: %d(%d%%)\n",
701 free, (free * 100) / __LOG_BUF_LEN);
702}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703
Randy Dunlapbfe8df32007-10-16 01:23:46 -0700704#ifdef CONFIG_BOOT_PRINTK_DELAY
705
Namhyung Kim674dff62010-10-26 14:22:48 -0700706static int boot_delay; /* msecs delay after each printk during bootup */
Dave Young3a3b6ed2009-09-22 16:43:31 -0700707static unsigned long long loops_per_msec; /* based on boot_delay */
Randy Dunlapbfe8df32007-10-16 01:23:46 -0700708
709static int __init boot_delay_setup(char *str)
710{
711 unsigned long lpj;
Randy Dunlapbfe8df32007-10-16 01:23:46 -0700712
713 lpj = preset_lpj ? preset_lpj : 1000000; /* some guess */
714 loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
715
716 get_option(&str, &boot_delay);
717 if (boot_delay > 10 * 1000)
718 boot_delay = 0;
719
Dave Young3a3b6ed2009-09-22 16:43:31 -0700720 pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
721 "HZ: %d, loops_per_msec: %llu\n",
722 boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
Randy Dunlapbfe8df32007-10-16 01:23:46 -0700723 return 1;
724}
725__setup("boot_delay=", boot_delay_setup);
726
727static void boot_delay_msec(void)
728{
729 unsigned long long k;
730 unsigned long timeout;
731
732 if (boot_delay == 0 || system_state != SYSTEM_BOOTING)
733 return;
734
Dave Young3a3b6ed2009-09-22 16:43:31 -0700735 k = (unsigned long long)loops_per_msec * boot_delay;
Randy Dunlapbfe8df32007-10-16 01:23:46 -0700736
737 timeout = jiffies + msecs_to_jiffies(boot_delay);
738 while (k) {
739 k--;
740 cpu_relax();
741 /*
742 * use (volatile) jiffies to prevent
743 * compiler reduction; loop termination via jiffies
744 * is secondary and may or may not happen.
745 */
746 if (time_after(jiffies, timeout))
747 break;
748 touch_nmi_watchdog();
749 }
750}
751#else
752static inline void boot_delay_msec(void)
753{
754}
755#endif
756
Dan Rosenbergeaf06b22010-11-11 14:05:18 -0800757#ifdef CONFIG_SECURITY_DMESG_RESTRICT
758int dmesg_restrict = 1;
759#else
760int dmesg_restrict;
761#endif
762
Linus Torvaldsee24aeb2011-02-10 17:53:55 -0800763static int syslog_action_restricted(int type)
764{
765 if (dmesg_restrict)
766 return 1;
767 /* Unless restricted, we allow "read all" and "get buffer size" for everybody */
768 return type != SYSLOG_ACTION_READ_ALL && type != SYSLOG_ACTION_SIZE_BUFFER;
769}
770
771static int check_syslog_permissions(int type, bool from_file)
772{
773 /*
774 * If this is from /proc/kmsg and we've already opened it, then we've
775 * already done the capabilities checks at open time.
776 */
777 if (from_file && type != SYSLOG_ACTION_OPEN)
778 return 0;
779
780 if (syslog_action_restricted(type)) {
781 if (capable(CAP_SYSLOG))
782 return 0;
783 /* For historical reasons, accept CAP_SYS_ADMIN too, with a warning */
784 if (capable(CAP_SYS_ADMIN)) {
Jonathan Niederf2c0d022011-08-08 06:22:43 +0200785 printk_once(KERN_WARNING "%s (%d): "
786 "Attempt to access syslog with CAP_SYS_ADMIN "
787 "but no CAP_SYSLOG (deprecated).\n",
788 current->comm, task_pid_nr(current));
Linus Torvaldsee24aeb2011-02-10 17:53:55 -0800789 return 0;
790 }
791 return -EPERM;
792 }
793 return 0;
794}
795
Kay Sievers7ff95542012-05-03 02:29:13 +0200796#if defined(CONFIG_PRINTK_TIME)
797static bool printk_time = 1;
798#else
799static bool printk_time;
800#endif
801module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
802
Kay Sievers084681d2012-06-28 09:38:53 +0200803static size_t print_time(u64 ts, char *buf)
804{
805 unsigned long rem_nsec;
806
807 if (!printk_time)
808 return 0;
809
810 if (!buf)
811 return 15;
812
813 rem_nsec = do_div(ts, 1000000000);
814 return sprintf(buf, "[%5lu.%06lu] ",
815 (unsigned long)ts, rem_nsec / 1000);
816}
817
Kay Sievers3ce9a7c2012-05-13 23:30:46 +0200818static size_t print_prefix(const struct log *msg, bool syslog, char *buf)
Kay Sievers649e6ee2012-05-10 04:30:45 +0200819{
Kay Sievers3ce9a7c2012-05-13 23:30:46 +0200820 size_t len = 0;
Kay Sievers43a73a52012-07-06 09:50:09 -0700821 unsigned int prefix = (msg->facility << 3) | msg->level;
Kay Sievers649e6ee2012-05-10 04:30:45 +0200822
Kay Sievers3ce9a7c2012-05-13 23:30:46 +0200823 if (syslog) {
824 if (buf) {
Kay Sievers43a73a52012-07-06 09:50:09 -0700825 len += sprintf(buf, "<%u>", prefix);
Kay Sievers3ce9a7c2012-05-13 23:30:46 +0200826 } else {
827 len += 3;
Kay Sievers43a73a52012-07-06 09:50:09 -0700828 if (prefix > 999)
829 len += 3;
830 else if (prefix > 99)
831 len += 2;
832 else if (prefix > 9)
Kay Sievers3ce9a7c2012-05-13 23:30:46 +0200833 len++;
834 }
Kay Sievers7ff95542012-05-03 02:29:13 +0200835 }
836
Kay Sievers084681d2012-06-28 09:38:53 +0200837 len += print_time(msg->ts_nsec, buf ? buf + len : NULL);
Kay Sievers3ce9a7c2012-05-13 23:30:46 +0200838 return len;
839}
840
841static size_t msg_print_text(const struct log *msg, bool syslog,
842 char *buf, size_t size)
843{
844 const char *text = log_text(msg);
845 size_t text_size = msg->text_len;
846 size_t len = 0;
847
848 do {
849 const char *next = memchr(text, '\n', text_size);
850 size_t text_len;
851
852 if (next) {
853 text_len = next - text;
854 next++;
855 text_size -= next - text;
856 } else {
857 text_len = text_size;
858 }
859
860 if (buf) {
861 if (print_prefix(msg, syslog, NULL) +
862 text_len + 1>= size - len)
863 break;
864
865 len += print_prefix(msg, syslog, buf + len);
866 memcpy(buf + len, text, text_len);
867 len += text_len;
868 buf[len++] = '\n';
869 } else {
870 /* SYSLOG_ACTION_* buffer size only calculation */
871 len += print_prefix(msg, syslog, NULL);
872 len += text_len + 1;
873 }
874
875 text = next;
876 } while (text);
877
Kay Sievers7ff95542012-05-03 02:29:13 +0200878 return len;
879}
880
881static int syslog_print(char __user *buf, int size)
882{
883 char *text;
Kay Sievers3ce9a7c2012-05-13 23:30:46 +0200884 struct log *msg;
Jan Beulich116e90b2012-06-22 16:36:09 +0100885 int len = 0;
Kay Sievers7ff95542012-05-03 02:29:13 +0200886
887 text = kmalloc(LOG_LINE_MAX, GFP_KERNEL);
888 if (!text)
889 return -ENOMEM;
890
Jan Beulich116e90b2012-06-22 16:36:09 +0100891 while (size > 0) {
892 size_t n;
Kay Sievers7ff95542012-05-03 02:29:13 +0200893
Jan Beulich116e90b2012-06-22 16:36:09 +0100894 raw_spin_lock_irq(&logbuf_lock);
895 if (syslog_seq < log_first_seq) {
896 /* messages are gone, move to first one */
897 syslog_seq = log_first_seq;
898 syslog_idx = log_first_idx;
899 }
900 if (syslog_seq == log_next_seq) {
901 raw_spin_unlock_irq(&logbuf_lock);
902 break;
903 }
904 msg = log_from_idx(syslog_idx);
905 n = msg_print_text(msg, true, text, LOG_LINE_MAX);
906 if (n <= size) {
907 syslog_idx = log_next(syslog_idx);
908 syslog_seq++;
909 } else
910 n = 0;
911 raw_spin_unlock_irq(&logbuf_lock);
912
913 if (!n)
914 break;
915
916 len += n;
917 size -= n;
918 buf += n;
919 n = copy_to_user(buf - n, text, n);
920
921 if (n) {
922 len -= n;
923 if (!len)
924 len = -EFAULT;
925 break;
926 }
927 }
Kay Sievers7ff95542012-05-03 02:29:13 +0200928
929 kfree(text);
930 return len;
931}
932
933static int syslog_print_all(char __user *buf, int size, bool clear)
934{
935 char *text;
936 int len = 0;
937
938 text = kmalloc(LOG_LINE_MAX, GFP_KERNEL);
939 if (!text)
940 return -ENOMEM;
941
942 raw_spin_lock_irq(&logbuf_lock);
943 if (buf) {
944 u64 next_seq;
945 u64 seq;
946 u32 idx;
947
948 if (clear_seq < log_first_seq) {
949 /* messages are gone, move to first available one */
950 clear_seq = log_first_seq;
951 clear_idx = log_first_idx;
952 }
953
954 /*
955 * Find first record that fits, including all following records,
956 * into the user-provided buffer for this dump.
Kay Sieverse2ae7152012-06-15 14:07:51 +0200957 */
Kay Sievers7ff95542012-05-03 02:29:13 +0200958 seq = clear_seq;
959 idx = clear_idx;
960 while (seq < log_next_seq) {
Kay Sievers3ce9a7c2012-05-13 23:30:46 +0200961 struct log *msg = log_from_idx(idx);
962
963 len += msg_print_text(msg, true, NULL, 0);
Kay Sievers7ff95542012-05-03 02:29:13 +0200964 idx = log_next(idx);
965 seq++;
966 }
Kay Sieverse2ae7152012-06-15 14:07:51 +0200967
968 /* move first record forward until length fits into the buffer */
Kay Sievers7ff95542012-05-03 02:29:13 +0200969 seq = clear_seq;
970 idx = clear_idx;
971 while (len > size && seq < log_next_seq) {
Kay Sievers3ce9a7c2012-05-13 23:30:46 +0200972 struct log *msg = log_from_idx(idx);
973
974 len -= msg_print_text(msg, true, NULL, 0);
Kay Sievers7ff95542012-05-03 02:29:13 +0200975 idx = log_next(idx);
976 seq++;
977 }
978
Kay Sieverse2ae7152012-06-15 14:07:51 +0200979 /* last message fitting into this dump */
Kay Sievers7ff95542012-05-03 02:29:13 +0200980 next_seq = log_next_seq;
981
982 len = 0;
983 while (len >= 0 && seq < next_seq) {
Kay Sievers3ce9a7c2012-05-13 23:30:46 +0200984 struct log *msg = log_from_idx(idx);
Kay Sievers7ff95542012-05-03 02:29:13 +0200985 int textlen;
986
Kay Sievers3ce9a7c2012-05-13 23:30:46 +0200987 textlen = msg_print_text(msg, true, text, LOG_LINE_MAX);
Kay Sievers7ff95542012-05-03 02:29:13 +0200988 if (textlen < 0) {
989 len = textlen;
990 break;
991 }
992 idx = log_next(idx);
993 seq++;
994
995 raw_spin_unlock_irq(&logbuf_lock);
996 if (copy_to_user(buf + len, text, textlen))
997 len = -EFAULT;
998 else
999 len += textlen;
1000 raw_spin_lock_irq(&logbuf_lock);
1001
1002 if (seq < log_first_seq) {
1003 /* messages are gone, move to next one */
1004 seq = log_first_seq;
1005 idx = log_first_idx;
1006 }
1007 }
1008 }
1009
1010 if (clear) {
1011 clear_seq = log_next_seq;
1012 clear_idx = log_next_idx;
1013 }
1014 raw_spin_unlock_irq(&logbuf_lock);
1015
1016 kfree(text);
1017 return len;
1018}
1019
Kees Cook00234592010-02-03 15:36:43 -08001020int do_syslog(int type, char __user *buf, int len, bool from_file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021{
Kay Sievers7ff95542012-05-03 02:29:13 +02001022 bool clear = false;
1023 static int saved_console_loglevel = -1;
Yuanhan Liu4a77a5a2012-06-16 21:21:51 +08001024 static DEFINE_MUTEX(syslog_mutex);
Linus Torvaldsee24aeb2011-02-10 17:53:55 -08001025 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026
Linus Torvaldsee24aeb2011-02-10 17:53:55 -08001027 error = check_syslog_permissions(type, from_file);
1028 if (error)
1029 goto out;
Eric Paris12b30522010-11-15 18:36:29 -05001030
1031 error = security_syslog(type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 if (error)
1033 return error;
1034
1035 switch (type) {
Kees Cookd78ca3c2010-02-03 15:37:13 -08001036 case SYSLOG_ACTION_CLOSE: /* Close log */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001038 case SYSLOG_ACTION_OPEN: /* Open log */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001040 case SYSLOG_ACTION_READ: /* Read from log */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 error = -EINVAL;
1042 if (!buf || len < 0)
1043 goto out;
1044 error = 0;
1045 if (!len)
1046 goto out;
1047 if (!access_ok(VERIFY_WRITE, buf, len)) {
1048 error = -EFAULT;
1049 goto out;
1050 }
Yuanhan Liu4a77a5a2012-06-16 21:21:51 +08001051 error = mutex_lock_interruptible(&syslog_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 if (error)
1053 goto out;
Yuanhan Liu4a77a5a2012-06-16 21:21:51 +08001054 error = wait_event_interruptible(log_wait,
1055 syslog_seq != log_next_seq);
1056 if (error) {
1057 mutex_unlock(&syslog_mutex);
1058 goto out;
1059 }
Kay Sievers7ff95542012-05-03 02:29:13 +02001060 error = syslog_print(buf, len);
Yuanhan Liu4a77a5a2012-06-16 21:21:51 +08001061 mutex_unlock(&syslog_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001063 /* Read/clear last kernel messages */
1064 case SYSLOG_ACTION_READ_CLEAR:
Kay Sievers7ff95542012-05-03 02:29:13 +02001065 clear = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 /* FALL THRU */
Kees Cookd78ca3c2010-02-03 15:37:13 -08001067 /* Read last kernel messages */
1068 case SYSLOG_ACTION_READ_ALL:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 error = -EINVAL;
1070 if (!buf || len < 0)
1071 goto out;
1072 error = 0;
1073 if (!len)
1074 goto out;
1075 if (!access_ok(VERIFY_WRITE, buf, len)) {
1076 error = -EFAULT;
1077 goto out;
1078 }
Kay Sievers7ff95542012-05-03 02:29:13 +02001079 error = syslog_print_all(buf, len, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001081 /* Clear ring buffer */
1082 case SYSLOG_ACTION_CLEAR:
Kay Sievers7ff95542012-05-03 02:29:13 +02001083 syslog_print_all(NULL, 0, true);
Alan Stern4661e352012-06-22 17:12:19 -04001084 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001085 /* Disable logging to console */
1086 case SYSLOG_ACTION_CONSOLE_OFF:
Frans Pop1aaad492009-07-06 13:31:48 +02001087 if (saved_console_loglevel == -1)
1088 saved_console_loglevel = console_loglevel;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 console_loglevel = minimum_console_loglevel;
1090 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001091 /* Enable logging to console */
1092 case SYSLOG_ACTION_CONSOLE_ON:
Frans Pop1aaad492009-07-06 13:31:48 +02001093 if (saved_console_loglevel != -1) {
1094 console_loglevel = saved_console_loglevel;
1095 saved_console_loglevel = -1;
1096 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001098 /* Set level of messages printed to console */
1099 case SYSLOG_ACTION_CONSOLE_LEVEL:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 error = -EINVAL;
1101 if (len < 1 || len > 8)
1102 goto out;
1103 if (len < minimum_console_loglevel)
1104 len = minimum_console_loglevel;
1105 console_loglevel = len;
Frans Pop1aaad492009-07-06 13:31:48 +02001106 /* Implicitly re-enable logging to console */
1107 saved_console_loglevel = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 error = 0;
1109 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001110 /* Number of chars in the log buffer */
1111 case SYSLOG_ACTION_SIZE_UNREAD:
Kay Sievers7ff95542012-05-03 02:29:13 +02001112 raw_spin_lock_irq(&logbuf_lock);
1113 if (syslog_seq < log_first_seq) {
1114 /* messages are gone, move to first one */
1115 syslog_seq = log_first_seq;
1116 syslog_idx = log_first_idx;
1117 }
1118 if (from_file) {
1119 /*
1120 * Short-cut for poll(/"proc/kmsg") which simply checks
1121 * for pending data, not the size; return the count of
1122 * records, not the length.
1123 */
1124 error = log_next_idx - syslog_idx;
1125 } else {
1126 u64 seq;
1127 u32 idx;
1128
1129 error = 0;
1130 seq = syslog_seq;
1131 idx = syslog_idx;
1132 while (seq < log_next_seq) {
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001133 struct log *msg = log_from_idx(idx);
1134
1135 error += msg_print_text(msg, true, NULL, 0);
Kay Sievers7ff95542012-05-03 02:29:13 +02001136 idx = log_next(idx);
1137 seq++;
1138 }
1139 }
1140 raw_spin_unlock_irq(&logbuf_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 break;
Kees Cookd78ca3c2010-02-03 15:37:13 -08001142 /* Size of the log buffer */
1143 case SYSLOG_ACTION_SIZE_BUFFER:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 error = log_buf_len;
1145 break;
1146 default:
1147 error = -EINVAL;
1148 break;
1149 }
1150out:
1151 return error;
1152}
1153
Heiko Carstens1e7bfb22009-01-14 14:14:29 +01001154SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155{
Kees Cook00234592010-02-03 15:36:43 -08001156 return do_syslog(type, buf, len, SYSLOG_FROM_CALL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157}
1158
Jason Wessel67fc4e02010-05-20 21:04:21 -05001159#ifdef CONFIG_KGDB_KDB
1160/* kdb dmesg command needs access to the syslog buffer. do_syslog()
1161 * uses locks so it cannot be used during debugging. Just tell kdb
1162 * where the start and end of the physical and logical logs are. This
1163 * is equivalent to do_syslog(3).
1164 */
1165void kdb_syslog_data(char *syslog_data[4])
1166{
1167 syslog_data[0] = log_buf;
1168 syslog_data[1] = log_buf + log_buf_len;
Kay Sievers7ff95542012-05-03 02:29:13 +02001169 syslog_data[2] = log_buf + log_first_idx;
1170 syslog_data[3] = log_buf + log_next_idx;
Jason Wessel67fc4e02010-05-20 21:04:21 -05001171}
1172#endif /* CONFIG_KGDB_KDB */
1173
Rusty Russell2329abf2012-01-13 09:32:18 +10301174static bool __read_mostly ignore_loglevel;
Ingo Molnar792908222006-12-06 20:40:51 -08001175
Adrian Bunk99eea6a2006-12-22 01:07:00 -08001176static int __init ignore_loglevel_setup(char *str)
Ingo Molnar792908222006-12-06 20:40:51 -08001177{
1178 ignore_loglevel = 1;
1179 printk(KERN_INFO "debug: ignoring loglevel setting.\n");
1180
Ingo Molnarc4772d92008-01-31 22:45:23 +01001181 return 0;
Ingo Molnar792908222006-12-06 20:40:51 -08001182}
1183
Ingo Molnarc4772d92008-01-31 22:45:23 +01001184early_param("ignore_loglevel", ignore_loglevel_setup);
Rusty Russell29d4d6d2012-01-13 09:32:17 +10301185module_param(ignore_loglevel, bool, S_IRUGO | S_IWUSR);
Yanmin Zhang0eca6b72011-10-31 17:11:25 -07001186MODULE_PARM_DESC(ignore_loglevel, "ignore loglevel setting, to"
1187 "print all kernel messages to the console.");
Ingo Molnar792908222006-12-06 20:40:51 -08001188
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190 * Call the console drivers, asking them to write out
1191 * log_buf[start] to log_buf[end - 1].
Torben Hohnac751ef2011-01-25 15:07:35 -08001192 * The console_lock must be held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 */
Kay Sievers7ff95542012-05-03 02:29:13 +02001194static void call_console_drivers(int level, const char *text, size_t len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195{
Kay Sievers7ff95542012-05-03 02:29:13 +02001196 struct console *con;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197
Kay Sievers7ff95542012-05-03 02:29:13 +02001198 trace_console(text, 0, len, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199
Kay Sievers7ff95542012-05-03 02:29:13 +02001200 if (level >= console_loglevel && !ignore_loglevel)
1201 return;
1202 if (!console_drivers)
1203 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204
Kay Sievers7ff95542012-05-03 02:29:13 +02001205 for_each_console(con) {
1206 if (exclusive_console && con != exclusive_console)
1207 continue;
1208 if (!(con->flags & CON_ENABLED))
1209 continue;
1210 if (!con->write)
1211 continue;
1212 if (!cpu_online(smp_processor_id()) &&
1213 !(con->flags & CON_ANYTIME))
1214 continue;
1215 con->write(con, text, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217}
1218
1219/*
1220 * Zap console related locks when oopsing. Only zap at most once
1221 * every 10 seconds, to leave time for slow consoles to print a
1222 * full oops.
1223 */
1224static void zap_locks(void)
1225{
1226 static unsigned long oops_timestamp;
1227
1228 if (time_after_eq(jiffies, oops_timestamp) &&
Jesper Juhl40dc5652005-10-30 15:02:46 -08001229 !time_after(jiffies, oops_timestamp + 30 * HZ))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 return;
1231
1232 oops_timestamp = jiffies;
1233
Peter Zijlstra94d24fc2011-06-07 11:17:30 +02001234 debug_locks_off();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 /* If a crash is occurring, make sure we can't deadlock */
Thomas Gleixner07354eb2009-07-25 17:50:36 +02001236 raw_spin_lock_init(&logbuf_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 /* And make sure that we print immediately */
Thomas Gleixner5b8c4f22010-09-07 14:33:43 +00001238 sema_init(&console_sem, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239}
1240
Michael Ellerman76a8ad22006-06-25 05:47:40 -07001241/* Check if we have any console registered that can be called early in boot. */
1242static int have_callable_console(void)
1243{
1244 struct console *con;
1245
Robin Getz4d091612009-07-01 21:08:37 -04001246 for_each_console(con)
Michael Ellerman76a8ad22006-06-25 05:47:40 -07001247 if (con->flags & CON_ANYTIME)
1248 return 1;
1249
1250 return 0;
1251}
1252
Linus Torvalds266c2e02008-03-24 19:25:08 -07001253/*
1254 * Can we actually use the console at this time on this cpu?
1255 *
1256 * Console drivers may assume that per-cpu resources have
1257 * been allocated. So unless they're explicitly marked as
1258 * being able to cope (CON_ANYTIME) don't call them until
1259 * this CPU is officially up.
1260 */
1261static inline int can_use_console(unsigned int cpu)
1262{
1263 return cpu_online(cpu) || have_callable_console();
1264}
1265
1266/*
1267 * Try to get console ownership to actually show the kernel
1268 * messages from a 'printk'. Return true (and with the
Torben Hohnac751ef2011-01-25 15:07:35 -08001269 * console_lock held, and 'console_locked' set) if it
Linus Torvalds266c2e02008-03-24 19:25:08 -07001270 * is successful, false otherwise.
1271 *
1272 * This gets called with the 'logbuf_lock' spinlock held and
1273 * interrupts disabled. It should return with 'lockbuf_lock'
1274 * released but interrupts still disabled.
1275 */
Torben Hohnac751ef2011-01-25 15:07:35 -08001276static int console_trylock_for_printk(unsigned int cpu)
Namhyung Kim8155c022010-10-26 14:22:47 -07001277 __releases(&logbuf_lock)
Linus Torvalds266c2e02008-03-24 19:25:08 -07001278{
Peter Zijlstra0b5e1c52011-06-07 11:15:33 +02001279 int retval = 0, wake = 0;
Linus Torvalds266c2e02008-03-24 19:25:08 -07001280
Torben Hohnac751ef2011-01-25 15:07:35 -08001281 if (console_trylock()) {
Linus Torvalds093a07e2008-04-15 13:09:54 -07001282 retval = 1;
1283
1284 /*
1285 * If we can't use the console, we need to release
1286 * the console semaphore by hand to avoid flushing
1287 * the buffer. We need to hold the console semaphore
1288 * in order to do this test safely.
1289 */
1290 if (!can_use_console(cpu)) {
1291 console_locked = 0;
Peter Zijlstra0b5e1c52011-06-07 11:15:33 +02001292 wake = 1;
Linus Torvalds093a07e2008-04-15 13:09:54 -07001293 retval = 0;
1294 }
1295 }
Kay Sievers7ff95542012-05-03 02:29:13 +02001296 logbuf_cpu = UINT_MAX;
Peter Zijlstra0b5e1c52011-06-07 11:15:33 +02001297 if (wake)
1298 up(&console_sem);
Thomas Gleixner07354eb2009-07-25 17:50:36 +02001299 raw_spin_unlock(&logbuf_lock);
Linus Torvalds266c2e02008-03-24 19:25:08 -07001300 return retval;
1301}
Ingo Molnar32a76002008-01-25 21:07:58 +01001302
Dave Youngaf913222009-09-22 16:43:33 -07001303int printk_delay_msec __read_mostly;
1304
1305static inline void printk_delay(void)
1306{
1307 if (unlikely(printk_delay_msec)) {
1308 int m = printk_delay_msec;
1309
1310 while (m--) {
1311 mdelay(1);
1312 touch_nmi_watchdog();
1313 }
1314 }
1315}
1316
Kay Sievers084681d2012-06-28 09:38:53 +02001317/*
1318 * Continuation lines are buffered, and not committed to the record buffer
1319 * until the line is complete, or a race forces it. The line fragments
1320 * though, are printed immediately to the consoles to ensure everything has
1321 * reached the console in case of a kernel crash.
1322 */
1323static struct cont {
1324 char buf[LOG_LINE_MAX];
1325 size_t len; /* length == 0 means unused buffer */
1326 size_t cons; /* bytes written to console */
1327 struct task_struct *owner; /* task of first print*/
1328 u64 ts_nsec; /* time of first print */
1329 u8 level; /* log level of first message */
1330 u8 facility; /* log level of first message */
1331 bool flushed:1; /* buffer sealed and committed */
1332} cont;
1333
1334static void cont_flush(void)
1335{
1336 if (cont.flushed)
1337 return;
1338 if (cont.len == 0)
1339 return;
1340
1341 log_store(cont.facility, cont.level, LOG_NOCONS, cont.ts_nsec,
1342 NULL, 0, cont.buf, cont.len);
1343
1344 cont.flushed = true;
1345}
1346
1347static bool cont_add(int facility, int level, const char *text, size_t len)
1348{
1349 if (cont.len && cont.flushed)
1350 return false;
1351
1352 if (cont.len + len > sizeof(cont.buf)) {
1353 cont_flush();
1354 return false;
1355 }
1356
1357 if (!cont.len) {
1358 cont.facility = facility;
1359 cont.level = level;
1360 cont.owner = current;
1361 cont.ts_nsec = local_clock();
1362 cont.cons = 0;
1363 cont.flushed = false;
1364 }
1365
1366 memcpy(cont.buf + cont.len, text, len);
1367 cont.len += len;
1368 return true;
1369}
1370
1371static size_t cont_print_text(char *text, size_t size)
1372{
1373 size_t textlen = 0;
1374 size_t len;
1375
1376 if (cont.cons == 0) {
1377 textlen += print_time(cont.ts_nsec, text);
1378 size -= textlen;
1379 }
1380
1381 len = cont.len - cont.cons;
1382 if (len > 0) {
1383 if (len+1 > size)
1384 len = size-1;
1385 memcpy(text + textlen, cont.buf + cont.cons, len);
1386 textlen += len;
1387 cont.cons = cont.len;
1388 }
1389
1390 if (cont.flushed) {
1391 text[textlen++] = '\n';
1392 /* got everything, release buffer */
1393 cont.len = 0;
1394 }
1395 return textlen;
1396}
1397
Kay Sievers7ff95542012-05-03 02:29:13 +02001398asmlinkage int vprintk_emit(int facility, int level,
1399 const char *dict, size_t dictlen,
1400 const char *fmt, va_list args)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401{
Kay Sievers7ff95542012-05-03 02:29:13 +02001402 static int recursion_bug;
Kay Sievers7ff95542012-05-03 02:29:13 +02001403 static char textbuf[LOG_LINE_MAX];
1404 char *text = textbuf;
Kay Sieversc313af12012-05-14 20:46:27 +02001405 size_t text_len;
Nick Andrewac60ad72008-05-12 21:21:04 +02001406 unsigned long flags;
Ingo Molnar32a76002008-01-25 21:07:58 +01001407 int this_cpu;
Kay Sievers7ff95542012-05-03 02:29:13 +02001408 bool newline = false;
Kay Sievers5c5d5ca2012-05-10 04:32:53 +02001409 bool prefix = false;
Kay Sievers7ff95542012-05-03 02:29:13 +02001410 int printed_len = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411
Randy Dunlapbfe8df32007-10-16 01:23:46 -07001412 boot_delay_msec();
Dave Youngaf913222009-09-22 16:43:33 -07001413 printk_delay();
Randy Dunlapbfe8df32007-10-16 01:23:46 -07001414
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415 /* This stops the holder of console_sem just where we want him */
Peter Zijlstra1a9a8ae2011-06-07 11:17:30 +02001416 local_irq_save(flags);
Ingo Molnar32a76002008-01-25 21:07:58 +01001417 this_cpu = smp_processor_id();
1418
1419 /*
1420 * Ouch, printk recursed into itself!
1421 */
Kay Sievers7ff95542012-05-03 02:29:13 +02001422 if (unlikely(logbuf_cpu == this_cpu)) {
Ingo Molnar32a76002008-01-25 21:07:58 +01001423 /*
1424 * If a crash is occurring during printk() on this CPU,
1425 * then try to get the crash message out but make sure
1426 * we can't deadlock. Otherwise just return to avoid the
1427 * recursion and return - but flag the recursion so that
1428 * it can be printed at the next appropriate moment:
1429 */
Peter Zijlstra94d24fc2011-06-07 11:17:30 +02001430 if (!oops_in_progress && !lockdep_recursing(current)) {
Tejun Heo3b8945e2008-05-12 21:21:04 +02001431 recursion_bug = 1;
Ingo Molnar32a76002008-01-25 21:07:58 +01001432 goto out_restore_irqs;
1433 }
1434 zap_locks();
1435 }
1436
Ingo Molnara0f1ccf2006-07-03 00:24:58 -07001437 lockdep_off();
Thomas Gleixner07354eb2009-07-25 17:50:36 +02001438 raw_spin_lock(&logbuf_lock);
Kay Sievers7ff95542012-05-03 02:29:13 +02001439 logbuf_cpu = this_cpu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
Tejun Heo3b8945e2008-05-12 21:21:04 +02001441 if (recursion_bug) {
Kay Sievers7ff95542012-05-03 02:29:13 +02001442 static const char recursion_msg[] =
1443 "BUG: recent printk recursion!";
1444
Tejun Heo3b8945e2008-05-12 21:21:04 +02001445 recursion_bug = 0;
Kay Sievers7ff95542012-05-03 02:29:13 +02001446 printed_len += strlen(recursion_msg);
1447 /* emit KERN_CRIT message */
Kay Sievers084681d2012-06-28 09:38:53 +02001448 log_store(0, 2, LOG_DEFAULT, 0,
1449 NULL, 0, recursion_msg, printed_len);
Linus Torvalds5fd29d62009-06-16 10:57:02 -07001450 }
1451
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 /*
Kay Sievers7ff95542012-05-03 02:29:13 +02001453 * The printf needs to come first; we need the syslog
1454 * prefix which might be passed-in as a parameter.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 */
Kay Sieversc313af12012-05-14 20:46:27 +02001456 text_len = vscnprintf(text, sizeof(textbuf), fmt, args);
Nick Andrewac60ad72008-05-12 21:21:04 +02001457
Kay Sievers7ff95542012-05-03 02:29:13 +02001458 /* mark and strip a trailing newline */
Kay Sieversc313af12012-05-14 20:46:27 +02001459 if (text_len && text[text_len-1] == '\n') {
1460 text_len--;
Kay Sievers7ff95542012-05-03 02:29:13 +02001461 newline = true;
1462 }
Kay Sievers9d90c8d2011-03-13 03:19:51 +01001463
Kay Sieversc313af12012-05-14 20:46:27 +02001464 /* strip syslog prefix and extract log level or control flags */
Kay Sievers7ff95542012-05-03 02:29:13 +02001465 if (text[0] == '<' && text[1] && text[2] == '>') {
1466 switch (text[1]) {
1467 case '0' ... '7':
1468 if (level == -1)
1469 level = text[1] - '0';
Kay Sievers7ff95542012-05-03 02:29:13 +02001470 case 'd': /* KERN_DEFAULT */
Kay Sievers5c5d5ca2012-05-10 04:32:53 +02001471 prefix = true;
1472 case 'c': /* KERN_CONT */
Kay Sievers7ff95542012-05-03 02:29:13 +02001473 text += 3;
Kay Sieversc313af12012-05-14 20:46:27 +02001474 text_len -= 3;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 }
Kay Sievers7ff95542012-05-03 02:29:13 +02001476 }
Nick Andrewac60ad72008-05-12 21:21:04 +02001477
Kay Sieversc313af12012-05-14 20:46:27 +02001478 if (level == -1)
1479 level = default_message_loglevel;
1480
1481 if (dict) {
1482 prefix = true;
1483 newline = true;
Kay Sievers7ff95542012-05-03 02:29:13 +02001484 }
1485
Kay Sieversc313af12012-05-14 20:46:27 +02001486 if (!newline) {
Kay Sievers084681d2012-06-28 09:38:53 +02001487 /*
1488 * Flush the conflicting buffer. An earlier newline was missing,
1489 * or another task also prints continuation lines.
1490 */
1491 if (cont.len && (prefix || cont.owner != current))
1492 cont_flush();
Kay Sieversc313af12012-05-14 20:46:27 +02001493
Kay Sievers084681d2012-06-28 09:38:53 +02001494 /* buffer line if possible, otherwise store it right away */
1495 if (!cont_add(facility, level, text, text_len))
1496 log_store(facility, level, LOG_DEFAULT, 0,
Kay Sieversc313af12012-05-14 20:46:27 +02001497 dict, dictlen, text, text_len);
Kay Sievers084681d2012-06-28 09:38:53 +02001498 } else {
1499 bool stored = false;
1500
1501 /*
Steven Rostedtd3620822012-06-29 11:40:11 -04001502 * If an earlier newline was missing and it was the same task,
1503 * either merge it with the current buffer and flush, or if
1504 * there was a race with interrupts (prefix == true) then just
1505 * flush it out and store this line separately.
Kay Sievers084681d2012-06-28 09:38:53 +02001506 */
Kay Sievers084681d2012-06-28 09:38:53 +02001507 if (cont.len && cont.owner == current) {
Steven Rostedtd3620822012-06-29 11:40:11 -04001508 if (!prefix)
1509 stored = cont_add(facility, level, text, text_len);
Kay Sievers084681d2012-06-28 09:38:53 +02001510 cont_flush();
Kay Sieversc313af12012-05-14 20:46:27 +02001511 }
Kay Sievers084681d2012-06-28 09:38:53 +02001512
1513 if (!stored)
1514 log_store(facility, level, LOG_DEFAULT, 0,
1515 dict, dictlen, text, text_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 }
Kay Sievers084681d2012-06-28 09:38:53 +02001517 printed_len += text_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518
Linus Torvalds266c2e02008-03-24 19:25:08 -07001519 /*
Kay Sievers7ff95542012-05-03 02:29:13 +02001520 * Try to acquire and then immediately release the console semaphore.
1521 * The release will print out buffers and wake up /dev/kmsg and syslog()
1522 * users.
Linus Torvalds266c2e02008-03-24 19:25:08 -07001523 *
Kay Sievers7ff95542012-05-03 02:29:13 +02001524 * The console_trylock_for_printk() function will release 'logbuf_lock'
1525 * regardless of whether it actually gets the console semaphore or not.
Linus Torvalds266c2e02008-03-24 19:25:08 -07001526 */
Torben Hohnac751ef2011-01-25 15:07:35 -08001527 if (console_trylock_for_printk(this_cpu))
1528 console_unlock();
Michael Ellerman76a8ad22006-06-25 05:47:40 -07001529
Linus Torvalds266c2e02008-03-24 19:25:08 -07001530 lockdep_on();
Ingo Molnar32a76002008-01-25 21:07:58 +01001531out_restore_irqs:
Peter Zijlstra1a9a8ae2011-06-07 11:17:30 +02001532 local_irq_restore(flags);
Michael Ellerman76a8ad22006-06-25 05:47:40 -07001533
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 return printed_len;
1535}
Kay Sievers7ff95542012-05-03 02:29:13 +02001536EXPORT_SYMBOL(vprintk_emit);
1537
1538asmlinkage int vprintk(const char *fmt, va_list args)
1539{
1540 return vprintk_emit(0, -1, NULL, 0, fmt, args);
1541}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542EXPORT_SYMBOL(vprintk);
1543
Kay Sievers7ff95542012-05-03 02:29:13 +02001544asmlinkage int printk_emit(int facility, int level,
1545 const char *dict, size_t dictlen,
1546 const char *fmt, ...)
1547{
1548 va_list args;
1549 int r;
1550
1551 va_start(args, fmt);
1552 r = vprintk_emit(facility, level, dict, dictlen, fmt, args);
1553 va_end(args);
1554
1555 return r;
1556}
1557EXPORT_SYMBOL(printk_emit);
1558
1559/**
1560 * printk - print a kernel message
1561 * @fmt: format string
1562 *
1563 * This is printk(). It can be called from any context. We want it to work.
1564 *
1565 * We try to grab the console_lock. If we succeed, it's easy - we log the
1566 * output and call the console drivers. If we fail to get the semaphore, we
1567 * place the output into the log buffer and return. The current holder of
1568 * the console_sem will notice the new output in console_unlock(); and will
1569 * send it to the consoles before releasing the lock.
1570 *
1571 * One effect of this deferred printing is that code which calls printk() and
1572 * then changes console_loglevel may break. This is because console_loglevel
1573 * is inspected when the actual printing occurs.
1574 *
1575 * See also:
1576 * printf(3)
1577 *
1578 * See the vsnprintf() documentation for format string extensions over C99.
1579 */
1580asmlinkage int printk(const char *fmt, ...)
1581{
1582 va_list args;
1583 int r;
1584
1585#ifdef CONFIG_KGDB_KDB
1586 if (unlikely(kdb_trap_printk)) {
1587 va_start(args, fmt);
1588 r = vkdb_printf(fmt, args);
1589 va_end(args);
1590 return r;
1591 }
1592#endif
1593 va_start(args, fmt);
1594 r = vprintk_emit(0, -1, NULL, 0, fmt, args);
1595 va_end(args);
1596
1597 return r;
1598}
1599EXPORT_SYMBOL(printk);
Kay Sievers7f3a7812012-05-09 01:37:51 +02001600
Matt Mackalld59745c2005-05-01 08:59:02 -07001601#else
1602
Kay Sievers7f3a7812012-05-09 01:37:51 +02001603#define LOG_LINE_MAX 0
Kay Sievers084681d2012-06-28 09:38:53 +02001604static struct cont {
1605 size_t len;
1606 size_t cons;
1607 u8 level;
1608 bool flushed:1;
1609} cont;
Kay Sievers7f3a7812012-05-09 01:37:51 +02001610static struct log *log_from_idx(u32 idx) { return NULL; }
1611static u32 log_next(u32 idx) { return 0; }
Kay Sievers7f3a7812012-05-09 01:37:51 +02001612static void call_console_drivers(int level, const char *text, size_t len) {}
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001613static size_t msg_print_text(const struct log *msg, bool syslog,
1614 char *buf, size_t size) { return 0; }
Kay Sievers084681d2012-06-28 09:38:53 +02001615static size_t cont_print_text(char *text, size_t size) { return 0; }
Matt Mackalld59745c2005-05-01 08:59:02 -07001616
Kay Sievers7f3a7812012-05-09 01:37:51 +02001617#endif /* CONFIG_PRINTK */
Matt Mackalld59745c2005-05-01 08:59:02 -07001618
Samuel Thibaultf7511d52008-04-30 00:54:51 -07001619static int __add_preferred_console(char *name, int idx, char *options,
1620 char *brl_options)
1621{
1622 struct console_cmdline *c;
1623 int i;
1624
1625 /*
1626 * See if this tty is not yet registered, and
1627 * if we have a slot free.
1628 */
1629 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
1630 if (strcmp(console_cmdline[i].name, name) == 0 &&
1631 console_cmdline[i].index == idx) {
1632 if (!brl_options)
1633 selected_console = i;
1634 return 0;
1635 }
1636 if (i == MAX_CMDLINECONSOLES)
1637 return -E2BIG;
1638 if (!brl_options)
1639 selected_console = i;
1640 c = &console_cmdline[i];
1641 strlcpy(c->name, name, sizeof(c->name));
1642 c->options = options;
1643#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1644 c->brl_options = brl_options;
1645#endif
1646 c->index = idx;
1647 return 0;
1648}
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001649/*
1650 * Set up a list of consoles. Called from init/main.c
1651 */
1652static int __init console_setup(char *str)
1653{
Yinghai Lueaa944a2007-07-15 23:37:27 -07001654 char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for index */
Samuel Thibaultf7511d52008-04-30 00:54:51 -07001655 char *s, *options, *brl_options = NULL;
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001656 int idx;
1657
Samuel Thibaultf7511d52008-04-30 00:54:51 -07001658#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1659 if (!memcmp(str, "brl,", 4)) {
1660 brl_options = "";
1661 str += 4;
1662 } else if (!memcmp(str, "brl=", 4)) {
1663 brl_options = str + 4;
1664 str = strchr(brl_options, ',');
1665 if (!str) {
1666 printk(KERN_ERR "need port name after brl=\n");
1667 return 1;
1668 }
1669 *(str++) = 0;
1670 }
1671#endif
1672
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001673 /*
1674 * Decode str into name, index, options.
1675 */
1676 if (str[0] >= '0' && str[0] <= '9') {
Yinghai Lueaa944a2007-07-15 23:37:27 -07001677 strcpy(buf, "ttyS");
1678 strncpy(buf + 4, str, sizeof(buf) - 5);
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001679 } else {
Yinghai Lueaa944a2007-07-15 23:37:27 -07001680 strncpy(buf, str, sizeof(buf) - 1);
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001681 }
Yinghai Lueaa944a2007-07-15 23:37:27 -07001682 buf[sizeof(buf) - 1] = 0;
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001683 if ((options = strchr(str, ',')) != NULL)
1684 *(options++) = 0;
1685#ifdef __sparc__
1686 if (!strcmp(str, "ttya"))
Yinghai Lueaa944a2007-07-15 23:37:27 -07001687 strcpy(buf, "ttyS0");
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001688 if (!strcmp(str, "ttyb"))
Yinghai Lueaa944a2007-07-15 23:37:27 -07001689 strcpy(buf, "ttyS1");
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001690#endif
Yinghai Lueaa944a2007-07-15 23:37:27 -07001691 for (s = buf; *s; s++)
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001692 if ((*s >= '0' && *s <= '9') || *s == ',')
1693 break;
1694 idx = simple_strtoul(s, NULL, 10);
1695 *s = 0;
1696
Samuel Thibaultf7511d52008-04-30 00:54:51 -07001697 __add_preferred_console(buf, idx, options, brl_options);
Markus Armbruster9e124fe2008-05-26 23:31:07 +01001698 console_set_on_cmdline = 1;
John Z. Bohach2ea1c532006-03-24 03:18:19 -08001699 return 1;
1700}
1701__setup("console=", console_setup);
1702
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703/**
Matt Mackall3c0547b2005-05-16 21:53:47 -07001704 * add_preferred_console - add a device to the list of preferred consoles.
Martin Waitzddad86c2005-11-13 16:08:14 -08001705 * @name: device name
1706 * @idx: device index
1707 * @options: options for this console
Matt Mackall3c0547b2005-05-16 21:53:47 -07001708 *
1709 * The last preferred console added will be used for kernel messages
1710 * and stdin/out/err for init. Normally this is used by console_setup
1711 * above to handle user-supplied console arguments; however it can also
1712 * be used by arch-specific code either to override the user or more
1713 * commonly to provide a default console (ie from PROM variables) when
1714 * the user has not supplied one.
1715 */
David S. Millerfb445ee2007-12-29 01:19:49 -08001716int add_preferred_console(char *name, int idx, char *options)
Matt Mackall3c0547b2005-05-16 21:53:47 -07001717{
Samuel Thibaultf7511d52008-04-30 00:54:51 -07001718 return __add_preferred_console(name, idx, options, NULL);
Matt Mackall3c0547b2005-05-16 21:53:47 -07001719}
1720
Daniel Ritzb6b1d872007-08-03 16:07:43 +02001721int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options)
Yinghai Lu18a8bd92007-07-15 23:37:59 -07001722{
1723 struct console_cmdline *c;
1724 int i;
1725
1726 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
1727 if (strcmp(console_cmdline[i].name, name) == 0 &&
1728 console_cmdline[i].index == idx) {
1729 c = &console_cmdline[i];
Markus Armbrusterf7352952008-04-30 00:54:52 -07001730 strlcpy(c->name, name_new, sizeof(c->name));
Yinghai Lu18a8bd92007-07-15 23:37:59 -07001731 c->name[sizeof(c->name) - 1] = 0;
1732 c->options = options;
1733 c->index = idx_new;
1734 return i;
1735 }
1736 /* not found */
1737 return -1;
1738}
1739
Rusty Russell2329abf2012-01-13 09:32:18 +10301740bool console_suspend_enabled = 1;
Andres Salomon8f4ce8c2007-10-18 03:04:50 -07001741EXPORT_SYMBOL(console_suspend_enabled);
1742
1743static int __init console_suspend_disable(char *str)
1744{
1745 console_suspend_enabled = 0;
1746 return 1;
1747}
1748__setup("no_console_suspend", console_suspend_disable);
Yanmin Zhang134620f2011-10-31 17:11:27 -07001749module_param_named(console_suspend, console_suspend_enabled,
1750 bool, S_IRUGO | S_IWUSR);
1751MODULE_PARM_DESC(console_suspend, "suspend console during suspend"
1752 " and hibernate operations");
Andres Salomon8f4ce8c2007-10-18 03:04:50 -07001753
Matt Mackall3c0547b2005-05-16 21:53:47 -07001754/**
Linus Torvalds557240b2006-06-19 18:16:01 -07001755 * suspend_console - suspend the console subsystem
1756 *
1757 * This disables printk() while we go into suspend states
1758 */
1759void suspend_console(void)
1760{
Andres Salomon8f4ce8c2007-10-18 03:04:50 -07001761 if (!console_suspend_enabled)
1762 return;
Pavel Machek0d630812008-07-23 21:28:32 -07001763 printk("Suspending console(s) (use no_console_suspend to debug)\n");
Torben Hohnac751ef2011-01-25 15:07:35 -08001764 console_lock();
Linus Torvalds557240b2006-06-19 18:16:01 -07001765 console_suspended = 1;
Arve Hjønnevåg403f3072009-02-14 02:07:24 +01001766 up(&console_sem);
Linus Torvalds557240b2006-06-19 18:16:01 -07001767}
1768
1769void resume_console(void)
1770{
Andres Salomon8f4ce8c2007-10-18 03:04:50 -07001771 if (!console_suspend_enabled)
1772 return;
Arve Hjønnevåg403f3072009-02-14 02:07:24 +01001773 down(&console_sem);
Linus Torvalds557240b2006-06-19 18:16:01 -07001774 console_suspended = 0;
Torben Hohnac751ef2011-01-25 15:07:35 -08001775 console_unlock();
Linus Torvalds557240b2006-06-19 18:16:01 -07001776}
1777
1778/**
Kevin Cernekee034260d2010-06-03 22:11:25 -07001779 * console_cpu_notify - print deferred console messages after CPU hotplug
1780 * @self: notifier struct
1781 * @action: CPU hotplug event
1782 * @hcpu: unused
1783 *
1784 * If printk() is called from a CPU that is not online yet, the messages
1785 * will be spooled but will not show up on the console. This function is
1786 * called when a new CPU comes online (or fails to come up), and ensures
1787 * that any such output gets printed.
1788 */
1789static int __cpuinit console_cpu_notify(struct notifier_block *self,
1790 unsigned long action, void *hcpu)
1791{
1792 switch (action) {
1793 case CPU_ONLINE:
1794 case CPU_DEAD:
1795 case CPU_DYING:
1796 case CPU_DOWN_FAILED:
1797 case CPU_UP_CANCELED:
Torben Hohnac751ef2011-01-25 15:07:35 -08001798 console_lock();
1799 console_unlock();
Kevin Cernekee034260d2010-06-03 22:11:25 -07001800 }
1801 return NOTIFY_OK;
1802}
1803
1804/**
Torben Hohnac751ef2011-01-25 15:07:35 -08001805 * console_lock - lock the console system for exclusive use.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 *
Torben Hohnac751ef2011-01-25 15:07:35 -08001807 * Acquires a lock which guarantees that the caller has
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 * exclusive access to the console system and the console_drivers list.
1809 *
1810 * Can sleep, returns nothing.
1811 */
Torben Hohnac751ef2011-01-25 15:07:35 -08001812void console_lock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813{
Eric Sesterhenn8abd8e22006-04-01 01:21:17 +02001814 BUG_ON(in_interrupt());
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 down(&console_sem);
Arve Hjønnevåg403f3072009-02-14 02:07:24 +01001816 if (console_suspended)
1817 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818 console_locked = 1;
1819 console_may_schedule = 1;
1820}
Torben Hohnac751ef2011-01-25 15:07:35 -08001821EXPORT_SYMBOL(console_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
Torben Hohnac751ef2011-01-25 15:07:35 -08001823/**
1824 * console_trylock - try to lock the console system for exclusive use.
1825 *
1826 * Tried to acquire a lock which guarantees that the caller has
1827 * exclusive access to the console system and the console_drivers list.
1828 *
1829 * returns 1 on success, and 0 on failure to acquire the lock.
1830 */
1831int console_trylock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832{
1833 if (down_trylock(&console_sem))
Torben Hohnac751ef2011-01-25 15:07:35 -08001834 return 0;
Arve Hjønnevåg403f3072009-02-14 02:07:24 +01001835 if (console_suspended) {
1836 up(&console_sem);
Torben Hohnac751ef2011-01-25 15:07:35 -08001837 return 0;
Arve Hjønnevåg403f3072009-02-14 02:07:24 +01001838 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839 console_locked = 1;
1840 console_may_schedule = 0;
Torben Hohnac751ef2011-01-25 15:07:35 -08001841 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842}
Torben Hohnac751ef2011-01-25 15:07:35 -08001843EXPORT_SYMBOL(console_trylock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844
1845int is_console_locked(void)
1846{
1847 return console_locked;
1848}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849
Peter Zijlstra3ccf3e82012-02-27 10:47:00 +01001850/*
Kay Sievers7ff95542012-05-03 02:29:13 +02001851 * Delayed printk version, for scheduler-internal messages:
Peter Zijlstra3ccf3e82012-02-27 10:47:00 +01001852 */
1853#define PRINTK_BUF_SIZE 512
1854
1855#define PRINTK_PENDING_WAKEUP 0x01
1856#define PRINTK_PENDING_SCHED 0x02
1857
Peter Zijlstrab845b512008-08-08 21:47:09 +02001858static DEFINE_PER_CPU(int, printk_pending);
Peter Zijlstra3ccf3e82012-02-27 10:47:00 +01001859static DEFINE_PER_CPU(char [PRINTK_BUF_SIZE], printk_sched_buf);
Peter Zijlstrab845b512008-08-08 21:47:09 +02001860
1861void printk_tick(void)
1862{
Eric Dumazet40dc11f2010-11-26 17:22:16 +01001863 if (__this_cpu_read(printk_pending)) {
Peter Zijlstra3ccf3e82012-02-27 10:47:00 +01001864 int pending = __this_cpu_xchg(printk_pending, 0);
1865 if (pending & PRINTK_PENDING_SCHED) {
1866 char *buf = __get_cpu_var(printk_sched_buf);
1867 printk(KERN_WARNING "[sched_delayed] %s", buf);
1868 }
1869 if (pending & PRINTK_PENDING_WAKEUP)
1870 wake_up_interruptible(&log_wait);
Peter Zijlstrab845b512008-08-08 21:47:09 +02001871 }
1872}
1873
1874int printk_needs_cpu(int cpu)
1875{
Eric Dumazet40dc11f2010-11-26 17:22:16 +01001876 if (cpu_is_offline(cpu))
Heiko Carstens61ab25442010-11-26 13:00:59 +01001877 printk_tick();
Eric Dumazet40dc11f2010-11-26 17:22:16 +01001878 return __this_cpu_read(printk_pending);
Peter Zijlstrab845b512008-08-08 21:47:09 +02001879}
1880
Kirill Korotaeve3e8a752007-02-10 01:46:19 -08001881void wake_up_klogd(void)
1882{
Peter Zijlstrab845b512008-08-08 21:47:09 +02001883 if (waitqueue_active(&log_wait))
Peter Zijlstra3ccf3e82012-02-27 10:47:00 +01001884 this_cpu_or(printk_pending, PRINTK_PENDING_WAKEUP);
Kirill Korotaeve3e8a752007-02-10 01:46:19 -08001885}
1886
Kay Sievers7ff95542012-05-03 02:29:13 +02001887/* the next printk record to write to the console */
1888static u64 console_seq;
1889static u32 console_idx;
1890
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891/**
Torben Hohnac751ef2011-01-25 15:07:35 -08001892 * console_unlock - unlock the console system
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 *
Torben Hohnac751ef2011-01-25 15:07:35 -08001894 * Releases the console_lock which the caller holds on the console system
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895 * and the console driver list.
1896 *
Torben Hohnac751ef2011-01-25 15:07:35 -08001897 * While the console_lock was held, console output may have been buffered
1898 * by printk(). If this is the case, console_unlock(); emits
1899 * the output prior to releasing the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900 *
Kay Sievers7f3a7812012-05-09 01:37:51 +02001901 * If there is output waiting, we wake /dev/kmsg and syslog() users.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 *
Torben Hohnac751ef2011-01-25 15:07:35 -08001903 * console_unlock(); may be called from any context.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 */
Torben Hohnac751ef2011-01-25 15:07:35 -08001905void console_unlock(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906{
Kay Sievers084681d2012-06-28 09:38:53 +02001907 static char text[LOG_LINE_MAX];
Kay Sievers7ff95542012-05-03 02:29:13 +02001908 static u64 seen_seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 unsigned long flags;
Kay Sievers7ff95542012-05-03 02:29:13 +02001910 bool wake_klogd = false;
1911 bool retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912
Linus Torvalds557240b2006-06-19 18:16:01 -07001913 if (console_suspended) {
Arve Hjønnevåg403f3072009-02-14 02:07:24 +01001914 up(&console_sem);
Linus Torvalds557240b2006-06-19 18:16:01 -07001915 return;
1916 }
Antonino A. Daplas78944e52006-08-05 12:14:16 -07001917
1918 console_may_schedule = 0;
1919
Kay Sievers084681d2012-06-28 09:38:53 +02001920 /* flush buffered message fragment immediately to console */
1921 raw_spin_lock_irqsave(&logbuf_lock, flags);
1922 if (cont.len && (cont.cons < cont.len || cont.flushed)) {
1923 size_t len;
1924
1925 len = cont_print_text(text, sizeof(text));
1926 raw_spin_unlock(&logbuf_lock);
1927 stop_critical_timings();
1928 call_console_drivers(cont.level, text, len);
1929 start_critical_timings();
1930 local_irq_restore(flags);
1931 } else
1932 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
1933
Peter Zijlstra4f2a8d32011-06-22 11:20:09 +02001934again:
Kay Sievers7ff95542012-05-03 02:29:13 +02001935 for (;;) {
1936 struct log *msg;
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001937 size_t len;
Kay Sievers7ff95542012-05-03 02:29:13 +02001938 int level;
1939
Thomas Gleixner07354eb2009-07-25 17:50:36 +02001940 raw_spin_lock_irqsave(&logbuf_lock, flags);
Kay Sievers7ff95542012-05-03 02:29:13 +02001941 if (seen_seq != log_next_seq) {
1942 wake_klogd = true;
1943 seen_seq = log_next_seq;
1944 }
1945
1946 if (console_seq < log_first_seq) {
1947 /* messages are gone, move to first one */
1948 console_seq = log_first_seq;
1949 console_idx = log_first_idx;
1950 }
Kay Sievers084681d2012-06-28 09:38:53 +02001951skip:
Kay Sievers7ff95542012-05-03 02:29:13 +02001952 if (console_seq == log_next_seq)
1953 break;
1954
1955 msg = log_from_idx(console_idx);
Kay Sievers084681d2012-06-28 09:38:53 +02001956 if (msg->flags & LOG_NOCONS) {
1957 /*
1958 * Skip record we have buffered and already printed
1959 * directly to the console when we received it.
1960 */
1961 console_idx = log_next(console_idx);
1962 console_seq++;
1963 goto skip;
1964 }
Kay Sievers649e6ee2012-05-10 04:30:45 +02001965
Kay Sievers084681d2012-06-28 09:38:53 +02001966 level = msg->level;
Kay Sievers3ce9a7c2012-05-13 23:30:46 +02001967 len = msg_print_text(msg, false, text, sizeof(text));
Kay Sievers7ff95542012-05-03 02:29:13 +02001968
1969 console_idx = log_next(console_idx);
1970 console_seq++;
Thomas Gleixner07354eb2009-07-25 17:50:36 +02001971 raw_spin_unlock(&logbuf_lock);
Kay Sievers7ff95542012-05-03 02:29:13 +02001972
Steven Rostedt81d68a92008-05-12 21:20:42 +02001973 stop_critical_timings(); /* don't trace print latency */
Kay Sievers7ff95542012-05-03 02:29:13 +02001974 call_console_drivers(level, text, len);
Steven Rostedt81d68a92008-05-12 21:20:42 +02001975 start_critical_timings();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976 local_irq_restore(flags);
1977 }
1978 console_locked = 0;
Feng Tangfe3d8ad2011-03-22 16:34:21 -07001979
1980 /* Release the exclusive_console once it is used */
1981 if (unlikely(exclusive_console))
1982 exclusive_console = NULL;
1983
Thomas Gleixner07354eb2009-07-25 17:50:36 +02001984 raw_spin_unlock(&logbuf_lock);
Peter Zijlstra4f2a8d32011-06-22 11:20:09 +02001985
Peter Zijlstra0b5e1c52011-06-07 11:15:33 +02001986 up(&console_sem);
Peter Zijlstra4f2a8d32011-06-22 11:20:09 +02001987
1988 /*
1989 * Someone could have filled up the buffer again, so re-check if there's
1990 * something to flush. In case we cannot trylock the console_sem again,
1991 * there's a new owner and the console_unlock() from them will do the
1992 * flush, no worries.
1993 */
Thomas Gleixner07354eb2009-07-25 17:50:36 +02001994 raw_spin_lock(&logbuf_lock);
Kay Sievers7ff95542012-05-03 02:29:13 +02001995 retry = console_seq != log_next_seq;
Peter Zijlstra09dc3cf2011-12-08 14:34:13 -08001996 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
1997
Peter Zijlstra4f2a8d32011-06-22 11:20:09 +02001998 if (retry && console_trylock())
1999 goto again;
2000
Kirill Korotaeve3e8a752007-02-10 01:46:19 -08002001 if (wake_klogd)
2002 wake_up_klogd();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003}
Torben Hohnac751ef2011-01-25 15:07:35 -08002004EXPORT_SYMBOL(console_unlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005
Martin Waitzddad86c2005-11-13 16:08:14 -08002006/**
2007 * console_conditional_schedule - yield the CPU if required
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 *
2009 * If the console code is currently allowed to sleep, and
2010 * if this CPU should yield the CPU to another task, do
2011 * so here.
2012 *
Torben Hohnac751ef2011-01-25 15:07:35 -08002013 * Must be called within console_lock();.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 */
2015void __sched console_conditional_schedule(void)
2016{
2017 if (console_may_schedule)
2018 cond_resched();
2019}
2020EXPORT_SYMBOL(console_conditional_schedule);
2021
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022void console_unblank(void)
2023{
2024 struct console *c;
2025
2026 /*
2027 * console_unblank can no longer be called in interrupt context unless
2028 * oops_in_progress is set to 1..
2029 */
2030 if (oops_in_progress) {
2031 if (down_trylock(&console_sem) != 0)
2032 return;
2033 } else
Torben Hohnac751ef2011-01-25 15:07:35 -08002034 console_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035
2036 console_locked = 1;
2037 console_may_schedule = 0;
Robin Getz4d091612009-07-01 21:08:37 -04002038 for_each_console(c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039 if ((c->flags & CON_ENABLED) && c->unblank)
2040 c->unblank();
Torben Hohnac751ef2011-01-25 15:07:35 -08002041 console_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043
2044/*
2045 * Return the console tty driver structure and its associated index
2046 */
2047struct tty_driver *console_device(int *index)
2048{
2049 struct console *c;
2050 struct tty_driver *driver = NULL;
2051
Torben Hohnac751ef2011-01-25 15:07:35 -08002052 console_lock();
Robin Getz4d091612009-07-01 21:08:37 -04002053 for_each_console(c) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 if (!c->device)
2055 continue;
2056 driver = c->device(c, index);
2057 if (driver)
2058 break;
2059 }
Torben Hohnac751ef2011-01-25 15:07:35 -08002060 console_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061 return driver;
2062}
2063
2064/*
2065 * Prevent further output on the passed console device so that (for example)
2066 * serial drivers can disable console output before suspending a port, and can
2067 * re-enable output afterwards.
2068 */
2069void console_stop(struct console *console)
2070{
Torben Hohnac751ef2011-01-25 15:07:35 -08002071 console_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072 console->flags &= ~CON_ENABLED;
Torben Hohnac751ef2011-01-25 15:07:35 -08002073 console_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074}
2075EXPORT_SYMBOL(console_stop);
2076
2077void console_start(struct console *console)
2078{
Torben Hohnac751ef2011-01-25 15:07:35 -08002079 console_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 console->flags |= CON_ENABLED;
Torben Hohnac751ef2011-01-25 15:07:35 -08002081 console_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082}
2083EXPORT_SYMBOL(console_start);
2084
Fabio M. Di Nitto7bf69392011-03-22 16:34:20 -07002085static int __read_mostly keep_bootcon;
2086
2087static int __init keep_bootcon_setup(char *str)
2088{
2089 keep_bootcon = 1;
2090 printk(KERN_INFO "debug: skip boot console de-registration.\n");
2091
2092 return 0;
2093}
2094
2095early_param("keep_bootcon", keep_bootcon_setup);
2096
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097/*
2098 * The console driver calls this routine during kernel initialization
2099 * to register the console printing procedure with printk() and to
2100 * print any messages that were printed by the kernel before the
2101 * console driver was initialized.
Robin Getz4d091612009-07-01 21:08:37 -04002102 *
2103 * This can happen pretty early during the boot process (because of
2104 * early_printk) - sometimes before setup_arch() completes - be careful
2105 * of what kernel features are used - they may not be initialised yet.
2106 *
2107 * There are two types of consoles - bootconsoles (early_printk) and
2108 * "real" consoles (everything which is not a bootconsole) which are
2109 * handled differently.
2110 * - Any number of bootconsoles can be registered at any time.
2111 * - As soon as a "real" console is registered, all bootconsoles
2112 * will be unregistered automatically.
2113 * - Once a "real" console is registered, any attempt to register a
2114 * bootconsoles will be rejected
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 */
Robin Getz4d091612009-07-01 21:08:37 -04002116void register_console(struct console *newcon)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117{
Jesper Juhl40dc5652005-10-30 15:02:46 -08002118 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 unsigned long flags;
Robin Getz4d091612009-07-01 21:08:37 -04002120 struct console *bcon = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121
Robin Getz4d091612009-07-01 21:08:37 -04002122 /*
2123 * before we register a new CON_BOOT console, make sure we don't
2124 * already have a valid console
2125 */
2126 if (console_drivers && newcon->flags & CON_BOOT) {
2127 /* find the last or real console */
2128 for_each_console(bcon) {
2129 if (!(bcon->flags & CON_BOOT)) {
2130 printk(KERN_INFO "Too late to register bootconsole %s%d\n",
2131 newcon->name, newcon->index);
2132 return;
2133 }
2134 }
Gerd Hoffmann69331af2007-05-08 00:26:49 -07002135 }
2136
Robin Getz4d091612009-07-01 21:08:37 -04002137 if (console_drivers && console_drivers->flags & CON_BOOT)
2138 bcon = console_drivers;
2139
2140 if (preferred_console < 0 || bcon || !console_drivers)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 preferred_console = selected_console;
2142
Robin Getz4d091612009-07-01 21:08:37 -04002143 if (newcon->early_setup)
2144 newcon->early_setup();
Yinghai Lu18a8bd92007-07-15 23:37:59 -07002145
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 /*
2147 * See if we want to use this console driver. If we
2148 * didn't select a console we take the first one
2149 * that registers here.
2150 */
2151 if (preferred_console < 0) {
Robin Getz4d091612009-07-01 21:08:37 -04002152 if (newcon->index < 0)
2153 newcon->index = 0;
2154 if (newcon->setup == NULL ||
2155 newcon->setup(newcon, NULL) == 0) {
2156 newcon->flags |= CON_ENABLED;
2157 if (newcon->device) {
2158 newcon->flags |= CON_CONSDEV;
Jan Kiszkacd3a1b82008-05-12 21:21:04 +02002159 preferred_console = 0;
2160 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 }
2162 }
2163
2164 /*
2165 * See if this console matches one we selected on
2166 * the command line.
2167 */
Jesper Juhl40dc5652005-10-30 15:02:46 -08002168 for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0];
2169 i++) {
Robin Getz4d091612009-07-01 21:08:37 -04002170 if (strcmp(console_cmdline[i].name, newcon->name) != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 continue;
Robin Getz4d091612009-07-01 21:08:37 -04002172 if (newcon->index >= 0 &&
2173 newcon->index != console_cmdline[i].index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 continue;
Robin Getz4d091612009-07-01 21:08:37 -04002175 if (newcon->index < 0)
2176 newcon->index = console_cmdline[i].index;
Samuel Thibaultf7511d52008-04-30 00:54:51 -07002177#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
2178 if (console_cmdline[i].brl_options) {
Robin Getz4d091612009-07-01 21:08:37 -04002179 newcon->flags |= CON_BRL;
2180 braille_register_console(newcon,
Samuel Thibaultf7511d52008-04-30 00:54:51 -07002181 console_cmdline[i].index,
2182 console_cmdline[i].options,
2183 console_cmdline[i].brl_options);
2184 return;
2185 }
2186#endif
Robin Getz4d091612009-07-01 21:08:37 -04002187 if (newcon->setup &&
2188 newcon->setup(newcon, console_cmdline[i].options) != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 break;
Robin Getz4d091612009-07-01 21:08:37 -04002190 newcon->flags |= CON_ENABLED;
2191 newcon->index = console_cmdline[i].index;
Greg Edwardsab4af032005-06-23 00:09:05 -07002192 if (i == selected_console) {
Robin Getz4d091612009-07-01 21:08:37 -04002193 newcon->flags |= CON_CONSDEV;
Greg Edwardsab4af032005-06-23 00:09:05 -07002194 preferred_console = selected_console;
2195 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 break;
2197 }
2198
Robin Getz4d091612009-07-01 21:08:37 -04002199 if (!(newcon->flags & CON_ENABLED))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 return;
2201
Robin Getz8259cf42009-07-09 13:08:37 -04002202 /*
2203 * If we have a bootconsole, and are switching to a real console,
2204 * don't print everything out again, since when the boot console, and
2205 * the real console are the same physical device, it's annoying to
2206 * see the beginning boot messages twice
2207 */
2208 if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
Robin Getz4d091612009-07-01 21:08:37 -04002209 newcon->flags &= ~CON_PRINTBUFFER;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210
2211 /*
2212 * Put this console in the list - keep the
2213 * preferred driver at the head of the list.
2214 */
Torben Hohnac751ef2011-01-25 15:07:35 -08002215 console_lock();
Robin Getz4d091612009-07-01 21:08:37 -04002216 if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
2217 newcon->next = console_drivers;
2218 console_drivers = newcon;
2219 if (newcon->next)
2220 newcon->next->flags &= ~CON_CONSDEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 } else {
Robin Getz4d091612009-07-01 21:08:37 -04002222 newcon->next = console_drivers->next;
2223 console_drivers->next = newcon;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 }
Robin Getz4d091612009-07-01 21:08:37 -04002225 if (newcon->flags & CON_PRINTBUFFER) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 /*
Torben Hohnac751ef2011-01-25 15:07:35 -08002227 * console_unlock(); will print out the buffered messages
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 * for us.
2229 */
Thomas Gleixner07354eb2009-07-25 17:50:36 +02002230 raw_spin_lock_irqsave(&logbuf_lock, flags);
Kay Sievers7ff95542012-05-03 02:29:13 +02002231 console_seq = syslog_seq;
2232 console_idx = syslog_idx;
Thomas Gleixner07354eb2009-07-25 17:50:36 +02002233 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
Feng Tangfe3d8ad2011-03-22 16:34:21 -07002234 /*
2235 * We're about to replay the log buffer. Only do this to the
2236 * just-registered console to avoid excessive message spam to
2237 * the already-registered consoles.
2238 */
2239 exclusive_console = newcon;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240 }
Torben Hohnac751ef2011-01-25 15:07:35 -08002241 console_unlock();
Kay Sieversfbc92a32010-12-01 18:51:05 +01002242 console_sysfs_notify();
Robin Getz8259cf42009-07-09 13:08:37 -04002243
2244 /*
2245 * By unregistering the bootconsoles after we enable the real console
2246 * we get the "console xxx enabled" message on all the consoles -
2247 * boot consoles, real consoles, etc - this is to ensure that end
2248 * users know there might be something in the kernel's log buffer that
2249 * went to the bootconsole (that they do not see on the real console)
2250 */
Fabio M. Di Nitto7bf69392011-03-22 16:34:20 -07002251 if (bcon &&
2252 ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
2253 !keep_bootcon) {
Robin Getz8259cf42009-07-09 13:08:37 -04002254 /* we need to iterate through twice, to make sure we print
2255 * everything out, before we unregister the console(s)
2256 */
2257 printk(KERN_INFO "console [%s%d] enabled, bootconsole disabled\n",
2258 newcon->name, newcon->index);
2259 for_each_console(bcon)
2260 if (bcon->flags & CON_BOOT)
2261 unregister_console(bcon);
2262 } else {
2263 printk(KERN_INFO "%sconsole [%s%d] enabled\n",
2264 (newcon->flags & CON_BOOT) ? "boot" : "" ,
2265 newcon->name, newcon->index);
2266 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267}
2268EXPORT_SYMBOL(register_console);
2269
Jesper Juhl40dc5652005-10-30 15:02:46 -08002270int unregister_console(struct console *console)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271{
Jesper Juhl40dc5652005-10-30 15:02:46 -08002272 struct console *a, *b;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273 int res = 1;
2274
Samuel Thibaultf7511d52008-04-30 00:54:51 -07002275#ifdef CONFIG_A11Y_BRAILLE_CONSOLE
2276 if (console->flags & CON_BRL)
2277 return braille_unregister_console(console);
2278#endif
2279
Torben Hohnac751ef2011-01-25 15:07:35 -08002280 console_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281 if (console_drivers == console) {
2282 console_drivers=console->next;
2283 res = 0;
Benjamin Herrenschmidte9b15b52005-11-23 13:37:44 -08002284 } else if (console_drivers) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285 for (a=console_drivers->next, b=console_drivers ;
2286 a; b=a, a=b->next) {
2287 if (a == console) {
2288 b->next = a->next;
2289 res = 0;
2290 break;
Jesper Juhl40dc5652005-10-30 15:02:46 -08002291 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 }
2293 }
Jesper Juhl40dc5652005-10-30 15:02:46 -08002294
Gerd Hoffmann69331af2007-05-08 00:26:49 -07002295 /*
Greg Edwardsab4af032005-06-23 00:09:05 -07002296 * If this isn't the last console and it has CON_CONSDEV set, we
2297 * need to set it on the next preferred console.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 */
Gerd Hoffmann69331af2007-05-08 00:26:49 -07002299 if (console_drivers != NULL && console->flags & CON_CONSDEV)
Greg Edwardsab4af032005-06-23 00:09:05 -07002300 console_drivers->flags |= CON_CONSDEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301
Torben Hohnac751ef2011-01-25 15:07:35 -08002302 console_unlock();
Kay Sieversfbc92a32010-12-01 18:51:05 +01002303 console_sysfs_notify();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304 return res;
2305}
2306EXPORT_SYMBOL(unregister_console);
Matt Mackalld59745c2005-05-01 08:59:02 -07002307
Kevin Cernekee034260d2010-06-03 22:11:25 -07002308static int __init printk_late_init(void)
Robin Getz0c5564b2007-08-20 15:22:47 -04002309{
Robin Getz4d091612009-07-01 21:08:37 -04002310 struct console *con;
2311
2312 for_each_console(con) {
Nishanth Aravamudan4c30c6f2011-08-25 15:59:11 -07002313 if (!keep_bootcon && con->flags & CON_BOOT) {
Robin Getzcb00e992007-08-21 23:14:58 -04002314 printk(KERN_INFO "turn off boot console %s%d\n",
Robin Getz4d091612009-07-01 21:08:37 -04002315 con->name, con->index);
Sonic Zhang42c2c8c2009-08-06 15:58:11 -07002316 unregister_console(con);
Robin Getzcb00e992007-08-21 23:14:58 -04002317 }
Robin Getz0c5564b2007-08-20 15:22:47 -04002318 }
Kevin Cernekee034260d2010-06-03 22:11:25 -07002319 hotcpu_notifier(console_cpu_notify, 0);
Robin Getz0c5564b2007-08-20 15:22:47 -04002320 return 0;
2321}
Kevin Cernekee034260d2010-06-03 22:11:25 -07002322late_initcall(printk_late_init);
Robin Getz0c5564b2007-08-20 15:22:47 -04002323
Joe Perches7ef3d2f2008-02-08 04:21:25 -08002324#if defined CONFIG_PRINTK
Dave Young717115e2008-07-25 01:45:58 -07002325
Peter Zijlstra600e1452012-03-15 12:35:37 +01002326int printk_sched(const char *fmt, ...)
2327{
2328 unsigned long flags;
2329 va_list args;
2330 char *buf;
2331 int r;
2332
2333 local_irq_save(flags);
2334 buf = __get_cpu_var(printk_sched_buf);
2335
2336 va_start(args, fmt);
2337 r = vsnprintf(buf, PRINTK_BUF_SIZE, fmt, args);
2338 va_end(args);
2339
2340 __this_cpu_or(printk_pending, PRINTK_PENDING_SCHED);
2341 local_irq_restore(flags);
2342
2343 return r;
2344}
2345
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346/*
2347 * printk rate limiting, lifted from the networking subsystem.
2348 *
Uwe Kleine-König641de9d2008-07-29 22:33:38 -07002349 * This enforces a rate limit: not more than 10 kernel messages
2350 * every 5s to make a denial-of-service attack impossible.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351 */
Uwe Kleine-König641de9d2008-07-29 22:33:38 -07002352DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
2353
Christian Borntraeger5c828712009-10-23 14:58:11 +02002354int __printk_ratelimit(const char *func)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355{
Christian Borntraeger5c828712009-10-23 14:58:11 +02002356 return ___ratelimit(&printk_ratelimit_state, func);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357}
Christian Borntraeger5c828712009-10-23 14:58:11 +02002358EXPORT_SYMBOL(__printk_ratelimit);
Andrew Mortonf46c4832006-11-02 22:07:16 -08002359
2360/**
2361 * printk_timed_ratelimit - caller-controlled printk ratelimiting
2362 * @caller_jiffies: pointer to caller's state
2363 * @interval_msecs: minimum interval between prints
2364 *
2365 * printk_timed_ratelimit() returns true if more than @interval_msecs
2366 * milliseconds have elapsed since the last time printk_timed_ratelimit()
2367 * returned true.
2368 */
2369bool printk_timed_ratelimit(unsigned long *caller_jiffies,
2370 unsigned int interval_msecs)
2371{
Guillaume Knispelf2d28a22009-03-17 16:18:42 +01002372 if (*caller_jiffies == 0
2373 || !time_in_range(jiffies, *caller_jiffies,
2374 *caller_jiffies
2375 + msecs_to_jiffies(interval_msecs))) {
2376 *caller_jiffies = jiffies;
Andrew Mortonf46c4832006-11-02 22:07:16 -08002377 return true;
2378 }
2379 return false;
2380}
2381EXPORT_SYMBOL(printk_timed_ratelimit);
Simon Kagstrom456b5652009-10-16 14:09:18 +02002382
2383static DEFINE_SPINLOCK(dump_list_lock);
2384static LIST_HEAD(dump_list);
2385
2386/**
2387 * kmsg_dump_register - register a kernel log dumper.
Randy Dunlap64855362009-12-17 15:27:27 -08002388 * @dumper: pointer to the kmsg_dumper structure
Simon Kagstrom456b5652009-10-16 14:09:18 +02002389 *
2390 * Adds a kernel log dumper to the system. The dump callback in the
2391 * structure will be called when the kernel oopses or panics and must be
2392 * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
2393 */
2394int kmsg_dump_register(struct kmsg_dumper *dumper)
2395{
2396 unsigned long flags;
2397 int err = -EBUSY;
2398
2399 /* The dump callback needs to be set */
2400 if (!dumper->dump)
2401 return -EINVAL;
2402
2403 spin_lock_irqsave(&dump_list_lock, flags);
2404 /* Don't allow registering multiple times */
2405 if (!dumper->registered) {
2406 dumper->registered = 1;
Huang Yingfb842b02011-01-12 16:59:43 -08002407 list_add_tail_rcu(&dumper->list, &dump_list);
Simon Kagstrom456b5652009-10-16 14:09:18 +02002408 err = 0;
2409 }
2410 spin_unlock_irqrestore(&dump_list_lock, flags);
2411
2412 return err;
2413}
2414EXPORT_SYMBOL_GPL(kmsg_dump_register);
2415
2416/**
2417 * kmsg_dump_unregister - unregister a kmsg dumper.
Randy Dunlap64855362009-12-17 15:27:27 -08002418 * @dumper: pointer to the kmsg_dumper structure
Simon Kagstrom456b5652009-10-16 14:09:18 +02002419 *
2420 * Removes a dump device from the system. Returns zero on success and
2421 * %-EINVAL otherwise.
2422 */
2423int kmsg_dump_unregister(struct kmsg_dumper *dumper)
2424{
2425 unsigned long flags;
2426 int err = -EINVAL;
2427
2428 spin_lock_irqsave(&dump_list_lock, flags);
2429 if (dumper->registered) {
2430 dumper->registered = 0;
Huang Yingfb842b02011-01-12 16:59:43 -08002431 list_del_rcu(&dumper->list);
Simon Kagstrom456b5652009-10-16 14:09:18 +02002432 err = 0;
2433 }
2434 spin_unlock_irqrestore(&dump_list_lock, flags);
Huang Yingfb842b02011-01-12 16:59:43 -08002435 synchronize_rcu();
Simon Kagstrom456b5652009-10-16 14:09:18 +02002436
2437 return err;
2438}
2439EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
2440
Kay Sievers7ff95542012-05-03 02:29:13 +02002441static bool always_kmsg_dump;
2442module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);
2443
Simon Kagstrom456b5652009-10-16 14:09:18 +02002444/**
2445 * kmsg_dump - dump kernel log to kernel message dumpers.
2446 * @reason: the reason (oops, panic etc) for dumping
2447 *
Kay Sieverse2ae7152012-06-15 14:07:51 +02002448 * Call each of the registered dumper's dump() callback, which can
2449 * retrieve the kmsg records with kmsg_dump_get_line() or
2450 * kmsg_dump_get_buffer().
Simon Kagstrom456b5652009-10-16 14:09:18 +02002451 */
2452void kmsg_dump(enum kmsg_dump_reason reason)
2453{
Simon Kagstrom456b5652009-10-16 14:09:18 +02002454 struct kmsg_dumper *dumper;
Simon Kagstrom456b5652009-10-16 14:09:18 +02002455 unsigned long flags;
2456
Matthew Garrettc22ab332012-03-05 14:59:10 -08002457 if ((reason > KMSG_DUMP_OOPS) && !always_kmsg_dump)
2458 return;
2459
Huang Yingfb842b02011-01-12 16:59:43 -08002460 rcu_read_lock();
Kay Sieverse2ae7152012-06-15 14:07:51 +02002461 list_for_each_entry_rcu(dumper, &dump_list, list) {
2462 if (dumper->max_reason && reason > dumper->max_reason)
2463 continue;
2464
2465 /* initialize iterator with data about the stored records */
2466 dumper->active = true;
2467
2468 raw_spin_lock_irqsave(&logbuf_lock, flags);
2469 dumper->cur_seq = clear_seq;
2470 dumper->cur_idx = clear_idx;
2471 dumper->next_seq = log_next_seq;
2472 dumper->next_idx = log_next_idx;
2473 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2474
2475 /* invoke dumper which will iterate over records */
2476 dumper->dump(dumper, reason);
2477
2478 /* reset iterator */
2479 dumper->active = false;
2480 }
Huang Yingfb842b02011-01-12 16:59:43 -08002481 rcu_read_unlock();
Simon Kagstrom456b5652009-10-16 14:09:18 +02002482}
Kay Sieverse2ae7152012-06-15 14:07:51 +02002483
2484/**
2485 * kmsg_dump_get_line - retrieve one kmsg log line
2486 * @dumper: registered kmsg dumper
2487 * @syslog: include the "<4>" prefixes
2488 * @line: buffer to copy the line to
2489 * @size: maximum size of the buffer
2490 * @len: length of line placed into buffer
2491 *
2492 * Start at the beginning of the kmsg buffer, with the oldest kmsg
2493 * record, and copy one record into the provided buffer.
2494 *
2495 * Consecutive calls will return the next available record moving
2496 * towards the end of the buffer with the youngest messages.
2497 *
2498 * A return value of FALSE indicates that there are no more records to
2499 * read.
2500 */
2501bool kmsg_dump_get_line(struct kmsg_dumper *dumper, bool syslog,
2502 char *line, size_t size, size_t *len)
2503{
2504 unsigned long flags;
2505 struct log *msg;
2506 size_t l = 0;
2507 bool ret = false;
2508
2509 if (!dumper->active)
2510 goto out;
2511
2512 raw_spin_lock_irqsave(&logbuf_lock, flags);
2513 if (dumper->cur_seq < log_first_seq) {
2514 /* messages are gone, move to first available one */
2515 dumper->cur_seq = log_first_seq;
2516 dumper->cur_idx = log_first_idx;
2517 }
2518
2519 /* last entry */
2520 if (dumper->cur_seq >= log_next_seq) {
2521 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2522 goto out;
2523 }
2524
2525 msg = log_from_idx(dumper->cur_idx);
2526 l = msg_print_text(msg, syslog,
2527 line, size);
2528
2529 dumper->cur_idx = log_next(dumper->cur_idx);
2530 dumper->cur_seq++;
2531 ret = true;
2532 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2533out:
2534 if (len)
2535 *len = l;
2536 return ret;
2537}
2538EXPORT_SYMBOL_GPL(kmsg_dump_get_line);
2539
2540/**
2541 * kmsg_dump_get_buffer - copy kmsg log lines
2542 * @dumper: registered kmsg dumper
2543 * @syslog: include the "<4>" prefixes
Randy Dunlap4f0f4af2012-06-30 15:37:24 -07002544 * @buf: buffer to copy the line to
Kay Sieverse2ae7152012-06-15 14:07:51 +02002545 * @size: maximum size of the buffer
2546 * @len: length of line placed into buffer
2547 *
2548 * Start at the end of the kmsg buffer and fill the provided buffer
2549 * with as many of the the *youngest* kmsg records that fit into it.
2550 * If the buffer is large enough, all available kmsg records will be
2551 * copied with a single call.
2552 *
2553 * Consecutive calls will fill the buffer with the next block of
2554 * available older records, not including the earlier retrieved ones.
2555 *
2556 * A return value of FALSE indicates that there are no more records to
2557 * read.
2558 */
2559bool kmsg_dump_get_buffer(struct kmsg_dumper *dumper, bool syslog,
2560 char *buf, size_t size, size_t *len)
2561{
2562 unsigned long flags;
2563 u64 seq;
2564 u32 idx;
2565 u64 next_seq;
2566 u32 next_idx;
2567 size_t l = 0;
2568 bool ret = false;
2569
2570 if (!dumper->active)
2571 goto out;
2572
2573 raw_spin_lock_irqsave(&logbuf_lock, flags);
2574 if (dumper->cur_seq < log_first_seq) {
2575 /* messages are gone, move to first available one */
2576 dumper->cur_seq = log_first_seq;
2577 dumper->cur_idx = log_first_idx;
2578 }
2579
2580 /* last entry */
2581 if (dumper->cur_seq >= dumper->next_seq) {
2582 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2583 goto out;
2584 }
2585
2586 /* calculate length of entire buffer */
2587 seq = dumper->cur_seq;
2588 idx = dumper->cur_idx;
2589 while (seq < dumper->next_seq) {
2590 struct log *msg = log_from_idx(idx);
2591
2592 l += msg_print_text(msg, true, NULL, 0);
2593 idx = log_next(idx);
2594 seq++;
2595 }
2596
2597 /* move first record forward until length fits into the buffer */
2598 seq = dumper->cur_seq;
2599 idx = dumper->cur_idx;
2600 while (l > size && seq < dumper->next_seq) {
2601 struct log *msg = log_from_idx(idx);
2602
2603 l -= msg_print_text(msg, true, NULL, 0);
2604 idx = log_next(idx);
2605 seq++;
2606 }
2607
2608 /* last message in next interation */
2609 next_seq = seq;
2610 next_idx = idx;
2611
2612 l = 0;
2613 while (seq < dumper->next_seq) {
2614 struct log *msg = log_from_idx(idx);
2615
2616 l += msg_print_text(msg, syslog,
2617 buf + l, size - l);
2618
2619 idx = log_next(idx);
2620 seq++;
2621 }
2622
2623 dumper->next_seq = next_seq;
2624 dumper->next_idx = next_idx;
2625 ret = true;
2626 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2627out:
2628 if (len)
2629 *len = l;
2630 return ret;
2631}
2632EXPORT_SYMBOL_GPL(kmsg_dump_get_buffer);
2633
2634/**
2635 * kmsg_dump_rewind - reset the interator
2636 * @dumper: registered kmsg dumper
2637 *
2638 * Reset the dumper's iterator so that kmsg_dump_get_line() and
2639 * kmsg_dump_get_buffer() can be called again and used multiple
2640 * times within the same dumper.dump() callback.
2641 */
2642void kmsg_dump_rewind(struct kmsg_dumper *dumper)
2643{
2644 unsigned long flags;
2645
2646 raw_spin_lock_irqsave(&logbuf_lock, flags);
2647 dumper->cur_seq = clear_seq;
2648 dumper->cur_idx = clear_idx;
2649 dumper->next_seq = log_next_seq;
2650 dumper->next_idx = log_next_idx;
2651 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2652}
2653EXPORT_SYMBOL_GPL(kmsg_dump_rewind);
Joe Perches7ef3d2f2008-02-08 04:21:25 -08002654#endif