xref: /linux-6.15/kernel/debug/kdb/kdb_io.c (revision db2f9c7d)
1 /*
2  * Kernel Debugger Architecture Independent Console I/O handler
3  *
4  * This file is subject to the terms and conditions of the GNU General Public
5  * License.  See the file "COPYING" in the main directory of this archive
6  * for more details.
7  *
8  * Copyright (c) 1999-2006 Silicon Graphics, Inc.  All Rights Reserved.
9  * Copyright (c) 2009 Wind River Systems, Inc.  All Rights Reserved.
10  */
11 
12 #include <linux/types.h>
13 #include <linux/ctype.h>
14 #include <linux/kernel.h>
15 #include <linux/init.h>
16 #include <linux/kdev_t.h>
17 #include <linux/console.h>
18 #include <linux/string.h>
19 #include <linux/sched.h>
20 #include <linux/smp.h>
21 #include <linux/nmi.h>
22 #include <linux/delay.h>
23 #include <linux/kgdb.h>
24 #include <linux/kdb.h>
25 #include <linux/kallsyms.h>
26 #include "kdb_private.h"
27 
28 #define CMD_BUFLEN 256
29 char kdb_prompt_str[CMD_BUFLEN];
30 
31 int kdb_trap_printk;
32 int kdb_printf_cpu = -1;
33 
34 static int kgdb_transition_check(char *buffer)
35 {
36 	if (buffer[0] != '+' && buffer[0] != '$') {
37 		KDB_STATE_SET(KGDB_TRANS);
38 		kdb_printf("%s", buffer);
39 	} else {
40 		int slen = strlen(buffer);
41 		if (slen > 3 && buffer[slen - 3] == '#') {
42 			kdb_gdb_state_pass(buffer);
43 			strcpy(buffer, "kgdb");
44 			KDB_STATE_SET(DOING_KGDB);
45 			return 1;
46 		}
47 	}
48 	return 0;
49 }
50 
51 /**
52  * kdb_handle_escape() - validity check on an accumulated escape sequence.
53  * @buf:	Accumulated escape characters to be examined. Note that buf
54  *		is not a string, it is an array of characters and need not be
55  *		nil terminated.
56  * @sz:		Number of accumulated escape characters.
57  *
58  * Return: -1 if the escape sequence is unwanted, 0 if it is incomplete,
59  * otherwise it returns a mapped key value to pass to the upper layers.
60  */
61 static int kdb_handle_escape(char *buf, size_t sz)
62 {
63 	char *lastkey = buf + sz - 1;
64 
65 	switch (sz) {
66 	case 1:
67 		if (*lastkey == '\e')
68 			return 0;
69 		break;
70 
71 	case 2: /* \e<something> */
72 		if (*lastkey == '[')
73 			return 0;
74 		break;
75 
76 	case 3:
77 		switch (*lastkey) {
78 		case 'A': /* \e[A, up arrow */
79 			return 16;
80 		case 'B': /* \e[B, down arrow */
81 			return 14;
82 		case 'C': /* \e[C, right arrow */
83 			return 6;
84 		case 'D': /* \e[D, left arrow */
85 			return 2;
86 		case '1': /* \e[<1,3,4>], may be home, del, end */
87 		case '3':
88 		case '4':
89 			return 0;
90 		}
91 		break;
92 
93 	case 4:
94 		if (*lastkey == '~') {
95 			switch (buf[2]) {
96 			case '1': /* \e[1~, home */
97 				return 1;
98 			case '3': /* \e[3~, del */
99 				return 4;
100 			case '4': /* \e[4~, end */
101 				return 5;
102 			}
103 		}
104 		break;
105 	}
106 
107 	return -1;
108 }
109 
110 /**
111  * kdb_getchar() - Read a single character from a kdb console (or consoles).
112  *
113  * Other than polling the various consoles that are currently enabled,
114  * most of the work done in this function is dealing with escape sequences.
115  *
116  * An escape key could be the start of a vt100 control sequence such as \e[D
117  * (left arrow) or it could be a character in its own right.  The standard
118  * method for detecting the difference is to wait for 2 seconds to see if there
119  * are any other characters.  kdb is complicated by the lack of a timer service
120  * (interrupts are off), by multiple input sources. Escape sequence processing
121  * has to be done as states in the polling loop.
122  *
123  * Return: The key pressed or a control code derived from an escape sequence.
124  */
125 char kdb_getchar(void)
126 {
127 #define ESCAPE_UDELAY 1000
128 #define ESCAPE_DELAY (2*1000000/ESCAPE_UDELAY) /* 2 seconds worth of udelays */
129 	char buf[4];	/* longest vt100 escape sequence is 4 bytes */
130 	char *pbuf = buf;
131 	int escape_delay = 0;
132 	get_char_func *f, *f_prev = NULL;
133 	int key;
134 	static bool last_char_was_cr;
135 
136 	for (f = &kdb_poll_funcs[0]; ; ++f) {
137 		if (*f == NULL) {
138 			/* Reset NMI watchdog once per poll loop */
139 			touch_nmi_watchdog();
140 			f = &kdb_poll_funcs[0];
141 		}
142 
143 		key = (*f)();
144 		if (key == -1) {
145 			if (escape_delay) {
146 				udelay(ESCAPE_UDELAY);
147 				if (--escape_delay == 0)
148 					return '\e';
149 			}
150 			continue;
151 		}
152 
153 		/*
154 		 * The caller expects that newlines are either CR or LF. However
155 		 * some terminals send _both_ CR and LF. Avoid having to handle
156 		 * this in the caller by stripping the LF if we saw a CR right
157 		 * before.
158 		 */
159 		if (last_char_was_cr && key == '\n') {
160 			last_char_was_cr = false;
161 			continue;
162 		}
163 		last_char_was_cr = (key == '\r');
164 
165 		/*
166 		 * When the first character is received (or we get a change
167 		 * input source) we set ourselves up to handle an escape
168 		 * sequences (just in case).
169 		 */
170 		if (f_prev != f) {
171 			f_prev = f;
172 			pbuf = buf;
173 			escape_delay = ESCAPE_DELAY;
174 		}
175 
176 		*pbuf++ = key;
177 		key = kdb_handle_escape(buf, pbuf - buf);
178 		if (key < 0) /* no escape sequence; return best character */
179 			return buf[pbuf - buf == 2 ? 1 : 0];
180 		if (key > 0)
181 			return key;
182 	}
183 
184 	unreachable();
185 }
186 
187 /**
188  * kdb_position_cursor() - Place cursor in the correct horizontal position
189  * @prompt: Nil-terminated string containing the prompt string
190  * @buffer: Nil-terminated string containing the entire command line
191  * @cp: Cursor position, pointer the character in buffer where the cursor
192  *      should be positioned.
193  *
194  * The cursor is positioned by sending a carriage-return and then printing
195  * the content of the line until we reach the correct cursor position.
196  *
197  * There is some additional fine detail here.
198  *
199  * Firstly, even though kdb_printf() will correctly format zero-width fields
200  * we want the second call to kdb_printf() to be conditional. That keeps things
201  * a little cleaner when LOGGING=1.
202  *
203  * Secondly, we can't combine everything into one call to kdb_printf() since
204  * that renders into a fixed length buffer and the combined print could result
205  * in unwanted truncation.
206  */
207 static void kdb_position_cursor(char *prompt, char *buffer, char *cp)
208 {
209 	kdb_printf("\r%s", kdb_prompt_str);
210 	if (cp > buffer)
211 		kdb_printf("%.*s", (int)(cp - buffer), buffer);
212 }
213 
214 /*
215  * kdb_read
216  *
217  *	This function reads a string of characters, terminated by
218  *	a newline, or by reaching the end of the supplied buffer,
219  *	from the current kernel debugger console device.
220  * Parameters:
221  *	buffer	- Address of character buffer to receive input characters.
222  *	bufsize - size, in bytes, of the character buffer
223  * Returns:
224  *	Returns a pointer to the buffer containing the received
225  *	character string.  This string will be terminated by a
226  *	newline character.
227  * Locking:
228  *	No locks are required to be held upon entry to this
229  *	function.  It is not reentrant - it relies on the fact
230  *	that while kdb is running on only one "master debug" cpu.
231  * Remarks:
232  *	The buffer size must be >= 2.
233  */
234 
235 static char *kdb_read(char *buffer, size_t bufsize)
236 {
237 	char *cp = buffer;
238 	char *bufend = buffer+bufsize-2;	/* Reserve space for newline
239 						 * and null byte */
240 	char *lastchar;
241 	char *p_tmp;
242 	static char tmpbuffer[CMD_BUFLEN];
243 	int len = strlen(buffer);
244 	int len_tmp;
245 	int tab = 0;
246 	int count;
247 	int i;
248 	int diag, dtab_count;
249 	int key, buf_size, ret;
250 
251 
252 	diag = kdbgetintenv("DTABCOUNT", &dtab_count);
253 	if (diag)
254 		dtab_count = 30;
255 
256 	if (len > 0) {
257 		cp += len;
258 		if (*(buffer+len-1) == '\n')
259 			cp--;
260 	}
261 
262 	lastchar = cp;
263 	*cp = '\0';
264 	kdb_printf("%s", buffer);
265 poll_again:
266 	key = kdb_getchar();
267 	if (key != 9)
268 		tab = 0;
269 	switch (key) {
270 	case 8: /* backspace */
271 		if (cp > buffer) {
272 			if (cp < lastchar) {
273 				memcpy(tmpbuffer, cp, lastchar - cp);
274 				memcpy(cp-1, tmpbuffer, lastchar - cp);
275 			}
276 			*(--lastchar) = '\0';
277 			--cp;
278 			kdb_printf("\b%s ", cp);
279 			kdb_position_cursor(kdb_prompt_str, buffer, cp);
280 		}
281 		break;
282 	case 10: /* linefeed */
283 	case 13: /* carriage return */
284 		*lastchar++ = '\n';
285 		*lastchar++ = '\0';
286 		if (!KDB_STATE(KGDB_TRANS)) {
287 			KDB_STATE_SET(KGDB_TRANS);
288 			kdb_printf("%s", buffer);
289 		}
290 		kdb_printf("\n");
291 		return buffer;
292 	case 4: /* Del */
293 		if (cp < lastchar) {
294 			memcpy(tmpbuffer, cp+1, lastchar - cp - 1);
295 			memcpy(cp, tmpbuffer, lastchar - cp - 1);
296 			*(--lastchar) = '\0';
297 			kdb_printf("%s ", cp);
298 			kdb_position_cursor(kdb_prompt_str, buffer, cp);
299 		}
300 		break;
301 	case 1: /* Home */
302 		if (cp > buffer) {
303 			cp = buffer;
304 			kdb_position_cursor(kdb_prompt_str, buffer, cp);
305 		}
306 		break;
307 	case 5: /* End */
308 		if (cp < lastchar) {
309 			kdb_printf("%s", cp);
310 			cp = lastchar;
311 		}
312 		break;
313 	case 2: /* Left */
314 		if (cp > buffer) {
315 			kdb_printf("\b");
316 			--cp;
317 		}
318 		break;
319 	case 14: /* Down */
320 		memset(tmpbuffer, ' ',
321 		       strlen(kdb_prompt_str) + (lastchar-buffer));
322 		*(tmpbuffer+strlen(kdb_prompt_str) +
323 		  (lastchar-buffer)) = '\0';
324 		kdb_printf("\r%s\r", tmpbuffer);
325 		*lastchar = (char)key;
326 		*(lastchar+1) = '\0';
327 		return lastchar;
328 	case 6: /* Right */
329 		if (cp < lastchar) {
330 			kdb_printf("%c", *cp);
331 			++cp;
332 		}
333 		break;
334 	case 16: /* Up */
335 		memset(tmpbuffer, ' ',
336 		       strlen(kdb_prompt_str) + (lastchar-buffer));
337 		*(tmpbuffer+strlen(kdb_prompt_str) +
338 		  (lastchar-buffer)) = '\0';
339 		kdb_printf("\r%s\r", tmpbuffer);
340 		*lastchar = (char)key;
341 		*(lastchar+1) = '\0';
342 		return lastchar;
343 	case 9: /* Tab */
344 		if (tab < 2)
345 			++tab;
346 		p_tmp = buffer;
347 		while (*p_tmp == ' ')
348 			p_tmp++;
349 		if (p_tmp > cp)
350 			break;
351 		memcpy(tmpbuffer, p_tmp, cp-p_tmp);
352 		*(tmpbuffer + (cp-p_tmp)) = '\0';
353 		p_tmp = strrchr(tmpbuffer, ' ');
354 		if (p_tmp)
355 			++p_tmp;
356 		else
357 			p_tmp = tmpbuffer;
358 		len = strlen(p_tmp);
359 		buf_size = sizeof(tmpbuffer) - (p_tmp - tmpbuffer);
360 		count = kallsyms_symbol_complete(p_tmp, buf_size);
361 		if (tab == 2 && count > 0) {
362 			kdb_printf("\n%d symbols are found.", count);
363 			if (count > dtab_count) {
364 				count = dtab_count;
365 				kdb_printf(" But only first %d symbols will"
366 					   " be printed.\nYou can change the"
367 					   " environment variable DTABCOUNT.",
368 					   count);
369 			}
370 			kdb_printf("\n");
371 			for (i = 0; i < count; i++) {
372 				ret = kallsyms_symbol_next(p_tmp, i, buf_size);
373 				if (WARN_ON(!ret))
374 					break;
375 				if (ret != -E2BIG)
376 					kdb_printf("%s ", p_tmp);
377 				else
378 					kdb_printf("%s... ", p_tmp);
379 				*(p_tmp + len) = '\0';
380 			}
381 			if (i >= dtab_count)
382 				kdb_printf("...");
383 			kdb_printf("\n");
384 			kdb_printf(kdb_prompt_str);
385 			kdb_printf("%s", buffer);
386 			if (cp != lastchar)
387 				kdb_position_cursor(kdb_prompt_str, buffer, cp);
388 		} else if (tab != 2 && count > 0) {
389 			/* How many new characters do we want from tmpbuffer? */
390 			len_tmp = strlen(p_tmp) - len;
391 			if (lastchar + len_tmp >= bufend)
392 				len_tmp = bufend - lastchar;
393 
394 			if (len_tmp) {
395 				/* + 1 ensures the '\0' is memmove'd */
396 				memmove(cp+len_tmp, cp, (lastchar-cp) + 1);
397 				memcpy(cp, p_tmp+len, len_tmp);
398 				kdb_printf("%s", cp);
399 				cp += len_tmp;
400 				lastchar += len_tmp;
401 				if (cp != lastchar)
402 					kdb_position_cursor(kdb_prompt_str,
403 							    buffer, cp);
404 			}
405 		}
406 		kdb_nextline = 1; /* reset output line number */
407 		break;
408 	default:
409 		if (key >= 32 && lastchar < bufend) {
410 			if (cp < lastchar) {
411 				memcpy(tmpbuffer, cp, lastchar - cp);
412 				memcpy(cp+1, tmpbuffer, lastchar - cp);
413 				*++lastchar = '\0';
414 				*cp = key;
415 				kdb_printf("%s", cp);
416 				++cp;
417 				kdb_position_cursor(kdb_prompt_str, buffer, cp);
418 			} else {
419 				*++lastchar = '\0';
420 				*cp++ = key;
421 				/* The kgdb transition check will hide
422 				 * printed characters if we think that
423 				 * kgdb is connecting, until the check
424 				 * fails */
425 				if (!KDB_STATE(KGDB_TRANS)) {
426 					if (kgdb_transition_check(buffer))
427 						return buffer;
428 				} else {
429 					kdb_printf("%c", key);
430 				}
431 			}
432 			/* Special escape to kgdb */
433 			if (lastchar - buffer >= 5 &&
434 			    strcmp(lastchar - 5, "$?#3f") == 0) {
435 				kdb_gdb_state_pass(lastchar - 5);
436 				strcpy(buffer, "kgdb");
437 				KDB_STATE_SET(DOING_KGDB);
438 				return buffer;
439 			}
440 			if (lastchar - buffer >= 11 &&
441 			    strcmp(lastchar - 11, "$qSupported") == 0) {
442 				kdb_gdb_state_pass(lastchar - 11);
443 				strcpy(buffer, "kgdb");
444 				KDB_STATE_SET(DOING_KGDB);
445 				return buffer;
446 			}
447 		}
448 		break;
449 	}
450 	goto poll_again;
451 }
452 
453 /*
454  * kdb_getstr
455  *
456  *	Print the prompt string and read a command from the
457  *	input device.
458  *
459  * Parameters:
460  *	buffer	Address of buffer to receive command
461  *	bufsize Size of buffer in bytes
462  *	prompt	Pointer to string to use as prompt string
463  * Returns:
464  *	Pointer to command buffer.
465  * Locking:
466  *	None.
467  * Remarks:
468  *	For SMP kernels, the processor number will be
469  *	substituted for %d, %x or %o in the prompt.
470  */
471 
472 char *kdb_getstr(char *buffer, size_t bufsize, const char *prompt)
473 {
474 	if (prompt && kdb_prompt_str != prompt)
475 		strscpy(kdb_prompt_str, prompt, CMD_BUFLEN);
476 	kdb_printf(kdb_prompt_str);
477 	kdb_nextline = 1;	/* Prompt and input resets line number */
478 	return kdb_read(buffer, bufsize);
479 }
480 
481 /*
482  * kdb_input_flush
483  *
484  *	Get rid of any buffered console input.
485  *
486  * Parameters:
487  *	none
488  * Returns:
489  *	nothing
490  * Locking:
491  *	none
492  * Remarks:
493  *	Call this function whenever you want to flush input.  If there is any
494  *	outstanding input, it ignores all characters until there has been no
495  *	data for approximately 1ms.
496  */
497 
498 static void kdb_input_flush(void)
499 {
500 	get_char_func *f;
501 	int res;
502 	int flush_delay = 1;
503 	while (flush_delay) {
504 		flush_delay--;
505 empty:
506 		touch_nmi_watchdog();
507 		for (f = &kdb_poll_funcs[0]; *f; ++f) {
508 			res = (*f)();
509 			if (res != -1) {
510 				flush_delay = 1;
511 				goto empty;
512 			}
513 		}
514 		if (flush_delay)
515 			mdelay(1);
516 	}
517 }
518 
519 /*
520  * kdb_printf
521  *
522  *	Print a string to the output device(s).
523  *
524  * Parameters:
525  *	printf-like format and optional args.
526  * Returns:
527  *	0
528  * Locking:
529  *	None.
530  * Remarks:
531  *	use 'kdbcons->write()' to avoid polluting 'log_buf' with
532  *	kdb output.
533  *
534  *  If the user is doing a cmd args | grep srch
535  *  then kdb_grepping_flag is set.
536  *  In that case we need to accumulate full lines (ending in \n) before
537  *  searching for the pattern.
538  */
539 
540 static char kdb_buffer[256];	/* A bit too big to go on stack */
541 static char *next_avail = kdb_buffer;
542 static int  size_avail;
543 static int  suspend_grep;
544 
545 /*
546  * search arg1 to see if it contains arg2
547  * (kdmain.c provides flags for ^pat and pat$)
548  *
549  * return 1 for found, 0 for not found
550  */
551 static int kdb_search_string(char *searched, char *searchfor)
552 {
553 	char firstchar, *cp;
554 	int len1, len2;
555 
556 	/* not counting the newline at the end of "searched" */
557 	len1 = strlen(searched)-1;
558 	len2 = strlen(searchfor);
559 	if (len1 < len2)
560 		return 0;
561 	if (kdb_grep_leading && kdb_grep_trailing && len1 != len2)
562 		return 0;
563 	if (kdb_grep_leading) {
564 		if (!strncmp(searched, searchfor, len2))
565 			return 1;
566 	} else if (kdb_grep_trailing) {
567 		if (!strncmp(searched+len1-len2, searchfor, len2))
568 			return 1;
569 	} else {
570 		firstchar = *searchfor;
571 		cp = searched;
572 		while ((cp = strchr(cp, firstchar))) {
573 			if (!strncmp(cp, searchfor, len2))
574 				return 1;
575 			cp++;
576 		}
577 	}
578 	return 0;
579 }
580 
581 static void kdb_msg_write(const char *msg, int msg_len)
582 {
583 	struct console *c;
584 	const char *cp;
585 	int cookie;
586 	int len;
587 
588 	if (msg_len == 0)
589 		return;
590 
591 	cp = msg;
592 	len = msg_len;
593 
594 	while (len--) {
595 		dbg_io_ops->write_char(*cp);
596 		cp++;
597 	}
598 
599 	/*
600 	 * The console_srcu_read_lock() only provides safe console list
601 	 * traversal. The use of the ->write() callback relies on all other
602 	 * CPUs being stopped at the moment and console drivers being able to
603 	 * handle reentrance when @oops_in_progress is set.
604 	 *
605 	 * There is no guarantee that every console driver can handle
606 	 * reentrance in this way; the developer deploying the debugger
607 	 * is responsible for ensuring that the console drivers they
608 	 * have selected handle reentrance appropriately.
609 	 */
610 	cookie = console_srcu_read_lock();
611 	for_each_console_srcu(c) {
612 		if (!(console_srcu_read_flags(c) & CON_ENABLED))
613 			continue;
614 		if (c == dbg_io_ops->cons)
615 			continue;
616 		if (!c->write)
617 			continue;
618 		/*
619 		 * Set oops_in_progress to encourage the console drivers to
620 		 * disregard their internal spin locks: in the current calling
621 		 * context the risk of deadlock is a bigger problem than risks
622 		 * due to re-entering the console driver. We operate directly on
623 		 * oops_in_progress rather than using bust_spinlocks() because
624 		 * the calls bust_spinlocks() makes on exit are not appropriate
625 		 * for this calling context.
626 		 */
627 		++oops_in_progress;
628 		c->write(c, msg, msg_len);
629 		--oops_in_progress;
630 		touch_nmi_watchdog();
631 	}
632 	console_srcu_read_unlock(cookie);
633 }
634 
635 int vkdb_printf(enum kdb_msgsrc src, const char *fmt, va_list ap)
636 {
637 	int diag;
638 	int linecount;
639 	int colcount;
640 	int logging, saved_loglevel = 0;
641 	int retlen = 0;
642 	int fnd, len;
643 	int this_cpu, old_cpu;
644 	char *cp, *cp2, *cphold = NULL, replaced_byte = ' ';
645 	char *moreprompt = "more> ";
646 	unsigned long flags;
647 
648 	/* Serialize kdb_printf if multiple cpus try to write at once.
649 	 * But if any cpu goes recursive in kdb, just print the output,
650 	 * even if it is interleaved with any other text.
651 	 */
652 	local_irq_save(flags);
653 	this_cpu = smp_processor_id();
654 	for (;;) {
655 		old_cpu = cmpxchg(&kdb_printf_cpu, -1, this_cpu);
656 		if (old_cpu == -1 || old_cpu == this_cpu)
657 			break;
658 
659 		cpu_relax();
660 	}
661 
662 	diag = kdbgetintenv("LINES", &linecount);
663 	if (diag || linecount <= 1)
664 		linecount = 24;
665 
666 	diag = kdbgetintenv("COLUMNS", &colcount);
667 	if (diag || colcount <= 1)
668 		colcount = 80;
669 
670 	diag = kdbgetintenv("LOGGING", &logging);
671 	if (diag)
672 		logging = 0;
673 
674 	if (!kdb_grepping_flag || suspend_grep) {
675 		/* normally, every vsnprintf starts a new buffer */
676 		next_avail = kdb_buffer;
677 		size_avail = sizeof(kdb_buffer);
678 	}
679 	vsnprintf(next_avail, size_avail, fmt, ap);
680 
681 	/*
682 	 * If kdb_parse() found that the command was cmd xxx | grep yyy
683 	 * then kdb_grepping_flag is set, and kdb_grep_string contains yyy
684 	 *
685 	 * Accumulate the print data up to a newline before searching it.
686 	 * (vsnprintf does null-terminate the string that it generates)
687 	 */
688 
689 	/* skip the search if prints are temporarily unconditional */
690 	if (!suspend_grep && kdb_grepping_flag) {
691 		cp = strchr(kdb_buffer, '\n');
692 		if (!cp) {
693 			/*
694 			 * Special cases that don't end with newlines
695 			 * but should be written without one:
696 			 *   The "[nn]kdb> " prompt should
697 			 *   appear at the front of the buffer.
698 			 *
699 			 *   The "[nn]more " prompt should also be
700 			 *     (MOREPROMPT -> moreprompt)
701 			 *   written *   but we print that ourselves,
702 			 *   we set the suspend_grep flag to make
703 			 *   it unconditional.
704 			 *
705 			 */
706 			if (next_avail == kdb_buffer) {
707 				/*
708 				 * these should occur after a newline,
709 				 * so they will be at the front of the
710 				 * buffer
711 				 */
712 				cp2 = kdb_buffer;
713 				len = strlen(kdb_prompt_str);
714 				if (!strncmp(cp2, kdb_prompt_str, len)) {
715 					/*
716 					 * We're about to start a new
717 					 * command, so we can go back
718 					 * to normal mode.
719 					 */
720 					kdb_grepping_flag = 0;
721 					goto kdb_printit;
722 				}
723 			}
724 			/* no newline; don't search/write the buffer
725 			   until one is there */
726 			len = strlen(kdb_buffer);
727 			next_avail = kdb_buffer + len;
728 			size_avail = sizeof(kdb_buffer) - len;
729 			goto kdb_print_out;
730 		}
731 
732 		/*
733 		 * The newline is present; print through it or discard
734 		 * it, depending on the results of the search.
735 		 */
736 		cp++;	 	     /* to byte after the newline */
737 		replaced_byte = *cp; /* remember what/where it was */
738 		cphold = cp;
739 		*cp = '\0';	     /* end the string for our search */
740 
741 		/*
742 		 * We now have a newline at the end of the string
743 		 * Only continue with this output if it contains the
744 		 * search string.
745 		 */
746 		fnd = kdb_search_string(kdb_buffer, kdb_grep_string);
747 		if (!fnd) {
748 			/*
749 			 * At this point the complete line at the start
750 			 * of kdb_buffer can be discarded, as it does
751 			 * not contain what the user is looking for.
752 			 * Shift the buffer left.
753 			 */
754 			*cphold = replaced_byte;
755 			strcpy(kdb_buffer, cphold);
756 			len = strlen(kdb_buffer);
757 			next_avail = kdb_buffer + len;
758 			size_avail = sizeof(kdb_buffer) - len;
759 			goto kdb_print_out;
760 		}
761 		if (kdb_grepping_flag >= KDB_GREPPING_FLAG_SEARCH) {
762 			/*
763 			 * This was a interactive search (using '/' at more
764 			 * prompt) and it has completed. Replace the \0 with
765 			 * its original value to ensure multi-line strings
766 			 * are handled properly, and return to normal mode.
767 			 */
768 			*cphold = replaced_byte;
769 			kdb_grepping_flag = 0;
770 		}
771 		/*
772 		 * at this point the string is a full line and
773 		 * should be printed, up to the null.
774 		 */
775 	}
776 kdb_printit:
777 
778 	/*
779 	 * Write to all consoles.
780 	 */
781 	retlen = strlen(kdb_buffer);
782 	cp = (char *) printk_skip_headers(kdb_buffer);
783 	if (!dbg_kdb_mode && kgdb_connected)
784 		gdbstub_msg_write(cp, retlen - (cp - kdb_buffer));
785 	else
786 		kdb_msg_write(cp, retlen - (cp - kdb_buffer));
787 
788 	if (logging) {
789 		saved_loglevel = console_loglevel;
790 		console_loglevel = CONSOLE_LOGLEVEL_SILENT;
791 		if (printk_get_level(kdb_buffer) || src == KDB_MSGSRC_PRINTK)
792 			printk("%s", kdb_buffer);
793 		else
794 			pr_info("%s", kdb_buffer);
795 	}
796 
797 	if (KDB_STATE(PAGER)) {
798 		/*
799 		 * Check printed string to decide how to bump the
800 		 * kdb_nextline to control when the more prompt should
801 		 * show up.
802 		 */
803 		int got = 0;
804 		len = retlen;
805 		while (len--) {
806 			if (kdb_buffer[len] == '\n') {
807 				kdb_nextline++;
808 				got = 0;
809 			} else if (kdb_buffer[len] == '\r') {
810 				got = 0;
811 			} else {
812 				got++;
813 			}
814 		}
815 		kdb_nextline += got / (colcount + 1);
816 	}
817 
818 	/* check for having reached the LINES number of printed lines */
819 	if (kdb_nextline >= linecount) {
820 		char ch;
821 
822 		/* Watch out for recursion here.  Any routine that calls
823 		 * kdb_printf will come back through here.  And kdb_read
824 		 * uses kdb_printf to echo on serial consoles ...
825 		 */
826 		kdb_nextline = 1;	/* In case of recursion */
827 
828 		/*
829 		 * Pause until cr.
830 		 */
831 		moreprompt = kdbgetenv("MOREPROMPT");
832 		if (moreprompt == NULL)
833 			moreprompt = "more> ";
834 
835 		kdb_input_flush();
836 		kdb_msg_write(moreprompt, strlen(moreprompt));
837 
838 		if (logging)
839 			printk("%s", moreprompt);
840 
841 		ch = kdb_getchar();
842 		kdb_nextline = 1;	/* Really set output line 1 */
843 
844 		/* empty and reset the buffer: */
845 		kdb_buffer[0] = '\0';
846 		next_avail = kdb_buffer;
847 		size_avail = sizeof(kdb_buffer);
848 		if ((ch == 'q') || (ch == 'Q')) {
849 			/* user hit q or Q */
850 			KDB_FLAG_SET(CMD_INTERRUPT); /* command interrupted */
851 			KDB_STATE_CLEAR(PAGER);
852 			/* end of command output; back to normal mode */
853 			kdb_grepping_flag = 0;
854 			kdb_printf("\n");
855 		} else if (ch == ' ') {
856 			kdb_printf("\r");
857 			suspend_grep = 1; /* for this recursion */
858 		} else if (ch == '\n' || ch == '\r') {
859 			kdb_nextline = linecount - 1;
860 			kdb_printf("\r");
861 			suspend_grep = 1; /* for this recursion */
862 		} else if (ch == '/' && !kdb_grepping_flag) {
863 			kdb_printf("\r");
864 			kdb_getstr(kdb_grep_string, KDB_GREP_STRLEN,
865 				   kdbgetenv("SEARCHPROMPT") ?: "search> ");
866 			*strchrnul(kdb_grep_string, '\n') = '\0';
867 			kdb_grepping_flag += KDB_GREPPING_FLAG_SEARCH;
868 			suspend_grep = 1; /* for this recursion */
869 		} else if (ch) {
870 			/* user hit something unexpected */
871 			suspend_grep = 1; /* for this recursion */
872 			if (ch != '/')
873 				kdb_printf(
874 				    "\nOnly 'q', 'Q' or '/' are processed at "
875 				    "more prompt, input ignored\n");
876 			else
877 				kdb_printf("\n'/' cannot be used during | "
878 					   "grep filtering, input ignored\n");
879 		} else if (kdb_grepping_flag) {
880 			/* user hit enter */
881 			suspend_grep = 1; /* for this recursion */
882 			kdb_printf("\n");
883 		}
884 		kdb_input_flush();
885 	}
886 
887 	/*
888 	 * For grep searches, shift the printed string left.
889 	 *  replaced_byte contains the character that was overwritten with
890 	 *  the terminating null, and cphold points to the null.
891 	 * Then adjust the notion of available space in the buffer.
892 	 */
893 	if (kdb_grepping_flag && !suspend_grep) {
894 		*cphold = replaced_byte;
895 		strcpy(kdb_buffer, cphold);
896 		len = strlen(kdb_buffer);
897 		next_avail = kdb_buffer + len;
898 		size_avail = sizeof(kdb_buffer) - len;
899 	}
900 
901 kdb_print_out:
902 	suspend_grep = 0; /* end of what may have been a recursive call */
903 	if (logging)
904 		console_loglevel = saved_loglevel;
905 	/* kdb_printf_cpu locked the code above. */
906 	smp_store_release(&kdb_printf_cpu, old_cpu);
907 	local_irq_restore(flags);
908 	return retlen;
909 }
910 
911 int kdb_printf(const char *fmt, ...)
912 {
913 	va_list ap;
914 	int r;
915 
916 	va_start(ap, fmt);
917 	r = vkdb_printf(KDB_MSGSRC_INTERNAL, fmt, ap);
918 	va_end(ap);
919 
920 	return r;
921 }
922 EXPORT_SYMBOL_GPL(kdb_printf);
923