printk.c 75.9 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12
/*
 *  linux/kernel/printk.c
 *
 *  Copyright (C) 1991, 1992  Linus Torvalds
 *
 * Modified to make sys_syslog() more flexible: added commands to
 * return the last 4k of kernel messages, regardless of whether
 * they've been read or not.  Added option to suppress kernel printk's
 * to the console.  Added hook for sending the console messages
 * elsewhere, in preparation for a serial line console (someday).
 * Ted Ts'o, 2/11/93.
 * Modified for sysctl support, 1/8/97, Chris Horn.
J
Jesper Juhl 已提交
13
 * Fixed SMP synchronization, 08/08/99, Manfred Spraul
14
 *     manfred@colorfullife.com
L
Linus Torvalds 已提交
15
 * Rewrote bits to get rid of console_lock
16
 *	01Mar01 Andrew Morton
L
Linus Torvalds 已提交
17 18 19 20 21 22 23 24
 */

#include <linux/kernel.h>
#include <linux/mm.h>
#include <linux/tty.h>
#include <linux/tty_driver.h>
#include <linux/console.h>
#include <linux/init.h>
R
Randy Dunlap 已提交
25 26
#include <linux/jiffies.h>
#include <linux/nmi.h>
L
Linus Torvalds 已提交
27
#include <linux/module.h>
J
Jan Engelhardt 已提交
28
#include <linux/moduleparam.h>
L
Linus Torvalds 已提交
29 30 31 32 33
#include <linux/interrupt.h>			/* For in_interrupt() */
#include <linux/delay.h>
#include <linux/smp.h>
#include <linux/security.h>
#include <linux/bootmem.h>
34
#include <linux/memblock.h>
35
#include <linux/aio.h>
L
Linus Torvalds 已提交
36
#include <linux/syscalls.h>
37
#include <linux/kexec.h>
38
#include <linux/kdb.h>
39
#include <linux/ratelimit.h>
40
#include <linux/kmsg_dump.h>
41
#include <linux/syslog.h>
42 43
#include <linux/cpu.h>
#include <linux/notifier.h>
44
#include <linux/rculist.h>
45
#include <linux/poll.h>
46
#include <linux/irq_work.h>
47
#include <linux/utsname.h>
A
Alex Elder 已提交
48
#include <linux/ctype.h>
L
Linus Torvalds 已提交
49 50 51

#include <asm/uaccess.h>

52 53 54
#define CREATE_TRACE_POINTS
#include <trace/events/printk.h>

J
Joe Perches 已提交
55
#include "console_cmdline.h"
56
#include "braille.h"
J
Joe Perches 已提交
57

L
Linus Torvalds 已提交
58
int console_printk[4] = {
59
	CONSOLE_LOGLEVEL_DEFAULT,	/* console_loglevel */
60
	MESSAGE_LOGLEVEL_DEFAULT,	/* default_message_loglevel */
61 62
	CONSOLE_LOGLEVEL_MIN,		/* minimum_console_loglevel */
	CONSOLE_LOGLEVEL_DEFAULT,	/* default_console_loglevel */
L
Linus Torvalds 已提交
63 64 65
};

/*
P
Patrick Pletscher 已提交
66
 * Low level drivers may need that to know if they can schedule in
L
Linus Torvalds 已提交
67 68 69 70 71 72 73 74 75 76
 * their unblank() callback or not. So let's export it.
 */
int oops_in_progress;
EXPORT_SYMBOL(oops_in_progress);

/*
 * console_sem protects the console_drivers list, and also
 * provides serialisation for access to the entire console
 * driver system.
 */
77
static DEFINE_SEMAPHORE(console_sem);
L
Linus Torvalds 已提交
78
struct console *console_drivers;
I
Ingo Molnar 已提交
79 80
EXPORT_SYMBOL_GPL(console_drivers);

81 82 83 84 85 86
#ifdef CONFIG_LOCKDEP
static struct lockdep_map console_lock_dep_map = {
	.name = "console_lock"
};
#endif

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
/*
 * Helper macros to handle lockdep when locking/unlocking console_sem. We use
 * macros instead of functions so that _RET_IP_ contains useful information.
 */
#define down_console_sem() do { \
	down(&console_sem);\
	mutex_acquire(&console_lock_dep_map, 0, 0, _RET_IP_);\
} while (0)

static int __down_trylock_console_sem(unsigned long ip)
{
	if (down_trylock(&console_sem))
		return 1;
	mutex_acquire(&console_lock_dep_map, 0, 1, ip);
	return 0;
}
#define down_trylock_console_sem() __down_trylock_console_sem(_RET_IP_)

#define up_console_sem() do { \
	mutex_release(&console_lock_dep_map, 1, _RET_IP_);\
	up(&console_sem);\
} while (0)

L
Linus Torvalds 已提交
110 111 112 113
/*
 * This is used for debugging the mess that is the VT code by
 * keeping track if we have the console semaphore held. It's
 * definitely not the perfect debug tool (we don't know if _WE_
A
Alex Elder 已提交
114 115 116
 * hold it and are racing, but it helps tracking those weird code
 * paths in the console code where we end up in places I want
 * locked without the console sempahore held).
L
Linus Torvalds 已提交
117
 */
118
static int console_locked, console_suspended;
L
Linus Torvalds 已提交
119

120 121 122 123 124
/*
 * If exclusive_console is non-NULL then only this console is to be printed to.
 */
static struct console *exclusive_console;

L
Linus Torvalds 已提交
125 126 127 128 129 130 131
/*
 *	Array of consoles built from command line options (console=)
 */

#define MAX_CMDLINECONSOLES 8

static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
J
Joe Perches 已提交
132

L
Linus Torvalds 已提交
133 134
static int selected_console = -1;
static int preferred_console = -1;
135 136
int console_set_on_cmdline;
EXPORT_SYMBOL(console_set_on_cmdline);
L
Linus Torvalds 已提交
137 138 139 140

/* Flag: console code may call schedule() */
static int console_may_schedule;

141 142 143 144 145 146
/*
 * The printk log buffer consists of a chain of concatenated variable
 * length records. Every record starts with a record header, containing
 * the overall length of the record.
 *
 * The heads to the first and last entry in the buffer, as well as the
A
Alex Elder 已提交
147 148
 * sequence numbers of these entries are maintained when messages are
 * stored.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
 *
 * If the heads indicate available messages, the length in the header
 * tells the start next message. A length == 0 for the next message
 * indicates a wrap-around to the beginning of the buffer.
 *
 * Every record carries the monotonic timestamp in microseconds, as well as
 * the standard userspace syslog level and syslog facility. The usual
 * kernel messages use LOG_KERN; userspace-injected messages always carry
 * a matching syslog facility, by default LOG_USER. The origin of every
 * message can be reliably determined that way.
 *
 * The human readable log message directly follows the message header. The
 * length of the message text is stored in the header, the stored message
 * is not terminated.
 *
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
 * Optionally, a message can carry a dictionary of properties (key/value pairs),
 * to provide userspace with a machine-readable message context.
 *
 * Examples for well-defined, commonly used property names are:
 *   DEVICE=b12:8               device identifier
 *                                b12:8         block dev_t
 *                                c127:3        char dev_t
 *                                n8            netdev ifindex
 *                                +sound:card0  subsystem:devname
 *   SUBSYSTEM=pci              driver-core subsystem name
 *
 * Valid characters in property names are [a-zA-Z0-9.-_]. The plain text value
 * follows directly after a '=' character. Every property is terminated by
 * a '\0' character. The last property is not terminated.
 *
 * Example of a message structure:
 *   0000  ff 8f 00 00 00 00 00 00      monotonic time in nsec
 *   0008  34 00                        record is 52 bytes long
 *   000a        0b 00                  text is 11 bytes long
 *   000c              1f 00            dictionary is 23 bytes long
 *   000e                    03 00      LOG_KERN (facility) LOG_ERR (level)
 *   0010  69 74 27 73 20 61 20 6c      "it's a l"
 *         69 6e 65                     "ine"
 *   001b           44 45 56 49 43      "DEVIC"
 *         45 3d 62 38 3a 32 00 44      "E=b8:2\0D"
 *         52 49 56 45 52 3d 62 75      "RIVER=bu"
 *         67                           "g"
 *   0032     00 00 00                  padding to next message header
 *
193
 * The 'struct printk_log' buffer header must never be directly exported to
194 195 196 197 198 199 200 201 202 203 204 205
 * userspace, it is a kernel-private implementation detail that might
 * need to be changed in the future, when the requirements change.
 *
 * /dev/kmsg exports the structured data in the following line format:
 *   "level,sequnum,timestamp;<message text>\n"
 *
 * The optional key/value pairs are attached as continuation lines starting
 * with a space character and terminated by a newline. All possible
 * non-prinatable characters are escaped in the "\xff" notation.
 *
 * Users of the export format should ignore possible additional values
 * separated by ',', and find the message after the ';' character.
206 207
 */

208
enum log_flags {
209 210 211 212
	LOG_NOCONS	= 1,	/* already flushed, do not print to console */
	LOG_NEWLINE	= 2,	/* text ended with a newline */
	LOG_PREFIX	= 4,	/* text started with a prefix */
	LOG_CONT	= 8,	/* text is a fragment of a continuation line */
213 214
};

215
struct printk_log {
216 217 218 219
	u64 ts_nsec;		/* timestamp in nanoseconds */
	u16 len;		/* length of entire record */
	u16 text_len;		/* length of text buffer */
	u16 dict_len;		/* length of dictionary buffer */
220 221 222
	u8 facility;		/* syslog facility */
	u8 flags:5;		/* internal record flags */
	u8 level:3;		/* syslog level */
223 224 225
};

/*
226 227 228
 * The logbuf_lock protects kmsg buffer, indices, counters.  This can be taken
 * within the scheduler's rq lock. It must be released before calling
 * console_unlock() or anything else that might wake up a process.
229 230
 */
static DEFINE_RAW_SPINLOCK(logbuf_lock);
M
Matt Mackall 已提交
231

232
#ifdef CONFIG_PRINTK
233
DECLARE_WAIT_QUEUE_HEAD(log_wait);
234 235 236
/* the next printk record to read by syslog(READ) or /proc/kmsg */
static u64 syslog_seq;
static u32 syslog_idx;
237
static enum log_flags syslog_prev;
238
static size_t syslog_partial;
239 240 241 242 243 244 245 246 247

/* index and sequence number of the first record stored in the buffer */
static u64 log_first_seq;
static u32 log_first_idx;

/* index and sequence number of the next record to store in the buffer */
static u64 log_next_seq;
static u32 log_next_idx;

248 249 250 251 252
/* the next printk record to write to the console */
static u64 console_seq;
static u32 console_idx;
static enum log_flags console_prev;

253 254 255 256
/* the next printk record to read after the last 'clear' command */
static u64 clear_seq;
static u32 clear_idx;

257
#define PREFIX_MAX		32
A
Alex Elder 已提交
258
#define LOG_LINE_MAX		(1024 - PREFIX_MAX)
259 260

/* record buffer */
261
#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
262 263
#define LOG_ALIGN 4
#else
264
#define LOG_ALIGN __alignof__(struct printk_log)
265
#endif
266
#define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
267
static char __log_buf[__LOG_BUF_LEN] __aligned(LOG_ALIGN);
268 269 270
static char *log_buf = __log_buf;
static u32 log_buf_len = __LOG_BUF_LEN;

271 272 273 274 275 276 277 278 279 280 281 282
/* Return log buffer address */
char *log_buf_addr_get(void)
{
	return log_buf;
}

/* Return log buffer size */
u32 log_buf_len_get(void)
{
	return log_buf_len;
}

283
/* human readable text of the record */
284
static char *log_text(const struct printk_log *msg)
285
{
286
	return (char *)msg + sizeof(struct printk_log);
287 288 289
}

/* optional key/value pair dictionary attached to the record */
290
static char *log_dict(const struct printk_log *msg)
291
{
292
	return (char *)msg + sizeof(struct printk_log) + msg->text_len;
293 294 295
}

/* get record by index; idx must point to valid msg */
296
static struct printk_log *log_from_idx(u32 idx)
297
{
298
	struct printk_log *msg = (struct printk_log *)(log_buf + idx);
299 300 301 302 303 304

	/*
	 * A length == 0 record is the end of buffer marker. Wrap around and
	 * read the message at the start of the buffer.
	 */
	if (!msg->len)
305
		return (struct printk_log *)log_buf;
306 307 308 309 310 311
	return msg;
}

/* get next record; idx must point to valid msg */
static u32 log_next(u32 idx)
{
312
	struct printk_log *msg = (struct printk_log *)(log_buf + idx);
313 314 315 316 317 318 319 320

	/* length == 0 indicates the end of the buffer; wrap */
	/*
	 * A length == 0 record is the end of buffer marker. Wrap around and
	 * read the message at the start of the buffer as *this* one, and
	 * return the one after that.
	 */
	if (!msg->len) {
321
		msg = (struct printk_log *)log_buf;
322 323 324 325 326
		return msg->len;
	}
	return idx + msg->len;
}

P
Petr Mladek 已提交
327 328 329 330 331 332 333 334 335 336
/*
 * Check whether there is enough free space for the given message.
 *
 * The same values of first_idx and next_idx mean that the buffer
 * is either empty or full.
 *
 * If the buffer is empty, we must respect the position of the indexes.
 * They cannot be reset to the beginning of the buffer.
 */
static int logbuf_has_space(u32 msg_size, bool empty)
337 338 339
{
	u32 free;

P
Petr Mladek 已提交
340
	if (log_next_idx > log_first_idx || empty)
341 342 343 344 345 346 347 348 349 350 351
		free = max(log_buf_len - log_next_idx, log_first_idx);
	else
		free = log_first_idx - log_next_idx;

	/*
	 * We need space also for an empty header that signalizes wrapping
	 * of the buffer.
	 */
	return free >= msg_size + sizeof(struct printk_log);
}

P
Petr Mladek 已提交
352
static int log_make_free_space(u32 msg_size)
353 354
{
	while (log_first_seq < log_next_seq) {
P
Petr Mladek 已提交
355 356
		if (logbuf_has_space(msg_size, false))
			return 0;
A
Alex Elder 已提交
357
		/* drop old messages until we have enough contiguous space */
358 359 360
		log_first_idx = log_next(log_first_idx);
		log_first_seq++;
	}
P
Petr Mladek 已提交
361 362 363 364 365 366

	/* sequence numbers are equal, so the log buffer is empty */
	if (logbuf_has_space(msg_size, true))
		return 0;

	return -ENOMEM;
367 368
}

369 370 371 372 373 374 375 376 377 378 379 380
/* compute the message size including the padding bytes */
static u32 msg_used_size(u16 text_len, u16 dict_len, u32 *pad_len)
{
	u32 size;

	size = sizeof(struct printk_log) + text_len + dict_len;
	*pad_len = (-size) & (LOG_ALIGN - 1);
	size += *pad_len;

	return size;
}

P
Petr Mladek 已提交
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
/*
 * Define how much of the log buffer we could take at maximum. The value
 * must be greater than two. Note that only half of the buffer is available
 * when the index points to the middle.
 */
#define MAX_LOG_TAKE_PART 4
static const char trunc_msg[] = "<truncated>";

static u32 truncate_msg(u16 *text_len, u16 *trunc_msg_len,
			u16 *dict_len, u32 *pad_len)
{
	/*
	 * The message should not take the whole buffer. Otherwise, it might
	 * get removed too soon.
	 */
	u32 max_text_len = log_buf_len / MAX_LOG_TAKE_PART;
	if (*text_len > max_text_len)
		*text_len = max_text_len;
	/* enable the warning message */
	*trunc_msg_len = strlen(trunc_msg);
	/* disable the "dict" completely */
	*dict_len = 0;
	/* compute the size again, count also the warning message */
	return msg_used_size(*text_len + *trunc_msg_len, 0, pad_len);
}

407
/* insert record into the buffer, discard old ones, update heads */
408 409 410 411
static int log_store(int facility, int level,
		     enum log_flags flags, u64 ts_nsec,
		     const char *dict, u16 dict_len,
		     const char *text, u16 text_len)
412
{
413
	struct printk_log *msg;
414
	u32 size, pad_len;
P
Petr Mladek 已提交
415
	u16 trunc_msg_len = 0;
416 417

	/* number of '\0' padding bytes to next message */
418
	size = msg_used_size(text_len, dict_len, &pad_len);
419

P
Petr Mladek 已提交
420 421 422 423 424 425
	if (log_make_free_space(size)) {
		/* truncate the message if it is too long for empty buffer */
		size = truncate_msg(&text_len, &trunc_msg_len,
				    &dict_len, &pad_len);
		/* survive when the log buffer is too small for trunc_msg */
		if (log_make_free_space(size))
426
			return 0;
P
Petr Mladek 已提交
427
	}
428

429
	if (log_next_idx + size + sizeof(struct printk_log) > log_buf_len) {
430 431 432 433 434
		/*
		 * This message + an additional empty header does not fit
		 * at the end of the buffer. Add an empty header with len == 0
		 * to signify a wrap around.
		 */
435
		memset(log_buf + log_next_idx, 0, sizeof(struct printk_log));
436 437 438 439
		log_next_idx = 0;
	}

	/* fill message */
440
	msg = (struct printk_log *)(log_buf + log_next_idx);
441 442
	memcpy(log_text(msg), text, text_len);
	msg->text_len = text_len;
P
Petr Mladek 已提交
443 444 445 446
	if (trunc_msg_len) {
		memcpy(log_text(msg) + text_len, trunc_msg, trunc_msg_len);
		msg->text_len += trunc_msg_len;
	}
447 448
	memcpy(log_dict(msg), dict, dict_len);
	msg->dict_len = dict_len;
449 450 451 452 453 454 455
	msg->facility = facility;
	msg->level = level & 7;
	msg->flags = flags & 0x1f;
	if (ts_nsec > 0)
		msg->ts_nsec = ts_nsec;
	else
		msg->ts_nsec = local_clock();
456
	memset(log_dict(msg) + dict_len, 0, pad_len);
457
	msg->len = size;
458 459 460 461

	/* insert message */
	log_next_idx += msg->len;
	log_next_seq++;
462 463

	return msg->text_len;
464
}
M
Matt Mackall 已提交
465

A
Alex Elder 已提交
466
int dmesg_restrict = IS_ENABLED(CONFIG_SECURITY_DMESG_RESTRICT);
467 468 469 470 471 472 473 474 475 476 477 478 479

static int syslog_action_restricted(int type)
{
	if (dmesg_restrict)
		return 1;
	/*
	 * Unless restricted, we allow "read all" and "get buffer size"
	 * for everybody.
	 */
	return type != SYSLOG_ACTION_READ_ALL &&
	       type != SYSLOG_ACTION_SIZE_BUFFER;
}

480
int check_syslog_permissions(int type, bool from_file)
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
{
	/*
	 * If this is from /proc/kmsg and we've already opened it, then we've
	 * already done the capabilities checks at open time.
	 */
	if (from_file && type != SYSLOG_ACTION_OPEN)
		return 0;

	if (syslog_action_restricted(type)) {
		if (capable(CAP_SYSLOG))
			return 0;
		/*
		 * For historical reasons, accept CAP_SYS_ADMIN too, with
		 * a warning.
		 */
		if (capable(CAP_SYS_ADMIN)) {
			pr_warn_once("%s (%d): Attempt to access syslog with "
				     "CAP_SYS_ADMIN but no CAP_SYSLOG "
				     "(deprecated).\n",
				 current->comm, task_pid_nr(current));
			return 0;
		}
		return -EPERM;
	}
	return security_syslog(type);
}


509 510 511 512
/* /dev/kmsg - userspace message inject/listen interface */
struct devkmsg_user {
	u64 seq;
	u32 idx;
513
	enum log_flags prev;
514 515 516 517
	struct mutex lock;
	char buf[8192];
};

A
Al Viro 已提交
518
static ssize_t devkmsg_write(struct kiocb *iocb, struct iov_iter *from)
519 520 521 522 523
{
	char *buf, *line;
	int i;
	int level = default_message_loglevel;
	int facility = 1;	/* LOG_USER */
A
Al Viro 已提交
524
	size_t len = iocb->ki_nbytes;
525 526 527 528 529 530 531 532
	ssize_t ret = len;

	if (len > LOG_LINE_MAX)
		return -EINVAL;
	buf = kmalloc(len+1, GFP_KERNEL);
	if (buf == NULL)
		return -ENOMEM;

A
Al Viro 已提交
533 534 535 536
	buf[len] = '\0';
	if (copy_from_iter(buf, len, from) != len) {
		kfree(buf);
		return -EFAULT;
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
	}

	/*
	 * Extract and skip the syslog prefix <[0-9]*>. Coming from userspace
	 * the decimal value represents 32bit, the lower 3 bit are the log
	 * level, the rest are the log facility.
	 *
	 * If no prefix or no userspace facility is specified, we
	 * enforce LOG_USER, to be able to reliably distinguish
	 * kernel-generated messages from userspace-injected ones.
	 */
	line = buf;
	if (line[0] == '<') {
		char *endp = NULL;

		i = simple_strtoul(line+1, &endp, 10);
		if (endp && endp[0] == '>') {
			level = i & 7;
			if (i >> 3)
				facility = i >> 3;
			endp++;
			len -= endp - line;
			line = endp;
		}
	}

	printk_emit(facility, level, NULL, 0, "%s", line);
	kfree(buf);
	return ret;
}

static ssize_t devkmsg_read(struct file *file, char __user *buf,
			    size_t count, loff_t *ppos)
{
	struct devkmsg_user *user = file->private_data;
572
	struct printk_log *msg;
573
	u64 ts_usec;
574
	size_t i;
575
	char cont = '-';
576 577 578 579 580 581
	size_t len;
	ssize_t ret;

	if (!user)
		return -EBADF;

582 583 584
	ret = mutex_lock_interruptible(&user->lock);
	if (ret)
		return ret;
585
	raw_spin_lock_irq(&logbuf_lock);
586 587 588
	while (user->seq == log_next_seq) {
		if (file->f_flags & O_NONBLOCK) {
			ret = -EAGAIN;
589
			raw_spin_unlock_irq(&logbuf_lock);
590 591 592
			goto out;
		}

593
		raw_spin_unlock_irq(&logbuf_lock);
594 595 596 597
		ret = wait_event_interruptible(log_wait,
					       user->seq != log_next_seq);
		if (ret)
			goto out;
598
		raw_spin_lock_irq(&logbuf_lock);
599 600 601 602 603 604 605
	}

	if (user->seq < log_first_seq) {
		/* our last seen message is gone, return error and reset */
		user->idx = log_first_idx;
		user->seq = log_first_seq;
		ret = -EPIPE;
606
		raw_spin_unlock_irq(&logbuf_lock);
607 608 609 610
		goto out;
	}

	msg = log_from_idx(user->idx);
611 612
	ts_usec = msg->ts_nsec;
	do_div(ts_usec, 1000);
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631

	/*
	 * If we couldn't merge continuation line fragments during the print,
	 * export the stored flags to allow an optional external merge of the
	 * records. Merging the records isn't always neccessarily correct, like
	 * when we hit a race during printing. In most cases though, it produces
	 * better readable output. 'c' in the record flags mark the first
	 * fragment of a line, '+' the following.
	 */
	if (msg->flags & LOG_CONT && !(user->prev & LOG_CONT))
		cont = 'c';
	else if ((msg->flags & LOG_CONT) ||
		 ((user->prev & LOG_CONT) && !(msg->flags & LOG_PREFIX)))
		cont = '+';

	len = sprintf(user->buf, "%u,%llu,%llu,%c;",
		      (msg->facility << 3) | msg->level,
		      user->seq, ts_usec, cont);
	user->prev = msg->flags;
632 633 634

	/* escape non-printable characters */
	for (i = 0; i < msg->text_len; i++) {
635
		unsigned char c = log_text(msg)[i];
636

637
		if (c < ' ' || c >= 127 || c == '\\')
638 639 640 641 642 643 644 645 646 647
			len += sprintf(user->buf + len, "\\x%02x", c);
		else
			user->buf[len++] = c;
	}
	user->buf[len++] = '\n';

	if (msg->dict_len) {
		bool line = true;

		for (i = 0; i < msg->dict_len; i++) {
648
			unsigned char c = log_dict(msg)[i];
649 650 651 652 653 654 655 656 657 658 659 660

			if (line) {
				user->buf[len++] = ' ';
				line = false;
			}

			if (c == '\0') {
				user->buf[len++] = '\n';
				line = true;
				continue;
			}

661
			if (c < ' ' || c >= 127 || c == '\\') {
662 663 664 665 666 667 668 669 670 671 672
				len += sprintf(user->buf + len, "\\x%02x", c);
				continue;
			}

			user->buf[len++] = c;
		}
		user->buf[len++] = '\n';
	}

	user->idx = log_next(user->idx);
	user->seq++;
673
	raw_spin_unlock_irq(&logbuf_lock);
674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699

	if (len > count) {
		ret = -EINVAL;
		goto out;
	}

	if (copy_to_user(buf, user->buf, len)) {
		ret = -EFAULT;
		goto out;
	}
	ret = len;
out:
	mutex_unlock(&user->lock);
	return ret;
}

static loff_t devkmsg_llseek(struct file *file, loff_t offset, int whence)
{
	struct devkmsg_user *user = file->private_data;
	loff_t ret = 0;

	if (!user)
		return -EBADF;
	if (offset)
		return -ESPIPE;

700
	raw_spin_lock_irq(&logbuf_lock);
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
	switch (whence) {
	case SEEK_SET:
		/* the first record */
		user->idx = log_first_idx;
		user->seq = log_first_seq;
		break;
	case SEEK_DATA:
		/*
		 * The first record after the last SYSLOG_ACTION_CLEAR,
		 * like issued by 'dmesg -c'. Reading /dev/kmsg itself
		 * changes no global state, and does not clear anything.
		 */
		user->idx = clear_idx;
		user->seq = clear_seq;
		break;
	case SEEK_END:
		/* after the last record */
		user->idx = log_next_idx;
		user->seq = log_next_seq;
		break;
	default:
		ret = -EINVAL;
	}
724
	raw_spin_unlock_irq(&logbuf_lock);
725 726 727 728 729 730 731 732 733 734 735 736 737
	return ret;
}

static unsigned int devkmsg_poll(struct file *file, poll_table *wait)
{
	struct devkmsg_user *user = file->private_data;
	int ret = 0;

	if (!user)
		return POLLERR|POLLNVAL;

	poll_wait(file, &log_wait, wait);

738
	raw_spin_lock_irq(&logbuf_lock);
739 740 741 742
	if (user->seq < log_next_seq) {
		/* return error when data has vanished underneath us */
		if (user->seq < log_first_seq)
			ret = POLLIN|POLLRDNORM|POLLERR|POLLPRI;
743 744
		else
			ret = POLLIN|POLLRDNORM;
745
	}
746
	raw_spin_unlock_irq(&logbuf_lock);
747 748 749 750 751 752 753 754 755 756 757 758 759

	return ret;
}

static int devkmsg_open(struct inode *inode, struct file *file)
{
	struct devkmsg_user *user;
	int err;

	/* write-only does not need any file context */
	if ((file->f_flags & O_ACCMODE) == O_WRONLY)
		return 0;

760 761
	err = check_syslog_permissions(SYSLOG_ACTION_READ_ALL,
				       SYSLOG_FROM_READER);
762 763 764 765 766 767 768 769 770
	if (err)
		return err;

	user = kmalloc(sizeof(struct devkmsg_user), GFP_KERNEL);
	if (!user)
		return -ENOMEM;

	mutex_init(&user->lock);

771
	raw_spin_lock_irq(&logbuf_lock);
772 773
	user->idx = log_first_idx;
	user->seq = log_first_seq;
774
	raw_spin_unlock_irq(&logbuf_lock);
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794

	file->private_data = user;
	return 0;
}

static int devkmsg_release(struct inode *inode, struct file *file)
{
	struct devkmsg_user *user = file->private_data;

	if (!user)
		return 0;

	mutex_destroy(&user->lock);
	kfree(user);
	return 0;
}

const struct file_operations kmsg_fops = {
	.open = devkmsg_open,
	.read = devkmsg_read,
A
Al Viro 已提交
795
	.write_iter = devkmsg_write,
796 797 798 799 800
	.llseek = devkmsg_llseek,
	.poll = devkmsg_poll,
	.release = devkmsg_release,
};

801 802
#ifdef CONFIG_KEXEC
/*
803
 * This appends the listed symbols to /proc/vmcore
804
 *
805
 * /proc/vmcore is used by various utilities, like crash and makedumpfile to
806 807 808 809 810 811 812 813
 * obtain access to symbols that are otherwise very difficult to locate.  These
 * symbols are specifically used so that utilities can access and extract the
 * dmesg log from a vmcore file after a crash.
 */
void log_buf_kexec_setup(void)
{
	VMCOREINFO_SYMBOL(log_buf);
	VMCOREINFO_SYMBOL(log_buf_len);
814 815
	VMCOREINFO_SYMBOL(log_first_idx);
	VMCOREINFO_SYMBOL(log_next_idx);
816
	/*
817
	 * Export struct printk_log size and field offsets. User space tools can
818 819
	 * parse it and detect any changes to structure down the line.
	 */
820 821 822 823 824
	VMCOREINFO_STRUCT_SIZE(printk_log);
	VMCOREINFO_OFFSET(printk_log, ts_nsec);
	VMCOREINFO_OFFSET(printk_log, len);
	VMCOREINFO_OFFSET(printk_log, text_len);
	VMCOREINFO_OFFSET(printk_log, dict_len);
825 826 827
}
#endif

828 829 830
/* requested log_buf_len from kernel cmdline */
static unsigned long __initdata new_log_buf_len;

831 832
/* we practice scaling the ring buffer by powers of 2 */
static void __init log_buf_len_update(unsigned size)
L
Linus Torvalds 已提交
833 834 835
{
	if (size)
		size = roundup_pow_of_two(size);
836 837
	if (size > log_buf_len)
		new_log_buf_len = size;
838 839 840 841 842 843 844 845
}

/* save requested log_buf_len since it's too early to process it */
static int __init log_buf_len_setup(char *str)
{
	unsigned size = memparse(str, &str);

	log_buf_len_update(size);
846 847

	return 0;
L
Linus Torvalds 已提交
848
}
849 850
early_param("log_buf_len", log_buf_len_setup);

851 852 853
#ifdef CONFIG_SMP
#define __LOG_CPU_MAX_BUF_LEN (1 << CONFIG_LOG_CPU_MAX_BUF_SHIFT)

854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
static void __init log_buf_add_cpu(void)
{
	unsigned int cpu_extra;

	/*
	 * archs should set up cpu_possible_bits properly with
	 * set_cpu_possible() after setup_arch() but just in
	 * case lets ensure this is valid.
	 */
	if (num_possible_cpus() == 1)
		return;

	cpu_extra = (num_possible_cpus() - 1) * __LOG_CPU_MAX_BUF_LEN;

	/* by default this will only continue through for large > 64 CPUs */
	if (cpu_extra <= __LOG_BUF_LEN / 2)
		return;

	pr_info("log_buf_len individual max cpu contribution: %d bytes\n",
		__LOG_CPU_MAX_BUF_LEN);
	pr_info("log_buf_len total cpu_extra contributions: %d bytes\n",
		cpu_extra);
	pr_info("log_buf_len min size: %d bytes\n", __LOG_BUF_LEN);

	log_buf_len_update(cpu_extra + __LOG_BUF_LEN);
}
880 881 882
#else /* !CONFIG_SMP */
static inline void log_buf_add_cpu(void) {}
#endif /* CONFIG_SMP */
883

884 885 886 887 888 889
void __init setup_log_buf(int early)
{
	unsigned long flags;
	char *new_log_buf;
	int free;

890 891 892 893 894 895
	if (log_buf != __log_buf)
		return;

	if (!early && !new_log_buf_len)
		log_buf_add_cpu();

896 897
	if (!new_log_buf_len)
		return;
L
Linus Torvalds 已提交
898

899
	if (early) {
900
		new_log_buf =
901
			memblock_virt_alloc(new_log_buf_len, LOG_ALIGN);
902
	} else {
903 904
		new_log_buf = memblock_virt_alloc_nopanic(new_log_buf_len,
							  LOG_ALIGN);
905 906 907 908 909 910 911 912
	}

	if (unlikely(!new_log_buf)) {
		pr_err("log_buf_len: %ld bytes not available\n",
			new_log_buf_len);
		return;
	}

913
	raw_spin_lock_irqsave(&logbuf_lock, flags);
914 915 916
	log_buf_len = new_log_buf_len;
	log_buf = new_log_buf;
	new_log_buf_len = 0;
917 918
	free = __LOG_BUF_LEN - log_next_idx;
	memcpy(log_buf, __log_buf, __LOG_BUF_LEN);
919
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
920

921
	pr_info("log_buf_len: %d bytes\n", log_buf_len);
922 923 924
	pr_info("early log buf free: %d(%d%%)\n",
		free, (free * 100) / __LOG_BUF_LEN);
}
L
Linus Torvalds 已提交
925

926 927 928 929
static bool __read_mostly ignore_loglevel;

static int __init ignore_loglevel_setup(char *str)
{
930
	ignore_loglevel = true;
931
	pr_info("debug: ignoring loglevel setting.\n");
932 933 934 935 936 937 938 939 940

	return 0;
}

early_param("ignore_loglevel", ignore_loglevel_setup);
module_param(ignore_loglevel, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(ignore_loglevel, "ignore loglevel setting, to"
	"print all kernel messages to the console.");

R
Randy Dunlap 已提交
941 942
#ifdef CONFIG_BOOT_PRINTK_DELAY

943
static int boot_delay; /* msecs delay after each printk during bootup */
944
static unsigned long long loops_per_msec;	/* based on boot_delay */
R
Randy Dunlap 已提交
945 946 947 948 949 950 951 952 953 954 955 956

static int __init boot_delay_setup(char *str)
{
	unsigned long lpj;

	lpj = preset_lpj ? preset_lpj : 1000000;	/* some guess */
	loops_per_msec = (unsigned long long)lpj / 1000 * HZ;

	get_option(&str, &boot_delay);
	if (boot_delay > 10 * 1000)
		boot_delay = 0;

957 958 959
	pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
		"HZ: %d, loops_per_msec: %llu\n",
		boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
960
	return 0;
R
Randy Dunlap 已提交
961
}
962
early_param("boot_delay", boot_delay_setup);
R
Randy Dunlap 已提交
963

964
static void boot_delay_msec(int level)
R
Randy Dunlap 已提交
965 966 967 968
{
	unsigned long long k;
	unsigned long timeout;

969 970
	if ((boot_delay == 0 || system_state != SYSTEM_BOOTING)
		|| (level >= console_loglevel && !ignore_loglevel)) {
R
Randy Dunlap 已提交
971
		return;
972
	}
R
Randy Dunlap 已提交
973

974
	k = (unsigned long long)loops_per_msec * boot_delay;
R
Randy Dunlap 已提交
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990

	timeout = jiffies + msecs_to_jiffies(boot_delay);
	while (k) {
		k--;
		cpu_relax();
		/*
		 * use (volatile) jiffies to prevent
		 * compiler reduction; loop termination via jiffies
		 * is secondary and may or may not happen.
		 */
		if (time_after(jiffies, timeout))
			break;
		touch_nmi_watchdog();
	}
}
#else
991
static inline void boot_delay_msec(int level)
R
Randy Dunlap 已提交
992 993 994 995
{
}
#endif

A
Alex Elder 已提交
996
static bool printk_time = IS_ENABLED(CONFIG_PRINTK_TIME);
997 998
module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);

999 1000 1001 1002 1003 1004 1005
static size_t print_time(u64 ts, char *buf)
{
	unsigned long rem_nsec;

	if (!printk_time)
		return 0;

1006 1007
	rem_nsec = do_div(ts, 1000000000);

1008
	if (!buf)
1009
		return snprintf(NULL, 0, "[%5lu.000000] ", (unsigned long)ts);
1010 1011 1012 1013 1014

	return sprintf(buf, "[%5lu.%06lu] ",
		       (unsigned long)ts, rem_nsec / 1000);
}

1015
static size_t print_prefix(const struct printk_log *msg, bool syslog, char *buf)
1016
{
1017
	size_t len = 0;
1018
	unsigned int prefix = (msg->facility << 3) | msg->level;
1019

1020 1021
	if (syslog) {
		if (buf) {
1022
			len += sprintf(buf, "<%u>", prefix);
1023 1024
		} else {
			len += 3;
1025 1026 1027 1028 1029
			if (prefix > 999)
				len += 3;
			else if (prefix > 99)
				len += 2;
			else if (prefix > 9)
1030 1031 1032
				len++;
		}
	}
1033

1034
	len += print_time(msg->ts_nsec, buf ? buf + len : NULL);
1035
	return len;
1036 1037
}

1038
static size_t msg_print_text(const struct printk_log *msg, enum log_flags prev,
1039
			     bool syslog, char *buf, size_t size)
1040
{
1041 1042
	const char *text = log_text(msg);
	size_t text_size = msg->text_len;
1043 1044
	bool prefix = true;
	bool newline = true;
1045 1046
	size_t len = 0;

1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
	if ((prev & LOG_CONT) && !(msg->flags & LOG_PREFIX))
		prefix = false;

	if (msg->flags & LOG_CONT) {
		if ((prev & LOG_CONT) && !(prev & LOG_NEWLINE))
			prefix = false;

		if (!(msg->flags & LOG_NEWLINE))
			newline = false;
	}

1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
	do {
		const char *next = memchr(text, '\n', text_size);
		size_t text_len;

		if (next) {
			text_len = next - text;
			next++;
			text_size -= next - text;
		} else {
			text_len = text_size;
		}
1069

1070 1071
		if (buf) {
			if (print_prefix(msg, syslog, NULL) +
1072
			    text_len + 1 >= size - len)
1073
				break;
1074

1075 1076
			if (prefix)
				len += print_prefix(msg, syslog, buf + len);
1077 1078
			memcpy(buf + len, text, text_len);
			len += text_len;
1079 1080
			if (next || newline)
				buf[len++] = '\n';
1081 1082
		} else {
			/* SYSLOG_ACTION_* buffer size only calculation */
1083 1084 1085 1086 1087
			if (prefix)
				len += print_prefix(msg, syslog, NULL);
			len += text_len;
			if (next || newline)
				len++;
1088
		}
1089

1090
		prefix = true;
1091 1092
		text = next;
	} while (text);
1093 1094 1095 1096 1097 1098 1099

	return len;
}

static int syslog_print(char __user *buf, int size)
{
	char *text;
1100
	struct printk_log *msg;
1101
	int len = 0;
1102

1103
	text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1104 1105 1106
	if (!text)
		return -ENOMEM;

1107 1108
	while (size > 0) {
		size_t n;
1109
		size_t skip;
1110 1111 1112 1113 1114 1115

		raw_spin_lock_irq(&logbuf_lock);
		if (syslog_seq < log_first_seq) {
			/* messages are gone, move to first one */
			syslog_seq = log_first_seq;
			syslog_idx = log_first_idx;
1116
			syslog_prev = 0;
1117
			syslog_partial = 0;
1118 1119 1120 1121 1122
		}
		if (syslog_seq == log_next_seq) {
			raw_spin_unlock_irq(&logbuf_lock);
			break;
		}
1123 1124

		skip = syslog_partial;
1125
		msg = log_from_idx(syslog_idx);
1126 1127
		n = msg_print_text(msg, syslog_prev, true, text,
				   LOG_LINE_MAX + PREFIX_MAX);
1128 1129
		if (n - syslog_partial <= size) {
			/* message fits into buffer, move forward */
1130 1131
			syslog_idx = log_next(syslog_idx);
			syslog_seq++;
1132
			syslog_prev = msg->flags;
1133 1134 1135 1136 1137 1138
			n -= syslog_partial;
			syslog_partial = 0;
		} else if (!len){
			/* partial read(), remember position */
			n = size;
			syslog_partial += n;
1139 1140 1141 1142 1143 1144 1145
		} else
			n = 0;
		raw_spin_unlock_irq(&logbuf_lock);

		if (!n)
			break;

1146
		if (copy_to_user(buf, text + skip, n)) {
1147 1148 1149 1150
			if (!len)
				len = -EFAULT;
			break;
		}
1151 1152 1153 1154

		len += n;
		size -= n;
		buf += n;
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
	}

	kfree(text);
	return len;
}

static int syslog_print_all(char __user *buf, int size, bool clear)
{
	char *text;
	int len = 0;

1166
	text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1167 1168 1169 1170 1171 1172 1173 1174
	if (!text)
		return -ENOMEM;

	raw_spin_lock_irq(&logbuf_lock);
	if (buf) {
		u64 next_seq;
		u64 seq;
		u32 idx;
1175
		enum log_flags prev;
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185

		if (clear_seq < log_first_seq) {
			/* messages are gone, move to first available one */
			clear_seq = log_first_seq;
			clear_idx = log_first_idx;
		}

		/*
		 * Find first record that fits, including all following records,
		 * into the user-provided buffer for this dump.
1186
		 */
1187 1188
		seq = clear_seq;
		idx = clear_idx;
1189
		prev = 0;
1190
		while (seq < log_next_seq) {
1191
			struct printk_log *msg = log_from_idx(idx);
1192

1193
			len += msg_print_text(msg, prev, true, NULL, 0);
1194
			prev = msg->flags;
1195 1196 1197
			idx = log_next(idx);
			seq++;
		}
1198 1199

		/* move first record forward until length fits into the buffer */
1200 1201
		seq = clear_seq;
		idx = clear_idx;
1202
		prev = 0;
1203
		while (len > size && seq < log_next_seq) {
1204
			struct printk_log *msg = log_from_idx(idx);
1205

1206
			len -= msg_print_text(msg, prev, true, NULL, 0);
1207
			prev = msg->flags;
1208 1209 1210 1211
			idx = log_next(idx);
			seq++;
		}

1212
		/* last message fitting into this dump */
1213 1214 1215 1216
		next_seq = log_next_seq;

		len = 0;
		while (len >= 0 && seq < next_seq) {
1217
			struct printk_log *msg = log_from_idx(idx);
1218 1219
			int textlen;

1220 1221
			textlen = msg_print_text(msg, prev, true, text,
						 LOG_LINE_MAX + PREFIX_MAX);
1222 1223 1224 1225 1226 1227
			if (textlen < 0) {
				len = textlen;
				break;
			}
			idx = log_next(idx);
			seq++;
1228
			prev = msg->flags;
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240

			raw_spin_unlock_irq(&logbuf_lock);
			if (copy_to_user(buf + len, text, textlen))
				len = -EFAULT;
			else
				len += textlen;
			raw_spin_lock_irq(&logbuf_lock);

			if (seq < log_first_seq) {
				/* messages are gone, move to next one */
				seq = log_first_seq;
				idx = log_first_idx;
1241
				prev = 0;
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
			}
		}
	}

	if (clear) {
		clear_seq = log_next_seq;
		clear_idx = log_next_idx;
	}
	raw_spin_unlock_irq(&logbuf_lock);

	kfree(text);
	return len;
}

1256
int do_syslog(int type, char __user *buf, int len, bool from_file)
L
Linus Torvalds 已提交
1257
{
1258
	bool clear = false;
1259
	static int saved_console_loglevel = LOGLEVEL_DEFAULT;
1260
	int error;
L
Linus Torvalds 已提交
1261

1262 1263 1264
	error = check_syslog_permissions(type, from_file);
	if (error)
		goto out;
1265 1266

	error = security_syslog(type);
L
Linus Torvalds 已提交
1267 1268 1269 1270
	if (error)
		return error;

	switch (type) {
1271
	case SYSLOG_ACTION_CLOSE:	/* Close log */
L
Linus Torvalds 已提交
1272
		break;
1273
	case SYSLOG_ACTION_OPEN:	/* Open log */
L
Linus Torvalds 已提交
1274
		break;
1275
	case SYSLOG_ACTION_READ:	/* Read from log */
L
Linus Torvalds 已提交
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285
		error = -EINVAL;
		if (!buf || len < 0)
			goto out;
		error = 0;
		if (!len)
			goto out;
		if (!access_ok(VERIFY_WRITE, buf, len)) {
			error = -EFAULT;
			goto out;
		}
J
Jesper Juhl 已提交
1286
		error = wait_event_interruptible(log_wait,
1287
						 syslog_seq != log_next_seq);
1288
		if (error)
L
Linus Torvalds 已提交
1289
			goto out;
1290
		error = syslog_print(buf, len);
L
Linus Torvalds 已提交
1291
		break;
1292 1293
	/* Read/clear last kernel messages */
	case SYSLOG_ACTION_READ_CLEAR:
1294
		clear = true;
L
Linus Torvalds 已提交
1295
		/* FALL THRU */
1296 1297
	/* Read last kernel messages */
	case SYSLOG_ACTION_READ_ALL:
L
Linus Torvalds 已提交
1298 1299 1300 1301 1302 1303 1304 1305 1306 1307
		error = -EINVAL;
		if (!buf || len < 0)
			goto out;
		error = 0;
		if (!len)
			goto out;
		if (!access_ok(VERIFY_WRITE, buf, len)) {
			error = -EFAULT;
			goto out;
		}
1308
		error = syslog_print_all(buf, len, clear);
L
Linus Torvalds 已提交
1309
		break;
1310 1311
	/* Clear ring buffer */
	case SYSLOG_ACTION_CLEAR:
1312
		syslog_print_all(NULL, 0, true);
1313
		break;
1314 1315
	/* Disable logging to console */
	case SYSLOG_ACTION_CONSOLE_OFF:
1316
		if (saved_console_loglevel == LOGLEVEL_DEFAULT)
1317
			saved_console_loglevel = console_loglevel;
L
Linus Torvalds 已提交
1318 1319
		console_loglevel = minimum_console_loglevel;
		break;
1320 1321
	/* Enable logging to console */
	case SYSLOG_ACTION_CONSOLE_ON:
1322
		if (saved_console_loglevel != LOGLEVEL_DEFAULT) {
1323
			console_loglevel = saved_console_loglevel;
1324
			saved_console_loglevel = LOGLEVEL_DEFAULT;
1325
		}
L
Linus Torvalds 已提交
1326
		break;
1327 1328
	/* Set level of messages printed to console */
	case SYSLOG_ACTION_CONSOLE_LEVEL:
L
Linus Torvalds 已提交
1329 1330 1331 1332 1333 1334
		error = -EINVAL;
		if (len < 1 || len > 8)
			goto out;
		if (len < minimum_console_loglevel)
			len = minimum_console_loglevel;
		console_loglevel = len;
1335
		/* Implicitly re-enable logging to console */
1336
		saved_console_loglevel = LOGLEVEL_DEFAULT;
L
Linus Torvalds 已提交
1337 1338
		error = 0;
		break;
1339 1340
	/* Number of chars in the log buffer */
	case SYSLOG_ACTION_SIZE_UNREAD:
1341 1342 1343 1344 1345
		raw_spin_lock_irq(&logbuf_lock);
		if (syslog_seq < log_first_seq) {
			/* messages are gone, move to first one */
			syslog_seq = log_first_seq;
			syslog_idx = log_first_idx;
1346
			syslog_prev = 0;
1347
			syslog_partial = 0;
1348 1349 1350 1351 1352 1353 1354
		}
		if (from_file) {
			/*
			 * Short-cut for poll(/"proc/kmsg") which simply checks
			 * for pending data, not the size; return the count of
			 * records, not the length.
			 */
1355
			error = log_next_seq - syslog_seq;
1356
		} else {
1357 1358 1359
			u64 seq = syslog_seq;
			u32 idx = syslog_idx;
			enum log_flags prev = syslog_prev;
1360 1361 1362

			error = 0;
			while (seq < log_next_seq) {
1363
				struct printk_log *msg = log_from_idx(idx);
1364

1365
				error += msg_print_text(msg, prev, true, NULL, 0);
1366 1367
				idx = log_next(idx);
				seq++;
1368
				prev = msg->flags;
1369
			}
1370
			error -= syslog_partial;
1371 1372
		}
		raw_spin_unlock_irq(&logbuf_lock);
L
Linus Torvalds 已提交
1373
		break;
1374 1375
	/* Size of the log buffer */
	case SYSLOG_ACTION_SIZE_BUFFER:
L
Linus Torvalds 已提交
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385
		error = log_buf_len;
		break;
	default:
		error = -EINVAL;
		break;
	}
out:
	return error;
}

1386
SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
L
Linus Torvalds 已提交
1387
{
1388
	return do_syslog(type, buf, len, SYSLOG_FROM_READER);
L
Linus Torvalds 已提交
1389 1390 1391 1392 1393
}

/*
 * Call the console drivers, asking them to write out
 * log_buf[start] to log_buf[end - 1].
1394
 * The console_lock must be held.
L
Linus Torvalds 已提交
1395
 */
1396
static void call_console_drivers(int level, const char *text, size_t len)
L
Linus Torvalds 已提交
1397
{
1398
	struct console *con;
L
Linus Torvalds 已提交
1399

1400
	trace_console(text, len);
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418

	if (level >= console_loglevel && !ignore_loglevel)
		return;
	if (!console_drivers)
		return;

	for_each_console(con) {
		if (exclusive_console && con != exclusive_console)
			continue;
		if (!(con->flags & CON_ENABLED))
			continue;
		if (!con->write)
			continue;
		if (!cpu_online(smp_processor_id()) &&
		    !(con->flags & CON_ANYTIME))
			continue;
		con->write(con, text, len);
	}
L
Linus Torvalds 已提交
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
}

/*
 * Zap console related locks when oopsing. Only zap at most once
 * every 10 seconds, to leave time for slow consoles to print a
 * full oops.
 */
static void zap_locks(void)
{
	static unsigned long oops_timestamp;

	if (time_after_eq(jiffies, oops_timestamp) &&
J
Jesper Juhl 已提交
1431
			!time_after(jiffies, oops_timestamp + 30 * HZ))
L
Linus Torvalds 已提交
1432 1433 1434 1435
		return;

	oops_timestamp = jiffies;

1436
	debug_locks_off();
L
Linus Torvalds 已提交
1437
	/* If a crash is occurring, make sure we can't deadlock */
1438
	raw_spin_lock_init(&logbuf_lock);
L
Linus Torvalds 已提交
1439
	/* And make sure that we print immediately */
1440
	sema_init(&console_sem, 1);
L
Linus Torvalds 已提交
1441 1442
}

1443 1444 1445 1446
/*
 * Check if we have any console that is capable of printing while cpu is
 * booting or shutting down. Requires console_sem.
 */
1447 1448 1449 1450
static int have_callable_console(void)
{
	struct console *con;

1451
	for_each_console(con)
1452 1453 1454 1455 1456 1457
		if (con->flags & CON_ANYTIME)
			return 1;

	return 0;
}

1458 1459 1460
/*
 * Can we actually use the console at this time on this cpu?
 *
1461 1462 1463
 * Console drivers may assume that per-cpu resources have been allocated. So
 * unless they're explicitly marked as being able to cope (CON_ANYTIME) don't
 * call them until this CPU is officially up.
1464 1465 1466 1467 1468 1469 1470 1471 1472
 */
static inline int can_use_console(unsigned int cpu)
{
	return cpu_online(cpu) || have_callable_console();
}

/*
 * Try to get console ownership to actually show the kernel
 * messages from a 'printk'. Return true (and with the
1473
 * console_lock held, and 'console_locked' set) if it
1474 1475
 * is successful, false otherwise.
 */
1476
static int console_trylock_for_printk(void)
1477
{
1478 1479
	unsigned int cpu = smp_processor_id();

1480 1481 1482 1483 1484 1485 1486 1487 1488
	if (!console_trylock())
		return 0;
	/*
	 * If we can't use the console, we need to release the console
	 * semaphore by hand to avoid flushing the buffer. We need to hold the
	 * console semaphore in order to do this test safely.
	 */
	if (!can_use_console(cpu)) {
		console_locked = 0;
1489
		up_console_sem();
1490 1491 1492
		return 0;
	}
	return 1;
1493
}
1494

1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508
int printk_delay_msec __read_mostly;

static inline void printk_delay(void)
{
	if (unlikely(printk_delay_msec)) {
		int m = printk_delay_msec;

		while (m--) {
			mdelay(1);
			touch_nmi_watchdog();
		}
	}
}

1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
/*
 * Continuation lines are buffered, and not committed to the record buffer
 * until the line is complete, or a race forces it. The line fragments
 * though, are printed immediately to the consoles to ensure everything has
 * reached the console in case of a kernel crash.
 */
static struct cont {
	char buf[LOG_LINE_MAX];
	size_t len;			/* length == 0 means unused buffer */
	size_t cons;			/* bytes written to console */
	struct task_struct *owner;	/* task of first print*/
	u64 ts_nsec;			/* time of first print */
	u8 level;			/* log level of first message */
A
Alex Elder 已提交
1522
	u8 facility;			/* log facility of first message */
1523
	enum log_flags flags;		/* prefix, newline flags */
1524 1525 1526
	bool flushed:1;			/* buffer sealed and committed */
} cont;

1527
static void cont_flush(enum log_flags flags)
1528 1529 1530 1531 1532 1533
{
	if (cont.flushed)
		return;
	if (cont.len == 0)
		return;

1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
	if (cont.cons) {
		/*
		 * If a fragment of this line was directly flushed to the
		 * console; wait for the console to pick up the rest of the
		 * line. LOG_NOCONS suppresses a duplicated output.
		 */
		log_store(cont.facility, cont.level, flags | LOG_NOCONS,
			  cont.ts_nsec, NULL, 0, cont.buf, cont.len);
		cont.flags = flags;
		cont.flushed = true;
	} else {
		/*
		 * If no fragment of this line ever reached the console,
		 * just submit it to the store and free the buffer.
		 */
		log_store(cont.facility, cont.level, flags, 0,
			  NULL, 0, cont.buf, cont.len);
		cont.len = 0;
	}
1553 1554 1555 1556 1557 1558 1559 1560
}

static bool cont_add(int facility, int level, const char *text, size_t len)
{
	if (cont.len && cont.flushed)
		return false;

	if (cont.len + len > sizeof(cont.buf)) {
1561 1562
		/* the line gets too long, split it up in separate records */
		cont_flush(LOG_CONT);
1563 1564 1565 1566 1567 1568 1569 1570
		return false;
	}

	if (!cont.len) {
		cont.facility = facility;
		cont.level = level;
		cont.owner = current;
		cont.ts_nsec = local_clock();
1571
		cont.flags = 0;
1572 1573 1574 1575 1576 1577
		cont.cons = 0;
		cont.flushed = false;
	}

	memcpy(cont.buf + cont.len, text, len);
	cont.len += len;
1578 1579 1580 1581

	if (cont.len > (sizeof(cont.buf) * 80) / 100)
		cont_flush(LOG_CONT);

1582 1583 1584 1585 1586 1587 1588 1589
	return true;
}

static size_t cont_print_text(char *text, size_t size)
{
	size_t textlen = 0;
	size_t len;

1590
	if (cont.cons == 0 && (console_prev & LOG_NEWLINE)) {
1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604
		textlen += print_time(cont.ts_nsec, text);
		size -= textlen;
	}

	len = cont.len - cont.cons;
	if (len > 0) {
		if (len+1 > size)
			len = size-1;
		memcpy(text + textlen, cont.buf + cont.cons, len);
		textlen += len;
		cont.cons = cont.len;
	}

	if (cont.flushed) {
1605 1606
		if (cont.flags & LOG_NEWLINE)
			text[textlen++] = '\n';
1607 1608 1609 1610 1611 1612
		/* got everything, release buffer */
		cont.len = 0;
	}
	return textlen;
}

1613 1614 1615
asmlinkage int vprintk_emit(int facility, int level,
			    const char *dict, size_t dictlen,
			    const char *fmt, va_list args)
L
Linus Torvalds 已提交
1616
{
1617 1618 1619
	static int recursion_bug;
	static char textbuf[LOG_LINE_MAX];
	char *text = textbuf;
1620
	size_t text_len = 0;
1621
	enum log_flags lflags = 0;
1622
	unsigned long flags;
1623
	int this_cpu;
1624
	int printed_len = 0;
1625
	bool in_sched = false;
1626
	/* cpu currently holding logbuf_lock in this function */
1627
	static unsigned int logbuf_cpu = UINT_MAX;
1628

1629 1630
	if (level == LOGLEVEL_SCHED) {
		level = LOGLEVEL_DEFAULT;
1631 1632
		in_sched = true;
	}
L
Linus Torvalds 已提交
1633

1634
	boot_delay_msec(level);
1635
	printk_delay();
R
Randy Dunlap 已提交
1636

L
Linus Torvalds 已提交
1637
	/* This stops the holder of console_sem just where we want him */
1638
	local_irq_save(flags);
1639 1640 1641 1642 1643
	this_cpu = smp_processor_id();

	/*
	 * Ouch, printk recursed into itself!
	 */
1644
	if (unlikely(logbuf_cpu == this_cpu)) {
1645 1646 1647 1648 1649 1650 1651
		/*
		 * If a crash is occurring during printk() on this CPU,
		 * then try to get the crash message out but make sure
		 * we can't deadlock. Otherwise just return to avoid the
		 * recursion and return - but flag the recursion so that
		 * it can be printed at the next appropriate moment:
		 */
1652
		if (!oops_in_progress && !lockdep_recursing(current)) {
1653
			recursion_bug = 1;
1654 1655
			local_irq_restore(flags);
			return 0;
1656 1657 1658 1659
		}
		zap_locks();
	}

1660
	lockdep_off();
1661
	raw_spin_lock(&logbuf_lock);
1662
	logbuf_cpu = this_cpu;
L
Linus Torvalds 已提交
1663

1664
	if (unlikely(recursion_bug)) {
1665 1666 1667
		static const char recursion_msg[] =
			"BUG: recent printk recursion!";

1668
		recursion_bug = 0;
1669
		/* emit KERN_CRIT message */
1670
		printed_len += log_store(0, 2, LOG_PREFIX|LOG_NEWLINE, 0,
1671 1672
					 NULL, 0, recursion_msg,
					 strlen(recursion_msg));
1673
	}
L
Linus Torvalds 已提交
1674

1675 1676 1677 1678
	/*
	 * The printf needs to come first; we need the syslog
	 * prefix which might be passed-in as a parameter.
	 */
1679
	text_len = vscnprintf(text, sizeof(textbuf), fmt, args);
1680

1681
	/* mark and strip a trailing newline */
1682 1683
	if (text_len && text[text_len-1] == '\n') {
		text_len--;
1684
		lflags |= LOG_NEWLINE;
1685
	}
1686

1687 1688 1689 1690 1691 1692 1693 1694
	/* strip kernel syslog prefix and extract log level or control flags */
	if (facility == 0) {
		int kern_level = printk_get_level(text);

		if (kern_level) {
			const char *end_of_header = printk_skip_level(text);
			switch (kern_level) {
			case '0' ... '7':
1695
				if (level == LOGLEVEL_DEFAULT)
1696
					level = kern_level - '0';
1697
				/* fallthrough */
1698 1699 1700
			case 'd':	/* KERN_DEFAULT */
				lflags |= LOG_PREFIX;
			}
1701 1702 1703 1704 1705
			/*
			 * No need to check length here because vscnprintf
			 * put '\0' at the end of the string. Only valid and
			 * newly printed level is detected.
			 */
1706 1707
			text_len -= end_of_header - text;
			text = (char *)end_of_header;
1708 1709 1710
		}
	}

1711
	if (level == LOGLEVEL_DEFAULT)
1712
		level = default_message_loglevel;
1713

1714 1715
	if (dict)
		lflags |= LOG_PREFIX|LOG_NEWLINE;
1716

1717
	if (!(lflags & LOG_NEWLINE)) {
1718 1719 1720 1721
		/*
		 * Flush the conflicting buffer. An earlier newline was missing,
		 * or another task also prints continuation lines.
		 */
1722
		if (cont.len && (lflags & LOG_PREFIX || cont.owner != current))
1723
			cont_flush(LOG_NEWLINE);
1724

1725
		/* buffer line if possible, otherwise store it right away */
1726 1727 1728 1729 1730 1731
		if (cont_add(facility, level, text, text_len))
			printed_len += text_len;
		else
			printed_len += log_store(facility, level,
						 lflags | LOG_CONT, 0,
						 dict, dictlen, text, text_len);
1732
	} else {
1733
		bool stored = false;
1734

1735
		/*
1736 1737 1738 1739
		 * If an earlier newline was missing and it was the same task,
		 * either merge it with the current buffer and flush, or if
		 * there was a race with interrupts (prefix == true) then just
		 * flush it out and store this line separately.
1740 1741
		 * If the preceding printk was from a different task and missed
		 * a newline, flush and append the newline.
1742
		 */
1743 1744 1745 1746
		if (cont.len) {
			if (cont.owner == current && !(lflags & LOG_PREFIX))
				stored = cont_add(facility, level, text,
						  text_len);
1747
			cont_flush(LOG_NEWLINE);
1748
		}
1749

1750 1751 1752 1753 1754
		if (stored)
			printed_len += text_len;
		else
			printed_len += log_store(facility, level, lflags, 0,
						 dict, dictlen, text, text_len);
L
Linus Torvalds 已提交
1755 1756
	}

1757 1758
	logbuf_cpu = UINT_MAX;
	raw_spin_unlock(&logbuf_lock);
1759 1760
	lockdep_on();
	local_irq_restore(flags);
1761

1762
	/* If called from the scheduler, we can not call up(). */
1763
	if (!in_sched) {
1764 1765 1766 1767 1768 1769 1770 1771
		lockdep_off();
		/*
		 * Disable preemption to avoid being preempted while holding
		 * console_sem which would prevent anyone from printing to
		 * console
		 */
		preempt_disable();

1772 1773 1774 1775 1776
		/*
		 * Try to acquire and then immediately release the console
		 * semaphore.  The release will print out buffers and wake up
		 * /dev/kmsg and syslog() users.
		 */
1777
		if (console_trylock_for_printk())
1778
			console_unlock();
1779 1780
		preempt_enable();
		lockdep_on();
1781
	}
1782

L
Linus Torvalds 已提交
1783 1784
	return printed_len;
}
1785 1786 1787 1788
EXPORT_SYMBOL(vprintk_emit);

asmlinkage int vprintk(const char *fmt, va_list args)
{
1789
	return vprintk_emit(0, LOGLEVEL_DEFAULT, NULL, 0, fmt, args);
1790
}
L
Linus Torvalds 已提交
1791 1792
EXPORT_SYMBOL(vprintk);

1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828
asmlinkage int printk_emit(int facility, int level,
			   const char *dict, size_t dictlen,
			   const char *fmt, ...)
{
	va_list args;
	int r;

	va_start(args, fmt);
	r = vprintk_emit(facility, level, dict, dictlen, fmt, args);
	va_end(args);

	return r;
}
EXPORT_SYMBOL(printk_emit);

/**
 * printk - print a kernel message
 * @fmt: format string
 *
 * This is printk(). It can be called from any context. We want it to work.
 *
 * We try to grab the console_lock. If we succeed, it's easy - we log the
 * output and call the console drivers.  If we fail to get the semaphore, we
 * place the output into the log buffer and return. The current holder of
 * the console_sem will notice the new output in console_unlock(); and will
 * send it to the consoles before releasing the lock.
 *
 * One effect of this deferred printing is that code which calls printk() and
 * then changes console_loglevel may break. This is because console_loglevel
 * is inspected when the actual printing occurs.
 *
 * See also:
 * printf(3)
 *
 * See the vsnprintf() documentation for format string extensions over C99.
 */
1829
asmlinkage __visible int printk(const char *fmt, ...)
1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842
{
	va_list args;
	int r;

#ifdef CONFIG_KGDB_KDB
	if (unlikely(kdb_trap_printk)) {
		va_start(args, fmt);
		r = vkdb_printf(fmt, args);
		va_end(args);
		return r;
	}
#endif
	va_start(args, fmt);
1843
	r = vprintk_emit(0, LOGLEVEL_DEFAULT, NULL, 0, fmt, args);
1844 1845 1846 1847 1848
	va_end(args);

	return r;
}
EXPORT_SYMBOL(printk);
1849

1850
#else /* CONFIG_PRINTK */
M
Matt Mackall 已提交
1851

1852 1853
#define LOG_LINE_MAX		0
#define PREFIX_MAX		0
A
Alex Elder 已提交
1854

1855 1856
static u64 syslog_seq;
static u32 syslog_idx;
1857 1858
static u64 console_seq;
static u32 console_idx;
1859 1860 1861 1862
static enum log_flags syslog_prev;
static u64 log_first_seq;
static u32 log_first_idx;
static u64 log_next_seq;
1863
static enum log_flags console_prev;
1864 1865 1866 1867 1868 1869
static struct cont {
	size_t len;
	size_t cons;
	u8 level;
	bool flushed:1;
} cont;
1870
static struct printk_log *log_from_idx(u32 idx) { return NULL; }
1871 1872
static u32 log_next(u32 idx) { return 0; }
static void call_console_drivers(int level, const char *text, size_t len) {}
1873
static size_t msg_print_text(const struct printk_log *msg, enum log_flags prev,
1874
			     bool syslog, char *buf, size_t size) { return 0; }
1875
static size_t cont_print_text(char *text, size_t size) { return 0; }
M
Matt Mackall 已提交
1876

1877
#endif /* CONFIG_PRINTK */
M
Matt Mackall 已提交
1878

1879 1880 1881
#ifdef CONFIG_EARLY_PRINTK
struct console *early_console;

1882
asmlinkage __visible void early_printk(const char *fmt, ...)
1883 1884
{
	va_list ap;
1885 1886 1887 1888 1889
	char buf[512];
	int n;

	if (!early_console)
		return;
1890 1891

	va_start(ap, fmt);
1892
	n = vscnprintf(buf, sizeof(buf), fmt, ap);
1893
	va_end(ap);
1894 1895

	early_console->write(early_console, buf, n);
1896 1897 1898
}
#endif

1899 1900 1901 1902 1903 1904 1905 1906 1907 1908
static int __add_preferred_console(char *name, int idx, char *options,
				   char *brl_options)
{
	struct console_cmdline *c;
	int i;

	/*
	 *	See if this tty is not yet registered, and
	 *	if we have a slot free.
	 */
1909 1910 1911 1912 1913 1914 1915
	for (i = 0, c = console_cmdline;
	     i < MAX_CMDLINECONSOLES && c->name[0];
	     i++, c++) {
		if (strcmp(c->name, name) == 0 && c->index == idx) {
			if (!brl_options)
				selected_console = i;
			return 0;
1916
		}
1917
	}
1918 1919 1920 1921 1922 1923
	if (i == MAX_CMDLINECONSOLES)
		return -E2BIG;
	if (!brl_options)
		selected_console = i;
	strlcpy(c->name, name, sizeof(c->name));
	c->options = options;
1924 1925
	braille_set_options(c, brl_options);

1926 1927 1928
	c->index = idx;
	return 0;
}
1929
/*
A
Alex Elder 已提交
1930 1931
 * Set up a console.  Called via do_early_param() in init/main.c
 * for each "console=" parameter in the boot command line.
1932 1933 1934
 */
static int __init console_setup(char *str)
{
A
Alex Elder 已提交
1935
	char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for "ttyS" */
1936
	char *s, *options, *brl_options = NULL;
1937 1938
	int idx;

1939 1940
	if (_braille_console_setup(&str, &brl_options))
		return 1;
1941

1942 1943 1944 1945
	/*
	 * Decode str into name, index, options.
	 */
	if (str[0] >= '0' && str[0] <= '9') {
Y
Yinghai Lu 已提交
1946 1947
		strcpy(buf, "ttyS");
		strncpy(buf + 4, str, sizeof(buf) - 5);
1948
	} else {
Y
Yinghai Lu 已提交
1949
		strncpy(buf, str, sizeof(buf) - 1);
1950
	}
Y
Yinghai Lu 已提交
1951
	buf[sizeof(buf) - 1] = 0;
A
Alex Elder 已提交
1952 1953
	options = strchr(str, ',');
	if (options)
1954 1955 1956
		*(options++) = 0;
#ifdef __sparc__
	if (!strcmp(str, "ttya"))
Y
Yinghai Lu 已提交
1957
		strcpy(buf, "ttyS0");
1958
	if (!strcmp(str, "ttyb"))
Y
Yinghai Lu 已提交
1959
		strcpy(buf, "ttyS1");
1960
#endif
Y
Yinghai Lu 已提交
1961
	for (s = buf; *s; s++)
A
Alex Elder 已提交
1962
		if (isdigit(*s) || *s == ',')
1963 1964 1965 1966
			break;
	idx = simple_strtoul(s, NULL, 10);
	*s = 0;

1967
	__add_preferred_console(buf, idx, options, brl_options);
1968
	console_set_on_cmdline = 1;
1969 1970 1971 1972
	return 1;
}
__setup("console=", console_setup);

1973 1974
/**
 * add_preferred_console - add a device to the list of preferred consoles.
1975 1976 1977
 * @name: device name
 * @idx: device index
 * @options: options for this console
1978 1979 1980 1981 1982 1983 1984 1985
 *
 * The last preferred console added will be used for kernel messages
 * and stdin/out/err for init.  Normally this is used by console_setup
 * above to handle user-supplied console arguments; however it can also
 * be used by arch-specific code either to override the user or more
 * commonly to provide a default console (ie from PROM variables) when
 * the user has not supplied one.
 */
1986
int add_preferred_console(char *name, int idx, char *options)
1987
{
1988
	return __add_preferred_console(name, idx, options, NULL);
1989 1990
}

1991
int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options)
1992 1993 1994 1995
{
	struct console_cmdline *c;
	int i;

1996 1997 1998 1999 2000 2001 2002 2003
	for (i = 0, c = console_cmdline;
	     i < MAX_CMDLINECONSOLES && c->name[0];
	     i++, c++)
		if (strcmp(c->name, name) == 0 && c->index == idx) {
			strlcpy(c->name, name_new, sizeof(c->name));
			c->options = options;
			c->index = idx_new;
			return i;
2004 2005 2006 2007 2008
		}
	/* not found */
	return -1;
}

2009
bool console_suspend_enabled = true;
2010 2011 2012 2013
EXPORT_SYMBOL(console_suspend_enabled);

static int __init console_suspend_disable(char *str)
{
2014
	console_suspend_enabled = false;
2015 2016 2017
	return 1;
}
__setup("no_console_suspend", console_suspend_disable);
2018 2019 2020 2021
module_param_named(console_suspend, console_suspend_enabled,
		bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(console_suspend, "suspend console during suspend"
	" and hibernate operations");
2022

2023 2024 2025 2026 2027 2028 2029
/**
 * suspend_console - suspend the console subsystem
 *
 * This disables printk() while we go into suspend states
 */
void suspend_console(void)
{
2030 2031
	if (!console_suspend_enabled)
		return;
2032
	printk("Suspending console(s) (use no_console_suspend to debug)\n");
2033
	console_lock();
2034
	console_suspended = 1;
2035
	up_console_sem();
2036 2037 2038 2039
}

void resume_console(void)
{
2040 2041
	if (!console_suspend_enabled)
		return;
2042
	down_console_sem();
2043
	console_suspended = 0;
2044
	console_unlock();
2045 2046
}

2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057
/**
 * console_cpu_notify - print deferred console messages after CPU hotplug
 * @self: notifier struct
 * @action: CPU hotplug event
 * @hcpu: unused
 *
 * If printk() is called from a CPU that is not online yet, the messages
 * will be spooled but will not show up on the console.  This function is
 * called when a new CPU comes online (or fails to come up), and ensures
 * that any such output gets printed.
 */
2058
static int console_cpu_notify(struct notifier_block *self,
2059 2060 2061 2062 2063 2064 2065
	unsigned long action, void *hcpu)
{
	switch (action) {
	case CPU_ONLINE:
	case CPU_DEAD:
	case CPU_DOWN_FAILED:
	case CPU_UP_CANCELED:
2066 2067
		console_lock();
		console_unlock();
2068 2069 2070 2071
	}
	return NOTIFY_OK;
}

L
Linus Torvalds 已提交
2072
/**
2073
 * console_lock - lock the console system for exclusive use.
L
Linus Torvalds 已提交
2074
 *
2075
 * Acquires a lock which guarantees that the caller has
L
Linus Torvalds 已提交
2076 2077 2078 2079
 * exclusive access to the console system and the console_drivers list.
 *
 * Can sleep, returns nothing.
 */
2080
void console_lock(void)
L
Linus Torvalds 已提交
2081
{
2082 2083
	might_sleep();

2084
	down_console_sem();
2085 2086
	if (console_suspended)
		return;
L
Linus Torvalds 已提交
2087 2088 2089
	console_locked = 1;
	console_may_schedule = 1;
}
2090
EXPORT_SYMBOL(console_lock);
L
Linus Torvalds 已提交
2091

2092 2093 2094
/**
 * console_trylock - try to lock the console system for exclusive use.
 *
A
Alex Elder 已提交
2095 2096
 * Try to acquire a lock which guarantees that the caller has exclusive
 * access to the console system and the console_drivers list.
2097 2098 2099 2100
 *
 * returns 1 on success, and 0 on failure to acquire the lock.
 */
int console_trylock(void)
L
Linus Torvalds 已提交
2101
{
2102
	if (down_trylock_console_sem())
2103
		return 0;
2104
	if (console_suspended) {
2105
		up_console_sem();
2106
		return 0;
2107
	}
L
Linus Torvalds 已提交
2108 2109
	console_locked = 1;
	console_may_schedule = 0;
2110
	return 1;
L
Linus Torvalds 已提交
2111
}
2112
EXPORT_SYMBOL(console_trylock);
L
Linus Torvalds 已提交
2113 2114 2115 2116 2117 2118

int is_console_locked(void)
{
	return console_locked;
}

2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146
static void console_cont_flush(char *text, size_t size)
{
	unsigned long flags;
	size_t len;

	raw_spin_lock_irqsave(&logbuf_lock, flags);

	if (!cont.len)
		goto out;

	/*
	 * We still queue earlier records, likely because the console was
	 * busy. The earlier ones need to be printed before this one, we
	 * did not flush any fragment so far, so just let it queue up.
	 */
	if (console_seq < log_next_seq && !cont.cons)
		goto out;

	len = cont_print_text(text, size);
	raw_spin_unlock(&logbuf_lock);
	stop_critical_timings();
	call_console_drivers(cont.level, text, len);
	start_critical_timings();
	local_irq_restore(flags);
	return;
out:
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
}
2147

L
Linus Torvalds 已提交
2148
/**
2149
 * console_unlock - unlock the console system
L
Linus Torvalds 已提交
2150
 *
2151
 * Releases the console_lock which the caller holds on the console system
L
Linus Torvalds 已提交
2152 2153
 * and the console driver list.
 *
2154 2155 2156
 * While the console_lock was held, console output may have been buffered
 * by printk().  If this is the case, console_unlock(); emits
 * the output prior to releasing the lock.
L
Linus Torvalds 已提交
2157
 *
2158
 * If there is output waiting, we wake /dev/kmsg and syslog() users.
L
Linus Torvalds 已提交
2159
 *
2160
 * console_unlock(); may be called from any context.
L
Linus Torvalds 已提交
2161
 */
2162
void console_unlock(void)
L
Linus Torvalds 已提交
2163
{
2164
	static char text[LOG_LINE_MAX + PREFIX_MAX];
2165
	static u64 seen_seq;
L
Linus Torvalds 已提交
2166
	unsigned long flags;
2167 2168
	bool wake_klogd = false;
	bool retry;
L
Linus Torvalds 已提交
2169

2170
	if (console_suspended) {
2171
		up_console_sem();
2172 2173
		return;
	}
2174 2175 2176

	console_may_schedule = 0;

2177
	/* flush buffered message fragment immediately to console */
2178
	console_cont_flush(text, sizeof(text));
2179
again:
2180
	for (;;) {
2181
		struct printk_log *msg;
2182
		size_t len;
2183 2184
		int level;

2185
		raw_spin_lock_irqsave(&logbuf_lock, flags);
2186 2187 2188 2189 2190 2191
		if (seen_seq != log_next_seq) {
			wake_klogd = true;
			seen_seq = log_next_seq;
		}

		if (console_seq < log_first_seq) {
2192 2193 2194
			len = sprintf(text, "** %u printk messages dropped ** ",
				      (unsigned)(log_first_seq - console_seq));

2195 2196 2197
			/* messages are gone, move to first one */
			console_seq = log_first_seq;
			console_idx = log_first_idx;
2198
			console_prev = 0;
2199 2200
		} else {
			len = 0;
2201
		}
2202
skip:
2203 2204 2205 2206
		if (console_seq == log_next_seq)
			break;

		msg = log_from_idx(console_idx);
2207 2208 2209 2210 2211 2212 2213
		if (msg->flags & LOG_NOCONS) {
			/*
			 * Skip record we have buffered and already printed
			 * directly to the console when we received it.
			 */
			console_idx = log_next(console_idx);
			console_seq++;
2214 2215 2216 2217 2218 2219
			/*
			 * We will get here again when we register a new
			 * CON_PRINTBUFFER console. Clear the flag so we
			 * will properly dump everything later.
			 */
			msg->flags &= ~LOG_NOCONS;
2220
			console_prev = msg->flags;
2221 2222
			goto skip;
		}
2223

2224
		level = msg->level;
2225 2226
		len += msg_print_text(msg, console_prev, false,
				      text + len, sizeof(text) - len);
2227 2228
		console_idx = log_next(console_idx);
		console_seq++;
2229
		console_prev = msg->flags;
2230
		raw_spin_unlock(&logbuf_lock);
2231

2232
		stop_critical_timings();	/* don't trace print latency */
2233
		call_console_drivers(level, text, len);
2234
		start_critical_timings();
L
Linus Torvalds 已提交
2235 2236 2237
		local_irq_restore(flags);
	}
	console_locked = 0;
2238 2239 2240 2241 2242

	/* Release the exclusive_console once it is used */
	if (unlikely(exclusive_console))
		exclusive_console = NULL;

2243
	raw_spin_unlock(&logbuf_lock);
2244

2245
	up_console_sem();
2246 2247 2248 2249 2250 2251 2252

	/*
	 * Someone could have filled up the buffer again, so re-check if there's
	 * something to flush. In case we cannot trylock the console_sem again,
	 * there's a new owner and the console_unlock() from them will do the
	 * flush, no worries.
	 */
2253
	raw_spin_lock(&logbuf_lock);
2254
	retry = console_seq != log_next_seq;
P
Peter Zijlstra 已提交
2255 2256
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);

2257 2258 2259
	if (retry && console_trylock())
		goto again;

2260 2261
	if (wake_klogd)
		wake_up_klogd();
L
Linus Torvalds 已提交
2262
}
2263
EXPORT_SYMBOL(console_unlock);
L
Linus Torvalds 已提交
2264

2265 2266
/**
 * console_conditional_schedule - yield the CPU if required
L
Linus Torvalds 已提交
2267 2268 2269 2270 2271
 *
 * If the console code is currently allowed to sleep, and
 * if this CPU should yield the CPU to another task, do
 * so here.
 *
2272
 * Must be called within console_lock();.
L
Linus Torvalds 已提交
2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289
 */
void __sched console_conditional_schedule(void)
{
	if (console_may_schedule)
		cond_resched();
}
EXPORT_SYMBOL(console_conditional_schedule);

void console_unblank(void)
{
	struct console *c;

	/*
	 * console_unblank can no longer be called in interrupt context unless
	 * oops_in_progress is set to 1..
	 */
	if (oops_in_progress) {
2290
		if (down_trylock_console_sem() != 0)
L
Linus Torvalds 已提交
2291 2292
			return;
	} else
2293
		console_lock();
L
Linus Torvalds 已提交
2294 2295 2296

	console_locked = 1;
	console_may_schedule = 0;
2297
	for_each_console(c)
L
Linus Torvalds 已提交
2298 2299
		if ((c->flags & CON_ENABLED) && c->unblank)
			c->unblank();
2300
	console_unlock();
L
Linus Torvalds 已提交
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310
}

/*
 * Return the console tty driver structure and its associated index
 */
struct tty_driver *console_device(int *index)
{
	struct console *c;
	struct tty_driver *driver = NULL;

2311
	console_lock();
2312
	for_each_console(c) {
L
Linus Torvalds 已提交
2313 2314 2315 2316 2317 2318
		if (!c->device)
			continue;
		driver = c->device(c, index);
		if (driver)
			break;
	}
2319
	console_unlock();
L
Linus Torvalds 已提交
2320 2321 2322 2323 2324 2325 2326 2327 2328 2329
	return driver;
}

/*
 * Prevent further output on the passed console device so that (for example)
 * serial drivers can disable console output before suspending a port, and can
 * re-enable output afterwards.
 */
void console_stop(struct console *console)
{
2330
	console_lock();
L
Linus Torvalds 已提交
2331
	console->flags &= ~CON_ENABLED;
2332
	console_unlock();
L
Linus Torvalds 已提交
2333 2334 2335 2336 2337
}
EXPORT_SYMBOL(console_stop);

void console_start(struct console *console)
{
2338
	console_lock();
L
Linus Torvalds 已提交
2339
	console->flags |= CON_ENABLED;
2340
	console_unlock();
L
Linus Torvalds 已提交
2341 2342 2343
}
EXPORT_SYMBOL(console_start);

2344 2345 2346 2347 2348
static int __read_mostly keep_bootcon;

static int __init keep_bootcon_setup(char *str)
{
	keep_bootcon = 1;
2349
	pr_info("debug: skip boot console de-registration.\n");
2350 2351 2352 2353 2354 2355

	return 0;
}

early_param("keep_bootcon", keep_bootcon_setup);

L
Linus Torvalds 已提交
2356 2357 2358 2359 2360
/*
 * The console driver calls this routine during kernel initialization
 * to register the console printing procedure with printk() and to
 * print any messages that were printed by the kernel before the
 * console driver was initialized.
2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373
 *
 * This can happen pretty early during the boot process (because of
 * early_printk) - sometimes before setup_arch() completes - be careful
 * of what kernel features are used - they may not be initialised yet.
 *
 * There are two types of consoles - bootconsoles (early_printk) and
 * "real" consoles (everything which is not a bootconsole) which are
 * handled differently.
 *  - Any number of bootconsoles can be registered at any time.
 *  - As soon as a "real" console is registered, all bootconsoles
 *    will be unregistered automatically.
 *  - Once a "real" console is registered, any attempt to register a
 *    bootconsoles will be rejected
L
Linus Torvalds 已提交
2374
 */
2375
void register_console(struct console *newcon)
L
Linus Torvalds 已提交
2376
{
J
Jesper Juhl 已提交
2377
	int i;
L
Linus Torvalds 已提交
2378
	unsigned long flags;
2379
	struct console *bcon = NULL;
2380
	struct console_cmdline *c;
L
Linus Torvalds 已提交
2381

2382 2383 2384 2385 2386 2387 2388
	if (console_drivers)
		for_each_console(bcon)
			if (WARN(bcon == newcon,
					"console '%s%d' already registered\n",
					bcon->name, bcon->index))
				return;

2389 2390 2391 2392 2393 2394 2395 2396
	/*
	 * before we register a new CON_BOOT console, make sure we don't
	 * already have a valid console
	 */
	if (console_drivers && newcon->flags & CON_BOOT) {
		/* find the last or real console */
		for_each_console(bcon) {
			if (!(bcon->flags & CON_BOOT)) {
2397
				pr_info("Too late to register bootconsole %s%d\n",
2398 2399 2400 2401
					newcon->name, newcon->index);
				return;
			}
		}
2402 2403
	}

2404 2405 2406 2407
	if (console_drivers && console_drivers->flags & CON_BOOT)
		bcon = console_drivers;

	if (preferred_console < 0 || bcon || !console_drivers)
L
Linus Torvalds 已提交
2408 2409
		preferred_console = selected_console;

2410 2411
	if (newcon->early_setup)
		newcon->early_setup();
2412

L
Linus Torvalds 已提交
2413 2414 2415 2416 2417 2418
	/*
	 *	See if we want to use this console driver. If we
	 *	didn't select a console we take the first one
	 *	that registers here.
	 */
	if (preferred_console < 0) {
2419 2420 2421 2422 2423 2424 2425
		if (newcon->index < 0)
			newcon->index = 0;
		if (newcon->setup == NULL ||
		    newcon->setup(newcon, NULL) == 0) {
			newcon->flags |= CON_ENABLED;
			if (newcon->device) {
				newcon->flags |= CON_CONSDEV;
2426 2427
				preferred_console = 0;
			}
L
Linus Torvalds 已提交
2428 2429 2430 2431 2432 2433 2434
		}
	}

	/*
	 *	See if this console matches one we selected on
	 *	the command line.
	 */
2435 2436 2437 2438
	for (i = 0, c = console_cmdline;
	     i < MAX_CMDLINECONSOLES && c->name[0];
	     i++, c++) {
		if (strcmp(c->name, newcon->name) != 0)
L
Linus Torvalds 已提交
2439
			continue;
2440
		if (newcon->index >= 0 &&
2441
		    newcon->index != c->index)
L
Linus Torvalds 已提交
2442
			continue;
2443
		if (newcon->index < 0)
2444
			newcon->index = c->index;
2445

2446
		if (_braille_register_console(newcon, c))
2447
			return;
2448

2449 2450
		if (newcon->setup &&
		    newcon->setup(newcon, console_cmdline[i].options) != 0)
L
Linus Torvalds 已提交
2451
			break;
2452
		newcon->flags |= CON_ENABLED;
2453
		newcon->index = c->index;
2454
		if (i == selected_console) {
2455
			newcon->flags |= CON_CONSDEV;
2456 2457
			preferred_console = selected_console;
		}
L
Linus Torvalds 已提交
2458 2459 2460
		break;
	}

2461
	if (!(newcon->flags & CON_ENABLED))
L
Linus Torvalds 已提交
2462 2463
		return;

2464 2465 2466 2467 2468 2469 2470
	/*
	 * If we have a bootconsole, and are switching to a real console,
	 * don't print everything out again, since when the boot console, and
	 * the real console are the same physical device, it's annoying to
	 * see the beginning boot messages twice
	 */
	if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
2471
		newcon->flags &= ~CON_PRINTBUFFER;
L
Linus Torvalds 已提交
2472 2473 2474 2475 2476

	/*
	 *	Put this console in the list - keep the
	 *	preferred driver at the head of the list.
	 */
2477
	console_lock();
2478 2479 2480 2481 2482
	if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
		newcon->next = console_drivers;
		console_drivers = newcon;
		if (newcon->next)
			newcon->next->flags &= ~CON_CONSDEV;
L
Linus Torvalds 已提交
2483
	} else {
2484 2485
		newcon->next = console_drivers->next;
		console_drivers->next = newcon;
L
Linus Torvalds 已提交
2486
	}
2487
	if (newcon->flags & CON_PRINTBUFFER) {
L
Linus Torvalds 已提交
2488
		/*
2489
		 * console_unlock(); will print out the buffered messages
L
Linus Torvalds 已提交
2490 2491
		 * for us.
		 */
2492
		raw_spin_lock_irqsave(&logbuf_lock, flags);
2493 2494
		console_seq = syslog_seq;
		console_idx = syslog_idx;
2495
		console_prev = syslog_prev;
2496
		raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2497 2498 2499 2500 2501 2502
		/*
		 * We're about to replay the log buffer.  Only do this to the
		 * just-registered console to avoid excessive message spam to
		 * the already-registered consoles.
		 */
		exclusive_console = newcon;
L
Linus Torvalds 已提交
2503
	}
2504
	console_unlock();
2505
	console_sysfs_notify();
2506 2507 2508 2509 2510 2511 2512 2513

	/*
	 * By unregistering the bootconsoles after we enable the real console
	 * we get the "console xxx enabled" message on all the consoles -
	 * boot consoles, real consoles, etc - this is to ensure that end
	 * users know there might be something in the kernel's log buffer that
	 * went to the bootconsole (that they do not see on the real console)
	 */
2514
	pr_info("%sconsole [%s%d] enabled\n",
2515 2516
		(newcon->flags & CON_BOOT) ? "boot" : "" ,
		newcon->name, newcon->index);
2517 2518 2519
	if (bcon &&
	    ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
	    !keep_bootcon) {
2520 2521
		/* We need to iterate through all boot consoles, to make
		 * sure we print everything out, before we unregister them.
2522 2523 2524 2525 2526
		 */
		for_each_console(bcon)
			if (bcon->flags & CON_BOOT)
				unregister_console(bcon);
	}
L
Linus Torvalds 已提交
2527 2528 2529
}
EXPORT_SYMBOL(register_console);

J
Jesper Juhl 已提交
2530
int unregister_console(struct console *console)
L
Linus Torvalds 已提交
2531
{
J
Jesper Juhl 已提交
2532
        struct console *a, *b;
2533
	int res;
L
Linus Torvalds 已提交
2534

2535
	pr_info("%sconsole [%s%d] disabled\n",
2536 2537 2538
		(console->flags & CON_BOOT) ? "boot" : "" ,
		console->name, console->index);

2539 2540 2541
	res = _braille_unregister_console(console);
	if (res)
		return res;
2542

2543
	res = 1;
2544
	console_lock();
L
Linus Torvalds 已提交
2545 2546 2547
	if (console_drivers == console) {
		console_drivers=console->next;
		res = 0;
2548
	} else if (console_drivers) {
L
Linus Torvalds 已提交
2549 2550 2551 2552 2553 2554
		for (a=console_drivers->next, b=console_drivers ;
		     a; b=a, a=b->next) {
			if (a == console) {
				b->next = a->next;
				res = 0;
				break;
J
Jesper Juhl 已提交
2555
			}
L
Linus Torvalds 已提交
2556 2557
		}
	}
J
Jesper Juhl 已提交
2558

2559
	/*
2560 2561
	 * If this isn't the last console and it has CON_CONSDEV set, we
	 * need to set it on the next preferred console.
L
Linus Torvalds 已提交
2562
	 */
2563
	if (console_drivers != NULL && console->flags & CON_CONSDEV)
2564
		console_drivers->flags |= CON_CONSDEV;
L
Linus Torvalds 已提交
2565

2566
	console->flags &= ~CON_ENABLED;
2567
	console_unlock();
2568
	console_sysfs_notify();
L
Linus Torvalds 已提交
2569 2570 2571
	return res;
}
EXPORT_SYMBOL(unregister_console);
M
Matt Mackall 已提交
2572

2573
static int __init printk_late_init(void)
2574
{
2575 2576 2577
	struct console *con;

	for_each_console(con) {
2578
		if (!keep_bootcon && con->flags & CON_BOOT) {
2579
			unregister_console(con);
2580
		}
2581
	}
2582
	hotcpu_notifier(console_cpu_notify, 0);
2583 2584
	return 0;
}
2585
late_initcall(printk_late_init);
2586

2587
#if defined CONFIG_PRINTK
2588 2589 2590 2591
/*
 * Delayed printk version, for scheduler-internal messages:
 */
#define PRINTK_PENDING_WAKEUP	0x01
2592
#define PRINTK_PENDING_OUTPUT	0x02
2593 2594 2595 2596 2597 2598 2599

static DEFINE_PER_CPU(int, printk_pending);

static void wake_up_klogd_work_func(struct irq_work *irq_work)
{
	int pending = __this_cpu_xchg(printk_pending, 0);

2600 2601 2602 2603
	if (pending & PRINTK_PENDING_OUTPUT) {
		/* If trylock fails, someone else is doing the printing */
		if (console_trylock())
			console_unlock();
2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619
	}

	if (pending & PRINTK_PENDING_WAKEUP)
		wake_up_interruptible(&log_wait);
}

static DEFINE_PER_CPU(struct irq_work, wake_up_klogd_work) = {
	.func = wake_up_klogd_work_func,
	.flags = IRQ_WORK_LAZY,
};

void wake_up_klogd(void)
{
	preempt_disable();
	if (waitqueue_active(&log_wait)) {
		this_cpu_or(printk_pending, PRINTK_PENDING_WAKEUP);
2620
		irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2621 2622 2623
	}
	preempt_enable();
}
D
Dave Young 已提交
2624

2625
int printk_deferred(const char *fmt, ...)
2626 2627 2628 2629
{
	va_list args;
	int r;

2630
	preempt_disable();
2631
	va_start(args, fmt);
2632
	r = vprintk_emit(0, LOGLEVEL_SCHED, NULL, 0, fmt, args);
2633 2634
	va_end(args);

2635
	__this_cpu_or(printk_pending, PRINTK_PENDING_OUTPUT);
2636
	irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2637
	preempt_enable();
2638 2639 2640 2641

	return r;
}

L
Linus Torvalds 已提交
2642 2643 2644
/*
 * printk rate limiting, lifted from the networking subsystem.
 *
2645 2646
 * This enforces a rate limit: not more than 10 kernel messages
 * every 5s to make a denial-of-service attack impossible.
L
Linus Torvalds 已提交
2647
 */
2648 2649
DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);

2650
int __printk_ratelimit(const char *func)
L
Linus Torvalds 已提交
2651
{
2652
	return ___ratelimit(&printk_ratelimit_state, func);
L
Linus Torvalds 已提交
2653
}
2654
EXPORT_SYMBOL(__printk_ratelimit);
2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667

/**
 * printk_timed_ratelimit - caller-controlled printk ratelimiting
 * @caller_jiffies: pointer to caller's state
 * @interval_msecs: minimum interval between prints
 *
 * printk_timed_ratelimit() returns true if more than @interval_msecs
 * milliseconds have elapsed since the last time printk_timed_ratelimit()
 * returned true.
 */
bool printk_timed_ratelimit(unsigned long *caller_jiffies,
			unsigned int interval_msecs)
{
A
Alex Elder 已提交
2668 2669 2670 2671 2672 2673 2674
	unsigned long elapsed = jiffies - *caller_jiffies;

	if (*caller_jiffies && elapsed <= msecs_to_jiffies(interval_msecs))
		return false;

	*caller_jiffies = jiffies;
	return true;
2675 2676
}
EXPORT_SYMBOL(printk_timed_ratelimit);
2677 2678 2679 2680 2681 2682

static DEFINE_SPINLOCK(dump_list_lock);
static LIST_HEAD(dump_list);

/**
 * kmsg_dump_register - register a kernel log dumper.
R
Randy Dunlap 已提交
2683
 * @dumper: pointer to the kmsg_dumper structure
2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701
 *
 * Adds a kernel log dumper to the system. The dump callback in the
 * structure will be called when the kernel oopses or panics and must be
 * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
 */
int kmsg_dump_register(struct kmsg_dumper *dumper)
{
	unsigned long flags;
	int err = -EBUSY;

	/* The dump callback needs to be set */
	if (!dumper->dump)
		return -EINVAL;

	spin_lock_irqsave(&dump_list_lock, flags);
	/* Don't allow registering multiple times */
	if (!dumper->registered) {
		dumper->registered = 1;
2702
		list_add_tail_rcu(&dumper->list, &dump_list);
2703 2704 2705 2706 2707 2708 2709 2710 2711 2712
		err = 0;
	}
	spin_unlock_irqrestore(&dump_list_lock, flags);

	return err;
}
EXPORT_SYMBOL_GPL(kmsg_dump_register);

/**
 * kmsg_dump_unregister - unregister a kmsg dumper.
R
Randy Dunlap 已提交
2713
 * @dumper: pointer to the kmsg_dumper structure
2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725
 *
 * Removes a dump device from the system. Returns zero on success and
 * %-EINVAL otherwise.
 */
int kmsg_dump_unregister(struct kmsg_dumper *dumper)
{
	unsigned long flags;
	int err = -EINVAL;

	spin_lock_irqsave(&dump_list_lock, flags);
	if (dumper->registered) {
		dumper->registered = 0;
2726
		list_del_rcu(&dumper->list);
2727 2728 2729
		err = 0;
	}
	spin_unlock_irqrestore(&dump_list_lock, flags);
2730
	synchronize_rcu();
2731 2732 2733 2734 2735

	return err;
}
EXPORT_SYMBOL_GPL(kmsg_dump_unregister);

2736 2737 2738
static bool always_kmsg_dump;
module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);

2739 2740 2741 2742
/**
 * kmsg_dump - dump kernel log to kernel message dumpers.
 * @reason: the reason (oops, panic etc) for dumping
 *
2743 2744 2745
 * Call each of the registered dumper's dump() callback, which can
 * retrieve the kmsg records with kmsg_dump_get_line() or
 * kmsg_dump_get_buffer().
2746 2747 2748 2749 2750 2751
 */
void kmsg_dump(enum kmsg_dump_reason reason)
{
	struct kmsg_dumper *dumper;
	unsigned long flags;

2752 2753 2754
	if ((reason > KMSG_DUMP_OOPS) && !always_kmsg_dump)
		return;

2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779
	rcu_read_lock();
	list_for_each_entry_rcu(dumper, &dump_list, list) {
		if (dumper->max_reason && reason > dumper->max_reason)
			continue;

		/* initialize iterator with data about the stored records */
		dumper->active = true;

		raw_spin_lock_irqsave(&logbuf_lock, flags);
		dumper->cur_seq = clear_seq;
		dumper->cur_idx = clear_idx;
		dumper->next_seq = log_next_seq;
		dumper->next_idx = log_next_idx;
		raw_spin_unlock_irqrestore(&logbuf_lock, flags);

		/* invoke dumper which will iterate over records */
		dumper->dump(dumper, reason);

		/* reset iterator */
		dumper->active = false;
	}
	rcu_read_unlock();
}

/**
2780
 * kmsg_dump_get_line_nolock - retrieve one kmsg log line (unlocked version)
2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794
 * @dumper: registered kmsg dumper
 * @syslog: include the "<4>" prefixes
 * @line: buffer to copy the line to
 * @size: maximum size of the buffer
 * @len: length of line placed into buffer
 *
 * Start at the beginning of the kmsg buffer, with the oldest kmsg
 * record, and copy one record into the provided buffer.
 *
 * Consecutive calls will return the next available record moving
 * towards the end of the buffer with the youngest messages.
 *
 * A return value of FALSE indicates that there are no more records to
 * read.
2795 2796
 *
 * The function is similar to kmsg_dump_get_line(), but grabs no locks.
2797
 */
2798 2799
bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper, bool syslog,
			       char *line, size_t size, size_t *len)
2800
{
2801
	struct printk_log *msg;
2802 2803 2804 2805 2806
	size_t l = 0;
	bool ret = false;

	if (!dumper->active)
		goto out;
2807

2808 2809 2810 2811 2812
	if (dumper->cur_seq < log_first_seq) {
		/* messages are gone, move to first available one */
		dumper->cur_seq = log_first_seq;
		dumper->cur_idx = log_first_idx;
	}
2813

2814
	/* last entry */
2815
	if (dumper->cur_seq >= log_next_seq)
2816
		goto out;
2817

2818
	msg = log_from_idx(dumper->cur_idx);
2819
	l = msg_print_text(msg, 0, syslog, line, size);
2820 2821 2822 2823 2824 2825 2826 2827 2828

	dumper->cur_idx = log_next(dumper->cur_idx);
	dumper->cur_seq++;
	ret = true;
out:
	if (len)
		*len = l;
	return ret;
}
2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858

/**
 * kmsg_dump_get_line - retrieve one kmsg log line
 * @dumper: registered kmsg dumper
 * @syslog: include the "<4>" prefixes
 * @line: buffer to copy the line to
 * @size: maximum size of the buffer
 * @len: length of line placed into buffer
 *
 * Start at the beginning of the kmsg buffer, with the oldest kmsg
 * record, and copy one record into the provided buffer.
 *
 * Consecutive calls will return the next available record moving
 * towards the end of the buffer with the youngest messages.
 *
 * A return value of FALSE indicates that there are no more records to
 * read.
 */
bool kmsg_dump_get_line(struct kmsg_dumper *dumper, bool syslog,
			char *line, size_t size, size_t *len)
{
	unsigned long flags;
	bool ret;

	raw_spin_lock_irqsave(&logbuf_lock, flags);
	ret = kmsg_dump_get_line_nolock(dumper, syslog, line, size, len);
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);

	return ret;
}
2859 2860 2861 2862 2863 2864
EXPORT_SYMBOL_GPL(kmsg_dump_get_line);

/**
 * kmsg_dump_get_buffer - copy kmsg log lines
 * @dumper: registered kmsg dumper
 * @syslog: include the "<4>" prefixes
R
Randy Dunlap 已提交
2865
 * @buf: buffer to copy the line to
2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887
 * @size: maximum size of the buffer
 * @len: length of line placed into buffer
 *
 * Start at the end of the kmsg buffer and fill the provided buffer
 * with as many of the the *youngest* kmsg records that fit into it.
 * If the buffer is large enough, all available kmsg records will be
 * copied with a single call.
 *
 * Consecutive calls will fill the buffer with the next block of
 * available older records, not including the earlier retrieved ones.
 *
 * A return value of FALSE indicates that there are no more records to
 * read.
 */
bool kmsg_dump_get_buffer(struct kmsg_dumper *dumper, bool syslog,
			  char *buf, size_t size, size_t *len)
{
	unsigned long flags;
	u64 seq;
	u32 idx;
	u64 next_seq;
	u32 next_idx;
2888
	enum log_flags prev;
2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910
	size_t l = 0;
	bool ret = false;

	if (!dumper->active)
		goto out;

	raw_spin_lock_irqsave(&logbuf_lock, flags);
	if (dumper->cur_seq < log_first_seq) {
		/* messages are gone, move to first available one */
		dumper->cur_seq = log_first_seq;
		dumper->cur_idx = log_first_idx;
	}

	/* last entry */
	if (dumper->cur_seq >= dumper->next_seq) {
		raw_spin_unlock_irqrestore(&logbuf_lock, flags);
		goto out;
	}

	/* calculate length of entire buffer */
	seq = dumper->cur_seq;
	idx = dumper->cur_idx;
2911
	prev = 0;
2912
	while (seq < dumper->next_seq) {
2913
		struct printk_log *msg = log_from_idx(idx);
2914

2915
		l += msg_print_text(msg, prev, true, NULL, 0);
2916 2917
		idx = log_next(idx);
		seq++;
2918
		prev = msg->flags;
2919 2920 2921 2922 2923
	}

	/* move first record forward until length fits into the buffer */
	seq = dumper->cur_seq;
	idx = dumper->cur_idx;
2924
	prev = 0;
2925
	while (l > size && seq < dumper->next_seq) {
2926
		struct printk_log *msg = log_from_idx(idx);
2927

2928
		l -= msg_print_text(msg, prev, true, NULL, 0);
2929 2930
		idx = log_next(idx);
		seq++;
2931
		prev = msg->flags;
2932
	}
2933 2934 2935 2936 2937 2938 2939

	/* last message in next interation */
	next_seq = seq;
	next_idx = idx;

	l = 0;
	while (seq < dumper->next_seq) {
2940
		struct printk_log *msg = log_from_idx(idx);
2941

2942
		l += msg_print_text(msg, prev, syslog, buf + l, size - l);
2943 2944
		idx = log_next(idx);
		seq++;
2945
		prev = msg->flags;
2946 2947 2948 2949 2950
	}

	dumper->next_seq = next_seq;
	dumper->next_idx = next_idx;
	ret = true;
2951
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2952 2953 2954 2955 2956 2957
out:
	if (len)
		*len = l;
	return ret;
}
EXPORT_SYMBOL_GPL(kmsg_dump_get_buffer);
2958

2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976
/**
 * kmsg_dump_rewind_nolock - reset the interator (unlocked version)
 * @dumper: registered kmsg dumper
 *
 * Reset the dumper's iterator so that kmsg_dump_get_line() and
 * kmsg_dump_get_buffer() can be called again and used multiple
 * times within the same dumper.dump() callback.
 *
 * The function is similar to kmsg_dump_rewind(), but grabs no locks.
 */
void kmsg_dump_rewind_nolock(struct kmsg_dumper *dumper)
{
	dumper->cur_seq = clear_seq;
	dumper->cur_idx = clear_idx;
	dumper->next_seq = log_next_seq;
	dumper->next_idx = log_next_idx;
}

2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989
/**
 * kmsg_dump_rewind - reset the interator
 * @dumper: registered kmsg dumper
 *
 * Reset the dumper's iterator so that kmsg_dump_get_line() and
 * kmsg_dump_get_buffer() can be called again and used multiple
 * times within the same dumper.dump() callback.
 */
void kmsg_dump_rewind(struct kmsg_dumper *dumper)
{
	unsigned long flags;

	raw_spin_lock_irqsave(&logbuf_lock, flags);
2990
	kmsg_dump_rewind_nolock(dumper);
2991
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2992
}
2993
EXPORT_SYMBOL_GPL(kmsg_dump_rewind);
2994

2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016
static char dump_stack_arch_desc_str[128];

/**
 * dump_stack_set_arch_desc - set arch-specific str to show with task dumps
 * @fmt: printf-style format string
 * @...: arguments for the format string
 *
 * The configured string will be printed right after utsname during task
 * dumps.  Usually used to add arch-specific system identifiers.  If an
 * arch wants to make use of such an ID string, it should initialize this
 * as soon as possible during boot.
 */
void __init dump_stack_set_arch_desc(const char *fmt, ...)
{
	va_list args;

	va_start(args, fmt);
	vsnprintf(dump_stack_arch_desc_str, sizeof(dump_stack_arch_desc_str),
		  fmt, args);
	va_end(args);
}

3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030
/**
 * dump_stack_print_info - print generic debug info for dump_stack()
 * @log_lvl: log level
 *
 * Arch-specific dump_stack() implementations can use this function to
 * print out the same debug information as the generic dump_stack().
 */
void dump_stack_print_info(const char *log_lvl)
{
	printk("%sCPU: %d PID: %d Comm: %.20s %s %s %.*s\n",
	       log_lvl, raw_smp_processor_id(), current->pid, current->comm,
	       print_tainted(), init_utsname()->release,
	       (int)strcspn(init_utsname()->version, " "),
	       init_utsname()->version);
3031 3032 3033 3034

	if (dump_stack_arch_desc_str[0] != '\0')
		printk("%sHardware name: %s\n",
		       log_lvl, dump_stack_arch_desc_str);
3035 3036

	print_worker_info(log_lvl, current);
3037 3038
}

3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054
/**
 * show_regs_print_info - print generic debug info for show_regs()
 * @log_lvl: log level
 *
 * show_regs() implementations can use this function to print out generic
 * debug information.
 */
void show_regs_print_info(const char *log_lvl)
{
	dump_stack_print_info(log_lvl);

	printk("%stask: %p ti: %p task.ti: %p\n",
	       log_lvl, current, current_thread_info(),
	       task_thread_info(current));
}

3055
#endif