2 * Kernel Debugger Architecture Independent Console I/O handler
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
8 * Copyright (c) 1999-2006 Silicon Graphics, Inc. All Rights Reserved.
9 * Copyright (c) 2009 Wind River Systems, Inc. All Rights Reserved.
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"
29 #define CMD_BUFLEN 256
30 char kdb_prompt_str[CMD_BUFLEN];
34 static int kgdb_transition_check(char *buffer)
36 if (buffer[0] != '+' && buffer[0] != '$') {
37 KDB_STATE_SET(KGDB_TRANS);
38 kdb_printf("%s", buffer);
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);
51 static int kdb_read_get_key(char *buffer, size_t bufsize)
53 #define ESCAPE_UDELAY 1000
54 #define ESCAPE_DELAY (2*1000000/ESCAPE_UDELAY) /* 2 seconds worth of udelays */
55 char escape_data[5]; /* longest vt100 escape sequence is 4 bytes */
56 char *ped = escape_data;
58 get_char_func *f, *f_escape = NULL;
61 for (f = &kdb_poll_funcs[0]; ; ++f) {
63 /* Reset NMI watchdog once per poll loop */
65 f = &kdb_poll_funcs[0];
67 if (escape_delay == 2) {
72 if (escape_delay == 1) {
81 udelay(ESCAPE_UDELAY);
93 if (escape_delay == 0 && key == '\e') {
94 escape_delay = ESCAPE_DELAY;
104 if (ped - escape_data == 1) {
107 } else if (ped - escape_data == 2) {
112 } else if (ped - escape_data == 3) {
116 case 'A': /* \e[A, up arrow */
119 case 'B': /* \e[B, down arrow */
122 case 'C': /* \e[C, right arrow */
125 case 'D': /* \e[D, left arrow */
128 case '1': /* dropthrough */
129 case '3': /* dropthrough */
130 /* \e[<1,3,4>], may be home, del, end */
137 escape_data[0] = mapkey;
138 escape_data[1] = '\0';
143 } else if (ped - escape_data == 4) {
144 /* \e[<1,3,4><something> */
147 switch (escape_data[2]) {
148 case '1': /* \e[1~, home */
151 case '3': /* \e[3~, del */
154 case '4': /* \e[4~, end */
160 escape_data[0] = mapkey;
161 escape_data[1] = '\0';
167 break; /* A key to process */
175 * This function reads a string of characters, terminated by
176 * a newline, or by reaching the end of the supplied buffer,
177 * from the current kernel debugger console device.
179 * buffer - Address of character buffer to receive input characters.
180 * bufsize - size, in bytes, of the character buffer
182 * Returns a pointer to the buffer containing the received
183 * character string. This string will be terminated by a
186 * No locks are required to be held upon entry to this
187 * function. It is not reentrant - it relies on the fact
188 * that while kdb is running on only one "master debug" cpu.
191 * The buffer size must be >= 2. A buffer size of 2 means that the caller only
192 * wants a single key.
194 * An escape key could be the start of a vt100 control sequence such as \e[D
195 * (left arrow) or it could be a character in its own right. The standard
196 * method for detecting the difference is to wait for 2 seconds to see if there
197 * are any other characters. kdb is complicated by the lack of a timer service
198 * (interrupts are off), by multiple input sources and by the need to sometimes
199 * return after just one key. Escape sequence processing has to be done as
200 * states in the polling loop.
203 static char *kdb_read(char *buffer, size_t bufsize)
206 char *bufend = buffer+bufsize-2; /* Reserve space for newline
211 static char tmpbuffer[CMD_BUFLEN];
212 int len = strlen(buffer);
217 int diag, dtab_count;
218 int key, buf_size, ret;
221 diag = kdbgetintenv("DTABCOUNT", &dtab_count);
227 if (*(buffer+len-1) == '\n')
233 kdb_printf("%s", buffer);
235 key = kdb_read_get_key(buffer, bufsize);
241 case 8: /* backspace */
244 memcpy(tmpbuffer, cp, lastchar - cp);
245 memcpy(cp-1, tmpbuffer, lastchar - cp);
247 *(--lastchar) = '\0';
249 kdb_printf("\b%s \r", cp);
252 kdb_printf(kdb_prompt_str);
253 kdb_printf("%s", buffer);
260 if (!KDB_STATE(KGDB_TRANS)) {
261 KDB_STATE_SET(KGDB_TRANS);
262 kdb_printf("%s", buffer);
268 memcpy(tmpbuffer, cp+1, lastchar - cp - 1);
269 memcpy(cp, tmpbuffer, lastchar - cp - 1);
270 *(--lastchar) = '\0';
271 kdb_printf("%s \r", cp);
274 kdb_printf(kdb_prompt_str);
275 kdb_printf("%s", buffer);
282 kdb_printf(kdb_prompt_str);
288 kdb_printf("%s", cp);
299 memset(tmpbuffer, ' ',
300 strlen(kdb_prompt_str) + (lastchar-buffer));
301 *(tmpbuffer+strlen(kdb_prompt_str) +
302 (lastchar-buffer)) = '\0';
303 kdb_printf("\r%s\r", tmpbuffer);
304 *lastchar = (char)key;
305 *(lastchar+1) = '\0';
309 kdb_printf("%c", *cp);
314 memset(tmpbuffer, ' ',
315 strlen(kdb_prompt_str) + (lastchar-buffer));
316 *(tmpbuffer+strlen(kdb_prompt_str) +
317 (lastchar-buffer)) = '\0';
318 kdb_printf("\r%s\r", tmpbuffer);
319 *lastchar = (char)key;
320 *(lastchar+1) = '\0';
326 while (*p_tmp == ' ')
330 memcpy(tmpbuffer, p_tmp, cp-p_tmp);
331 *(tmpbuffer + (cp-p_tmp)) = '\0';
332 p_tmp = strrchr(tmpbuffer, ' ');
338 buf_size = sizeof(tmpbuffer) - (p_tmp - tmpbuffer);
339 count = kallsyms_symbol_complete(p_tmp, buf_size);
340 if (tab == 2 && count > 0) {
341 kdb_printf("\n%d symbols are found.", count);
342 if (count > dtab_count) {
344 kdb_printf(" But only first %d symbols will"
345 " be printed.\nYou can change the"
346 " environment variable DTABCOUNT.",
350 for (i = 0; i < count; i++) {
351 ret = kallsyms_symbol_next(p_tmp, i, buf_size);
355 kdb_printf("%s ", p_tmp);
357 kdb_printf("%s... ", p_tmp);
358 *(p_tmp + len) = '\0';
363 kdb_printf(kdb_prompt_str);
364 kdb_printf("%s", buffer);
365 } else if (tab != 2 && count > 0) {
366 len_tmp = strlen(p_tmp);
367 strncpy(p_tmp+len_tmp, cp, lastchar-cp+1);
368 len_tmp = strlen(p_tmp);
369 strncpy(cp, p_tmp+len, len_tmp-len + 1);
371 kdb_printf("%s", cp);
375 kdb_nextline = 1; /* reset output line number */
378 if (key >= 32 && lastchar < bufend) {
380 memcpy(tmpbuffer, cp, lastchar - cp);
381 memcpy(cp+1, tmpbuffer, lastchar - cp);
384 kdb_printf("%s\r", cp);
388 kdb_printf(kdb_prompt_str);
389 kdb_printf("%s", buffer);
394 /* The kgdb transition check will hide
395 * printed characters if we think that
396 * kgdb is connecting, until the check
398 if (!KDB_STATE(KGDB_TRANS)) {
399 if (kgdb_transition_check(buffer))
402 kdb_printf("%c", key);
405 /* Special escape to kgdb */
406 if (lastchar - buffer >= 5 &&
407 strcmp(lastchar - 5, "$?#3f") == 0) {
408 kdb_gdb_state_pass(lastchar - 5);
409 strcpy(buffer, "kgdb");
410 KDB_STATE_SET(DOING_KGDB);
413 if (lastchar - buffer >= 11 &&
414 strcmp(lastchar - 11, "$qSupported") == 0) {
415 kdb_gdb_state_pass(lastchar - 11);
416 strcpy(buffer, "kgdb");
417 KDB_STATE_SET(DOING_KGDB);
429 * Print the prompt string and read a command from the
433 * buffer Address of buffer to receive command
434 * bufsize Size of buffer in bytes
435 * prompt Pointer to string to use as prompt string
437 * Pointer to command buffer.
441 * For SMP kernels, the processor number will be
442 * substituted for %d, %x or %o in the prompt.
445 char *kdb_getstr(char *buffer, size_t bufsize, const char *prompt)
447 if (prompt && kdb_prompt_str != prompt)
448 strncpy(kdb_prompt_str, prompt, CMD_BUFLEN);
449 kdb_printf(kdb_prompt_str);
450 kdb_nextline = 1; /* Prompt and input resets line number */
451 return kdb_read(buffer, bufsize);
457 * Get rid of any buffered console input.
466 * Call this function whenever you want to flush input. If there is any
467 * outstanding input, it ignores all characters until there has been no
468 * data for approximately 1ms.
471 static void kdb_input_flush(void)
476 while (flush_delay) {
479 touch_nmi_watchdog();
480 for (f = &kdb_poll_funcs[0]; *f; ++f) {
495 * Print a string to the output device(s).
498 * printf-like format and optional args.
504 * use 'kdbcons->write()' to avoid polluting 'log_buf' with
507 * If the user is doing a cmd args | grep srch
508 * then kdb_grepping_flag is set.
509 * In that case we need to accumulate full lines (ending in \n) before
510 * searching for the pattern.
513 static char kdb_buffer[256]; /* A bit too big to go on stack */
514 static char *next_avail = kdb_buffer;
515 static int size_avail;
516 static int suspend_grep;
519 * search arg1 to see if it contains arg2
520 * (kdmain.c provides flags for ^pat and pat$)
522 * return 1 for found, 0 for not found
524 static int kdb_search_string(char *searched, char *searchfor)
529 /* not counting the newline at the end of "searched" */
530 len1 = strlen(searched)-1;
531 len2 = strlen(searchfor);
534 if (kdb_grep_leading && kdb_grep_trailing && len1 != len2)
536 if (kdb_grep_leading) {
537 if (!strncmp(searched, searchfor, len2))
539 } else if (kdb_grep_trailing) {
540 if (!strncmp(searched+len1-len2, searchfor, len2))
543 firstchar = *searchfor;
545 while ((cp = strchr(cp, firstchar))) {
546 if (!strncmp(cp, searchfor, len2))
554 int vkdb_printf(enum kdb_msgsrc src, const char *fmt, va_list ap)
559 int logging, saved_loglevel = 0;
560 int saved_trap_printk;
561 int got_printf_lock = 0;
564 char *cp, *cp2, *cphold = NULL, replaced_byte = ' ';
565 char *moreprompt = "more> ";
566 struct console *c = console_drivers;
567 static DEFINE_SPINLOCK(kdb_printf_lock);
568 unsigned long uninitialized_var(flags);
571 saved_trap_printk = kdb_trap_printk;
574 /* Serialize kdb_printf if multiple cpus try to write at once.
575 * But if any cpu goes recursive in kdb, just print the output,
576 * even if it is interleaved with any other text.
578 if (!KDB_STATE(PRINTF_LOCK)) {
579 KDB_STATE_SET(PRINTF_LOCK);
580 spin_lock_irqsave(&kdb_printf_lock, flags);
582 atomic_inc(&kdb_event);
584 __acquire(kdb_printf_lock);
587 diag = kdbgetintenv("LINES", &linecount);
588 if (diag || linecount <= 1)
591 diag = kdbgetintenv("COLUMNS", &colcount);
592 if (diag || colcount <= 1)
595 diag = kdbgetintenv("LOGGING", &logging);
599 if (!kdb_grepping_flag || suspend_grep) {
600 /* normally, every vsnprintf starts a new buffer */
601 next_avail = kdb_buffer;
602 size_avail = sizeof(kdb_buffer);
604 vsnprintf(next_avail, size_avail, fmt, ap);
607 * If kdb_parse() found that the command was cmd xxx | grep yyy
608 * then kdb_grepping_flag is set, and kdb_grep_string contains yyy
610 * Accumulate the print data up to a newline before searching it.
611 * (vsnprintf does null-terminate the string that it generates)
614 /* skip the search if prints are temporarily unconditional */
615 if (!suspend_grep && kdb_grepping_flag) {
616 cp = strchr(kdb_buffer, '\n');
619 * Special cases that don't end with newlines
620 * but should be written without one:
621 * The "[nn]kdb> " prompt should
622 * appear at the front of the buffer.
624 * The "[nn]more " prompt should also be
625 * (MOREPROMPT -> moreprompt)
626 * written * but we print that ourselves,
627 * we set the suspend_grep flag to make
631 if (next_avail == kdb_buffer) {
633 * these should occur after a newline,
634 * so they will be at the front of the
638 len = strlen(kdb_prompt_str);
639 if (!strncmp(cp2, kdb_prompt_str, len)) {
641 * We're about to start a new
642 * command, so we can go back
645 kdb_grepping_flag = 0;
649 /* no newline; don't search/write the buffer
650 until one is there */
651 len = strlen(kdb_buffer);
652 next_avail = kdb_buffer + len;
653 size_avail = sizeof(kdb_buffer) - len;
658 * The newline is present; print through it or discard
659 * it, depending on the results of the search.
661 cp++; /* to byte after the newline */
662 replaced_byte = *cp; /* remember what/where it was */
664 *cp = '\0'; /* end the string for our search */
667 * We now have a newline at the end of the string
668 * Only continue with this output if it contains the
671 fnd = kdb_search_string(kdb_buffer, kdb_grep_string);
674 * At this point the complete line at the start
675 * of kdb_buffer can be discarded, as it does
676 * not contain what the user is looking for.
677 * Shift the buffer left.
679 *cphold = replaced_byte;
680 strcpy(kdb_buffer, cphold);
681 len = strlen(kdb_buffer);
682 next_avail = kdb_buffer + len;
683 size_avail = sizeof(kdb_buffer) - len;
686 if (kdb_grepping_flag >= KDB_GREPPING_FLAG_SEARCH) {
688 * This was a interactive search (using '/' at more
689 * prompt) and it has completed. Replace the \0 with
690 * its original value to ensure multi-line strings
691 * are handled properly, and return to normal mode.
693 *cphold = replaced_byte;
694 kdb_grepping_flag = 0;
697 * at this point the string is a full line and
698 * should be printed, up to the null.
704 * Write to all consoles.
706 retlen = strlen(kdb_buffer);
707 cp = (char *) printk_skip_level(kdb_buffer);
708 if (!dbg_kdb_mode && kgdb_connected) {
709 gdbstub_msg_write(cp, retlen - (cp - kdb_buffer));
711 if (dbg_io_ops && !dbg_io_ops->is_console) {
712 len = retlen - (cp - kdb_buffer);
715 dbg_io_ops->write_char(*cp2);
720 c->write(c, cp, retlen - (cp - kdb_buffer));
721 touch_nmi_watchdog();
726 saved_loglevel = console_loglevel;
727 console_loglevel = CONSOLE_LOGLEVEL_SILENT;
728 if (printk_get_level(kdb_buffer) || src == KDB_MSGSRC_PRINTK)
729 printk("%s", kdb_buffer);
731 pr_info("%s", kdb_buffer);
734 if (KDB_STATE(PAGER)) {
736 * Check printed string to decide how to bump the
737 * kdb_nextline to control when the more prompt should
743 if (kdb_buffer[len] == '\n') {
746 } else if (kdb_buffer[len] == '\r') {
752 kdb_nextline += got / (colcount + 1);
755 /* check for having reached the LINES number of printed lines */
756 if (kdb_nextline >= linecount) {
759 /* Watch out for recursion here. Any routine that calls
760 * kdb_printf will come back through here. And kdb_read
761 * uses kdb_printf to echo on serial consoles ...
763 kdb_nextline = 1; /* In case of recursion */
768 moreprompt = kdbgetenv("MOREPROMPT");
769 if (moreprompt == NULL)
770 moreprompt = "more> ";
775 if (dbg_io_ops && !dbg_io_ops->is_console) {
776 len = strlen(moreprompt);
779 dbg_io_ops->write_char(*cp);
784 c->write(c, moreprompt, strlen(moreprompt));
785 touch_nmi_watchdog();
790 printk("%s", moreprompt);
792 kdb_read(buf1, 2); /* '2' indicates to return
793 * immediately after getting one key. */
794 kdb_nextline = 1; /* Really set output line 1 */
796 /* empty and reset the buffer: */
797 kdb_buffer[0] = '\0';
798 next_avail = kdb_buffer;
799 size_avail = sizeof(kdb_buffer);
800 if ((buf1[0] == 'q') || (buf1[0] == 'Q')) {
801 /* user hit q or Q */
802 KDB_FLAG_SET(CMD_INTERRUPT); /* command interrupted */
803 KDB_STATE_CLEAR(PAGER);
804 /* end of command output; back to normal mode */
805 kdb_grepping_flag = 0;
807 } else if (buf1[0] == ' ') {
809 suspend_grep = 1; /* for this recursion */
810 } else if (buf1[0] == '\n') {
811 kdb_nextline = linecount - 1;
813 suspend_grep = 1; /* for this recursion */
814 } else if (buf1[0] == '/' && !kdb_grepping_flag) {
816 kdb_getstr(kdb_grep_string, KDB_GREP_STRLEN,
817 kdbgetenv("SEARCHPROMPT") ?: "search> ");
818 *strchrnul(kdb_grep_string, '\n') = '\0';
819 kdb_grepping_flag += KDB_GREPPING_FLAG_SEARCH;
820 suspend_grep = 1; /* for this recursion */
821 } else if (buf1[0] && buf1[0] != '\n') {
822 /* user hit something other than enter */
823 suspend_grep = 1; /* for this recursion */
826 "\nOnly 'q', 'Q' or '/' are processed at "
827 "more prompt, input ignored\n");
829 kdb_printf("\n'/' cannot be used during | "
830 "grep filtering, input ignored\n");
831 } else if (kdb_grepping_flag) {
833 suspend_grep = 1; /* for this recursion */
840 * For grep searches, shift the printed string left.
841 * replaced_byte contains the character that was overwritten with
842 * the terminating null, and cphold points to the null.
843 * Then adjust the notion of available space in the buffer.
845 if (kdb_grepping_flag && !suspend_grep) {
846 *cphold = replaced_byte;
847 strcpy(kdb_buffer, cphold);
848 len = strlen(kdb_buffer);
849 next_avail = kdb_buffer + len;
850 size_avail = sizeof(kdb_buffer) - len;
854 suspend_grep = 0; /* end of what may have been a recursive call */
856 console_loglevel = saved_loglevel;
857 if (KDB_STATE(PRINTF_LOCK) && got_printf_lock) {
859 spin_unlock_irqrestore(&kdb_printf_lock, flags);
860 KDB_STATE_CLEAR(PRINTF_LOCK);
861 atomic_dec(&kdb_event);
863 __release(kdb_printf_lock);
865 kdb_trap_printk = saved_trap_printk;
870 int kdb_printf(const char *fmt, ...)
876 r = vkdb_printf(KDB_MSGSRC_INTERNAL, fmt, ap);
881 EXPORT_SYMBOL_GPL(kdb_printf);