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
];
33 int kdb_printf_cpu
= -1;
35 static int kgdb_transition_check(char *buffer
)
37 if (buffer
[0] != '+' && buffer
[0] != '$') {
38 KDB_STATE_SET(KGDB_TRANS
);
39 kdb_printf("%s", buffer
);
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
);
52 static int kdb_read_get_key(char *buffer
, size_t bufsize
)
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
;
59 get_char_func
*f
, *f_escape
= NULL
;
62 for (f
= &kdb_poll_funcs
[0]; ; ++f
) {
64 /* Reset NMI watchdog once per poll loop */
66 f
= &kdb_poll_funcs
[0];
68 if (escape_delay
== 2) {
73 if (escape_delay
== 1) {
82 udelay(ESCAPE_UDELAY
);
94 if (escape_delay
== 0 && key
== '\e') {
95 escape_delay
= ESCAPE_DELAY
;
105 if (ped
- escape_data
== 1) {
108 } else if (ped
- escape_data
== 2) {
113 } else if (ped
- escape_data
== 3) {
117 case 'A': /* \e[A, up arrow */
120 case 'B': /* \e[B, down arrow */
123 case 'C': /* \e[C, right arrow */
126 case 'D': /* \e[D, left arrow */
129 case '1': /* dropthrough */
130 case '3': /* dropthrough */
131 /* \e[<1,3,4>], may be home, del, end */
138 escape_data
[0] = mapkey
;
139 escape_data
[1] = '\0';
144 } else if (ped
- escape_data
== 4) {
145 /* \e[<1,3,4><something> */
148 switch (escape_data
[2]) {
149 case '1': /* \e[1~, home */
152 case '3': /* \e[3~, del */
155 case '4': /* \e[4~, end */
161 escape_data
[0] = mapkey
;
162 escape_data
[1] = '\0';
168 break; /* A key to process */
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.
180 * buffer - Address of character buffer to receive input characters.
181 * bufsize - size, in bytes, of the character buffer
183 * Returns a pointer to the buffer containing the received
184 * character string. This string will be terminated by a
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.
192 * The buffer size must be >= 2. A buffer size of 2 means that the caller only
193 * wants a single key.
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.
204 static char *kdb_read(char *buffer
, size_t bufsize
)
207 char *bufend
= buffer
+bufsize
-2; /* Reserve space for newline
212 static char tmpbuffer
[CMD_BUFLEN
];
213 int len
= strlen(buffer
);
218 int diag
, dtab_count
;
219 int key
, buf_size
, ret
;
222 diag
= kdbgetintenv("DTABCOUNT", &dtab_count
);
228 if (*(buffer
+len
-1) == '\n')
234 kdb_printf("%s", buffer
);
236 key
= kdb_read_get_key(buffer
, bufsize
);
242 case 8: /* backspace */
245 memcpy(tmpbuffer
, cp
, lastchar
- cp
);
246 memcpy(cp
-1, tmpbuffer
, lastchar
- cp
);
248 *(--lastchar
) = '\0';
250 kdb_printf("\b%s \r", cp
);
253 kdb_printf(kdb_prompt_str
);
254 kdb_printf("%s", buffer
);
261 if (!KDB_STATE(KGDB_TRANS
)) {
262 KDB_STATE_SET(KGDB_TRANS
);
263 kdb_printf("%s", buffer
);
269 memcpy(tmpbuffer
, cp
+1, lastchar
- cp
- 1);
270 memcpy(cp
, tmpbuffer
, lastchar
- cp
- 1);
271 *(--lastchar
) = '\0';
272 kdb_printf("%s \r", cp
);
275 kdb_printf(kdb_prompt_str
);
276 kdb_printf("%s", buffer
);
283 kdb_printf(kdb_prompt_str
);
289 kdb_printf("%s", cp
);
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';
310 kdb_printf("%c", *cp
);
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';
327 while (*p_tmp
== ' ')
331 memcpy(tmpbuffer
, p_tmp
, cp
-p_tmp
);
332 *(tmpbuffer
+ (cp
-p_tmp
)) = '\0';
333 p_tmp
= strrchr(tmpbuffer
, ' ');
339 buf_size
= sizeof(tmpbuffer
) - (p_tmp
- tmpbuffer
);
340 count
= kallsyms_symbol_complete(p_tmp
, buf_size
);
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 ret
= kallsyms_symbol_next(p_tmp
, i
, buf_size
);
356 kdb_printf("%s ", p_tmp
);
358 kdb_printf("%s... ", p_tmp
);
359 *(p_tmp
+ len
) = '\0';
364 kdb_printf(kdb_prompt_str
);
365 kdb_printf("%s", buffer
);
366 } else if (tab
!= 2 && count
> 0) {
367 len_tmp
= strlen(p_tmp
);
368 strncpy(p_tmp
+len_tmp
, cp
, lastchar
-cp
+1);
369 len_tmp
= strlen(p_tmp
);
370 strncpy(cp
, p_tmp
+len
, len_tmp
-len
+ 1);
372 kdb_printf("%s", cp
);
376 kdb_nextline
= 1; /* reset output line number */
379 if (key
>= 32 && lastchar
< bufend
) {
381 memcpy(tmpbuffer
, cp
, lastchar
- cp
);
382 memcpy(cp
+1, tmpbuffer
, lastchar
- cp
);
385 kdb_printf("%s\r", cp
);
389 kdb_printf(kdb_prompt_str
);
390 kdb_printf("%s", buffer
);
395 /* The kgdb transition check will hide
396 * printed characters if we think that
397 * kgdb is connecting, until the check
399 if (!KDB_STATE(KGDB_TRANS
)) {
400 if (kgdb_transition_check(buffer
))
403 kdb_printf("%c", key
);
406 /* Special escape to kgdb */
407 if (lastchar
- buffer
>= 5 &&
408 strcmp(lastchar
- 5, "$?#3f") == 0) {
409 kdb_gdb_state_pass(lastchar
- 5);
410 strcpy(buffer
, "kgdb");
411 KDB_STATE_SET(DOING_KGDB
);
414 if (lastchar
- buffer
>= 11 &&
415 strcmp(lastchar
- 11, "$qSupported") == 0) {
416 kdb_gdb_state_pass(lastchar
- 11);
417 strcpy(buffer
, "kgdb");
418 KDB_STATE_SET(DOING_KGDB
);
430 * Print the prompt string and read a command from the
434 * buffer Address of buffer to receive command
435 * bufsize Size of buffer in bytes
436 * prompt Pointer to string to use as prompt string
438 * Pointer to command buffer.
442 * For SMP kernels, the processor number will be
443 * substituted for %d, %x or %o in the prompt.
446 char *kdb_getstr(char *buffer
, size_t bufsize
, const char *prompt
)
448 if (prompt
&& kdb_prompt_str
!= prompt
)
449 strncpy(kdb_prompt_str
, prompt
, CMD_BUFLEN
);
450 kdb_printf(kdb_prompt_str
);
451 kdb_nextline
= 1; /* Prompt and input resets line number */
452 return kdb_read(buffer
, bufsize
);
458 * Get rid of any buffered console input.
467 * Call this function whenever you want to flush input. If there is any
468 * outstanding input, it ignores all characters until there has been no
469 * data for approximately 1ms.
472 static void kdb_input_flush(void)
477 while (flush_delay
) {
480 touch_nmi_watchdog();
481 for (f
= &kdb_poll_funcs
[0]; *f
; ++f
) {
496 * Print a string to the output device(s).
499 * printf-like format and optional args.
505 * use 'kdbcons->write()' to avoid polluting 'log_buf' with
508 * If the user is doing a cmd args | grep srch
509 * then kdb_grepping_flag is set.
510 * In that case we need to accumulate full lines (ending in \n) before
511 * searching for the pattern.
514 static char kdb_buffer
[256]; /* A bit too big to go on stack */
515 static char *next_avail
= kdb_buffer
;
516 static int size_avail
;
517 static int suspend_grep
;
520 * search arg1 to see if it contains arg2
521 * (kdmain.c provides flags for ^pat and pat$)
523 * return 1 for found, 0 for not found
525 static int kdb_search_string(char *searched
, char *searchfor
)
530 /* not counting the newline at the end of "searched" */
531 len1
= strlen(searched
)-1;
532 len2
= strlen(searchfor
);
535 if (kdb_grep_leading
&& kdb_grep_trailing
&& len1
!= len2
)
537 if (kdb_grep_leading
) {
538 if (!strncmp(searched
, searchfor
, len2
))
540 } else if (kdb_grep_trailing
) {
541 if (!strncmp(searched
+len1
-len2
, searchfor
, len2
))
544 firstchar
= *searchfor
;
546 while ((cp
= strchr(cp
, firstchar
))) {
547 if (!strncmp(cp
, searchfor
, len2
))
555 int vkdb_printf(enum kdb_msgsrc src
, const char *fmt
, va_list ap
)
560 int logging
, saved_loglevel
= 0;
563 int this_cpu
, old_cpu
;
564 char *cp
, *cp2
, *cphold
= NULL
, replaced_byte
= ' ';
565 char *moreprompt
= "more> ";
566 struct console
*c
= console_drivers
;
567 unsigned long uninitialized_var(flags
);
569 /* Serialize kdb_printf if multiple cpus try to write at once.
570 * But if any cpu goes recursive in kdb, just print the output,
571 * even if it is interleaved with any other text.
573 local_irq_save(flags
);
574 this_cpu
= smp_processor_id();
576 old_cpu
= cmpxchg(&kdb_printf_cpu
, -1, this_cpu
);
577 if (old_cpu
== -1 || old_cpu
== this_cpu
)
583 diag
= kdbgetintenv("LINES", &linecount
);
584 if (diag
|| linecount
<= 1)
587 diag
= kdbgetintenv("COLUMNS", &colcount
);
588 if (diag
|| colcount
<= 1)
591 diag
= kdbgetintenv("LOGGING", &logging
);
595 if (!kdb_grepping_flag
|| suspend_grep
) {
596 /* normally, every vsnprintf starts a new buffer */
597 next_avail
= kdb_buffer
;
598 size_avail
= sizeof(kdb_buffer
);
600 vsnprintf(next_avail
, size_avail
, fmt
, ap
);
603 * If kdb_parse() found that the command was cmd xxx | grep yyy
604 * then kdb_grepping_flag is set, and kdb_grep_string contains yyy
606 * Accumulate the print data up to a newline before searching it.
607 * (vsnprintf does null-terminate the string that it generates)
610 /* skip the search if prints are temporarily unconditional */
611 if (!suspend_grep
&& kdb_grepping_flag
) {
612 cp
= strchr(kdb_buffer
, '\n');
615 * Special cases that don't end with newlines
616 * but should be written without one:
617 * The "[nn]kdb> " prompt should
618 * appear at the front of the buffer.
620 * The "[nn]more " prompt should also be
621 * (MOREPROMPT -> moreprompt)
622 * written * but we print that ourselves,
623 * we set the suspend_grep flag to make
627 if (next_avail
== kdb_buffer
) {
629 * these should occur after a newline,
630 * so they will be at the front of the
634 len
= strlen(kdb_prompt_str
);
635 if (!strncmp(cp2
, kdb_prompt_str
, len
)) {
637 * We're about to start a new
638 * command, so we can go back
641 kdb_grepping_flag
= 0;
645 /* no newline; don't search/write the buffer
646 until one is there */
647 len
= strlen(kdb_buffer
);
648 next_avail
= kdb_buffer
+ len
;
649 size_avail
= sizeof(kdb_buffer
) - len
;
654 * The newline is present; print through it or discard
655 * it, depending on the results of the search.
657 cp
++; /* to byte after the newline */
658 replaced_byte
= *cp
; /* remember what/where it was */
660 *cp
= '\0'; /* end the string for our search */
663 * We now have a newline at the end of the string
664 * Only continue with this output if it contains the
667 fnd
= kdb_search_string(kdb_buffer
, kdb_grep_string
);
670 * At this point the complete line at the start
671 * of kdb_buffer can be discarded, as it does
672 * not contain what the user is looking for.
673 * Shift the buffer left.
675 *cphold
= replaced_byte
;
676 strcpy(kdb_buffer
, cphold
);
677 len
= strlen(kdb_buffer
);
678 next_avail
= kdb_buffer
+ len
;
679 size_avail
= sizeof(kdb_buffer
) - len
;
682 if (kdb_grepping_flag
>= KDB_GREPPING_FLAG_SEARCH
)
684 * This was a interactive search (using '/' at more
685 * prompt) and it has completed. Clear the flag.
687 kdb_grepping_flag
= 0;
689 * at this point the string is a full line and
690 * should be printed, up to the null.
696 * Write to all consoles.
698 retlen
= strlen(kdb_buffer
);
699 cp
= (char *) printk_skip_headers(kdb_buffer
);
700 if (!dbg_kdb_mode
&& kgdb_connected
) {
701 gdbstub_msg_write(cp
, retlen
- (cp
- kdb_buffer
));
703 if (dbg_io_ops
&& !dbg_io_ops
->is_console
) {
704 len
= retlen
- (cp
- kdb_buffer
);
707 dbg_io_ops
->write_char(*cp2
);
712 c
->write(c
, cp
, retlen
- (cp
- kdb_buffer
));
713 touch_nmi_watchdog();
718 saved_loglevel
= console_loglevel
;
719 console_loglevel
= CONSOLE_LOGLEVEL_SILENT
;
720 if (printk_get_level(kdb_buffer
) || src
== KDB_MSGSRC_PRINTK
)
721 printk("%s", kdb_buffer
);
723 pr_info("%s", kdb_buffer
);
726 if (KDB_STATE(PAGER
)) {
728 * Check printed string to decide how to bump the
729 * kdb_nextline to control when the more prompt should
735 if (kdb_buffer
[len
] == '\n') {
738 } else if (kdb_buffer
[len
] == '\r') {
744 kdb_nextline
+= got
/ (colcount
+ 1);
747 /* check for having reached the LINES number of printed lines */
748 if (kdb_nextline
>= linecount
) {
751 /* Watch out for recursion here. Any routine that calls
752 * kdb_printf will come back through here. And kdb_read
753 * uses kdb_printf to echo on serial consoles ...
755 kdb_nextline
= 1; /* In case of recursion */
760 moreprompt
= kdbgetenv("MOREPROMPT");
761 if (moreprompt
== NULL
)
762 moreprompt
= "more> ";
767 if (dbg_io_ops
&& !dbg_io_ops
->is_console
) {
768 len
= strlen(moreprompt
);
771 dbg_io_ops
->write_char(*cp
);
776 c
->write(c
, moreprompt
, strlen(moreprompt
));
777 touch_nmi_watchdog();
782 printk("%s", moreprompt
);
784 kdb_read(buf1
, 2); /* '2' indicates to return
785 * immediately after getting one key. */
786 kdb_nextline
= 1; /* Really set output line 1 */
788 /* empty and reset the buffer: */
789 kdb_buffer
[0] = '\0';
790 next_avail
= kdb_buffer
;
791 size_avail
= sizeof(kdb_buffer
);
792 if ((buf1
[0] == 'q') || (buf1
[0] == 'Q')) {
793 /* user hit q or Q */
794 KDB_FLAG_SET(CMD_INTERRUPT
); /* command interrupted */
795 KDB_STATE_CLEAR(PAGER
);
796 /* end of command output; back to normal mode */
797 kdb_grepping_flag
= 0;
799 } else if (buf1
[0] == ' ') {
801 suspend_grep
= 1; /* for this recursion */
802 } else if (buf1
[0] == '\n') {
803 kdb_nextline
= linecount
- 1;
805 suspend_grep
= 1; /* for this recursion */
806 } else if (buf1
[0] == '/' && !kdb_grepping_flag
) {
808 kdb_getstr(kdb_grep_string
, KDB_GREP_STRLEN
,
809 kdbgetenv("SEARCHPROMPT") ?: "search> ");
810 *strchrnul(kdb_grep_string
, '\n') = '\0';
811 kdb_grepping_flag
+= KDB_GREPPING_FLAG_SEARCH
;
812 suspend_grep
= 1; /* for this recursion */
813 } else if (buf1
[0] && buf1
[0] != '\n') {
814 /* user hit something other than enter */
815 suspend_grep
= 1; /* for this recursion */
818 "\nOnly 'q', 'Q' or '/' are processed at "
819 "more prompt, input ignored\n");
821 kdb_printf("\n'/' cannot be used during | "
822 "grep filtering, input ignored\n");
823 } else if (kdb_grepping_flag
) {
825 suspend_grep
= 1; /* for this recursion */
832 * For grep searches, shift the printed string left.
833 * replaced_byte contains the character that was overwritten with
834 * the terminating null, and cphold points to the null.
835 * Then adjust the notion of available space in the buffer.
837 if (kdb_grepping_flag
&& !suspend_grep
) {
838 *cphold
= replaced_byte
;
839 strcpy(kdb_buffer
, cphold
);
840 len
= strlen(kdb_buffer
);
841 next_avail
= kdb_buffer
+ len
;
842 size_avail
= sizeof(kdb_buffer
) - len
;
846 suspend_grep
= 0; /* end of what may have been a recursive call */
848 console_loglevel
= saved_loglevel
;
849 /* kdb_printf_cpu locked the code above. */
850 smp_store_release(&kdb_printf_cpu
, old_cpu
);
851 local_irq_restore(flags
);
855 int kdb_printf(const char *fmt
, ...)
861 r
= vkdb_printf(KDB_MSGSRC_INTERNAL
, fmt
, ap
);
866 EXPORT_SYMBOL_GPL(kdb_printf
);