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>
106 #define v1printk(a...) do { \
108 printk(KERN_INFO a); \
110 #define v2printk(a...) do { \
112 printk(KERN_INFO a); \
113 touch_nmi_watchdog(); \
115 #define eprintk(a...) do { \
116 printk(KERN_ERR a); \
119 #define MAX_CONFIG_LEN 40
121 static struct kgdb_io kgdbts_io_ops
;
122 static char get_buf
[BUFMAX
];
123 static int get_buf_cnt
;
124 static char put_buf
[BUFMAX
];
125 static int put_buf_cnt
;
126 static char scratch_buf
[BUFMAX
];
128 static int repeat_test
;
129 static int test_complete
;
131 static int final_ack
;
132 static int force_hwbrks
;
133 static int hwbreaks_ok
;
134 static int hw_break_val
;
135 static int hw_break_val2
;
136 #if defined(CONFIG_ARM) || defined(CONFIG_MIPS) || defined(CONFIG_SPARC)
137 static int arch_needs_sstep_emulation
= 1;
139 static int arch_needs_sstep_emulation
;
141 static unsigned long sstep_addr
;
142 static int sstep_state
;
144 /* Storage for the registers, in GDB format. */
145 static unsigned long kgdbts_gdb_regs
[(NUMREGBYTES
+
146 sizeof(unsigned long) - 1) /
147 sizeof(unsigned long)];
148 static struct pt_regs kgdbts_regs
;
150 /* -1 = init not run yet, 0 = unconfigured, 1 = configured. */
151 static int configured
= -1;
153 #ifdef CONFIG_KGDB_TESTS_BOOT_STRING
154 static char config
[MAX_CONFIG_LEN
] = CONFIG_KGDB_TESTS_BOOT_STRING
;
156 static char config
[MAX_CONFIG_LEN
];
158 static struct kparam_string kps
= {
160 .maxlen
= MAX_CONFIG_LEN
,
163 static void fill_get_buf(char *buf
);
168 void (*get_handler
)(char *);
169 int (*put_handler
)(char *, char *);
174 struct test_struct
*tst
;
176 int (*run_test
) (int, int);
177 int (*validate_put
) (char *);
180 static struct test_state ts
;
182 static int kgdbts_unreg_thread(void *ptr
)
184 /* Wait until the tests are complete and then ungresiter the I/O
188 msleep_interruptible(1500);
191 kgdb_unregister_io_module(&kgdbts_io_ops
);
197 /* This is noinline such that it can be used for a single location to
200 static noinline
void kgdbts_break_test(void)
202 v2printk("kgdbts: breakpoint complete\n");
205 /* Lookup symbol info in the kernel */
206 static unsigned long lookup_addr(char *arg
)
208 unsigned long addr
= 0;
210 if (!strcmp(arg
, "kgdbts_break_test"))
211 addr
= (unsigned long)kgdbts_break_test
;
212 else if (!strcmp(arg
, "sys_open"))
213 addr
= (unsigned long)sys_open
;
214 else if (!strcmp(arg
, "do_fork"))
215 addr
= (unsigned long)do_fork
;
216 else if (!strcmp(arg
, "hw_break_val"))
217 addr
= (unsigned long)&hw_break_val
;
221 static void break_helper(char *bp_type
, char *arg
, unsigned long vaddr
)
226 addr
= lookup_addr(arg
);
230 sprintf(scratch_buf
, "%s,%lx,%i", bp_type
, addr
,
232 fill_get_buf(scratch_buf
);
235 static void sw_break(char *arg
)
237 break_helper(force_hwbrks
? "Z1" : "Z0", arg
, 0);
240 static void sw_rem_break(char *arg
)
242 break_helper(force_hwbrks
? "z1" : "z0", arg
, 0);
245 static void hw_break(char *arg
)
247 break_helper("Z1", arg
, 0);
250 static void hw_rem_break(char *arg
)
252 break_helper("z1", arg
, 0);
255 static void hw_write_break(char *arg
)
257 break_helper("Z2", arg
, 0);
260 static void hw_rem_write_break(char *arg
)
262 break_helper("z2", arg
, 0);
265 static void hw_access_break(char *arg
)
267 break_helper("Z4", arg
, 0);
270 static void hw_rem_access_break(char *arg
)
272 break_helper("z4", arg
, 0);
275 static void hw_break_val_access(void)
277 hw_break_val2
= hw_break_val
;
280 static void hw_break_val_write(void)
285 static int check_and_rewind_pc(char *put_str
, char *arg
)
287 unsigned long addr
= lookup_addr(arg
);
290 kgdb_hex2mem(&put_str
[1], (char *)kgdbts_gdb_regs
,
292 gdb_regs_to_pt_regs(kgdbts_gdb_regs
, &kgdbts_regs
);
293 v2printk("Stopped at IP: %lx\n", instruction_pointer(&kgdbts_regs
));
295 /* On x86 a breakpoint stop requires it to be decremented */
296 if (addr
+ 1 == kgdbts_regs
.ip
)
299 if (strcmp(arg
, "silent") &&
300 instruction_pointer(&kgdbts_regs
) + offset
!= addr
) {
301 eprintk("kgdbts: BP mismatch %lx expected %lx\n",
302 instruction_pointer(&kgdbts_regs
) + offset
, addr
);
306 /* On x86 adjust the instruction pointer if needed */
307 kgdbts_regs
.ip
+= offset
;
312 static int check_single_step(char *put_str
, char *arg
)
314 unsigned long addr
= lookup_addr(arg
);
316 * From an arch indepent point of view the instruction pointer
317 * should be on a different instruction
319 kgdb_hex2mem(&put_str
[1], (char *)kgdbts_gdb_regs
,
321 gdb_regs_to_pt_regs(kgdbts_gdb_regs
, &kgdbts_regs
);
322 v2printk("Singlestep stopped at IP: %lx\n",
323 instruction_pointer(&kgdbts_regs
));
324 if (instruction_pointer(&kgdbts_regs
) == addr
) {
325 eprintk("kgdbts: SingleStep failed at %lx\n",
326 instruction_pointer(&kgdbts_regs
));
333 static void write_regs(char *arg
)
335 memset(scratch_buf
, 0, sizeof(scratch_buf
));
336 scratch_buf
[0] = 'G';
337 pt_regs_to_gdb_regs(kgdbts_gdb_regs
, &kgdbts_regs
);
338 kgdb_mem2hex((char *)kgdbts_gdb_regs
, &scratch_buf
[1], NUMREGBYTES
);
339 fill_get_buf(scratch_buf
);
342 static void skip_back_repeat_test(char *arg
)
344 int go_back
= simple_strtol(arg
, NULL
, 10);
347 if (repeat_test
<= 0)
351 fill_get_buf(ts
.tst
[ts
.idx
].get
);
354 static int got_break(char *put_str
, char *arg
)
357 if (!strncmp(put_str
+1, arg
, 2)) {
358 if (!strncmp(arg
, "T0", 2))
365 static void emul_sstep_get(char *arg
)
367 if (!arch_needs_sstep_emulation
) {
371 switch (sstep_state
) {
373 v2printk("Emulate single step\n");
374 /* Start by looking at the current PC */
379 break_helper("Z0", NULL
, sstep_addr
);
386 /* Clear breakpoint */
387 break_helper("z0", NULL
, sstep_addr
);
390 eprintk("kgdbts: ERROR failed sstep get emulation\n");
395 static int emul_sstep_put(char *put_str
, char *arg
)
397 if (!arch_needs_sstep_emulation
) {
398 if (!strncmp(put_str
+1, arg
, 2))
402 switch (sstep_state
) {
404 /* validate the "g" packet to get the IP */
405 kgdb_hex2mem(&put_str
[1], (char *)kgdbts_gdb_regs
,
407 gdb_regs_to_pt_regs(kgdbts_gdb_regs
, &kgdbts_regs
);
408 v2printk("Stopped at IP: %lx\n",
409 instruction_pointer(&kgdbts_regs
));
410 /* Want to stop at IP + break instruction size by default */
411 sstep_addr
= instruction_pointer(&kgdbts_regs
) +
415 if (strncmp(put_str
, "$OK", 3)) {
416 eprintk("kgdbts: failed sstep break set\n");
421 if (strncmp(put_str
, "$T0", 3)) {
422 eprintk("kgdbts: failed continue sstep\n");
427 if (strncmp(put_str
, "$OK", 3)) {
428 eprintk("kgdbts: failed sstep break unset\n");
431 /* Single step is complete so continue on! */
435 eprintk("kgdbts: ERROR failed sstep put emulation\n");
438 /* Continue on the same test line until emulation is complete */
443 static int final_ack_set(char *put_str
, char *arg
)
445 if (strncmp(put_str
+1, arg
, 2))
451 * Test to plant a breakpoint and detach, which should clear out the
452 * breakpoint and restore the original instruction.
454 static struct test_struct plant_and_detach_test
[] = {
455 { "?", "S0*" }, /* Clear break points */
456 { "kgdbts_break_test", "OK", sw_break
, }, /* set sw breakpoint */
457 { "D", "OK" }, /* Detach */
462 * Simple test to write in a software breakpoint, check for the
463 * correct stop location and detach.
465 static struct test_struct sw_breakpoint_test
[] = {
466 { "?", "S0*" }, /* Clear break points */
467 { "kgdbts_break_test", "OK", sw_break
, }, /* set sw breakpoint */
468 { "c", "T0*", }, /* Continue */
469 { "g", "kgdbts_break_test", NULL
, check_and_rewind_pc
},
470 { "write", "OK", write_regs
},
471 { "kgdbts_break_test", "OK", sw_rem_break
}, /*remove breakpoint */
472 { "D", "OK" }, /* Detach */
473 { "D", "OK", NULL
, got_break
}, /* On success we made it here */
478 * Test a known bad memory read location to test the fault handler and
479 * read bytes 1-8 at the bad address
481 static struct test_struct bad_read_test
[] = {
482 { "?", "S0*" }, /* Clear break points */
483 { "m0,1", "E*" }, /* read 1 byte at address 1 */
484 { "m0,2", "E*" }, /* read 1 byte at address 2 */
485 { "m0,3", "E*" }, /* read 1 byte at address 3 */
486 { "m0,4", "E*" }, /* read 1 byte at address 4 */
487 { "m0,5", "E*" }, /* read 1 byte at address 5 */
488 { "m0,6", "E*" }, /* read 1 byte at address 6 */
489 { "m0,7", "E*" }, /* read 1 byte at address 7 */
490 { "m0,8", "E*" }, /* read 1 byte at address 8 */
491 { "D", "OK" }, /* Detach which removes all breakpoints and continues */
496 * Test for hitting a breakpoint, remove it, single step, plant it
499 static struct test_struct singlestep_break_test
[] = {
500 { "?", "S0*" }, /* Clear break points */
501 { "kgdbts_break_test", "OK", sw_break
, }, /* set sw breakpoint */
502 { "c", "T0*", }, /* Continue */
503 { "g", "kgdbts_break_test", NULL
, check_and_rewind_pc
},
504 { "write", "OK", write_regs
}, /* Write registers */
505 { "kgdbts_break_test", "OK", sw_rem_break
}, /*remove breakpoint */
506 { "s", "T0*", emul_sstep_get
, emul_sstep_put
}, /* Single step */
507 { "g", "kgdbts_break_test", NULL
, check_single_step
},
508 { "kgdbts_break_test", "OK", sw_break
, }, /* set sw breakpoint */
509 { "c", "T0*", }, /* Continue */
510 { "g", "kgdbts_break_test", NULL
, check_and_rewind_pc
},
511 { "write", "OK", write_regs
}, /* Write registers */
512 { "D", "OK" }, /* Remove all breakpoints and continues */
517 * Test for hitting a breakpoint at do_fork for what ever the number
518 * of iterations required by the variable repeat_test.
520 static struct test_struct do_fork_test
[] = {
521 { "?", "S0*" }, /* Clear break points */
522 { "do_fork", "OK", sw_break
, }, /* set sw breakpoint */
523 { "c", "T0*", }, /* Continue */
524 { "g", "do_fork", NULL
, check_and_rewind_pc
}, /* check location */
525 { "write", "OK", write_regs
}, /* Write registers */
526 { "do_fork", "OK", sw_rem_break
}, /*remove breakpoint */
527 { "s", "T0*", emul_sstep_get
, emul_sstep_put
}, /* Single step */
528 { "g", "do_fork", NULL
, check_single_step
},
529 { "do_fork", "OK", sw_break
, }, /* set sw breakpoint */
530 { "7", "T0*", skip_back_repeat_test
}, /* Loop based on repeat_test */
531 { "D", "OK", NULL
, final_ack_set
}, /* detach and unregister I/O */
535 /* Test for hitting a breakpoint at sys_open for what ever the number
536 * of iterations required by the variable repeat_test.
538 static struct test_struct sys_open_test
[] = {
539 { "?", "S0*" }, /* Clear break points */
540 { "sys_open", "OK", sw_break
, }, /* set sw breakpoint */
541 { "c", "T0*", }, /* Continue */
542 { "g", "sys_open", NULL
, check_and_rewind_pc
}, /* check location */
543 { "write", "OK", write_regs
}, /* Write registers */
544 { "sys_open", "OK", sw_rem_break
}, /*remove breakpoint */
545 { "s", "T0*", emul_sstep_get
, emul_sstep_put
}, /* Single step */
546 { "g", "sys_open", NULL
, check_single_step
},
547 { "sys_open", "OK", sw_break
, }, /* set sw breakpoint */
548 { "7", "T0*", skip_back_repeat_test
}, /* Loop based on repeat_test */
549 { "D", "OK", NULL
, final_ack_set
}, /* detach and unregister I/O */
554 * Test for hitting a simple hw breakpoint
556 static struct test_struct hw_breakpoint_test
[] = {
557 { "?", "S0*" }, /* Clear break points */
558 { "kgdbts_break_test", "OK", hw_break
, }, /* set hw breakpoint */
559 { "c", "T0*", }, /* Continue */
560 { "g", "kgdbts_break_test", NULL
, check_and_rewind_pc
},
561 { "write", "OK", write_regs
},
562 { "kgdbts_break_test", "OK", hw_rem_break
}, /*remove breakpoint */
563 { "D", "OK" }, /* Detach */
564 { "D", "OK", NULL
, got_break
}, /* On success we made it here */
569 * Test for hitting a hw write breakpoint
571 static struct test_struct hw_write_break_test
[] = {
572 { "?", "S0*" }, /* Clear break points */
573 { "hw_break_val", "OK", hw_write_break
, }, /* set hw breakpoint */
574 { "c", "T0*", NULL
, got_break
}, /* Continue */
575 { "g", "silent", NULL
, check_and_rewind_pc
},
576 { "write", "OK", write_regs
},
577 { "hw_break_val", "OK", hw_rem_write_break
}, /*remove breakpoint */
578 { "D", "OK" }, /* Detach */
579 { "D", "OK", NULL
, got_break
}, /* On success we made it here */
584 * Test for hitting a hw access breakpoint
586 static struct test_struct hw_access_break_test
[] = {
587 { "?", "S0*" }, /* Clear break points */
588 { "hw_break_val", "OK", hw_access_break
, }, /* set hw breakpoint */
589 { "c", "T0*", NULL
, got_break
}, /* Continue */
590 { "g", "silent", NULL
, check_and_rewind_pc
},
591 { "write", "OK", write_regs
},
592 { "hw_break_val", "OK", hw_rem_access_break
}, /*remove breakpoint */
593 { "D", "OK" }, /* Detach */
594 { "D", "OK", NULL
, got_break
}, /* On success we made it here */
599 * Test for hitting a hw access breakpoint
601 static struct test_struct nmi_sleep_test
[] = {
602 { "?", "S0*" }, /* Clear break points */
603 { "c", "T0*", NULL
, got_break
}, /* Continue */
604 { "D", "OK" }, /* Detach */
605 { "D", "OK", NULL
, got_break
}, /* On success we made it here */
609 static void fill_get_buf(char *buf
)
611 unsigned char checksum
= 0;
615 strcpy(get_buf
, "$");
616 strcat(get_buf
, buf
);
617 while ((ch
= buf
[count
])) {
621 strcat(get_buf
, "#");
622 get_buf
[count
+ 2] = hex_asc_hi(checksum
);
623 get_buf
[count
+ 3] = hex_asc_lo(checksum
);
624 get_buf
[count
+ 4] = '\0';
625 v2printk("get%i: %s\n", ts
.idx
, get_buf
);
628 static int validate_simple_test(char *put_str
)
632 if (ts
.tst
[ts
.idx
].put_handler
)
633 return ts
.tst
[ts
.idx
].put_handler(put_str
,
636 chk_str
= ts
.tst
[ts
.idx
].put
;
640 while (*chk_str
!= '\0' && *put_str
!= '\0') {
641 /* If someone does a * to match the rest of the string, allow
642 * it, or stop if the recieved string is complete.
644 if (*put_str
== '#' || *chk_str
== '*')
646 if (*put_str
!= *chk_str
)
652 if (*chk_str
== '\0' && (*put_str
== '\0' || *put_str
== '#'))
658 static int run_simple_test(int is_get_char
, int chr
)
662 /* Send an ACK on the get if a prior put completed and set the
669 /* On the first get char, fill the transmit buffer and then
670 * take from the get_string.
672 if (get_buf_cnt
== 0) {
673 if (ts
.tst
[ts
.idx
].get_handler
)
674 ts
.tst
[ts
.idx
].get_handler(ts
.tst
[ts
.idx
].get
);
676 fill_get_buf(ts
.tst
[ts
.idx
].get
);
679 if (get_buf
[get_buf_cnt
] == '\0') {
680 eprintk("kgdbts: ERROR GET: EOB on '%s' at %i\n",
685 ret
= get_buf
[get_buf_cnt
];
690 /* This callback is a put char which is when kgdb sends data to
693 if (ts
.tst
[ts
.idx
].get
[0] == '\0' &&
694 ts
.tst
[ts
.idx
].put
[0] == '\0') {
695 eprintk("kgdbts: ERROR: beyond end of test on"
696 " '%s' line %i\n", ts
.name
, ts
.idx
);
700 if (put_buf_cnt
>= BUFMAX
) {
701 eprintk("kgdbts: ERROR: put buffer overflow on"
702 " '%s' line %i\n", ts
.name
, ts
.idx
);
706 /* Ignore everything until the first valid packet start '$' */
707 if (put_buf_cnt
== 0 && chr
!= '$')
710 put_buf
[put_buf_cnt
] = chr
;
713 /* End of packet == #XX so look for the '#' */
714 if (put_buf_cnt
> 3 && put_buf
[put_buf_cnt
- 3] == '#') {
715 if (put_buf_cnt
>= BUFMAX
) {
716 eprintk("kgdbts: ERROR: put buffer overflow on"
717 " '%s' line %i\n", ts
.name
, ts
.idx
);
721 put_buf
[put_buf_cnt
] = '\0';
722 v2printk("put%i: %s\n", ts
.idx
, put_buf
);
723 /* Trigger check here */
724 if (ts
.validate_put
&& ts
.validate_put(put_buf
)) {
725 eprintk("kgdbts: ERROR PUT: end of test "
726 "buffer on '%s' line %i expected %s got %s\n",
727 ts
.name
, ts
.idx
, ts
.tst
[ts
.idx
].put
, put_buf
);
737 static void init_simple_test(void)
739 memset(&ts
, 0, sizeof(ts
));
740 ts
.run_test
= run_simple_test
;
741 ts
.validate_put
= validate_simple_test
;
744 static void run_plant_and_detach_test(int is_early
)
746 char before
[BREAK_INSTR_SIZE
];
747 char after
[BREAK_INSTR_SIZE
];
749 probe_kernel_read(before
, (char *)kgdbts_break_test
,
752 ts
.tst
= plant_and_detach_test
;
753 ts
.name
= "plant_and_detach_test";
754 /* Activate test with initial breakpoint */
757 probe_kernel_read(after
, (char *)kgdbts_break_test
,
759 if (memcmp(before
, after
, BREAK_INSTR_SIZE
)) {
760 printk(KERN_CRIT
"kgdbts: ERROR kgdb corrupted memory\n");
761 panic("kgdb memory corruption");
764 /* complete the detach test */
769 static void run_breakpoint_test(int is_hw_breakpoint
)
773 if (is_hw_breakpoint
) {
774 ts
.tst
= hw_breakpoint_test
;
775 ts
.name
= "hw_breakpoint_test";
777 ts
.tst
= sw_breakpoint_test
;
778 ts
.name
= "sw_breakpoint_test";
780 /* Activate test with initial breakpoint */
782 /* run code with the break point in it */
789 eprintk("kgdbts: ERROR %s test failed\n", ts
.name
);
790 if (is_hw_breakpoint
)
794 static void run_hw_break_test(int is_write_test
)
799 ts
.tst
= hw_write_break_test
;
800 ts
.name
= "hw_write_break_test";
802 ts
.tst
= hw_access_break_test
;
803 ts
.name
= "hw_access_break_test";
805 /* Activate test with initial breakpoint */
807 hw_break_val_access();
809 if (test_complete
== 2) {
810 eprintk("kgdbts: ERROR %s broke on access\n",
814 hw_break_val_write();
818 if (test_complete
== 1)
821 eprintk("kgdbts: ERROR %s test failed\n", ts
.name
);
825 static void run_nmi_sleep_test(int nmi_sleep
)
830 ts
.tst
= nmi_sleep_test
;
831 ts
.name
= "nmi_sleep_test";
832 /* Activate test with initial breakpoint */
834 local_irq_save(flags
);
835 mdelay(nmi_sleep
*1000);
836 touch_nmi_watchdog();
837 local_irq_restore(flags
);
838 if (test_complete
!= 2)
839 eprintk("kgdbts: ERROR nmi_test did not hit nmi\n");
841 if (test_complete
== 1)
844 eprintk("kgdbts: ERROR %s test failed\n", ts
.name
);
847 static void run_bad_read_test(void)
850 ts
.tst
= bad_read_test
;
851 ts
.name
= "bad_read_test";
852 /* Activate test with initial breakpoint */
856 static void run_do_fork_test(void)
859 ts
.tst
= do_fork_test
;
860 ts
.name
= "do_fork_test";
861 /* Activate test with initial breakpoint */
865 static void run_sys_open_test(void)
868 ts
.tst
= sys_open_test
;
869 ts
.name
= "sys_open_test";
870 /* Activate test with initial breakpoint */
874 static void run_singlestep_break_test(void)
877 ts
.tst
= singlestep_break_test
;
878 ts
.name
= "singlestep_breakpoint_test";
879 /* Activate test with initial breakpoint */
885 static void kgdbts_run_tests(void)
889 int do_sys_open_test
= 0;
890 int sstep_test
= 1000;
894 ptr
= strchr(config
, 'F');
896 fork_test
= simple_strtol(ptr
+ 1, NULL
, 10);
897 ptr
= strchr(config
, 'S');
899 do_sys_open_test
= simple_strtol(ptr
+ 1, NULL
, 10);
900 ptr
= strchr(config
, 'N');
902 nmi_sleep
= simple_strtol(ptr
+1, NULL
, 10);
903 ptr
= strchr(config
, 'I');
905 sstep_test
= simple_strtol(ptr
+1, NULL
, 10);
907 /* required internal KGDB tests */
908 v1printk("kgdbts:RUN plant and detach test\n");
909 run_plant_and_detach_test(0);
910 v1printk("kgdbts:RUN sw breakpoint test\n");
911 run_breakpoint_test(0);
912 v1printk("kgdbts:RUN bad memory access test\n");
914 v1printk("kgdbts:RUN singlestep test %i iterations\n", sstep_test
);
915 for (i
= 0; i
< sstep_test
; i
++) {
916 run_singlestep_break_test();
918 v1printk("kgdbts:RUN singlestep [%i/%i]\n",
922 /* ===Optional tests=== */
924 /* All HW break point tests */
925 if (arch_kgdb_ops
.flags
& KGDB_HW_BREAKPOINT
) {
927 v1printk("kgdbts:RUN hw breakpoint test\n");
928 run_breakpoint_test(1);
929 v1printk("kgdbts:RUN hw write breakpoint test\n");
930 run_hw_break_test(1);
931 v1printk("kgdbts:RUN access write breakpoint test\n");
932 run_hw_break_test(0);
936 v1printk("kgdbts:RUN NMI sleep %i seconds test\n", nmi_sleep
);
937 run_nmi_sleep_test(nmi_sleep
);
940 #ifdef CONFIG_DEBUG_RODATA
941 /* Until there is an api to write to read-only text segments, use
942 * HW breakpoints for the remainder of any tests, else print a
943 * failure message if hw breakpoints do not work.
945 if (!(arch_kgdb_ops
.flags
& KGDB_HW_BREAKPOINT
&& hwbreaks_ok
)) {
946 eprintk("kgdbts: HW breakpoints do not work,"
947 "skipping remaining tests\n");
951 #endif /* CONFIG_DEBUG_RODATA */
953 /* If the do_fork test is run it will be the last test that is
954 * executed because a kernel thread will be spawned at the very
955 * end to unregister the debug hooks.
958 repeat_test
= fork_test
;
959 printk(KERN_INFO
"kgdbts:RUN do_fork for %i breakpoints\n",
961 kthread_run(kgdbts_unreg_thread
, NULL
, "kgdbts_unreg");
966 /* If the sys_open test is run it will be the last test that is
967 * executed because a kernel thread will be spawned at the very
968 * end to unregister the debug hooks.
970 if (do_sys_open_test
) {
971 repeat_test
= do_sys_open_test
;
972 printk(KERN_INFO
"kgdbts:RUN sys_open for %i breakpoints\n",
974 kthread_run(kgdbts_unreg_thread
, NULL
, "kgdbts_unreg");
978 /* Shutdown and unregister */
979 kgdb_unregister_io_module(&kgdbts_io_ops
);
983 static int kgdbts_option_setup(char *opt
)
985 if (strlen(opt
) > MAX_CONFIG_LEN
) {
986 printk(KERN_ERR
"kgdbts: config string too long\n");
992 if (strstr(config
, "V1"))
994 if (strstr(config
, "V2"))
1000 __setup("kgdbts=", kgdbts_option_setup
);
1002 static int configure_kgdbts(void)
1006 if (!strlen(config
) || isspace(config
[0]))
1008 err
= kgdbts_option_setup(config
);
1013 run_plant_and_detach_test(1);
1015 err
= kgdb_register_io_module(&kgdbts_io_ops
);
1032 static int __init
init_kgdbts(void)
1034 /* Already configured? */
1035 if (configured
== 1)
1038 return configure_kgdbts();
1041 static void cleanup_kgdbts(void)
1043 if (configured
== 1)
1044 kgdb_unregister_io_module(&kgdbts_io_ops
);
1047 static int kgdbts_get_char(void)
1052 val
= ts
.run_test(1, 0);
1057 static void kgdbts_put_char(u8 chr
)
1060 ts
.run_test(0, chr
);
1063 static int param_set_kgdbts_var(const char *kmessage
, struct kernel_param
*kp
)
1065 int len
= strlen(kmessage
);
1067 if (len
>= MAX_CONFIG_LEN
) {
1068 printk(KERN_ERR
"kgdbts: config string too long\n");
1072 /* Only copy in the string if the init function has not run yet */
1073 if (configured
< 0) {
1074 strcpy(config
, kmessage
);
1078 if (kgdb_connected
) {
1080 "kgdbts: Cannot reconfigure while KGDB is connected.\n");
1085 strcpy(config
, kmessage
);
1086 /* Chop out \n char as a result of echo */
1087 if (config
[len
- 1] == '\n')
1088 config
[len
- 1] = '\0';
1090 if (configured
== 1)
1093 /* Go and configure with the new params. */
1094 return configure_kgdbts();
1097 static void kgdbts_pre_exp_handler(void)
1099 /* Increment the module count when the debugger is active */
1100 if (!kgdb_connected
)
1101 try_module_get(THIS_MODULE
);
1104 static void kgdbts_post_exp_handler(void)
1106 /* decrement the module count when the debugger detaches */
1107 if (!kgdb_connected
)
1108 module_put(THIS_MODULE
);
1111 static struct kgdb_io kgdbts_io_ops
= {
1113 .read_char
= kgdbts_get_char
,
1114 .write_char
= kgdbts_put_char
,
1115 .pre_exception
= kgdbts_pre_exp_handler
,
1116 .post_exception
= kgdbts_post_exp_handler
,
1119 module_init(init_kgdbts
);
1120 module_exit(cleanup_kgdbts
);
1121 module_param_call(kgdbts
, param_set_kgdbts_var
, param_get_string
, &kps
, 0644);
1122 MODULE_PARM_DESC(kgdbts
, "<A|V1|V2>[F#|S#][N#]");
1123 MODULE_DESCRIPTION("KGDB Test Suite");
1124 MODULE_LICENSE("GPL");
1125 MODULE_AUTHOR("Wind River Systems, Inc.");