printk.c 80.7 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>
L
Linus Torvalds 已提交
35
#include <linux/syscalls.h>
36
#include <linux/kexec.h>
37
#include <linux/kdb.h>
38
#include <linux/ratelimit.h>
39
#include <linux/kmsg_dump.h>
40
#include <linux/syslog.h>
41 42
#include <linux/cpu.h>
#include <linux/notifier.h>
43
#include <linux/rculist.h>
44
#include <linux/poll.h>
45
#include <linux/irq_work.h>
46
#include <linux/utsname.h>
A
Alex Elder 已提交
47
#include <linux/ctype.h>
48
#include <linux/uio.h>
L
Linus Torvalds 已提交
49 50

#include <asm/uaccess.h>
51
#include <asm-generic/sections.h>
L
Linus Torvalds 已提交
52

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

J
Joe Perches 已提交
56
#include "console_cmdline.h"
57
#include "braille.h"
58
#include "internal.h"
J
Joe Perches 已提交
59

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

/*
P
Patrick Pletscher 已提交
68
 * Low level drivers may need that to know if they can schedule in
L
Linus Torvalds 已提交
69 70 71 72 73 74 75 76 77 78
 * 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.
 */
79
static DEFINE_SEMAPHORE(console_sem);
L
Linus Torvalds 已提交
80
struct console *console_drivers;
I
Ingo Molnar 已提交
81 82
EXPORT_SYMBOL_GPL(console_drivers);

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

89 90 91 92 93 94 95 96 97 98 99 100
/*
 * Number of registered extended console drivers.
 *
 * If extended consoles are present, in-kernel cont reassembly is disabled
 * and each fragment is stored as a separate log entry with proper
 * continuation flag so that every emitted message has full metadata.  This
 * doesn't change the result for regular consoles or /proc/kmsg.  For
 * /dev/kmsg, as long as the reader concatenates messages according to
 * consecutive continuation flags, the end result should be the same too.
 */
static int nr_ext_console_drivers;

101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
/*
 * 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 已提交
124 125 126 127
/*
 * 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 已提交
128 129 130
 * 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 已提交
131
 */
132
static int console_locked, console_suspended;
L
Linus Torvalds 已提交
133

134 135 136 137 138
/*
 * If exclusive_console is non-NULL then only this console is to be printed to.
 */
static struct console *exclusive_console;

L
Linus Torvalds 已提交
139 140 141 142 143 144 145
/*
 *	Array of consoles built from command line options (console=)
 */

#define MAX_CMDLINECONSOLES 8

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

L
Linus Torvalds 已提交
147 148
static int selected_console = -1;
static int preferred_console = -1;
149 150
int console_set_on_cmdline;
EXPORT_SYMBOL(console_set_on_cmdline);
L
Linus Torvalds 已提交
151 152 153 154

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

155 156 157 158 159 160
/*
 * 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 已提交
161 162
 * sequence numbers of these entries are maintained when messages are
 * stored.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
 *
 * 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.
 *
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
 * 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
 *
207
 * The 'struct printk_log' buffer header must never be directly exported to
208 209 210 211
 * 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:
212 213 214 215
 *   "<level>,<sequnum>,<timestamp>,<contflag>[,additional_values, ... ];<message text>\n"
 *
 * Users of the export format should ignore possible additional values
 * separated by ',', and find the message after the ';' character.
216 217 218 219
 *
 * 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.
220 221
 */

222
enum log_flags {
223 224 225 226
	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 */
227 228
};

229
struct printk_log {
230 231 232 233
	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 */
234 235 236
	u8 facility;		/* syslog facility */
	u8 flags:5;		/* internal record flags */
	u8 level:3;		/* syslog level */
237 238 239 240 241
}
#ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
__packed __aligned(4)
#endif
;
242 243

/*
244 245 246
 * 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.
247 248
 */
static DEFINE_RAW_SPINLOCK(logbuf_lock);
M
Matt Mackall 已提交
249

250
#ifdef CONFIG_PRINTK
251
DECLARE_WAIT_QUEUE_HEAD(log_wait);
252 253 254
/* the next printk record to read by syslog(READ) or /proc/kmsg */
static u64 syslog_seq;
static u32 syslog_idx;
255
static enum log_flags syslog_prev;
256
static size_t syslog_partial;
257 258 259 260 261 262 263 264 265

/* 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;

266 267 268 269 270
/* the next printk record to write to the console */
static u64 console_seq;
static u32 console_idx;
static enum log_flags console_prev;

271 272 273 274
/* the next printk record to read after the last 'clear' command */
static u64 clear_seq;
static u32 clear_idx;

275
#define PREFIX_MAX		32
A
Alex Elder 已提交
276
#define LOG_LINE_MAX		(1024 - PREFIX_MAX)
277

278 279 280
#define LOG_LEVEL(v)		((v) & 0x07)
#define LOG_FACILITY(v)		((v) >> 3 & 0xff)

281
/* record buffer */
282
#define LOG_ALIGN __alignof__(struct printk_log)
283
#define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
284
static char __log_buf[__LOG_BUF_LEN] __aligned(LOG_ALIGN);
285 286 287
static char *log_buf = __log_buf;
static u32 log_buf_len = __LOG_BUF_LEN;

288 289 290 291 292 293 294 295 296 297 298 299
/* 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;
}

300
/* human readable text of the record */
301
static char *log_text(const struct printk_log *msg)
302
{
303
	return (char *)msg + sizeof(struct printk_log);
304 305 306
}

/* optional key/value pair dictionary attached to the record */
307
static char *log_dict(const struct printk_log *msg)
308
{
309
	return (char *)msg + sizeof(struct printk_log) + msg->text_len;
310 311 312
}

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

	/*
	 * 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)
322
		return (struct printk_log *)log_buf;
323 324 325 326 327 328
	return msg;
}

/* get next record; idx must point to valid msg */
static u32 log_next(u32 idx)
{
329
	struct printk_log *msg = (struct printk_log *)(log_buf + idx);
330 331 332 333 334 335 336 337

	/* 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) {
338
		msg = (struct printk_log *)log_buf;
339 340 341 342 343
		return msg->len;
	}
	return idx + msg->len;
}

P
Petr Mladek 已提交
344 345 346 347 348 349 350 351 352 353
/*
 * 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)
354 355 356
{
	u32 free;

P
Petr Mladek 已提交
357
	if (log_next_idx > log_first_idx || empty)
358 359 360 361 362 363 364 365 366 367 368
		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 已提交
369
static int log_make_free_space(u32 msg_size)
370
{
371 372
	while (log_first_seq < log_next_seq &&
	       !logbuf_has_space(msg_size, false)) {
A
Alex Elder 已提交
373
		/* drop old messages until we have enough contiguous space */
374 375 376
		log_first_idx = log_next(log_first_idx);
		log_first_seq++;
	}
P
Petr Mladek 已提交
377

378 379 380 381 382
	if (clear_seq < log_first_seq) {
		clear_seq = log_first_seq;
		clear_idx = log_first_idx;
	}

P
Petr Mladek 已提交
383
	/* sequence numbers are equal, so the log buffer is empty */
384
	if (logbuf_has_space(msg_size, log_first_seq == log_next_seq))
P
Petr Mladek 已提交
385 386 387
		return 0;

	return -ENOMEM;
388 389
}

390 391 392 393 394 395 396 397 398 399 400 401
/* 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 已提交
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
/*
 * 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);
}

428
/* insert record into the buffer, discard old ones, update heads */
429 430 431 432
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)
433
{
434
	struct printk_log *msg;
435
	u32 size, pad_len;
P
Petr Mladek 已提交
436
	u16 trunc_msg_len = 0;
437 438

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

P
Petr Mladek 已提交
441 442 443 444 445 446
	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))
447
			return 0;
P
Petr Mladek 已提交
448
	}
449

450
	if (log_next_idx + size + sizeof(struct printk_log) > log_buf_len) {
451 452 453 454 455
		/*
		 * 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.
		 */
456
		memset(log_buf + log_next_idx, 0, sizeof(struct printk_log));
457 458 459 460
		log_next_idx = 0;
	}

	/* fill message */
461
	msg = (struct printk_log *)(log_buf + log_next_idx);
462 463
	memcpy(log_text(msg), text, text_len);
	msg->text_len = text_len;
P
Petr Mladek 已提交
464 465 466 467
	if (trunc_msg_len) {
		memcpy(log_text(msg) + text_len, trunc_msg, trunc_msg_len);
		msg->text_len += trunc_msg_len;
	}
468 469
	memcpy(log_dict(msg), dict, dict_len);
	msg->dict_len = dict_len;
470 471 472 473 474 475 476
	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();
477
	memset(log_dict(msg) + dict_len, 0, pad_len);
478
	msg->len = size;
479 480 481 482

	/* insert message */
	log_next_idx += msg->len;
	log_next_seq++;
483 484

	return msg->text_len;
485
}
M
Matt Mackall 已提交
486

A
Alex Elder 已提交
487
int dmesg_restrict = IS_ENABLED(CONFIG_SECURITY_DMESG_RESTRICT);
488 489 490 491 492 493 494 495 496 497 498 499 500

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;
}

501
int check_syslog_permissions(int type, int source)
502 503 504 505 506
{
	/*
	 * If this is from /proc/kmsg and we've already opened it, then we've
	 * already done the capabilities checks at open time.
	 */
507
	if (source == SYSLOG_FROM_PROC && type != SYSLOG_ACTION_OPEN)
508
		goto ok;
509 510 511

	if (syslog_action_restricted(type)) {
		if (capable(CAP_SYSLOG))
512
			goto ok;
513 514 515 516 517 518 519 520 521
		/*
		 * 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));
522
			goto ok;
523 524 525
		}
		return -EPERM;
	}
526
ok:
527 528
	return security_syslog(type);
}
G
Geliang Tang 已提交
529
EXPORT_SYMBOL_GPL(check_syslog_permissions);
530

531 532 533 534 535
static void append_char(char **pp, char *e, char c)
{
	if (*pp < e)
		*(*pp)++ = c;
}
536

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 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
static ssize_t msg_print_ext_header(char *buf, size_t size,
				    struct printk_log *msg, u64 seq,
				    enum log_flags prev_flags)
{
	u64 ts_usec = msg->ts_nsec;
	char cont = '-';

	do_div(ts_usec, 1000);

	/*
	 * 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 && !(prev_flags & LOG_CONT))
		cont = 'c';
	else if ((msg->flags & LOG_CONT) ||
		 ((prev_flags & LOG_CONT) && !(msg->flags & LOG_PREFIX)))
		cont = '+';

	return scnprintf(buf, size, "%u,%llu,%llu,%c;",
		       (msg->facility << 3) | msg->level, seq, ts_usec, cont);
}

static ssize_t msg_print_ext_body(char *buf, size_t size,
				  char *dict, size_t dict_len,
				  char *text, size_t text_len)
{
	char *p = buf, *e = buf + size;
	size_t i;

	/* escape non-printable characters */
	for (i = 0; i < text_len; i++) {
		unsigned char c = text[i];

		if (c < ' ' || c >= 127 || c == '\\')
			p += scnprintf(p, e - p, "\\x%02x", c);
		else
			append_char(&p, e, c);
	}
	append_char(&p, e, '\n');

	if (dict_len) {
		bool line = true;

		for (i = 0; i < dict_len; i++) {
			unsigned char c = dict[i];

			if (line) {
				append_char(&p, e, ' ');
				line = false;
			}

			if (c == '\0') {
				append_char(&p, e, '\n');
				line = true;
				continue;
			}

			if (c < ' ' || c >= 127 || c == '\\') {
				p += scnprintf(p, e - p, "\\x%02x", c);
				continue;
			}

			append_char(&p, e, c);
		}
		append_char(&p, e, '\n');
	}

	return p - buf;
}

612 613 614 615
/* /dev/kmsg - userspace message inject/listen interface */
struct devkmsg_user {
	u64 seq;
	u32 idx;
616
	enum log_flags prev;
617
	struct mutex lock;
618
	char buf[CONSOLE_EXT_LOG_MAX];
619 620
};

A
Al Viro 已提交
621
static ssize_t devkmsg_write(struct kiocb *iocb, struct iov_iter *from)
622 623 624 625
{
	char *buf, *line;
	int level = default_message_loglevel;
	int facility = 1;	/* LOG_USER */
C
Christoph Hellwig 已提交
626
	size_t len = iov_iter_count(from);
627 628 629 630 631 632 633 634
	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 已提交
635 636 637 638
	buf[len] = '\0';
	if (copy_from_iter(buf, len, from) != len) {
		kfree(buf);
		return -EFAULT;
639 640 641 642 643 644 645 646 647 648 649 650 651 652
	}

	/*
	 * 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;
653
		unsigned int u;
654

655
		u = simple_strtoul(line + 1, &endp, 10);
656
		if (endp && endp[0] == '>') {
657 658 659
			level = LOG_LEVEL(u);
			if (LOG_FACILITY(u) != 0)
				facility = LOG_FACILITY(u);
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
			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;
675
	struct printk_log *msg;
676 677 678 679 680 681
	size_t len;
	ssize_t ret;

	if (!user)
		return -EBADF;

682 683 684
	ret = mutex_lock_interruptible(&user->lock);
	if (ret)
		return ret;
685
	raw_spin_lock_irq(&logbuf_lock);
686 687 688
	while (user->seq == log_next_seq) {
		if (file->f_flags & O_NONBLOCK) {
			ret = -EAGAIN;
689
			raw_spin_unlock_irq(&logbuf_lock);
690 691 692
			goto out;
		}

693
		raw_spin_unlock_irq(&logbuf_lock);
694 695 696 697
		ret = wait_event_interruptible(log_wait,
					       user->seq != log_next_seq);
		if (ret)
			goto out;
698
		raw_spin_lock_irq(&logbuf_lock);
699 700 701 702 703 704 705
	}

	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;
706
		raw_spin_unlock_irq(&logbuf_lock);
707 708 709 710
		goto out;
	}

	msg = log_from_idx(user->idx);
711 712 713 714 715
	len = msg_print_ext_header(user->buf, sizeof(user->buf),
				   msg, user->seq, user->prev);
	len += msg_print_ext_body(user->buf + len, sizeof(user->buf) - len,
				  log_dict(msg), msg->dict_len,
				  log_text(msg), msg->text_len);
716 717

	user->prev = msg->flags;
718 719
	user->idx = log_next(user->idx);
	user->seq++;
720
	raw_spin_unlock_irq(&logbuf_lock);
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746

	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;

747
	raw_spin_lock_irq(&logbuf_lock);
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
	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;
	}
771
	raw_spin_unlock_irq(&logbuf_lock);
772 773 774 775 776 777 778 779 780 781 782 783 784
	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);

785
	raw_spin_lock_irq(&logbuf_lock);
786 787 788 789
	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;
790 791
		else
			ret = POLLIN|POLLRDNORM;
792
	}
793
	raw_spin_unlock_irq(&logbuf_lock);
794 795 796 797 798 799 800 801 802 803 804 805 806

	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;

807 808
	err = check_syslog_permissions(SYSLOG_ACTION_READ_ALL,
				       SYSLOG_FROM_READER);
809 810 811 812 813 814 815 816 817
	if (err)
		return err;

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

	mutex_init(&user->lock);

818
	raw_spin_lock_irq(&logbuf_lock);
819 820
	user->idx = log_first_idx;
	user->seq = log_first_seq;
821
	raw_spin_unlock_irq(&logbuf_lock);
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841

	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 已提交
842
	.write_iter = devkmsg_write,
843 844 845 846 847
	.llseek = devkmsg_llseek,
	.poll = devkmsg_poll,
	.release = devkmsg_release,
};

848
#ifdef CONFIG_KEXEC_CORE
849
/*
850
 * This appends the listed symbols to /proc/vmcore
851
 *
852
 * /proc/vmcore is used by various utilities, like crash and makedumpfile to
853 854 855 856 857 858 859 860
 * 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);
861
	VMCOREINFO_SYMBOL(log_first_idx);
862
	VMCOREINFO_SYMBOL(clear_idx);
863
	VMCOREINFO_SYMBOL(log_next_idx);
864
	/*
865
	 * Export struct printk_log size and field offsets. User space tools can
866 867
	 * parse it and detect any changes to structure down the line.
	 */
868 869 870 871 872
	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);
873 874 875
}
#endif

876 877 878
/* requested log_buf_len from kernel cmdline */
static unsigned long __initdata new_log_buf_len;

879 880
/* we practice scaling the ring buffer by powers of 2 */
static void __init log_buf_len_update(unsigned size)
L
Linus Torvalds 已提交
881 882 883
{
	if (size)
		size = roundup_pow_of_two(size);
884 885
	if (size > log_buf_len)
		new_log_buf_len = size;
886 887 888 889 890 891 892 893
}

/* 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);
894 895

	return 0;
L
Linus Torvalds 已提交
896
}
897 898
early_param("log_buf_len", log_buf_len_setup);

899 900 901
#ifdef CONFIG_SMP
#define __LOG_CPU_MAX_BUF_LEN (1 << CONFIG_LOG_CPU_MAX_BUF_SHIFT)

902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
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);
}
928 929 930
#else /* !CONFIG_SMP */
static inline void log_buf_add_cpu(void) {}
#endif /* CONFIG_SMP */
931

932 933 934 935 936 937
void __init setup_log_buf(int early)
{
	unsigned long flags;
	char *new_log_buf;
	int free;

938 939 940 941 942 943
	if (log_buf != __log_buf)
		return;

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

944 945
	if (!new_log_buf_len)
		return;
L
Linus Torvalds 已提交
946

947
	if (early) {
948
		new_log_buf =
949
			memblock_virt_alloc(new_log_buf_len, LOG_ALIGN);
950
	} else {
951 952
		new_log_buf = memblock_virt_alloc_nopanic(new_log_buf_len,
							  LOG_ALIGN);
953 954 955 956 957 958 959 960
	}

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

961
	raw_spin_lock_irqsave(&logbuf_lock, flags);
962 963 964
	log_buf_len = new_log_buf_len;
	log_buf = new_log_buf;
	new_log_buf_len = 0;
965 966
	free = __LOG_BUF_LEN - log_next_idx;
	memcpy(log_buf, __log_buf, __LOG_BUF_LEN);
967
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
968

969
	pr_info("log_buf_len: %d bytes\n", log_buf_len);
970 971 972
	pr_info("early log buf free: %d(%d%%)\n",
		free, (free * 100) / __LOG_BUF_LEN);
}
L
Linus Torvalds 已提交
973

974 975 976 977
static bool __read_mostly ignore_loglevel;

static int __init ignore_loglevel_setup(char *str)
{
978
	ignore_loglevel = true;
979
	pr_info("debug: ignoring loglevel setting.\n");
980 981 982 983 984 985

	return 0;
}

early_param("ignore_loglevel", ignore_loglevel_setup);
module_param(ignore_loglevel, bool, S_IRUGO | S_IWUSR);
986 987
MODULE_PARM_DESC(ignore_loglevel,
		 "ignore loglevel setting (prints all kernel messages to the console)");
988

R
Randy Dunlap 已提交
989 990
#ifdef CONFIG_BOOT_PRINTK_DELAY

991
static int boot_delay; /* msecs delay after each printk during bootup */
992
static unsigned long long loops_per_msec;	/* based on boot_delay */
R
Randy Dunlap 已提交
993 994 995 996 997 998 999 1000 1001 1002 1003 1004

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;

1005 1006 1007
	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);
1008
	return 0;
R
Randy Dunlap 已提交
1009
}
1010
early_param("boot_delay", boot_delay_setup);
R
Randy Dunlap 已提交
1011

1012
static void boot_delay_msec(int level)
R
Randy Dunlap 已提交
1013 1014 1015 1016
{
	unsigned long long k;
	unsigned long timeout;

1017 1018
	if ((boot_delay == 0 || system_state != SYSTEM_BOOTING)
		|| (level >= console_loglevel && !ignore_loglevel)) {
R
Randy Dunlap 已提交
1019
		return;
1020
	}
R
Randy Dunlap 已提交
1021

1022
	k = (unsigned long long)loops_per_msec * boot_delay;
R
Randy Dunlap 已提交
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038

	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
1039
static inline void boot_delay_msec(int level)
R
Randy Dunlap 已提交
1040 1041 1042 1043
{
}
#endif

A
Alex Elder 已提交
1044
static bool printk_time = IS_ENABLED(CONFIG_PRINTK_TIME);
1045 1046
module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);

1047 1048 1049 1050 1051 1052 1053
static size_t print_time(u64 ts, char *buf)
{
	unsigned long rem_nsec;

	if (!printk_time)
		return 0;

1054 1055
	rem_nsec = do_div(ts, 1000000000);

1056
	if (!buf)
1057
		return snprintf(NULL, 0, "[%5lu.000000] ", (unsigned long)ts);
1058 1059 1060 1061 1062

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

1063
static size_t print_prefix(const struct printk_log *msg, bool syslog, char *buf)
1064
{
1065
	size_t len = 0;
1066
	unsigned int prefix = (msg->facility << 3) | msg->level;
1067

1068 1069
	if (syslog) {
		if (buf) {
1070
			len += sprintf(buf, "<%u>", prefix);
1071 1072
		} else {
			len += 3;
1073 1074 1075 1076 1077
			if (prefix > 999)
				len += 3;
			else if (prefix > 99)
				len += 2;
			else if (prefix > 9)
1078 1079 1080
				len++;
		}
	}
1081

1082
	len += print_time(msg->ts_nsec, buf ? buf + len : NULL);
1083
	return len;
1084 1085
}

1086
static size_t msg_print_text(const struct printk_log *msg, enum log_flags prev,
1087
			     bool syslog, char *buf, size_t size)
1088
{
1089 1090
	const char *text = log_text(msg);
	size_t text_size = msg->text_len;
1091 1092
	bool prefix = true;
	bool newline = true;
1093 1094
	size_t len = 0;

1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
	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;
	}

1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
	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;
		}
1117

1118 1119
		if (buf) {
			if (print_prefix(msg, syslog, NULL) +
1120
			    text_len + 1 >= size - len)
1121
				break;
1122

1123 1124
			if (prefix)
				len += print_prefix(msg, syslog, buf + len);
1125 1126
			memcpy(buf + len, text, text_len);
			len += text_len;
1127 1128
			if (next || newline)
				buf[len++] = '\n';
1129 1130
		} else {
			/* SYSLOG_ACTION_* buffer size only calculation */
1131 1132 1133 1134 1135
			if (prefix)
				len += print_prefix(msg, syslog, NULL);
			len += text_len;
			if (next || newline)
				len++;
1136
		}
1137

1138
		prefix = true;
1139 1140
		text = next;
	} while (text);
1141 1142 1143 1144 1145 1146 1147

	return len;
}

static int syslog_print(char __user *buf, int size)
{
	char *text;
1148
	struct printk_log *msg;
1149
	int len = 0;
1150

1151
	text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1152 1153 1154
	if (!text)
		return -ENOMEM;

1155 1156
	while (size > 0) {
		size_t n;
1157
		size_t skip;
1158 1159 1160 1161 1162 1163

		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;
1164
			syslog_prev = 0;
1165
			syslog_partial = 0;
1166 1167 1168 1169 1170
		}
		if (syslog_seq == log_next_seq) {
			raw_spin_unlock_irq(&logbuf_lock);
			break;
		}
1171 1172

		skip = syslog_partial;
1173
		msg = log_from_idx(syslog_idx);
1174 1175
		n = msg_print_text(msg, syslog_prev, true, text,
				   LOG_LINE_MAX + PREFIX_MAX);
1176 1177
		if (n - syslog_partial <= size) {
			/* message fits into buffer, move forward */
1178 1179
			syslog_idx = log_next(syslog_idx);
			syslog_seq++;
1180
			syslog_prev = msg->flags;
1181 1182 1183 1184 1185 1186
			n -= syslog_partial;
			syslog_partial = 0;
		} else if (!len){
			/* partial read(), remember position */
			n = size;
			syslog_partial += n;
1187 1188 1189 1190 1191 1192 1193
		} else
			n = 0;
		raw_spin_unlock_irq(&logbuf_lock);

		if (!n)
			break;

1194
		if (copy_to_user(buf, text + skip, n)) {
1195 1196 1197 1198
			if (!len)
				len = -EFAULT;
			break;
		}
1199 1200 1201 1202

		len += n;
		size -= n;
		buf += n;
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
	}

	kfree(text);
	return len;
}

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

1214
	text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1215 1216 1217 1218 1219 1220 1221 1222
	if (!text)
		return -ENOMEM;

	raw_spin_lock_irq(&logbuf_lock);
	if (buf) {
		u64 next_seq;
		u64 seq;
		u32 idx;
1223
		enum log_flags prev;
1224 1225 1226 1227

		/*
		 * Find first record that fits, including all following records,
		 * into the user-provided buffer for this dump.
1228
		 */
1229 1230
		seq = clear_seq;
		idx = clear_idx;
1231
		prev = 0;
1232
		while (seq < log_next_seq) {
1233
			struct printk_log *msg = log_from_idx(idx);
1234

1235
			len += msg_print_text(msg, prev, true, NULL, 0);
1236
			prev = msg->flags;
1237 1238 1239
			idx = log_next(idx);
			seq++;
		}
1240 1241

		/* move first record forward until length fits into the buffer */
1242 1243
		seq = clear_seq;
		idx = clear_idx;
1244
		prev = 0;
1245
		while (len > size && seq < log_next_seq) {
1246
			struct printk_log *msg = log_from_idx(idx);
1247

1248
			len -= msg_print_text(msg, prev, true, NULL, 0);
1249
			prev = msg->flags;
1250 1251 1252 1253
			idx = log_next(idx);
			seq++;
		}

1254
		/* last message fitting into this dump */
1255 1256 1257 1258
		next_seq = log_next_seq;

		len = 0;
		while (len >= 0 && seq < next_seq) {
1259
			struct printk_log *msg = log_from_idx(idx);
1260 1261
			int textlen;

1262 1263
			textlen = msg_print_text(msg, prev, true, text,
						 LOG_LINE_MAX + PREFIX_MAX);
1264 1265 1266 1267 1268 1269
			if (textlen < 0) {
				len = textlen;
				break;
			}
			idx = log_next(idx);
			seq++;
1270
			prev = msg->flags;
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282

			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;
1283
				prev = 0;
1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
			}
		}
	}

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

	kfree(text);
	return len;
}

1298
int do_syslog(int type, char __user *buf, int len, int source)
L
Linus Torvalds 已提交
1299
{
1300
	bool clear = false;
1301
	static int saved_console_loglevel = LOGLEVEL_DEFAULT;
1302
	int error;
L
Linus Torvalds 已提交
1303

1304
	error = check_syslog_permissions(type, source);
1305 1306
	if (error)
		goto out;
1307

L
Linus Torvalds 已提交
1308
	switch (type) {
1309
	case SYSLOG_ACTION_CLOSE:	/* Close log */
L
Linus Torvalds 已提交
1310
		break;
1311
	case SYSLOG_ACTION_OPEN:	/* Open log */
L
Linus Torvalds 已提交
1312
		break;
1313
	case SYSLOG_ACTION_READ:	/* Read from log */
L
Linus Torvalds 已提交
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323
		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 已提交
1324
		error = wait_event_interruptible(log_wait,
1325
						 syslog_seq != log_next_seq);
1326
		if (error)
L
Linus Torvalds 已提交
1327
			goto out;
1328
		error = syslog_print(buf, len);
L
Linus Torvalds 已提交
1329
		break;
1330 1331
	/* Read/clear last kernel messages */
	case SYSLOG_ACTION_READ_CLEAR:
1332
		clear = true;
L
Linus Torvalds 已提交
1333
		/* FALL THRU */
1334 1335
	/* Read last kernel messages */
	case SYSLOG_ACTION_READ_ALL:
L
Linus Torvalds 已提交
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345
		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;
		}
1346
		error = syslog_print_all(buf, len, clear);
L
Linus Torvalds 已提交
1347
		break;
1348 1349
	/* Clear ring buffer */
	case SYSLOG_ACTION_CLEAR:
1350
		syslog_print_all(NULL, 0, true);
1351
		break;
1352 1353
	/* Disable logging to console */
	case SYSLOG_ACTION_CONSOLE_OFF:
1354
		if (saved_console_loglevel == LOGLEVEL_DEFAULT)
1355
			saved_console_loglevel = console_loglevel;
L
Linus Torvalds 已提交
1356 1357
		console_loglevel = minimum_console_loglevel;
		break;
1358 1359
	/* Enable logging to console */
	case SYSLOG_ACTION_CONSOLE_ON:
1360
		if (saved_console_loglevel != LOGLEVEL_DEFAULT) {
1361
			console_loglevel = saved_console_loglevel;
1362
			saved_console_loglevel = LOGLEVEL_DEFAULT;
1363
		}
L
Linus Torvalds 已提交
1364
		break;
1365 1366
	/* Set level of messages printed to console */
	case SYSLOG_ACTION_CONSOLE_LEVEL:
L
Linus Torvalds 已提交
1367 1368 1369 1370 1371 1372
		error = -EINVAL;
		if (len < 1 || len > 8)
			goto out;
		if (len < minimum_console_loglevel)
			len = minimum_console_loglevel;
		console_loglevel = len;
1373
		/* Implicitly re-enable logging to console */
1374
		saved_console_loglevel = LOGLEVEL_DEFAULT;
L
Linus Torvalds 已提交
1375 1376
		error = 0;
		break;
1377 1378
	/* Number of chars in the log buffer */
	case SYSLOG_ACTION_SIZE_UNREAD:
1379 1380 1381 1382 1383
		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;
1384
			syslog_prev = 0;
1385
			syslog_partial = 0;
1386
		}
1387
		if (source == SYSLOG_FROM_PROC) {
1388 1389 1390 1391 1392
			/*
			 * Short-cut for poll(/"proc/kmsg") which simply checks
			 * for pending data, not the size; return the count of
			 * records, not the length.
			 */
1393
			error = log_next_seq - syslog_seq;
1394
		} else {
1395 1396 1397
			u64 seq = syslog_seq;
			u32 idx = syslog_idx;
			enum log_flags prev = syslog_prev;
1398 1399 1400

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

1403
				error += msg_print_text(msg, prev, true, NULL, 0);
1404 1405
				idx = log_next(idx);
				seq++;
1406
				prev = msg->flags;
1407
			}
1408
			error -= syslog_partial;
1409 1410
		}
		raw_spin_unlock_irq(&logbuf_lock);
L
Linus Torvalds 已提交
1411
		break;
1412 1413
	/* Size of the log buffer */
	case SYSLOG_ACTION_SIZE_BUFFER:
L
Linus Torvalds 已提交
1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
		error = log_buf_len;
		break;
	default:
		error = -EINVAL;
		break;
	}
out:
	return error;
}

1424
SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
L
Linus Torvalds 已提交
1425
{
1426
	return do_syslog(type, buf, len, SYSLOG_FROM_READER);
L
Linus Torvalds 已提交
1427 1428 1429 1430 1431
}

/*
 * Call the console drivers, asking them to write out
 * log_buf[start] to log_buf[end - 1].
1432
 * The console_lock must be held.
L
Linus Torvalds 已提交
1433
 */
1434 1435 1436
static void call_console_drivers(int level,
				 const char *ext_text, size_t ext_len,
				 const char *text, size_t len)
L
Linus Torvalds 已提交
1437
{
1438
	struct console *con;
L
Linus Torvalds 已提交
1439

1440
	trace_console(text, len);
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456

	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;
1457 1458 1459 1460
		if (con->flags & CON_EXTENDED)
			con->write(con, ext_text, ext_len);
		else
			con->write(con, text, len);
1461
	}
L
Linus Torvalds 已提交
1462 1463 1464
}

/*
1465 1466 1467
 * Zap console related locks when oopsing.
 * To leave time for slow consoles to print a full oops,
 * only zap at most once every 30 seconds.
L
Linus Torvalds 已提交
1468 1469 1470 1471 1472 1473
 */
static void zap_locks(void)
{
	static unsigned long oops_timestamp;

	if (time_after_eq(jiffies, oops_timestamp) &&
1474
	    !time_after(jiffies, oops_timestamp + 30 * HZ))
L
Linus Torvalds 已提交
1475 1476 1477 1478
		return;

	oops_timestamp = jiffies;

1479
	debug_locks_off();
L
Linus Torvalds 已提交
1480
	/* If a crash is occurring, make sure we can't deadlock */
1481
	raw_spin_lock_init(&logbuf_lock);
L
Linus Torvalds 已提交
1482
	/* And make sure that we print immediately */
1483
	sema_init(&console_sem, 1);
L
Linus Torvalds 已提交
1484 1485
}

1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499
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();
		}
	}
}

1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
/*
 * 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 已提交
1513
	u8 facility;			/* log facility of first message */
1514
	enum log_flags flags;		/* prefix, newline flags */
1515 1516 1517
	bool flushed:1;			/* buffer sealed and committed */
} cont;

1518
static void cont_flush(enum log_flags flags)
1519 1520 1521 1522 1523 1524
{
	if (cont.flushed)
		return;
	if (cont.len == 0)
		return;

1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543
	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;
	}
1544 1545 1546 1547 1548 1549 1550
}

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

1551 1552 1553 1554 1555 1556
	/*
	 * If ext consoles are present, flush and skip in-kernel
	 * continuation.  See nr_ext_console_drivers definition.  Also, if
	 * the line gets too long, split it up in separate records.
	 */
	if (nr_ext_console_drivers || cont.len + len > sizeof(cont.buf)) {
1557
		cont_flush(LOG_CONT);
1558 1559 1560 1561 1562 1563 1564 1565
		return false;
	}

	if (!cont.len) {
		cont.facility = facility;
		cont.level = level;
		cont.owner = current;
		cont.ts_nsec = local_clock();
1566
		cont.flags = 0;
1567 1568 1569 1570 1571 1572
		cont.cons = 0;
		cont.flushed = false;
	}

	memcpy(cont.buf + cont.len, text, len);
	cont.len += len;
1573 1574 1575 1576

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

1577 1578 1579 1580 1581 1582 1583 1584
	return true;
}

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

1585
	if (cont.cons == 0 && (console_prev & LOG_NEWLINE)) {
1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599
		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) {
1600 1601
		if (cont.flags & LOG_NEWLINE)
			text[textlen++] = '\n';
1602 1603 1604 1605 1606 1607
		/* got everything, release buffer */
		cont.len = 0;
	}
	return textlen;
}

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

1624 1625
	if (level == LOGLEVEL_SCHED) {
		level = LOGLEVEL_DEFAULT;
1626 1627
		in_sched = true;
	}
L
Linus Torvalds 已提交
1628

1629
	boot_delay_msec(level);
1630
	printk_delay();
R
Randy Dunlap 已提交
1631

1632
	local_irq_save(flags);
1633 1634 1635 1636 1637
	this_cpu = smp_processor_id();

	/*
	 * Ouch, printk recursed into itself!
	 */
1638
	if (unlikely(logbuf_cpu == this_cpu)) {
1639 1640 1641 1642 1643 1644 1645
		/*
		 * 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:
		 */
1646
		if (!oops_in_progress && !lockdep_recursing(current)) {
1647
			recursion_bug = true;
1648 1649
			local_irq_restore(flags);
			return 0;
1650 1651 1652 1653
		}
		zap_locks();
	}

1654
	lockdep_off();
1655
	/* This stops the holder of console_sem just where we want him */
1656
	raw_spin_lock(&logbuf_lock);
1657
	logbuf_cpu = this_cpu;
L
Linus Torvalds 已提交
1658

1659
	if (unlikely(recursion_bug)) {
1660 1661 1662
		static const char recursion_msg[] =
			"BUG: recent printk recursion!";

1663
		recursion_bug = false;
1664
		/* emit KERN_CRIT message */
1665
		printed_len += log_store(0, 2, LOG_PREFIX|LOG_NEWLINE, 0,
1666 1667
					 NULL, 0, recursion_msg,
					 strlen(recursion_msg));
1668
	}
L
Linus Torvalds 已提交
1669

1670 1671 1672 1673
	/*
	 * The printf needs to come first; we need the syslog
	 * prefix which might be passed-in as a parameter.
	 */
1674
	text_len = vscnprintf(text, sizeof(textbuf), fmt, args);
1675

1676
	/* mark and strip a trailing newline */
1677 1678
	if (text_len && text[text_len-1] == '\n') {
		text_len--;
1679
		lflags |= LOG_NEWLINE;
1680
	}
1681

1682 1683 1684 1685 1686 1687 1688 1689
	/* 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':
1690
				if (level == LOGLEVEL_DEFAULT)
1691
					level = kern_level - '0';
1692
				/* fallthrough */
1693 1694 1695
			case 'd':	/* KERN_DEFAULT */
				lflags |= LOG_PREFIX;
			}
1696 1697 1698 1699 1700
			/*
			 * No need to check length here because vscnprintf
			 * put '\0' at the end of the string. Only valid and
			 * newly printed level is detected.
			 */
1701 1702
			text_len -= end_of_header - text;
			text = (char *)end_of_header;
1703 1704 1705
		}
	}

1706
	if (level == LOGLEVEL_DEFAULT)
1707
		level = default_message_loglevel;
1708

1709 1710
	if (dict)
		lflags |= LOG_PREFIX|LOG_NEWLINE;
1711

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

1720
		/* buffer line if possible, otherwise store it right away */
1721 1722 1723 1724 1725 1726
		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);
1727
	} else {
1728
		bool stored = false;
1729

1730
		/*
1731 1732 1733 1734
		 * 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.
1735 1736
		 * If the preceding printk was from a different task and missed
		 * a newline, flush and append the newline.
1737
		 */
1738 1739 1740 1741
		if (cont.len) {
			if (cont.owner == current && !(lflags & LOG_PREFIX))
				stored = cont_add(facility, level, text,
						  text_len);
1742
			cont_flush(LOG_NEWLINE);
1743
		}
1744

1745 1746 1747 1748 1749
		if (stored)
			printed_len += text_len;
		else
			printed_len += log_store(facility, level, lflags, 0,
						 dict, dictlen, text, text_len);
L
Linus Torvalds 已提交
1750 1751
	}

1752 1753
	logbuf_cpu = UINT_MAX;
	raw_spin_unlock(&logbuf_lock);
1754 1755
	lockdep_on();
	local_irq_restore(flags);
1756

1757
	/* If called from the scheduler, we can not call up(). */
1758
	if (!in_sched) {
1759
		lockdep_off();
1760 1761 1762 1763 1764
		/*
		 * Try to acquire and then immediately release the console
		 * semaphore.  The release will print out buffers and wake up
		 * /dev/kmsg and syslog() users.
		 */
1765
		if (console_trylock())
1766
			console_unlock();
1767
		lockdep_on();
1768
	}
1769

L
Linus Torvalds 已提交
1770 1771
	return printed_len;
}
1772 1773 1774 1775
EXPORT_SYMBOL(vprintk_emit);

asmlinkage int vprintk(const char *fmt, va_list args)
{
1776
	return vprintk_emit(0, LOGLEVEL_DEFAULT, NULL, 0, fmt, args);
1777
}
L
Linus Torvalds 已提交
1778 1779
EXPORT_SYMBOL(vprintk);

1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794
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);

1795 1796 1797 1798 1799 1800
int vprintk_default(const char *fmt, va_list args)
{
	int r;

#ifdef CONFIG_KGDB_KDB
	if (unlikely(kdb_trap_printk)) {
1801
		r = vkdb_printf(KDB_MSGSRC_PRINTK, fmt, args);
1802 1803 1804
		return r;
	}
#endif
1805
	r = vprintk_emit(0, LOGLEVEL_DEFAULT, NULL, 0, fmt, args);
1806 1807 1808 1809 1810

	return r;
}
EXPORT_SYMBOL_GPL(vprintk_default);

1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831
/**
 * 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.
 */
1832
asmlinkage __visible int printk(const char *fmt, ...)
1833 1834 1835 1836 1837
{
	va_list args;
	int r;

	va_start(args, fmt);
1838
	r = vprintk_func(fmt, args);
1839 1840 1841 1842 1843
	va_end(args);

	return r;
}
EXPORT_SYMBOL(printk);
1844

1845
#else /* CONFIG_PRINTK */
M
Matt Mackall 已提交
1846

1847 1848
#define LOG_LINE_MAX		0
#define PREFIX_MAX		0
A
Alex Elder 已提交
1849

1850 1851
static u64 syslog_seq;
static u32 syslog_idx;
1852 1853
static u64 console_seq;
static u32 console_idx;
1854 1855 1856 1857
static enum log_flags syslog_prev;
static u64 log_first_seq;
static u32 log_first_idx;
static u64 log_next_seq;
1858
static enum log_flags console_prev;
1859 1860 1861 1862 1863 1864
static struct cont {
	size_t len;
	size_t cons;
	u8 level;
	bool flushed:1;
} cont;
1865 1866
static char *log_text(const struct printk_log *msg) { return NULL; }
static char *log_dict(const struct printk_log *msg) { return NULL; }
1867
static struct printk_log *log_from_idx(u32 idx) { return NULL; }
1868
static u32 log_next(u32 idx) { return 0; }
1869 1870 1871 1872 1873 1874 1875 1876 1877
static ssize_t msg_print_ext_header(char *buf, size_t size,
				    struct printk_log *msg, u64 seq,
				    enum log_flags prev_flags) { return 0; }
static ssize_t msg_print_ext_body(char *buf, size_t size,
				  char *dict, size_t dict_len,
				  char *text, size_t text_len) { return 0; }
static void call_console_drivers(int level,
				 const char *ext_text, size_t ext_len,
				 const char *text, size_t len) {}
1878
static size_t msg_print_text(const struct printk_log *msg, enum log_flags prev,
1879
			     bool syslog, char *buf, size_t size) { return 0; }
1880
static size_t cont_print_text(char *text, size_t size) { return 0; }
M
Matt Mackall 已提交
1881

1882 1883 1884
/* Still needs to be defined for users */
DEFINE_PER_CPU(printk_func_t, printk_func);

1885
#endif /* CONFIG_PRINTK */
M
Matt Mackall 已提交
1886

1887 1888 1889
#ifdef CONFIG_EARLY_PRINTK
struct console *early_console;

1890
asmlinkage __visible void early_printk(const char *fmt, ...)
1891 1892
{
	va_list ap;
1893 1894 1895 1896 1897
	char buf[512];
	int n;

	if (!early_console)
		return;
1898 1899

	va_start(ap, fmt);
1900
	n = vscnprintf(buf, sizeof(buf), fmt, ap);
1901
	va_end(ap);
1902 1903

	early_console->write(early_console, buf, n);
1904 1905 1906
}
#endif

1907 1908 1909 1910 1911 1912 1913 1914 1915 1916
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.
	 */
1917 1918 1919 1920 1921 1922 1923
	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;
1924
		}
1925
	}
1926 1927 1928 1929 1930 1931
	if (i == MAX_CMDLINECONSOLES)
		return -E2BIG;
	if (!brl_options)
		selected_console = i;
	strlcpy(c->name, name, sizeof(c->name));
	c->options = options;
1932 1933
	braille_set_options(c, brl_options);

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

1947 1948
	if (_braille_console_setup(&str, &brl_options))
		return 1;
1949

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

1975
	__add_preferred_console(buf, idx, options, brl_options);
1976
	console_set_on_cmdline = 1;
1977 1978 1979 1980
	return 1;
}
__setup("console=", console_setup);

1981 1982
/**
 * add_preferred_console - add a device to the list of preferred consoles.
1983 1984 1985
 * @name: device name
 * @idx: device index
 * @options: options for this console
1986 1987 1988 1989 1990 1991 1992 1993
 *
 * 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.
 */
1994
int add_preferred_console(char *name, int idx, char *options)
1995
{
1996
	return __add_preferred_console(name, idx, options, NULL);
1997 1998
}

1999
bool console_suspend_enabled = true;
2000 2001 2002 2003
EXPORT_SYMBOL(console_suspend_enabled);

static int __init console_suspend_disable(char *str)
{
2004
	console_suspend_enabled = false;
2005 2006 2007
	return 1;
}
__setup("no_console_suspend", console_suspend_disable);
2008 2009 2010 2011
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");
2012

2013 2014 2015 2016 2017 2018 2019
/**
 * suspend_console - suspend the console subsystem
 *
 * This disables printk() while we go into suspend states
 */
void suspend_console(void)
{
2020 2021
	if (!console_suspend_enabled)
		return;
2022
	printk("Suspending console(s) (use no_console_suspend to debug)\n");
2023
	console_lock();
2024
	console_suspended = 1;
2025
	up_console_sem();
2026 2027 2028 2029
}

void resume_console(void)
{
2030 2031
	if (!console_suspend_enabled)
		return;
2032
	down_console_sem();
2033
	console_suspended = 0;
2034
	console_unlock();
2035 2036
}

2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047
/**
 * 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.
 */
2048
static int console_cpu_notify(struct notifier_block *self,
2049 2050 2051 2052 2053 2054 2055
	unsigned long action, void *hcpu)
{
	switch (action) {
	case CPU_ONLINE:
	case CPU_DEAD:
	case CPU_DOWN_FAILED:
	case CPU_UP_CANCELED:
2056 2057
		console_lock();
		console_unlock();
2058 2059 2060 2061
	}
	return NOTIFY_OK;
}

L
Linus Torvalds 已提交
2062
/**
2063
 * console_lock - lock the console system for exclusive use.
L
Linus Torvalds 已提交
2064
 *
2065
 * Acquires a lock which guarantees that the caller has
L
Linus Torvalds 已提交
2066 2067 2068 2069
 * exclusive access to the console system and the console_drivers list.
 *
 * Can sleep, returns nothing.
 */
2070
void console_lock(void)
L
Linus Torvalds 已提交
2071
{
2072 2073
	might_sleep();

2074
	down_console_sem();
2075 2076
	if (console_suspended)
		return;
L
Linus Torvalds 已提交
2077 2078 2079
	console_locked = 1;
	console_may_schedule = 1;
}
2080
EXPORT_SYMBOL(console_lock);
L
Linus Torvalds 已提交
2081

2082 2083 2084
/**
 * console_trylock - try to lock the console system for exclusive use.
 *
A
Alex Elder 已提交
2085 2086
 * Try to acquire a lock which guarantees that the caller has exclusive
 * access to the console system and the console_drivers list.
2087 2088 2089 2090
 *
 * returns 1 on success, and 0 on failure to acquire the lock.
 */
int console_trylock(void)
L
Linus Torvalds 已提交
2091
{
2092
	if (down_trylock_console_sem())
2093
		return 0;
2094
	if (console_suspended) {
2095
		up_console_sem();
2096
		return 0;
2097
	}
L
Linus Torvalds 已提交
2098
	console_locked = 1;
2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112
	/*
	 * When PREEMPT_COUNT disabled we can't reliably detect if it's
	 * safe to schedule (e.g. calling printk while holding a spin_lock),
	 * because preempt_disable()/preempt_enable() are just barriers there
	 * and preempt_count() is always 0.
	 *
	 * RCU read sections have a separate preemption counter when
	 * PREEMPT_RCU enabled thus we must take extra care and check
	 * rcu_preempt_depth(), otherwise RCU read sections modify
	 * preempt_count().
	 */
	console_may_schedule = !oops_in_progress &&
			preemptible() &&
			!rcu_preempt_depth();
2113
	return 1;
L
Linus Torvalds 已提交
2114
}
2115
EXPORT_SYMBOL(console_trylock);
L
Linus Torvalds 已提交
2116 2117 2118 2119 2120 2121

int is_console_locked(void)
{
	return console_locked;
}

2122 2123 2124 2125 2126 2127 2128 2129 2130
/*
 * Check if we have any console that is capable of printing while cpu is
 * booting or shutting down. Requires console_sem.
 */
static int have_callable_console(void)
{
	struct console *con;

	for_each_console(con)
2131 2132
		if ((con->flags & CON_ENABLED) &&
				(con->flags & CON_ANYTIME))
2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149
			return 1;

	return 0;
}

/*
 * Can we actually use the console at this time on this cpu?
 *
 * 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.
 */
static inline int can_use_console(void)
{
	return cpu_online(raw_smp_processor_id()) || have_callable_console();
}

2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170
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();
2171
	call_console_drivers(cont.level, NULL, 0, text, len);
2172 2173 2174 2175 2176 2177
	start_critical_timings();
	local_irq_restore(flags);
	return;
out:
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
}
2178

L
Linus Torvalds 已提交
2179
/**
2180
 * console_unlock - unlock the console system
L
Linus Torvalds 已提交
2181
 *
2182
 * Releases the console_lock which the caller holds on the console system
L
Linus Torvalds 已提交
2183 2184
 * and the console driver list.
 *
2185 2186 2187
 * 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 已提交
2188
 *
2189
 * If there is output waiting, we wake /dev/kmsg and syslog() users.
L
Linus Torvalds 已提交
2190
 *
2191
 * console_unlock(); may be called from any context.
L
Linus Torvalds 已提交
2192
 */
2193
void console_unlock(void)
L
Linus Torvalds 已提交
2194
{
2195
	static char ext_text[CONSOLE_EXT_LOG_MAX];
2196
	static char text[LOG_LINE_MAX + PREFIX_MAX];
2197
	static u64 seen_seq;
L
Linus Torvalds 已提交
2198
	unsigned long flags;
2199
	bool wake_klogd = false;
2200
	bool do_cond_resched, retry;
L
Linus Torvalds 已提交
2201

2202
	if (console_suspended) {
2203
		up_console_sem();
2204 2205
		return;
	}
2206

2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217
	/*
	 * Console drivers are called under logbuf_lock, so
	 * @console_may_schedule should be cleared before; however, we may
	 * end up dumping a lot of lines, for example, if called from
	 * console registration path, and should invoke cond_resched()
	 * between lines if allowable.  Not doing so can cause a very long
	 * scheduling stall on a slow console leading to RCU stall and
	 * softlockup warnings which exacerbate the issue with more
	 * messages practically incapacitating the system.
	 */
	do_cond_resched = console_may_schedule;
2218 2219
	console_may_schedule = 0;

2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231
again:
	/*
	 * We released the console_sem lock, so we need to recheck if
	 * cpu is online and (if not) is there at least one CON_ANYTIME
	 * console.
	 */
	if (!can_use_console()) {
		console_locked = 0;
		up_console_sem();
		return;
	}

2232
	/* flush buffered message fragment immediately to console */
2233
	console_cont_flush(text, sizeof(text));
2234

2235
	for (;;) {
2236
		struct printk_log *msg;
2237
		size_t ext_len = 0;
2238
		size_t len;
2239 2240
		int level;

2241
		raw_spin_lock_irqsave(&logbuf_lock, flags);
2242 2243 2244 2245 2246 2247
		if (seen_seq != log_next_seq) {
			wake_klogd = true;
			seen_seq = log_next_seq;
		}

		if (console_seq < log_first_seq) {
2248 2249 2250
			len = sprintf(text, "** %u printk messages dropped ** ",
				      (unsigned)(log_first_seq - console_seq));

2251 2252 2253
			/* messages are gone, move to first one */
			console_seq = log_first_seq;
			console_idx = log_first_idx;
2254
			console_prev = 0;
2255 2256
		} else {
			len = 0;
2257
		}
2258
skip:
2259 2260 2261 2262
		if (console_seq == log_next_seq)
			break;

		msg = log_from_idx(console_idx);
2263 2264 2265 2266 2267 2268 2269
		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++;
2270 2271 2272 2273 2274 2275
			/*
			 * 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;
2276
			console_prev = msg->flags;
2277 2278
			goto skip;
		}
2279

2280
		level = msg->level;
2281 2282
		len += msg_print_text(msg, console_prev, false,
				      text + len, sizeof(text) - len);
2283 2284 2285 2286 2287 2288 2289 2290 2291
		if (nr_ext_console_drivers) {
			ext_len = msg_print_ext_header(ext_text,
						sizeof(ext_text),
						msg, console_seq, console_prev);
			ext_len += msg_print_ext_body(ext_text + ext_len,
						sizeof(ext_text) - ext_len,
						log_dict(msg), msg->dict_len,
						log_text(msg), msg->text_len);
		}
2292 2293
		console_idx = log_next(console_idx);
		console_seq++;
2294
		console_prev = msg->flags;
2295
		raw_spin_unlock(&logbuf_lock);
2296

2297
		stop_critical_timings();	/* don't trace print latency */
2298
		call_console_drivers(level, ext_text, ext_len, text, len);
2299
		start_critical_timings();
L
Linus Torvalds 已提交
2300
		local_irq_restore(flags);
2301 2302 2303

		if (do_cond_resched)
			cond_resched();
L
Linus Torvalds 已提交
2304 2305
	}
	console_locked = 0;
2306 2307 2308 2309 2310

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

2311
	raw_spin_unlock(&logbuf_lock);
2312

2313
	up_console_sem();
2314 2315 2316 2317 2318 2319 2320

	/*
	 * 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.
	 */
2321
	raw_spin_lock(&logbuf_lock);
2322
	retry = console_seq != log_next_seq;
P
Peter Zijlstra 已提交
2323 2324
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);

2325 2326 2327
	if (retry && console_trylock())
		goto again;

2328 2329
	if (wake_klogd)
		wake_up_klogd();
L
Linus Torvalds 已提交
2330
}
2331
EXPORT_SYMBOL(console_unlock);
L
Linus Torvalds 已提交
2332

2333 2334
/**
 * console_conditional_schedule - yield the CPU if required
L
Linus Torvalds 已提交
2335 2336 2337 2338 2339
 *
 * If the console code is currently allowed to sleep, and
 * if this CPU should yield the CPU to another task, do
 * so here.
 *
2340
 * Must be called within console_lock();.
L
Linus Torvalds 已提交
2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357
 */
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) {
2358
		if (down_trylock_console_sem() != 0)
L
Linus Torvalds 已提交
2359 2360
			return;
	} else
2361
		console_lock();
L
Linus Torvalds 已提交
2362 2363 2364

	console_locked = 1;
	console_may_schedule = 0;
2365
	for_each_console(c)
L
Linus Torvalds 已提交
2366 2367
		if ((c->flags & CON_ENABLED) && c->unblank)
			c->unblank();
2368
	console_unlock();
L
Linus Torvalds 已提交
2369 2370
}

2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389
/**
 * console_flush_on_panic - flush console content on panic
 *
 * Immediately output all pending messages no matter what.
 */
void console_flush_on_panic(void)
{
	/*
	 * If someone else is holding the console lock, trylock will fail
	 * and may_schedule may be set.  Ignore and proceed to unlock so
	 * that messages are flushed out.  As this can be called from any
	 * context and we don't want to get preempted while flushing,
	 * ensure may_schedule is cleared.
	 */
	console_trylock();
	console_may_schedule = 0;
	console_unlock();
}

L
Linus Torvalds 已提交
2390 2391 2392 2393 2394 2395 2396 2397
/*
 * 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;

2398
	console_lock();
2399
	for_each_console(c) {
L
Linus Torvalds 已提交
2400 2401 2402 2403 2404 2405
		if (!c->device)
			continue;
		driver = c->device(c, index);
		if (driver)
			break;
	}
2406
	console_unlock();
L
Linus Torvalds 已提交
2407 2408 2409 2410 2411 2412 2413 2414 2415 2416
	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)
{
2417
	console_lock();
L
Linus Torvalds 已提交
2418
	console->flags &= ~CON_ENABLED;
2419
	console_unlock();
L
Linus Torvalds 已提交
2420 2421 2422 2423 2424
}
EXPORT_SYMBOL(console_stop);

void console_start(struct console *console)
{
2425
	console_lock();
L
Linus Torvalds 已提交
2426
	console->flags |= CON_ENABLED;
2427
	console_unlock();
L
Linus Torvalds 已提交
2428 2429 2430
}
EXPORT_SYMBOL(console_start);

2431 2432 2433 2434 2435
static int __read_mostly keep_bootcon;

static int __init keep_bootcon_setup(char *str)
{
	keep_bootcon = 1;
2436
	pr_info("debug: skip boot console de-registration.\n");
2437 2438 2439 2440 2441 2442

	return 0;
}

early_param("keep_bootcon", keep_bootcon_setup);

L
Linus Torvalds 已提交
2443 2444 2445 2446 2447
/*
 * 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.
2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460
 *
 * 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 已提交
2461
 */
2462
void register_console(struct console *newcon)
L
Linus Torvalds 已提交
2463
{
J
Jesper Juhl 已提交
2464
	int i;
L
Linus Torvalds 已提交
2465
	unsigned long flags;
2466
	struct console *bcon = NULL;
2467
	struct console_cmdline *c;
L
Linus Torvalds 已提交
2468

2469 2470 2471 2472 2473 2474 2475
	if (console_drivers)
		for_each_console(bcon)
			if (WARN(bcon == newcon,
					"console '%s%d' already registered\n",
					bcon->name, bcon->index))
				return;

2476 2477 2478 2479 2480 2481 2482 2483
	/*
	 * 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)) {
2484
				pr_info("Too late to register bootconsole %s%d\n",
2485 2486 2487 2488
					newcon->name, newcon->index);
				return;
			}
		}
2489 2490
	}

2491 2492 2493 2494
	if (console_drivers && console_drivers->flags & CON_BOOT)
		bcon = console_drivers;

	if (preferred_console < 0 || bcon || !console_drivers)
L
Linus Torvalds 已提交
2495 2496 2497 2498 2499 2500 2501 2502
		preferred_console = selected_console;

	/*
	 *	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) {
2503 2504 2505 2506 2507 2508 2509
		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;
2510 2511
				preferred_console = 0;
			}
L
Linus Torvalds 已提交
2512 2513 2514 2515 2516 2517 2518
		}
	}

	/*
	 *	See if this console matches one we selected on
	 *	the command line.
	 */
2519 2520 2521
	for (i = 0, c = console_cmdline;
	     i < MAX_CMDLINECONSOLES && c->name[0];
	     i++, c++) {
2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532
		if (!newcon->match ||
		    newcon->match(newcon, c->name, c->index, c->options) != 0) {
			/* default matching */
			BUILD_BUG_ON(sizeof(c->name) != sizeof(newcon->name));
			if (strcmp(c->name, newcon->name) != 0)
				continue;
			if (newcon->index >= 0 &&
			    newcon->index != c->index)
				continue;
			if (newcon->index < 0)
				newcon->index = c->index;
2533

2534 2535 2536 2537 2538 2539 2540
			if (_braille_register_console(newcon, c))
				return;

			if (newcon->setup &&
			    newcon->setup(newcon, c->options) != 0)
				break;
		}
2541

2542
		newcon->flags |= CON_ENABLED;
2543
		if (i == selected_console) {
2544
			newcon->flags |= CON_CONSDEV;
2545 2546
			preferred_console = selected_console;
		}
L
Linus Torvalds 已提交
2547 2548 2549
		break;
	}

2550
	if (!(newcon->flags & CON_ENABLED))
L
Linus Torvalds 已提交
2551 2552
		return;

2553 2554 2555 2556 2557 2558 2559
	/*
	 * 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))
2560
		newcon->flags &= ~CON_PRINTBUFFER;
L
Linus Torvalds 已提交
2561 2562 2563 2564 2565

	/*
	 *	Put this console in the list - keep the
	 *	preferred driver at the head of the list.
	 */
2566
	console_lock();
2567 2568 2569 2570 2571
	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 已提交
2572
	} else {
2573 2574
		newcon->next = console_drivers->next;
		console_drivers->next = newcon;
L
Linus Torvalds 已提交
2575
	}
2576 2577 2578 2579 2580

	if (newcon->flags & CON_EXTENDED)
		if (!nr_ext_console_drivers++)
			pr_info("printk: continuation disabled due to ext consoles, expect more fragments in /dev/kmsg\n");

2581
	if (newcon->flags & CON_PRINTBUFFER) {
L
Linus Torvalds 已提交
2582
		/*
2583
		 * console_unlock(); will print out the buffered messages
L
Linus Torvalds 已提交
2584 2585
		 * for us.
		 */
2586
		raw_spin_lock_irqsave(&logbuf_lock, flags);
2587 2588
		console_seq = syslog_seq;
		console_idx = syslog_idx;
2589
		console_prev = syslog_prev;
2590
		raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2591 2592 2593 2594 2595 2596
		/*
		 * 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 已提交
2597
	}
2598
	console_unlock();
2599
	console_sysfs_notify();
2600 2601 2602 2603 2604 2605 2606 2607

	/*
	 * 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)
	 */
2608
	pr_info("%sconsole [%s%d] enabled\n",
2609 2610
		(newcon->flags & CON_BOOT) ? "boot" : "" ,
		newcon->name, newcon->index);
2611 2612 2613
	if (bcon &&
	    ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
	    !keep_bootcon) {
2614 2615
		/* We need to iterate through all boot consoles, to make
		 * sure we print everything out, before we unregister them.
2616 2617 2618 2619 2620
		 */
		for_each_console(bcon)
			if (bcon->flags & CON_BOOT)
				unregister_console(bcon);
	}
L
Linus Torvalds 已提交
2621 2622 2623
}
EXPORT_SYMBOL(register_console);

J
Jesper Juhl 已提交
2624
int unregister_console(struct console *console)
L
Linus Torvalds 已提交
2625
{
J
Jesper Juhl 已提交
2626
        struct console *a, *b;
2627
	int res;
L
Linus Torvalds 已提交
2628

2629
	pr_info("%sconsole [%s%d] disabled\n",
2630 2631 2632
		(console->flags & CON_BOOT) ? "boot" : "" ,
		console->name, console->index);

2633 2634 2635
	res = _braille_unregister_console(console);
	if (res)
		return res;
2636

2637
	res = 1;
2638
	console_lock();
L
Linus Torvalds 已提交
2639 2640 2641
	if (console_drivers == console) {
		console_drivers=console->next;
		res = 0;
2642
	} else if (console_drivers) {
L
Linus Torvalds 已提交
2643 2644 2645 2646 2647 2648
		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 已提交
2649
			}
L
Linus Torvalds 已提交
2650 2651
		}
	}
J
Jesper Juhl 已提交
2652

2653 2654 2655
	if (!res && (console->flags & CON_EXTENDED))
		nr_ext_console_drivers--;

2656
	/*
2657 2658
	 * 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 已提交
2659
	 */
2660
	if (console_drivers != NULL && console->flags & CON_CONSDEV)
2661
		console_drivers->flags |= CON_CONSDEV;
L
Linus Torvalds 已提交
2662

2663
	console->flags &= ~CON_ENABLED;
2664
	console_unlock();
2665
	console_sysfs_notify();
L
Linus Torvalds 已提交
2666 2667 2668
	return res;
}
EXPORT_SYMBOL(unregister_console);
M
Matt Mackall 已提交
2669

2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684
/*
 * Some boot consoles access data that is in the init section and which will
 * be discarded after the initcalls have been run. To make sure that no code
 * will access this data, unregister the boot consoles in a late initcall.
 *
 * If for some reason, such as deferred probe or the driver being a loadable
 * module, the real console hasn't registered yet at this point, there will
 * be a brief interval in which no messages are logged to the console, which
 * makes it difficult to diagnose problems that occur during this time.
 *
 * To mitigate this problem somewhat, only unregister consoles whose memory
 * intersects with the init section. Note that code exists elsewhere to get
 * rid of the boot console as soon as the proper console shows up, so there
 * won't be side-effects from postponing the removal.
 */
2685
static int __init printk_late_init(void)
2686
{
2687 2688 2689
	struct console *con;

	for_each_console(con) {
2690
		if (!keep_bootcon && con->flags & CON_BOOT) {
2691 2692 2693 2694 2695 2696 2697 2698 2699
			/*
			 * Make sure to unregister boot consoles whose data
			 * resides in the init section before the init section
			 * is discarded. Boot consoles whose data will stick
			 * around will automatically be unregistered when the
			 * proper console replaces them.
			 */
			if (init_section_intersects(con, sizeof(*con)))
				unregister_console(con);
2700
		}
2701
	}
2702
	hotcpu_notifier(console_cpu_notify, 0);
2703 2704
	return 0;
}
2705
late_initcall(printk_late_init);
2706

2707
#if defined CONFIG_PRINTK
2708 2709 2710 2711
/*
 * Delayed printk version, for scheduler-internal messages:
 */
#define PRINTK_PENDING_WAKEUP	0x01
2712
#define PRINTK_PENDING_OUTPUT	0x02
2713 2714 2715 2716 2717 2718 2719

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);

2720 2721 2722 2723
	if (pending & PRINTK_PENDING_OUTPUT) {
		/* If trylock fails, someone else is doing the printing */
		if (console_trylock())
			console_unlock();
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739
	}

	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);
2740
		irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2741 2742 2743
	}
	preempt_enable();
}
D
Dave Young 已提交
2744

2745
int printk_deferred(const char *fmt, ...)
2746 2747 2748 2749
{
	va_list args;
	int r;

2750
	preempt_disable();
2751
	va_start(args, fmt);
2752
	r = vprintk_emit(0, LOGLEVEL_SCHED, NULL, 0, fmt, args);
2753 2754
	va_end(args);

2755
	__this_cpu_or(printk_pending, PRINTK_PENDING_OUTPUT);
2756
	irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2757
	preempt_enable();
2758 2759 2760 2761

	return r;
}

L
Linus Torvalds 已提交
2762 2763 2764
/*
 * printk rate limiting, lifted from the networking subsystem.
 *
2765 2766
 * This enforces a rate limit: not more than 10 kernel messages
 * every 5s to make a denial-of-service attack impossible.
L
Linus Torvalds 已提交
2767
 */
2768 2769
DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);

2770
int __printk_ratelimit(const char *func)
L
Linus Torvalds 已提交
2771
{
2772
	return ___ratelimit(&printk_ratelimit_state, func);
L
Linus Torvalds 已提交
2773
}
2774
EXPORT_SYMBOL(__printk_ratelimit);
2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787

/**
 * 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 已提交
2788 2789 2790 2791 2792 2793 2794
	unsigned long elapsed = jiffies - *caller_jiffies;

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

	*caller_jiffies = jiffies;
	return true;
2795 2796
}
EXPORT_SYMBOL(printk_timed_ratelimit);
2797 2798 2799 2800 2801 2802

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

/**
 * kmsg_dump_register - register a kernel log dumper.
R
Randy Dunlap 已提交
2803
 * @dumper: pointer to the kmsg_dumper structure
2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821
 *
 * 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;
2822
		list_add_tail_rcu(&dumper->list, &dump_list);
2823 2824 2825 2826 2827 2828 2829 2830 2831 2832
		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 已提交
2833
 * @dumper: pointer to the kmsg_dumper structure
2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845
 *
 * 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;
2846
		list_del_rcu(&dumper->list);
2847 2848 2849
		err = 0;
	}
	spin_unlock_irqrestore(&dump_list_lock, flags);
2850
	synchronize_rcu();
2851 2852 2853 2854 2855

	return err;
}
EXPORT_SYMBOL_GPL(kmsg_dump_unregister);

2856 2857 2858
static bool always_kmsg_dump;
module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);

2859 2860 2861 2862
/**
 * kmsg_dump - dump kernel log to kernel message dumpers.
 * @reason: the reason (oops, panic etc) for dumping
 *
2863 2864 2865
 * 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().
2866 2867 2868 2869 2870 2871
 */
void kmsg_dump(enum kmsg_dump_reason reason)
{
	struct kmsg_dumper *dumper;
	unsigned long flags;

2872 2873 2874
	if ((reason > KMSG_DUMP_OOPS) && !always_kmsg_dump)
		return;

2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899
	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();
}

/**
2900
 * kmsg_dump_get_line_nolock - retrieve one kmsg log line (unlocked version)
2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914
 * @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.
2915 2916
 *
 * The function is similar to kmsg_dump_get_line(), but grabs no locks.
2917
 */
2918 2919
bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper, bool syslog,
			       char *line, size_t size, size_t *len)
2920
{
2921
	struct printk_log *msg;
2922 2923 2924 2925 2926
	size_t l = 0;
	bool ret = false;

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

2928 2929 2930 2931 2932
	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;
	}
2933

2934
	/* last entry */
2935
	if (dumper->cur_seq >= log_next_seq)
2936
		goto out;
2937

2938
	msg = log_from_idx(dumper->cur_idx);
2939
	l = msg_print_text(msg, 0, syslog, line, size);
2940 2941 2942 2943 2944 2945 2946 2947 2948

	dumper->cur_idx = log_next(dumper->cur_idx);
	dumper->cur_seq++;
	ret = true;
out:
	if (len)
		*len = l;
	return ret;
}
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978

/**
 * 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;
}
2979 2980 2981 2982 2983 2984
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 已提交
2985
 * @buf: buffer to copy the line to
2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007
 * @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;
3008
	enum log_flags prev;
3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030
	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;
3031
	prev = 0;
3032
	while (seq < dumper->next_seq) {
3033
		struct printk_log *msg = log_from_idx(idx);
3034

3035
		l += msg_print_text(msg, prev, true, NULL, 0);
3036 3037
		idx = log_next(idx);
		seq++;
3038
		prev = msg->flags;
3039 3040 3041 3042 3043
	}

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

3048
		l -= msg_print_text(msg, prev, true, NULL, 0);
3049 3050
		idx = log_next(idx);
		seq++;
3051
		prev = msg->flags;
3052
	}
3053 3054 3055 3056 3057 3058 3059

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

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

3062
		l += msg_print_text(msg, prev, syslog, buf + l, size - l);
3063 3064
		idx = log_next(idx);
		seq++;
3065
		prev = msg->flags;
3066 3067 3068 3069 3070
	}

	dumper->next_seq = next_seq;
	dumper->next_idx = next_idx;
	ret = true;
3071
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
3072 3073 3074 3075 3076 3077
out:
	if (len)
		*len = l;
	return ret;
}
EXPORT_SYMBOL_GPL(kmsg_dump_get_buffer);
3078

3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096
/**
 * 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;
}

3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109
/**
 * 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);
3110
	kmsg_dump_rewind_nolock(dumper);
3111
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
3112
}
3113
EXPORT_SYMBOL_GPL(kmsg_dump_rewind);
3114

3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136
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);
}

3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150
/**
 * 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);
3151 3152 3153 3154

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

	print_worker_info(log_lvl, current);
3157 3158
}

3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174
/**
 * 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));
}

3175
#endif