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 void kgdb_transition_check(char *buffer
)
36 int slen
= strlen(buffer
);
37 if (strncmp(buffer
, "$?#3f", slen
) != 0 &&
38 strncmp(buffer
, "$qSupported#37", slen
) != 0 &&
39 strncmp(buffer
, "+$qSupported#37", slen
) != 0) {
40 KDB_STATE_SET(KGDB_TRANS
);
41 kdb_printf("%s", buffer
);
45 static int kdb_read_get_key(char *buffer
, size_t bufsize
)
47 #define ESCAPE_UDELAY 1000
48 #define ESCAPE_DELAY (2*1000000/ESCAPE_UDELAY) /* 2 seconds worth of udelays */
49 char escape_data
[5]; /* longest vt100 escape sequence is 4 bytes */
50 char *ped
= escape_data
;
52 get_char_func
*f
, *f_escape
= NULL
;
55 for (f
= &kdb_poll_funcs
[0]; ; ++f
) {
57 /* Reset NMI watchdog once per poll loop */
59 f
= &kdb_poll_funcs
[0];
61 if (escape_delay
== 2) {
66 if (escape_delay
== 1) {
75 udelay(ESCAPE_UDELAY
);
87 if (escape_delay
== 0 && key
== '\e') {
88 escape_delay
= ESCAPE_DELAY
;
98 if (ped
- escape_data
== 1) {
101 } else if (ped
- escape_data
== 2) {
106 } else if (ped
- escape_data
== 3) {
110 case 'A': /* \e[A, up arrow */
113 case 'B': /* \e[B, down arrow */
116 case 'C': /* \e[C, right arrow */
119 case 'D': /* \e[D, left arrow */
122 case '1': /* dropthrough */
123 case '3': /* dropthrough */
124 /* \e[<1,3,4>], may be home, del, end */
131 escape_data
[0] = mapkey
;
132 escape_data
[1] = '\0';
137 } else if (ped
- escape_data
== 4) {
138 /* \e[<1,3,4><something> */
141 switch (escape_data
[2]) {
142 case '1': /* \e[1~, home */
145 case '3': /* \e[3~, del */
148 case '4': /* \e[4~, end */
154 escape_data
[0] = mapkey
;
155 escape_data
[1] = '\0';
161 break; /* A key to process */
169 * This function reads a string of characters, terminated by
170 * a newline, or by reaching the end of the supplied buffer,
171 * from the current kernel debugger console device.
173 * buffer - Address of character buffer to receive input characters.
174 * bufsize - size, in bytes, of the character buffer
176 * Returns a pointer to the buffer containing the received
177 * character string. This string will be terminated by a
180 * No locks are required to be held upon entry to this
181 * function. It is not reentrant - it relies on the fact
182 * that while kdb is running on only one "master debug" cpu.
185 * The buffer size must be >= 2. A buffer size of 2 means that the caller only
186 * wants a single key.
188 * An escape key could be the start of a vt100 control sequence such as \e[D
189 * (left arrow) or it could be a character in its own right. The standard
190 * method for detecting the difference is to wait for 2 seconds to see if there
191 * are any other characters. kdb is complicated by the lack of a timer service
192 * (interrupts are off), by multiple input sources and by the need to sometimes
193 * return after just one key. Escape sequence processing has to be done as
194 * states in the polling loop.
197 static char *kdb_read(char *buffer
, size_t bufsize
)
200 char *bufend
= buffer
+bufsize
-2; /* Reserve space for newline
205 static char tmpbuffer
[CMD_BUFLEN
];
206 int len
= strlen(buffer
);
211 int diag
, dtab_count
;
215 diag
= kdbgetintenv("DTABCOUNT", &dtab_count
);
221 if (*(buffer
+len
-1) == '\n')
227 kdb_printf("%s", buffer
);
229 key
= kdb_read_get_key(buffer
, bufsize
);
235 case 8: /* backspace */
238 memcpy(tmpbuffer
, cp
, lastchar
- cp
);
239 memcpy(cp
-1, tmpbuffer
, lastchar
- cp
);
241 *(--lastchar
) = '\0';
243 kdb_printf("\b%s \r", cp
);
246 kdb_printf(kdb_prompt_str
);
247 kdb_printf("%s", buffer
);
258 memcpy(tmpbuffer
, cp
+1, lastchar
- cp
- 1);
259 memcpy(cp
, tmpbuffer
, lastchar
- cp
- 1);
260 *(--lastchar
) = '\0';
261 kdb_printf("%s \r", cp
);
264 kdb_printf(kdb_prompt_str
);
265 kdb_printf("%s", buffer
);
272 kdb_printf(kdb_prompt_str
);
278 kdb_printf("%s", cp
);
289 memset(tmpbuffer
, ' ',
290 strlen(kdb_prompt_str
) + (lastchar
-buffer
));
291 *(tmpbuffer
+strlen(kdb_prompt_str
) +
292 (lastchar
-buffer
)) = '\0';
293 kdb_printf("\r%s\r", tmpbuffer
);
294 *lastchar
= (char)key
;
295 *(lastchar
+1) = '\0';
299 kdb_printf("%c", *cp
);
304 memset(tmpbuffer
, ' ',
305 strlen(kdb_prompt_str
) + (lastchar
-buffer
));
306 *(tmpbuffer
+strlen(kdb_prompt_str
) +
307 (lastchar
-buffer
)) = '\0';
308 kdb_printf("\r%s\r", tmpbuffer
);
309 *lastchar
= (char)key
;
310 *(lastchar
+1) = '\0';
316 while (*p_tmp
== ' ')
320 memcpy(tmpbuffer
, p_tmp
, cp
-p_tmp
);
321 *(tmpbuffer
+ (cp
-p_tmp
)) = '\0';
322 p_tmp
= strrchr(tmpbuffer
, ' ');
328 count
= kallsyms_symbol_complete(p_tmp
,
330 (p_tmp
- tmpbuffer
));
331 if (tab
== 2 && count
> 0) {
332 kdb_printf("\n%d symbols are found.", count
);
333 if (count
> dtab_count
) {
335 kdb_printf(" But only first %d symbols will"
336 " be printed.\nYou can change the"
337 " environment variable DTABCOUNT.",
341 for (i
= 0; i
< count
; i
++) {
342 if (kallsyms_symbol_next(p_tmp
, i
) < 0)
344 kdb_printf("%s ", p_tmp
);
345 *(p_tmp
+ len
) = '\0';
350 kdb_printf(kdb_prompt_str
);
351 kdb_printf("%s", buffer
);
352 } else if (tab
!= 2 && count
> 0) {
353 len_tmp
= strlen(p_tmp
);
354 strncpy(p_tmp
+len_tmp
, cp
, lastchar
-cp
+1);
355 len_tmp
= strlen(p_tmp
);
356 strncpy(cp
, p_tmp
+len
, len_tmp
-len
+ 1);
358 kdb_printf("%s", cp
);
362 kdb_nextline
= 1; /* reset output line number */
365 if (key
>= 32 && lastchar
< bufend
) {
367 memcpy(tmpbuffer
, cp
, lastchar
- cp
);
368 memcpy(cp
+1, tmpbuffer
, lastchar
- cp
);
371 kdb_printf("%s\r", cp
);
375 kdb_printf(kdb_prompt_str
);
376 kdb_printf("%s", buffer
);
381 /* The kgdb transition check will hide
382 * printed characters if we think that
383 * kgdb is connecting, until the check
385 if (!KDB_STATE(KGDB_TRANS
))
386 kgdb_transition_check(buffer
);
388 kdb_printf("%c", key
);
390 /* Special escape to kgdb */
391 if (lastchar
- buffer
>= 5 &&
392 strcmp(lastchar
- 5, "$?#3f") == 0) {
393 strcpy(buffer
, "kgdb");
394 KDB_STATE_SET(DOING_KGDB
);
397 if (lastchar
- buffer
>= 14 &&
398 strcmp(lastchar
- 14, "$qSupported#37") == 0) {
399 strcpy(buffer
, "kgdb");
400 KDB_STATE_SET(DOING_KGDB2
);
412 * Print the prompt string and read a command from the
416 * buffer Address of buffer to receive command
417 * bufsize Size of buffer in bytes
418 * prompt Pointer to string to use as prompt string
420 * Pointer to command buffer.
424 * For SMP kernels, the processor number will be
425 * substituted for %d, %x or %o in the prompt.
428 char *kdb_getstr(char *buffer
, size_t bufsize
, char *prompt
)
430 if (prompt
&& kdb_prompt_str
!= prompt
)
431 strncpy(kdb_prompt_str
, prompt
, CMD_BUFLEN
);
432 kdb_printf(kdb_prompt_str
);
433 kdb_nextline
= 1; /* Prompt and input resets line number */
434 return kdb_read(buffer
, bufsize
);
440 * Get rid of any buffered console input.
449 * Call this function whenever you want to flush input. If there is any
450 * outstanding input, it ignores all characters until there has been no
451 * data for approximately 1ms.
454 static void kdb_input_flush(void)
459 while (flush_delay
) {
462 touch_nmi_watchdog();
463 for (f
= &kdb_poll_funcs
[0]; *f
; ++f
) {
478 * Print a string to the output device(s).
481 * printf-like format and optional args.
487 * use 'kdbcons->write()' to avoid polluting 'log_buf' with
490 * If the user is doing a cmd args | grep srch
491 * then kdb_grepping_flag is set.
492 * In that case we need to accumulate full lines (ending in \n) before
493 * searching for the pattern.
496 static char kdb_buffer
[256]; /* A bit too big to go on stack */
497 static char *next_avail
= kdb_buffer
;
498 static int size_avail
;
499 static int suspend_grep
;
502 * search arg1 to see if it contains arg2
503 * (kdmain.c provides flags for ^pat and pat$)
505 * return 1 for found, 0 for not found
507 static int kdb_search_string(char *searched
, char *searchfor
)
512 /* not counting the newline at the end of "searched" */
513 len1
= strlen(searched
)-1;
514 len2
= strlen(searchfor
);
517 if (kdb_grep_leading
&& kdb_grep_trailing
&& len1
!= len2
)
519 if (kdb_grep_leading
) {
520 if (!strncmp(searched
, searchfor
, len2
))
522 } else if (kdb_grep_trailing
) {
523 if (!strncmp(searched
+len1
-len2
, searchfor
, len2
))
526 firstchar
= *searchfor
;
528 while ((cp
= strchr(cp
, firstchar
))) {
529 if (!strncmp(cp
, searchfor
, len2
))
537 int vkdb_printf(const char *fmt
, va_list ap
)
541 int logging
, saved_loglevel
= 0;
542 int saved_trap_printk
;
543 int got_printf_lock
= 0;
546 char *cp
, *cp2
, *cphold
= NULL
, replaced_byte
= ' ';
547 char *moreprompt
= "more> ";
548 struct console
*c
= console_drivers
;
549 static DEFINE_SPINLOCK(kdb_printf_lock
);
550 unsigned long uninitialized_var(flags
);
553 saved_trap_printk
= kdb_trap_printk
;
556 /* Serialize kdb_printf if multiple cpus try to write at once.
557 * But if any cpu goes recursive in kdb, just print the output,
558 * even if it is interleaved with any other text.
560 if (!KDB_STATE(PRINTF_LOCK
)) {
561 KDB_STATE_SET(PRINTF_LOCK
);
562 spin_lock_irqsave(&kdb_printf_lock
, flags
);
564 atomic_inc(&kdb_event
);
566 __acquire(kdb_printf_lock
);
569 diag
= kdbgetintenv("LINES", &linecount
);
570 if (diag
|| linecount
<= 1)
573 diag
= kdbgetintenv("LOGGING", &logging
);
577 if (!kdb_grepping_flag
|| suspend_grep
) {
578 /* normally, every vsnprintf starts a new buffer */
579 next_avail
= kdb_buffer
;
580 size_avail
= sizeof(kdb_buffer
);
582 vsnprintf(next_avail
, size_avail
, fmt
, ap
);
585 * If kdb_parse() found that the command was cmd xxx | grep yyy
586 * then kdb_grepping_flag is set, and kdb_grep_string contains yyy
588 * Accumulate the print data up to a newline before searching it.
589 * (vsnprintf does null-terminate the string that it generates)
592 /* skip the search if prints are temporarily unconditional */
593 if (!suspend_grep
&& kdb_grepping_flag
) {
594 cp
= strchr(kdb_buffer
, '\n');
597 * Special cases that don't end with newlines
598 * but should be written without one:
599 * The "[nn]kdb> " prompt should
600 * appear at the front of the buffer.
602 * The "[nn]more " prompt should also be
603 * (MOREPROMPT -> moreprompt)
604 * written * but we print that ourselves,
605 * we set the suspend_grep flag to make
609 if (next_avail
== kdb_buffer
) {
611 * these should occur after a newline,
612 * so they will be at the front of the
616 len
= strlen(kdb_prompt_str
);
617 if (!strncmp(cp2
, kdb_prompt_str
, len
)) {
619 * We're about to start a new
620 * command, so we can go back
623 kdb_grepping_flag
= 0;
627 /* no newline; don't search/write the buffer
628 until one is there */
629 len
= strlen(kdb_buffer
);
630 next_avail
= kdb_buffer
+ len
;
631 size_avail
= sizeof(kdb_buffer
) - len
;
636 * The newline is present; print through it or discard
637 * it, depending on the results of the search.
639 cp
++; /* to byte after the newline */
640 replaced_byte
= *cp
; /* remember what/where it was */
642 *cp
= '\0'; /* end the string for our search */
645 * We now have a newline at the end of the string
646 * Only continue with this output if it contains the
649 fnd
= kdb_search_string(kdb_buffer
, kdb_grep_string
);
652 * At this point the complete line at the start
653 * of kdb_buffer can be discarded, as it does
654 * not contain what the user is looking for.
655 * Shift the buffer left.
657 *cphold
= replaced_byte
;
658 strcpy(kdb_buffer
, cphold
);
659 len
= strlen(kdb_buffer
);
660 next_avail
= kdb_buffer
+ len
;
661 size_avail
= sizeof(kdb_buffer
) - len
;
665 * at this point the string is a full line and
666 * should be printed, up to the null.
672 * Write to all consoles.
674 retlen
= strlen(kdb_buffer
);
675 if (!dbg_kdb_mode
&& kgdb_connected
) {
676 gdbstub_msg_write(kdb_buffer
, retlen
);
678 if (!dbg_io_ops
->is_console
) {
679 len
= strlen(kdb_buffer
);
682 dbg_io_ops
->write_char(*cp
);
687 c
->write(c
, kdb_buffer
, retlen
);
688 touch_nmi_watchdog();
693 saved_loglevel
= console_loglevel
;
694 console_loglevel
= 0;
695 printk(KERN_INFO
"%s", kdb_buffer
);
698 if (KDB_STATE(PAGER
) && strchr(kdb_buffer
, '\n'))
701 /* check for having reached the LINES number of printed lines */
702 if (kdb_nextline
== linecount
) {
704 #if defined(CONFIG_SMP)
708 /* Watch out for recursion here. Any routine that calls
709 * kdb_printf will come back through here. And kdb_read
710 * uses kdb_printf to echo on serial consoles ...
712 kdb_nextline
= 1; /* In case of recursion */
717 moreprompt
= kdbgetenv("MOREPROMPT");
718 if (moreprompt
== NULL
)
719 moreprompt
= "more> ";
721 #if defined(CONFIG_SMP)
722 if (strchr(moreprompt
, '%')) {
723 sprintf(buf2
, moreprompt
, get_cpu());
732 if (!dbg_io_ops
->is_console
) {
733 len
= strlen(moreprompt
);
736 dbg_io_ops
->write_char(*cp
);
741 c
->write(c
, moreprompt
, strlen(moreprompt
));
742 touch_nmi_watchdog();
747 printk("%s", moreprompt
);
749 kdb_read(buf1
, 2); /* '2' indicates to return
750 * immediately after getting one key. */
751 kdb_nextline
= 1; /* Really set output line 1 */
753 /* empty and reset the buffer: */
754 kdb_buffer
[0] = '\0';
755 next_avail
= kdb_buffer
;
756 size_avail
= sizeof(kdb_buffer
);
757 if ((buf1
[0] == 'q') || (buf1
[0] == 'Q')) {
758 /* user hit q or Q */
759 KDB_FLAG_SET(CMD_INTERRUPT
); /* command interrupted */
760 KDB_STATE_CLEAR(PAGER
);
761 /* end of command output; back to normal mode */
762 kdb_grepping_flag
= 0;
764 } else if (buf1
[0] == ' ') {
766 suspend_grep
= 1; /* for this recursion */
767 } else if (buf1
[0] == '\n') {
768 kdb_nextline
= linecount
- 1;
770 suspend_grep
= 1; /* for this recursion */
771 } else if (buf1
[0] && buf1
[0] != '\n') {
772 /* user hit something other than enter */
773 suspend_grep
= 1; /* for this recursion */
774 kdb_printf("\nOnly 'q' or 'Q' are processed at more "
775 "prompt, input ignored\n");
776 } else if (kdb_grepping_flag
) {
778 suspend_grep
= 1; /* for this recursion */
785 * For grep searches, shift the printed string left.
786 * replaced_byte contains the character that was overwritten with
787 * the terminating null, and cphold points to the null.
788 * Then adjust the notion of available space in the buffer.
790 if (kdb_grepping_flag
&& !suspend_grep
) {
791 *cphold
= replaced_byte
;
792 strcpy(kdb_buffer
, cphold
);
793 len
= strlen(kdb_buffer
);
794 next_avail
= kdb_buffer
+ len
;
795 size_avail
= sizeof(kdb_buffer
) - len
;
799 suspend_grep
= 0; /* end of what may have been a recursive call */
801 console_loglevel
= saved_loglevel
;
802 if (KDB_STATE(PRINTF_LOCK
) && got_printf_lock
) {
804 spin_unlock_irqrestore(&kdb_printf_lock
, flags
);
805 KDB_STATE_CLEAR(PRINTF_LOCK
);
806 atomic_dec(&kdb_event
);
808 __release(kdb_printf_lock
);
810 kdb_trap_printk
= saved_trap_printk
;
815 int kdb_printf(const char *fmt
, ...)
821 r
= vkdb_printf(fmt
, ap
);
826 EXPORT_SYMBOL_GPL(kdb_printf
);