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