1 /*
2  *  linux/kernel/printk.c
3  *
4  *  Copyright (C) 1991, 1992  Linus Torvalds
5  *
6  * Modified to make sys_syslog() more flexible: added commands to
7  * return the last 4k of kernel messages, regardless of whether
8  * they've been read or not.  Added option to suppress kernel printk's
9  * to the console.  Added hook for sending the console messages
10  * elsewhere, in preparation for a serial line console (someday).
11  * Ted Ts'o, 2/11/93.
12  * Modified for sysctl support, 1/8/97, Chris Horn.
13  * Fixed SMP synchronization, 08/08/99, Manfred Spraul
14  *     manfred@colorfullife.com
15  * Rewrote bits to get rid of console_lock
16  *	01Mar01 Andrew Morton
17  */
18 
19 #include <linux/kernel.h>
20 #include <linux/mm.h>
21 #include <linux/tty.h>
22 #include <linux/tty_driver.h>
23 #include <linux/console.h>
24 #include <linux/init.h>
25 #include <linux/jiffies.h>
26 #include <linux/nmi.h>
27 #include <linux/module.h>
28 #include <linux/moduleparam.h>
29 #include <linux/interrupt.h>			/* For in_interrupt() */
30 #include <linux/delay.h>
31 #include <linux/smp.h>
32 #include <linux/security.h>
33 #include <linux/bootmem.h>
34 #include <linux/memblock.h>
35 #include <linux/syscalls.h>
36 #include <linux/kexec.h>
37 #include <linux/kdb.h>
38 #include <linux/ratelimit.h>
39 #include <linux/kmsg_dump.h>
40 #include <linux/syslog.h>
41 #include <linux/cpu.h>
42 #include <linux/notifier.h>
43 #include <linux/rculist.h>
44 
45 #include <asm/uaccess.h>
46 
47 /*
48  * Architectures can override it:
49  */
early_printk(const char * fmt,...)50 void asmlinkage __attribute__((weak)) early_printk(const char *fmt, ...)
51 {
52 }
53 
54 #define __LOG_BUF_LEN	(1 << CONFIG_LOG_BUF_SHIFT)
55 
56 /* printk's without a loglevel use this.. */
57 #define DEFAULT_MESSAGE_LOGLEVEL CONFIG_DEFAULT_MESSAGE_LOGLEVEL
58 
59 /* We show everything that is MORE important than this.. */
60 #define MINIMUM_CONSOLE_LOGLEVEL 1 /* Minimum loglevel we let people use */
61 #define DEFAULT_CONSOLE_LOGLEVEL 7 /* anything MORE serious than KERN_DEBUG */
62 
63 DECLARE_WAIT_QUEUE_HEAD(log_wait);
64 
65 int console_printk[4] = {
66 	DEFAULT_CONSOLE_LOGLEVEL,	/* console_loglevel */
67 	DEFAULT_MESSAGE_LOGLEVEL,	/* default_message_loglevel */
68 	MINIMUM_CONSOLE_LOGLEVEL,	/* minimum_console_loglevel */
69 	DEFAULT_CONSOLE_LOGLEVEL,	/* default_console_loglevel */
70 };
71 
72 /*
73  * Low level drivers may need that to know if they can schedule in
74  * their unblank() callback or not. So let's export it.
75  */
76 int oops_in_progress;
77 EXPORT_SYMBOL(oops_in_progress);
78 
79 /*
80  * console_sem protects the console_drivers list, and also
81  * provides serialisation for access to the entire console
82  * driver system.
83  */
84 static DEFINE_SEMAPHORE(console_sem);
85 struct console *console_drivers;
86 EXPORT_SYMBOL_GPL(console_drivers);
87 
88 /*
89  * This is used for debugging the mess that is the VT code by
90  * keeping track if we have the console semaphore held. It's
91  * definitely not the perfect debug tool (we don't know if _WE_
92  * hold it are racing, but it helps tracking those weird code
93  * path in the console code where we end up in places I want
94  * locked without the console sempahore held
95  */
96 static int console_locked, console_suspended;
97 
98 /*
99  * logbuf_lock protects log_buf, log_start, log_end, con_start and logged_chars
100  * It is also used in interesting ways to provide interlocking in
101  * console_unlock();.
102  */
103 static DEFINE_RAW_SPINLOCK(logbuf_lock);
104 
105 #define LOG_BUF_MASK (log_buf_len-1)
106 #define LOG_BUF(idx) (log_buf[(idx) & LOG_BUF_MASK])
107 
108 /*
109  * The indices into log_buf are not constrained to log_buf_len - they
110  * must be masked before subscripting
111  */
112 static unsigned log_start;	/* Index into log_buf: next char to be read by syslog() */
113 static unsigned con_start;	/* Index into log_buf: next char to be sent to consoles */
114 static unsigned log_end;	/* Index into log_buf: most-recently-written-char + 1 */
115 
116 /*
117  * If exclusive_console is non-NULL then only this console is to be printed to.
118  */
119 static struct console *exclusive_console;
120 
121 /*
122  *	Array of consoles built from command line options (console=)
123  */
124 struct console_cmdline
125 {
126 	char	name[8];			/* Name of the driver	    */
127 	int	index;				/* Minor dev. to use	    */
128 	char	*options;			/* Options for the driver   */
129 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
130 	char	*brl_options;			/* Options for braille driver */
131 #endif
132 };
133 
134 #define MAX_CMDLINECONSOLES 8
135 
136 static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
137 static int selected_console = -1;
138 static int preferred_console = -1;
139 int console_set_on_cmdline;
140 EXPORT_SYMBOL(console_set_on_cmdline);
141 
142 /* Flag: console code may call schedule() */
143 static int console_may_schedule;
144 
145 #ifdef CONFIG_PRINTK
146 
147 static char __log_buf[__LOG_BUF_LEN];
148 static char *log_buf = __log_buf;
149 static int log_buf_len = __LOG_BUF_LEN;
150 static unsigned logged_chars; /* Number of chars produced since last read+clear operation */
151 static int saved_console_loglevel = -1;
152 
153 #ifdef CONFIG_KEXEC
154 /*
155  * This appends the listed symbols to /proc/vmcoreinfo
156  *
157  * /proc/vmcoreinfo is used by various utiilties, like crash and makedumpfile to
158  * obtain access to symbols that are otherwise very difficult to locate.  These
159  * symbols are specifically used so that utilities can access and extract the
160  * dmesg log from a vmcore file after a crash.
161  */
log_buf_kexec_setup(void)162 void log_buf_kexec_setup(void)
163 {
164 	VMCOREINFO_SYMBOL(log_buf);
165 	VMCOREINFO_SYMBOL(log_end);
166 	VMCOREINFO_SYMBOL(log_buf_len);
167 	VMCOREINFO_SYMBOL(logged_chars);
168 }
169 #endif
170 
171 /* requested log_buf_len from kernel cmdline */
172 static unsigned long __initdata new_log_buf_len;
173 
174 /* save requested log_buf_len since it's too early to process it */
log_buf_len_setup(char * str)175 static int __init log_buf_len_setup(char *str)
176 {
177 	unsigned size = memparse(str, &str);
178 
179 	if (size)
180 		size = roundup_pow_of_two(size);
181 	if (size > log_buf_len)
182 		new_log_buf_len = size;
183 
184 	return 0;
185 }
186 early_param("log_buf_len", log_buf_len_setup);
187 
setup_log_buf(int early)188 void __init setup_log_buf(int early)
189 {
190 	unsigned long flags;
191 	unsigned start, dest_idx, offset;
192 	char *new_log_buf;
193 	int free;
194 
195 	if (!new_log_buf_len)
196 		return;
197 
198 	if (early) {
199 		unsigned long mem;
200 
201 		mem = memblock_alloc(new_log_buf_len, PAGE_SIZE);
202 		if (!mem)
203 			return;
204 		new_log_buf = __va(mem);
205 	} else {
206 		new_log_buf = alloc_bootmem_nopanic(new_log_buf_len);
207 	}
208 
209 	if (unlikely(!new_log_buf)) {
210 		pr_err("log_buf_len: %ld bytes not available\n",
211 			new_log_buf_len);
212 		return;
213 	}
214 
215 	raw_spin_lock_irqsave(&logbuf_lock, flags);
216 	log_buf_len = new_log_buf_len;
217 	log_buf = new_log_buf;
218 	new_log_buf_len = 0;
219 	free = __LOG_BUF_LEN - log_end;
220 
221 	offset = start = min(con_start, log_start);
222 	dest_idx = 0;
223 	while (start != log_end) {
224 		unsigned log_idx_mask = start & (__LOG_BUF_LEN - 1);
225 
226 		log_buf[dest_idx] = __log_buf[log_idx_mask];
227 		start++;
228 		dest_idx++;
229 	}
230 	log_start -= offset;
231 	con_start -= offset;
232 	log_end -= offset;
233 	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
234 
235 	pr_info("log_buf_len: %d\n", log_buf_len);
236 	pr_info("early log buf free: %d(%d%%)\n",
237 		free, (free * 100) / __LOG_BUF_LEN);
238 }
239 
240 #ifdef CONFIG_BOOT_PRINTK_DELAY
241 
242 static int boot_delay; /* msecs delay after each printk during bootup */
243 static unsigned long long loops_per_msec;	/* based on boot_delay */
244 
boot_delay_setup(char * str)245 static int __init boot_delay_setup(char *str)
246 {
247 	unsigned long lpj;
248 
249 	lpj = preset_lpj ? preset_lpj : 1000000;	/* some guess */
250 	loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
251 
252 	get_option(&str, &boot_delay);
253 	if (boot_delay > 10 * 1000)
254 		boot_delay = 0;
255 
256 	pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
257 		"HZ: %d, loops_per_msec: %llu\n",
258 		boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
259 	return 1;
260 }
261 __setup("boot_delay=", boot_delay_setup);
262 
boot_delay_msec(void)263 static void boot_delay_msec(void)
264 {
265 	unsigned long long k;
266 	unsigned long timeout;
267 
268 	if (boot_delay == 0 || system_state != SYSTEM_BOOTING)
269 		return;
270 
271 	k = (unsigned long long)loops_per_msec * boot_delay;
272 
273 	timeout = jiffies + msecs_to_jiffies(boot_delay);
274 	while (k) {
275 		k--;
276 		cpu_relax();
277 		/*
278 		 * use (volatile) jiffies to prevent
279 		 * compiler reduction; loop termination via jiffies
280 		 * is secondary and may or may not happen.
281 		 */
282 		if (time_after(jiffies, timeout))
283 			break;
284 		touch_nmi_watchdog();
285 	}
286 }
287 #else
boot_delay_msec(void)288 static inline void boot_delay_msec(void)
289 {
290 }
291 #endif
292 
293 #ifdef CONFIG_SECURITY_DMESG_RESTRICT
294 int dmesg_restrict = 1;
295 #else
296 int dmesg_restrict;
297 #endif
298 
syslog_action_restricted(int type)299 static int syslog_action_restricted(int type)
300 {
301 	if (dmesg_restrict)
302 		return 1;
303 	/* Unless restricted, we allow "read all" and "get buffer size" for everybody */
304 	return type != SYSLOG_ACTION_READ_ALL && type != SYSLOG_ACTION_SIZE_BUFFER;
305 }
306 
check_syslog_permissions(int type,bool from_file)307 static int check_syslog_permissions(int type, bool from_file)
308 {
309 	/*
310 	 * If this is from /proc/kmsg and we've already opened it, then we've
311 	 * already done the capabilities checks at open time.
312 	 */
313 	if (from_file && type != SYSLOG_ACTION_OPEN)
314 		return 0;
315 
316 	if (syslog_action_restricted(type)) {
317 		if (capable(CAP_SYSLOG))
318 			return 0;
319 		/* For historical reasons, accept CAP_SYS_ADMIN too, with a warning */
320 		if (capable(CAP_SYS_ADMIN)) {
321 			printk_once(KERN_WARNING "%s (%d): "
322 				 "Attempt to access syslog with CAP_SYS_ADMIN "
323 				 "but no CAP_SYSLOG (deprecated).\n",
324 				 current->comm, task_pid_nr(current));
325 			return 0;
326 		}
327 		return -EPERM;
328 	}
329 	return 0;
330 }
331 
do_syslog(int type,char __user * buf,int len,bool from_file)332 int do_syslog(int type, char __user *buf, int len, bool from_file)
333 {
334 	unsigned i, j, limit, count;
335 	int do_clear = 0;
336 	char c;
337 	int error;
338 
339 	error = check_syslog_permissions(type, from_file);
340 	if (error)
341 		goto out;
342 
343 	error = security_syslog(type);
344 	if (error)
345 		return error;
346 
347 	switch (type) {
348 	case SYSLOG_ACTION_CLOSE:	/* Close log */
349 		break;
350 	case SYSLOG_ACTION_OPEN:	/* Open log */
351 		break;
352 	case SYSLOG_ACTION_READ:	/* Read from log */
353 		error = -EINVAL;
354 		if (!buf || len < 0)
355 			goto out;
356 		error = 0;
357 		if (!len)
358 			goto out;
359 		if (!access_ok(VERIFY_WRITE, buf, len)) {
360 			error = -EFAULT;
361 			goto out;
362 		}
363 		error = wait_event_interruptible(log_wait,
364 							(log_start - log_end));
365 		if (error)
366 			goto out;
367 		i = 0;
368 		raw_spin_lock_irq(&logbuf_lock);
369 		while (!error && (log_start != log_end) && i < len) {
370 			c = LOG_BUF(log_start);
371 			log_start++;
372 			raw_spin_unlock_irq(&logbuf_lock);
373 			error = __put_user(c,buf);
374 			buf++;
375 			i++;
376 			cond_resched();
377 			raw_spin_lock_irq(&logbuf_lock);
378 		}
379 		raw_spin_unlock_irq(&logbuf_lock);
380 		if (!error)
381 			error = i;
382 		break;
383 	/* Read/clear last kernel messages */
384 	case SYSLOG_ACTION_READ_CLEAR:
385 		do_clear = 1;
386 		/* FALL THRU */
387 	/* Read last kernel messages */
388 	case SYSLOG_ACTION_READ_ALL:
389 		error = -EINVAL;
390 		if (!buf || len < 0)
391 			goto out;
392 		error = 0;
393 		if (!len)
394 			goto out;
395 		if (!access_ok(VERIFY_WRITE, buf, len)) {
396 			error = -EFAULT;
397 			goto out;
398 		}
399 		count = len;
400 		if (count > log_buf_len)
401 			count = log_buf_len;
402 		raw_spin_lock_irq(&logbuf_lock);
403 		if (count > logged_chars)
404 			count = logged_chars;
405 		if (do_clear)
406 			logged_chars = 0;
407 		limit = log_end;
408 		/*
409 		 * __put_user() could sleep, and while we sleep
410 		 * printk() could overwrite the messages
411 		 * we try to copy to user space. Therefore
412 		 * the messages are copied in reverse. <manfreds>
413 		 */
414 		for (i = 0; i < count && !error; i++) {
415 			j = limit-1-i;
416 			if (j + log_buf_len < log_end)
417 				break;
418 			c = LOG_BUF(j);
419 			raw_spin_unlock_irq(&logbuf_lock);
420 			error = __put_user(c,&buf[count-1-i]);
421 			cond_resched();
422 			raw_spin_lock_irq(&logbuf_lock);
423 		}
424 		raw_spin_unlock_irq(&logbuf_lock);
425 		if (error)
426 			break;
427 		error = i;
428 		if (i != count) {
429 			int offset = count-error;
430 			/* buffer overflow during copy, correct user buffer. */
431 			for (i = 0; i < error; i++) {
432 				if (__get_user(c,&buf[i+offset]) ||
433 				    __put_user(c,&buf[i])) {
434 					error = -EFAULT;
435 					break;
436 				}
437 				cond_resched();
438 			}
439 		}
440 		break;
441 	/* Clear ring buffer */
442 	case SYSLOG_ACTION_CLEAR:
443 		logged_chars = 0;
444 		break;
445 	/* Disable logging to console */
446 	case SYSLOG_ACTION_CONSOLE_OFF:
447 		if (saved_console_loglevel == -1)
448 			saved_console_loglevel = console_loglevel;
449 		console_loglevel = minimum_console_loglevel;
450 		break;
451 	/* Enable logging to console */
452 	case SYSLOG_ACTION_CONSOLE_ON:
453 		if (saved_console_loglevel != -1) {
454 			console_loglevel = saved_console_loglevel;
455 			saved_console_loglevel = -1;
456 		}
457 		break;
458 	/* Set level of messages printed to console */
459 	case SYSLOG_ACTION_CONSOLE_LEVEL:
460 		error = -EINVAL;
461 		if (len < 1 || len > 8)
462 			goto out;
463 		if (len < minimum_console_loglevel)
464 			len = minimum_console_loglevel;
465 		console_loglevel = len;
466 		/* Implicitly re-enable logging to console */
467 		saved_console_loglevel = -1;
468 		error = 0;
469 		break;
470 	/* Number of chars in the log buffer */
471 	case SYSLOG_ACTION_SIZE_UNREAD:
472 		error = log_end - log_start;
473 		break;
474 	/* Size of the log buffer */
475 	case SYSLOG_ACTION_SIZE_BUFFER:
476 		error = log_buf_len;
477 		break;
478 	default:
479 		error = -EINVAL;
480 		break;
481 	}
482 out:
483 	return error;
484 }
485 
SYSCALL_DEFINE3(syslog,int,type,char __user *,buf,int,len)486 SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
487 {
488 	return do_syslog(type, buf, len, SYSLOG_FROM_CALL);
489 }
490 
491 #ifdef	CONFIG_KGDB_KDB
492 /* kdb dmesg command needs access to the syslog buffer.  do_syslog()
493  * uses locks so it cannot be used during debugging.  Just tell kdb
494  * where the start and end of the physical and logical logs are.  This
495  * is equivalent to do_syslog(3).
496  */
kdb_syslog_data(char * syslog_data[4])497 void kdb_syslog_data(char *syslog_data[4])
498 {
499 	syslog_data[0] = log_buf;
500 	syslog_data[1] = log_buf + log_buf_len;
501 	syslog_data[2] = log_buf + log_end -
502 		(logged_chars < log_buf_len ? logged_chars : log_buf_len);
503 	syslog_data[3] = log_buf + log_end;
504 }
505 #endif	/* CONFIG_KGDB_KDB */
506 
507 /*
508  * Call the console drivers on a range of log_buf
509  */
__call_console_drivers(unsigned start,unsigned end)510 static void __call_console_drivers(unsigned start, unsigned end)
511 {
512 	struct console *con;
513 
514 	for_each_console(con) {
515 		if (exclusive_console && con != exclusive_console)
516 			continue;
517 		if ((con->flags & CON_ENABLED) && con->write &&
518 				(cpu_online(smp_processor_id()) ||
519 				(con->flags & CON_ANYTIME)))
520 			con->write(con, &LOG_BUF(start), end - start);
521 	}
522 }
523 
524 static bool __read_mostly ignore_loglevel;
525 
ignore_loglevel_setup(char * str)526 static int __init ignore_loglevel_setup(char *str)
527 {
528 	ignore_loglevel = 1;
529 	printk(KERN_INFO "debug: ignoring loglevel setting.\n");
530 
531 	return 0;
532 }
533 
534 early_param("ignore_loglevel", ignore_loglevel_setup);
535 module_param(ignore_loglevel, bool, S_IRUGO | S_IWUSR);
536 MODULE_PARM_DESC(ignore_loglevel, "ignore loglevel setting, to"
537 	"print all kernel messages to the console.");
538 
539 /*
540  * Write out chars from start to end - 1 inclusive
541  */
_call_console_drivers(unsigned start,unsigned end,int msg_log_level)542 static void _call_console_drivers(unsigned start,
543 				unsigned end, int msg_log_level)
544 {
545 	if ((msg_log_level < console_loglevel || ignore_loglevel) &&
546 			console_drivers && start != end) {
547 		if ((start & LOG_BUF_MASK) > (end & LOG_BUF_MASK)) {
548 			/* wrapped write */
549 			__call_console_drivers(start & LOG_BUF_MASK,
550 						log_buf_len);
551 			__call_console_drivers(0, end & LOG_BUF_MASK);
552 		} else {
553 			__call_console_drivers(start, end);
554 		}
555 	}
556 }
557 
558 /*
559  * Parse the syslog header <[0-9]*>. The decimal value represents 32bit, the
560  * lower 3 bit are the log level, the rest are the log facility. In case
561  * userspace passes usual userspace syslog messages to /dev/kmsg or
562  * /dev/ttyprintk, the log prefix might contain the facility. Printk needs
563  * to extract the correct log level for in-kernel processing, and not mangle
564  * the original value.
565  *
566  * If a prefix is found, the length of the prefix is returned. If 'level' is
567  * passed, it will be filled in with the log level without a possible facility
568  * value. If 'special' is passed, the special printk prefix chars are accepted
569  * and returned. If no valid header is found, 0 is returned and the passed
570  * variables are not touched.
571  */
log_prefix(const char * p,unsigned int * level,char * special)572 static size_t log_prefix(const char *p, unsigned int *level, char *special)
573 {
574 	unsigned int lev = 0;
575 	char sp = '\0';
576 	size_t len;
577 
578 	if (p[0] != '<' || !p[1])
579 		return 0;
580 	if (p[2] == '>') {
581 		/* usual single digit level number or special char */
582 		switch (p[1]) {
583 		case '0' ... '7':
584 			lev = p[1] - '0';
585 			break;
586 		case 'c': /* KERN_CONT */
587 		case 'd': /* KERN_DEFAULT */
588 			sp = p[1];
589 			break;
590 		default:
591 			return 0;
592 		}
593 		len = 3;
594 	} else {
595 		/* multi digit including the level and facility number */
596 		char *endp = NULL;
597 
598 		lev = (simple_strtoul(&p[1], &endp, 10) & 7);
599 		if (endp == NULL || endp[0] != '>')
600 			return 0;
601 		len = (endp + 1) - p;
602 	}
603 
604 	/* do not accept special char if not asked for */
605 	if (sp && !special)
606 		return 0;
607 
608 	if (special) {
609 		*special = sp;
610 		/* return special char, do not touch level */
611 		if (sp)
612 			return len;
613 	}
614 
615 	if (level)
616 		*level = lev;
617 	return len;
618 }
619 
620 /*
621  * Call the console drivers, asking them to write out
622  * log_buf[start] to log_buf[end - 1].
623  * The console_lock must be held.
624  */
call_console_drivers(unsigned start,unsigned end)625 static void call_console_drivers(unsigned start, unsigned end)
626 {
627 	unsigned cur_index, start_print;
628 	static int msg_level = -1;
629 
630 	BUG_ON(((int)(start - end)) > 0);
631 
632 	cur_index = start;
633 	start_print = start;
634 	while (cur_index != end) {
635 		if (msg_level < 0 && ((end - cur_index) > 2)) {
636 			/* strip log prefix */
637 			cur_index += log_prefix(&LOG_BUF(cur_index), &msg_level, NULL);
638 			start_print = cur_index;
639 		}
640 		while (cur_index != end) {
641 			char c = LOG_BUF(cur_index);
642 
643 			cur_index++;
644 			if (c == '\n') {
645 				if (msg_level < 0) {
646 					/*
647 					 * printk() has already given us loglevel tags in
648 					 * the buffer.  This code is here in case the
649 					 * log buffer has wrapped right round and scribbled
650 					 * on those tags
651 					 */
652 					msg_level = default_message_loglevel;
653 				}
654 				_call_console_drivers(start_print, cur_index, msg_level);
655 				msg_level = -1;
656 				start_print = cur_index;
657 				break;
658 			}
659 		}
660 	}
661 	_call_console_drivers(start_print, end, msg_level);
662 }
663 
emit_log_char(char c)664 static void emit_log_char(char c)
665 {
666 	LOG_BUF(log_end) = c;
667 	log_end++;
668 	if (log_end - log_start > log_buf_len)
669 		log_start = log_end - log_buf_len;
670 	if (log_end - con_start > log_buf_len)
671 		con_start = log_end - log_buf_len;
672 	if (logged_chars < log_buf_len)
673 		logged_chars++;
674 }
675 
676 /*
677  * Zap console related locks when oopsing. Only zap at most once
678  * every 10 seconds, to leave time for slow consoles to print a
679  * full oops.
680  */
zap_locks(void)681 static void zap_locks(void)
682 {
683 	static unsigned long oops_timestamp;
684 
685 	if (time_after_eq(jiffies, oops_timestamp) &&
686 			!time_after(jiffies, oops_timestamp + 30 * HZ))
687 		return;
688 
689 	oops_timestamp = jiffies;
690 
691 	debug_locks_off();
692 	/* If a crash is occurring, make sure we can't deadlock */
693 	raw_spin_lock_init(&logbuf_lock);
694 	/* And make sure that we print immediately */
695 	sema_init(&console_sem, 1);
696 }
697 
698 #if defined(CONFIG_PRINTK_TIME)
699 static bool printk_time = 1;
700 #else
701 static bool printk_time = 0;
702 #endif
703 module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
704 
705 static bool always_kmsg_dump;
706 module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);
707 
708 /* Check if we have any console registered that can be called early in boot. */
have_callable_console(void)709 static int have_callable_console(void)
710 {
711 	struct console *con;
712 
713 	for_each_console(con)
714 		if (con->flags & CON_ANYTIME)
715 			return 1;
716 
717 	return 0;
718 }
719 
720 /**
721  * printk - print a kernel message
722  * @fmt: format string
723  *
724  * This is printk().  It can be called from any context.  We want it to work.
725  *
726  * We try to grab the console_lock.  If we succeed, it's easy - we log the output and
727  * call the console drivers.  If we fail to get the semaphore we place the output
728  * into the log buffer and return.  The current holder of the console_sem will
729  * notice the new output in console_unlock(); and will send it to the
730  * consoles before releasing the lock.
731  *
732  * One effect of this deferred printing is that code which calls printk() and
733  * then changes console_loglevel may break. This is because console_loglevel
734  * is inspected when the actual printing occurs.
735  *
736  * See also:
737  * printf(3)
738  *
739  * See the vsnprintf() documentation for format string extensions over C99.
740  */
741 
printk(const char * fmt,...)742 asmlinkage int printk(const char *fmt, ...)
743 {
744 	va_list args;
745 	int r;
746 
747 #ifdef CONFIG_KGDB_KDB
748 	if (unlikely(kdb_trap_printk)) {
749 		va_start(args, fmt);
750 		r = vkdb_printf(fmt, args);
751 		va_end(args);
752 		return r;
753 	}
754 #endif
755 	va_start(args, fmt);
756 	r = vprintk(fmt, args);
757 	va_end(args);
758 
759 	return r;
760 }
761 
762 /* cpu currently holding logbuf_lock */
763 static volatile unsigned int printk_cpu = UINT_MAX;
764 
765 /*
766  * Can we actually use the console at this time on this cpu?
767  *
768  * Console drivers may assume that per-cpu resources have
769  * been allocated. So unless they're explicitly marked as
770  * being able to cope (CON_ANYTIME) don't call them until
771  * this CPU is officially up.
772  */
can_use_console(unsigned int cpu)773 static inline int can_use_console(unsigned int cpu)
774 {
775 	return cpu_online(cpu) || have_callable_console();
776 }
777 
778 /*
779  * Try to get console ownership to actually show the kernel
780  * messages from a 'printk'. Return true (and with the
781  * console_lock held, and 'console_locked' set) if it
782  * is successful, false otherwise.
783  *
784  * This gets called with the 'logbuf_lock' spinlock held and
785  * interrupts disabled. It should return with 'lockbuf_lock'
786  * released but interrupts still disabled.
787  */
console_trylock_for_printk(unsigned int cpu)788 static int console_trylock_for_printk(unsigned int cpu)
789 	__releases(&logbuf_lock)
790 {
791 	int retval = 0, wake = 0;
792 
793 	if (console_trylock()) {
794 		retval = 1;
795 
796 		/*
797 		 * If we can't use the console, we need to release
798 		 * the console semaphore by hand to avoid flushing
799 		 * the buffer. We need to hold the console semaphore
800 		 * in order to do this test safely.
801 		 */
802 		if (!can_use_console(cpu)) {
803 			console_locked = 0;
804 			wake = 1;
805 			retval = 0;
806 		}
807 	}
808 	printk_cpu = UINT_MAX;
809 	if (wake)
810 		up(&console_sem);
811 	raw_spin_unlock(&logbuf_lock);
812 	return retval;
813 }
814 static const char recursion_bug_msg [] =
815 		KERN_CRIT "BUG: recent printk recursion!\n";
816 static int recursion_bug;
817 static int new_text_line = 1;
818 static char printk_buf[1024];
819 
820 int printk_delay_msec __read_mostly;
821 
printk_delay(void)822 static inline void printk_delay(void)
823 {
824 	if (unlikely(printk_delay_msec)) {
825 		int m = printk_delay_msec;
826 
827 		while (m--) {
828 			mdelay(1);
829 			touch_nmi_watchdog();
830 		}
831 	}
832 }
833 
vprintk(const char * fmt,va_list args)834 asmlinkage int vprintk(const char *fmt, va_list args)
835 {
836 	int printed_len = 0;
837 	int current_log_level = default_message_loglevel;
838 	unsigned long flags;
839 	int this_cpu;
840 	char *p;
841 	size_t plen;
842 	char special;
843 
844 	boot_delay_msec();
845 	printk_delay();
846 
847 	/* This stops the holder of console_sem just where we want him */
848 	local_irq_save(flags);
849 	this_cpu = smp_processor_id();
850 
851 	/*
852 	 * Ouch, printk recursed into itself!
853 	 */
854 	if (unlikely(printk_cpu == this_cpu)) {
855 		/*
856 		 * If a crash is occurring during printk() on this CPU,
857 		 * then try to get the crash message out but make sure
858 		 * we can't deadlock. Otherwise just return to avoid the
859 		 * recursion and return - but flag the recursion so that
860 		 * it can be printed at the next appropriate moment:
861 		 */
862 		if (!oops_in_progress && !lockdep_recursing(current)) {
863 			recursion_bug = 1;
864 			goto out_restore_irqs;
865 		}
866 		zap_locks();
867 	}
868 
869 	lockdep_off();
870 	raw_spin_lock(&logbuf_lock);
871 	printk_cpu = this_cpu;
872 
873 	if (recursion_bug) {
874 		recursion_bug = 0;
875 		strcpy(printk_buf, recursion_bug_msg);
876 		printed_len = strlen(recursion_bug_msg);
877 	}
878 	/* Emit the output into the temporary buffer */
879 	printed_len += vscnprintf(printk_buf + printed_len,
880 				  sizeof(printk_buf) - printed_len, fmt, args);
881 
882 	p = printk_buf;
883 
884 	/* Read log level and handle special printk prefix */
885 	plen = log_prefix(p, &current_log_level, &special);
886 	if (plen) {
887 		p += plen;
888 
889 		switch (special) {
890 		case 'c': /* Strip <c> KERN_CONT, continue line */
891 			plen = 0;
892 			break;
893 		case 'd': /* Strip <d> KERN_DEFAULT, start new line */
894 			plen = 0;
895 		default:
896 			if (!new_text_line) {
897 				emit_log_char('\n');
898 				new_text_line = 1;
899 			}
900 		}
901 	}
902 
903 	/*
904 	 * Copy the output into log_buf. If the caller didn't provide
905 	 * the appropriate log prefix, we insert them here
906 	 */
907 	for (; *p; p++) {
908 		if (new_text_line) {
909 			new_text_line = 0;
910 
911 			if (plen) {
912 				/* Copy original log prefix */
913 				int i;
914 
915 				for (i = 0; i < plen; i++)
916 					emit_log_char(printk_buf[i]);
917 				printed_len += plen;
918 			} else {
919 				/* Add log prefix */
920 				emit_log_char('<');
921 				emit_log_char(current_log_level + '0');
922 				emit_log_char('>');
923 				printed_len += 3;
924 			}
925 
926 			if (printk_time) {
927 				/* Add the current time stamp */
928 				char tbuf[50], *tp;
929 				unsigned tlen;
930 				unsigned long long t;
931 				unsigned long nanosec_rem;
932 
933 				t = cpu_clock(printk_cpu);
934 				nanosec_rem = do_div(t, 1000000000);
935 				tlen = sprintf(tbuf, "[%5lu.%06lu] ",
936 						(unsigned long) t,
937 						nanosec_rem / 1000);
938 
939 				for (tp = tbuf; tp < tbuf + tlen; tp++)
940 					emit_log_char(*tp);
941 				printed_len += tlen;
942 			}
943 
944 			if (!*p)
945 				break;
946 		}
947 
948 		emit_log_char(*p);
949 		if (*p == '\n')
950 			new_text_line = 1;
951 	}
952 
953 	/*
954 	 * Try to acquire and then immediately release the
955 	 * console semaphore. The release will do all the
956 	 * actual magic (print out buffers, wake up klogd,
957 	 * etc).
958 	 *
959 	 * The console_trylock_for_printk() function
960 	 * will release 'logbuf_lock' regardless of whether it
961 	 * actually gets the semaphore or not.
962 	 */
963 	if (console_trylock_for_printk(this_cpu))
964 		console_unlock();
965 
966 	lockdep_on();
967 out_restore_irqs:
968 	local_irq_restore(flags);
969 
970 	return printed_len;
971 }
972 EXPORT_SYMBOL(printk);
973 EXPORT_SYMBOL(vprintk);
974 
975 #else
976 
call_console_drivers(unsigned start,unsigned end)977 static void call_console_drivers(unsigned start, unsigned end)
978 {
979 }
980 
981 #endif
982 
__add_preferred_console(char * name,int idx,char * options,char * brl_options)983 static int __add_preferred_console(char *name, int idx, char *options,
984 				   char *brl_options)
985 {
986 	struct console_cmdline *c;
987 	int i;
988 
989 	/*
990 	 *	See if this tty is not yet registered, and
991 	 *	if we have a slot free.
992 	 */
993 	for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
994 		if (strcmp(console_cmdline[i].name, name) == 0 &&
995 			  console_cmdline[i].index == idx) {
996 				if (!brl_options)
997 					selected_console = i;
998 				return 0;
999 		}
1000 	if (i == MAX_CMDLINECONSOLES)
1001 		return -E2BIG;
1002 	if (!brl_options)
1003 		selected_console = i;
1004 	c = &console_cmdline[i];
1005 	strlcpy(c->name, name, sizeof(c->name));
1006 	c->options = options;
1007 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1008 	c->brl_options = brl_options;
1009 #endif
1010 	c->index = idx;
1011 	return 0;
1012 }
1013 /*
1014  * Set up a list of consoles.  Called from init/main.c
1015  */
console_setup(char * str)1016 static int __init console_setup(char *str)
1017 {
1018 	char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for index */
1019 	char *s, *options, *brl_options = NULL;
1020 	int idx;
1021 
1022 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1023 	if (!memcmp(str, "brl,", 4)) {
1024 		brl_options = "";
1025 		str += 4;
1026 	} else if (!memcmp(str, "brl=", 4)) {
1027 		brl_options = str + 4;
1028 		str = strchr(brl_options, ',');
1029 		if (!str) {
1030 			printk(KERN_ERR "need port name after brl=\n");
1031 			return 1;
1032 		}
1033 		*(str++) = 0;
1034 	}
1035 #endif
1036 
1037 	/*
1038 	 * Decode str into name, index, options.
1039 	 */
1040 	if (str[0] >= '0' && str[0] <= '9') {
1041 		strcpy(buf, "ttyS");
1042 		strncpy(buf + 4, str, sizeof(buf) - 5);
1043 	} else {
1044 		strncpy(buf, str, sizeof(buf) - 1);
1045 	}
1046 	buf[sizeof(buf) - 1] = 0;
1047 	if ((options = strchr(str, ',')) != NULL)
1048 		*(options++) = 0;
1049 #ifdef __sparc__
1050 	if (!strcmp(str, "ttya"))
1051 		strcpy(buf, "ttyS0");
1052 	if (!strcmp(str, "ttyb"))
1053 		strcpy(buf, "ttyS1");
1054 #endif
1055 	for (s = buf; *s; s++)
1056 		if ((*s >= '0' && *s <= '9') || *s == ',')
1057 			break;
1058 	idx = simple_strtoul(s, NULL, 10);
1059 	*s = 0;
1060 
1061 	__add_preferred_console(buf, idx, options, brl_options);
1062 	console_set_on_cmdline = 1;
1063 	return 1;
1064 }
1065 __setup("console=", console_setup);
1066 
1067 /**
1068  * add_preferred_console - add a device to the list of preferred consoles.
1069  * @name: device name
1070  * @idx: device index
1071  * @options: options for this console
1072  *
1073  * The last preferred console added will be used for kernel messages
1074  * and stdin/out/err for init.  Normally this is used by console_setup
1075  * above to handle user-supplied console arguments; however it can also
1076  * be used by arch-specific code either to override the user or more
1077  * commonly to provide a default console (ie from PROM variables) when
1078  * the user has not supplied one.
1079  */
add_preferred_console(char * name,int idx,char * options)1080 int add_preferred_console(char *name, int idx, char *options)
1081 {
1082 	return __add_preferred_console(name, idx, options, NULL);
1083 }
1084 
update_console_cmdline(char * name,int idx,char * name_new,int idx_new,char * options)1085 int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options)
1086 {
1087 	struct console_cmdline *c;
1088 	int i;
1089 
1090 	for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
1091 		if (strcmp(console_cmdline[i].name, name) == 0 &&
1092 			  console_cmdline[i].index == idx) {
1093 				c = &console_cmdline[i];
1094 				strlcpy(c->name, name_new, sizeof(c->name));
1095 				c->name[sizeof(c->name) - 1] = 0;
1096 				c->options = options;
1097 				c->index = idx_new;
1098 				return i;
1099 		}
1100 	/* not found */
1101 	return -1;
1102 }
1103 
1104 bool console_suspend_enabled = 1;
1105 EXPORT_SYMBOL(console_suspend_enabled);
1106 
console_suspend_disable(char * str)1107 static int __init console_suspend_disable(char *str)
1108 {
1109 	console_suspend_enabled = 0;
1110 	return 1;
1111 }
1112 __setup("no_console_suspend", console_suspend_disable);
1113 module_param_named(console_suspend, console_suspend_enabled,
1114 		bool, S_IRUGO | S_IWUSR);
1115 MODULE_PARM_DESC(console_suspend, "suspend console during suspend"
1116 	" and hibernate operations");
1117 
1118 /**
1119  * suspend_console - suspend the console subsystem
1120  *
1121  * This disables printk() while we go into suspend states
1122  */
suspend_console(void)1123 void suspend_console(void)
1124 {
1125 	if (!console_suspend_enabled)
1126 		return;
1127 	printk("Suspending console(s) (use no_console_suspend to debug)\n");
1128 	console_lock();
1129 	console_suspended = 1;
1130 	up(&console_sem);
1131 }
1132 
resume_console(void)1133 void resume_console(void)
1134 {
1135 	if (!console_suspend_enabled)
1136 		return;
1137 	down(&console_sem);
1138 	console_suspended = 0;
1139 	console_unlock();
1140 }
1141 
1142 /**
1143  * console_cpu_notify - print deferred console messages after CPU hotplug
1144  * @self: notifier struct
1145  * @action: CPU hotplug event
1146  * @hcpu: unused
1147  *
1148  * If printk() is called from a CPU that is not online yet, the messages
1149  * will be spooled but will not show up on the console.  This function is
1150  * called when a new CPU comes online (or fails to come up), and ensures
1151  * that any such output gets printed.
1152  */
console_cpu_notify(struct notifier_block * self,unsigned long action,void * hcpu)1153 static int __cpuinit console_cpu_notify(struct notifier_block *self,
1154 	unsigned long action, void *hcpu)
1155 {
1156 	switch (action) {
1157 	case CPU_ONLINE:
1158 	case CPU_DEAD:
1159 	case CPU_DYING:
1160 	case CPU_DOWN_FAILED:
1161 	case CPU_UP_CANCELED:
1162 		console_lock();
1163 		console_unlock();
1164 	}
1165 	return NOTIFY_OK;
1166 }
1167 
1168 /**
1169  * console_lock - lock the console system for exclusive use.
1170  *
1171  * Acquires a lock which guarantees that the caller has
1172  * exclusive access to the console system and the console_drivers list.
1173  *
1174  * Can sleep, returns nothing.
1175  */
console_lock(void)1176 void console_lock(void)
1177 {
1178 	BUG_ON(in_interrupt());
1179 	down(&console_sem);
1180 	if (console_suspended)
1181 		return;
1182 	console_locked = 1;
1183 	console_may_schedule = 1;
1184 }
1185 EXPORT_SYMBOL(console_lock);
1186 
1187 /**
1188  * console_trylock - try to lock the console system for exclusive use.
1189  *
1190  * Tried to acquire a lock which guarantees that the caller has
1191  * exclusive access to the console system and the console_drivers list.
1192  *
1193  * returns 1 on success, and 0 on failure to acquire the lock.
1194  */
console_trylock(void)1195 int console_trylock(void)
1196 {
1197 	if (down_trylock(&console_sem))
1198 		return 0;
1199 	if (console_suspended) {
1200 		up(&console_sem);
1201 		return 0;
1202 	}
1203 	console_locked = 1;
1204 	console_may_schedule = 0;
1205 	return 1;
1206 }
1207 EXPORT_SYMBOL(console_trylock);
1208 
is_console_locked(void)1209 int is_console_locked(void)
1210 {
1211 	return console_locked;
1212 }
1213 
1214 static DEFINE_PER_CPU(int, printk_pending);
1215 
printk_tick(void)1216 void printk_tick(void)
1217 {
1218 	if (__this_cpu_read(printk_pending)) {
1219 		__this_cpu_write(printk_pending, 0);
1220 		wake_up_interruptible(&log_wait);
1221 	}
1222 }
1223 
printk_needs_cpu(int cpu)1224 int printk_needs_cpu(int cpu)
1225 {
1226 	if (cpu_is_offline(cpu))
1227 		printk_tick();
1228 	return __this_cpu_read(printk_pending);
1229 }
1230 
wake_up_klogd(void)1231 void wake_up_klogd(void)
1232 {
1233 	if (waitqueue_active(&log_wait))
1234 		this_cpu_write(printk_pending, 1);
1235 }
1236 
1237 /**
1238  * console_unlock - unlock the console system
1239  *
1240  * Releases the console_lock which the caller holds on the console system
1241  * and the console driver list.
1242  *
1243  * While the console_lock was held, console output may have been buffered
1244  * by printk().  If this is the case, console_unlock(); emits
1245  * the output prior to releasing the lock.
1246  *
1247  * If there is output waiting for klogd, we wake it up.
1248  *
1249  * console_unlock(); may be called from any context.
1250  */
console_unlock(void)1251 void console_unlock(void)
1252 {
1253 	unsigned long flags;
1254 	unsigned _con_start, _log_end;
1255 	unsigned wake_klogd = 0, retry = 0;
1256 
1257 	if (console_suspended) {
1258 		up(&console_sem);
1259 		return;
1260 	}
1261 
1262 	console_may_schedule = 0;
1263 
1264 again:
1265 	for ( ; ; ) {
1266 		raw_spin_lock_irqsave(&logbuf_lock, flags);
1267 		wake_klogd |= log_start - log_end;
1268 		if (con_start == log_end)
1269 			break;			/* Nothing to print */
1270 		_con_start = con_start;
1271 		_log_end = log_end;
1272 		con_start = log_end;		/* Flush */
1273 		raw_spin_unlock(&logbuf_lock);
1274 		stop_critical_timings();	/* don't trace print latency */
1275 		call_console_drivers(_con_start, _log_end);
1276 		start_critical_timings();
1277 		local_irq_restore(flags);
1278 	}
1279 	console_locked = 0;
1280 
1281 	/* Release the exclusive_console once it is used */
1282 	if (unlikely(exclusive_console))
1283 		exclusive_console = NULL;
1284 
1285 	raw_spin_unlock(&logbuf_lock);
1286 
1287 	up(&console_sem);
1288 
1289 	/*
1290 	 * Someone could have filled up the buffer again, so re-check if there's
1291 	 * something to flush. In case we cannot trylock the console_sem again,
1292 	 * there's a new owner and the console_unlock() from them will do the
1293 	 * flush, no worries.
1294 	 */
1295 	raw_spin_lock(&logbuf_lock);
1296 	if (con_start != log_end)
1297 		retry = 1;
1298 	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
1299 
1300 	if (retry && console_trylock())
1301 		goto again;
1302 
1303 	if (wake_klogd)
1304 		wake_up_klogd();
1305 }
1306 EXPORT_SYMBOL(console_unlock);
1307 
1308 /**
1309  * console_conditional_schedule - yield the CPU if required
1310  *
1311  * If the console code is currently allowed to sleep, and
1312  * if this CPU should yield the CPU to another task, do
1313  * so here.
1314  *
1315  * Must be called within console_lock();.
1316  */
console_conditional_schedule(void)1317 void __sched console_conditional_schedule(void)
1318 {
1319 	if (console_may_schedule)
1320 		cond_resched();
1321 }
1322 EXPORT_SYMBOL(console_conditional_schedule);
1323 
console_unblank(void)1324 void console_unblank(void)
1325 {
1326 	struct console *c;
1327 
1328 	/*
1329 	 * console_unblank can no longer be called in interrupt context unless
1330 	 * oops_in_progress is set to 1..
1331 	 */
1332 	if (oops_in_progress) {
1333 		if (down_trylock(&console_sem) != 0)
1334 			return;
1335 	} else
1336 		console_lock();
1337 
1338 	console_locked = 1;
1339 	console_may_schedule = 0;
1340 	for_each_console(c)
1341 		if ((c->flags & CON_ENABLED) && c->unblank)
1342 			c->unblank();
1343 	console_unlock();
1344 }
1345 
1346 /*
1347  * Return the console tty driver structure and its associated index
1348  */
console_device(int * index)1349 struct tty_driver *console_device(int *index)
1350 {
1351 	struct console *c;
1352 	struct tty_driver *driver = NULL;
1353 
1354 	console_lock();
1355 	for_each_console(c) {
1356 		if (!c->device)
1357 			continue;
1358 		driver = c->device(c, index);
1359 		if (driver)
1360 			break;
1361 	}
1362 	console_unlock();
1363 	return driver;
1364 }
1365 
1366 /*
1367  * Prevent further output on the passed console device so that (for example)
1368  * serial drivers can disable console output before suspending a port, and can
1369  * re-enable output afterwards.
1370  */
console_stop(struct console * console)1371 void console_stop(struct console *console)
1372 {
1373 	console_lock();
1374 	console->flags &= ~CON_ENABLED;
1375 	console_unlock();
1376 }
1377 EXPORT_SYMBOL(console_stop);
1378 
console_start(struct console * console)1379 void console_start(struct console *console)
1380 {
1381 	console_lock();
1382 	console->flags |= CON_ENABLED;
1383 	console_unlock();
1384 }
1385 EXPORT_SYMBOL(console_start);
1386 
1387 static int __read_mostly keep_bootcon;
1388 
keep_bootcon_setup(char * str)1389 static int __init keep_bootcon_setup(char *str)
1390 {
1391 	keep_bootcon = 1;
1392 	printk(KERN_INFO "debug: skip boot console de-registration.\n");
1393 
1394 	return 0;
1395 }
1396 
1397 early_param("keep_bootcon", keep_bootcon_setup);
1398 
1399 /*
1400  * The console driver calls this routine during kernel initialization
1401  * to register the console printing procedure with printk() and to
1402  * print any messages that were printed by the kernel before the
1403  * console driver was initialized.
1404  *
1405  * This can happen pretty early during the boot process (because of
1406  * early_printk) - sometimes before setup_arch() completes - be careful
1407  * of what kernel features are used - they may not be initialised yet.
1408  *
1409  * There are two types of consoles - bootconsoles (early_printk) and
1410  * "real" consoles (everything which is not a bootconsole) which are
1411  * handled differently.
1412  *  - Any number of bootconsoles can be registered at any time.
1413  *  - As soon as a "real" console is registered, all bootconsoles
1414  *    will be unregistered automatically.
1415  *  - Once a "real" console is registered, any attempt to register a
1416  *    bootconsoles will be rejected
1417  */
register_console(struct console * newcon)1418 void register_console(struct console *newcon)
1419 {
1420 	int i;
1421 	unsigned long flags;
1422 	struct console *bcon = NULL;
1423 
1424 	/*
1425 	 * before we register a new CON_BOOT console, make sure we don't
1426 	 * already have a valid console
1427 	 */
1428 	if (console_drivers && newcon->flags & CON_BOOT) {
1429 		/* find the last or real console */
1430 		for_each_console(bcon) {
1431 			if (!(bcon->flags & CON_BOOT)) {
1432 				printk(KERN_INFO "Too late to register bootconsole %s%d\n",
1433 					newcon->name, newcon->index);
1434 				return;
1435 			}
1436 		}
1437 	}
1438 
1439 	if (console_drivers && console_drivers->flags & CON_BOOT)
1440 		bcon = console_drivers;
1441 
1442 	if (preferred_console < 0 || bcon || !console_drivers)
1443 		preferred_console = selected_console;
1444 
1445 	if (newcon->early_setup)
1446 		newcon->early_setup();
1447 
1448 	/*
1449 	 *	See if we want to use this console driver. If we
1450 	 *	didn't select a console we take the first one
1451 	 *	that registers here.
1452 	 */
1453 	if (preferred_console < 0) {
1454 		if (newcon->index < 0)
1455 			newcon->index = 0;
1456 		if (newcon->setup == NULL ||
1457 		    newcon->setup(newcon, NULL) == 0) {
1458 			newcon->flags |= CON_ENABLED;
1459 			if (newcon->device) {
1460 				newcon->flags |= CON_CONSDEV;
1461 				preferred_console = 0;
1462 			}
1463 		}
1464 	}
1465 
1466 	/*
1467 	 *	See if this console matches one we selected on
1468 	 *	the command line.
1469 	 */
1470 	for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0];
1471 			i++) {
1472 		if (strcmp(console_cmdline[i].name, newcon->name) != 0)
1473 			continue;
1474 		if (newcon->index >= 0 &&
1475 		    newcon->index != console_cmdline[i].index)
1476 			continue;
1477 		if (newcon->index < 0)
1478 			newcon->index = console_cmdline[i].index;
1479 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1480 		if (console_cmdline[i].brl_options) {
1481 			newcon->flags |= CON_BRL;
1482 			braille_register_console(newcon,
1483 					console_cmdline[i].index,
1484 					console_cmdline[i].options,
1485 					console_cmdline[i].brl_options);
1486 			return;
1487 		}
1488 #endif
1489 		if (newcon->setup &&
1490 		    newcon->setup(newcon, console_cmdline[i].options) != 0)
1491 			break;
1492 		newcon->flags |= CON_ENABLED;
1493 		newcon->index = console_cmdline[i].index;
1494 		if (i == selected_console) {
1495 			newcon->flags |= CON_CONSDEV;
1496 			preferred_console = selected_console;
1497 		}
1498 		break;
1499 	}
1500 
1501 	if (!(newcon->flags & CON_ENABLED))
1502 		return;
1503 
1504 	/*
1505 	 * If we have a bootconsole, and are switching to a real console,
1506 	 * don't print everything out again, since when the boot console, and
1507 	 * the real console are the same physical device, it's annoying to
1508 	 * see the beginning boot messages twice
1509 	 */
1510 	if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
1511 		newcon->flags &= ~CON_PRINTBUFFER;
1512 
1513 	/*
1514 	 *	Put this console in the list - keep the
1515 	 *	preferred driver at the head of the list.
1516 	 */
1517 	console_lock();
1518 	if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
1519 		newcon->next = console_drivers;
1520 		console_drivers = newcon;
1521 		if (newcon->next)
1522 			newcon->next->flags &= ~CON_CONSDEV;
1523 	} else {
1524 		newcon->next = console_drivers->next;
1525 		console_drivers->next = newcon;
1526 	}
1527 	if (newcon->flags & CON_PRINTBUFFER) {
1528 		/*
1529 		 * console_unlock(); will print out the buffered messages
1530 		 * for us.
1531 		 */
1532 		raw_spin_lock_irqsave(&logbuf_lock, flags);
1533 		con_start = log_start;
1534 		raw_spin_unlock_irqrestore(&logbuf_lock, flags);
1535 		/*
1536 		 * We're about to replay the log buffer.  Only do this to the
1537 		 * just-registered console to avoid excessive message spam to
1538 		 * the already-registered consoles.
1539 		 */
1540 		exclusive_console = newcon;
1541 	}
1542 	console_unlock();
1543 	console_sysfs_notify();
1544 
1545 	/*
1546 	 * By unregistering the bootconsoles after we enable the real console
1547 	 * we get the "console xxx enabled" message on all the consoles -
1548 	 * boot consoles, real consoles, etc - this is to ensure that end
1549 	 * users know there might be something in the kernel's log buffer that
1550 	 * went to the bootconsole (that they do not see on the real console)
1551 	 */
1552 	if (bcon &&
1553 	    ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
1554 	    !keep_bootcon) {
1555 		/* we need to iterate through twice, to make sure we print
1556 		 * everything out, before we unregister the console(s)
1557 		 */
1558 		printk(KERN_INFO "console [%s%d] enabled, bootconsole disabled\n",
1559 			newcon->name, newcon->index);
1560 		for_each_console(bcon)
1561 			if (bcon->flags & CON_BOOT)
1562 				unregister_console(bcon);
1563 	} else {
1564 		printk(KERN_INFO "%sconsole [%s%d] enabled\n",
1565 			(newcon->flags & CON_BOOT) ? "boot" : "" ,
1566 			newcon->name, newcon->index);
1567 	}
1568 }
1569 EXPORT_SYMBOL(register_console);
1570 
unregister_console(struct console * console)1571 int unregister_console(struct console *console)
1572 {
1573         struct console *a, *b;
1574 	int res = 1;
1575 
1576 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1577 	if (console->flags & CON_BRL)
1578 		return braille_unregister_console(console);
1579 #endif
1580 
1581 	console_lock();
1582 	if (console_drivers == console) {
1583 		console_drivers=console->next;
1584 		res = 0;
1585 	} else if (console_drivers) {
1586 		for (a=console_drivers->next, b=console_drivers ;
1587 		     a; b=a, a=b->next) {
1588 			if (a == console) {
1589 				b->next = a->next;
1590 				res = 0;
1591 				break;
1592 			}
1593 		}
1594 	}
1595 
1596 	/*
1597 	 * If this isn't the last console and it has CON_CONSDEV set, we
1598 	 * need to set it on the next preferred console.
1599 	 */
1600 	if (console_drivers != NULL && console->flags & CON_CONSDEV)
1601 		console_drivers->flags |= CON_CONSDEV;
1602 
1603 	console_unlock();
1604 	console_sysfs_notify();
1605 	return res;
1606 }
1607 EXPORT_SYMBOL(unregister_console);
1608 
printk_late_init(void)1609 static int __init printk_late_init(void)
1610 {
1611 	struct console *con;
1612 
1613 	for_each_console(con) {
1614 		if (!keep_bootcon && con->flags & CON_BOOT) {
1615 			printk(KERN_INFO "turn off boot console %s%d\n",
1616 				con->name, con->index);
1617 			unregister_console(con);
1618 		}
1619 	}
1620 	hotcpu_notifier(console_cpu_notify, 0);
1621 	return 0;
1622 }
1623 late_initcall(printk_late_init);
1624 
1625 #if defined CONFIG_PRINTK
1626 
1627 /*
1628  * printk rate limiting, lifted from the networking subsystem.
1629  *
1630  * This enforces a rate limit: not more than 10 kernel messages
1631  * every 5s to make a denial-of-service attack impossible.
1632  */
1633 DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
1634 
__printk_ratelimit(const char * func)1635 int __printk_ratelimit(const char *func)
1636 {
1637 	return ___ratelimit(&printk_ratelimit_state, func);
1638 }
1639 EXPORT_SYMBOL(__printk_ratelimit);
1640 
1641 /**
1642  * printk_timed_ratelimit - caller-controlled printk ratelimiting
1643  * @caller_jiffies: pointer to caller's state
1644  * @interval_msecs: minimum interval between prints
1645  *
1646  * printk_timed_ratelimit() returns true if more than @interval_msecs
1647  * milliseconds have elapsed since the last time printk_timed_ratelimit()
1648  * returned true.
1649  */
printk_timed_ratelimit(unsigned long * caller_jiffies,unsigned int interval_msecs)1650 bool printk_timed_ratelimit(unsigned long *caller_jiffies,
1651 			unsigned int interval_msecs)
1652 {
1653 	if (*caller_jiffies == 0
1654 			|| !time_in_range(jiffies, *caller_jiffies,
1655 					*caller_jiffies
1656 					+ msecs_to_jiffies(interval_msecs))) {
1657 		*caller_jiffies = jiffies;
1658 		return true;
1659 	}
1660 	return false;
1661 }
1662 EXPORT_SYMBOL(printk_timed_ratelimit);
1663 
1664 static DEFINE_SPINLOCK(dump_list_lock);
1665 static LIST_HEAD(dump_list);
1666 
1667 /**
1668  * kmsg_dump_register - register a kernel log dumper.
1669  * @dumper: pointer to the kmsg_dumper structure
1670  *
1671  * Adds a kernel log dumper to the system. The dump callback in the
1672  * structure will be called when the kernel oopses or panics and must be
1673  * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
1674  */
kmsg_dump_register(struct kmsg_dumper * dumper)1675 int kmsg_dump_register(struct kmsg_dumper *dumper)
1676 {
1677 	unsigned long flags;
1678 	int err = -EBUSY;
1679 
1680 	/* The dump callback needs to be set */
1681 	if (!dumper->dump)
1682 		return -EINVAL;
1683 
1684 	spin_lock_irqsave(&dump_list_lock, flags);
1685 	/* Don't allow registering multiple times */
1686 	if (!dumper->registered) {
1687 		dumper->registered = 1;
1688 		list_add_tail_rcu(&dumper->list, &dump_list);
1689 		err = 0;
1690 	}
1691 	spin_unlock_irqrestore(&dump_list_lock, flags);
1692 
1693 	return err;
1694 }
1695 EXPORT_SYMBOL_GPL(kmsg_dump_register);
1696 
1697 /**
1698  * kmsg_dump_unregister - unregister a kmsg dumper.
1699  * @dumper: pointer to the kmsg_dumper structure
1700  *
1701  * Removes a dump device from the system. Returns zero on success and
1702  * %-EINVAL otherwise.
1703  */
kmsg_dump_unregister(struct kmsg_dumper * dumper)1704 int kmsg_dump_unregister(struct kmsg_dumper *dumper)
1705 {
1706 	unsigned long flags;
1707 	int err = -EINVAL;
1708 
1709 	spin_lock_irqsave(&dump_list_lock, flags);
1710 	if (dumper->registered) {
1711 		dumper->registered = 0;
1712 		list_del_rcu(&dumper->list);
1713 		err = 0;
1714 	}
1715 	spin_unlock_irqrestore(&dump_list_lock, flags);
1716 	synchronize_rcu();
1717 
1718 	return err;
1719 }
1720 EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
1721 
1722 /**
1723  * kmsg_dump - dump kernel log to kernel message dumpers.
1724  * @reason: the reason (oops, panic etc) for dumping
1725  *
1726  * Iterate through each of the dump devices and call the oops/panic
1727  * callbacks with the log buffer.
1728  */
kmsg_dump(enum kmsg_dump_reason reason)1729 void kmsg_dump(enum kmsg_dump_reason reason)
1730 {
1731 	unsigned long end;
1732 	unsigned chars;
1733 	struct kmsg_dumper *dumper;
1734 	const char *s1, *s2;
1735 	unsigned long l1, l2;
1736 	unsigned long flags;
1737 
1738 	if ((reason > KMSG_DUMP_OOPS) && !always_kmsg_dump)
1739 		return;
1740 
1741 	/* Theoretically, the log could move on after we do this, but
1742 	   there's not a lot we can do about that. The new messages
1743 	   will overwrite the start of what we dump. */
1744 	raw_spin_lock_irqsave(&logbuf_lock, flags);
1745 	end = log_end & LOG_BUF_MASK;
1746 	chars = logged_chars;
1747 	raw_spin_unlock_irqrestore(&logbuf_lock, flags);
1748 
1749 	if (chars > end) {
1750 		s1 = log_buf + log_buf_len - chars + end;
1751 		l1 = chars - end;
1752 
1753 		s2 = log_buf;
1754 		l2 = end;
1755 	} else {
1756 		s1 = "";
1757 		l1 = 0;
1758 
1759 		s2 = log_buf + end - chars;
1760 		l2 = chars;
1761 	}
1762 
1763 	rcu_read_lock();
1764 	list_for_each_entry_rcu(dumper, &dump_list, list)
1765 		dumper->dump(dumper, reason, s1, l1, s2, l2);
1766 	rcu_read_unlock();
1767 }
1768 #endif
1769