2 * kgdbts is a test suite for kgdb for the sole purpose of validating
3 * that key pieces of the kgdb internals are working properly such as
4 * HW/SW breakpoints, single stepping, and NMI.
6 * Created by: Jason Wessel <jason.wessel@windriver.com>
8 * Copyright (c) 2008 Wind River Systems, Inc.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
17 * See the GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 /* Information about the kgdb test suite.
24 * -------------------------------------
26 * The kgdb test suite is designed as a KGDB I/O module which
27 * simulates the communications that a debugger would have with kgdb.
28 * The tests are broken up in to a line by line and referenced here as
29 * a "get" which is kgdb requesting input and "put" which is kgdb
32 * The kgdb suite can be invoked from the kernel command line
33 * arguments system or executed dynamically at run time. The test
34 * suite uses the variable "kgdbts" to obtain the information about
35 * which tests to run and to configure the verbosity level. The
36 * following are the various characters you can use with the kgdbts=
39 * When using the "kgdbts=" you only choose one of the following core
41 * A = Run all the core tests silently
42 * V1 = Run all the core tests with minimal output
43 * V2 = Run all the core tests in debug mode
45 * You can also specify optional tests:
46 * N## = Go to sleep with interrupts of for ## seconds
47 * to test the HW NMI watchdog
48 * F## = Break at do_fork for ## iterations
49 * S## = Break at sys_open for ## iterations
50 * I## = Run the single step test ## iterations
52 * NOTE: that the do_fork and sys_open tests are mutually exclusive.
54 * To invoke the kgdb test suite from boot you use a kernel start
55 * argument as follows:
57 * Or if you wanted to perform the NMI test for 6 seconds and do_fork
58 * test for 100 forks, you could use:
59 * kgdbts=V1N6F100 kgdbwait
61 * The test suite can also be invoked at run time with:
62 * echo kgdbts=V1N6F100 > /sys/module/kgdbts/parameters/kgdbts
63 * Or as another example:
64 * echo kgdbts=V2 > /sys/module/kgdbts/parameters/kgdbts
66 * When developing a new kgdb arch specific implementation or
67 * using these tests for the purpose of regression testing,
68 * several invocations are required.
70 * 1) Boot with the test suite enabled by using the kernel arguments
71 * "kgdbts=V1F100 kgdbwait"
72 * ## If kgdb arch specific implementation has NMI use
75 * 2) After the system boot run the basic test.
76 * echo kgdbts=V1 > /sys/module/kgdbts/parameters/kgdbts
78 * 3) Run the concurrency tests. It is best to use n+1
79 * while loops where n is the number of cpus you have
80 * in your system. The example below uses only two
83 * ## This tests break points on sys_open
84 * while [ 1 ] ; do find / > /dev/null 2>&1 ; done &
85 * while [ 1 ] ; do find / > /dev/null 2>&1 ; done &
86 * echo kgdbts=V1S10000 > /sys/module/kgdbts/parameters/kgdbts
87 * fg # and hit control-c
88 * fg # and hit control-c
89 * ## This tests break points on do_fork
90 * while [ 1 ] ; do date > /dev/null ; done &
91 * while [ 1 ] ; do date > /dev/null ; done &
92 * echo kgdbts=V1F1000 > /sys/module/kgdbts/parameters/kgdbts
93 * fg # and hit control-c
97 #include <linux/kernel.h>
98 #include <linux/kgdb.h>
99 #include <linux/ctype.h>
100 #include <linux/uaccess.h>
101 #include <linux/syscalls.h>
102 #include <linux/nmi.h>
103 #include <linux/delay.h>
104 #include <linux/kthread.h>
105 #include <linux/module.h>
106 #include <asm/sections.h>
108 #define v1printk(a...) do { \
110 printk(KERN_INFO a); \
112 #define v2printk(a...) do { \
114 printk(KERN_INFO a); \
116 touch_nmi_watchdog(); \
118 #define eprintk(a...) do { \
119 printk(KERN_ERR a); \
122 #define MAX_CONFIG_LEN 40
124 static struct kgdb_io kgdbts_io_ops;
125 static char get_buf[BUFMAX];
126 static int get_buf_cnt;
127 static char put_buf[BUFMAX];
128 static int put_buf_cnt;
129 static char scratch_buf[BUFMAX];
131 static int repeat_test;
132 static int test_complete;
134 static int final_ack;
135 static int force_hwbrks;
136 static int hwbreaks_ok;
137 static int hw_break_val;
138 static int hw_break_val2;
139 static int cont_instead_of_sstep;
140 static unsigned long cont_thread_id;
141 static unsigned long sstep_thread_id;
142 #if defined(CONFIG_ARM) || defined(CONFIG_MIPS) || defined(CONFIG_SPARC)
143 static int arch_needs_sstep_emulation = 1;
145 static int arch_needs_sstep_emulation;
147 static unsigned long cont_addr;
148 static unsigned long sstep_addr;
149 static int restart_from_top_after_write;
150 static int sstep_state;
152 /* Storage for the registers, in GDB format. */
153 static unsigned long kgdbts_gdb_regs[(NUMREGBYTES +
154 sizeof(unsigned long) - 1) /
155 sizeof(unsigned long)];
156 static struct pt_regs kgdbts_regs;
158 /* -1 = init not run yet, 0 = unconfigured, 1 = configured. */
159 static int configured = -1;
161 #ifdef CONFIG_KGDB_TESTS_BOOT_STRING
162 static char config[MAX_CONFIG_LEN] = CONFIG_KGDB_TESTS_BOOT_STRING;
164 static char config[MAX_CONFIG_LEN];
166 static struct kparam_string kps = {
168 .maxlen = MAX_CONFIG_LEN,
171 static void fill_get_buf(char *buf);
176 void (*get_handler)(char *);
177 int (*put_handler)(char *, char *);
182 struct test_struct *tst;
184 int (*run_test) (int, int);
185 int (*validate_put) (char *);
188 static struct test_state ts;
190 static int kgdbts_unreg_thread(void *ptr)
192 /* Wait until the tests are complete and then ungresiter the I/O
196 msleep_interruptible(1500);
197 /* Pause for any other threads to exit after final ack. */
198 msleep_interruptible(1000);
200 kgdb_unregister_io_module(&kgdbts_io_ops);
206 /* This is noinline such that it can be used for a single location to
209 static noinline void kgdbts_break_test(void)
211 v2printk("kgdbts: breakpoint complete\n");
214 /* Lookup symbol info in the kernel */
215 static unsigned long lookup_addr(char *arg)
217 unsigned long addr = 0;
219 if (!strcmp(arg, "kgdbts_break_test"))
220 addr = (unsigned long)kgdbts_break_test;
221 else if (!strcmp(arg, "sys_open"))
222 addr = (unsigned long)do_sys_open;
223 else if (!strcmp(arg, "do_fork"))
224 addr = (unsigned long)_do_fork;
225 else if (!strcmp(arg, "hw_break_val"))
226 addr = (unsigned long)&hw_break_val;
227 addr = (unsigned long) dereference_function_descriptor((void *)addr);
231 static void break_helper(char *bp_type, char *arg, unsigned long vaddr)
236 addr = lookup_addr(arg);
240 sprintf(scratch_buf, "%s,%lx,%i", bp_type, addr,
242 fill_get_buf(scratch_buf);
245 static void sw_break(char *arg)
247 break_helper(force_hwbrks ? "Z1" : "Z0", arg, 0);
250 static void sw_rem_break(char *arg)
252 break_helper(force_hwbrks ? "z1" : "z0", arg, 0);
255 static void hw_break(char *arg)
257 break_helper("Z1", arg, 0);
260 static void hw_rem_break(char *arg)
262 break_helper("z1", arg, 0);
265 static void hw_write_break(char *arg)
267 break_helper("Z2", arg, 0);
270 static void hw_rem_write_break(char *arg)
272 break_helper("z2", arg, 0);
275 static void hw_access_break(char *arg)
277 break_helper("Z4", arg, 0);
280 static void hw_rem_access_break(char *arg)
282 break_helper("z4", arg, 0);
285 static void hw_break_val_access(void)
287 hw_break_val2 = hw_break_val;
290 static void hw_break_val_write(void)
295 static int get_thread_id_continue(char *put_str, char *arg)
297 char *ptr = &put_str[11];
299 if (put_str[1] != 'T' || put_str[2] != '0')
301 kgdb_hex2long(&ptr, &cont_thread_id);
305 static int check_and_rewind_pc(char *put_str, char *arg)
307 unsigned long addr = lookup_addr(arg);
311 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
313 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
314 ip = instruction_pointer(&kgdbts_regs);
315 v2printk("Stopped at IP: %lx\n", ip);
316 #ifdef GDB_ADJUSTS_BREAK_OFFSET
317 /* On some arches, a breakpoint stop requires it to be decremented */
318 if (addr + BREAK_INSTR_SIZE == ip)
319 offset = -BREAK_INSTR_SIZE;
322 if (arch_needs_sstep_emulation && sstep_addr &&
323 ip + offset == sstep_addr &&
324 ((!strcmp(arg, "sys_open") || !strcmp(arg, "do_fork")))) {
325 /* This is special case for emulated single step */
326 v2printk("Emul: rewind hit single step bp\n");
327 restart_from_top_after_write = 1;
328 } else if (strcmp(arg, "silent") && ip + offset != addr) {
329 eprintk("kgdbts: BP mismatch %lx expected %lx\n",
333 /* Readjust the instruction pointer if needed */
336 #ifdef GDB_ADJUSTS_BREAK_OFFSET
337 instruction_pointer_set(&kgdbts_regs, ip);
342 static int check_single_step(char *put_str, char *arg)
344 unsigned long addr = lookup_addr(arg);
345 static int matched_id;
348 * From an arch indepent point of view the instruction pointer
349 * should be on a different instruction
351 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
353 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
354 v2printk("Singlestep stopped at IP: %lx\n",
355 instruction_pointer(&kgdbts_regs));
357 if (sstep_thread_id != cont_thread_id) {
359 * Ensure we stopped in the same thread id as before, else the
360 * debugger should continue until the original thread that was
361 * single stepped is scheduled again, emulating gdb's behavior.
363 v2printk("ThrID does not match: %lx\n", cont_thread_id);
364 if (arch_needs_sstep_emulation) {
366 instruction_pointer(&kgdbts_regs) != addr)
373 cont_instead_of_sstep = 1;
379 if (instruction_pointer(&kgdbts_regs) == addr) {
380 eprintk("kgdbts: SingleStep failed at %lx\n",
381 instruction_pointer(&kgdbts_regs));
388 static void write_regs(char *arg)
390 memset(scratch_buf, 0, sizeof(scratch_buf));
391 scratch_buf[0] = 'G';
392 pt_regs_to_gdb_regs(kgdbts_gdb_regs, &kgdbts_regs);
393 kgdb_mem2hex((char *)kgdbts_gdb_regs, &scratch_buf[1], NUMREGBYTES);
394 fill_get_buf(scratch_buf);
397 static void skip_back_repeat_test(char *arg)
399 int go_back = simple_strtol(arg, NULL, 10);
402 if (repeat_test <= 0)
406 fill_get_buf(ts.tst[ts.idx].get);
409 static int got_break(char *put_str, char *arg)
412 if (!strncmp(put_str+1, arg, 2)) {
413 if (!strncmp(arg, "T0", 2))
420 static void get_cont_catch(char *arg)
422 /* Always send detach because the test is completed at this point */
426 static int put_cont_catch(char *put_str, char *arg)
428 /* This is at the end of the test and we catch any and all input */
429 v2printk("kgdbts: cleanup task: %lx\n", sstep_thread_id);
434 static int emul_reset(char *put_str, char *arg)
436 if (strncmp(put_str, "$OK", 3))
438 if (restart_from_top_after_write) {
439 restart_from_top_after_write = 0;
445 static void emul_sstep_get(char *arg)
447 if (!arch_needs_sstep_emulation) {
448 if (cont_instead_of_sstep) {
449 cont_instead_of_sstep = 0;
456 switch (sstep_state) {
458 v2printk("Emulate single step\n");
459 /* Start by looking at the current PC */
464 break_helper("Z0", NULL, sstep_addr);
471 /* Clear breakpoint */
472 break_helper("z0", NULL, sstep_addr);
475 eprintk("kgdbts: ERROR failed sstep get emulation\n");
480 static int emul_sstep_put(char *put_str, char *arg)
482 if (!arch_needs_sstep_emulation) {
483 char *ptr = &put_str[11];
484 if (put_str[1] != 'T' || put_str[2] != '0')
486 kgdb_hex2long(&ptr, &sstep_thread_id);
489 switch (sstep_state) {
491 /* validate the "g" packet to get the IP */
492 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
494 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
495 v2printk("Stopped at IP: %lx\n",
496 instruction_pointer(&kgdbts_regs));
497 /* Want to stop at IP + break instruction size by default */
498 sstep_addr = cont_addr + BREAK_INSTR_SIZE;
501 if (strncmp(put_str, "$OK", 3)) {
502 eprintk("kgdbts: failed sstep break set\n");
507 if (strncmp(put_str, "$T0", 3)) {
508 eprintk("kgdbts: failed continue sstep\n");
511 char *ptr = &put_str[11];
512 kgdb_hex2long(&ptr, &sstep_thread_id);
516 if (strncmp(put_str, "$OK", 3)) {
517 eprintk("kgdbts: failed sstep break unset\n");
520 /* Single step is complete so continue on! */
524 eprintk("kgdbts: ERROR failed sstep put emulation\n");
527 /* Continue on the same test line until emulation is complete */
532 static int final_ack_set(char *put_str, char *arg)
534 if (strncmp(put_str+1, arg, 2))
540 * Test to plant a breakpoint and detach, which should clear out the
541 * breakpoint and restore the original instruction.
543 static struct test_struct plant_and_detach_test[] = {
544 { "?", "S0*" }, /* Clear break points */
545 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
546 { "D", "OK" }, /* Detach */
551 * Simple test to write in a software breakpoint, check for the
552 * correct stop location and detach.
554 static struct test_struct sw_breakpoint_test[] = {
555 { "?", "S0*" }, /* Clear break points */
556 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
557 { "c", "T0*", }, /* Continue */
558 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
559 { "write", "OK", write_regs },
560 { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */
561 { "D", "OK" }, /* Detach */
562 { "D", "OK", NULL, got_break }, /* On success we made it here */
567 * Test a known bad memory read location to test the fault handler and
568 * read bytes 1-8 at the bad address
570 static struct test_struct bad_read_test[] = {
571 { "?", "S0*" }, /* Clear break points */
572 { "m0,1", "E*" }, /* read 1 byte at address 1 */
573 { "m0,2", "E*" }, /* read 1 byte at address 2 */
574 { "m0,3", "E*" }, /* read 1 byte at address 3 */
575 { "m0,4", "E*" }, /* read 1 byte at address 4 */
576 { "m0,5", "E*" }, /* read 1 byte at address 5 */
577 { "m0,6", "E*" }, /* read 1 byte at address 6 */
578 { "m0,7", "E*" }, /* read 1 byte at address 7 */
579 { "m0,8", "E*" }, /* read 1 byte at address 8 */
580 { "D", "OK" }, /* Detach which removes all breakpoints and continues */
585 * Test for hitting a breakpoint, remove it, single step, plant it
588 static struct test_struct singlestep_break_test[] = {
589 { "?", "S0*" }, /* Clear break points */
590 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
591 { "c", "T0*", NULL, get_thread_id_continue }, /* Continue */
592 { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */
593 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
594 { "write", "OK", write_regs }, /* Write registers */
595 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
596 { "g", "kgdbts_break_test", NULL, check_single_step },
597 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
598 { "c", "T0*", }, /* Continue */
599 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
600 { "write", "OK", write_regs }, /* Write registers */
601 { "D", "OK" }, /* Remove all breakpoints and continues */
606 * Test for hitting a breakpoint at do_fork for what ever the number
607 * of iterations required by the variable repeat_test.
609 static struct test_struct do_fork_test[] = {
610 { "?", "S0*" }, /* Clear break points */
611 { "do_fork", "OK", sw_break, }, /* set sw breakpoint */
612 { "c", "T0*", NULL, get_thread_id_continue }, /* Continue */
613 { "do_fork", "OK", sw_rem_break }, /*remove breakpoint */
614 { "g", "do_fork", NULL, check_and_rewind_pc }, /* check location */
615 { "write", "OK", write_regs, emul_reset }, /* Write registers */
616 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
617 { "g", "do_fork", NULL, check_single_step },
618 { "do_fork", "OK", sw_break, }, /* set sw breakpoint */
619 { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */
620 { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */
621 { "", "", get_cont_catch, put_cont_catch },
624 /* Test for hitting a breakpoint at sys_open for what ever the number
625 * of iterations required by the variable repeat_test.
627 static struct test_struct sys_open_test[] = {
628 { "?", "S0*" }, /* Clear break points */
629 { "sys_open", "OK", sw_break, }, /* set sw breakpoint */
630 { "c", "T0*", NULL, get_thread_id_continue }, /* Continue */
631 { "sys_open", "OK", sw_rem_break }, /*remove breakpoint */
632 { "g", "sys_open", NULL, check_and_rewind_pc }, /* check location */
633 { "write", "OK", write_regs, emul_reset }, /* Write registers */
634 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
635 { "g", "sys_open", NULL, check_single_step },
636 { "sys_open", "OK", sw_break, }, /* set sw breakpoint */
637 { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */
638 { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */
639 { "", "", get_cont_catch, put_cont_catch },
643 * Test for hitting a simple hw breakpoint
645 static struct test_struct hw_breakpoint_test[] = {
646 { "?", "S0*" }, /* Clear break points */
647 { "kgdbts_break_test", "OK", hw_break, }, /* set hw breakpoint */
648 { "c", "T0*", }, /* Continue */
649 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
650 { "write", "OK", write_regs },
651 { "kgdbts_break_test", "OK", hw_rem_break }, /*remove breakpoint */
652 { "D", "OK" }, /* Detach */
653 { "D", "OK", NULL, got_break }, /* On success we made it here */
658 * Test for hitting a hw write breakpoint
660 static struct test_struct hw_write_break_test[] = {
661 { "?", "S0*" }, /* Clear break points */
662 { "hw_break_val", "OK", hw_write_break, }, /* set hw breakpoint */
663 { "c", "T0*", NULL, got_break }, /* Continue */
664 { "g", "silent", NULL, check_and_rewind_pc },
665 { "write", "OK", write_regs },
666 { "hw_break_val", "OK", hw_rem_write_break }, /*remove breakpoint */
667 { "D", "OK" }, /* Detach */
668 { "D", "OK", NULL, got_break }, /* On success we made it here */
673 * Test for hitting a hw access breakpoint
675 static struct test_struct hw_access_break_test[] = {
676 { "?", "S0*" }, /* Clear break points */
677 { "hw_break_val", "OK", hw_access_break, }, /* set hw breakpoint */
678 { "c", "T0*", NULL, got_break }, /* Continue */
679 { "g", "silent", NULL, check_and_rewind_pc },
680 { "write", "OK", write_regs },
681 { "hw_break_val", "OK", hw_rem_access_break }, /*remove breakpoint */
682 { "D", "OK" }, /* Detach */
683 { "D", "OK", NULL, got_break }, /* On success we made it here */
688 * Test for hitting a hw access breakpoint
690 static struct test_struct nmi_sleep_test[] = {
691 { "?", "S0*" }, /* Clear break points */
692 { "c", "T0*", NULL, got_break }, /* Continue */
693 { "D", "OK" }, /* Detach */
694 { "D", "OK", NULL, got_break }, /* On success we made it here */
698 static void fill_get_buf(char *buf)
700 unsigned char checksum = 0;
704 strcpy(get_buf, "$");
705 strcat(get_buf, buf);
706 while ((ch = buf[count])) {
710 strcat(get_buf, "#");
711 get_buf[count + 2] = hex_asc_hi(checksum);
712 get_buf[count + 3] = hex_asc_lo(checksum);
713 get_buf[count + 4] = '\0';
714 v2printk("get%i: %s\n", ts.idx, get_buf);
717 static int validate_simple_test(char *put_str)
721 if (ts.tst[ts.idx].put_handler)
722 return ts.tst[ts.idx].put_handler(put_str,
725 chk_str = ts.tst[ts.idx].put;
729 while (*chk_str != '\0' && *put_str != '\0') {
730 /* If someone does a * to match the rest of the string, allow
731 * it, or stop if the received string is complete.
733 if (*put_str == '#' || *chk_str == '*')
735 if (*put_str != *chk_str)
741 if (*chk_str == '\0' && (*put_str == '\0' || *put_str == '#'))
747 static int run_simple_test(int is_get_char, int chr)
751 /* Send an ACK on the get if a prior put completed and set the
758 /* On the first get char, fill the transmit buffer and then
759 * take from the get_string.
761 if (get_buf_cnt == 0) {
762 if (ts.tst[ts.idx].get_handler)
763 ts.tst[ts.idx].get_handler(ts.tst[ts.idx].get);
765 fill_get_buf(ts.tst[ts.idx].get);
768 if (get_buf[get_buf_cnt] == '\0') {
769 eprintk("kgdbts: ERROR GET: EOB on '%s' at %i\n",
774 ret = get_buf[get_buf_cnt];
779 /* This callback is a put char which is when kgdb sends data to
782 if (ts.tst[ts.idx].get[0] == '\0' && ts.tst[ts.idx].put[0] == '\0' &&
783 !ts.tst[ts.idx].get_handler) {
784 eprintk("kgdbts: ERROR: beyond end of test on"
785 " '%s' line %i\n", ts.name, ts.idx);
789 if (put_buf_cnt >= BUFMAX) {
790 eprintk("kgdbts: ERROR: put buffer overflow on"
791 " '%s' line %i\n", ts.name, ts.idx);
795 /* Ignore everything until the first valid packet start '$' */
796 if (put_buf_cnt == 0 && chr != '$')
799 put_buf[put_buf_cnt] = chr;
802 /* End of packet == #XX so look for the '#' */
803 if (put_buf_cnt > 3 && put_buf[put_buf_cnt - 3] == '#') {
804 if (put_buf_cnt >= BUFMAX) {
805 eprintk("kgdbts: ERROR: put buffer overflow on"
806 " '%s' line %i\n", ts.name, ts.idx);
810 put_buf[put_buf_cnt] = '\0';
811 v2printk("put%i: %s\n", ts.idx, put_buf);
812 /* Trigger check here */
813 if (ts.validate_put && ts.validate_put(put_buf)) {
814 eprintk("kgdbts: ERROR PUT: end of test "
815 "buffer on '%s' line %i expected %s got %s\n",
816 ts.name, ts.idx, ts.tst[ts.idx].put, put_buf);
826 static void init_simple_test(void)
828 memset(&ts, 0, sizeof(ts));
829 ts.run_test = run_simple_test;
830 ts.validate_put = validate_simple_test;
833 static void run_plant_and_detach_test(int is_early)
835 char before[BREAK_INSTR_SIZE];
836 char after[BREAK_INSTR_SIZE];
838 probe_kernel_read(before, (char *)kgdbts_break_test,
841 ts.tst = plant_and_detach_test;
842 ts.name = "plant_and_detach_test";
843 /* Activate test with initial breakpoint */
846 probe_kernel_read(after, (char *)kgdbts_break_test,
848 if (memcmp(before, after, BREAK_INSTR_SIZE)) {
849 printk(KERN_CRIT "kgdbts: ERROR kgdb corrupted memory\n");
850 panic("kgdb memory corruption");
853 /* complete the detach test */
858 static void run_breakpoint_test(int is_hw_breakpoint)
862 if (is_hw_breakpoint) {
863 ts.tst = hw_breakpoint_test;
864 ts.name = "hw_breakpoint_test";
866 ts.tst = sw_breakpoint_test;
867 ts.name = "sw_breakpoint_test";
869 /* Activate test with initial breakpoint */
871 /* run code with the break point in it */
878 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
879 if (is_hw_breakpoint)
883 static void run_hw_break_test(int is_write_test)
888 ts.tst = hw_write_break_test;
889 ts.name = "hw_write_break_test";
891 ts.tst = hw_access_break_test;
892 ts.name = "hw_access_break_test";
894 /* Activate test with initial breakpoint */
896 hw_break_val_access();
898 if (test_complete == 2) {
899 eprintk("kgdbts: ERROR %s broke on access\n",
903 hw_break_val_write();
907 if (test_complete == 1)
910 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
914 static void run_nmi_sleep_test(int nmi_sleep)
919 ts.tst = nmi_sleep_test;
920 ts.name = "nmi_sleep_test";
921 /* Activate test with initial breakpoint */
923 local_irq_save(flags);
924 mdelay(nmi_sleep*1000);
925 touch_nmi_watchdog();
926 local_irq_restore(flags);
927 if (test_complete != 2)
928 eprintk("kgdbts: ERROR nmi_test did not hit nmi\n");
930 if (test_complete == 1)
933 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
936 static void run_bad_read_test(void)
939 ts.tst = bad_read_test;
940 ts.name = "bad_read_test";
941 /* Activate test with initial breakpoint */
945 static void run_do_fork_test(void)
948 ts.tst = do_fork_test;
949 ts.name = "do_fork_test";
950 /* Activate test with initial breakpoint */
954 static void run_sys_open_test(void)
957 ts.tst = sys_open_test;
958 ts.name = "sys_open_test";
959 /* Activate test with initial breakpoint */
963 static void run_singlestep_break_test(void)
966 ts.tst = singlestep_break_test;
967 ts.name = "singlestep_breakpoint_test";
968 /* Activate test with initial breakpoint */
974 static void kgdbts_run_tests(void)
978 int do_sys_open_test = 0;
979 int sstep_test = 1000;
984 if (strstr(config, "V1"))
986 if (strstr(config, "V2"))
989 ptr = strchr(config, 'F');
991 fork_test = simple_strtol(ptr + 1, NULL, 10);
992 ptr = strchr(config, 'S');
994 do_sys_open_test = simple_strtol(ptr + 1, NULL, 10);
995 ptr = strchr(config, 'N');
997 nmi_sleep = simple_strtol(ptr+1, NULL, 10);
998 ptr = strchr(config, 'I');
1000 sstep_test = simple_strtol(ptr+1, NULL, 10);
1002 /* All HW break point tests */
1003 if (arch_kgdb_ops.flags & KGDB_HW_BREAKPOINT) {
1005 v1printk("kgdbts:RUN hw breakpoint test\n");
1006 run_breakpoint_test(1);
1007 v1printk("kgdbts:RUN hw write breakpoint test\n");
1008 run_hw_break_test(1);
1009 v1printk("kgdbts:RUN access write breakpoint test\n");
1010 run_hw_break_test(0);
1013 /* required internal KGDB tests */
1014 v1printk("kgdbts:RUN plant and detach test\n");
1015 run_plant_and_detach_test(0);
1016 v1printk("kgdbts:RUN sw breakpoint test\n");
1017 run_breakpoint_test(0);
1018 v1printk("kgdbts:RUN bad memory access test\n");
1019 run_bad_read_test();
1020 v1printk("kgdbts:RUN singlestep test %i iterations\n", sstep_test);
1021 for (i = 0; i < sstep_test; i++) {
1022 run_singlestep_break_test();
1024 v1printk("kgdbts:RUN singlestep [%i/%i]\n",
1028 /* ===Optional tests=== */
1031 v1printk("kgdbts:RUN NMI sleep %i seconds test\n", nmi_sleep);
1032 run_nmi_sleep_test(nmi_sleep);
1035 /* If the do_fork test is run it will be the last test that is
1036 * executed because a kernel thread will be spawned at the very
1037 * end to unregister the debug hooks.
1040 repeat_test = fork_test;
1041 printk(KERN_INFO "kgdbts:RUN do_fork for %i breakpoints\n",
1043 kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg");
1048 /* If the sys_open test is run it will be the last test that is
1049 * executed because a kernel thread will be spawned at the very
1050 * end to unregister the debug hooks.
1052 if (do_sys_open_test) {
1053 repeat_test = do_sys_open_test;
1054 printk(KERN_INFO "kgdbts:RUN sys_open for %i breakpoints\n",
1056 kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg");
1057 run_sys_open_test();
1060 /* Shutdown and unregister */
1061 kgdb_unregister_io_module(&kgdbts_io_ops);
1065 static int kgdbts_option_setup(char *opt)
1067 if (strlen(opt) >= MAX_CONFIG_LEN) {
1068 printk(KERN_ERR "kgdbts: config string too long\n");
1071 strcpy(config, opt);
1075 __setup("kgdbts=", kgdbts_option_setup);
1077 static int configure_kgdbts(void)
1081 if (!strlen(config) || isspace(config[0]))
1085 run_plant_and_detach_test(1);
1087 err = kgdb_register_io_module(&kgdbts_io_ops);
1104 static int __init init_kgdbts(void)
1106 /* Already configured? */
1107 if (configured == 1)
1110 return configure_kgdbts();
1112 device_initcall(init_kgdbts);
1114 static int kgdbts_get_char(void)
1119 val = ts.run_test(1, 0);
1124 static void kgdbts_put_char(u8 chr)
1127 ts.run_test(0, chr);
1130 static int param_set_kgdbts_var(const char *kmessage, struct kernel_param *kp)
1132 size_t len = strlen(kmessage);
1134 if (len >= MAX_CONFIG_LEN) {
1135 printk(KERN_ERR "kgdbts: config string too long\n");
1139 /* Only copy in the string if the init function has not run yet */
1140 if (configured < 0) {
1141 strcpy(config, kmessage);
1145 if (configured == 1) {
1146 printk(KERN_ERR "kgdbts: ERROR: Already configured and running.\n");
1150 strcpy(config, kmessage);
1151 /* Chop out \n char as a result of echo */
1152 if (len && config[len - 1] == '\n')
1153 config[len - 1] = '\0';
1155 /* Go and configure with the new params. */
1156 return configure_kgdbts();
1159 static void kgdbts_pre_exp_handler(void)
1161 /* Increment the module count when the debugger is active */
1162 if (!kgdb_connected)
1163 try_module_get(THIS_MODULE);
1166 static void kgdbts_post_exp_handler(void)
1168 /* decrement the module count when the debugger detaches */
1169 if (!kgdb_connected)
1170 module_put(THIS_MODULE);
1173 static struct kgdb_io kgdbts_io_ops = {
1175 .read_char = kgdbts_get_char,
1176 .write_char = kgdbts_put_char,
1177 .pre_exception = kgdbts_pre_exp_handler,
1178 .post_exception = kgdbts_post_exp_handler,
1182 * not really modular, but the easiest way to keep compat with existing
1183 * bootargs behaviour is to continue using module_param here.
1185 module_param_call(kgdbts, param_set_kgdbts_var, param_get_string, &kps, 0644);
1186 MODULE_PARM_DESC(kgdbts, "<A|V1|V2>[F#|S#][N#]");