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