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 <linux/sched/task.h>
108 #include <asm/sections.h>
110 #define v1printk(a...) do { \
112 printk(KERN_INFO a); \
114 #define v2printk(a...) do { \
116 printk(KERN_INFO a); \
118 touch_nmi_watchdog(); \
120 #define eprintk(a...) do { \
121 printk(KERN_ERR a); \
124 #define MAX_CONFIG_LEN 40
126 static struct kgdb_io kgdbts_io_ops;
127 static char get_buf[BUFMAX];
128 static int get_buf_cnt;
129 static char put_buf[BUFMAX];
130 static int put_buf_cnt;
131 static char scratch_buf[BUFMAX];
133 static int repeat_test;
134 static int test_complete;
136 static int final_ack;
137 static int force_hwbrks;
138 static int hwbreaks_ok;
139 static int hw_break_val;
140 static int hw_break_val2;
141 static int cont_instead_of_sstep;
142 static unsigned long cont_thread_id;
143 static unsigned long sstep_thread_id;
144 #if defined(CONFIG_ARM) || defined(CONFIG_MIPS) || defined(CONFIG_SPARC)
145 static int arch_needs_sstep_emulation = 1;
147 static int arch_needs_sstep_emulation;
149 static unsigned long cont_addr;
150 static unsigned long sstep_addr;
151 static int restart_from_top_after_write;
152 static int sstep_state;
154 /* Storage for the registers, in GDB format. */
155 static unsigned long kgdbts_gdb_regs[(NUMREGBYTES +
156 sizeof(unsigned long) - 1) /
157 sizeof(unsigned long)];
158 static struct pt_regs kgdbts_regs;
160 /* -1 = init not run yet, 0 = unconfigured, 1 = configured. */
161 static int configured = -1;
163 #ifdef CONFIG_KGDB_TESTS_BOOT_STRING
164 static char config[MAX_CONFIG_LEN] = CONFIG_KGDB_TESTS_BOOT_STRING;
166 static char config[MAX_CONFIG_LEN];
168 static struct kparam_string kps = {
170 .maxlen = MAX_CONFIG_LEN,
173 static void fill_get_buf(char *buf);
178 void (*get_handler)(char *);
179 int (*put_handler)(char *, char *);
184 struct test_struct *tst;
186 int (*run_test) (int, int);
187 int (*validate_put) (char *);
190 static struct test_state ts;
192 static int kgdbts_unreg_thread(void *ptr)
194 /* Wait until the tests are complete and then ungresiter the I/O
198 msleep_interruptible(1500);
199 /* Pause for any other threads to exit after final ack. */
200 msleep_interruptible(1000);
202 kgdb_unregister_io_module(&kgdbts_io_ops);
208 /* This is noinline such that it can be used for a single location to
211 static noinline void kgdbts_break_test(void)
213 v2printk("kgdbts: breakpoint complete\n");
216 /* Lookup symbol info in the kernel */
217 static unsigned long lookup_addr(char *arg)
219 unsigned long addr = 0;
221 if (!strcmp(arg, "kgdbts_break_test"))
222 addr = (unsigned long)kgdbts_break_test;
223 else if (!strcmp(arg, "sys_open"))
224 addr = (unsigned long)do_sys_open;
225 else if (!strcmp(arg, "do_fork"))
226 addr = (unsigned long)_do_fork;
227 else if (!strcmp(arg, "hw_break_val"))
228 addr = (unsigned long)&hw_break_val;
229 addr = (unsigned long) dereference_function_descriptor((void *)addr);
233 static void break_helper(char *bp_type, char *arg, unsigned long vaddr)
238 addr = lookup_addr(arg);
242 sprintf(scratch_buf, "%s,%lx,%i", bp_type, addr,
244 fill_get_buf(scratch_buf);
247 static void sw_break(char *arg)
249 break_helper(force_hwbrks ? "Z1" : "Z0", arg, 0);
252 static void sw_rem_break(char *arg)
254 break_helper(force_hwbrks ? "z1" : "z0", arg, 0);
257 static void hw_break(char *arg)
259 break_helper("Z1", arg, 0);
262 static void hw_rem_break(char *arg)
264 break_helper("z1", arg, 0);
267 static void hw_write_break(char *arg)
269 break_helper("Z2", arg, 0);
272 static void hw_rem_write_break(char *arg)
274 break_helper("z2", arg, 0);
277 static void hw_access_break(char *arg)
279 break_helper("Z4", arg, 0);
282 static void hw_rem_access_break(char *arg)
284 break_helper("z4", arg, 0);
287 static void hw_break_val_access(void)
289 hw_break_val2 = hw_break_val;
292 static void hw_break_val_write(void)
297 static int get_thread_id_continue(char *put_str, char *arg)
299 char *ptr = &put_str[11];
301 if (put_str[1] != 'T' || put_str[2] != '0')
303 kgdb_hex2long(&ptr, &cont_thread_id);
307 static int check_and_rewind_pc(char *put_str, char *arg)
309 unsigned long addr = lookup_addr(arg);
313 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
315 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
316 ip = instruction_pointer(&kgdbts_regs);
317 v2printk("Stopped at IP: %lx\n", ip);
318 #ifdef GDB_ADJUSTS_BREAK_OFFSET
319 /* On some arches, a breakpoint stop requires it to be decremented */
320 if (addr + BREAK_INSTR_SIZE == ip)
321 offset = -BREAK_INSTR_SIZE;
324 if (arch_needs_sstep_emulation && sstep_addr &&
325 ip + offset == sstep_addr &&
326 ((!strcmp(arg, "sys_open") || !strcmp(arg, "do_fork")))) {
327 /* This is special case for emulated single step */
328 v2printk("Emul: rewind hit single step bp\n");
329 restart_from_top_after_write = 1;
330 } else if (strcmp(arg, "silent") && ip + offset != addr) {
331 eprintk("kgdbts: BP mismatch %lx expected %lx\n",
335 /* Readjust the instruction pointer if needed */
338 #ifdef GDB_ADJUSTS_BREAK_OFFSET
339 instruction_pointer_set(&kgdbts_regs, ip);
344 static int check_single_step(char *put_str, char *arg)
346 unsigned long addr = lookup_addr(arg);
347 static int matched_id;
350 * From an arch indepent point of view the instruction pointer
351 * should be on a different instruction
353 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
355 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
356 v2printk("Singlestep stopped at IP: %lx\n",
357 instruction_pointer(&kgdbts_regs));
359 if (sstep_thread_id != cont_thread_id) {
361 * Ensure we stopped in the same thread id as before, else the
362 * debugger should continue until the original thread that was
363 * single stepped is scheduled again, emulating gdb's behavior.
365 v2printk("ThrID does not match: %lx\n", cont_thread_id);
366 if (arch_needs_sstep_emulation) {
368 instruction_pointer(&kgdbts_regs) != addr)
375 cont_instead_of_sstep = 1;
381 if (instruction_pointer(&kgdbts_regs) == addr) {
382 eprintk("kgdbts: SingleStep failed at %lx\n",
383 instruction_pointer(&kgdbts_regs));
390 static void write_regs(char *arg)
392 memset(scratch_buf, 0, sizeof(scratch_buf));
393 scratch_buf[0] = 'G';
394 pt_regs_to_gdb_regs(kgdbts_gdb_regs, &kgdbts_regs);
395 kgdb_mem2hex((char *)kgdbts_gdb_regs, &scratch_buf[1], NUMREGBYTES);
396 fill_get_buf(scratch_buf);
399 static void skip_back_repeat_test(char *arg)
401 int go_back = simple_strtol(arg, NULL, 10);
404 if (repeat_test <= 0) {
407 if (repeat_test % 100 == 0)
408 v1printk("kgdbts:RUN ... %d remaining\n", repeat_test);
412 fill_get_buf(ts.tst[ts.idx].get);
415 static int got_break(char *put_str, char *arg)
418 if (!strncmp(put_str+1, arg, 2)) {
419 if (!strncmp(arg, "T0", 2))
426 static void get_cont_catch(char *arg)
428 /* Always send detach because the test is completed at this point */
432 static int put_cont_catch(char *put_str, char *arg)
434 /* This is at the end of the test and we catch any and all input */
435 v2printk("kgdbts: cleanup task: %lx\n", sstep_thread_id);
440 static int emul_reset(char *put_str, char *arg)
442 if (strncmp(put_str, "$OK", 3))
444 if (restart_from_top_after_write) {
445 restart_from_top_after_write = 0;
451 static void emul_sstep_get(char *arg)
453 if (!arch_needs_sstep_emulation) {
454 if (cont_instead_of_sstep) {
455 cont_instead_of_sstep = 0;
462 switch (sstep_state) {
464 v2printk("Emulate single step\n");
465 /* Start by looking at the current PC */
470 break_helper("Z0", NULL, sstep_addr);
477 /* Clear breakpoint */
478 break_helper("z0", NULL, sstep_addr);
481 eprintk("kgdbts: ERROR failed sstep get emulation\n");
486 static int emul_sstep_put(char *put_str, char *arg)
488 if (!arch_needs_sstep_emulation) {
489 char *ptr = &put_str[11];
490 if (put_str[1] != 'T' || put_str[2] != '0')
492 kgdb_hex2long(&ptr, &sstep_thread_id);
495 switch (sstep_state) {
497 /* validate the "g" packet to get the IP */
498 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
500 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
501 v2printk("Stopped at IP: %lx\n",
502 instruction_pointer(&kgdbts_regs));
503 /* Want to stop at IP + break instruction size by default */
504 sstep_addr = cont_addr + BREAK_INSTR_SIZE;
507 if (strncmp(put_str, "$OK", 3)) {
508 eprintk("kgdbts: failed sstep break set\n");
513 if (strncmp(put_str, "$T0", 3)) {
514 eprintk("kgdbts: failed continue sstep\n");
517 char *ptr = &put_str[11];
518 kgdb_hex2long(&ptr, &sstep_thread_id);
522 if (strncmp(put_str, "$OK", 3)) {
523 eprintk("kgdbts: failed sstep break unset\n");
526 /* Single step is complete so continue on! */
530 eprintk("kgdbts: ERROR failed sstep put emulation\n");
533 /* Continue on the same test line until emulation is complete */
538 static int final_ack_set(char *put_str, char *arg)
540 if (strncmp(put_str+1, arg, 2))
546 * Test to plant a breakpoint and detach, which should clear out the
547 * breakpoint and restore the original instruction.
549 static struct test_struct plant_and_detach_test[] = {
550 { "?", "S0*" }, /* Clear break points */
551 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
552 { "D", "OK" }, /* Detach */
557 * Simple test to write in a software breakpoint, check for the
558 * correct stop location and detach.
560 static struct test_struct sw_breakpoint_test[] = {
561 { "?", "S0*" }, /* Clear break points */
562 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
563 { "c", "T0*", }, /* Continue */
564 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
565 { "write", "OK", write_regs },
566 { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */
567 { "D", "OK" }, /* Detach */
568 { "D", "OK", NULL, got_break }, /* On success we made it here */
573 * Test a known bad memory read location to test the fault handler and
574 * read bytes 1-8 at the bad address
576 static struct test_struct bad_read_test[] = {
577 { "?", "S0*" }, /* Clear break points */
578 { "m0,1", "E*" }, /* read 1 byte at address 1 */
579 { "m0,2", "E*" }, /* read 1 byte at address 2 */
580 { "m0,3", "E*" }, /* read 1 byte at address 3 */
581 { "m0,4", "E*" }, /* read 1 byte at address 4 */
582 { "m0,5", "E*" }, /* read 1 byte at address 5 */
583 { "m0,6", "E*" }, /* read 1 byte at address 6 */
584 { "m0,7", "E*" }, /* read 1 byte at address 7 */
585 { "m0,8", "E*" }, /* read 1 byte at address 8 */
586 { "D", "OK" }, /* Detach which removes all breakpoints and continues */
591 * Test for hitting a breakpoint, remove it, single step, plant it
594 static struct test_struct singlestep_break_test[] = {
595 { "?", "S0*" }, /* Clear break points */
596 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
597 { "c", "T0*", NULL, get_thread_id_continue }, /* Continue */
598 { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */
599 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
600 { "write", "OK", write_regs }, /* Write registers */
601 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
602 { "g", "kgdbts_break_test", NULL, check_single_step },
603 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
604 { "c", "T0*", }, /* Continue */
605 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
606 { "write", "OK", write_regs }, /* Write registers */
607 { "D", "OK" }, /* Remove all breakpoints and continues */
612 * Test for hitting a breakpoint at do_fork for what ever the number
613 * of iterations required by the variable repeat_test.
615 static struct test_struct do_fork_test[] = {
616 { "?", "S0*" }, /* Clear break points */
617 { "do_fork", "OK", sw_break, }, /* set sw breakpoint */
618 { "c", "T0*", NULL, get_thread_id_continue }, /* Continue */
619 { "do_fork", "OK", sw_rem_break }, /*remove breakpoint */
620 { "g", "do_fork", NULL, check_and_rewind_pc }, /* check location */
621 { "write", "OK", write_regs, emul_reset }, /* Write registers */
622 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
623 { "g", "do_fork", NULL, check_single_step },
624 { "do_fork", "OK", sw_break, }, /* set sw breakpoint */
625 { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */
626 { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */
627 { "", "", get_cont_catch, put_cont_catch },
630 /* Test for hitting a breakpoint at sys_open for what ever the number
631 * of iterations required by the variable repeat_test.
633 static struct test_struct sys_open_test[] = {
634 { "?", "S0*" }, /* Clear break points */
635 { "sys_open", "OK", sw_break, }, /* set sw breakpoint */
636 { "c", "T0*", NULL, get_thread_id_continue }, /* Continue */
637 { "sys_open", "OK", sw_rem_break }, /*remove breakpoint */
638 { "g", "sys_open", NULL, check_and_rewind_pc }, /* check location */
639 { "write", "OK", write_regs, emul_reset }, /* Write registers */
640 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
641 { "g", "sys_open", NULL, check_single_step },
642 { "sys_open", "OK", sw_break, }, /* set sw breakpoint */
643 { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */
644 { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */
645 { "", "", get_cont_catch, put_cont_catch },
649 * Test for hitting a simple hw breakpoint
651 static struct test_struct hw_breakpoint_test[] = {
652 { "?", "S0*" }, /* Clear break points */
653 { "kgdbts_break_test", "OK", hw_break, }, /* set hw breakpoint */
654 { "c", "T0*", }, /* Continue */
655 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
656 { "write", "OK", write_regs },
657 { "kgdbts_break_test", "OK", hw_rem_break }, /*remove breakpoint */
658 { "D", "OK" }, /* Detach */
659 { "D", "OK", NULL, got_break }, /* On success we made it here */
664 * Test for hitting a hw write breakpoint
666 static struct test_struct hw_write_break_test[] = {
667 { "?", "S0*" }, /* Clear break points */
668 { "hw_break_val", "OK", hw_write_break, }, /* set hw breakpoint */
669 { "c", "T0*", NULL, got_break }, /* Continue */
670 { "g", "silent", NULL, check_and_rewind_pc },
671 { "write", "OK", write_regs },
672 { "hw_break_val", "OK", hw_rem_write_break }, /*remove breakpoint */
673 { "D", "OK" }, /* Detach */
674 { "D", "OK", NULL, got_break }, /* On success we made it here */
679 * Test for hitting a hw access breakpoint
681 static struct test_struct hw_access_break_test[] = {
682 { "?", "S0*" }, /* Clear break points */
683 { "hw_break_val", "OK", hw_access_break, }, /* set hw breakpoint */
684 { "c", "T0*", NULL, got_break }, /* Continue */
685 { "g", "silent", NULL, check_and_rewind_pc },
686 { "write", "OK", write_regs },
687 { "hw_break_val", "OK", hw_rem_access_break }, /*remove breakpoint */
688 { "D", "OK" }, /* Detach */
689 { "D", "OK", NULL, got_break }, /* On success we made it here */
694 * Test for hitting a hw access breakpoint
696 static struct test_struct nmi_sleep_test[] = {
697 { "?", "S0*" }, /* Clear break points */
698 { "c", "T0*", NULL, got_break }, /* Continue */
699 { "D", "OK" }, /* Detach */
700 { "D", "OK", NULL, got_break }, /* On success we made it here */
704 static void fill_get_buf(char *buf)
706 unsigned char checksum = 0;
710 strcpy(get_buf, "$");
711 strcat(get_buf, buf);
712 while ((ch = buf[count])) {
716 strcat(get_buf, "#");
717 get_buf[count + 2] = hex_asc_hi(checksum);
718 get_buf[count + 3] = hex_asc_lo(checksum);
719 get_buf[count + 4] = '\0';
720 v2printk("get%i: %s\n", ts.idx, get_buf);
723 static int validate_simple_test(char *put_str)
727 if (ts.tst[ts.idx].put_handler)
728 return ts.tst[ts.idx].put_handler(put_str,
731 chk_str = ts.tst[ts.idx].put;
735 while (*chk_str != '\0' && *put_str != '\0') {
736 /* If someone does a * to match the rest of the string, allow
737 * it, or stop if the received string is complete.
739 if (*put_str == '#' || *chk_str == '*')
741 if (*put_str != *chk_str)
747 if (*chk_str == '\0' && (*put_str == '\0' || *put_str == '#'))
753 static int run_simple_test(int is_get_char, int chr)
757 /* Send an ACK on the get if a prior put completed and set the
764 /* On the first get char, fill the transmit buffer and then
765 * take from the get_string.
767 if (get_buf_cnt == 0) {
768 if (ts.tst[ts.idx].get_handler)
769 ts.tst[ts.idx].get_handler(ts.tst[ts.idx].get);
771 fill_get_buf(ts.tst[ts.idx].get);
774 if (get_buf[get_buf_cnt] == '\0') {
775 eprintk("kgdbts: ERROR GET: EOB on '%s' at %i\n",
780 ret = get_buf[get_buf_cnt];
785 /* This callback is a put char which is when kgdb sends data to
788 if (ts.tst[ts.idx].get[0] == '\0' && ts.tst[ts.idx].put[0] == '\0' &&
789 !ts.tst[ts.idx].get_handler) {
790 eprintk("kgdbts: ERROR: beyond end of test on"
791 " '%s' line %i\n", ts.name, ts.idx);
795 if (put_buf_cnt >= BUFMAX) {
796 eprintk("kgdbts: ERROR: put buffer overflow on"
797 " '%s' line %i\n", ts.name, ts.idx);
801 /* Ignore everything until the first valid packet start '$' */
802 if (put_buf_cnt == 0 && chr != '$')
805 put_buf[put_buf_cnt] = chr;
808 /* End of packet == #XX so look for the '#' */
809 if (put_buf_cnt > 3 && put_buf[put_buf_cnt - 3] == '#') {
810 if (put_buf_cnt >= BUFMAX) {
811 eprintk("kgdbts: ERROR: put buffer overflow on"
812 " '%s' line %i\n", ts.name, ts.idx);
816 put_buf[put_buf_cnt] = '\0';
817 v2printk("put%i: %s\n", ts.idx, put_buf);
818 /* Trigger check here */
819 if (ts.validate_put && ts.validate_put(put_buf)) {
820 eprintk("kgdbts: ERROR PUT: end of test "
821 "buffer on '%s' line %i expected %s got %s\n",
822 ts.name, ts.idx, ts.tst[ts.idx].put, put_buf);
832 static void init_simple_test(void)
834 memset(&ts, 0, sizeof(ts));
835 ts.run_test = run_simple_test;
836 ts.validate_put = validate_simple_test;
839 static void run_plant_and_detach_test(int is_early)
841 char before[BREAK_INSTR_SIZE];
842 char after[BREAK_INSTR_SIZE];
844 probe_kernel_read(before, (char *)kgdbts_break_test,
847 ts.tst = plant_and_detach_test;
848 ts.name = "plant_and_detach_test";
849 /* Activate test with initial breakpoint */
852 probe_kernel_read(after, (char *)kgdbts_break_test,
854 if (memcmp(before, after, BREAK_INSTR_SIZE)) {
855 printk(KERN_CRIT "kgdbts: ERROR kgdb corrupted memory\n");
856 panic("kgdb memory corruption");
859 /* complete the detach test */
864 static void run_breakpoint_test(int is_hw_breakpoint)
868 if (is_hw_breakpoint) {
869 ts.tst = hw_breakpoint_test;
870 ts.name = "hw_breakpoint_test";
872 ts.tst = sw_breakpoint_test;
873 ts.name = "sw_breakpoint_test";
875 /* Activate test with initial breakpoint */
877 /* run code with the break point in it */
884 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
885 if (is_hw_breakpoint)
889 static void run_hw_break_test(int is_write_test)
894 ts.tst = hw_write_break_test;
895 ts.name = "hw_write_break_test";
897 ts.tst = hw_access_break_test;
898 ts.name = "hw_access_break_test";
900 /* Activate test with initial breakpoint */
902 hw_break_val_access();
904 if (test_complete == 2) {
905 eprintk("kgdbts: ERROR %s broke on access\n",
909 hw_break_val_write();
913 if (test_complete == 1)
916 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
920 static void run_nmi_sleep_test(int nmi_sleep)
925 ts.tst = nmi_sleep_test;
926 ts.name = "nmi_sleep_test";
927 /* Activate test with initial breakpoint */
929 local_irq_save(flags);
930 mdelay(nmi_sleep*1000);
931 touch_nmi_watchdog();
932 local_irq_restore(flags);
933 if (test_complete != 2)
934 eprintk("kgdbts: ERROR nmi_test did not hit nmi\n");
936 if (test_complete == 1)
939 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
942 static void run_bad_read_test(void)
945 ts.tst = bad_read_test;
946 ts.name = "bad_read_test";
947 /* Activate test with initial breakpoint */
951 static void run_do_fork_test(void)
954 ts.tst = do_fork_test;
955 ts.name = "do_fork_test";
956 /* Activate test with initial breakpoint */
960 static void run_sys_open_test(void)
963 ts.tst = sys_open_test;
964 ts.name = "sys_open_test";
965 /* Activate test with initial breakpoint */
969 static void run_singlestep_break_test(void)
972 ts.tst = singlestep_break_test;
973 ts.name = "singlestep_breakpoint_test";
974 /* Activate test with initial breakpoint */
980 static void kgdbts_run_tests(void)
984 int do_sys_open_test = 0;
985 int sstep_test = 1000;
990 if (strstr(config, "V1"))
992 if (strstr(config, "V2"))
995 ptr = strchr(config, 'F');
997 fork_test = simple_strtol(ptr + 1, NULL, 10);
998 ptr = strchr(config, 'S');
1000 do_sys_open_test = simple_strtol(ptr + 1, NULL, 10);
1001 ptr = strchr(config, 'N');
1003 nmi_sleep = simple_strtol(ptr+1, NULL, 10);
1004 ptr = strchr(config, 'I');
1006 sstep_test = simple_strtol(ptr+1, NULL, 10);
1008 /* All HW break point tests */
1009 if (arch_kgdb_ops.flags & KGDB_HW_BREAKPOINT) {
1011 v1printk("kgdbts:RUN hw breakpoint test\n");
1012 run_breakpoint_test(1);
1013 v1printk("kgdbts:RUN hw write breakpoint test\n");
1014 run_hw_break_test(1);
1015 v1printk("kgdbts:RUN access write breakpoint test\n");
1016 run_hw_break_test(0);
1019 /* required internal KGDB tests */
1020 v1printk("kgdbts:RUN plant and detach test\n");
1021 run_plant_and_detach_test(0);
1022 v1printk("kgdbts:RUN sw breakpoint test\n");
1023 run_breakpoint_test(0);
1024 v1printk("kgdbts:RUN bad memory access test\n");
1025 run_bad_read_test();
1026 v1printk("kgdbts:RUN singlestep test %i iterations\n", sstep_test);
1027 for (i = 0; i < sstep_test; i++) {
1028 run_singlestep_break_test();
1030 v1printk("kgdbts:RUN singlestep [%i/%i]\n",
1034 /* ===Optional tests=== */
1037 v1printk("kgdbts:RUN NMI sleep %i seconds test\n", nmi_sleep);
1038 run_nmi_sleep_test(nmi_sleep);
1041 /* If the do_fork test is run it will be the last test that is
1042 * executed because a kernel thread will be spawned at the very
1043 * end to unregister the debug hooks.
1046 repeat_test = fork_test;
1047 printk(KERN_INFO "kgdbts:RUN do_fork for %i breakpoints\n",
1049 kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg");
1054 /* If the sys_open test is run it will be the last test that is
1055 * executed because a kernel thread will be spawned at the very
1056 * end to unregister the debug hooks.
1058 if (do_sys_open_test) {
1059 repeat_test = do_sys_open_test;
1060 printk(KERN_INFO "kgdbts:RUN sys_open for %i breakpoints\n",
1062 kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg");
1063 run_sys_open_test();
1066 /* Shutdown and unregister */
1067 kgdb_unregister_io_module(&kgdbts_io_ops);
1071 static int kgdbts_option_setup(char *opt)
1073 if (strlen(opt) >= MAX_CONFIG_LEN) {
1074 printk(KERN_ERR "kgdbts: config string too long\n");
1077 strcpy(config, opt);
1081 __setup("kgdbts=", kgdbts_option_setup);
1083 static int configure_kgdbts(void)
1087 if (!strlen(config) || isspace(config[0]))
1091 run_plant_and_detach_test(1);
1093 err = kgdb_register_io_module(&kgdbts_io_ops);
1110 static int __init init_kgdbts(void)
1112 /* Already configured? */
1113 if (configured == 1)
1116 return configure_kgdbts();
1118 device_initcall(init_kgdbts);
1120 static int kgdbts_get_char(void)
1125 val = ts.run_test(1, 0);
1130 static void kgdbts_put_char(u8 chr)
1133 ts.run_test(0, chr);
1136 static int param_set_kgdbts_var(const char *kmessage,
1137 const struct kernel_param *kp)
1139 size_t len = strlen(kmessage);
1141 if (len >= MAX_CONFIG_LEN) {
1142 printk(KERN_ERR "kgdbts: config string too long\n");
1146 /* Only copy in the string if the init function has not run yet */
1147 if (configured < 0) {
1148 strcpy(config, kmessage);
1152 if (configured == 1) {
1153 printk(KERN_ERR "kgdbts: ERROR: Already configured and running.\n");
1157 strcpy(config, kmessage);
1158 /* Chop out \n char as a result of echo */
1159 if (len && config[len - 1] == '\n')
1160 config[len - 1] = '\0';
1162 /* Go and configure with the new params. */
1163 return configure_kgdbts();
1166 static void kgdbts_pre_exp_handler(void)
1168 /* Increment the module count when the debugger is active */
1169 if (!kgdb_connected)
1170 try_module_get(THIS_MODULE);
1173 static void kgdbts_post_exp_handler(void)
1175 /* decrement the module count when the debugger detaches */
1176 if (!kgdb_connected)
1177 module_put(THIS_MODULE);
1180 static struct kgdb_io kgdbts_io_ops = {
1182 .read_char = kgdbts_get_char,
1183 .write_char = kgdbts_put_char,
1184 .pre_exception = kgdbts_pre_exp_handler,
1185 .post_exception = kgdbts_post_exp_handler,
1189 * not really modular, but the easiest way to keep compat with existing
1190 * bootargs behaviour is to continue using module_param here.
1192 module_param_call(kgdbts, param_set_kgdbts_var, param_get_string, &kps, 0644);
1193 MODULE_PARM_DESC(kgdbts, "<A|V1|V2>[F#|S#][N#]");