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