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

49
#include <linux/uaccess.h>
50
#include <asm/sections.h>
L
Linus Torvalds 已提交
51

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

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

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

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

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

88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
enum devkmsg_log_bits {
	__DEVKMSG_LOG_BIT_ON = 0,
	__DEVKMSG_LOG_BIT_OFF,
	__DEVKMSG_LOG_BIT_LOCK,
};

enum devkmsg_log_masks {
	DEVKMSG_LOG_MASK_ON             = BIT(__DEVKMSG_LOG_BIT_ON),
	DEVKMSG_LOG_MASK_OFF            = BIT(__DEVKMSG_LOG_BIT_OFF),
	DEVKMSG_LOG_MASK_LOCK           = BIT(__DEVKMSG_LOG_BIT_LOCK),
};

/* Keep both the 'on' and 'off' bits clear, i.e. ratelimit by default: */
#define DEVKMSG_LOG_MASK_DEFAULT	0

static unsigned int __read_mostly devkmsg_log = DEVKMSG_LOG_MASK_DEFAULT;

static int __control_devkmsg(char *str)
{
	if (!str)
		return -EINVAL;

	if (!strncmp(str, "on", 2)) {
		devkmsg_log = DEVKMSG_LOG_MASK_ON;
		return 2;
	} else if (!strncmp(str, "off", 3)) {
		devkmsg_log = DEVKMSG_LOG_MASK_OFF;
		return 3;
	} else if (!strncmp(str, "ratelimit", 9)) {
		devkmsg_log = DEVKMSG_LOG_MASK_DEFAULT;
		return 9;
	}
	return -EINVAL;
}

static int __init control_devkmsg(char *str)
{
	if (__control_devkmsg(str) < 0)
		return 1;

	/*
	 * Set sysctl string accordingly:
	 */
	if (devkmsg_log == DEVKMSG_LOG_MASK_ON) {
		memset(devkmsg_log_str, 0, DEVKMSG_STR_MAX_SIZE);
		strncpy(devkmsg_log_str, "on", 2);
	} else if (devkmsg_log == DEVKMSG_LOG_MASK_OFF) {
		memset(devkmsg_log_str, 0, DEVKMSG_STR_MAX_SIZE);
		strncpy(devkmsg_log_str, "off", 3);
	}
	/* else "ratelimit" which is set by default. */

	/*
	 * Sysctl cannot change it anymore. The kernel command line setting of
	 * this parameter is to force the setting to be permanent throughout the
	 * runtime of the system. This is a precation measure against userspace
	 * trying to be a smarta** and attempting to change it up on us.
	 */
	devkmsg_log |= DEVKMSG_LOG_MASK_LOCK;

	return 0;
}
__setup("printk.devkmsg=", control_devkmsg);

char devkmsg_log_str[DEVKMSG_STR_MAX_SIZE] = "ratelimit";

int devkmsg_sysctl_set_loglvl(struct ctl_table *table, int write,
			      void __user *buffer, size_t *lenp, loff_t *ppos)
{
	char old_str[DEVKMSG_STR_MAX_SIZE];
	unsigned int old;
	int err;

	if (write) {
		if (devkmsg_log & DEVKMSG_LOG_MASK_LOCK)
			return -EINVAL;

		old = devkmsg_log;
		strncpy(old_str, devkmsg_log_str, DEVKMSG_STR_MAX_SIZE);
	}

	err = proc_dostring(table, write, buffer, lenp, ppos);
	if (err)
		return err;

	if (write) {
		err = __control_devkmsg(devkmsg_log_str);

		/*
		 * Do not accept an unknown string OR a known string with
		 * trailing crap...
		 */
		if (err < 0 || (err + 1 != *lenp)) {

			/* ... and restore old setting. */
			devkmsg_log = old;
			strncpy(devkmsg_log_str, old_str, DEVKMSG_STR_MAX_SIZE);

			return -EINVAL;
		}
	}

	return 0;
}

193 194 195 196 197 198 199 200 201 202 203 204
/*
 * 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;

205 206 207 208 209 210 211 212 213 214 215
/*
 * 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)
{
216 217 218 219 220 221 222 223 224 225 226 227 228
	int lock_failed;
	unsigned long flags;

	/*
	 * Here and in __up_console_sem() we need to be in safe mode,
	 * because spindump/WARN/etc from under console ->lock will
	 * deadlock in printk()->down_trylock_console_sem() otherwise.
	 */
	printk_safe_enter_irqsave(flags);
	lock_failed = down_trylock(&console_sem);
	printk_safe_exit_irqrestore(flags);

	if (lock_failed)
229 230 231 232 233 234
		return 1;
	mutex_acquire(&console_lock_dep_map, 0, 1, ip);
	return 0;
}
#define down_trylock_console_sem() __down_trylock_console_sem(_RET_IP_)

235 236 237 238 239 240 241 242 243 244 245
static void __up_console_sem(unsigned long ip)
{
	unsigned long flags;

	mutex_release(&console_lock_dep_map, 1, ip);

	printk_safe_enter_irqsave(flags);
	up(&console_sem);
	printk_safe_exit_irqrestore(flags);
}
#define up_console_sem() __up_console_sem(_RET_IP_)
246

L
Linus Torvalds 已提交
247 248 249 250
/*
 * 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 已提交
251 252 253
 * 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 已提交
254
 */
255
static int console_locked, console_suspended;
L
Linus Torvalds 已提交
256

257 258 259 260 261
/*
 * If exclusive_console is non-NULL then only this console is to be printed to.
 */
static struct console *exclusive_console;

L
Linus Torvalds 已提交
262 263 264 265 266 267 268
/*
 *	Array of consoles built from command line options (console=)
 */

#define MAX_CMDLINECONSOLES 8

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

L
Linus Torvalds 已提交
270 271
static int selected_console = -1;
static int preferred_console = -1;
272 273
int console_set_on_cmdline;
EXPORT_SYMBOL(console_set_on_cmdline);
L
Linus Torvalds 已提交
274 275 276 277

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

278 279 280 281 282 283
/*
 * 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 已提交
284 285
 * sequence numbers of these entries are maintained when messages are
 * stored.
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
 *
 * 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.
 *
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
 * 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
 *
330
 * The 'struct printk_log' buffer header must never be directly exported to
331 332 333 334
 * 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:
335 336 337 338
 *   "<level>,<sequnum>,<timestamp>,<contflag>[,additional_values, ... ];<message text>\n"
 *
 * Users of the export format should ignore possible additional values
 * separated by ',', and find the message after the ';' character.
339 340 341 342
 *
 * 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.
343 344
 */

345
enum log_flags {
346 347 348 349
	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 */
350 351
};

352
struct printk_log {
353 354 355 356
	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 */
357 358 359
	u8 facility;		/* syslog facility */
	u8 flags:5;		/* internal record flags */
	u8 level:3;		/* syslog level */
360 361 362 363 364
}
#ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
__packed __aligned(4)
#endif
;
365 366

/*
367 368 369
 * 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.
370
 */
371
DEFINE_RAW_SPINLOCK(logbuf_lock);
M
Matt Mackall 已提交
372

373
#ifdef CONFIG_PRINTK
374
DECLARE_WAIT_QUEUE_HEAD(log_wait);
375 376 377
/* the next printk record to read by syslog(READ) or /proc/kmsg */
static u64 syslog_seq;
static u32 syslog_idx;
378
static size_t syslog_partial;
379 380 381 382 383 384 385 386 387

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

388 389 390 391
/* the next printk record to write to the console */
static u64 console_seq;
static u32 console_idx;

392 393 394 395
/* the next printk record to read after the last 'clear' command */
static u64 clear_seq;
static u32 clear_idx;

396
#define PREFIX_MAX		32
A
Alex Elder 已提交
397
#define LOG_LINE_MAX		(1024 - PREFIX_MAX)
398

399 400 401
#define LOG_LEVEL(v)		((v) & 0x07)
#define LOG_FACILITY(v)		((v) >> 3 & 0xff)

402
/* record buffer */
403
#define LOG_ALIGN __alignof__(struct printk_log)
404
#define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
405
static char __log_buf[__LOG_BUF_LEN] __aligned(LOG_ALIGN);
406 407 408
static char *log_buf = __log_buf;
static u32 log_buf_len = __LOG_BUF_LEN;

409 410 411 412 413 414 415 416 417 418 419 420
/* 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;
}

421
/* human readable text of the record */
422
static char *log_text(const struct printk_log *msg)
423
{
424
	return (char *)msg + sizeof(struct printk_log);
425 426 427
}

/* optional key/value pair dictionary attached to the record */
428
static char *log_dict(const struct printk_log *msg)
429
{
430
	return (char *)msg + sizeof(struct printk_log) + msg->text_len;
431 432 433
}

/* get record by index; idx must point to valid msg */
434
static struct printk_log *log_from_idx(u32 idx)
435
{
436
	struct printk_log *msg = (struct printk_log *)(log_buf + idx);
437 438 439 440 441 442

	/*
	 * 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)
443
		return (struct printk_log *)log_buf;
444 445 446 447 448 449
	return msg;
}

/* get next record; idx must point to valid msg */
static u32 log_next(u32 idx)
{
450
	struct printk_log *msg = (struct printk_log *)(log_buf + idx);
451 452 453 454 455 456 457 458

	/* 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) {
459
		msg = (struct printk_log *)log_buf;
460 461 462 463 464
		return msg->len;
	}
	return idx + msg->len;
}

P
Petr Mladek 已提交
465 466 467 468 469 470 471 472 473 474
/*
 * 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)
475 476 477
{
	u32 free;

P
Petr Mladek 已提交
478
	if (log_next_idx > log_first_idx || empty)
479 480 481 482 483 484 485 486 487 488 489
		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 已提交
490
static int log_make_free_space(u32 msg_size)
491
{
492 493
	while (log_first_seq < log_next_seq &&
	       !logbuf_has_space(msg_size, false)) {
A
Alex Elder 已提交
494
		/* drop old messages until we have enough contiguous space */
495 496 497
		log_first_idx = log_next(log_first_idx);
		log_first_seq++;
	}
P
Petr Mladek 已提交
498

499 500 501 502 503
	if (clear_seq < log_first_seq) {
		clear_seq = log_first_seq;
		clear_idx = log_first_idx;
	}

P
Petr Mladek 已提交
504
	/* sequence numbers are equal, so the log buffer is empty */
505
	if (logbuf_has_space(msg_size, log_first_seq == log_next_seq))
P
Petr Mladek 已提交
506 507 508
		return 0;

	return -ENOMEM;
509 510
}

511 512 513 514 515 516 517 518 519 520 521 522
/* 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 已提交
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
/*
 * 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);
}

549
/* insert record into the buffer, discard old ones, update heads */
550 551 552 553
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)
554
{
555
	struct printk_log *msg;
556
	u32 size, pad_len;
P
Petr Mladek 已提交
557
	u16 trunc_msg_len = 0;
558 559

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

P
Petr Mladek 已提交
562 563 564 565 566 567
	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))
568
			return 0;
P
Petr Mladek 已提交
569
	}
570

571
	if (log_next_idx + size + sizeof(struct printk_log) > log_buf_len) {
572 573 574 575 576
		/*
		 * 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.
		 */
577
		memset(log_buf + log_next_idx, 0, sizeof(struct printk_log));
578 579 580 581
		log_next_idx = 0;
	}

	/* fill message */
582
	msg = (struct printk_log *)(log_buf + log_next_idx);
583 584
	memcpy(log_text(msg), text, text_len);
	msg->text_len = text_len;
P
Petr Mladek 已提交
585 586 587 588
	if (trunc_msg_len) {
		memcpy(log_text(msg) + text_len, trunc_msg, trunc_msg_len);
		msg->text_len += trunc_msg_len;
	}
589 590
	memcpy(log_dict(msg), dict, dict_len);
	msg->dict_len = dict_len;
591 592 593 594 595 596 597
	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();
598
	memset(log_dict(msg) + dict_len, 0, pad_len);
599
	msg->len = size;
600 601 602 603

	/* insert message */
	log_next_idx += msg->len;
	log_next_seq++;
604 605

	return msg->text_len;
606
}
M
Matt Mackall 已提交
607

A
Alex Elder 已提交
608
int dmesg_restrict = IS_ENABLED(CONFIG_SECURITY_DMESG_RESTRICT);
609 610 611 612 613 614 615 616 617 618 619 620 621

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

622
int check_syslog_permissions(int type, int source)
623 624 625 626 627
{
	/*
	 * If this is from /proc/kmsg and we've already opened it, then we've
	 * already done the capabilities checks at open time.
	 */
628
	if (source == SYSLOG_FROM_PROC && type != SYSLOG_ACTION_OPEN)
629
		goto ok;
630 631 632

	if (syslog_action_restricted(type)) {
		if (capable(CAP_SYSLOG))
633
			goto ok;
634 635 636 637 638 639 640 641 642
		/*
		 * 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));
643
			goto ok;
644 645 646
		}
		return -EPERM;
	}
647
ok:
648 649
	return security_syslog(type);
}
G
Geliang Tang 已提交
650
EXPORT_SYMBOL_GPL(check_syslog_permissions);
651

652 653 654 655 656
static void append_char(char **pp, char *e, char c)
{
	if (*pp < e)
		*(*pp)++ = c;
}
657

658
static ssize_t msg_print_ext_header(char *buf, size_t size,
659
				    struct printk_log *msg, u64 seq)
660 661 662 663 664 665
{
	u64 ts_usec = msg->ts_nsec;

	do_div(ts_usec, 1000);

	return scnprintf(buf, size, "%u,%llu,%llu,%c;",
666 667
		       (msg->facility << 3) | msg->level, seq, ts_usec,
		       msg->flags & LOG_CONT ? 'c' : '-');
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
}

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

718 719 720 721
/* /dev/kmsg - userspace message inject/listen interface */
struct devkmsg_user {
	u64 seq;
	u32 idx;
722
	struct ratelimit_state rs;
723
	struct mutex lock;
724
	char buf[CONSOLE_EXT_LOG_MAX];
725 726
};

A
Al Viro 已提交
727
static ssize_t devkmsg_write(struct kiocb *iocb, struct iov_iter *from)
728 729 730 731
{
	char *buf, *line;
	int level = default_message_loglevel;
	int facility = 1;	/* LOG_USER */
732 733
	struct file *file = iocb->ki_filp;
	struct devkmsg_user *user = file->private_data;
C
Christoph Hellwig 已提交
734
	size_t len = iov_iter_count(from);
735 736
	ssize_t ret = len;

737
	if (!user || len > LOG_LINE_MAX)
738
		return -EINVAL;
739 740 741 742 743 744 745 746 747 748 749

	/* Ignore when user logging is disabled. */
	if (devkmsg_log & DEVKMSG_LOG_MASK_OFF)
		return len;

	/* Ratelimit when not explicitly enabled. */
	if (!(devkmsg_log & DEVKMSG_LOG_MASK_ON)) {
		if (!___ratelimit(&user->rs, current->comm))
			return ret;
	}

750 751 752 753
	buf = kmalloc(len+1, GFP_KERNEL);
	if (buf == NULL)
		return -ENOMEM;

A
Al Viro 已提交
754
	buf[len] = '\0';
755
	if (!copy_from_iter_full(buf, len, from)) {
A
Al Viro 已提交
756 757
		kfree(buf);
		return -EFAULT;
758 759 760 761 762 763 764 765 766 767 768 769 770 771
	}

	/*
	 * 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;
772
		unsigned int u;
773

774
		u = simple_strtoul(line + 1, &endp, 10);
775
		if (endp && endp[0] == '>') {
776 777 778
			level = LOG_LEVEL(u);
			if (LOG_FACILITY(u) != 0)
				facility = LOG_FACILITY(u);
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
			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;
794
	struct printk_log *msg;
795 796 797 798 799 800
	size_t len;
	ssize_t ret;

	if (!user)
		return -EBADF;

801 802 803
	ret = mutex_lock_interruptible(&user->lock);
	if (ret)
		return ret;
804
	raw_spin_lock_irq(&logbuf_lock);
805 806 807
	while (user->seq == log_next_seq) {
		if (file->f_flags & O_NONBLOCK) {
			ret = -EAGAIN;
808
			raw_spin_unlock_irq(&logbuf_lock);
809 810 811
			goto out;
		}

812
		raw_spin_unlock_irq(&logbuf_lock);
813 814 815 816
		ret = wait_event_interruptible(log_wait,
					       user->seq != log_next_seq);
		if (ret)
			goto out;
817
		raw_spin_lock_irq(&logbuf_lock);
818 819 820 821 822 823 824
	}

	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;
825
		raw_spin_unlock_irq(&logbuf_lock);
826 827 828 829
		goto out;
	}

	msg = log_from_idx(user->idx);
830
	len = msg_print_ext_header(user->buf, sizeof(user->buf),
831
				   msg, user->seq);
832 833 834
	len += msg_print_ext_body(user->buf + len, sizeof(user->buf) - len,
				  log_dict(msg), msg->dict_len,
				  log_text(msg), msg->text_len);
835

836 837
	user->idx = log_next(user->idx);
	user->seq++;
838
	raw_spin_unlock_irq(&logbuf_lock);
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864

	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;

865
	raw_spin_lock_irq(&logbuf_lock);
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
	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;
	}
889
	raw_spin_unlock_irq(&logbuf_lock);
890 891 892 893 894 895 896 897 898 899 900 901 902
	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);

903
	raw_spin_lock_irq(&logbuf_lock);
904 905 906 907
	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;
908 909
		else
			ret = POLLIN|POLLRDNORM;
910
	}
911
	raw_spin_unlock_irq(&logbuf_lock);
912 913 914 915 916 917 918 919 920

	return ret;
}

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

921 922
	if (devkmsg_log & DEVKMSG_LOG_MASK_OFF)
		return -EPERM;
923

924 925 926 927 928 929 930
	/* write-only does not need any file context */
	if ((file->f_flags & O_ACCMODE) != O_WRONLY) {
		err = check_syslog_permissions(SYSLOG_ACTION_READ_ALL,
					       SYSLOG_FROM_READER);
		if (err)
			return err;
	}
931 932 933 934 935

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

936 937 938
	ratelimit_default_init(&user->rs);
	ratelimit_set_flags(&user->rs, RATELIMIT_MSG_ON_RELEASE);

939 940
	mutex_init(&user->lock);

941
	raw_spin_lock_irq(&logbuf_lock);
942 943
	user->idx = log_first_idx;
	user->seq = log_first_seq;
944
	raw_spin_unlock_irq(&logbuf_lock);
945 946 947 948 949 950 951 952 953 954 955 956

	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;

957 958
	ratelimit_state_exit(&user->rs);

959 960 961 962 963 964 965 966
	mutex_destroy(&user->lock);
	kfree(user);
	return 0;
}

const struct file_operations kmsg_fops = {
	.open = devkmsg_open,
	.read = devkmsg_read,
A
Al Viro 已提交
967
	.write_iter = devkmsg_write,
968 969 970 971 972
	.llseek = devkmsg_llseek,
	.poll = devkmsg_poll,
	.release = devkmsg_release,
};

973
#ifdef CONFIG_KEXEC_CORE
974
/*
975
 * This appends the listed symbols to /proc/vmcore
976
 *
977
 * /proc/vmcore is used by various utilities, like crash and makedumpfile to
978 979 980 981 982 983 984 985
 * 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);
986
	VMCOREINFO_SYMBOL(log_first_idx);
987
	VMCOREINFO_SYMBOL(clear_idx);
988
	VMCOREINFO_SYMBOL(log_next_idx);
989
	/*
990
	 * Export struct printk_log size and field offsets. User space tools can
991 992
	 * parse it and detect any changes to structure down the line.
	 */
993 994 995 996 997
	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);
998 999 1000
}
#endif

1001 1002 1003
/* requested log_buf_len from kernel cmdline */
static unsigned long __initdata new_log_buf_len;

1004 1005
/* we practice scaling the ring buffer by powers of 2 */
static void __init log_buf_len_update(unsigned size)
L
Linus Torvalds 已提交
1006 1007 1008
{
	if (size)
		size = roundup_pow_of_two(size);
1009 1010
	if (size > log_buf_len)
		new_log_buf_len = size;
1011 1012 1013 1014 1015 1016 1017 1018
}

/* 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);
1019 1020

	return 0;
L
Linus Torvalds 已提交
1021
}
1022 1023
early_param("log_buf_len", log_buf_len_setup);

1024 1025 1026
#ifdef CONFIG_SMP
#define __LOG_CPU_MAX_BUF_LEN (1 << CONFIG_LOG_CPU_MAX_BUF_SHIFT)

1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
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);
}
1053 1054 1055
#else /* !CONFIG_SMP */
static inline void log_buf_add_cpu(void) {}
#endif /* CONFIG_SMP */
1056

1057 1058 1059 1060 1061 1062
void __init setup_log_buf(int early)
{
	unsigned long flags;
	char *new_log_buf;
	int free;

1063 1064 1065 1066 1067 1068
	if (log_buf != __log_buf)
		return;

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

1069 1070
	if (!new_log_buf_len)
		return;
L
Linus Torvalds 已提交
1071

1072
	if (early) {
1073
		new_log_buf =
1074
			memblock_virt_alloc(new_log_buf_len, LOG_ALIGN);
1075
	} else {
1076 1077
		new_log_buf = memblock_virt_alloc_nopanic(new_log_buf_len,
							  LOG_ALIGN);
1078 1079 1080 1081 1082 1083 1084 1085
	}

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

1086
	raw_spin_lock_irqsave(&logbuf_lock, flags);
1087 1088 1089
	log_buf_len = new_log_buf_len;
	log_buf = new_log_buf;
	new_log_buf_len = 0;
1090 1091
	free = __LOG_BUF_LEN - log_next_idx;
	memcpy(log_buf, __log_buf, __LOG_BUF_LEN);
1092
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
1093

1094
	pr_info("log_buf_len: %d bytes\n", log_buf_len);
1095 1096 1097
	pr_info("early log buf free: %d(%d%%)\n",
		free, (free * 100) / __LOG_BUF_LEN);
}
L
Linus Torvalds 已提交
1098

1099 1100 1101 1102
static bool __read_mostly ignore_loglevel;

static int __init ignore_loglevel_setup(char *str)
{
1103
	ignore_loglevel = true;
1104
	pr_info("debug: ignoring loglevel setting.\n");
1105 1106 1107 1108 1109 1110

	return 0;
}

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

1114 1115 1116 1117 1118
static bool suppress_message_printing(int level)
{
	return (level >= console_loglevel && !ignore_loglevel);
}

R
Randy Dunlap 已提交
1119 1120
#ifdef CONFIG_BOOT_PRINTK_DELAY

1121
static int boot_delay; /* msecs delay after each printk during bootup */
1122
static unsigned long long loops_per_msec;	/* based on boot_delay */
R
Randy Dunlap 已提交
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134

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;

1135 1136 1137
	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);
1138
	return 0;
R
Randy Dunlap 已提交
1139
}
1140
early_param("boot_delay", boot_delay_setup);
R
Randy Dunlap 已提交
1141

1142
static void boot_delay_msec(int level)
R
Randy Dunlap 已提交
1143 1144 1145 1146
{
	unsigned long long k;
	unsigned long timeout;

1147
	if ((boot_delay == 0 || system_state != SYSTEM_BOOTING)
1148
		|| suppress_message_printing(level)) {
R
Randy Dunlap 已提交
1149
		return;
1150
	}
R
Randy Dunlap 已提交
1151

1152
	k = (unsigned long long)loops_per_msec * boot_delay;
R
Randy Dunlap 已提交
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168

	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
1169
static inline void boot_delay_msec(int level)
R
Randy Dunlap 已提交
1170 1171 1172 1173
{
}
#endif

A
Alex Elder 已提交
1174
static bool printk_time = IS_ENABLED(CONFIG_PRINTK_TIME);
1175 1176
module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);

1177 1178 1179 1180 1181 1182 1183
static size_t print_time(u64 ts, char *buf)
{
	unsigned long rem_nsec;

	if (!printk_time)
		return 0;

1184 1185
	rem_nsec = do_div(ts, 1000000000);

1186
	if (!buf)
1187
		return snprintf(NULL, 0, "[%5lu.000000] ", (unsigned long)ts);
1188 1189 1190 1191 1192

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

1193
static size_t print_prefix(const struct printk_log *msg, bool syslog, char *buf)
1194
{
1195
	size_t len = 0;
1196
	unsigned int prefix = (msg->facility << 3) | msg->level;
1197

1198 1199
	if (syslog) {
		if (buf) {
1200
			len += sprintf(buf, "<%u>", prefix);
1201 1202
		} else {
			len += 3;
1203 1204 1205 1206 1207
			if (prefix > 999)
				len += 3;
			else if (prefix > 99)
				len += 2;
			else if (prefix > 9)
1208 1209 1210
				len++;
		}
	}
1211

1212
	len += print_time(msg->ts_nsec, buf ? buf + len : NULL);
1213
	return len;
1214 1215
}

1216
static size_t msg_print_text(const struct printk_log *msg, bool syslog, char *buf, size_t size)
1217
{
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
	const char *text = log_text(msg);
	size_t text_size = msg->text_len;
	size_t len = 0;

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

1234 1235
		if (buf) {
			if (print_prefix(msg, syslog, NULL) +
1236
			    text_len + 1 >= size - len)
1237
				break;
1238

1239
			len += print_prefix(msg, syslog, buf + len);
1240 1241
			memcpy(buf + len, text, text_len);
			len += text_len;
1242
			buf[len++] = '\n';
1243 1244
		} else {
			/* SYSLOG_ACTION_* buffer size only calculation */
1245
			len += print_prefix(msg, syslog, NULL);
1246
			len += text_len;
1247
			len++;
1248
		}
1249

1250 1251
		text = next;
	} while (text);
1252 1253 1254 1255 1256 1257 1258

	return len;
}

static int syslog_print(char __user *buf, int size)
{
	char *text;
1259
	struct printk_log *msg;
1260
	int len = 0;
1261

1262
	text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1263 1264 1265
	if (!text)
		return -ENOMEM;

1266 1267
	while (size > 0) {
		size_t n;
1268
		size_t skip;
1269 1270 1271 1272 1273 1274

		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;
1275
			syslog_partial = 0;
1276 1277 1278 1279 1280
		}
		if (syslog_seq == log_next_seq) {
			raw_spin_unlock_irq(&logbuf_lock);
			break;
		}
1281 1282

		skip = syslog_partial;
1283
		msg = log_from_idx(syslog_idx);
1284
		n = msg_print_text(msg, true, text, LOG_LINE_MAX + PREFIX_MAX);
1285 1286
		if (n - syslog_partial <= size) {
			/* message fits into buffer, move forward */
1287 1288
			syslog_idx = log_next(syslog_idx);
			syslog_seq++;
1289 1290 1291 1292 1293 1294
			n -= syslog_partial;
			syslog_partial = 0;
		} else if (!len){
			/* partial read(), remember position */
			n = size;
			syslog_partial += n;
1295 1296 1297 1298 1299 1300 1301
		} else
			n = 0;
		raw_spin_unlock_irq(&logbuf_lock);

		if (!n)
			break;

1302
		if (copy_to_user(buf, text + skip, n)) {
1303 1304 1305 1306
			if (!len)
				len = -EFAULT;
			break;
		}
1307 1308 1309 1310

		len += n;
		size -= n;
		buf += n;
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321
	}

	kfree(text);
	return len;
}

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

1322
	text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334
	if (!text)
		return -ENOMEM;

	raw_spin_lock_irq(&logbuf_lock);
	if (buf) {
		u64 next_seq;
		u64 seq;
		u32 idx;

		/*
		 * Find first record that fits, including all following records,
		 * into the user-provided buffer for this dump.
1335
		 */
1336 1337 1338
		seq = clear_seq;
		idx = clear_idx;
		while (seq < log_next_seq) {
1339
			struct printk_log *msg = log_from_idx(idx);
1340

1341
			len += msg_print_text(msg, true, NULL, 0);
1342 1343 1344
			idx = log_next(idx);
			seq++;
		}
1345 1346

		/* move first record forward until length fits into the buffer */
1347 1348 1349
		seq = clear_seq;
		idx = clear_idx;
		while (len > size && seq < log_next_seq) {
1350
			struct printk_log *msg = log_from_idx(idx);
1351

1352
			len -= msg_print_text(msg, true, NULL, 0);
1353 1354 1355 1356
			idx = log_next(idx);
			seq++;
		}

1357
		/* last message fitting into this dump */
1358 1359 1360 1361
		next_seq = log_next_seq;

		len = 0;
		while (len >= 0 && seq < next_seq) {
1362
			struct printk_log *msg = log_from_idx(idx);
1363 1364
			int textlen;

1365
			textlen = msg_print_text(msg, true, text,
1366
						 LOG_LINE_MAX + PREFIX_MAX);
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
			if (textlen < 0) {
				len = textlen;
				break;
			}
			idx = log_next(idx);
			seq++;

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

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

	kfree(text);
	return len;
}

1399
int do_syslog(int type, char __user *buf, int len, int source)
L
Linus Torvalds 已提交
1400
{
1401
	bool clear = false;
1402
	static int saved_console_loglevel = LOGLEVEL_DEFAULT;
1403
	int error;
L
Linus Torvalds 已提交
1404

1405
	error = check_syslog_permissions(type, source);
1406 1407
	if (error)
		goto out;
1408

L
Linus Torvalds 已提交
1409
	switch (type) {
1410
	case SYSLOG_ACTION_CLOSE:	/* Close log */
L
Linus Torvalds 已提交
1411
		break;
1412
	case SYSLOG_ACTION_OPEN:	/* Open log */
L
Linus Torvalds 已提交
1413
		break;
1414
	case SYSLOG_ACTION_READ:	/* Read from log */
L
Linus Torvalds 已提交
1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
		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 已提交
1425
		error = wait_event_interruptible(log_wait,
1426
						 syslog_seq != log_next_seq);
1427
		if (error)
L
Linus Torvalds 已提交
1428
			goto out;
1429
		error = syslog_print(buf, len);
L
Linus Torvalds 已提交
1430
		break;
1431 1432
	/* Read/clear last kernel messages */
	case SYSLOG_ACTION_READ_CLEAR:
1433
		clear = true;
L
Linus Torvalds 已提交
1434
		/* FALL THRU */
1435 1436
	/* Read last kernel messages */
	case SYSLOG_ACTION_READ_ALL:
L
Linus Torvalds 已提交
1437 1438 1439 1440 1441 1442 1443 1444 1445 1446
		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;
		}
1447
		error = syslog_print_all(buf, len, clear);
L
Linus Torvalds 已提交
1448
		break;
1449 1450
	/* Clear ring buffer */
	case SYSLOG_ACTION_CLEAR:
1451
		syslog_print_all(NULL, 0, true);
1452
		break;
1453 1454
	/* Disable logging to console */
	case SYSLOG_ACTION_CONSOLE_OFF:
1455
		if (saved_console_loglevel == LOGLEVEL_DEFAULT)
1456
			saved_console_loglevel = console_loglevel;
L
Linus Torvalds 已提交
1457 1458
		console_loglevel = minimum_console_loglevel;
		break;
1459 1460
	/* Enable logging to console */
	case SYSLOG_ACTION_CONSOLE_ON:
1461
		if (saved_console_loglevel != LOGLEVEL_DEFAULT) {
1462
			console_loglevel = saved_console_loglevel;
1463
			saved_console_loglevel = LOGLEVEL_DEFAULT;
1464
		}
L
Linus Torvalds 已提交
1465
		break;
1466 1467
	/* Set level of messages printed to console */
	case SYSLOG_ACTION_CONSOLE_LEVEL:
L
Linus Torvalds 已提交
1468 1469 1470 1471 1472 1473
		error = -EINVAL;
		if (len < 1 || len > 8)
			goto out;
		if (len < minimum_console_loglevel)
			len = minimum_console_loglevel;
		console_loglevel = len;
1474
		/* Implicitly re-enable logging to console */
1475
		saved_console_loglevel = LOGLEVEL_DEFAULT;
L
Linus Torvalds 已提交
1476 1477
		error = 0;
		break;
1478 1479
	/* Number of chars in the log buffer */
	case SYSLOG_ACTION_SIZE_UNREAD:
1480 1481 1482 1483 1484
		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;
1485
			syslog_partial = 0;
1486
		}
1487
		if (source == SYSLOG_FROM_PROC) {
1488 1489 1490 1491 1492
			/*
			 * Short-cut for poll(/"proc/kmsg") which simply checks
			 * for pending data, not the size; return the count of
			 * records, not the length.
			 */
1493
			error = log_next_seq - syslog_seq;
1494
		} else {
1495 1496
			u64 seq = syslog_seq;
			u32 idx = syslog_idx;
1497 1498 1499

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

1502
				error += msg_print_text(msg, true, NULL, 0);
1503 1504 1505
				idx = log_next(idx);
				seq++;
			}
1506
			error -= syslog_partial;
1507 1508
		}
		raw_spin_unlock_irq(&logbuf_lock);
L
Linus Torvalds 已提交
1509
		break;
1510 1511
	/* Size of the log buffer */
	case SYSLOG_ACTION_SIZE_BUFFER:
L
Linus Torvalds 已提交
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
		error = log_buf_len;
		break;
	default:
		error = -EINVAL;
		break;
	}
out:
	return error;
}

1522
SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
L
Linus Torvalds 已提交
1523
{
1524
	return do_syslog(type, buf, len, SYSLOG_FROM_READER);
L
Linus Torvalds 已提交
1525 1526 1527 1528 1529
}

/*
 * Call the console drivers, asking them to write out
 * log_buf[start] to log_buf[end - 1].
1530
 * The console_lock must be held.
L
Linus Torvalds 已提交
1531
 */
1532 1533 1534
static void call_console_drivers(int level,
				 const char *ext_text, size_t ext_len,
				 const char *text, size_t len)
L
Linus Torvalds 已提交
1535
{
1536
	struct console *con;
L
Linus Torvalds 已提交
1537

1538
	trace_console(text, len);
1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552

	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;
1553 1554 1555 1556
		if (con->flags & CON_EXTENDED)
			con->write(con, ext_text, ext_len);
		else
			con->write(con, text, len);
1557
	}
L
Linus Torvalds 已提交
1558 1559
}

1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573
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();
		}
	}
}

1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585
/*
 * 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 */
	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 已提交
1586
	u8 facility;			/* log facility of first message */
1587
	enum log_flags flags;		/* prefix, newline flags */
1588 1589
} cont;

1590
static void cont_flush(void)
1591 1592 1593
{
	if (cont.len == 0)
		return;
1594 1595 1596 1597

	log_store(cont.facility, cont.level, cont.flags, cont.ts_nsec,
		  NULL, 0, cont.buf, cont.len);
	cont.len = 0;
1598 1599
}

1600
static bool cont_add(int facility, int level, enum log_flags flags, const char *text, size_t len)
1601
{
1602 1603 1604 1605 1606 1607
	/*
	 * 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)) {
1608
		cont_flush();
1609 1610 1611 1612 1613 1614 1615 1616
		return false;
	}

	if (!cont.len) {
		cont.facility = facility;
		cont.level = level;
		cont.owner = current;
		cont.ts_nsec = local_clock();
1617
		cont.flags = flags;
1618 1619 1620 1621
	}

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

1623 1624 1625 1626 1627 1628 1629
	// The original flags come from the first line,
	// but later continuations can add a newline.
	if (flags & LOG_NEWLINE) {
		cont.flags |= LOG_NEWLINE;
		cont_flush();
	}

1630
	if (cont.len > (sizeof(cont.buf) * 80) / 100)
1631
		cont_flush();
1632

1633 1634 1635
	return true;
}

1636 1637 1638
static size_t log_output(int facility, int level, enum log_flags lflags, const char *dict, size_t dictlen, char *text, size_t text_len)
{
	/*
1639 1640
	 * If an earlier line was buffered, and we're a continuation
	 * write from the same process, try to add it to the buffer.
1641 1642
	 */
	if (cont.len) {
1643 1644 1645 1646 1647 1648 1649
		if (cont.owner == current && (lflags & LOG_CONT)) {
			if (cont_add(facility, level, lflags, text, text_len))
				return text_len;
		}
		/* Otherwise, make sure it's flushed */
		cont_flush();
	}
1650

1651 1652 1653 1654
	/* Skip empty continuation lines that couldn't be added - they just flush */
	if (!text_len && (lflags & LOG_CONT))
		return 0;

1655 1656 1657
	/* If it doesn't end in a newline, try to buffer the current line */
	if (!(lflags & LOG_NEWLINE)) {
		if (cont_add(facility, level, lflags, text, text_len))
1658 1659 1660
			return text_len;
	}

1661
	/* Store it in the record log */
1662 1663 1664
	return log_store(facility, level, lflags, 0, dict, dictlen, text, text_len);
}

1665 1666 1667
asmlinkage int vprintk_emit(int facility, int level,
			    const char *dict, size_t dictlen,
			    const char *fmt, va_list args)
L
Linus Torvalds 已提交
1668
{
1669 1670
	static char textbuf[LOG_LINE_MAX];
	char *text = textbuf;
1671
	size_t text_len = 0;
1672
	enum log_flags lflags = 0;
1673
	unsigned long flags;
1674
	int printed_len = 0;
1675
	bool in_sched = false;
1676

1677 1678
	if (level == LOGLEVEL_SCHED) {
		level = LOGLEVEL_DEFAULT;
1679 1680
		in_sched = true;
	}
L
Linus Torvalds 已提交
1681

1682
	boot_delay_msec(level);
1683
	printk_delay();
R
Randy Dunlap 已提交
1684

1685
	printk_safe_enter_irqsave(flags);
1686
	/* This stops the holder of console_sem just where we want him */
1687
	raw_spin_lock(&logbuf_lock);
1688 1689 1690 1691
	/*
	 * The printf needs to come first; we need the syslog
	 * prefix which might be passed-in as a parameter.
	 */
1692
	text_len = vscnprintf(text, sizeof(textbuf), fmt, args);
1693

1694
	/* mark and strip a trailing newline */
1695 1696
	if (text_len && text[text_len-1] == '\n') {
		text_len--;
1697
		lflags |= LOG_NEWLINE;
1698
	}
1699

1700 1701
	/* strip kernel syslog prefix and extract log level or control flags */
	if (facility == 0) {
1702
		int kern_level;
1703

1704
		while ((kern_level = printk_get_level(text)) != 0) {
1705 1706
			switch (kern_level) {
			case '0' ... '7':
1707
				if (level == LOGLEVEL_DEFAULT)
1708
					level = kern_level - '0';
1709
				/* fallthrough */
1710 1711
			case 'd':	/* KERN_DEFAULT */
				lflags |= LOG_PREFIX;
1712 1713 1714
				break;
			case 'c':	/* KERN_CONT */
				lflags |= LOG_CONT;
1715
			}
1716 1717 1718

			text_len -= 2;
			text += 2;
1719 1720 1721
		}
	}

1722
	if (level == LOGLEVEL_DEFAULT)
1723
		level = default_message_loglevel;
1724

1725 1726
	if (dict)
		lflags |= LOG_PREFIX|LOG_NEWLINE;
1727

1728
	printed_len += log_output(facility, level, lflags, dict, dictlen, text, text_len);
L
Linus Torvalds 已提交
1729

1730
	raw_spin_unlock(&logbuf_lock);
1731
	printk_safe_exit_irqrestore(flags);
1732

1733
	/* If called from the scheduler, we can not call up(). */
1734 1735 1736 1737 1738 1739
	if (!in_sched) {
		/*
		 * Try to acquire and then immediately release the console
		 * semaphore.  The release will print out buffers and wake up
		 * /dev/kmsg and syslog() users.
		 */
1740
		if (console_trylock())
1741 1742
			console_unlock();
	}
1743

L
Linus Torvalds 已提交
1744 1745
	return printed_len;
}
1746 1747 1748 1749
EXPORT_SYMBOL(vprintk_emit);

asmlinkage int vprintk(const char *fmt, va_list args)
{
1750
	return vprintk_func(fmt, args);
1751
}
L
Linus Torvalds 已提交
1752 1753
EXPORT_SYMBOL(vprintk);

1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768
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);

1769
int vprintk_default(const char *fmt, va_list args)
1770 1771 1772 1773
{
	int r;

#ifdef CONFIG_KGDB_KDB
1774 1775
	/* Allow to pass printk() to kdb but avoid a recursion. */
	if (unlikely(kdb_trap_printk && kdb_printf_cpu < 0)) {
1776
		r = vkdb_printf(KDB_MSGSRC_PRINTK, fmt, args);
1777 1778 1779
		return r;
	}
#endif
1780
	r = vprintk_emit(0, LOGLEVEL_DEFAULT, NULL, 0, fmt, args);
1781 1782 1783 1784 1785

	return r;
}
EXPORT_SYMBOL_GPL(vprintk_default);

1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806
/**
 * 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.
 */
1807
asmlinkage __visible int printk(const char *fmt, ...)
1808 1809 1810 1811 1812
{
	va_list args;
	int r;

	va_start(args, fmt);
1813
	r = vprintk_func(fmt, args);
1814 1815 1816 1817 1818
	va_end(args);

	return r;
}
EXPORT_SYMBOL(printk);
1819

1820
#else /* CONFIG_PRINTK */
M
Matt Mackall 已提交
1821

1822 1823
#define LOG_LINE_MAX		0
#define PREFIX_MAX		0
A
Alex Elder 已提交
1824

1825 1826
static u64 syslog_seq;
static u32 syslog_idx;
1827 1828
static u64 console_seq;
static u32 console_idx;
1829 1830 1831
static u64 log_first_seq;
static u32 log_first_idx;
static u64 log_next_seq;
1832 1833
static char *log_text(const struct printk_log *msg) { return NULL; }
static char *log_dict(const struct printk_log *msg) { return NULL; }
1834
static struct printk_log *log_from_idx(u32 idx) { return NULL; }
1835
static u32 log_next(u32 idx) { return 0; }
1836
static ssize_t msg_print_ext_header(char *buf, size_t size,
1837 1838
				    struct printk_log *msg,
				    u64 seq) { return 0; }
1839 1840 1841 1842 1843 1844
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) {}
1845
static size_t msg_print_text(const struct printk_log *msg,
1846
			     bool syslog, char *buf, size_t size) { return 0; }
1847
static bool suppress_message_printing(int level) { return false; }
M
Matt Mackall 已提交
1848

1849
#endif /* CONFIG_PRINTK */
M
Matt Mackall 已提交
1850

1851 1852 1853
#ifdef CONFIG_EARLY_PRINTK
struct console *early_console;

1854
asmlinkage __visible void early_printk(const char *fmt, ...)
1855 1856
{
	va_list ap;
1857 1858 1859 1860 1861
	char buf[512];
	int n;

	if (!early_console)
		return;
1862 1863

	va_start(ap, fmt);
1864
	n = vscnprintf(buf, sizeof(buf), fmt, ap);
1865
	va_end(ap);
1866 1867

	early_console->write(early_console, buf, n);
1868 1869 1870
}
#endif

1871 1872 1873 1874 1875 1876 1877 1878 1879 1880
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.
	 */
1881 1882 1883 1884 1885 1886 1887
	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;
1888
		}
1889
	}
1890 1891 1892 1893 1894 1895
	if (i == MAX_CMDLINECONSOLES)
		return -E2BIG;
	if (!brl_options)
		selected_console = i;
	strlcpy(c->name, name, sizeof(c->name));
	c->options = options;
1896 1897
	braille_set_options(c, brl_options);

1898 1899 1900
	c->index = idx;
	return 0;
}
1901
/*
A
Alex Elder 已提交
1902 1903
 * Set up a console.  Called via do_early_param() in init/main.c
 * for each "console=" parameter in the boot command line.
1904 1905 1906
 */
static int __init console_setup(char *str)
{
A
Alex Elder 已提交
1907
	char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for "ttyS" */
1908
	char *s, *options, *brl_options = NULL;
1909 1910
	int idx;

1911 1912
	if (_braille_console_setup(&str, &brl_options))
		return 1;
1913

1914 1915 1916 1917
	/*
	 * Decode str into name, index, options.
	 */
	if (str[0] >= '0' && str[0] <= '9') {
Y
Yinghai Lu 已提交
1918 1919
		strcpy(buf, "ttyS");
		strncpy(buf + 4, str, sizeof(buf) - 5);
1920
	} else {
Y
Yinghai Lu 已提交
1921
		strncpy(buf, str, sizeof(buf) - 1);
1922
	}
Y
Yinghai Lu 已提交
1923
	buf[sizeof(buf) - 1] = 0;
A
Alex Elder 已提交
1924 1925
	options = strchr(str, ',');
	if (options)
1926 1927 1928
		*(options++) = 0;
#ifdef __sparc__
	if (!strcmp(str, "ttya"))
Y
Yinghai Lu 已提交
1929
		strcpy(buf, "ttyS0");
1930
	if (!strcmp(str, "ttyb"))
Y
Yinghai Lu 已提交
1931
		strcpy(buf, "ttyS1");
1932
#endif
Y
Yinghai Lu 已提交
1933
	for (s = buf; *s; s++)
A
Alex Elder 已提交
1934
		if (isdigit(*s) || *s == ',')
1935 1936 1937 1938
			break;
	idx = simple_strtoul(s, NULL, 10);
	*s = 0;

1939
	__add_preferred_console(buf, idx, options, brl_options);
1940
	console_set_on_cmdline = 1;
1941 1942 1943 1944
	return 1;
}
__setup("console=", console_setup);

1945 1946
/**
 * add_preferred_console - add a device to the list of preferred consoles.
1947 1948 1949
 * @name: device name
 * @idx: device index
 * @options: options for this console
1950 1951 1952 1953 1954 1955 1956 1957
 *
 * 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.
 */
1958
int add_preferred_console(char *name, int idx, char *options)
1959
{
1960
	return __add_preferred_console(name, idx, options, NULL);
1961 1962
}

1963
bool console_suspend_enabled = true;
1964 1965 1966 1967
EXPORT_SYMBOL(console_suspend_enabled);

static int __init console_suspend_disable(char *str)
{
1968
	console_suspend_enabled = false;
1969 1970 1971
	return 1;
}
__setup("no_console_suspend", console_suspend_disable);
1972 1973 1974 1975
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");
1976

1977 1978 1979 1980 1981 1982 1983
/**
 * suspend_console - suspend the console subsystem
 *
 * This disables printk() while we go into suspend states
 */
void suspend_console(void)
{
1984 1985
	if (!console_suspend_enabled)
		return;
1986
	printk("Suspending console(s) (use no_console_suspend to debug)\n");
1987
	console_lock();
1988
	console_suspended = 1;
1989
	up_console_sem();
1990 1991 1992 1993
}

void resume_console(void)
{
1994 1995
	if (!console_suspend_enabled)
		return;
1996
	down_console_sem();
1997
	console_suspended = 0;
1998
	console_unlock();
1999 2000
}

2001 2002
/**
 * console_cpu_notify - print deferred console messages after CPU hotplug
2003
 * @cpu: unused
2004 2005 2006 2007 2008 2009
 *
 * 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.
 */
2010 2011
static int console_cpu_notify(unsigned int cpu)
{
2012
	if (!cpuhp_tasks_frozen) {
2013 2014
		console_lock();
		console_unlock();
2015
	}
2016
	return 0;
2017 2018
}

L
Linus Torvalds 已提交
2019
/**
2020
 * console_lock - lock the console system for exclusive use.
L
Linus Torvalds 已提交
2021
 *
2022
 * Acquires a lock which guarantees that the caller has
L
Linus Torvalds 已提交
2023 2024 2025 2026
 * exclusive access to the console system and the console_drivers list.
 *
 * Can sleep, returns nothing.
 */
2027
void console_lock(void)
L
Linus Torvalds 已提交
2028
{
2029 2030
	might_sleep();

2031
	down_console_sem();
2032 2033
	if (console_suspended)
		return;
L
Linus Torvalds 已提交
2034 2035 2036
	console_locked = 1;
	console_may_schedule = 1;
}
2037
EXPORT_SYMBOL(console_lock);
L
Linus Torvalds 已提交
2038

2039 2040 2041
/**
 * console_trylock - try to lock the console system for exclusive use.
 *
A
Alex Elder 已提交
2042 2043
 * Try to acquire a lock which guarantees that the caller has exclusive
 * access to the console system and the console_drivers list.
2044 2045 2046 2047
 *
 * returns 1 on success, and 0 on failure to acquire the lock.
 */
int console_trylock(void)
L
Linus Torvalds 已提交
2048
{
2049
	if (down_trylock_console_sem())
2050
		return 0;
2051
	if (console_suspended) {
2052
		up_console_sem();
2053
		return 0;
2054
	}
L
Linus Torvalds 已提交
2055
	console_locked = 1;
2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069
	/*
	 * When PREEMPT_COUNT disabled we can't reliably detect if it's
	 * safe to schedule (e.g. calling printk while holding a spin_lock),
	 * because preempt_disable()/preempt_enable() are just barriers there
	 * and preempt_count() is always 0.
	 *
	 * RCU read sections have a separate preemption counter when
	 * PREEMPT_RCU enabled thus we must take extra care and check
	 * rcu_preempt_depth(), otherwise RCU read sections modify
	 * preempt_count().
	 */
	console_may_schedule = !oops_in_progress &&
			preemptible() &&
			!rcu_preempt_depth();
2070
	return 1;
L
Linus Torvalds 已提交
2071
}
2072
EXPORT_SYMBOL(console_trylock);
L
Linus Torvalds 已提交
2073 2074 2075 2076 2077 2078

int is_console_locked(void)
{
	return console_locked;
}

2079 2080 2081 2082 2083 2084 2085 2086 2087
/*
 * Check if we have any console that is capable of printing while cpu is
 * booting or shutting down. Requires console_sem.
 */
static int have_callable_console(void)
{
	struct console *con;

	for_each_console(con)
2088 2089
		if ((con->flags & CON_ENABLED) &&
				(con->flags & CON_ANYTIME))
2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106
			return 1;

	return 0;
}

/*
 * Can we actually use the console at this time on this cpu?
 *
 * Console drivers may assume that per-cpu resources have been allocated. So
 * unless they're explicitly marked as being able to cope (CON_ANYTIME) don't
 * call them until this CPU is officially up.
 */
static inline int can_use_console(void)
{
	return cpu_online(raw_smp_processor_id()) || have_callable_console();
}

L
Linus Torvalds 已提交
2107
/**
2108
 * console_unlock - unlock the console system
L
Linus Torvalds 已提交
2109
 *
2110
 * Releases the console_lock which the caller holds on the console system
L
Linus Torvalds 已提交
2111 2112
 * and the console driver list.
 *
2113 2114 2115
 * 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 已提交
2116
 *
2117
 * If there is output waiting, we wake /dev/kmsg and syslog() users.
L
Linus Torvalds 已提交
2118
 *
2119
 * console_unlock(); may be called from any context.
L
Linus Torvalds 已提交
2120
 */
2121
void console_unlock(void)
L
Linus Torvalds 已提交
2122
{
2123
	static char ext_text[CONSOLE_EXT_LOG_MAX];
2124
	static char text[LOG_LINE_MAX + PREFIX_MAX];
2125
	static u64 seen_seq;
L
Linus Torvalds 已提交
2126
	unsigned long flags;
2127
	bool wake_klogd = false;
2128
	bool do_cond_resched, retry;
L
Linus Torvalds 已提交
2129

2130
	if (console_suspended) {
2131
		up_console_sem();
2132 2133
		return;
	}
2134

2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145
	/*
	 * Console drivers are called under logbuf_lock, so
	 * @console_may_schedule should be cleared before; however, we may
	 * end up dumping a lot of lines, for example, if called from
	 * console registration path, and should invoke cond_resched()
	 * between lines if allowable.  Not doing so can cause a very long
	 * scheduling stall on a slow console leading to RCU stall and
	 * softlockup warnings which exacerbate the issue with more
	 * messages practically incapacitating the system.
	 */
	do_cond_resched = console_may_schedule;
2146 2147
	console_may_schedule = 0;

2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159
again:
	/*
	 * We released the console_sem lock, so we need to recheck if
	 * cpu is online and (if not) is there at least one CON_ANYTIME
	 * console.
	 */
	if (!can_use_console()) {
		console_locked = 0;
		up_console_sem();
		return;
	}

2160
	for (;;) {
2161
		struct printk_log *msg;
2162
		size_t ext_len = 0;
2163
		size_t len;
2164 2165
		int level;

2166 2167
		printk_safe_enter_irqsave(flags);
		raw_spin_lock(&logbuf_lock);
2168 2169 2170 2171 2172 2173
		if (seen_seq != log_next_seq) {
			wake_klogd = true;
			seen_seq = log_next_seq;
		}

		if (console_seq < log_first_seq) {
2174 2175 2176
			len = sprintf(text, "** %u printk messages dropped ** ",
				      (unsigned)(log_first_seq - console_seq));

2177 2178 2179
			/* messages are gone, move to first one */
			console_seq = log_first_seq;
			console_idx = log_first_idx;
2180 2181
		} else {
			len = 0;
2182
		}
2183
skip:
2184 2185 2186 2187
		if (console_seq == log_next_seq)
			break;

		msg = log_from_idx(console_idx);
2188
		level = msg->level;
2189
		if (suppress_message_printing(level)) {
2190 2191
			/*
			 * Skip record we have buffered and already printed
2192 2193
			 * directly to the console when we received it, and
			 * record that has level above the console loglevel.
2194 2195 2196 2197 2198
			 */
			console_idx = log_next(console_idx);
			console_seq++;
			goto skip;
		}
2199

2200
		len += msg_print_text(msg, false, text + len, sizeof(text) - len);
2201 2202 2203
		if (nr_ext_console_drivers) {
			ext_len = msg_print_ext_header(ext_text,
						sizeof(ext_text),
2204
						msg, console_seq);
2205 2206 2207 2208 2209
			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);
		}
2210 2211
		console_idx = log_next(console_idx);
		console_seq++;
2212
		raw_spin_unlock(&logbuf_lock);
2213

2214
		stop_critical_timings();	/* don't trace print latency */
2215
		call_console_drivers(level, ext_text, ext_len, text, len);
2216
		start_critical_timings();
2217
		printk_safe_exit_irqrestore(flags);
2218 2219 2220

		if (do_cond_resched)
			cond_resched();
L
Linus Torvalds 已提交
2221 2222
	}
	console_locked = 0;
2223 2224 2225 2226 2227

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

2228
	raw_spin_unlock(&logbuf_lock);
2229

2230
	up_console_sem();
2231 2232 2233 2234 2235 2236 2237

	/*
	 * 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.
	 */
2238
	raw_spin_lock(&logbuf_lock);
2239
	retry = console_seq != log_next_seq;
2240 2241
	raw_spin_unlock(&logbuf_lock);
	printk_safe_exit_irqrestore(flags);
P
Peter Zijlstra 已提交
2242

2243 2244 2245
	if (retry && console_trylock())
		goto again;

2246 2247
	if (wake_klogd)
		wake_up_klogd();
L
Linus Torvalds 已提交
2248
}
2249
EXPORT_SYMBOL(console_unlock);
L
Linus Torvalds 已提交
2250

2251 2252
/**
 * console_conditional_schedule - yield the CPU if required
L
Linus Torvalds 已提交
2253 2254 2255 2256 2257
 *
 * If the console code is currently allowed to sleep, and
 * if this CPU should yield the CPU to another task, do
 * so here.
 *
2258
 * Must be called within console_lock();.
L
Linus Torvalds 已提交
2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275
 */
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) {
2276
		if (down_trylock_console_sem() != 0)
L
Linus Torvalds 已提交
2277 2278
			return;
	} else
2279
		console_lock();
L
Linus Torvalds 已提交
2280 2281 2282

	console_locked = 1;
	console_may_schedule = 0;
2283
	for_each_console(c)
L
Linus Torvalds 已提交
2284 2285
		if ((c->flags & CON_ENABLED) && c->unblank)
			c->unblank();
2286
	console_unlock();
L
Linus Torvalds 已提交
2287 2288
}

2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307
/**
 * console_flush_on_panic - flush console content on panic
 *
 * Immediately output all pending messages no matter what.
 */
void console_flush_on_panic(void)
{
	/*
	 * If someone else is holding the console lock, trylock will fail
	 * and may_schedule may be set.  Ignore and proceed to unlock so
	 * that messages are flushed out.  As this can be called from any
	 * context and we don't want to get preempted while flushing,
	 * ensure may_schedule is cleared.
	 */
	console_trylock();
	console_may_schedule = 0;
	console_unlock();
}

L
Linus Torvalds 已提交
2308 2309 2310 2311 2312 2313 2314 2315
/*
 * 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;

2316
	console_lock();
2317
	for_each_console(c) {
L
Linus Torvalds 已提交
2318 2319 2320 2321 2322 2323
		if (!c->device)
			continue;
		driver = c->device(c, index);
		if (driver)
			break;
	}
2324
	console_unlock();
L
Linus Torvalds 已提交
2325 2326 2327 2328 2329 2330 2331 2332 2333 2334
	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)
{
2335
	console_lock();
L
Linus Torvalds 已提交
2336
	console->flags &= ~CON_ENABLED;
2337
	console_unlock();
L
Linus Torvalds 已提交
2338 2339 2340 2341 2342
}
EXPORT_SYMBOL(console_stop);

void console_start(struct console *console)
{
2343
	console_lock();
L
Linus Torvalds 已提交
2344
	console->flags |= CON_ENABLED;
2345
	console_unlock();
L
Linus Torvalds 已提交
2346 2347 2348
}
EXPORT_SYMBOL(console_start);

2349 2350 2351 2352 2353
static int __read_mostly keep_bootcon;

static int __init keep_bootcon_setup(char *str)
{
	keep_bootcon = 1;
2354
	pr_info("debug: skip boot console de-registration.\n");
2355 2356 2357 2358 2359 2360

	return 0;
}

early_param("keep_bootcon", keep_bootcon_setup);

L
Linus Torvalds 已提交
2361 2362 2363 2364 2365
/*
 * 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.
2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378
 *
 * 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 已提交
2379
 */
2380
void register_console(struct console *newcon)
L
Linus Torvalds 已提交
2381
{
J
Jesper Juhl 已提交
2382
	int i;
L
Linus Torvalds 已提交
2383
	unsigned long flags;
2384
	struct console *bcon = NULL;
2385
	struct console_cmdline *c;
L
Linus Torvalds 已提交
2386

2387 2388 2389 2390 2391 2392 2393
	if (console_drivers)
		for_each_console(bcon)
			if (WARN(bcon == newcon,
					"console '%s%d' already registered\n",
					bcon->name, bcon->index))
				return;

2394 2395 2396 2397 2398 2399 2400 2401
	/*
	 * 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)) {
2402
				pr_info("Too late to register bootconsole %s%d\n",
2403 2404 2405 2406
					newcon->name, newcon->index);
				return;
			}
		}
2407 2408
	}

2409 2410 2411 2412
	if (console_drivers && console_drivers->flags & CON_BOOT)
		bcon = console_drivers;

	if (preferred_console < 0 || bcon || !console_drivers)
L
Linus Torvalds 已提交
2413 2414 2415 2416 2417 2418 2419
		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.
	 */
2420
	if (preferred_console < 0) {
2421 2422 2423 2424 2425 2426 2427
		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;
2428 2429
				preferred_console = 0;
			}
L
Linus Torvalds 已提交
2430 2431 2432 2433 2434 2435 2436
		}
	}

	/*
	 *	See if this console matches one we selected on
	 *	the command line.
	 */
2437 2438 2439
	for (i = 0, c = console_cmdline;
	     i < MAX_CMDLINECONSOLES && c->name[0];
	     i++, c++) {
2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450
		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;
2451

2452 2453 2454 2455 2456 2457 2458
			if (_braille_register_console(newcon, c))
				return;

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

2460
		newcon->flags |= CON_ENABLED;
2461
		if (i == selected_console) {
2462
			newcon->flags |= CON_CONSDEV;
2463 2464
			preferred_console = selected_console;
		}
L
Linus Torvalds 已提交
2465 2466 2467
		break;
	}

2468
	if (!(newcon->flags & CON_ENABLED))
L
Linus Torvalds 已提交
2469 2470
		return;

2471 2472 2473 2474 2475 2476 2477
	/*
	 * 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))
2478
		newcon->flags &= ~CON_PRINTBUFFER;
L
Linus Torvalds 已提交
2479 2480 2481 2482 2483

	/*
	 *	Put this console in the list - keep the
	 *	preferred driver at the head of the list.
	 */
2484
	console_lock();
2485 2486 2487 2488 2489
	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 已提交
2490
	} else {
2491 2492
		newcon->next = console_drivers->next;
		console_drivers->next = newcon;
L
Linus Torvalds 已提交
2493
	}
2494 2495 2496 2497 2498

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

2499
	if (newcon->flags & CON_PRINTBUFFER) {
L
Linus Torvalds 已提交
2500
		/*
2501
		 * console_unlock(); will print out the buffered messages
L
Linus Torvalds 已提交
2502 2503
		 * for us.
		 */
2504
		raw_spin_lock_irqsave(&logbuf_lock, flags);
2505 2506
		console_seq = syslog_seq;
		console_idx = syslog_idx;
2507
		raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2508 2509 2510 2511 2512 2513
		/*
		 * 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 已提交
2514
	}
2515
	console_unlock();
2516
	console_sysfs_notify();
2517 2518 2519 2520 2521 2522 2523 2524

	/*
	 * 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)
	 */
2525
	pr_info("%sconsole [%s%d] enabled\n",
2526 2527
		(newcon->flags & CON_BOOT) ? "boot" : "" ,
		newcon->name, newcon->index);
2528 2529 2530
	if (bcon &&
	    ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
	    !keep_bootcon) {
2531 2532
		/* We need to iterate through all boot consoles, to make
		 * sure we print everything out, before we unregister them.
2533 2534 2535 2536 2537
		 */
		for_each_console(bcon)
			if (bcon->flags & CON_BOOT)
				unregister_console(bcon);
	}
L
Linus Torvalds 已提交
2538 2539 2540
}
EXPORT_SYMBOL(register_console);

J
Jesper Juhl 已提交
2541
int unregister_console(struct console *console)
L
Linus Torvalds 已提交
2542
{
J
Jesper Juhl 已提交
2543
        struct console *a, *b;
2544
	int res;
L
Linus Torvalds 已提交
2545

2546
	pr_info("%sconsole [%s%d] disabled\n",
2547 2548 2549
		(console->flags & CON_BOOT) ? "boot" : "" ,
		console->name, console->index);

2550 2551 2552
	res = _braille_unregister_console(console);
	if (res)
		return res;
2553

2554
	res = 1;
2555
	console_lock();
L
Linus Torvalds 已提交
2556 2557 2558
	if (console_drivers == console) {
		console_drivers=console->next;
		res = 0;
2559
	} else if (console_drivers) {
L
Linus Torvalds 已提交
2560 2561 2562 2563 2564 2565
		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 已提交
2566
			}
L
Linus Torvalds 已提交
2567 2568
		}
	}
J
Jesper Juhl 已提交
2569

2570 2571 2572
	if (!res && (console->flags & CON_EXTENDED))
		nr_ext_console_drivers--;

2573
	/*
2574 2575
	 * 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 已提交
2576
	 */
2577
	if (console_drivers != NULL && console->flags & CON_CONSDEV)
2578
		console_drivers->flags |= CON_CONSDEV;
L
Linus Torvalds 已提交
2579

2580
	console->flags &= ~CON_ENABLED;
2581
	console_unlock();
2582
	console_sysfs_notify();
L
Linus Torvalds 已提交
2583 2584 2585
	return res;
}
EXPORT_SYMBOL(unregister_console);
M
Matt Mackall 已提交
2586

2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601
/*
 * Some boot consoles access data that is in the init section and which will
 * be discarded after the initcalls have been run. To make sure that no code
 * will access this data, unregister the boot consoles in a late initcall.
 *
 * If for some reason, such as deferred probe or the driver being a loadable
 * module, the real console hasn't registered yet at this point, there will
 * be a brief interval in which no messages are logged to the console, which
 * makes it difficult to diagnose problems that occur during this time.
 *
 * To mitigate this problem somewhat, only unregister consoles whose memory
 * intersects with the init section. Note that code exists elsewhere to get
 * rid of the boot console as soon as the proper console shows up, so there
 * won't be side-effects from postponing the removal.
 */
2602
static int __init printk_late_init(void)
2603
{
2604
	struct console *con;
2605
	int ret;
2606 2607

	for_each_console(con) {
2608
		if (!keep_bootcon && con->flags & CON_BOOT) {
2609 2610 2611 2612 2613 2614 2615 2616 2617
			/*
			 * Make sure to unregister boot consoles whose data
			 * resides in the init section before the init section
			 * is discarded. Boot consoles whose data will stick
			 * around will automatically be unregistered when the
			 * proper console replaces them.
			 */
			if (init_section_intersects(con, sizeof(*con)))
				unregister_console(con);
2618
		}
2619
	}
2620 2621 2622 2623 2624 2625
	ret = cpuhp_setup_state_nocalls(CPUHP_PRINTK_DEAD, "printk:dead", NULL,
					console_cpu_notify);
	WARN_ON(ret < 0);
	ret = cpuhp_setup_state_nocalls(CPUHP_AP_ONLINE_DYN, "printk:online",
					console_cpu_notify, NULL);
	WARN_ON(ret < 0);
2626 2627
	return 0;
}
2628
late_initcall(printk_late_init);
2629

2630
#if defined CONFIG_PRINTK
2631 2632 2633 2634
/*
 * Delayed printk version, for scheduler-internal messages:
 */
#define PRINTK_PENDING_WAKEUP	0x01
2635
#define PRINTK_PENDING_OUTPUT	0x02
2636 2637 2638 2639 2640 2641 2642

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

2643 2644 2645 2646
	if (pending & PRINTK_PENDING_OUTPUT) {
		/* If trylock fails, someone else is doing the printing */
		if (console_trylock())
			console_unlock();
2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662
	}

	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);
2663
		irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2664 2665 2666
	}
	preempt_enable();
}
D
Dave Young 已提交
2667

2668
int printk_deferred(const char *fmt, ...)
2669 2670 2671 2672
{
	va_list args;
	int r;

2673
	preempt_disable();
2674
	va_start(args, fmt);
2675
	r = vprintk_emit(0, LOGLEVEL_SCHED, NULL, 0, fmt, args);
2676 2677
	va_end(args);

2678
	__this_cpu_or(printk_pending, PRINTK_PENDING_OUTPUT);
2679
	irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2680
	preempt_enable();
2681 2682 2683 2684

	return r;
}

L
Linus Torvalds 已提交
2685 2686 2687
/*
 * printk rate limiting, lifted from the networking subsystem.
 *
2688 2689
 * This enforces a rate limit: not more than 10 kernel messages
 * every 5s to make a denial-of-service attack impossible.
L
Linus Torvalds 已提交
2690
 */
2691 2692
DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);

2693
int __printk_ratelimit(const char *func)
L
Linus Torvalds 已提交
2694
{
2695
	return ___ratelimit(&printk_ratelimit_state, func);
L
Linus Torvalds 已提交
2696
}
2697
EXPORT_SYMBOL(__printk_ratelimit);
2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710

/**
 * 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 已提交
2711 2712 2713 2714 2715 2716 2717
	unsigned long elapsed = jiffies - *caller_jiffies;

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

	*caller_jiffies = jiffies;
	return true;
2718 2719
}
EXPORT_SYMBOL(printk_timed_ratelimit);
2720 2721 2722 2723 2724 2725

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

/**
 * kmsg_dump_register - register a kernel log dumper.
R
Randy Dunlap 已提交
2726
 * @dumper: pointer to the kmsg_dumper structure
2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744
 *
 * 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;
2745
		list_add_tail_rcu(&dumper->list, &dump_list);
2746 2747 2748 2749 2750 2751 2752 2753 2754 2755
		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 已提交
2756
 * @dumper: pointer to the kmsg_dumper structure
2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768
 *
 * 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;
2769
		list_del_rcu(&dumper->list);
2770 2771 2772
		err = 0;
	}
	spin_unlock_irqrestore(&dump_list_lock, flags);
2773
	synchronize_rcu();
2774 2775 2776 2777 2778

	return err;
}
EXPORT_SYMBOL_GPL(kmsg_dump_unregister);

2779 2780 2781
static bool always_kmsg_dump;
module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);

2782 2783 2784 2785
/**
 * kmsg_dump - dump kernel log to kernel message dumpers.
 * @reason: the reason (oops, panic etc) for dumping
 *
2786 2787 2788
 * 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().
2789 2790 2791 2792 2793 2794
 */
void kmsg_dump(enum kmsg_dump_reason reason)
{
	struct kmsg_dumper *dumper;
	unsigned long flags;

2795 2796 2797
	if ((reason > KMSG_DUMP_OOPS) && !always_kmsg_dump)
		return;

2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822
	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();
}

/**
2823
 * kmsg_dump_get_line_nolock - retrieve one kmsg log line (unlocked version)
2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837
 * @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.
2838 2839
 *
 * The function is similar to kmsg_dump_get_line(), but grabs no locks.
2840
 */
2841 2842
bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper, bool syslog,
			       char *line, size_t size, size_t *len)
2843
{
2844
	struct printk_log *msg;
2845 2846 2847 2848 2849
	size_t l = 0;
	bool ret = false;

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

2851 2852 2853 2854 2855
	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;
	}
2856

2857
	/* last entry */
2858
	if (dumper->cur_seq >= log_next_seq)
2859
		goto out;
2860

2861
	msg = log_from_idx(dumper->cur_idx);
2862
	l = msg_print_text(msg, syslog, line, size);
2863 2864 2865 2866 2867 2868 2869 2870 2871

	dumper->cur_idx = log_next(dumper->cur_idx);
	dumper->cur_seq++;
	ret = true;
out:
	if (len)
		*len = l;
	return ret;
}
2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901

/**
 * 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;
}
2902 2903 2904 2905 2906 2907
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 已提交
2908
 * @buf: buffer to copy the line to
2909 2910 2911 2912 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 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953
 * @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;
	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;
	while (seq < dumper->next_seq) {
2954
		struct printk_log *msg = log_from_idx(idx);
2955

2956
		l += msg_print_text(msg, true, NULL, 0);
2957 2958 2959 2960 2961 2962 2963 2964
		idx = log_next(idx);
		seq++;
	}

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

2967
		l -= msg_print_text(msg, true, NULL, 0);
2968 2969
		idx = log_next(idx);
		seq++;
2970
	}
2971 2972 2973 2974 2975 2976 2977

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

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

2980
		l += msg_print_text(msg, syslog, buf + l, size - l);
2981 2982 2983 2984 2985 2986 2987
		idx = log_next(idx);
		seq++;
	}

	dumper->next_seq = next_seq;
	dumper->next_idx = next_idx;
	ret = true;
2988
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2989 2990 2991 2992 2993 2994
out:
	if (len)
		*len = l;
	return ret;
}
EXPORT_SYMBOL_GPL(kmsg_dump_get_buffer);
2995

2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013
/**
 * 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;
}

3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026
/**
 * 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);
3027
	kmsg_dump_rewind_nolock(dumper);
3028
	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
3029
}
3030
EXPORT_SYMBOL_GPL(kmsg_dump_rewind);
3031

3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053
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);
}

3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067
/**
 * 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);
3068 3069 3070 3071

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

	print_worker_info(log_lvl, current);
3074 3075
}

3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086
/**
 * 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);

3087 3088
	printk("%stask: %p task.stack: %p\n",
	       log_lvl, current, task_stack_page(current));
3089 3090
}

3091
#endif