printk.c 78.8 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 51

#include <asm/uaccess.h>

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

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

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

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

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

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

87 88 89 90 91 92 93 94 95 96 97 98
/*
 * 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;

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

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

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

#define MAX_CMDLINECONSOLES 8

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

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

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

153 154 155 156 157 158
/*
 * 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 已提交
159 160
 * sequence numbers of these entries are maintained when messages are
 * stored.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
 *
 * 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.
 *
176 177 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
 * 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
 *
205
 * The 'struct printk_log' buffer header must never be directly exported to
206 207 208 209
 * 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:
210
 *   "<level>,<sequnum>,<timestamp>,<contflag>;<message text>\n"
211 212 213 214 215 216 217
 *
 * The optional key/value pairs are attached as continuation lines starting
 * with a space character and terminated by a newline. All possible
 * non-prinatable characters are escaped in the "\xff" notation.
 *
 * Users of the export format should ignore possible additional values
 * separated by ',', and find the message after the ';' character.
218 219
 */

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

227
struct printk_log {
228 229 230 231
	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 */
232 233 234
	u8 facility;		/* syslog facility */
	u8 flags:5;		/* internal record flags */
	u8 level:3;		/* syslog level */
235 236 237
};

/*
238 239 240
 * 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.
241 242
 */
static DEFINE_RAW_SPINLOCK(logbuf_lock);
M
Matt Mackall 已提交
243

244
#ifdef CONFIG_PRINTK
245
DECLARE_WAIT_QUEUE_HEAD(log_wait);
246 247 248
/* the next printk record to read by syslog(READ) or /proc/kmsg */
static u64 syslog_seq;
static u32 syslog_idx;
249
static enum log_flags syslog_prev;
250
static size_t syslog_partial;
251 252 253 254 255 256 257 258 259

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

260 261 262 263 264
/* the next printk record to write to the console */
static u64 console_seq;
static u32 console_idx;
static enum log_flags console_prev;

265 266 267 268
/* the next printk record to read after the last 'clear' command */
static u64 clear_seq;
static u32 clear_idx;

269
#define PREFIX_MAX		32
A
Alex Elder 已提交
270
#define LOG_LINE_MAX		(1024 - PREFIX_MAX)
271 272

/* record buffer */
273
#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
274 275
#define LOG_ALIGN 4
#else
276
#define LOG_ALIGN __alignof__(struct printk_log)
277
#endif
278
#define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
279
static char __log_buf[__LOG_BUF_LEN] __aligned(LOG_ALIGN);
280 281 282
static char *log_buf = __log_buf;
static u32 log_buf_len = __LOG_BUF_LEN;

283 284 285 286 287 288 289 290 291 292 293 294
/* 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;
}

295
/* human readable text of the record */
296
static char *log_text(const struct printk_log *msg)
297
{
298
	return (char *)msg + sizeof(struct printk_log);
299 300 301
}

/* optional key/value pair dictionary attached to the record */
302
static char *log_dict(const struct printk_log *msg)
303
{
304
	return (char *)msg + sizeof(struct printk_log) + msg->text_len;
305 306 307
}

/* get record by index; idx must point to valid msg */
308
static struct printk_log *log_from_idx(u32 idx)
309
{
310
	struct printk_log *msg = (struct printk_log *)(log_buf + idx);
311 312 313 314 315 316

	/*
	 * 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)
317
		return (struct printk_log *)log_buf;
318 319 320 321 322 323
	return msg;
}

/* get next record; idx must point to valid msg */
static u32 log_next(u32 idx)
{
324
	struct printk_log *msg = (struct printk_log *)(log_buf + idx);
325 326 327 328 329 330 331 332

	/* 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) {
333
		msg = (struct printk_log *)log_buf;
334 335 336 337 338
		return msg->len;
	}
	return idx + msg->len;
}

P
Petr Mladek 已提交
339 340 341 342 343 344 345 346 347 348
/*
 * 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)
349 350 351
{
	u32 free;

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

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

	return -ENOMEM;
379 380
}

381 382 383 384 385 386 387 388 389 390 391 392
/* 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 已提交
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
/*
 * 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);
}

419
/* insert record into the buffer, discard old ones, update heads */
420 421 422 423
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)
424
{
425
	struct printk_log *msg;
426
	u32 size, pad_len;
P
Petr Mladek 已提交
427
	u16 trunc_msg_len = 0;
428 429

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

P
Petr Mladek 已提交
432 433 434 435 436 437
	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))
438
			return 0;
P
Petr Mladek 已提交
439
	}
440

441
	if (log_next_idx + size + sizeof(struct printk_log) > log_buf_len) {
442 443 444 445 446
		/*
		 * 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.
		 */
447
		memset(log_buf + log_next_idx, 0, sizeof(struct printk_log));
448 449 450 451
		log_next_idx = 0;
	}

	/* fill message */
452
	msg = (struct printk_log *)(log_buf + log_next_idx);
453 454
	memcpy(log_text(msg), text, text_len);
	msg->text_len = text_len;
P
Petr Mladek 已提交
455 456 457 458
	if (trunc_msg_len) {
		memcpy(log_text(msg) + text_len, trunc_msg, trunc_msg_len);
		msg->text_len += trunc_msg_len;
	}
459 460
	memcpy(log_dict(msg), dict, dict_len);
	msg->dict_len = dict_len;
461 462 463 464 465 466 467
	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();
468
	memset(log_dict(msg) + dict_len, 0, pad_len);
469
	msg->len = size;
470 471 472 473

	/* insert message */
	log_next_idx += msg->len;
	log_next_seq++;
474 475

	return msg->text_len;
476
}
M
Matt Mackall 已提交
477

A
Alex Elder 已提交
478
int dmesg_restrict = IS_ENABLED(CONFIG_SECURITY_DMESG_RESTRICT);
479 480 481 482 483 484 485 486 487 488 489 490 491

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

492
int check_syslog_permissions(int type, int source)
493 494 495 496 497
{
	/*
	 * If this is from /proc/kmsg and we've already opened it, then we've
	 * already done the capabilities checks at open time.
	 */
498
	if (source == SYSLOG_FROM_PROC && type != SYSLOG_ACTION_OPEN)
499
		goto ok;
500 501 502

	if (syslog_action_restricted(type)) {
		if (capable(CAP_SYSLOG))
503
			goto ok;
504 505 506 507 508 509 510 511 512
		/*
		 * 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));
513
			goto ok;
514 515 516
		}
		return -EPERM;
	}
517
ok:
518 519 520
	return security_syslog(type);
}

521 522 523 524 525
static void append_char(char **pp, char *e, char c)
{
	if (*pp < e)
		*(*pp)++ = c;
}
526

527 528 529 530 531 532 533 534 535 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
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;
}

602 603 604 605
/* /dev/kmsg - userspace message inject/listen interface */
struct devkmsg_user {
	u64 seq;
	u32 idx;
606
	enum log_flags prev;
607
	struct mutex lock;
608
	char buf[CONSOLE_EXT_LOG_MAX];
609 610
};

A
Al Viro 已提交
611
static ssize_t devkmsg_write(struct kiocb *iocb, struct iov_iter *from)
612 613 614 615 616
{
	char *buf, *line;
	int i;
	int level = default_message_loglevel;
	int facility = 1;	/* LOG_USER */
C
Christoph Hellwig 已提交
617
	size_t len = iov_iter_count(from);
618 619 620 621 622 623 624 625
	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 已提交
626 627 628 629
	buf[len] = '\0';
	if (copy_from_iter(buf, len, from) != len) {
		kfree(buf);
		return -EFAULT;
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
	}

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

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

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

static ssize_t devkmsg_read(struct file *file, char __user *buf,
			    size_t count, loff_t *ppos)
{
	struct devkmsg_user *user = file->private_data;
665
	struct printk_log *msg;
666 667 668 669 670 671
	size_t len;
	ssize_t ret;

	if (!user)
		return -EBADF;

672 673 674
	ret = mutex_lock_interruptible(&user->lock);
	if (ret)
		return ret;
675
	raw_spin_lock_irq(&logbuf_lock);
676 677 678
	while (user->seq == log_next_seq) {
		if (file->f_flags & O_NONBLOCK) {
			ret = -EAGAIN;
679
			raw_spin_unlock_irq(&logbuf_lock);
680 681 682
			goto out;
		}

683
		raw_spin_unlock_irq(&logbuf_lock);
684 685 686 687
		ret = wait_event_interruptible(log_wait,
					       user->seq != log_next_seq);
		if (ret)
			goto out;
688
		raw_spin_lock_irq(&logbuf_lock);
689 690 691 692 693 694 695
	}

	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;
696
		raw_spin_unlock_irq(&logbuf_lock);
697 698 699 700
		goto out;
	}

	msg = log_from_idx(user->idx);
701 702 703 704 705
	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);
706 707

	user->prev = msg->flags;
708 709
	user->idx = log_next(user->idx);
	user->seq++;
710
	raw_spin_unlock_irq(&logbuf_lock);
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736

	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;

737
	raw_spin_lock_irq(&logbuf_lock);
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
	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;
	}
761
	raw_spin_unlock_irq(&logbuf_lock);
762 763 764 765 766 767 768 769 770 771 772 773 774
	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);

775
	raw_spin_lock_irq(&logbuf_lock);
776 777 778 779
	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;
780 781
		else
			ret = POLLIN|POLLRDNORM;
782
	}
783
	raw_spin_unlock_irq(&logbuf_lock);
784 785 786 787 788 789 790 791 792 793 794 795 796

	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;

797 798
	err = check_syslog_permissions(SYSLOG_ACTION_READ_ALL,
				       SYSLOG_FROM_READER);
799 800 801 802 803 804 805 806 807
	if (err)
		return err;

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

	mutex_init(&user->lock);

808
	raw_spin_lock_irq(&logbuf_lock);
809 810
	user->idx = log_first_idx;
	user->seq = log_first_seq;
811
	raw_spin_unlock_irq(&logbuf_lock);
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831

	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 已提交
832
	.write_iter = devkmsg_write,
833 834 835 836 837
	.llseek = devkmsg_llseek,
	.poll = devkmsg_poll,
	.release = devkmsg_release,
};

838 839
#ifdef CONFIG_KEXEC
/*
840
 * This appends the listed symbols to /proc/vmcore
841
 *
842
 * /proc/vmcore is used by various utilities, like crash and makedumpfile to
843 844 845 846 847 848 849 850
 * 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);
851 852
	VMCOREINFO_SYMBOL(log_first_idx);
	VMCOREINFO_SYMBOL(log_next_idx);
853
	/*
854
	 * Export struct printk_log size and field offsets. User space tools can
855 856
	 * parse it and detect any changes to structure down the line.
	 */
857 858 859 860 861
	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);
862 863 864
}
#endif

865 866 867
/* requested log_buf_len from kernel cmdline */
static unsigned long __initdata new_log_buf_len;

868 869
/* we practice scaling the ring buffer by powers of 2 */
static void __init log_buf_len_update(unsigned size)
L
Linus Torvalds 已提交
870 871 872
{
	if (size)
		size = roundup_pow_of_two(size);
873 874
	if (size > log_buf_len)
		new_log_buf_len = size;
875 876 877 878 879 880 881 882
}

/* 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);
883 884

	return 0;
L
Linus Torvalds 已提交
885
}
886 887
early_param("log_buf_len", log_buf_len_setup);

888 889 890
#ifdef CONFIG_SMP
#define __LOG_CPU_MAX_BUF_LEN (1 << CONFIG_LOG_CPU_MAX_BUF_SHIFT)

891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
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);
}
917 918 919
#else /* !CONFIG_SMP */
static inline void log_buf_add_cpu(void) {}
#endif /* CONFIG_SMP */
920

921 922 923 924 925 926
void __init setup_log_buf(int early)
{
	unsigned long flags;
	char *new_log_buf;
	int free;

927 928 929 930 931 932
	if (log_buf != __log_buf)
		return;

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

933 934
	if (!new_log_buf_len)
		return;
L
Linus Torvalds 已提交
935

936
	if (early) {
937
		new_log_buf =
938
			memblock_virt_alloc(new_log_buf_len, LOG_ALIGN);
939
	} else {
940 941
		new_log_buf = memblock_virt_alloc_nopanic(new_log_buf_len,
							  LOG_ALIGN);
942 943 944 945 946 947 948 949
	}

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

950
	raw_spin_lock_irqsave(&logbuf_lock, flags);
951 952 953
	log_buf_len = new_log_buf_len;
	log_buf = new_log_buf;
	new_log_buf_len = 0;
954 955
	free = __LOG_BUF_LEN - log_next_idx;
	memcpy(log_buf, __log_buf, __LOG_BUF_LEN);
956
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
957

958
	pr_info("log_buf_len: %d bytes\n", log_buf_len);
959 960 961
	pr_info("early log buf free: %d(%d%%)\n",
		free, (free * 100) / __LOG_BUF_LEN);
}
L
Linus Torvalds 已提交
962

963 964 965 966
static bool __read_mostly ignore_loglevel;

static int __init ignore_loglevel_setup(char *str)
{
967
	ignore_loglevel = true;
968
	pr_info("debug: ignoring loglevel setting.\n");
969 970 971 972 973 974

	return 0;
}

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

R
Randy Dunlap 已提交
978 979
#ifdef CONFIG_BOOT_PRINTK_DELAY

980
static int boot_delay; /* msecs delay after each printk during bootup */
981
static unsigned long long loops_per_msec;	/* based on boot_delay */
R
Randy Dunlap 已提交
982 983 984 985 986 987 988 989 990 991 992 993

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;

994 995 996
	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);
997
	return 0;
R
Randy Dunlap 已提交
998
}
999
early_param("boot_delay", boot_delay_setup);
R
Randy Dunlap 已提交
1000

1001
static void boot_delay_msec(int level)
R
Randy Dunlap 已提交
1002 1003 1004 1005
{
	unsigned long long k;
	unsigned long timeout;

1006 1007
	if ((boot_delay == 0 || system_state != SYSTEM_BOOTING)
		|| (level >= console_loglevel && !ignore_loglevel)) {
R
Randy Dunlap 已提交
1008
		return;
1009
	}
R
Randy Dunlap 已提交
1010

1011
	k = (unsigned long long)loops_per_msec * boot_delay;
R
Randy Dunlap 已提交
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027

	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
1028
static inline void boot_delay_msec(int level)
R
Randy Dunlap 已提交
1029 1030 1031 1032
{
}
#endif

A
Alex Elder 已提交
1033
static bool printk_time = IS_ENABLED(CONFIG_PRINTK_TIME);
1034 1035
module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);

1036 1037 1038 1039 1040 1041 1042
static size_t print_time(u64 ts, char *buf)
{
	unsigned long rem_nsec;

	if (!printk_time)
		return 0;

1043 1044
	rem_nsec = do_div(ts, 1000000000);

1045
	if (!buf)
1046
		return snprintf(NULL, 0, "[%5lu.000000] ", (unsigned long)ts);
1047 1048 1049 1050 1051

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

1052
static size_t print_prefix(const struct printk_log *msg, bool syslog, char *buf)
1053
{
1054
	size_t len = 0;
1055
	unsigned int prefix = (msg->facility << 3) | msg->level;
1056

1057 1058
	if (syslog) {
		if (buf) {
1059
			len += sprintf(buf, "<%u>", prefix);
1060 1061
		} else {
			len += 3;
1062 1063 1064 1065 1066
			if (prefix > 999)
				len += 3;
			else if (prefix > 99)
				len += 2;
			else if (prefix > 9)
1067 1068 1069
				len++;
		}
	}
1070

1071
	len += print_time(msg->ts_nsec, buf ? buf + len : NULL);
1072
	return len;
1073 1074
}

1075
static size_t msg_print_text(const struct printk_log *msg, enum log_flags prev,
1076
			     bool syslog, char *buf, size_t size)
1077
{
1078 1079
	const char *text = log_text(msg);
	size_t text_size = msg->text_len;
1080 1081
	bool prefix = true;
	bool newline = true;
1082 1083
	size_t len = 0;

1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
	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;
	}

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

1107 1108
		if (buf) {
			if (print_prefix(msg, syslog, NULL) +
1109
			    text_len + 1 >= size - len)
1110
				break;
1111

1112 1113
			if (prefix)
				len += print_prefix(msg, syslog, buf + len);
1114 1115
			memcpy(buf + len, text, text_len);
			len += text_len;
1116 1117
			if (next || newline)
				buf[len++] = '\n';
1118 1119
		} else {
			/* SYSLOG_ACTION_* buffer size only calculation */
1120 1121 1122 1123 1124
			if (prefix)
				len += print_prefix(msg, syslog, NULL);
			len += text_len;
			if (next || newline)
				len++;
1125
		}
1126

1127
		prefix = true;
1128 1129
		text = next;
	} while (text);
1130 1131 1132 1133 1134 1135 1136

	return len;
}

static int syslog_print(char __user *buf, int size)
{
	char *text;
1137
	struct printk_log *msg;
1138
	int len = 0;
1139

1140
	text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1141 1142 1143
	if (!text)
		return -ENOMEM;

1144 1145
	while (size > 0) {
		size_t n;
1146
		size_t skip;
1147 1148 1149 1150 1151 1152

		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;
1153
			syslog_prev = 0;
1154
			syslog_partial = 0;
1155 1156 1157 1158 1159
		}
		if (syslog_seq == log_next_seq) {
			raw_spin_unlock_irq(&logbuf_lock);
			break;
		}
1160 1161

		skip = syslog_partial;
1162
		msg = log_from_idx(syslog_idx);
1163 1164
		n = msg_print_text(msg, syslog_prev, true, text,
				   LOG_LINE_MAX + PREFIX_MAX);
1165 1166
		if (n - syslog_partial <= size) {
			/* message fits into buffer, move forward */
1167 1168
			syslog_idx = log_next(syslog_idx);
			syslog_seq++;
1169
			syslog_prev = msg->flags;
1170 1171 1172 1173 1174 1175
			n -= syslog_partial;
			syslog_partial = 0;
		} else if (!len){
			/* partial read(), remember position */
			n = size;
			syslog_partial += n;
1176 1177 1178 1179 1180 1181 1182
		} else
			n = 0;
		raw_spin_unlock_irq(&logbuf_lock);

		if (!n)
			break;

1183
		if (copy_to_user(buf, text + skip, n)) {
1184 1185 1186 1187
			if (!len)
				len = -EFAULT;
			break;
		}
1188 1189 1190 1191

		len += n;
		size -= n;
		buf += n;
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
	}

	kfree(text);
	return len;
}

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

1203
	text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1204 1205 1206 1207 1208 1209 1210 1211
	if (!text)
		return -ENOMEM;

	raw_spin_lock_irq(&logbuf_lock);
	if (buf) {
		u64 next_seq;
		u64 seq;
		u32 idx;
1212
		enum log_flags prev;
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222

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

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

1230
			len += msg_print_text(msg, prev, true, NULL, 0);
1231
			prev = msg->flags;
1232 1233 1234
			idx = log_next(idx);
			seq++;
		}
1235 1236

		/* move first record forward until length fits into the buffer */
1237 1238
		seq = clear_seq;
		idx = clear_idx;
1239
		prev = 0;
1240
		while (len > size && seq < log_next_seq) {
1241
			struct printk_log *msg = log_from_idx(idx);
1242

1243
			len -= msg_print_text(msg, prev, true, NULL, 0);
1244
			prev = msg->flags;
1245 1246 1247 1248
			idx = log_next(idx);
			seq++;
		}

1249
		/* last message fitting into this dump */
1250 1251 1252 1253
		next_seq = log_next_seq;

		len = 0;
		while (len >= 0 && seq < next_seq) {
1254
			struct printk_log *msg = log_from_idx(idx);
1255 1256
			int textlen;

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

			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;
1278
				prev = 0;
1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
			}
		}
	}

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

	kfree(text);
	return len;
}

1293
int do_syslog(int type, char __user *buf, int len, int source)
L
Linus Torvalds 已提交
1294
{
1295
	bool clear = false;
1296
	static int saved_console_loglevel = LOGLEVEL_DEFAULT;
1297
	int error;
L
Linus Torvalds 已提交
1298

1299
	error = check_syslog_permissions(type, source);
1300 1301
	if (error)
		goto out;
1302

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

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

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

1419
SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
L
Linus Torvalds 已提交
1420
{
1421
	return do_syslog(type, buf, len, SYSLOG_FROM_READER);
L
Linus Torvalds 已提交
1422 1423 1424 1425 1426
}

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

1435
	trace_console(text, len);
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451

	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;
1452 1453 1454 1455
		if (con->flags & CON_EXTENDED)
			con->write(con, ext_text, ext_len);
		else
			con->write(con, text, len);
1456
	}
L
Linus Torvalds 已提交
1457 1458 1459
}

/*
1460 1461 1462
 * 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 已提交
1463 1464 1465 1466 1467 1468
 */
static void zap_locks(void)
{
	static unsigned long oops_timestamp;

	if (time_after_eq(jiffies, oops_timestamp) &&
1469
	    !time_after(jiffies, oops_timestamp + 30 * HZ))
L
Linus Torvalds 已提交
1470 1471 1472 1473
		return;

	oops_timestamp = jiffies;

1474
	debug_locks_off();
L
Linus Torvalds 已提交
1475
	/* If a crash is occurring, make sure we can't deadlock */
1476
	raw_spin_lock_init(&logbuf_lock);
L
Linus Torvalds 已提交
1477
	/* And make sure that we print immediately */
1478
	sema_init(&console_sem, 1);
L
Linus Torvalds 已提交
1479 1480
}

1481 1482 1483 1484
/*
 * Check if we have any console that is capable of printing while cpu is
 * booting or shutting down. Requires console_sem.
 */
1485 1486 1487 1488
static int have_callable_console(void)
{
	struct console *con;

1489
	for_each_console(con)
1490 1491 1492 1493 1494 1495
		if (con->flags & CON_ANYTIME)
			return 1;

	return 0;
}

1496 1497 1498
/*
 * Can we actually use the console at this time on this cpu?
 *
1499 1500 1501
 * 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.
1502 1503 1504 1505 1506 1507 1508 1509 1510
 */
static inline int can_use_console(unsigned int cpu)
{
	return cpu_online(cpu) || have_callable_console();
}

/*
 * Try to get console ownership to actually show the kernel
 * messages from a 'printk'. Return true (and with the
1511
 * console_lock held, and 'console_locked' set) if it
1512 1513
 * is successful, false otherwise.
 */
1514
static int console_trylock_for_printk(void)
1515
{
1516 1517
	unsigned int cpu = smp_processor_id();

1518 1519 1520 1521 1522 1523 1524 1525 1526
	if (!console_trylock())
		return 0;
	/*
	 * If we can't use the console, we need to release the console
	 * semaphore by hand to avoid flushing the buffer. We need to hold the
	 * console semaphore in order to do this test safely.
	 */
	if (!can_use_console(cpu)) {
		console_locked = 0;
1527
		up_console_sem();
1528 1529 1530
		return 0;
	}
	return 1;
1531
}
1532

1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
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();
		}
	}
}

1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
/*
 * 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 已提交
1560
	u8 facility;			/* log facility of first message */
1561
	enum log_flags flags;		/* prefix, newline flags */
1562 1563 1564
	bool flushed:1;			/* buffer sealed and committed */
} cont;

1565
static void cont_flush(enum log_flags flags)
1566 1567 1568 1569 1570 1571
{
	if (cont.flushed)
		return;
	if (cont.len == 0)
		return;

1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590
	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;
	}
1591 1592 1593 1594 1595 1596 1597
}

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

1598 1599 1600 1601 1602 1603
	/*
	 * 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)) {
1604
		cont_flush(LOG_CONT);
1605 1606 1607 1608 1609 1610 1611 1612
		return false;
	}

	if (!cont.len) {
		cont.facility = facility;
		cont.level = level;
		cont.owner = current;
		cont.ts_nsec = local_clock();
1613
		cont.flags = 0;
1614 1615 1616 1617 1618 1619
		cont.cons = 0;
		cont.flushed = false;
	}

	memcpy(cont.buf + cont.len, text, len);
	cont.len += len;
1620 1621 1622 1623

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

1624 1625 1626 1627 1628 1629 1630 1631
	return true;
}

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

1632
	if (cont.cons == 0 && (console_prev & LOG_NEWLINE)) {
1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
		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) {
1647 1648
		if (cont.flags & LOG_NEWLINE)
			text[textlen++] = '\n';
1649 1650 1651 1652 1653 1654
		/* got everything, release buffer */
		cont.len = 0;
	}
	return textlen;
}

1655 1656 1657
asmlinkage int vprintk_emit(int facility, int level,
			    const char *dict, size_t dictlen,
			    const char *fmt, va_list args)
L
Linus Torvalds 已提交
1658
{
1659 1660 1661
	static int recursion_bug;
	static char textbuf[LOG_LINE_MAX];
	char *text = textbuf;
1662
	size_t text_len = 0;
1663
	enum log_flags lflags = 0;
1664
	unsigned long flags;
1665
	int this_cpu;
1666
	int printed_len = 0;
1667
	bool in_sched = false;
1668
	/* cpu currently holding logbuf_lock in this function */
1669
	static unsigned int logbuf_cpu = UINT_MAX;
1670

1671 1672
	if (level == LOGLEVEL_SCHED) {
		level = LOGLEVEL_DEFAULT;
1673 1674
		in_sched = true;
	}
L
Linus Torvalds 已提交
1675

1676
	boot_delay_msec(level);
1677
	printk_delay();
R
Randy Dunlap 已提交
1678

L
Linus Torvalds 已提交
1679
	/* This stops the holder of console_sem just where we want him */
1680
	local_irq_save(flags);
1681 1682 1683 1684 1685
	this_cpu = smp_processor_id();

	/*
	 * Ouch, printk recursed into itself!
	 */
1686
	if (unlikely(logbuf_cpu == this_cpu)) {
1687 1688 1689 1690 1691 1692 1693
		/*
		 * 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:
		 */
1694
		if (!oops_in_progress && !lockdep_recursing(current)) {
1695
			recursion_bug = 1;
1696 1697
			local_irq_restore(flags);
			return 0;
1698 1699 1700 1701
		}
		zap_locks();
	}

1702
	lockdep_off();
1703
	raw_spin_lock(&logbuf_lock);
1704
	logbuf_cpu = this_cpu;
L
Linus Torvalds 已提交
1705

1706
	if (unlikely(recursion_bug)) {
1707 1708 1709
		static const char recursion_msg[] =
			"BUG: recent printk recursion!";

1710
		recursion_bug = 0;
1711
		/* emit KERN_CRIT message */
1712
		printed_len += log_store(0, 2, LOG_PREFIX|LOG_NEWLINE, 0,
1713 1714
					 NULL, 0, recursion_msg,
					 strlen(recursion_msg));
1715
	}
L
Linus Torvalds 已提交
1716

1717 1718 1719 1720
	/*
	 * The printf needs to come first; we need the syslog
	 * prefix which might be passed-in as a parameter.
	 */
1721
	text_len = vscnprintf(text, sizeof(textbuf), fmt, args);
1722

1723
	/* mark and strip a trailing newline */
1724 1725
	if (text_len && text[text_len-1] == '\n') {
		text_len--;
1726
		lflags |= LOG_NEWLINE;
1727
	}
1728

1729 1730 1731 1732 1733 1734 1735 1736
	/* 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':
1737
				if (level == LOGLEVEL_DEFAULT)
1738
					level = kern_level - '0';
1739
				/* fallthrough */
1740 1741 1742
			case 'd':	/* KERN_DEFAULT */
				lflags |= LOG_PREFIX;
			}
1743 1744 1745 1746 1747
			/*
			 * No need to check length here because vscnprintf
			 * put '\0' at the end of the string. Only valid and
			 * newly printed level is detected.
			 */
1748 1749
			text_len -= end_of_header - text;
			text = (char *)end_of_header;
1750 1751 1752
		}
	}

1753
	if (level == LOGLEVEL_DEFAULT)
1754
		level = default_message_loglevel;
1755

1756 1757
	if (dict)
		lflags |= LOG_PREFIX|LOG_NEWLINE;
1758

1759
	if (!(lflags & LOG_NEWLINE)) {
1760 1761 1762 1763
		/*
		 * Flush the conflicting buffer. An earlier newline was missing,
		 * or another task also prints continuation lines.
		 */
1764
		if (cont.len && (lflags & LOG_PREFIX || cont.owner != current))
1765
			cont_flush(LOG_NEWLINE);
1766

1767
		/* buffer line if possible, otherwise store it right away */
1768 1769 1770 1771 1772 1773
		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);
1774
	} else {
1775
		bool stored = false;
1776

1777
		/*
1778 1779 1780 1781
		 * 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.
1782 1783
		 * If the preceding printk was from a different task and missed
		 * a newline, flush and append the newline.
1784
		 */
1785 1786 1787 1788
		if (cont.len) {
			if (cont.owner == current && !(lflags & LOG_PREFIX))
				stored = cont_add(facility, level, text,
						  text_len);
1789
			cont_flush(LOG_NEWLINE);
1790
		}
1791

1792 1793 1794 1795 1796
		if (stored)
			printed_len += text_len;
		else
			printed_len += log_store(facility, level, lflags, 0,
						 dict, dictlen, text, text_len);
L
Linus Torvalds 已提交
1797 1798
	}

1799 1800
	logbuf_cpu = UINT_MAX;
	raw_spin_unlock(&logbuf_lock);
1801 1802
	lockdep_on();
	local_irq_restore(flags);
1803

1804
	/* If called from the scheduler, we can not call up(). */
1805
	if (!in_sched) {
1806 1807 1808 1809 1810 1811 1812 1813
		lockdep_off();
		/*
		 * Disable preemption to avoid being preempted while holding
		 * console_sem which would prevent anyone from printing to
		 * console
		 */
		preempt_disable();

1814 1815 1816 1817 1818
		/*
		 * Try to acquire and then immediately release the console
		 * semaphore.  The release will print out buffers and wake up
		 * /dev/kmsg and syslog() users.
		 */
1819
		if (console_trylock_for_printk())
1820
			console_unlock();
1821 1822
		preempt_enable();
		lockdep_on();
1823
	}
1824

L
Linus Torvalds 已提交
1825 1826
	return printed_len;
}
1827 1828 1829 1830
EXPORT_SYMBOL(vprintk_emit);

asmlinkage int vprintk(const char *fmt, va_list args)
{
1831
	return vprintk_emit(0, LOGLEVEL_DEFAULT, NULL, 0, fmt, args);
1832
}
L
Linus Torvalds 已提交
1833 1834
EXPORT_SYMBOL(vprintk);

1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849
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);

1850 1851 1852 1853 1854 1855
int vprintk_default(const char *fmt, va_list args)
{
	int r;

#ifdef CONFIG_KGDB_KDB
	if (unlikely(kdb_trap_printk)) {
1856
		r = vkdb_printf(KDB_MSGSRC_PRINTK, fmt, args);
1857 1858 1859
		return r;
	}
#endif
1860
	r = vprintk_emit(0, LOGLEVEL_DEFAULT, NULL, 0, fmt, args);
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873

	return r;
}
EXPORT_SYMBOL_GPL(vprintk_default);

/*
 * This allows printk to be diverted to another function per cpu.
 * This is useful for calling printk functions from within NMI
 * without worrying about race conditions that can lock up the
 * box.
 */
DEFINE_PER_CPU(printk_func_t, printk_func) = vprintk_default;

1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894
/**
 * 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.
 */
1895
asmlinkage __visible int printk(const char *fmt, ...)
1896
{
1897
	printk_func_t vprintk_func;
1898 1899 1900 1901
	va_list args;
	int r;

	va_start(args, fmt);
1902 1903 1904 1905 1906 1907 1908

	/*
	 * If a caller overrides the per_cpu printk_func, then it needs
	 * to disable preemption when calling printk(). Otherwise
	 * the printk_func should be set to the default. No need to
	 * disable preemption here.
	 */
1909 1910
	vprintk_func = this_cpu_read(printk_func);
	r = vprintk_func(fmt, args);
1911

1912 1913 1914 1915 1916
	va_end(args);

	return r;
}
EXPORT_SYMBOL(printk);
1917

1918
#else /* CONFIG_PRINTK */
M
Matt Mackall 已提交
1919

1920 1921
#define LOG_LINE_MAX		0
#define PREFIX_MAX		0
A
Alex Elder 已提交
1922

1923 1924
static u64 syslog_seq;
static u32 syslog_idx;
1925 1926
static u64 console_seq;
static u32 console_idx;
1927 1928 1929 1930
static enum log_flags syslog_prev;
static u64 log_first_seq;
static u32 log_first_idx;
static u64 log_next_seq;
1931
static enum log_flags console_prev;
1932 1933 1934 1935 1936 1937
static struct cont {
	size_t len;
	size_t cons;
	u8 level;
	bool flushed:1;
} cont;
1938 1939
static char *log_text(const struct printk_log *msg) { return NULL; }
static char *log_dict(const struct printk_log *msg) { return NULL; }
1940
static struct printk_log *log_from_idx(u32 idx) { return NULL; }
1941
static u32 log_next(u32 idx) { return 0; }
1942 1943 1944 1945 1946 1947 1948 1949 1950
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) {}
1951
static size_t msg_print_text(const struct printk_log *msg, enum log_flags prev,
1952
			     bool syslog, char *buf, size_t size) { return 0; }
1953
static size_t cont_print_text(char *text, size_t size) { return 0; }
M
Matt Mackall 已提交
1954

1955 1956 1957
/* Still needs to be defined for users */
DEFINE_PER_CPU(printk_func_t, printk_func);

1958
#endif /* CONFIG_PRINTK */
M
Matt Mackall 已提交
1959

1960 1961 1962
#ifdef CONFIG_EARLY_PRINTK
struct console *early_console;

1963
asmlinkage __visible void early_printk(const char *fmt, ...)
1964 1965
{
	va_list ap;
1966 1967 1968 1969 1970
	char buf[512];
	int n;

	if (!early_console)
		return;
1971 1972

	va_start(ap, fmt);
1973
	n = vscnprintf(buf, sizeof(buf), fmt, ap);
1974
	va_end(ap);
1975 1976

	early_console->write(early_console, buf, n);
1977 1978 1979
}
#endif

1980 1981 1982 1983 1984 1985 1986 1987 1988 1989
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.
	 */
1990 1991 1992 1993 1994 1995 1996
	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;
1997
		}
1998
	}
1999 2000 2001 2002 2003 2004
	if (i == MAX_CMDLINECONSOLES)
		return -E2BIG;
	if (!brl_options)
		selected_console = i;
	strlcpy(c->name, name, sizeof(c->name));
	c->options = options;
2005 2006
	braille_set_options(c, brl_options);

2007 2008 2009
	c->index = idx;
	return 0;
}
2010
/*
A
Alex Elder 已提交
2011 2012
 * Set up a console.  Called via do_early_param() in init/main.c
 * for each "console=" parameter in the boot command line.
2013 2014 2015
 */
static int __init console_setup(char *str)
{
A
Alex Elder 已提交
2016
	char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for "ttyS" */
2017
	char *s, *options, *brl_options = NULL;
2018 2019
	int idx;

2020 2021
	if (_braille_console_setup(&str, &brl_options))
		return 1;
2022

2023 2024 2025 2026
	/*
	 * Decode str into name, index, options.
	 */
	if (str[0] >= '0' && str[0] <= '9') {
Y
Yinghai Lu 已提交
2027 2028
		strcpy(buf, "ttyS");
		strncpy(buf + 4, str, sizeof(buf) - 5);
2029
	} else {
Y
Yinghai Lu 已提交
2030
		strncpy(buf, str, sizeof(buf) - 1);
2031
	}
Y
Yinghai Lu 已提交
2032
	buf[sizeof(buf) - 1] = 0;
A
Alex Elder 已提交
2033 2034
	options = strchr(str, ',');
	if (options)
2035 2036 2037
		*(options++) = 0;
#ifdef __sparc__
	if (!strcmp(str, "ttya"))
Y
Yinghai Lu 已提交
2038
		strcpy(buf, "ttyS0");
2039
	if (!strcmp(str, "ttyb"))
Y
Yinghai Lu 已提交
2040
		strcpy(buf, "ttyS1");
2041
#endif
Y
Yinghai Lu 已提交
2042
	for (s = buf; *s; s++)
A
Alex Elder 已提交
2043
		if (isdigit(*s) || *s == ',')
2044 2045 2046 2047
			break;
	idx = simple_strtoul(s, NULL, 10);
	*s = 0;

2048
	__add_preferred_console(buf, idx, options, brl_options);
2049
	console_set_on_cmdline = 1;
2050 2051 2052 2053
	return 1;
}
__setup("console=", console_setup);

2054 2055
/**
 * add_preferred_console - add a device to the list of preferred consoles.
2056 2057 2058
 * @name: device name
 * @idx: device index
 * @options: options for this console
2059 2060 2061 2062 2063 2064 2065 2066
 *
 * 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.
 */
2067
int add_preferred_console(char *name, int idx, char *options)
2068
{
2069
	return __add_preferred_console(name, idx, options, NULL);
2070 2071
}

2072
bool console_suspend_enabled = true;
2073 2074 2075 2076
EXPORT_SYMBOL(console_suspend_enabled);

static int __init console_suspend_disable(char *str)
{
2077
	console_suspend_enabled = false;
2078 2079 2080
	return 1;
}
__setup("no_console_suspend", console_suspend_disable);
2081 2082 2083 2084
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");
2085

2086 2087 2088 2089 2090 2091 2092
/**
 * suspend_console - suspend the console subsystem
 *
 * This disables printk() while we go into suspend states
 */
void suspend_console(void)
{
2093 2094
	if (!console_suspend_enabled)
		return;
2095
	printk("Suspending console(s) (use no_console_suspend to debug)\n");
2096
	console_lock();
2097
	console_suspended = 1;
2098
	up_console_sem();
2099 2100 2101 2102
}

void resume_console(void)
{
2103 2104
	if (!console_suspend_enabled)
		return;
2105
	down_console_sem();
2106
	console_suspended = 0;
2107
	console_unlock();
2108 2109
}

2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120
/**
 * 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.
 */
2121
static int console_cpu_notify(struct notifier_block *self,
2122 2123 2124 2125 2126 2127 2128
	unsigned long action, void *hcpu)
{
	switch (action) {
	case CPU_ONLINE:
	case CPU_DEAD:
	case CPU_DOWN_FAILED:
	case CPU_UP_CANCELED:
2129 2130
		console_lock();
		console_unlock();
2131 2132 2133 2134
	}
	return NOTIFY_OK;
}

L
Linus Torvalds 已提交
2135
/**
2136
 * console_lock - lock the console system for exclusive use.
L
Linus Torvalds 已提交
2137
 *
2138
 * Acquires a lock which guarantees that the caller has
L
Linus Torvalds 已提交
2139 2140 2141 2142
 * exclusive access to the console system and the console_drivers list.
 *
 * Can sleep, returns nothing.
 */
2143
void console_lock(void)
L
Linus Torvalds 已提交
2144
{
2145 2146
	might_sleep();

2147
	down_console_sem();
2148 2149
	if (console_suspended)
		return;
L
Linus Torvalds 已提交
2150 2151 2152
	console_locked = 1;
	console_may_schedule = 1;
}
2153
EXPORT_SYMBOL(console_lock);
L
Linus Torvalds 已提交
2154

2155 2156 2157
/**
 * console_trylock - try to lock the console system for exclusive use.
 *
A
Alex Elder 已提交
2158 2159
 * Try to acquire a lock which guarantees that the caller has exclusive
 * access to the console system and the console_drivers list.
2160 2161 2162 2163
 *
 * returns 1 on success, and 0 on failure to acquire the lock.
 */
int console_trylock(void)
L
Linus Torvalds 已提交
2164
{
2165
	if (down_trylock_console_sem())
2166
		return 0;
2167
	if (console_suspended) {
2168
		up_console_sem();
2169
		return 0;
2170
	}
L
Linus Torvalds 已提交
2171 2172
	console_locked = 1;
	console_may_schedule = 0;
2173
	return 1;
L
Linus Torvalds 已提交
2174
}
2175
EXPORT_SYMBOL(console_trylock);
L
Linus Torvalds 已提交
2176 2177 2178 2179 2180 2181

int is_console_locked(void)
{
	return console_locked;
}

2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202
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();
2203
	call_console_drivers(cont.level, NULL, 0, text, len);
2204 2205 2206 2207 2208 2209
	start_critical_timings();
	local_irq_restore(flags);
	return;
out:
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
}
2210

L
Linus Torvalds 已提交
2211
/**
2212
 * console_unlock - unlock the console system
L
Linus Torvalds 已提交
2213
 *
2214
 * Releases the console_lock which the caller holds on the console system
L
Linus Torvalds 已提交
2215 2216
 * and the console driver list.
 *
2217 2218 2219
 * 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 已提交
2220
 *
2221
 * If there is output waiting, we wake /dev/kmsg and syslog() users.
L
Linus Torvalds 已提交
2222
 *
2223
 * console_unlock(); may be called from any context.
L
Linus Torvalds 已提交
2224
 */
2225
void console_unlock(void)
L
Linus Torvalds 已提交
2226
{
2227
	static char ext_text[CONSOLE_EXT_LOG_MAX];
2228
	static char text[LOG_LINE_MAX + PREFIX_MAX];
2229
	static u64 seen_seq;
L
Linus Torvalds 已提交
2230
	unsigned long flags;
2231 2232
	bool wake_klogd = false;
	bool retry;
L
Linus Torvalds 已提交
2233

2234
	if (console_suspended) {
2235
		up_console_sem();
2236 2237
		return;
	}
2238 2239 2240

	console_may_schedule = 0;

2241
	/* flush buffered message fragment immediately to console */
2242
	console_cont_flush(text, sizeof(text));
2243
again:
2244
	for (;;) {
2245
		struct printk_log *msg;
2246
		size_t ext_len = 0;
2247
		size_t len;
2248 2249
		int level;

2250
		raw_spin_lock_irqsave(&logbuf_lock, flags);
2251 2252 2253 2254 2255 2256
		if (seen_seq != log_next_seq) {
			wake_klogd = true;
			seen_seq = log_next_seq;
		}

		if (console_seq < log_first_seq) {
2257 2258 2259
			len = sprintf(text, "** %u printk messages dropped ** ",
				      (unsigned)(log_first_seq - console_seq));

2260 2261 2262
			/* messages are gone, move to first one */
			console_seq = log_first_seq;
			console_idx = log_first_idx;
2263
			console_prev = 0;
2264 2265
		} else {
			len = 0;
2266
		}
2267
skip:
2268 2269 2270 2271
		if (console_seq == log_next_seq)
			break;

		msg = log_from_idx(console_idx);
2272 2273 2274 2275 2276 2277 2278
		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++;
2279 2280 2281 2282 2283 2284
			/*
			 * 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;
2285
			console_prev = msg->flags;
2286 2287
			goto skip;
		}
2288

2289
		level = msg->level;
2290 2291
		len += msg_print_text(msg, console_prev, false,
				      text + len, sizeof(text) - len);
2292 2293 2294 2295 2296 2297 2298 2299 2300
		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);
		}
2301 2302
		console_idx = log_next(console_idx);
		console_seq++;
2303
		console_prev = msg->flags;
2304
		raw_spin_unlock(&logbuf_lock);
2305

2306
		stop_critical_timings();	/* don't trace print latency */
2307
		call_console_drivers(level, ext_text, ext_len, text, len);
2308
		start_critical_timings();
L
Linus Torvalds 已提交
2309 2310 2311
		local_irq_restore(flags);
	}
	console_locked = 0;
2312 2313 2314 2315 2316

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

2317
	raw_spin_unlock(&logbuf_lock);
2318

2319
	up_console_sem();
2320 2321 2322 2323 2324 2325 2326

	/*
	 * 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.
	 */
2327
	raw_spin_lock(&logbuf_lock);
2328
	retry = console_seq != log_next_seq;
P
Peter Zijlstra 已提交
2329 2330
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);

2331 2332 2333
	if (retry && console_trylock())
		goto again;

2334 2335
	if (wake_klogd)
		wake_up_klogd();
L
Linus Torvalds 已提交
2336
}
2337
EXPORT_SYMBOL(console_unlock);
L
Linus Torvalds 已提交
2338

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

	console_locked = 1;
	console_may_schedule = 0;
2371
	for_each_console(c)
L
Linus Torvalds 已提交
2372 2373
		if ((c->flags & CON_ENABLED) && c->unblank)
			c->unblank();
2374
	console_unlock();
L
Linus Torvalds 已提交
2375 2376 2377 2378 2379 2380 2381 2382 2383 2384
}

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

2385
	console_lock();
2386
	for_each_console(c) {
L
Linus Torvalds 已提交
2387 2388 2389 2390 2391 2392
		if (!c->device)
			continue;
		driver = c->device(c, index);
		if (driver)
			break;
	}
2393
	console_unlock();
L
Linus Torvalds 已提交
2394 2395 2396 2397 2398 2399 2400 2401 2402 2403
	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)
{
2404
	console_lock();
L
Linus Torvalds 已提交
2405
	console->flags &= ~CON_ENABLED;
2406
	console_unlock();
L
Linus Torvalds 已提交
2407 2408 2409 2410 2411
}
EXPORT_SYMBOL(console_stop);

void console_start(struct console *console)
{
2412
	console_lock();
L
Linus Torvalds 已提交
2413
	console->flags |= CON_ENABLED;
2414
	console_unlock();
L
Linus Torvalds 已提交
2415 2416 2417
}
EXPORT_SYMBOL(console_start);

2418 2419 2420 2421 2422
static int __read_mostly keep_bootcon;

static int __init keep_bootcon_setup(char *str)
{
	keep_bootcon = 1;
2423
	pr_info("debug: skip boot console de-registration.\n");
2424 2425 2426 2427 2428 2429

	return 0;
}

early_param("keep_bootcon", keep_bootcon_setup);

L
Linus Torvalds 已提交
2430 2431 2432 2433 2434
/*
 * 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.
2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447
 *
 * 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 已提交
2448
 */
2449
void register_console(struct console *newcon)
L
Linus Torvalds 已提交
2450
{
J
Jesper Juhl 已提交
2451
	int i;
L
Linus Torvalds 已提交
2452
	unsigned long flags;
2453
	struct console *bcon = NULL;
2454
	struct console_cmdline *c;
L
Linus Torvalds 已提交
2455

2456 2457 2458 2459 2460 2461 2462
	if (console_drivers)
		for_each_console(bcon)
			if (WARN(bcon == newcon,
					"console '%s%d' already registered\n",
					bcon->name, bcon->index))
				return;

2463 2464 2465 2466 2467 2468 2469 2470
	/*
	 * 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)) {
2471
				pr_info("Too late to register bootconsole %s%d\n",
2472 2473 2474 2475
					newcon->name, newcon->index);
				return;
			}
		}
2476 2477
	}

2478 2479 2480 2481
	if (console_drivers && console_drivers->flags & CON_BOOT)
		bcon = console_drivers;

	if (preferred_console < 0 || bcon || !console_drivers)
L
Linus Torvalds 已提交
2482 2483 2484 2485 2486 2487 2488 2489
		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) {
2490 2491 2492 2493 2494 2495 2496
		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;
2497 2498
				preferred_console = 0;
			}
L
Linus Torvalds 已提交
2499 2500 2501 2502 2503 2504 2505
		}
	}

	/*
	 *	See if this console matches one we selected on
	 *	the command line.
	 */
2506 2507 2508
	for (i = 0, c = console_cmdline;
	     i < MAX_CMDLINECONSOLES && c->name[0];
	     i++, c++) {
2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519
		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;
2520

2521 2522 2523 2524 2525 2526 2527
			if (_braille_register_console(newcon, c))
				return;

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

2529
		newcon->flags |= CON_ENABLED;
2530
		if (i == selected_console) {
2531
			newcon->flags |= CON_CONSDEV;
2532 2533
			preferred_console = selected_console;
		}
L
Linus Torvalds 已提交
2534 2535 2536
		break;
	}

2537
	if (!(newcon->flags & CON_ENABLED))
L
Linus Torvalds 已提交
2538 2539
		return;

2540 2541 2542 2543 2544 2545 2546
	/*
	 * 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))
2547
		newcon->flags &= ~CON_PRINTBUFFER;
L
Linus Torvalds 已提交
2548 2549 2550 2551 2552

	/*
	 *	Put this console in the list - keep the
	 *	preferred driver at the head of the list.
	 */
2553
	console_lock();
2554 2555 2556 2557 2558
	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 已提交
2559
	} else {
2560 2561
		newcon->next = console_drivers->next;
		console_drivers->next = newcon;
L
Linus Torvalds 已提交
2562
	}
2563 2564 2565 2566 2567

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

2568
	if (newcon->flags & CON_PRINTBUFFER) {
L
Linus Torvalds 已提交
2569
		/*
2570
		 * console_unlock(); will print out the buffered messages
L
Linus Torvalds 已提交
2571 2572
		 * for us.
		 */
2573
		raw_spin_lock_irqsave(&logbuf_lock, flags);
2574 2575
		console_seq = syslog_seq;
		console_idx = syslog_idx;
2576
		console_prev = syslog_prev;
2577
		raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2578 2579 2580 2581 2582 2583
		/*
		 * 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 已提交
2584
	}
2585
	console_unlock();
2586
	console_sysfs_notify();
2587 2588 2589 2590 2591 2592 2593 2594

	/*
	 * 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)
	 */
2595
	pr_info("%sconsole [%s%d] enabled\n",
2596 2597
		(newcon->flags & CON_BOOT) ? "boot" : "" ,
		newcon->name, newcon->index);
2598 2599 2600
	if (bcon &&
	    ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
	    !keep_bootcon) {
2601 2602
		/* We need to iterate through all boot consoles, to make
		 * sure we print everything out, before we unregister them.
2603 2604 2605 2606 2607
		 */
		for_each_console(bcon)
			if (bcon->flags & CON_BOOT)
				unregister_console(bcon);
	}
L
Linus Torvalds 已提交
2608 2609 2610
}
EXPORT_SYMBOL(register_console);

J
Jesper Juhl 已提交
2611
int unregister_console(struct console *console)
L
Linus Torvalds 已提交
2612
{
J
Jesper Juhl 已提交
2613
        struct console *a, *b;
2614
	int res;
L
Linus Torvalds 已提交
2615

2616
	pr_info("%sconsole [%s%d] disabled\n",
2617 2618 2619
		(console->flags & CON_BOOT) ? "boot" : "" ,
		console->name, console->index);

2620 2621 2622
	res = _braille_unregister_console(console);
	if (res)
		return res;
2623

2624
	res = 1;
2625
	console_lock();
L
Linus Torvalds 已提交
2626 2627 2628
	if (console_drivers == console) {
		console_drivers=console->next;
		res = 0;
2629
	} else if (console_drivers) {
L
Linus Torvalds 已提交
2630 2631 2632 2633 2634 2635
		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 已提交
2636
			}
L
Linus Torvalds 已提交
2637 2638
		}
	}
J
Jesper Juhl 已提交
2639

2640 2641 2642
	if (!res && (console->flags & CON_EXTENDED))
		nr_ext_console_drivers--;

2643
	/*
2644 2645
	 * 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 已提交
2646
	 */
2647
	if (console_drivers != NULL && console->flags & CON_CONSDEV)
2648
		console_drivers->flags |= CON_CONSDEV;
L
Linus Torvalds 已提交
2649

2650
	console->flags &= ~CON_ENABLED;
2651
	console_unlock();
2652
	console_sysfs_notify();
L
Linus Torvalds 已提交
2653 2654 2655
	return res;
}
EXPORT_SYMBOL(unregister_console);
M
Matt Mackall 已提交
2656

2657
static int __init printk_late_init(void)
2658
{
2659 2660 2661
	struct console *con;

	for_each_console(con) {
2662
		if (!keep_bootcon && con->flags & CON_BOOT) {
2663
			unregister_console(con);
2664
		}
2665
	}
2666
	hotcpu_notifier(console_cpu_notify, 0);
2667 2668
	return 0;
}
2669
late_initcall(printk_late_init);
2670

2671
#if defined CONFIG_PRINTK
2672 2673 2674 2675
/*
 * Delayed printk version, for scheduler-internal messages:
 */
#define PRINTK_PENDING_WAKEUP	0x01
2676
#define PRINTK_PENDING_OUTPUT	0x02
2677 2678 2679 2680 2681 2682 2683

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

2684 2685 2686 2687
	if (pending & PRINTK_PENDING_OUTPUT) {
		/* If trylock fails, someone else is doing the printing */
		if (console_trylock())
			console_unlock();
2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703
	}

	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);
2704
		irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2705 2706 2707
	}
	preempt_enable();
}
D
Dave Young 已提交
2708

2709
int printk_deferred(const char *fmt, ...)
2710 2711 2712 2713
{
	va_list args;
	int r;

2714
	preempt_disable();
2715
	va_start(args, fmt);
2716
	r = vprintk_emit(0, LOGLEVEL_SCHED, NULL, 0, fmt, args);
2717 2718
	va_end(args);

2719
	__this_cpu_or(printk_pending, PRINTK_PENDING_OUTPUT);
2720
	irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2721
	preempt_enable();
2722 2723 2724 2725

	return r;
}

L
Linus Torvalds 已提交
2726 2727 2728
/*
 * printk rate limiting, lifted from the networking subsystem.
 *
2729 2730
 * This enforces a rate limit: not more than 10 kernel messages
 * every 5s to make a denial-of-service attack impossible.
L
Linus Torvalds 已提交
2731
 */
2732 2733
DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);

2734
int __printk_ratelimit(const char *func)
L
Linus Torvalds 已提交
2735
{
2736
	return ___ratelimit(&printk_ratelimit_state, func);
L
Linus Torvalds 已提交
2737
}
2738
EXPORT_SYMBOL(__printk_ratelimit);
2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751

/**
 * 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 已提交
2752 2753 2754 2755 2756 2757 2758
	unsigned long elapsed = jiffies - *caller_jiffies;

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

	*caller_jiffies = jiffies;
	return true;
2759 2760
}
EXPORT_SYMBOL(printk_timed_ratelimit);
2761 2762 2763 2764 2765 2766

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

/**
 * kmsg_dump_register - register a kernel log dumper.
R
Randy Dunlap 已提交
2767
 * @dumper: pointer to the kmsg_dumper structure
2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785
 *
 * 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;
2786
		list_add_tail_rcu(&dumper->list, &dump_list);
2787 2788 2789 2790 2791 2792 2793 2794 2795 2796
		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 已提交
2797
 * @dumper: pointer to the kmsg_dumper structure
2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809
 *
 * 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;
2810
		list_del_rcu(&dumper->list);
2811 2812 2813
		err = 0;
	}
	spin_unlock_irqrestore(&dump_list_lock, flags);
2814
	synchronize_rcu();
2815 2816 2817 2818 2819

	return err;
}
EXPORT_SYMBOL_GPL(kmsg_dump_unregister);

2820 2821 2822
static bool always_kmsg_dump;
module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);

2823 2824 2825 2826
/**
 * kmsg_dump - dump kernel log to kernel message dumpers.
 * @reason: the reason (oops, panic etc) for dumping
 *
2827 2828 2829
 * 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().
2830 2831 2832 2833 2834 2835
 */
void kmsg_dump(enum kmsg_dump_reason reason)
{
	struct kmsg_dumper *dumper;
	unsigned long flags;

2836 2837 2838
	if ((reason > KMSG_DUMP_OOPS) && !always_kmsg_dump)
		return;

2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863
	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();
}

/**
2864
 * kmsg_dump_get_line_nolock - retrieve one kmsg log line (unlocked version)
2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878
 * @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.
2879 2880
 *
 * The function is similar to kmsg_dump_get_line(), but grabs no locks.
2881
 */
2882 2883
bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper, bool syslog,
			       char *line, size_t size, size_t *len)
2884
{
2885
	struct printk_log *msg;
2886 2887 2888 2889 2890
	size_t l = 0;
	bool ret = false;

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

2892 2893 2894 2895 2896
	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;
	}
2897

2898
	/* last entry */
2899
	if (dumper->cur_seq >= log_next_seq)
2900
		goto out;
2901

2902
	msg = log_from_idx(dumper->cur_idx);
2903
	l = msg_print_text(msg, 0, syslog, line, size);
2904 2905 2906 2907 2908 2909 2910 2911 2912

	dumper->cur_idx = log_next(dumper->cur_idx);
	dumper->cur_seq++;
	ret = true;
out:
	if (len)
		*len = l;
	return ret;
}
2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942

/**
 * 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;
}
2943 2944 2945 2946 2947 2948
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 已提交
2949
 * @buf: buffer to copy the line to
2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971
 * @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;
2972
	enum log_flags prev;
2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994
	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;
2995
	prev = 0;
2996
	while (seq < dumper->next_seq) {
2997
		struct printk_log *msg = log_from_idx(idx);
2998

2999
		l += msg_print_text(msg, prev, true, NULL, 0);
3000 3001
		idx = log_next(idx);
		seq++;
3002
		prev = msg->flags;
3003 3004 3005 3006 3007
	}

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

3012
		l -= msg_print_text(msg, prev, true, NULL, 0);
3013 3014
		idx = log_next(idx);
		seq++;
3015
		prev = msg->flags;
3016
	}
3017 3018 3019 3020 3021 3022 3023

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

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

3026
		l += msg_print_text(msg, prev, syslog, buf + l, size - l);
3027 3028
		idx = log_next(idx);
		seq++;
3029
		prev = msg->flags;
3030 3031 3032 3033 3034
	}

	dumper->next_seq = next_seq;
	dumper->next_idx = next_idx;
	ret = true;
3035
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
3036 3037 3038 3039 3040 3041
out:
	if (len)
		*len = l;
	return ret;
}
EXPORT_SYMBOL_GPL(kmsg_dump_get_buffer);
3042

3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060
/**
 * 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;
}

3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073
/**
 * 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);
3074
	kmsg_dump_rewind_nolock(dumper);
3075
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
3076
}
3077
EXPORT_SYMBOL_GPL(kmsg_dump_rewind);
3078

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

3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114
/**
 * 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);
3115 3116 3117 3118

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

	print_worker_info(log_lvl, current);
3121 3122
}

3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138
/**
 * 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));
}

3139
#endif