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;
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 count = kallsyms_symbol_complete(p_tmp,
340 (p_tmp - tmpbuffer));
341 if (tab == 2 && count > 0) {
342 kdb_printf("\n%d symbols are found.", count);
343 if (count > dtab_count) {
345 kdb_printf(" But only first %d symbols will"
346 " be printed.\nYou can change the"
347 " environment variable DTABCOUNT.",
351 for (i = 0; i < count; i++) {
352 if (kallsyms_symbol_next(p_tmp, i) < 0)
354 kdb_printf("%s ", p_tmp);
355 *(p_tmp + len) = '\0';
360 kdb_printf(kdb_prompt_str);
361 kdb_printf("%s", buffer);
362 } else if (tab != 2 && count > 0) {
363 len_tmp = strlen(p_tmp);
364 strncpy(p_tmp+len_tmp, cp, lastchar-cp+1);
365 len_tmp = strlen(p_tmp);
366 strncpy(cp, p_tmp+len, len_tmp-len + 1);
368 kdb_printf("%s", cp);
372 kdb_nextline = 1; /* reset output line number */
375 if (key >= 32 && lastchar < bufend) {
377 memcpy(tmpbuffer, cp, lastchar - cp);
378 memcpy(cp+1, tmpbuffer, lastchar - cp);
381 kdb_printf("%s\r", cp);
385 kdb_printf(kdb_prompt_str);
386 kdb_printf("%s", buffer);
391 /* The kgdb transition check will hide
392 * printed characters if we think that
393 * kgdb is connecting, until the check
395 if (!KDB_STATE(KGDB_TRANS)) {
396 if (kgdb_transition_check(buffer))
399 kdb_printf("%c", key);
402 /* Special escape to kgdb */
403 if (lastchar - buffer >= 5 &&
404 strcmp(lastchar - 5, "$?#3f") == 0) {
405 kdb_gdb_state_pass(lastchar - 5);
406 strcpy(buffer, "kgdb");
407 KDB_STATE_SET(DOING_KGDB);
410 if (lastchar - buffer >= 11 &&
411 strcmp(lastchar - 11, "$qSupported") == 0) {
412 kdb_gdb_state_pass(lastchar - 11);
413 strcpy(buffer, "kgdb");
414 KDB_STATE_SET(DOING_KGDB);
426 * Print the prompt string and read a command from the
430 * buffer Address of buffer to receive command
431 * bufsize Size of buffer in bytes
432 * prompt Pointer to string to use as prompt string
434 * Pointer to command buffer.
438 * For SMP kernels, the processor number will be
439 * substituted for %d, %x or %o in the prompt.
442 char *kdb_getstr(char *buffer, size_t bufsize, char *prompt)
444 if (prompt && kdb_prompt_str != prompt)
445 strncpy(kdb_prompt_str, prompt, CMD_BUFLEN);
446 kdb_printf(kdb_prompt_str);
447 kdb_nextline = 1; /* Prompt and input resets line number */
448 return kdb_read(buffer, bufsize);
454 * Get rid of any buffered console input.
463 * Call this function whenever you want to flush input. If there is any
464 * outstanding input, it ignores all characters until there has been no
465 * data for approximately 1ms.
468 static void kdb_input_flush(void)
473 while (flush_delay) {
476 touch_nmi_watchdog();
477 for (f = &kdb_poll_funcs[0]; *f; ++f) {
492 * Print a string to the output device(s).
495 * printf-like format and optional args.
501 * use 'kdbcons->write()' to avoid polluting 'log_buf' with
504 * If the user is doing a cmd args | grep srch
505 * then kdb_grepping_flag is set.
506 * In that case we need to accumulate full lines (ending in \n) before
507 * searching for the pattern.
510 static char kdb_buffer[256]; /* A bit too big to go on stack */
511 static char *next_avail = kdb_buffer;
512 static int size_avail;
513 static int suspend_grep;
516 * search arg1 to see if it contains arg2
517 * (kdmain.c provides flags for ^pat and pat$)
519 * return 1 for found, 0 for not found
521 static int kdb_search_string(char *searched, char *searchfor)
526 /* not counting the newline at the end of "searched" */
527 len1 = strlen(searched)-1;
528 len2 = strlen(searchfor);
531 if (kdb_grep_leading && kdb_grep_trailing && len1 != len2)
533 if (kdb_grep_leading) {
534 if (!strncmp(searched, searchfor, len2))
536 } else if (kdb_grep_trailing) {
537 if (!strncmp(searched+len1-len2, searchfor, len2))
540 firstchar = *searchfor;
542 while ((cp = strchr(cp, firstchar))) {
543 if (!strncmp(cp, searchfor, len2))
551 int vkdb_printf(const char *fmt, va_list ap)
556 int logging, saved_loglevel = 0;
557 int saved_trap_printk;
558 int got_printf_lock = 0;
561 char *cp, *cp2, *cphold = NULL, replaced_byte = ' ';
562 char *moreprompt = "more> ";
563 struct console *c = console_drivers;
564 static DEFINE_SPINLOCK(kdb_printf_lock);
565 unsigned long uninitialized_var(flags);
568 saved_trap_printk = kdb_trap_printk;
571 /* Serialize kdb_printf if multiple cpus try to write at once.
572 * But if any cpu goes recursive in kdb, just print the output,
573 * even if it is interleaved with any other text.
575 if (!KDB_STATE(PRINTF_LOCK)) {
576 KDB_STATE_SET(PRINTF_LOCK);
577 spin_lock_irqsave(&kdb_printf_lock, flags);
579 atomic_inc(&kdb_event);
581 __acquire(kdb_printf_lock);
584 diag = kdbgetintenv("LINES", &linecount);
585 if (diag || linecount <= 1)
588 diag = kdbgetintenv("COLUMNS", &colcount);
589 if (diag || colcount <= 1)
592 diag = kdbgetintenv("LOGGING", &logging);
596 if (!kdb_grepping_flag || suspend_grep) {
597 /* normally, every vsnprintf starts a new buffer */
598 next_avail = kdb_buffer;
599 size_avail = sizeof(kdb_buffer);
601 vsnprintf(next_avail, size_avail, fmt, ap);
604 * If kdb_parse() found that the command was cmd xxx | grep yyy
605 * then kdb_grepping_flag is set, and kdb_grep_string contains yyy
607 * Accumulate the print data up to a newline before searching it.
608 * (vsnprintf does null-terminate the string that it generates)
611 /* skip the search if prints are temporarily unconditional */
612 if (!suspend_grep && kdb_grepping_flag) {
613 cp = strchr(kdb_buffer, '\n');
616 * Special cases that don't end with newlines
617 * but should be written without one:
618 * The "[nn]kdb> " prompt should
619 * appear at the front of the buffer.
621 * The "[nn]more " prompt should also be
622 * (MOREPROMPT -> moreprompt)
623 * written * but we print that ourselves,
624 * we set the suspend_grep flag to make
628 if (next_avail == kdb_buffer) {
630 * these should occur after a newline,
631 * so they will be at the front of the
635 len = strlen(kdb_prompt_str);
636 if (!strncmp(cp2, kdb_prompt_str, len)) {
638 * We're about to start a new
639 * command, so we can go back
642 kdb_grepping_flag = 0;
646 /* no newline; don't search/write the buffer
647 until one is there */
648 len = strlen(kdb_buffer);
649 next_avail = kdb_buffer + len;
650 size_avail = sizeof(kdb_buffer) - len;
655 * The newline is present; print through it or discard
656 * it, depending on the results of the search.
658 cp++; /* to byte after the newline */
659 replaced_byte = *cp; /* remember what/where it was */
661 *cp = '\0'; /* end the string for our search */
664 * We now have a newline at the end of the string
665 * Only continue with this output if it contains the
668 fnd = kdb_search_string(kdb_buffer, kdb_grep_string);
671 * At this point the complete line at the start
672 * of kdb_buffer can be discarded, as it does
673 * not contain what the user is looking for.
674 * Shift the buffer left.
676 *cphold = replaced_byte;
677 strcpy(kdb_buffer, cphold);
678 len = strlen(kdb_buffer);
679 next_avail = kdb_buffer + len;
680 size_avail = sizeof(kdb_buffer) - len;
684 * at this point the string is a full line and
685 * should be printed, up to the null.
691 * Write to all consoles.
693 retlen = strlen(kdb_buffer);
694 if (!dbg_kdb_mode && kgdb_connected) {
695 gdbstub_msg_write(kdb_buffer, retlen);
697 if (dbg_io_ops && !dbg_io_ops->is_console) {
701 dbg_io_ops->write_char(*cp);
706 c->write(c, kdb_buffer, retlen);
707 touch_nmi_watchdog();
712 saved_loglevel = console_loglevel;
713 console_loglevel = 0;
714 printk(KERN_INFO "%s", kdb_buffer);
717 if (KDB_STATE(PAGER)) {
719 * Check printed string to decide how to bump the
720 * kdb_nextline to control when the more prompt should
726 if (kdb_buffer[len] == '\n') {
729 } else if (kdb_buffer[len] == '\r') {
735 kdb_nextline += got / (colcount + 1);
738 /* check for having reached the LINES number of printed lines */
739 if (kdb_nextline >= linecount) {
742 /* Watch out for recursion here. Any routine that calls
743 * kdb_printf will come back through here. And kdb_read
744 * uses kdb_printf to echo on serial consoles ...
746 kdb_nextline = 1; /* In case of recursion */
751 moreprompt = kdbgetenv("MOREPROMPT");
752 if (moreprompt == NULL)
753 moreprompt = "more> ";
758 if (dbg_io_ops && !dbg_io_ops->is_console) {
759 len = strlen(moreprompt);
762 dbg_io_ops->write_char(*cp);
767 c->write(c, moreprompt, strlen(moreprompt));
768 touch_nmi_watchdog();
773 printk("%s", moreprompt);
775 kdb_read(buf1, 2); /* '2' indicates to return
776 * immediately after getting one key. */
777 kdb_nextline = 1; /* Really set output line 1 */
779 /* empty and reset the buffer: */
780 kdb_buffer[0] = '\0';
781 next_avail = kdb_buffer;
782 size_avail = sizeof(kdb_buffer);
783 if ((buf1[0] == 'q') || (buf1[0] == 'Q')) {
784 /* user hit q or Q */
785 KDB_FLAG_SET(CMD_INTERRUPT); /* command interrupted */
786 KDB_STATE_CLEAR(PAGER);
787 /* end of command output; back to normal mode */
788 kdb_grepping_flag = 0;
790 } else if (buf1[0] == ' ') {
792 suspend_grep = 1; /* for this recursion */
793 } else if (buf1[0] == '\n') {
794 kdb_nextline = linecount - 1;
796 suspend_grep = 1; /* for this recursion */
797 } else if (buf1[0] && buf1[0] != '\n') {
798 /* user hit something other than enter */
799 suspend_grep = 1; /* for this recursion */
800 kdb_printf("\nOnly 'q' or 'Q' are processed at more "
801 "prompt, input ignored\n");
802 } else if (kdb_grepping_flag) {
804 suspend_grep = 1; /* for this recursion */
811 * For grep searches, shift the printed string left.
812 * replaced_byte contains the character that was overwritten with
813 * the terminating null, and cphold points to the null.
814 * Then adjust the notion of available space in the buffer.
816 if (kdb_grepping_flag && !suspend_grep) {
817 *cphold = replaced_byte;
818 strcpy(kdb_buffer, cphold);
819 len = strlen(kdb_buffer);
820 next_avail = kdb_buffer + len;
821 size_avail = sizeof(kdb_buffer) - len;
825 suspend_grep = 0; /* end of what may have been a recursive call */
827 console_loglevel = saved_loglevel;
828 if (KDB_STATE(PRINTF_LOCK) && got_printf_lock) {
830 spin_unlock_irqrestore(&kdb_printf_lock, flags);
831 KDB_STATE_CLEAR(PRINTF_LOCK);
832 atomic_dec(&kdb_event);
834 __release(kdb_printf_lock);
836 kdb_trap_printk = saved_trap_printk;
841 int kdb_printf(const char *fmt, ...)
847 r = vkdb_printf(fmt, ap);
852 EXPORT_SYMBOL_GPL(kdb_printf);