printk.c 79.5 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>
48
#include <linux/sched/clock.h>
49
#include <linux/sched/debug.h>
50
#include <linux/sched/task_stack.h>
L
Linus Torvalds 已提交
51

52
#include <linux/uaccess.h>
53
#include <asm/sections.h>
L
Linus Torvalds 已提交
54

55 56 57
#define CREATE_TRACE_POINTS
#include <trace/events/printk.h>

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

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

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

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

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 193 194 195
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;
}

196 197 198 199 200 201 202 203 204 205 206 207
/*
 * 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;

208 209 210 211 212 213 214 215 216 217 218
/*
 * 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)
{
219 220 221 222 223 224 225 226 227 228 229 230 231
	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)
232 233 234 235 236 237
		return 1;
	mutex_acquire(&console_lock_dep_map, 0, 1, ip);
	return 0;
}
#define down_trylock_console_sem() __down_trylock_console_sem(_RET_IP_)

238 239 240 241 242 243 244 245 246 247 248
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_)
249

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

260 261 262 263 264
/*
 * If exclusive_console is non-NULL then only this console is to be printed to.
 */
static struct console *exclusive_console;

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

#define MAX_CMDLINECONSOLES 8

static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
272
static int console_cmdline_cnt;
J
Joe Perches 已提交
273

L
Linus Torvalds 已提交
274
static int preferred_console = -1;
275 276
int console_set_on_cmdline;
EXPORT_SYMBOL(console_set_on_cmdline);
L
Linus Torvalds 已提交
277 278 279 280

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

281 282 283 284 285 286
/*
 * 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 已提交
287 288
 * sequence numbers of these entries are maintained when messages are
 * stored.
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
 *
 * 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.
 *
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 330 331 332
 * 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
 *
333
 * The 'struct printk_log' buffer header must never be directly exported to
334 335 336 337
 * 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:
338 339 340 341
 *   "<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.
342 343 344 345
 *
 * 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.
346 347
 */

348
enum log_flags {
349 350 351 352
	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 */
353 354
};

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

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

376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
/*
 * Helper macros to lock/unlock logbuf_lock and switch between
 * printk-safe/unsafe modes.
 */
#define logbuf_lock_irq()				\
	do {						\
		printk_safe_enter_irq();		\
		raw_spin_lock(&logbuf_lock);		\
	} while (0)

#define logbuf_unlock_irq()				\
	do {						\
		raw_spin_unlock(&logbuf_lock);		\
		printk_safe_exit_irq();			\
	} while (0)

#define logbuf_lock_irqsave(flags)			\
	do {						\
		printk_safe_enter_irqsave(flags);	\
		raw_spin_lock(&logbuf_lock);		\
	} while (0)

#define logbuf_unlock_irqrestore(flags)		\
	do {						\
		raw_spin_unlock(&logbuf_lock);		\
		printk_safe_exit_irqrestore(flags);	\
	} while (0)

404
#ifdef CONFIG_PRINTK
405
DECLARE_WAIT_QUEUE_HEAD(log_wait);
406 407 408
/* the next printk record to read by syslog(READ) or /proc/kmsg */
static u64 syslog_seq;
static u32 syslog_idx;
409
static size_t syslog_partial;
410 411 412 413 414 415 416 417 418

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

419 420 421 422
/* the next printk record to write to the console */
static u64 console_seq;
static u32 console_idx;

423 424 425 426
/* the next printk record to read after the last 'clear' command */
static u64 clear_seq;
static u32 clear_idx;

427
#define PREFIX_MAX		32
A
Alex Elder 已提交
428
#define LOG_LINE_MAX		(1024 - PREFIX_MAX)
429

430 431 432
#define LOG_LEVEL(v)		((v) & 0x07)
#define LOG_FACILITY(v)		((v) >> 3 & 0xff)

433
/* record buffer */
434
#define LOG_ALIGN __alignof__(struct printk_log)
435
#define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
436
static char __log_buf[__LOG_BUF_LEN] __aligned(LOG_ALIGN);
437 438 439
static char *log_buf = __log_buf;
static u32 log_buf_len = __LOG_BUF_LEN;

440 441 442 443 444 445 446 447 448 449 450 451
/* 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;
}

452
/* human readable text of the record */
453
static char *log_text(const struct printk_log *msg)
454
{
455
	return (char *)msg + sizeof(struct printk_log);
456 457 458
}

/* optional key/value pair dictionary attached to the record */
459
static char *log_dict(const struct printk_log *msg)
460
{
461
	return (char *)msg + sizeof(struct printk_log) + msg->text_len;
462 463 464
}

/* get record by index; idx must point to valid msg */
465
static struct printk_log *log_from_idx(u32 idx)
466
{
467
	struct printk_log *msg = (struct printk_log *)(log_buf + idx);
468 469 470 471 472 473

	/*
	 * 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)
474
		return (struct printk_log *)log_buf;
475 476 477 478 479 480
	return msg;
}

/* get next record; idx must point to valid msg */
static u32 log_next(u32 idx)
{
481
	struct printk_log *msg = (struct printk_log *)(log_buf + idx);
482 483 484 485 486 487 488 489

	/* 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) {
490
		msg = (struct printk_log *)log_buf;
491 492 493 494 495
		return msg->len;
	}
	return idx + msg->len;
}

P
Petr Mladek 已提交
496 497 498 499 500 501 502 503 504 505
/*
 * 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)
506 507 508
{
	u32 free;

P
Petr Mladek 已提交
509
	if (log_next_idx > log_first_idx || empty)
510 511 512 513 514 515 516 517 518 519 520
		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 已提交
521
static int log_make_free_space(u32 msg_size)
522
{
523 524
	while (log_first_seq < log_next_seq &&
	       !logbuf_has_space(msg_size, false)) {
A
Alex Elder 已提交
525
		/* drop old messages until we have enough contiguous space */
526 527 528
		log_first_idx = log_next(log_first_idx);
		log_first_seq++;
	}
P
Petr Mladek 已提交
529

530 531 532 533 534
	if (clear_seq < log_first_seq) {
		clear_seq = log_first_seq;
		clear_idx = log_first_idx;
	}

P
Petr Mladek 已提交
535
	/* sequence numbers are equal, so the log buffer is empty */
536
	if (logbuf_has_space(msg_size, log_first_seq == log_next_seq))
P
Petr Mladek 已提交
537 538 539
		return 0;

	return -ENOMEM;
540 541
}

542 543 544 545 546 547 548 549 550 551 552 553
/* 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 已提交
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
/*
 * 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);
}

580
/* insert record into the buffer, discard old ones, update heads */
581 582 583 584
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)
585
{
586
	struct printk_log *msg;
587
	u32 size, pad_len;
P
Petr Mladek 已提交
588
	u16 trunc_msg_len = 0;
589 590

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

P
Petr Mladek 已提交
593 594 595 596 597 598
	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))
599
			return 0;
P
Petr Mladek 已提交
600
	}
601

602
	if (log_next_idx + size + sizeof(struct printk_log) > log_buf_len) {
603 604 605 606 607
		/*
		 * 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.
		 */
608
		memset(log_buf + log_next_idx, 0, sizeof(struct printk_log));
609 610 611 612
		log_next_idx = 0;
	}

	/* fill message */
613
	msg = (struct printk_log *)(log_buf + log_next_idx);
614 615
	memcpy(log_text(msg), text, text_len);
	msg->text_len = text_len;
P
Petr Mladek 已提交
616 617 618 619
	if (trunc_msg_len) {
		memcpy(log_text(msg) + text_len, trunc_msg, trunc_msg_len);
		msg->text_len += trunc_msg_len;
	}
620 621
	memcpy(log_dict(msg), dict, dict_len);
	msg->dict_len = dict_len;
622 623 624 625 626 627 628
	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();
629
	memset(log_dict(msg) + dict_len, 0, pad_len);
630
	msg->len = size;
631 632 633 634

	/* insert message */
	log_next_idx += msg->len;
	log_next_seq++;
635 636

	return msg->text_len;
637
}
M
Matt Mackall 已提交
638

A
Alex Elder 已提交
639
int dmesg_restrict = IS_ENABLED(CONFIG_SECURITY_DMESG_RESTRICT);
640 641 642 643 644 645 646 647 648 649 650 651 652

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

653
int check_syslog_permissions(int type, int source)
654 655 656 657 658
{
	/*
	 * If this is from /proc/kmsg and we've already opened it, then we've
	 * already done the capabilities checks at open time.
	 */
659
	if (source == SYSLOG_FROM_PROC && type != SYSLOG_ACTION_OPEN)
660
		goto ok;
661 662 663

	if (syslog_action_restricted(type)) {
		if (capable(CAP_SYSLOG))
664
			goto ok;
665 666 667 668 669 670 671 672 673
		/*
		 * 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));
674
			goto ok;
675 676 677
		}
		return -EPERM;
	}
678
ok:
679 680
	return security_syslog(type);
}
G
Geliang Tang 已提交
681
EXPORT_SYMBOL_GPL(check_syslog_permissions);
682

683 684 685 686 687
static void append_char(char **pp, char *e, char c)
{
	if (*pp < e)
		*(*pp)++ = c;
}
688

689
static ssize_t msg_print_ext_header(char *buf, size_t size,
690
				    struct printk_log *msg, u64 seq)
691 692 693 694 695 696
{
	u64 ts_usec = msg->ts_nsec;

	do_div(ts_usec, 1000);

	return scnprintf(buf, size, "%u,%llu,%llu,%c;",
697 698
		       (msg->facility << 3) | msg->level, seq, ts_usec,
		       msg->flags & LOG_CONT ? 'c' : '-');
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
}

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

749 750 751 752
/* /dev/kmsg - userspace message inject/listen interface */
struct devkmsg_user {
	u64 seq;
	u32 idx;
753
	struct ratelimit_state rs;
754
	struct mutex lock;
755
	char buf[CONSOLE_EXT_LOG_MAX];
756 757
};

A
Al Viro 已提交
758
static ssize_t devkmsg_write(struct kiocb *iocb, struct iov_iter *from)
759 760 761 762
{
	char *buf, *line;
	int level = default_message_loglevel;
	int facility = 1;	/* LOG_USER */
763 764
	struct file *file = iocb->ki_filp;
	struct devkmsg_user *user = file->private_data;
C
Christoph Hellwig 已提交
765
	size_t len = iov_iter_count(from);
766 767
	ssize_t ret = len;

768
	if (!user || len > LOG_LINE_MAX)
769
		return -EINVAL;
770 771 772 773 774 775 776 777 778 779 780

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

781 782 783 784
	buf = kmalloc(len+1, GFP_KERNEL);
	if (buf == NULL)
		return -ENOMEM;

A
Al Viro 已提交
785
	buf[len] = '\0';
786
	if (!copy_from_iter_full(buf, len, from)) {
A
Al Viro 已提交
787 788
		kfree(buf);
		return -EFAULT;
789 790 791 792 793 794 795 796 797 798 799 800 801 802
	}

	/*
	 * 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;
803
		unsigned int u;
804

805
		u = simple_strtoul(line + 1, &endp, 10);
806
		if (endp && endp[0] == '>') {
807 808 809
			level = LOG_LEVEL(u);
			if (LOG_FACILITY(u) != 0)
				facility = LOG_FACILITY(u);
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
			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;
825
	struct printk_log *msg;
826 827 828 829 830 831
	size_t len;
	ssize_t ret;

	if (!user)
		return -EBADF;

832 833 834
	ret = mutex_lock_interruptible(&user->lock);
	if (ret)
		return ret;
835 836

	logbuf_lock_irq();
837 838 839
	while (user->seq == log_next_seq) {
		if (file->f_flags & O_NONBLOCK) {
			ret = -EAGAIN;
840
			logbuf_unlock_irq();
841 842 843
			goto out;
		}

844
		logbuf_unlock_irq();
845 846 847 848
		ret = wait_event_interruptible(log_wait,
					       user->seq != log_next_seq);
		if (ret)
			goto out;
849
		logbuf_lock_irq();
850 851 852 853 854 855 856
	}

	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;
857
		logbuf_unlock_irq();
858 859 860 861
		goto out;
	}

	msg = log_from_idx(user->idx);
862
	len = msg_print_ext_header(user->buf, sizeof(user->buf),
863
				   msg, user->seq);
864 865 866
	len += msg_print_ext_body(user->buf + len, sizeof(user->buf) - len,
				  log_dict(msg), msg->dict_len,
				  log_text(msg), msg->text_len);
867

868 869
	user->idx = log_next(user->idx);
	user->seq++;
870
	logbuf_unlock_irq();
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896

	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;

897
	logbuf_lock_irq();
898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
	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;
	}
921
	logbuf_unlock_irq();
922 923 924 925 926 927 928 929 930 931 932 933 934
	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);

935
	logbuf_lock_irq();
936 937 938 939
	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;
940 941
		else
			ret = POLLIN|POLLRDNORM;
942
	}
943
	logbuf_unlock_irq();
944 945 946 947 948 949 950 951 952

	return ret;
}

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

953 954
	if (devkmsg_log & DEVKMSG_LOG_MASK_OFF)
		return -EPERM;
955

956 957 958 959 960 961 962
	/* 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;
	}
963 964 965 966 967

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

968 969 970
	ratelimit_default_init(&user->rs);
	ratelimit_set_flags(&user->rs, RATELIMIT_MSG_ON_RELEASE);

971 972
	mutex_init(&user->lock);

973
	logbuf_lock_irq();
974 975
	user->idx = log_first_idx;
	user->seq = log_first_seq;
976
	logbuf_unlock_irq();
977 978 979 980 981 982 983 984 985 986 987 988

	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;

989 990
	ratelimit_state_exit(&user->rs);

991 992 993 994 995 996 997 998
	mutex_destroy(&user->lock);
	kfree(user);
	return 0;
}

const struct file_operations kmsg_fops = {
	.open = devkmsg_open,
	.read = devkmsg_read,
A
Al Viro 已提交
999
	.write_iter = devkmsg_write,
1000 1001 1002 1003 1004
	.llseek = devkmsg_llseek,
	.poll = devkmsg_poll,
	.release = devkmsg_release,
};

1005
#ifdef CONFIG_KEXEC_CORE
1006
/*
1007
 * This appends the listed symbols to /proc/vmcore
1008
 *
1009
 * /proc/vmcore is used by various utilities, like crash and makedumpfile to
1010 1011 1012 1013 1014 1015 1016 1017
 * 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);
1018
	VMCOREINFO_SYMBOL(log_first_idx);
1019
	VMCOREINFO_SYMBOL(clear_idx);
1020
	VMCOREINFO_SYMBOL(log_next_idx);
1021
	/*
1022
	 * Export struct printk_log size and field offsets. User space tools can
1023 1024
	 * parse it and detect any changes to structure down the line.
	 */
1025 1026 1027 1028 1029
	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);
1030 1031 1032
}
#endif

1033 1034 1035
/* requested log_buf_len from kernel cmdline */
static unsigned long __initdata new_log_buf_len;

1036 1037
/* we practice scaling the ring buffer by powers of 2 */
static void __init log_buf_len_update(unsigned size)
L
Linus Torvalds 已提交
1038 1039 1040
{
	if (size)
		size = roundup_pow_of_two(size);
1041 1042
	if (size > log_buf_len)
		new_log_buf_len = size;
1043 1044 1045 1046 1047 1048 1049 1050
}

/* 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);
1051 1052

	return 0;
L
Linus Torvalds 已提交
1053
}
1054 1055
early_param("log_buf_len", log_buf_len_setup);

1056 1057 1058
#ifdef CONFIG_SMP
#define __LOG_CPU_MAX_BUF_LEN (1 << CONFIG_LOG_CPU_MAX_BUF_SHIFT)

1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
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);
}
1085 1086 1087
#else /* !CONFIG_SMP */
static inline void log_buf_add_cpu(void) {}
#endif /* CONFIG_SMP */
1088

1089 1090 1091 1092 1093 1094
void __init setup_log_buf(int early)
{
	unsigned long flags;
	char *new_log_buf;
	int free;

1095 1096 1097 1098 1099 1100
	if (log_buf != __log_buf)
		return;

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

1101 1102
	if (!new_log_buf_len)
		return;
L
Linus Torvalds 已提交
1103

1104
	if (early) {
1105
		new_log_buf =
1106
			memblock_virt_alloc(new_log_buf_len, LOG_ALIGN);
1107
	} else {
1108 1109
		new_log_buf = memblock_virt_alloc_nopanic(new_log_buf_len,
							  LOG_ALIGN);
1110 1111 1112 1113 1114 1115 1116 1117
	}

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

1118
	logbuf_lock_irqsave(flags);
1119 1120 1121
	log_buf_len = new_log_buf_len;
	log_buf = new_log_buf;
	new_log_buf_len = 0;
1122 1123
	free = __LOG_BUF_LEN - log_next_idx;
	memcpy(log_buf, __log_buf, __LOG_BUF_LEN);
1124
	logbuf_unlock_irqrestore(flags);
1125

1126
	pr_info("log_buf_len: %d bytes\n", log_buf_len);
1127 1128 1129
	pr_info("early log buf free: %d(%d%%)\n",
		free, (free * 100) / __LOG_BUF_LEN);
}
L
Linus Torvalds 已提交
1130

1131 1132 1133 1134
static bool __read_mostly ignore_loglevel;

static int __init ignore_loglevel_setup(char *str)
{
1135
	ignore_loglevel = true;
1136
	pr_info("debug: ignoring loglevel setting.\n");
1137 1138 1139 1140 1141 1142

	return 0;
}

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

1146 1147 1148 1149 1150
static bool suppress_message_printing(int level)
{
	return (level >= console_loglevel && !ignore_loglevel);
}

R
Randy Dunlap 已提交
1151 1152
#ifdef CONFIG_BOOT_PRINTK_DELAY

1153
static int boot_delay; /* msecs delay after each printk during bootup */
1154
static unsigned long long loops_per_msec;	/* based on boot_delay */
R
Randy Dunlap 已提交
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166

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;

1167 1168 1169
	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);
1170
	return 0;
R
Randy Dunlap 已提交
1171
}
1172
early_param("boot_delay", boot_delay_setup);
R
Randy Dunlap 已提交
1173

1174
static void boot_delay_msec(int level)
R
Randy Dunlap 已提交
1175 1176 1177 1178
{
	unsigned long long k;
	unsigned long timeout;

1179
	if ((boot_delay == 0 || system_state != SYSTEM_BOOTING)
1180
		|| suppress_message_printing(level)) {
R
Randy Dunlap 已提交
1181
		return;
1182
	}
R
Randy Dunlap 已提交
1183

1184
	k = (unsigned long long)loops_per_msec * boot_delay;
R
Randy Dunlap 已提交
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200

	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
1201
static inline void boot_delay_msec(int level)
R
Randy Dunlap 已提交
1202 1203 1204 1205
{
}
#endif

A
Alex Elder 已提交
1206
static bool printk_time = IS_ENABLED(CONFIG_PRINTK_TIME);
1207 1208
module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);

1209 1210 1211 1212 1213 1214 1215
static size_t print_time(u64 ts, char *buf)
{
	unsigned long rem_nsec;

	if (!printk_time)
		return 0;

1216 1217
	rem_nsec = do_div(ts, 1000000000);

1218
	if (!buf)
1219
		return snprintf(NULL, 0, "[%5lu.000000] ", (unsigned long)ts);
1220 1221 1222 1223 1224

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

1225
static size_t print_prefix(const struct printk_log *msg, bool syslog, char *buf)
1226
{
1227
	size_t len = 0;
1228
	unsigned int prefix = (msg->facility << 3) | msg->level;
1229

1230 1231
	if (syslog) {
		if (buf) {
1232
			len += sprintf(buf, "<%u>", prefix);
1233 1234
		} else {
			len += 3;
1235 1236 1237 1238 1239
			if (prefix > 999)
				len += 3;
			else if (prefix > 99)
				len += 2;
			else if (prefix > 9)
1240 1241 1242
				len++;
		}
	}
1243

1244
	len += print_time(msg->ts_nsec, buf ? buf + len : NULL);
1245
	return len;
1246 1247
}

1248
static size_t msg_print_text(const struct printk_log *msg, bool syslog, char *buf, size_t size)
1249
{
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264
	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;
		}
1265

1266 1267
		if (buf) {
			if (print_prefix(msg, syslog, NULL) +
1268
			    text_len + 1 >= size - len)
1269
				break;
1270

1271
			len += print_prefix(msg, syslog, buf + len);
1272 1273
			memcpy(buf + len, text, text_len);
			len += text_len;
1274
			buf[len++] = '\n';
1275 1276
		} else {
			/* SYSLOG_ACTION_* buffer size only calculation */
1277
			len += print_prefix(msg, syslog, NULL);
1278
			len += text_len;
1279
			len++;
1280
		}
1281

1282 1283
		text = next;
	} while (text);
1284 1285 1286 1287 1288 1289 1290

	return len;
}

static int syslog_print(char __user *buf, int size)
{
	char *text;
1291
	struct printk_log *msg;
1292
	int len = 0;
1293

1294
	text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1295 1296 1297
	if (!text)
		return -ENOMEM;

1298 1299
	while (size > 0) {
		size_t n;
1300
		size_t skip;
1301

1302
		logbuf_lock_irq();
1303 1304 1305 1306
		if (syslog_seq < log_first_seq) {
			/* messages are gone, move to first one */
			syslog_seq = log_first_seq;
			syslog_idx = log_first_idx;
1307
			syslog_partial = 0;
1308 1309
		}
		if (syslog_seq == log_next_seq) {
1310
			logbuf_unlock_irq();
1311 1312
			break;
		}
1313 1314

		skip = syslog_partial;
1315
		msg = log_from_idx(syslog_idx);
1316
		n = msg_print_text(msg, true, text, LOG_LINE_MAX + PREFIX_MAX);
1317 1318
		if (n - syslog_partial <= size) {
			/* message fits into buffer, move forward */
1319 1320
			syslog_idx = log_next(syslog_idx);
			syslog_seq++;
1321 1322 1323 1324 1325 1326
			n -= syslog_partial;
			syslog_partial = 0;
		} else if (!len){
			/* partial read(), remember position */
			n = size;
			syslog_partial += n;
1327 1328
		} else
			n = 0;
1329
		logbuf_unlock_irq();
1330 1331 1332 1333

		if (!n)
			break;

1334
		if (copy_to_user(buf, text + skip, n)) {
1335 1336 1337 1338
			if (!len)
				len = -EFAULT;
			break;
		}
1339 1340 1341 1342

		len += n;
		size -= n;
		buf += n;
1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
	}

	kfree(text);
	return len;
}

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

1354
	text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1355 1356 1357
	if (!text)
		return -ENOMEM;

1358
	logbuf_lock_irq();
1359 1360 1361 1362 1363 1364 1365 1366
	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.
1367
		 */
1368 1369 1370
		seq = clear_seq;
		idx = clear_idx;
		while (seq < log_next_seq) {
1371
			struct printk_log *msg = log_from_idx(idx);
1372

1373
			len += msg_print_text(msg, true, NULL, 0);
1374 1375 1376
			idx = log_next(idx);
			seq++;
		}
1377 1378

		/* move first record forward until length fits into the buffer */
1379 1380 1381
		seq = clear_seq;
		idx = clear_idx;
		while (len > size && seq < log_next_seq) {
1382
			struct printk_log *msg = log_from_idx(idx);
1383

1384
			len -= msg_print_text(msg, true, NULL, 0);
1385 1386 1387 1388
			idx = log_next(idx);
			seq++;
		}

1389
		/* last message fitting into this dump */
1390 1391 1392 1393
		next_seq = log_next_seq;

		len = 0;
		while (len >= 0 && seq < next_seq) {
1394
			struct printk_log *msg = log_from_idx(idx);
1395 1396
			int textlen;

1397
			textlen = msg_print_text(msg, true, text,
1398
						 LOG_LINE_MAX + PREFIX_MAX);
1399 1400 1401 1402 1403 1404 1405
			if (textlen < 0) {
				len = textlen;
				break;
			}
			idx = log_next(idx);
			seq++;

1406
			logbuf_unlock_irq();
1407 1408 1409 1410
			if (copy_to_user(buf + len, text, textlen))
				len = -EFAULT;
			else
				len += textlen;
1411
			logbuf_lock_irq();
1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424

			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;
	}
1425
	logbuf_unlock_irq();
1426 1427 1428 1429 1430

	kfree(text);
	return len;
}

1431
int do_syslog(int type, char __user *buf, int len, int source)
L
Linus Torvalds 已提交
1432
{
1433
	bool clear = false;
1434
	static int saved_console_loglevel = LOGLEVEL_DEFAULT;
1435
	int error;
L
Linus Torvalds 已提交
1436

1437
	error = check_syslog_permissions(type, source);
1438 1439
	if (error)
		goto out;
1440

L
Linus Torvalds 已提交
1441
	switch (type) {
1442
	case SYSLOG_ACTION_CLOSE:	/* Close log */
L
Linus Torvalds 已提交
1443
		break;
1444
	case SYSLOG_ACTION_OPEN:	/* Open log */
L
Linus Torvalds 已提交
1445
		break;
1446
	case SYSLOG_ACTION_READ:	/* Read from log */
L
Linus Torvalds 已提交
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
		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 已提交
1457
		error = wait_event_interruptible(log_wait,
1458
						 syslog_seq != log_next_seq);
1459
		if (error)
L
Linus Torvalds 已提交
1460
			goto out;
1461
		error = syslog_print(buf, len);
L
Linus Torvalds 已提交
1462
		break;
1463 1464
	/* Read/clear last kernel messages */
	case SYSLOG_ACTION_READ_CLEAR:
1465
		clear = true;
L
Linus Torvalds 已提交
1466
		/* FALL THRU */
1467 1468
	/* Read last kernel messages */
	case SYSLOG_ACTION_READ_ALL:
L
Linus Torvalds 已提交
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478
		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;
		}
1479
		error = syslog_print_all(buf, len, clear);
L
Linus Torvalds 已提交
1480
		break;
1481 1482
	/* Clear ring buffer */
	case SYSLOG_ACTION_CLEAR:
1483
		syslog_print_all(NULL, 0, true);
1484
		break;
1485 1486
	/* Disable logging to console */
	case SYSLOG_ACTION_CONSOLE_OFF:
1487
		if (saved_console_loglevel == LOGLEVEL_DEFAULT)
1488
			saved_console_loglevel = console_loglevel;
L
Linus Torvalds 已提交
1489 1490
		console_loglevel = minimum_console_loglevel;
		break;
1491 1492
	/* Enable logging to console */
	case SYSLOG_ACTION_CONSOLE_ON:
1493
		if (saved_console_loglevel != LOGLEVEL_DEFAULT) {
1494
			console_loglevel = saved_console_loglevel;
1495
			saved_console_loglevel = LOGLEVEL_DEFAULT;
1496
		}
L
Linus Torvalds 已提交
1497
		break;
1498 1499
	/* Set level of messages printed to console */
	case SYSLOG_ACTION_CONSOLE_LEVEL:
L
Linus Torvalds 已提交
1500 1501 1502 1503 1504 1505
		error = -EINVAL;
		if (len < 1 || len > 8)
			goto out;
		if (len < minimum_console_loglevel)
			len = minimum_console_loglevel;
		console_loglevel = len;
1506
		/* Implicitly re-enable logging to console */
1507
		saved_console_loglevel = LOGLEVEL_DEFAULT;
L
Linus Torvalds 已提交
1508 1509
		error = 0;
		break;
1510 1511
	/* Number of chars in the log buffer */
	case SYSLOG_ACTION_SIZE_UNREAD:
1512
		logbuf_lock_irq();
1513 1514 1515 1516
		if (syslog_seq < log_first_seq) {
			/* messages are gone, move to first one */
			syslog_seq = log_first_seq;
			syslog_idx = log_first_idx;
1517
			syslog_partial = 0;
1518
		}
1519
		if (source == SYSLOG_FROM_PROC) {
1520 1521 1522 1523 1524
			/*
			 * Short-cut for poll(/"proc/kmsg") which simply checks
			 * for pending data, not the size; return the count of
			 * records, not the length.
			 */
1525
			error = log_next_seq - syslog_seq;
1526
		} else {
1527 1528
			u64 seq = syslog_seq;
			u32 idx = syslog_idx;
1529 1530 1531

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

1534
				error += msg_print_text(msg, true, NULL, 0);
1535 1536 1537
				idx = log_next(idx);
				seq++;
			}
1538
			error -= syslog_partial;
1539
		}
1540
		logbuf_unlock_irq();
L
Linus Torvalds 已提交
1541
		break;
1542 1543
	/* Size of the log buffer */
	case SYSLOG_ACTION_SIZE_BUFFER:
L
Linus Torvalds 已提交
1544 1545 1546 1547 1548 1549 1550 1551 1552 1553
		error = log_buf_len;
		break;
	default:
		error = -EINVAL;
		break;
	}
out:
	return error;
}

1554
SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
L
Linus Torvalds 已提交
1555
{
1556
	return do_syslog(type, buf, len, SYSLOG_FROM_READER);
L
Linus Torvalds 已提交
1557 1558 1559 1560 1561
}

/*
 * Call the console drivers, asking them to write out
 * log_buf[start] to log_buf[end - 1].
1562
 * The console_lock must be held.
L
Linus Torvalds 已提交
1563
 */
1564
static void call_console_drivers(const char *ext_text, size_t ext_len,
1565
				 const char *text, size_t len)
L
Linus Torvalds 已提交
1566
{
1567
	struct console *con;
L
Linus Torvalds 已提交
1568

1569
	trace_console_rcuidle(text, len);
1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583

	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;
1584 1585 1586 1587
		if (con->flags & CON_EXTENDED)
			con->write(con, ext_text, ext_len);
		else
			con->write(con, text, len);
1588
	}
L
Linus Torvalds 已提交
1589 1590
}

1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604
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();
		}
	}
}

1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616
/*
 * 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 已提交
1617
	u8 facility;			/* log facility of first message */
1618
	enum log_flags flags;		/* prefix, newline flags */
1619 1620
} cont;

1621
static void cont_flush(void)
1622 1623 1624
{
	if (cont.len == 0)
		return;
1625 1626 1627 1628

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

1631
static bool cont_add(int facility, int level, enum log_flags flags, const char *text, size_t len)
1632
{
1633 1634 1635 1636 1637 1638
	/*
	 * 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)) {
1639
		cont_flush();
1640 1641 1642 1643 1644 1645 1646 1647
		return false;
	}

	if (!cont.len) {
		cont.facility = facility;
		cont.level = level;
		cont.owner = current;
		cont.ts_nsec = local_clock();
1648
		cont.flags = flags;
1649 1650 1651 1652
	}

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

1654 1655 1656 1657 1658 1659 1660
	// 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();
	}

1661
	if (cont.len > (sizeof(cont.buf) * 80) / 100)
1662
		cont_flush();
1663

1664 1665 1666
	return true;
}

1667 1668 1669
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)
{
	/*
1670 1671
	 * If an earlier line was buffered, and we're a continuation
	 * write from the same process, try to add it to the buffer.
1672 1673
	 */
	if (cont.len) {
1674 1675 1676 1677 1678 1679 1680
		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();
	}
1681

1682 1683 1684 1685
	/* Skip empty continuation lines that couldn't be added - they just flush */
	if (!text_len && (lflags & LOG_CONT))
		return 0;

1686 1687 1688
	/* 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))
1689 1690 1691
			return text_len;
	}

1692
	/* Store it in the record log */
1693 1694 1695
	return log_store(facility, level, lflags, 0, dict, dictlen, text, text_len);
}

1696 1697 1698
asmlinkage int vprintk_emit(int facility, int level,
			    const char *dict, size_t dictlen,
			    const char *fmt, va_list args)
L
Linus Torvalds 已提交
1699
{
1700 1701
	static char textbuf[LOG_LINE_MAX];
	char *text = textbuf;
1702
	size_t text_len = 0;
1703
	enum log_flags lflags = 0;
1704
	unsigned long flags;
1705
	int printed_len = 0;
1706
	bool in_sched = false;
1707

1708 1709
	if (level == LOGLEVEL_SCHED) {
		level = LOGLEVEL_DEFAULT;
1710 1711
		in_sched = true;
	}
L
Linus Torvalds 已提交
1712

1713
	boot_delay_msec(level);
1714
	printk_delay();
R
Randy Dunlap 已提交
1715

1716
	/* This stops the holder of console_sem just where we want him */
1717
	logbuf_lock_irqsave(flags);
1718 1719 1720 1721
	/*
	 * The printf needs to come first; we need the syslog
	 * prefix which might be passed-in as a parameter.
	 */
1722
	text_len = vscnprintf(text, sizeof(textbuf), fmt, args);
1723

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

1730 1731
	/* strip kernel syslog prefix and extract log level or control flags */
	if (facility == 0) {
1732
		int kern_level;
1733

1734
		while ((kern_level = printk_get_level(text)) != 0) {
1735 1736
			switch (kern_level) {
			case '0' ... '7':
1737
				if (level == LOGLEVEL_DEFAULT)
1738
					level = kern_level - '0';
1739
				/* fallthrough */
1740 1741
			case 'd':	/* KERN_DEFAULT */
				lflags |= LOG_PREFIX;
1742 1743 1744
				break;
			case 'c':	/* KERN_CONT */
				lflags |= LOG_CONT;
1745
			}
1746 1747 1748

			text_len -= 2;
			text += 2;
1749 1750 1751
		}
	}

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

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

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

1760
	logbuf_unlock_irqrestore(flags);
1761

1762
	/* If called from the scheduler, we can not call up(). */
1763 1764 1765 1766 1767 1768
	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.
		 */
1769
		if (console_trylock())
1770 1771
			console_unlock();
	}
1772

L
Linus Torvalds 已提交
1773 1774
	return printed_len;
}
1775 1776 1777 1778
EXPORT_SYMBOL(vprintk_emit);

asmlinkage int vprintk(const char *fmt, va_list args)
{
1779
	return vprintk_func(fmt, args);
1780
}
L
Linus Torvalds 已提交
1781 1782
EXPORT_SYMBOL(vprintk);

1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797
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);

1798
int vprintk_default(const char *fmt, va_list args)
1799 1800 1801 1802
{
	int r;

#ifdef CONFIG_KGDB_KDB
1803 1804
	/* Allow to pass printk() to kdb but avoid a recursion. */
	if (unlikely(kdb_trap_printk && kdb_printf_cpu < 0)) {
1805
		r = vkdb_printf(KDB_MSGSRC_PRINTK, fmt, args);
1806 1807 1808
		return r;
	}
#endif
1809
	r = vprintk_emit(0, LOGLEVEL_DEFAULT, NULL, 0, fmt, args);
1810 1811 1812 1813 1814

	return r;
}
EXPORT_SYMBOL_GPL(vprintk_default);

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

	va_start(args, fmt);
1842
	r = vprintk_func(fmt, args);
1843 1844 1845 1846 1847
	va_end(args);

	return r;
}
EXPORT_SYMBOL(printk);
1848

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

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

1854 1855
static u64 syslog_seq;
static u32 syslog_idx;
1856 1857
static u64 console_seq;
static u32 console_idx;
1858 1859 1860
static u64 log_first_seq;
static u32 log_first_idx;
static u64 log_next_seq;
1861 1862
static char *log_text(const struct printk_log *msg) { return NULL; }
static char *log_dict(const struct printk_log *msg) { return NULL; }
1863
static struct printk_log *log_from_idx(u32 idx) { return NULL; }
1864
static u32 log_next(u32 idx) { return 0; }
1865
static ssize_t msg_print_ext_header(char *buf, size_t size,
1866 1867
				    struct printk_log *msg,
				    u64 seq) { return 0; }
1868 1869 1870
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; }
1871
static void call_console_drivers(const char *ext_text, size_t ext_len,
1872
				 const char *text, size_t len) {}
1873
static size_t msg_print_text(const struct printk_log *msg,
1874
			     bool syslog, char *buf, size_t size) { return 0; }
1875
static bool suppress_message_printing(int level) { return false; }
M
Matt Mackall 已提交
1876

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

1879 1880 1881
#ifdef CONFIG_EARLY_PRINTK
struct console *early_console;

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

	if (!early_console)
		return;
1890 1891

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

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

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

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

			/*
			 * Maintain an invariant that will help to find if
			 * the matching console is preferred, see
			 * register_console():
			 *
			 * The last non-braille console is always
			 * the preferred one.
			 */
			if (i != console_cmdline_cnt - 1)
				swap(console_cmdline[i],
				     console_cmdline[console_cmdline_cnt - 1]);

			preferred_console = console_cmdline_cnt - 1;

1928
			return 0;
1929
		}
1930
	}
1931 1932 1933
	if (i == MAX_CMDLINECONSOLES)
		return -E2BIG;
	if (!brl_options)
1934
		preferred_console = i;
1935 1936
	strlcpy(c->name, name, sizeof(c->name));
	c->options = options;
1937 1938
	braille_set_options(c, brl_options);

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

1953 1954
	if (_braille_console_setup(&str, &brl_options))
		return 1;
1955

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

1981
	__add_preferred_console(buf, idx, options, brl_options);
1982
	console_set_on_cmdline = 1;
1983 1984 1985 1986
	return 1;
}
__setup("console=", console_setup);

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

2005
bool console_suspend_enabled = true;
2006 2007 2008 2009
EXPORT_SYMBOL(console_suspend_enabled);

static int __init console_suspend_disable(char *str)
{
2010
	console_suspend_enabled = false;
2011 2012 2013
	return 1;
}
__setup("no_console_suspend", console_suspend_disable);
2014 2015 2016 2017
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");
2018

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

void resume_console(void)
{
2036 2037
	if (!console_suspend_enabled)
		return;
2038
	down_console_sem();
2039
	console_suspended = 0;
2040
	console_unlock();
2041 2042
}

2043 2044
/**
 * console_cpu_notify - print deferred console messages after CPU hotplug
2045
 * @cpu: unused
2046 2047
 *
 * If printk() is called from a CPU that is not online yet, the messages
2048 2049 2050
 * will be printed on the console only if there are CON_ANYTIME consoles.
 * This function is called when a new CPU comes online (or fails to come
 * up) or goes offline.
2051
 */
2052 2053
static int console_cpu_notify(unsigned int cpu)
{
2054
	if (!cpuhp_tasks_frozen) {
2055 2056 2057
		/* If trylock fails, someone else is doing the printing */
		if (console_trylock())
			console_unlock();
2058
	}
2059
	return 0;
2060 2061
}

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

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

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

int is_console_locked(void)
{
	return console_locked;
}

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

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

	return 0;
}

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

L
Linus Torvalds 已提交
2150
/**
2151
 * console_unlock - unlock the console system
L
Linus Torvalds 已提交
2152
 *
2153
 * Releases the console_lock which the caller holds on the console system
L
Linus Torvalds 已提交
2154 2155
 * and the console driver list.
 *
2156 2157 2158
 * 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 已提交
2159
 *
2160
 * If there is output waiting, we wake /dev/kmsg and syslog() users.
L
Linus Torvalds 已提交
2161
 *
2162
 * console_unlock(); may be called from any context.
L
Linus Torvalds 已提交
2163
 */
2164
void console_unlock(void)
L
Linus Torvalds 已提交
2165
{
2166
	static char ext_text[CONSOLE_EXT_LOG_MAX];
2167
	static char text[LOG_LINE_MAX + PREFIX_MAX];
2168
	static u64 seen_seq;
L
Linus Torvalds 已提交
2169
	unsigned long flags;
2170
	bool wake_klogd = false;
2171
	bool do_cond_resched, retry;
L
Linus Torvalds 已提交
2172

2173
	if (console_suspended) {
2174
		up_console_sem();
2175 2176
		return;
	}
2177

2178
	/*
2179
	 * Console drivers are called with interrupts disabled, so
2180 2181 2182 2183 2184 2185 2186
	 * @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.
2187 2188 2189 2190
	 *
	 * console_trylock() is not able to detect the preemptive
	 * context reliably. Therefore the value must be stored before
	 * and cleared after the the "again" goto label.
2191 2192
	 */
	do_cond_resched = console_may_schedule;
2193
again:
2194 2195
	console_may_schedule = 0;

2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206
	/*
	 * 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;
	}

2207
	for (;;) {
2208
		struct printk_log *msg;
2209
		size_t ext_len = 0;
2210
		size_t len;
2211

2212 2213
		printk_safe_enter_irqsave(flags);
		raw_spin_lock(&logbuf_lock);
2214 2215 2216 2217 2218 2219
		if (seen_seq != log_next_seq) {
			wake_klogd = true;
			seen_seq = log_next_seq;
		}

		if (console_seq < log_first_seq) {
2220 2221 2222
			len = sprintf(text, "** %u printk messages dropped ** ",
				      (unsigned)(log_first_seq - console_seq));

2223 2224 2225
			/* messages are gone, move to first one */
			console_seq = log_first_seq;
			console_idx = log_first_idx;
2226 2227
		} else {
			len = 0;
2228
		}
2229
skip:
2230 2231 2232 2233
		if (console_seq == log_next_seq)
			break;

		msg = log_from_idx(console_idx);
2234
		if (suppress_message_printing(msg->level)) {
2235 2236
			/*
			 * Skip record we have buffered and already printed
2237 2238
			 * directly to the console when we received it, and
			 * record that has level above the console loglevel.
2239 2240 2241 2242 2243
			 */
			console_idx = log_next(console_idx);
			console_seq++;
			goto skip;
		}
2244

2245
		len += msg_print_text(msg, false, text + len, sizeof(text) - len);
2246 2247 2248
		if (nr_ext_console_drivers) {
			ext_len = msg_print_ext_header(ext_text,
						sizeof(ext_text),
2249
						msg, console_seq);
2250 2251 2252 2253 2254
			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);
		}
2255 2256
		console_idx = log_next(console_idx);
		console_seq++;
2257
		raw_spin_unlock(&logbuf_lock);
2258

2259
		stop_critical_timings();	/* don't trace print latency */
2260
		call_console_drivers(ext_text, ext_len, text, len);
2261
		start_critical_timings();
2262
		printk_safe_exit_irqrestore(flags);
2263 2264 2265

		if (do_cond_resched)
			cond_resched();
L
Linus Torvalds 已提交
2266 2267
	}
	console_locked = 0;
2268 2269 2270 2271 2272

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

2273
	raw_spin_unlock(&logbuf_lock);
2274

2275
	up_console_sem();
2276 2277 2278 2279 2280 2281 2282

	/*
	 * 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.
	 */
2283
	raw_spin_lock(&logbuf_lock);
2284
	retry = console_seq != log_next_seq;
2285 2286
	raw_spin_unlock(&logbuf_lock);
	printk_safe_exit_irqrestore(flags);
P
Peter Zijlstra 已提交
2287

2288 2289 2290
	if (retry && console_trylock())
		goto again;

2291 2292
	if (wake_klogd)
		wake_up_klogd();
L
Linus Torvalds 已提交
2293
}
2294
EXPORT_SYMBOL(console_unlock);
L
Linus Torvalds 已提交
2295

2296 2297
/**
 * console_conditional_schedule - yield the CPU if required
L
Linus Torvalds 已提交
2298 2299 2300 2301 2302
 *
 * If the console code is currently allowed to sleep, and
 * if this CPU should yield the CPU to another task, do
 * so here.
 *
2303
 * Must be called within console_lock();.
L
Linus Torvalds 已提交
2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320
 */
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) {
2321
		if (down_trylock_console_sem() != 0)
L
Linus Torvalds 已提交
2322 2323
			return;
	} else
2324
		console_lock();
L
Linus Torvalds 已提交
2325 2326 2327

	console_locked = 1;
	console_may_schedule = 0;
2328
	for_each_console(c)
L
Linus Torvalds 已提交
2329 2330
		if ((c->flags & CON_ENABLED) && c->unblank)
			c->unblank();
2331
	console_unlock();
L
Linus Torvalds 已提交
2332 2333
}

2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352
/**
 * 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 已提交
2353 2354 2355 2356 2357 2358 2359 2360
/*
 * 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;

2361
	console_lock();
2362
	for_each_console(c) {
L
Linus Torvalds 已提交
2363 2364 2365 2366 2367 2368
		if (!c->device)
			continue;
		driver = c->device(c, index);
		if (driver)
			break;
	}
2369
	console_unlock();
L
Linus Torvalds 已提交
2370 2371 2372 2373 2374 2375 2376 2377 2378 2379
	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)
{
2380
	console_lock();
L
Linus Torvalds 已提交
2381
	console->flags &= ~CON_ENABLED;
2382
	console_unlock();
L
Linus Torvalds 已提交
2383 2384 2385 2386 2387
}
EXPORT_SYMBOL(console_stop);

void console_start(struct console *console)
{
2388
	console_lock();
L
Linus Torvalds 已提交
2389
	console->flags |= CON_ENABLED;
2390
	console_unlock();
L
Linus Torvalds 已提交
2391 2392 2393
}
EXPORT_SYMBOL(console_start);

2394 2395 2396 2397 2398
static int __read_mostly keep_bootcon;

static int __init keep_bootcon_setup(char *str)
{
	keep_bootcon = 1;
2399
	pr_info("debug: skip boot console de-registration.\n");
2400 2401 2402 2403 2404 2405

	return 0;
}

early_param("keep_bootcon", keep_bootcon_setup);

L
Linus Torvalds 已提交
2406 2407 2408 2409 2410
/*
 * 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.
2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423
 *
 * 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 已提交
2424
 */
2425
void register_console(struct console *newcon)
L
Linus Torvalds 已提交
2426
{
J
Jesper Juhl 已提交
2427
	int i;
L
Linus Torvalds 已提交
2428
	unsigned long flags;
2429
	struct console *bcon = NULL;
2430
	struct console_cmdline *c;
2431
	static bool has_preferred;
L
Linus Torvalds 已提交
2432

2433 2434 2435 2436 2437 2438 2439
	if (console_drivers)
		for_each_console(bcon)
			if (WARN(bcon == newcon,
					"console '%s%d' already registered\n",
					bcon->name, bcon->index))
				return;

2440 2441 2442 2443 2444 2445 2446 2447
	/*
	 * 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)) {
2448
				pr_info("Too late to register bootconsole %s%d\n",
2449 2450 2451 2452
					newcon->name, newcon->index);
				return;
			}
		}
2453 2454
	}

2455 2456 2457
	if (console_drivers && console_drivers->flags & CON_BOOT)
		bcon = console_drivers;

2458
	if (!has_preferred || bcon || !console_drivers)
2459
		has_preferred = preferred_console >= 0;
L
Linus Torvalds 已提交
2460 2461 2462 2463 2464 2465

	/*
	 *	See if we want to use this console driver. If we
	 *	didn't select a console we take the first one
	 *	that registers here.
	 */
2466
	if (!has_preferred) {
2467 2468 2469 2470 2471 2472 2473
		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;
2474
				has_preferred = true;
2475
			}
L
Linus Torvalds 已提交
2476 2477 2478 2479
		}
	}

	/*
2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492
	 * See if this console matches one we selected on the command line.
	 *
	 * There may be several entries in the console_cmdline array matching
	 * with the same console, one with newcon->match(), another by
	 * name/index:
	 *
	 *	pl011,mmio,0x87e024000000,115200 -- added from SPCR
	 *	ttyAMA0 -- added from command line
	 *
	 * Traverse the console_cmdline array in reverse order to be
	 * sure that if this console is preferred then it will be the first
	 * matching entry.  We use the invariant that is maintained in
	 * __add_preferred_console().
L
Linus Torvalds 已提交
2493
	 */
2494 2495 2496
	for (i = console_cmdline_cnt - 1; i >= 0; i--) {
		c = console_cmdline + i;

2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507
		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;
2508

2509 2510 2511 2512 2513 2514 2515
			if (_braille_register_console(newcon, c))
				return;

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

2517
		newcon->flags |= CON_ENABLED;
2518
		if (i == preferred_console) {
2519
			newcon->flags |= CON_CONSDEV;
2520
			has_preferred = true;
2521
		}
L
Linus Torvalds 已提交
2522 2523 2524
		break;
	}

2525
	if (!(newcon->flags & CON_ENABLED))
L
Linus Torvalds 已提交
2526 2527
		return;

2528 2529 2530 2531 2532 2533 2534
	/*
	 * 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))
2535
		newcon->flags &= ~CON_PRINTBUFFER;
L
Linus Torvalds 已提交
2536 2537 2538 2539 2540

	/*
	 *	Put this console in the list - keep the
	 *	preferred driver at the head of the list.
	 */
2541
	console_lock();
2542 2543 2544 2545 2546
	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 已提交
2547
	} else {
2548 2549
		newcon->next = console_drivers->next;
		console_drivers->next = newcon;
L
Linus Torvalds 已提交
2550
	}
2551 2552 2553 2554 2555

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

2556
	if (newcon->flags & CON_PRINTBUFFER) {
L
Linus Torvalds 已提交
2557
		/*
2558
		 * console_unlock(); will print out the buffered messages
L
Linus Torvalds 已提交
2559 2560
		 * for us.
		 */
2561
		logbuf_lock_irqsave(flags);
2562 2563
		console_seq = syslog_seq;
		console_idx = syslog_idx;
2564
		logbuf_unlock_irqrestore(flags);
2565 2566 2567 2568 2569 2570
		/*
		 * 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 已提交
2571
	}
2572
	console_unlock();
2573
	console_sysfs_notify();
2574 2575 2576 2577 2578 2579 2580 2581

	/*
	 * 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)
	 */
2582
	pr_info("%sconsole [%s%d] enabled\n",
2583 2584
		(newcon->flags & CON_BOOT) ? "boot" : "" ,
		newcon->name, newcon->index);
2585 2586 2587
	if (bcon &&
	    ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
	    !keep_bootcon) {
2588 2589
		/* We need to iterate through all boot consoles, to make
		 * sure we print everything out, before we unregister them.
2590 2591 2592 2593 2594
		 */
		for_each_console(bcon)
			if (bcon->flags & CON_BOOT)
				unregister_console(bcon);
	}
L
Linus Torvalds 已提交
2595 2596 2597
}
EXPORT_SYMBOL(register_console);

J
Jesper Juhl 已提交
2598
int unregister_console(struct console *console)
L
Linus Torvalds 已提交
2599
{
J
Jesper Juhl 已提交
2600
        struct console *a, *b;
2601
	int res;
L
Linus Torvalds 已提交
2602

2603
	pr_info("%sconsole [%s%d] disabled\n",
2604 2605 2606
		(console->flags & CON_BOOT) ? "boot" : "" ,
		console->name, console->index);

2607 2608 2609
	res = _braille_unregister_console(console);
	if (res)
		return res;
2610

2611
	res = 1;
2612
	console_lock();
L
Linus Torvalds 已提交
2613 2614 2615
	if (console_drivers == console) {
		console_drivers=console->next;
		res = 0;
2616
	} else if (console_drivers) {
L
Linus Torvalds 已提交
2617 2618 2619 2620 2621 2622
		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 已提交
2623
			}
L
Linus Torvalds 已提交
2624 2625
		}
	}
J
Jesper Juhl 已提交
2626

2627 2628 2629
	if (!res && (console->flags & CON_EXTENDED))
		nr_ext_console_drivers--;

2630
	/*
2631 2632
	 * 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 已提交
2633
	 */
2634
	if (console_drivers != NULL && console->flags & CON_CONSDEV)
2635
		console_drivers->flags |= CON_CONSDEV;
L
Linus Torvalds 已提交
2636

2637
	console->flags &= ~CON_ENABLED;
2638
	console_unlock();
2639
	console_sysfs_notify();
L
Linus Torvalds 已提交
2640 2641 2642
	return res;
}
EXPORT_SYMBOL(unregister_console);
M
Matt Mackall 已提交
2643

2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658
/*
 * 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.
 */
2659
static int __init printk_late_init(void)
2660
{
2661
	struct console *con;
2662
	int ret;
2663 2664

	for_each_console(con) {
2665
		if (!keep_bootcon && con->flags & CON_BOOT) {
2666 2667 2668 2669 2670 2671 2672 2673 2674
			/*
			 * 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);
2675
		}
2676
	}
2677 2678 2679 2680 2681 2682
	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);
2683 2684
	return 0;
}
2685
late_initcall(printk_late_init);
2686

2687
#if defined CONFIG_PRINTK
2688 2689 2690 2691
/*
 * Delayed printk version, for scheduler-internal messages:
 */
#define PRINTK_PENDING_WAKEUP	0x01
2692
#define PRINTK_PENDING_OUTPUT	0x02
2693 2694 2695 2696 2697 2698 2699

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

2700 2701 2702 2703
	if (pending & PRINTK_PENDING_OUTPUT) {
		/* If trylock fails, someone else is doing the printing */
		if (console_trylock())
			console_unlock();
2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719
	}

	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);
2720
		irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2721 2722 2723
	}
	preempt_enable();
}
D
Dave Young 已提交
2724

2725
int printk_deferred(const char *fmt, ...)
2726 2727 2728 2729
{
	va_list args;
	int r;

2730
	preempt_disable();
2731
	va_start(args, fmt);
2732
	r = vprintk_emit(0, LOGLEVEL_SCHED, NULL, 0, fmt, args);
2733 2734
	va_end(args);

2735
	__this_cpu_or(printk_pending, PRINTK_PENDING_OUTPUT);
2736
	irq_work_queue(this_cpu_ptr(&wake_up_klogd_work));
2737
	preempt_enable();
2738 2739 2740 2741

	return r;
}

L
Linus Torvalds 已提交
2742 2743 2744
/*
 * printk rate limiting, lifted from the networking subsystem.
 *
2745 2746
 * This enforces a rate limit: not more than 10 kernel messages
 * every 5s to make a denial-of-service attack impossible.
L
Linus Torvalds 已提交
2747
 */
2748 2749
DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);

2750
int __printk_ratelimit(const char *func)
L
Linus Torvalds 已提交
2751
{
2752
	return ___ratelimit(&printk_ratelimit_state, func);
L
Linus Torvalds 已提交
2753
}
2754
EXPORT_SYMBOL(__printk_ratelimit);
2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767

/**
 * 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 已提交
2768 2769 2770 2771 2772 2773 2774
	unsigned long elapsed = jiffies - *caller_jiffies;

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

	*caller_jiffies = jiffies;
	return true;
2775 2776
}
EXPORT_SYMBOL(printk_timed_ratelimit);
2777 2778 2779 2780 2781 2782

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

/**
 * kmsg_dump_register - register a kernel log dumper.
R
Randy Dunlap 已提交
2783
 * @dumper: pointer to the kmsg_dumper structure
2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801
 *
 * 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;
2802
		list_add_tail_rcu(&dumper->list, &dump_list);
2803 2804 2805 2806 2807 2808 2809 2810 2811 2812
		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 已提交
2813
 * @dumper: pointer to the kmsg_dumper structure
2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825
 *
 * 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;
2826
		list_del_rcu(&dumper->list);
2827 2828 2829
		err = 0;
	}
	spin_unlock_irqrestore(&dump_list_lock, flags);
2830
	synchronize_rcu();
2831 2832 2833 2834 2835

	return err;
}
EXPORT_SYMBOL_GPL(kmsg_dump_unregister);

2836 2837 2838
static bool always_kmsg_dump;
module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);

2839 2840 2841 2842
/**
 * kmsg_dump - dump kernel log to kernel message dumpers.
 * @reason: the reason (oops, panic etc) for dumping
 *
2843 2844 2845
 * 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().
2846 2847 2848 2849 2850 2851
 */
void kmsg_dump(enum kmsg_dump_reason reason)
{
	struct kmsg_dumper *dumper;
	unsigned long flags;

2852 2853 2854
	if ((reason > KMSG_DUMP_OOPS) && !always_kmsg_dump)
		return;

2855 2856 2857 2858 2859 2860 2861 2862
	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;

2863
		logbuf_lock_irqsave(flags);
2864 2865 2866 2867
		dumper->cur_seq = clear_seq;
		dumper->cur_idx = clear_idx;
		dumper->next_seq = log_next_seq;
		dumper->next_idx = log_next_idx;
2868
		logbuf_unlock_irqrestore(flags);
2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879

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

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

/**
2880
 * kmsg_dump_get_line_nolock - retrieve one kmsg log line (unlocked version)
2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894
 * @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.
2895 2896
 *
 * The function is similar to kmsg_dump_get_line(), but grabs no locks.
2897
 */
2898 2899
bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper, bool syslog,
			       char *line, size_t size, size_t *len)
2900
{
2901
	struct printk_log *msg;
2902 2903 2904 2905 2906
	size_t l = 0;
	bool ret = false;

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

2908 2909 2910 2911 2912
	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;
	}
2913

2914
	/* last entry */
2915
	if (dumper->cur_seq >= log_next_seq)
2916
		goto out;
2917

2918
	msg = log_from_idx(dumper->cur_idx);
2919
	l = msg_print_text(msg, syslog, line, size);
2920 2921 2922 2923 2924 2925 2926 2927 2928

	dumper->cur_idx = log_next(dumper->cur_idx);
	dumper->cur_seq++;
	ret = true;
out:
	if (len)
		*len = l;
	return ret;
}
2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952

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

2953
	logbuf_lock_irqsave(flags);
2954
	ret = kmsg_dump_get_line_nolock(dumper, syslog, line, size, len);
2955
	logbuf_unlock_irqrestore(flags);
2956 2957 2958

	return ret;
}
2959 2960 2961 2962 2963 2964
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 已提交
2965
 * @buf: buffer to copy the line to
2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993
 * @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;

2994
	logbuf_lock_irqsave(flags);
2995 2996 2997 2998 2999 3000 3001 3002
	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) {
3003
		logbuf_unlock_irqrestore(flags);
3004 3005 3006 3007 3008 3009 3010
		goto out;
	}

	/* calculate length of entire buffer */
	seq = dumper->cur_seq;
	idx = dumper->cur_idx;
	while (seq < dumper->next_seq) {
3011
		struct printk_log *msg = log_from_idx(idx);
3012

3013
		l += msg_print_text(msg, true, NULL, 0);
3014 3015 3016 3017 3018 3019 3020 3021
		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) {
3022
		struct printk_log *msg = log_from_idx(idx);
3023

3024
		l -= msg_print_text(msg, true, NULL, 0);
3025 3026
		idx = log_next(idx);
		seq++;
3027
	}
3028 3029 3030 3031 3032 3033 3034

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

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

3037
		l += msg_print_text(msg, syslog, buf + l, size - l);
3038 3039 3040 3041 3042 3043 3044
		idx = log_next(idx);
		seq++;
	}

	dumper->next_seq = next_seq;
	dumper->next_idx = next_idx;
	ret = true;
3045
	logbuf_unlock_irqrestore(flags);
3046 3047 3048 3049 3050 3051
out:
	if (len)
		*len = l;
	return ret;
}
EXPORT_SYMBOL_GPL(kmsg_dump_get_buffer);
3052

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

3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082
/**
 * 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;

3083
	logbuf_lock_irqsave(flags);
3084
	kmsg_dump_rewind_nolock(dumper);
3085
	logbuf_unlock_irqrestore(flags);
3086
}
3087
EXPORT_SYMBOL_GPL(kmsg_dump_rewind);
3088

3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110
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);
}

3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124
/**
 * 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);
3125 3126 3127 3128

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

	print_worker_info(log_lvl, current);
3131 3132
}

3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143
/**
 * 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);

3144 3145
	printk("%stask: %p task.stack: %p\n",
	       log_lvl, current, task_stack_page(current));
3146 3147
}

3148
#endif