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);
291 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
293 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
294 ip = instruction_pointer(&kgdbts_regs);
295 v2printk("Stopped at IP: %lx\n", ip);
296 #ifdef GDB_ADJUSTS_BREAK_OFFSET
297 /* On some arches, a breakpoint stop requires it to be decremented */
298 if (addr + BREAK_INSTR_SIZE == ip)
299 offset = -BREAK_INSTR_SIZE;
301 if (strcmp(arg, "silent") && ip + offset != addr) {
302 eprintk("kgdbts: BP mismatch %lx expected %lx\n",
306 /* Readjust the instruction pointer if needed */
308 #ifdef GDB_ADJUSTS_BREAK_OFFSET
309 instruction_pointer_set(&kgdbts_regs, ip);
314 static int check_single_step(char *put_str, char *arg)
316 unsigned long addr = lookup_addr(arg);
318 * From an arch indepent point of view the instruction pointer
319 * should be on a different instruction
321 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
323 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
324 v2printk("Singlestep stopped at IP: %lx\n",
325 instruction_pointer(&kgdbts_regs));
326 if (instruction_pointer(&kgdbts_regs) == addr) {
327 eprintk("kgdbts: SingleStep failed at %lx\n",
328 instruction_pointer(&kgdbts_regs));
335 static void write_regs(char *arg)
337 memset(scratch_buf, 0, sizeof(scratch_buf));
338 scratch_buf[0] = 'G';
339 pt_regs_to_gdb_regs(kgdbts_gdb_regs, &kgdbts_regs);
340 kgdb_mem2hex((char *)kgdbts_gdb_regs, &scratch_buf[1], NUMREGBYTES);
341 fill_get_buf(scratch_buf);
344 static void skip_back_repeat_test(char *arg)
346 int go_back = simple_strtol(arg, NULL, 10);
349 if (repeat_test <= 0)
353 fill_get_buf(ts.tst[ts.idx].get);
356 static int got_break(char *put_str, char *arg)
359 if (!strncmp(put_str+1, arg, 2)) {
360 if (!strncmp(arg, "T0", 2))
367 static void emul_sstep_get(char *arg)
369 if (!arch_needs_sstep_emulation) {
373 switch (sstep_state) {
375 v2printk("Emulate single step\n");
376 /* Start by looking at the current PC */
381 break_helper("Z0", NULL, sstep_addr);
388 /* Clear breakpoint */
389 break_helper("z0", NULL, sstep_addr);
392 eprintk("kgdbts: ERROR failed sstep get emulation\n");
397 static int emul_sstep_put(char *put_str, char *arg)
399 if (!arch_needs_sstep_emulation) {
400 if (!strncmp(put_str+1, arg, 2))
404 switch (sstep_state) {
406 /* validate the "g" packet to get the IP */
407 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
409 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
410 v2printk("Stopped at IP: %lx\n",
411 instruction_pointer(&kgdbts_regs));
412 /* Want to stop at IP + break instruction size by default */
413 sstep_addr = instruction_pointer(&kgdbts_regs) +
417 if (strncmp(put_str, "$OK", 3)) {
418 eprintk("kgdbts: failed sstep break set\n");
423 if (strncmp(put_str, "$T0", 3)) {
424 eprintk("kgdbts: failed continue sstep\n");
429 if (strncmp(put_str, "$OK", 3)) {
430 eprintk("kgdbts: failed sstep break unset\n");
433 /* Single step is complete so continue on! */
437 eprintk("kgdbts: ERROR failed sstep put emulation\n");
440 /* Continue on the same test line until emulation is complete */
445 static int final_ack_set(char *put_str, char *arg)
447 if (strncmp(put_str+1, arg, 2))
453 * Test to plant a breakpoint and detach, which should clear out the
454 * breakpoint and restore the original instruction.
456 static struct test_struct plant_and_detach_test[] = {
457 { "?", "S0*" }, /* Clear break points */
458 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
459 { "D", "OK" }, /* Detach */
464 * Simple test to write in a software breakpoint, check for the
465 * correct stop location and detach.
467 static struct test_struct sw_breakpoint_test[] = {
468 { "?", "S0*" }, /* Clear break points */
469 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
470 { "c", "T0*", }, /* Continue */
471 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
472 { "write", "OK", write_regs },
473 { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */
474 { "D", "OK" }, /* Detach */
475 { "D", "OK", NULL, got_break }, /* On success we made it here */
480 * Test a known bad memory read location to test the fault handler and
481 * read bytes 1-8 at the bad address
483 static struct test_struct bad_read_test[] = {
484 { "?", "S0*" }, /* Clear break points */
485 { "m0,1", "E*" }, /* read 1 byte at address 1 */
486 { "m0,2", "E*" }, /* read 1 byte at address 2 */
487 { "m0,3", "E*" }, /* read 1 byte at address 3 */
488 { "m0,4", "E*" }, /* read 1 byte at address 4 */
489 { "m0,5", "E*" }, /* read 1 byte at address 5 */
490 { "m0,6", "E*" }, /* read 1 byte at address 6 */
491 { "m0,7", "E*" }, /* read 1 byte at address 7 */
492 { "m0,8", "E*" }, /* read 1 byte at address 8 */
493 { "D", "OK" }, /* Detach which removes all breakpoints and continues */
498 * Test for hitting a breakpoint, remove it, single step, plant it
501 static struct test_struct singlestep_break_test[] = {
502 { "?", "S0*" }, /* Clear break points */
503 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
504 { "c", "T0*", }, /* Continue */
505 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
506 { "write", "OK", write_regs }, /* Write registers */
507 { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */
508 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
509 { "g", "kgdbts_break_test", NULL, check_single_step },
510 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
511 { "c", "T0*", }, /* Continue */
512 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
513 { "write", "OK", write_regs }, /* Write registers */
514 { "D", "OK" }, /* Remove all breakpoints and continues */
519 * Test for hitting a breakpoint at do_fork for what ever the number
520 * of iterations required by the variable repeat_test.
522 static struct test_struct do_fork_test[] = {
523 { "?", "S0*" }, /* Clear break points */
524 { "do_fork", "OK", sw_break, }, /* set sw breakpoint */
525 { "c", "T0*", }, /* Continue */
526 { "g", "do_fork", NULL, check_and_rewind_pc }, /* check location */
527 { "write", "OK", write_regs }, /* Write registers */
528 { "do_fork", "OK", sw_rem_break }, /*remove breakpoint */
529 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
530 { "g", "do_fork", NULL, check_single_step },
531 { "do_fork", "OK", sw_break, }, /* set sw breakpoint */
532 { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */
533 { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */
537 /* Test for hitting a breakpoint at sys_open for what ever the number
538 * of iterations required by the variable repeat_test.
540 static struct test_struct sys_open_test[] = {
541 { "?", "S0*" }, /* Clear break points */
542 { "sys_open", "OK", sw_break, }, /* set sw breakpoint */
543 { "c", "T0*", }, /* Continue */
544 { "g", "sys_open", NULL, check_and_rewind_pc }, /* check location */
545 { "write", "OK", write_regs }, /* Write registers */
546 { "sys_open", "OK", sw_rem_break }, /*remove breakpoint */
547 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
548 { "g", "sys_open", NULL, check_single_step },
549 { "sys_open", "OK", sw_break, }, /* set sw breakpoint */
550 { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */
551 { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */
556 * Test for hitting a simple hw breakpoint
558 static struct test_struct hw_breakpoint_test[] = {
559 { "?", "S0*" }, /* Clear break points */
560 { "kgdbts_break_test", "OK", hw_break, }, /* set hw breakpoint */
561 { "c", "T0*", }, /* Continue */
562 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
563 { "write", "OK", write_regs },
564 { "kgdbts_break_test", "OK", hw_rem_break }, /*remove breakpoint */
565 { "D", "OK" }, /* Detach */
566 { "D", "OK", NULL, got_break }, /* On success we made it here */
571 * Test for hitting a hw write breakpoint
573 static struct test_struct hw_write_break_test[] = {
574 { "?", "S0*" }, /* Clear break points */
575 { "hw_break_val", "OK", hw_write_break, }, /* set hw breakpoint */
576 { "c", "T0*", NULL, got_break }, /* Continue */
577 { "g", "silent", NULL, check_and_rewind_pc },
578 { "write", "OK", write_regs },
579 { "hw_break_val", "OK", hw_rem_write_break }, /*remove breakpoint */
580 { "D", "OK" }, /* Detach */
581 { "D", "OK", NULL, got_break }, /* On success we made it here */
586 * Test for hitting a hw access breakpoint
588 static struct test_struct hw_access_break_test[] = {
589 { "?", "S0*" }, /* Clear break points */
590 { "hw_break_val", "OK", hw_access_break, }, /* set hw breakpoint */
591 { "c", "T0*", NULL, got_break }, /* Continue */
592 { "g", "silent", NULL, check_and_rewind_pc },
593 { "write", "OK", write_regs },
594 { "hw_break_val", "OK", hw_rem_access_break }, /*remove breakpoint */
595 { "D", "OK" }, /* Detach */
596 { "D", "OK", NULL, got_break }, /* On success we made it here */
601 * Test for hitting a hw access breakpoint
603 static struct test_struct nmi_sleep_test[] = {
604 { "?", "S0*" }, /* Clear break points */
605 { "c", "T0*", NULL, got_break }, /* Continue */
606 { "D", "OK" }, /* Detach */
607 { "D", "OK", NULL, got_break }, /* On success we made it here */
611 static void fill_get_buf(char *buf)
613 unsigned char checksum = 0;
617 strcpy(get_buf, "$");
618 strcat(get_buf, buf);
619 while ((ch = buf[count])) {
623 strcat(get_buf, "#");
624 get_buf[count + 2] = hex_asc_hi(checksum);
625 get_buf[count + 3] = hex_asc_lo(checksum);
626 get_buf[count + 4] = '\0';
627 v2printk("get%i: %s\n", ts.idx, get_buf);
630 static int validate_simple_test(char *put_str)
634 if (ts.tst[ts.idx].put_handler)
635 return ts.tst[ts.idx].put_handler(put_str,
638 chk_str = ts.tst[ts.idx].put;
642 while (*chk_str != '\0' && *put_str != '\0') {
643 /* If someone does a * to match the rest of the string, allow
644 * it, or stop if the received string is complete.
646 if (*put_str == '#' || *chk_str == '*')
648 if (*put_str != *chk_str)
654 if (*chk_str == '\0' && (*put_str == '\0' || *put_str == '#'))
660 static int run_simple_test(int is_get_char, int chr)
664 /* Send an ACK on the get if a prior put completed and set the
671 /* On the first get char, fill the transmit buffer and then
672 * take from the get_string.
674 if (get_buf_cnt == 0) {
675 if (ts.tst[ts.idx].get_handler)
676 ts.tst[ts.idx].get_handler(ts.tst[ts.idx].get);
678 fill_get_buf(ts.tst[ts.idx].get);
681 if (get_buf[get_buf_cnt] == '\0') {
682 eprintk("kgdbts: ERROR GET: EOB on '%s' at %i\n",
687 ret = get_buf[get_buf_cnt];
692 /* This callback is a put char which is when kgdb sends data to
695 if (ts.tst[ts.idx].get[0] == '\0' &&
696 ts.tst[ts.idx].put[0] == '\0') {
697 eprintk("kgdbts: ERROR: beyond end of test on"
698 " '%s' line %i\n", ts.name, ts.idx);
702 if (put_buf_cnt >= BUFMAX) {
703 eprintk("kgdbts: ERROR: put buffer overflow on"
704 " '%s' line %i\n", ts.name, ts.idx);
708 /* Ignore everything until the first valid packet start '$' */
709 if (put_buf_cnt == 0 && chr != '$')
712 put_buf[put_buf_cnt] = chr;
715 /* End of packet == #XX so look for the '#' */
716 if (put_buf_cnt > 3 && put_buf[put_buf_cnt - 3] == '#') {
717 if (put_buf_cnt >= BUFMAX) {
718 eprintk("kgdbts: ERROR: put buffer overflow on"
719 " '%s' line %i\n", ts.name, ts.idx);
723 put_buf[put_buf_cnt] = '\0';
724 v2printk("put%i: %s\n", ts.idx, put_buf);
725 /* Trigger check here */
726 if (ts.validate_put && ts.validate_put(put_buf)) {
727 eprintk("kgdbts: ERROR PUT: end of test "
728 "buffer on '%s' line %i expected %s got %s\n",
729 ts.name, ts.idx, ts.tst[ts.idx].put, put_buf);
739 static void init_simple_test(void)
741 memset(&ts, 0, sizeof(ts));
742 ts.run_test = run_simple_test;
743 ts.validate_put = validate_simple_test;
746 static void run_plant_and_detach_test(int is_early)
748 char before[BREAK_INSTR_SIZE];
749 char after[BREAK_INSTR_SIZE];
751 probe_kernel_read(before, (char *)kgdbts_break_test,
754 ts.tst = plant_and_detach_test;
755 ts.name = "plant_and_detach_test";
756 /* Activate test with initial breakpoint */
759 probe_kernel_read(after, (char *)kgdbts_break_test,
761 if (memcmp(before, after, BREAK_INSTR_SIZE)) {
762 printk(KERN_CRIT "kgdbts: ERROR kgdb corrupted memory\n");
763 panic("kgdb memory corruption");
766 /* complete the detach test */
771 static void run_breakpoint_test(int is_hw_breakpoint)
775 if (is_hw_breakpoint) {
776 ts.tst = hw_breakpoint_test;
777 ts.name = "hw_breakpoint_test";
779 ts.tst = sw_breakpoint_test;
780 ts.name = "sw_breakpoint_test";
782 /* Activate test with initial breakpoint */
784 /* run code with the break point in it */
791 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
792 if (is_hw_breakpoint)
796 static void run_hw_break_test(int is_write_test)
801 ts.tst = hw_write_break_test;
802 ts.name = "hw_write_break_test";
804 ts.tst = hw_access_break_test;
805 ts.name = "hw_access_break_test";
807 /* Activate test with initial breakpoint */
809 hw_break_val_access();
811 if (test_complete == 2) {
812 eprintk("kgdbts: ERROR %s broke on access\n",
816 hw_break_val_write();
820 if (test_complete == 1)
823 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
827 static void run_nmi_sleep_test(int nmi_sleep)
832 ts.tst = nmi_sleep_test;
833 ts.name = "nmi_sleep_test";
834 /* Activate test with initial breakpoint */
836 local_irq_save(flags);
837 mdelay(nmi_sleep*1000);
838 touch_nmi_watchdog();
839 local_irq_restore(flags);
840 if (test_complete != 2)
841 eprintk("kgdbts: ERROR nmi_test did not hit nmi\n");
843 if (test_complete == 1)
846 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
849 static void run_bad_read_test(void)
852 ts.tst = bad_read_test;
853 ts.name = "bad_read_test";
854 /* Activate test with initial breakpoint */
858 static void run_do_fork_test(void)
861 ts.tst = do_fork_test;
862 ts.name = "do_fork_test";
863 /* Activate test with initial breakpoint */
867 static void run_sys_open_test(void)
870 ts.tst = sys_open_test;
871 ts.name = "sys_open_test";
872 /* Activate test with initial breakpoint */
876 static void run_singlestep_break_test(void)
879 ts.tst = singlestep_break_test;
880 ts.name = "singlestep_breakpoint_test";
881 /* Activate test with initial breakpoint */
887 static void kgdbts_run_tests(void)
891 int do_sys_open_test = 0;
892 int sstep_test = 1000;
896 ptr = strchr(config, 'F');
898 fork_test = simple_strtol(ptr + 1, NULL, 10);
899 ptr = strchr(config, 'S');
901 do_sys_open_test = simple_strtol(ptr + 1, NULL, 10);
902 ptr = strchr(config, 'N');
904 nmi_sleep = simple_strtol(ptr+1, NULL, 10);
905 ptr = strchr(config, 'I');
907 sstep_test = simple_strtol(ptr+1, NULL, 10);
909 /* required internal KGDB tests */
910 v1printk("kgdbts:RUN plant and detach test\n");
911 run_plant_and_detach_test(0);
912 v1printk("kgdbts:RUN sw breakpoint test\n");
913 run_breakpoint_test(0);
914 v1printk("kgdbts:RUN bad memory access test\n");
916 v1printk("kgdbts:RUN singlestep test %i iterations\n", sstep_test);
917 for (i = 0; i < sstep_test; i++) {
918 run_singlestep_break_test();
920 v1printk("kgdbts:RUN singlestep [%i/%i]\n",
924 /* ===Optional tests=== */
926 /* All HW break point tests */
927 if (arch_kgdb_ops.flags & KGDB_HW_BREAKPOINT) {
929 v1printk("kgdbts:RUN hw breakpoint test\n");
930 run_breakpoint_test(1);
931 v1printk("kgdbts:RUN hw write breakpoint test\n");
932 run_hw_break_test(1);
933 v1printk("kgdbts:RUN access write breakpoint test\n");
934 run_hw_break_test(0);
938 v1printk("kgdbts:RUN NMI sleep %i seconds test\n", nmi_sleep);
939 run_nmi_sleep_test(nmi_sleep);
942 #ifdef CONFIG_DEBUG_RODATA
943 /* Until there is an api to write to read-only text segments, use
944 * HW breakpoints for the remainder of any tests, else print a
945 * failure message if hw breakpoints do not work.
947 if (!(arch_kgdb_ops.flags & KGDB_HW_BREAKPOINT && hwbreaks_ok)) {
948 eprintk("kgdbts: HW breakpoints do not work,"
949 "skipping remaining tests\n");
953 #endif /* CONFIG_DEBUG_RODATA */
955 /* If the do_fork test is run it will be the last test that is
956 * executed because a kernel thread will be spawned at the very
957 * end to unregister the debug hooks.
960 repeat_test = fork_test;
961 printk(KERN_INFO "kgdbts:RUN do_fork for %i breakpoints\n",
963 kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg");
968 /* If the sys_open test is run it will be the last test that is
969 * executed because a kernel thread will be spawned at the very
970 * end to unregister the debug hooks.
972 if (do_sys_open_test) {
973 repeat_test = do_sys_open_test;
974 printk(KERN_INFO "kgdbts:RUN sys_open for %i breakpoints\n",
976 kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg");
980 /* Shutdown and unregister */
981 kgdb_unregister_io_module(&kgdbts_io_ops);
985 static int kgdbts_option_setup(char *opt)
987 if (strlen(opt) >= MAX_CONFIG_LEN) {
988 printk(KERN_ERR "kgdbts: config string too long\n");
994 if (strstr(config, "V1"))
996 if (strstr(config, "V2"))
1002 __setup("kgdbts=", kgdbts_option_setup);
1004 static int configure_kgdbts(void)
1008 if (!strlen(config) || isspace(config[0]))
1010 err = kgdbts_option_setup(config);
1015 run_plant_and_detach_test(1);
1017 err = kgdb_register_io_module(&kgdbts_io_ops);
1034 static int __init init_kgdbts(void)
1036 /* Already configured? */
1037 if (configured == 1)
1040 return configure_kgdbts();
1043 static int kgdbts_get_char(void)
1048 val = ts.run_test(1, 0);
1053 static void kgdbts_put_char(u8 chr)
1056 ts.run_test(0, chr);
1059 static int param_set_kgdbts_var(const char *kmessage, struct kernel_param *kp)
1061 int len = strlen(kmessage);
1063 if (len >= MAX_CONFIG_LEN) {
1064 printk(KERN_ERR "kgdbts: config string too long\n");
1068 /* Only copy in the string if the init function has not run yet */
1069 if (configured < 0) {
1070 strcpy(config, kmessage);
1074 if (configured == 1) {
1075 printk(KERN_ERR "kgdbts: ERROR: Already configured and running.\n");
1079 strcpy(config, kmessage);
1080 /* Chop out \n char as a result of echo */
1081 if (config[len - 1] == '\n')
1082 config[len - 1] = '\0';
1084 /* Go and configure with the new params. */
1085 return configure_kgdbts();
1088 static void kgdbts_pre_exp_handler(void)
1090 /* Increment the module count when the debugger is active */
1091 if (!kgdb_connected)
1092 try_module_get(THIS_MODULE);
1095 static void kgdbts_post_exp_handler(void)
1097 /* decrement the module count when the debugger detaches */
1098 if (!kgdb_connected)
1099 module_put(THIS_MODULE);
1102 static struct kgdb_io kgdbts_io_ops = {
1104 .read_char = kgdbts_get_char,
1105 .write_char = kgdbts_put_char,
1106 .pre_exception = kgdbts_pre_exp_handler,
1107 .post_exception = kgdbts_post_exp_handler,
1110 module_init(init_kgdbts);
1111 module_param_call(kgdbts, param_set_kgdbts_var, param_get_string, &kps, 0644);
1112 MODULE_PARM_DESC(kgdbts, "<A|V1|V2>[F#|S#][N#]");
1113 MODULE_DESCRIPTION("KGDB Test Suite");
1114 MODULE_LICENSE("GPL");
1115 MODULE_AUTHOR("Wind River Systems, Inc.");