1 // SPDX-License-Identifier: GPL-2.0-only
3 * kgdbts is a test suite for kgdb for the sole purpose of validating
4 * that key pieces of the kgdb internals are working properly such as
5 * HW/SW breakpoints, single stepping, and NMI.
7 * Created by: Jason Wessel <jason.wessel@windriver.com>
9 * Copyright (c) 2008 Wind River Systems, Inc.
11 /* Information about the kgdb test suite.
12 * -------------------------------------
14 * The kgdb test suite is designed as a KGDB I/O module which
15 * simulates the communications that a debugger would have with kgdb.
16 * The tests are broken up in to a line by line and referenced here as
17 * a "get" which is kgdb requesting input and "put" which is kgdb
20 * The kgdb suite can be invoked from the kernel command line
21 * arguments system or executed dynamically at run time. The test
22 * suite uses the variable "kgdbts" to obtain the information about
23 * which tests to run and to configure the verbosity level. The
24 * following are the various characters you can use with the kgdbts=
27 * When using the "kgdbts=" you only choose one of the following core
29 * A = Run all the core tests silently
30 * V1 = Run all the core tests with minimal output
31 * V2 = Run all the core tests in debug mode
33 * You can also specify optional tests:
34 * N## = Go to sleep with interrupts of for ## seconds
35 * to test the HW NMI watchdog
36 * F## = Break at kernel_clone for ## iterations
37 * S## = Break at sys_open for ## iterations
38 * I## = Run the single step test ## iterations
40 * NOTE: that the kernel_clone and sys_open tests are mutually exclusive.
42 * To invoke the kgdb test suite from boot you use a kernel start
43 * argument as follows:
45 * Or if you wanted to perform the NMI test for 6 seconds and kernel_clone
46 * test for 100 forks, you could use:
47 * kgdbts=V1N6F100 kgdbwait
49 * The test suite can also be invoked at run time with:
50 * echo kgdbts=V1N6F100 > /sys/module/kgdbts/parameters/kgdbts
51 * Or as another example:
52 * echo kgdbts=V2 > /sys/module/kgdbts/parameters/kgdbts
54 * When developing a new kgdb arch specific implementation or
55 * using these tests for the purpose of regression testing,
56 * several invocations are required.
58 * 1) Boot with the test suite enabled by using the kernel arguments
59 * "kgdbts=V1F100 kgdbwait"
60 * ## If kgdb arch specific implementation has NMI use
63 * 2) After the system boot run the basic test.
64 * echo kgdbts=V1 > /sys/module/kgdbts/parameters/kgdbts
66 * 3) Run the concurrency tests. It is best to use n+1
67 * while loops where n is the number of cpus you have
68 * in your system. The example below uses only two
71 * ## This tests break points on sys_open
72 * while [ 1 ] ; do find / > /dev/null 2>&1 ; done &
73 * while [ 1 ] ; do find / > /dev/null 2>&1 ; done &
74 * echo kgdbts=V1S10000 > /sys/module/kgdbts/parameters/kgdbts
75 * fg # and hit control-c
76 * fg # and hit control-c
77 * ## This tests break points on kernel_clone
78 * while [ 1 ] ; do date > /dev/null ; done &
79 * while [ 1 ] ; do date > /dev/null ; done &
80 * echo kgdbts=V1F1000 > /sys/module/kgdbts/parameters/kgdbts
81 * fg # and hit control-c
85 #include <linux/kernel.h>
86 #include <linux/kgdb.h>
87 #include <linux/ctype.h>
88 #include <linux/uaccess.h>
89 #include <linux/syscalls.h>
90 #include <linux/nmi.h>
91 #include <linux/delay.h>
92 #include <linux/kthread.h>
93 #include <linux/module.h>
94 #include <linux/sched/task.h>
96 #include <asm/sections.h>
98 #define v1printk(a...) do { \
100 printk(KERN_INFO a); \
102 #define v2printk(a...) do { \
104 printk(KERN_INFO a); \
105 touch_nmi_watchdog(); \
107 #define eprintk(a...) do { \
108 printk(KERN_ERR a); \
111 #define MAX_CONFIG_LEN 40
113 static struct kgdb_io kgdbts_io_ops;
114 static char get_buf[BUFMAX];
115 static int get_buf_cnt;
116 static char put_buf[BUFMAX];
117 static int put_buf_cnt;
118 static char scratch_buf[BUFMAX];
120 static int repeat_test;
121 static int test_complete;
123 static int final_ack;
124 static int force_hwbrks;
125 static int hwbreaks_ok;
126 static int hw_break_val;
127 static int hw_break_val2;
128 static int cont_instead_of_sstep;
129 static unsigned long cont_thread_id;
130 static unsigned long sstep_thread_id;
131 #if defined(CONFIG_ARM) || defined(CONFIG_MIPS) || defined(CONFIG_SPARC)
132 static int arch_needs_sstep_emulation = 1;
134 static int arch_needs_sstep_emulation;
136 static unsigned long cont_addr;
137 static unsigned long sstep_addr;
138 static int restart_from_top_after_write;
139 static int sstep_state;
141 /* Storage for the registers, in GDB format. */
142 static unsigned long kgdbts_gdb_regs[(NUMREGBYTES +
143 sizeof(unsigned long) - 1) /
144 sizeof(unsigned long)];
145 static struct pt_regs kgdbts_regs;
147 /* -1 = init not run yet, 0 = unconfigured, 1 = configured. */
148 static int configured = -1;
150 #ifdef CONFIG_KGDB_TESTS_BOOT_STRING
151 static char config[MAX_CONFIG_LEN] = CONFIG_KGDB_TESTS_BOOT_STRING;
153 static char config[MAX_CONFIG_LEN];
155 static struct kparam_string kps = {
157 .maxlen = MAX_CONFIG_LEN,
160 static void fill_get_buf(char *buf);
165 void (*get_handler)(char *);
166 int (*put_handler)(char *, char *);
171 struct test_struct *tst;
173 int (*run_test) (int, int);
174 int (*validate_put) (char *);
177 static struct test_state ts;
179 static int kgdbts_unreg_thread(void *ptr)
181 /* Wait until the tests are complete and then ungresiter the I/O
185 msleep_interruptible(1500);
186 /* Pause for any other threads to exit after final ack. */
187 msleep_interruptible(1000);
189 kgdb_unregister_io_module(&kgdbts_io_ops);
195 /* This is noinline such that it can be used for a single location to
198 static noinline void kgdbts_break_test(void)
200 v2printk("kgdbts: breakpoint complete\n");
203 /* Lookup symbol info in the kernel */
204 static unsigned long lookup_addr(char *arg)
206 unsigned long addr = 0;
208 if (!strcmp(arg, "kgdbts_break_test"))
209 addr = (unsigned long)kgdbts_break_test;
210 else if (!strcmp(arg, "sys_open"))
211 addr = (unsigned long)do_sys_open;
212 else if (!strcmp(arg, "kernel_clone"))
213 addr = (unsigned long)kernel_clone;
214 else if (!strcmp(arg, "hw_break_val"))
215 addr = (unsigned long)&hw_break_val;
216 addr = (unsigned long) dereference_function_descriptor((void *)addr);
220 static void break_helper(char *bp_type, char *arg, unsigned long vaddr)
225 addr = lookup_addr(arg);
229 sprintf(scratch_buf, "%s,%lx,%i", bp_type, addr,
231 fill_get_buf(scratch_buf);
234 static void sw_break(char *arg)
236 break_helper(force_hwbrks ? "Z1" : "Z0", arg, 0);
239 static void sw_rem_break(char *arg)
241 break_helper(force_hwbrks ? "z1" : "z0", arg, 0);
244 static void hw_break(char *arg)
246 break_helper("Z1", arg, 0);
249 static void hw_rem_break(char *arg)
251 break_helper("z1", arg, 0);
254 static void hw_write_break(char *arg)
256 break_helper("Z2", arg, 0);
259 static void hw_rem_write_break(char *arg)
261 break_helper("z2", arg, 0);
264 static void hw_access_break(char *arg)
266 break_helper("Z4", arg, 0);
269 static void hw_rem_access_break(char *arg)
271 break_helper("z4", arg, 0);
274 static void hw_break_val_access(void)
276 hw_break_val2 = hw_break_val;
279 static void hw_break_val_write(void)
284 static int get_thread_id_continue(char *put_str, char *arg)
286 char *ptr = &put_str[11];
288 if (put_str[1] != 'T' || put_str[2] != '0')
290 kgdb_hex2long(&ptr, &cont_thread_id);
294 static int check_and_rewind_pc(char *put_str, char *arg)
296 unsigned long addr = lookup_addr(arg);
300 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
302 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
303 ip = instruction_pointer(&kgdbts_regs);
304 v2printk("Stopped at IP: %lx\n", ip);
305 #ifdef GDB_ADJUSTS_BREAK_OFFSET
306 /* On some arches, a breakpoint stop requires it to be decremented */
307 if (addr + BREAK_INSTR_SIZE == ip)
308 offset = -BREAK_INSTR_SIZE;
311 if (arch_needs_sstep_emulation && sstep_addr &&
312 ip + offset == sstep_addr &&
313 ((!strcmp(arg, "sys_open") || !strcmp(arg, "kernel_clone")))) {
314 /* This is special case for emulated single step */
315 v2printk("Emul: rewind hit single step bp\n");
316 restart_from_top_after_write = 1;
317 } else if (strcmp(arg, "silent") && ip + offset != addr) {
318 eprintk("kgdbts: BP mismatch %lx expected %lx\n",
322 /* Readjust the instruction pointer if needed */
325 #ifdef GDB_ADJUSTS_BREAK_OFFSET
326 instruction_pointer_set(&kgdbts_regs, ip);
331 static int check_single_step(char *put_str, char *arg)
333 unsigned long addr = lookup_addr(arg);
334 static int matched_id;
337 * From an arch indepent point of view the instruction pointer
338 * should be on a different instruction
340 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
342 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
343 v2printk("Singlestep stopped at IP: %lx\n",
344 instruction_pointer(&kgdbts_regs));
346 if (sstep_thread_id != cont_thread_id) {
348 * Ensure we stopped in the same thread id as before, else the
349 * debugger should continue until the original thread that was
350 * single stepped is scheduled again, emulating gdb's behavior.
352 v2printk("ThrID does not match: %lx\n", cont_thread_id);
353 if (arch_needs_sstep_emulation) {
355 instruction_pointer(&kgdbts_regs) != addr)
362 cont_instead_of_sstep = 1;
368 if (instruction_pointer(&kgdbts_regs) == addr) {
369 eprintk("kgdbts: SingleStep failed at %lx\n",
370 instruction_pointer(&kgdbts_regs));
377 static void write_regs(char *arg)
379 memset(scratch_buf, 0, sizeof(scratch_buf));
380 scratch_buf[0] = 'G';
381 pt_regs_to_gdb_regs(kgdbts_gdb_regs, &kgdbts_regs);
382 kgdb_mem2hex((char *)kgdbts_gdb_regs, &scratch_buf[1], NUMREGBYTES);
383 fill_get_buf(scratch_buf);
386 static void skip_back_repeat_test(char *arg)
388 int go_back = simple_strtol(arg, NULL, 10);
391 if (repeat_test <= 0) {
394 if (repeat_test % 100 == 0)
395 v1printk("kgdbts:RUN ... %d remaining\n", repeat_test);
399 fill_get_buf(ts.tst[ts.idx].get);
402 static int got_break(char *put_str, char *arg)
405 if (!strncmp(put_str+1, arg, 2)) {
406 if (!strncmp(arg, "T0", 2))
413 static void get_cont_catch(char *arg)
415 /* Always send detach because the test is completed at this point */
419 static int put_cont_catch(char *put_str, char *arg)
421 /* This is at the end of the test and we catch any and all input */
422 v2printk("kgdbts: cleanup task: %lx\n", sstep_thread_id);
427 static int emul_reset(char *put_str, char *arg)
429 if (strncmp(put_str, "$OK", 3))
431 if (restart_from_top_after_write) {
432 restart_from_top_after_write = 0;
438 static void emul_sstep_get(char *arg)
440 if (!arch_needs_sstep_emulation) {
441 if (cont_instead_of_sstep) {
442 cont_instead_of_sstep = 0;
449 switch (sstep_state) {
451 v2printk("Emulate single step\n");
452 /* Start by looking at the current PC */
457 break_helper("Z0", NULL, sstep_addr);
464 /* Clear breakpoint */
465 break_helper("z0", NULL, sstep_addr);
468 eprintk("kgdbts: ERROR failed sstep get emulation\n");
473 static int emul_sstep_put(char *put_str, char *arg)
475 if (!arch_needs_sstep_emulation) {
476 char *ptr = &put_str[11];
477 if (put_str[1] != 'T' || put_str[2] != '0')
479 kgdb_hex2long(&ptr, &sstep_thread_id);
482 switch (sstep_state) {
484 /* validate the "g" packet to get the IP */
485 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
487 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
488 v2printk("Stopped at IP: %lx\n",
489 instruction_pointer(&kgdbts_regs));
490 /* Want to stop at IP + break instruction size by default */
491 sstep_addr = cont_addr + BREAK_INSTR_SIZE;
494 if (strncmp(put_str, "$OK", 3)) {
495 eprintk("kgdbts: failed sstep break set\n");
500 if (strncmp(put_str, "$T0", 3)) {
501 eprintk("kgdbts: failed continue sstep\n");
504 char *ptr = &put_str[11];
505 kgdb_hex2long(&ptr, &sstep_thread_id);
509 if (strncmp(put_str, "$OK", 3)) {
510 eprintk("kgdbts: failed sstep break unset\n");
513 /* Single step is complete so continue on! */
517 eprintk("kgdbts: ERROR failed sstep put emulation\n");
520 /* Continue on the same test line until emulation is complete */
525 static int final_ack_set(char *put_str, char *arg)
527 if (strncmp(put_str+1, arg, 2))
533 * Test to plant a breakpoint and detach, which should clear out the
534 * breakpoint and restore the original instruction.
536 static struct test_struct plant_and_detach_test[] = {
537 { "?", "S0*" }, /* Clear break points */
538 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
539 { "D", "OK" }, /* Detach */
544 * Simple test to write in a software breakpoint, check for the
545 * correct stop location and detach.
547 static struct test_struct sw_breakpoint_test[] = {
548 { "?", "S0*" }, /* Clear break points */
549 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
550 { "c", "T0*", }, /* Continue */
551 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
552 { "write", "OK", write_regs },
553 { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */
554 { "D", "OK" }, /* Detach */
555 { "D", "OK", NULL, got_break }, /* On success we made it here */
560 * Test a known bad memory read location to test the fault handler and
561 * read bytes 1-8 at the bad address
563 static struct test_struct bad_read_test[] = {
564 { "?", "S0*" }, /* Clear break points */
565 { "m0,1", "E*" }, /* read 1 byte at address 1 */
566 { "m0,2", "E*" }, /* read 1 byte at address 2 */
567 { "m0,3", "E*" }, /* read 1 byte at address 3 */
568 { "m0,4", "E*" }, /* read 1 byte at address 4 */
569 { "m0,5", "E*" }, /* read 1 byte at address 5 */
570 { "m0,6", "E*" }, /* read 1 byte at address 6 */
571 { "m0,7", "E*" }, /* read 1 byte at address 7 */
572 { "m0,8", "E*" }, /* read 1 byte at address 8 */
573 { "D", "OK" }, /* Detach which removes all breakpoints and continues */
578 * Test for hitting a breakpoint, remove it, single step, plant it
581 static struct test_struct singlestep_break_test[] = {
582 { "?", "S0*" }, /* Clear break points */
583 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
584 { "c", "T0*", NULL, get_thread_id_continue }, /* Continue */
585 { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */
586 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
587 { "write", "OK", write_regs }, /* Write registers */
588 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
589 { "g", "kgdbts_break_test", NULL, check_single_step },
590 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
591 { "c", "T0*", }, /* Continue */
592 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
593 { "write", "OK", write_regs }, /* Write registers */
594 { "D", "OK" }, /* Remove all breakpoints and continues */
599 * Test for hitting a breakpoint at kernel_clone for what ever the number
600 * of iterations required by the variable repeat_test.
602 static struct test_struct do_kernel_clone_test[] = {
603 { "?", "S0*" }, /* Clear break points */
604 { "kernel_clone", "OK", sw_break, }, /* set sw breakpoint */
605 { "c", "T0*", NULL, get_thread_id_continue }, /* Continue */
606 { "kernel_clone", "OK", sw_rem_break }, /*remove breakpoint */
607 { "g", "kernel_clone", NULL, check_and_rewind_pc }, /* check location */
608 { "write", "OK", write_regs, emul_reset }, /* Write registers */
609 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
610 { "g", "kernel_clone", NULL, check_single_step },
611 { "kernel_clone", "OK", sw_break, }, /* set sw breakpoint */
612 { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */
613 { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */
614 { "", "", get_cont_catch, put_cont_catch },
617 /* Test for hitting a breakpoint at sys_open for what ever the number
618 * of iterations required by the variable repeat_test.
620 static struct test_struct sys_open_test[] = {
621 { "?", "S0*" }, /* Clear break points */
622 { "sys_open", "OK", sw_break, }, /* set sw breakpoint */
623 { "c", "T0*", NULL, get_thread_id_continue }, /* Continue */
624 { "sys_open", "OK", sw_rem_break }, /*remove breakpoint */
625 { "g", "sys_open", NULL, check_and_rewind_pc }, /* check location */
626 { "write", "OK", write_regs, emul_reset }, /* Write registers */
627 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
628 { "g", "sys_open", NULL, check_single_step },
629 { "sys_open", "OK", sw_break, }, /* set sw breakpoint */
630 { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */
631 { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */
632 { "", "", get_cont_catch, put_cont_catch },
636 * Test for hitting a simple hw breakpoint
638 static struct test_struct hw_breakpoint_test[] = {
639 { "?", "S0*" }, /* Clear break points */
640 { "kgdbts_break_test", "OK", hw_break, }, /* set hw breakpoint */
641 { "c", "T0*", }, /* Continue */
642 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
643 { "write", "OK", write_regs },
644 { "kgdbts_break_test", "OK", hw_rem_break }, /*remove breakpoint */
645 { "D", "OK" }, /* Detach */
646 { "D", "OK", NULL, got_break }, /* On success we made it here */
651 * Test for hitting a hw write breakpoint
653 static struct test_struct hw_write_break_test[] = {
654 { "?", "S0*" }, /* Clear break points */
655 { "hw_break_val", "OK", hw_write_break, }, /* set hw breakpoint */
656 { "c", "T0*", NULL, got_break }, /* Continue */
657 { "g", "silent", NULL, check_and_rewind_pc },
658 { "write", "OK", write_regs },
659 { "hw_break_val", "OK", hw_rem_write_break }, /*remove breakpoint */
660 { "D", "OK" }, /* Detach */
661 { "D", "OK", NULL, got_break }, /* On success we made it here */
666 * Test for hitting a hw access breakpoint
668 static struct test_struct hw_access_break_test[] = {
669 { "?", "S0*" }, /* Clear break points */
670 { "hw_break_val", "OK", hw_access_break, }, /* set hw breakpoint */
671 { "c", "T0*", NULL, got_break }, /* Continue */
672 { "g", "silent", NULL, check_and_rewind_pc },
673 { "write", "OK", write_regs },
674 { "hw_break_val", "OK", hw_rem_access_break }, /*remove breakpoint */
675 { "D", "OK" }, /* Detach */
676 { "D", "OK", NULL, got_break }, /* On success we made it here */
681 * Test for hitting a hw access breakpoint
683 static struct test_struct nmi_sleep_test[] = {
684 { "?", "S0*" }, /* Clear break points */
685 { "c", "T0*", NULL, got_break }, /* Continue */
686 { "D", "OK" }, /* Detach */
687 { "D", "OK", NULL, got_break }, /* On success we made it here */
691 static void fill_get_buf(char *buf)
693 unsigned char checksum = 0;
697 strcpy(get_buf, "$");
698 strcat(get_buf, buf);
699 while ((ch = buf[count])) {
703 strcat(get_buf, "#");
704 get_buf[count + 2] = hex_asc_hi(checksum);
705 get_buf[count + 3] = hex_asc_lo(checksum);
706 get_buf[count + 4] = '\0';
707 v2printk("get%i: %s\n", ts.idx, get_buf);
710 static int validate_simple_test(char *put_str)
714 if (ts.tst[ts.idx].put_handler)
715 return ts.tst[ts.idx].put_handler(put_str,
718 chk_str = ts.tst[ts.idx].put;
722 while (*chk_str != '\0' && *put_str != '\0') {
723 /* If someone does a * to match the rest of the string, allow
724 * it, or stop if the received string is complete.
726 if (*put_str == '#' || *chk_str == '*')
728 if (*put_str != *chk_str)
734 if (*chk_str == '\0' && (*put_str == '\0' || *put_str == '#'))
740 static int run_simple_test(int is_get_char, int chr)
744 /* Send an ACK on the get if a prior put completed and set the
751 /* On the first get char, fill the transmit buffer and then
752 * take from the get_string.
754 if (get_buf_cnt == 0) {
755 if (ts.tst[ts.idx].get_handler)
756 ts.tst[ts.idx].get_handler(ts.tst[ts.idx].get);
758 fill_get_buf(ts.tst[ts.idx].get);
761 if (get_buf[get_buf_cnt] == '\0') {
762 eprintk("kgdbts: ERROR GET: EOB on '%s' at %i\n",
767 ret = get_buf[get_buf_cnt];
772 /* This callback is a put char which is when kgdb sends data to
775 if (ts.tst[ts.idx].get[0] == '\0' && ts.tst[ts.idx].put[0] == '\0' &&
776 !ts.tst[ts.idx].get_handler) {
777 eprintk("kgdbts: ERROR: beyond end of test on"
778 " '%s' line %i\n", ts.name, ts.idx);
782 if (put_buf_cnt >= BUFMAX) {
783 eprintk("kgdbts: ERROR: put buffer overflow on"
784 " '%s' line %i\n", ts.name, ts.idx);
788 /* Ignore everything until the first valid packet start '$' */
789 if (put_buf_cnt == 0 && chr != '$')
792 put_buf[put_buf_cnt] = chr;
795 /* End of packet == #XX so look for the '#' */
796 if (put_buf_cnt > 3 && put_buf[put_buf_cnt - 3] == '#') {
797 if (put_buf_cnt >= BUFMAX) {
798 eprintk("kgdbts: ERROR: put buffer overflow on"
799 " '%s' line %i\n", ts.name, ts.idx);
803 put_buf[put_buf_cnt] = '\0';
804 v2printk("put%i: %s\n", ts.idx, put_buf);
805 /* Trigger check here */
806 if (ts.validate_put && ts.validate_put(put_buf)) {
807 eprintk("kgdbts: ERROR PUT: end of test "
808 "buffer on '%s' line %i expected %s got %s\n",
809 ts.name, ts.idx, ts.tst[ts.idx].put, put_buf);
819 static void init_simple_test(void)
821 memset(&ts, 0, sizeof(ts));
822 ts.run_test = run_simple_test;
823 ts.validate_put = validate_simple_test;
826 static void run_plant_and_detach_test(int is_early)
828 char before[BREAK_INSTR_SIZE];
829 char after[BREAK_INSTR_SIZE];
831 copy_from_kernel_nofault(before, (char *)kgdbts_break_test,
834 ts.tst = plant_and_detach_test;
835 ts.name = "plant_and_detach_test";
836 /* Activate test with initial breakpoint */
839 copy_from_kernel_nofault(after, (char *)kgdbts_break_test,
841 if (memcmp(before, after, BREAK_INSTR_SIZE)) {
842 printk(KERN_CRIT "kgdbts: ERROR kgdb corrupted memory\n");
843 panic("kgdb memory corruption");
846 /* complete the detach test */
851 static void run_breakpoint_test(int is_hw_breakpoint)
855 if (is_hw_breakpoint) {
856 ts.tst = hw_breakpoint_test;
857 ts.name = "hw_breakpoint_test";
859 ts.tst = sw_breakpoint_test;
860 ts.name = "sw_breakpoint_test";
862 /* Activate test with initial breakpoint */
864 /* run code with the break point in it */
871 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
872 if (is_hw_breakpoint)
876 static void run_hw_break_test(int is_write_test)
881 ts.tst = hw_write_break_test;
882 ts.name = "hw_write_break_test";
884 ts.tst = hw_access_break_test;
885 ts.name = "hw_access_break_test";
887 /* Activate test with initial breakpoint */
889 hw_break_val_access();
891 if (test_complete == 2) {
892 eprintk("kgdbts: ERROR %s broke on access\n",
896 hw_break_val_write();
900 if (test_complete == 1)
903 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
907 static void run_nmi_sleep_test(int nmi_sleep)
912 ts.tst = nmi_sleep_test;
913 ts.name = "nmi_sleep_test";
914 /* Activate test with initial breakpoint */
916 local_irq_save(flags);
917 mdelay(nmi_sleep*1000);
918 touch_nmi_watchdog();
919 local_irq_restore(flags);
920 if (test_complete != 2)
921 eprintk("kgdbts: ERROR nmi_test did not hit nmi\n");
923 if (test_complete == 1)
926 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
929 static void run_bad_read_test(void)
932 ts.tst = bad_read_test;
933 ts.name = "bad_read_test";
934 /* Activate test with initial breakpoint */
938 static void run_kernel_clone_test(void)
941 ts.tst = do_kernel_clone_test;
942 ts.name = "do_kernel_clone_test";
943 /* Activate test with initial breakpoint */
947 static void run_sys_open_test(void)
950 ts.tst = sys_open_test;
951 ts.name = "sys_open_test";
952 /* Activate test with initial breakpoint */
956 static void run_singlestep_break_test(void)
959 ts.tst = singlestep_break_test;
960 ts.name = "singlestep_breakpoint_test";
961 /* Activate test with initial breakpoint */
967 static void kgdbts_run_tests(void)
971 int do_sys_open_test = 0;
972 int sstep_test = 1000;
977 if (strstr(config, "V1"))
979 if (strstr(config, "V2"))
982 ptr = strchr(config, 'F');
984 clone_test = simple_strtol(ptr + 1, NULL, 10);
985 ptr = strchr(config, 'S');
987 do_sys_open_test = simple_strtol(ptr + 1, NULL, 10);
988 ptr = strchr(config, 'N');
990 nmi_sleep = simple_strtol(ptr+1, NULL, 10);
991 ptr = strchr(config, 'I');
993 sstep_test = simple_strtol(ptr+1, NULL, 10);
995 /* All HW break point tests */
996 if (arch_kgdb_ops.flags & KGDB_HW_BREAKPOINT) {
998 v1printk("kgdbts:RUN hw breakpoint test\n");
999 run_breakpoint_test(1);
1000 v1printk("kgdbts:RUN hw write breakpoint test\n");
1001 run_hw_break_test(1);
1002 v1printk("kgdbts:RUN access write breakpoint test\n");
1003 run_hw_break_test(0);
1006 /* required internal KGDB tests */
1007 v1printk("kgdbts:RUN plant and detach test\n");
1008 run_plant_and_detach_test(0);
1009 v1printk("kgdbts:RUN sw breakpoint test\n");
1010 run_breakpoint_test(0);
1011 v1printk("kgdbts:RUN bad memory access test\n");
1012 run_bad_read_test();
1013 v1printk("kgdbts:RUN singlestep test %i iterations\n", sstep_test);
1014 for (i = 0; i < sstep_test; i++) {
1015 run_singlestep_break_test();
1017 v1printk("kgdbts:RUN singlestep [%i/%i]\n",
1021 /* ===Optional tests=== */
1024 v1printk("kgdbts:RUN NMI sleep %i seconds test\n", nmi_sleep);
1025 run_nmi_sleep_test(nmi_sleep);
1028 /* If the kernel_clone test is run it will be the last test that is
1029 * executed because a kernel thread will be spawned at the very
1030 * end to unregister the debug hooks.
1033 repeat_test = clone_test;
1034 printk(KERN_INFO "kgdbts:RUN kernel_clone for %i breakpoints\n",
1036 kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg");
1037 run_kernel_clone_test();
1041 /* If the sys_open 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.
1045 if (do_sys_open_test) {
1046 repeat_test = do_sys_open_test;
1047 printk(KERN_INFO "kgdbts:RUN sys_open for %i breakpoints\n",
1049 kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg");
1050 run_sys_open_test();
1053 /* Shutdown and unregister */
1054 kgdb_unregister_io_module(&kgdbts_io_ops);
1058 static int kgdbts_option_setup(char *opt)
1060 if (strlen(opt) >= MAX_CONFIG_LEN) {
1061 printk(KERN_ERR "kgdbts: config string too long\n");
1064 strcpy(config, opt);
1068 __setup("kgdbts=", kgdbts_option_setup);
1070 static int configure_kgdbts(void)
1074 if (!strlen(config) || isspace(config[0]))
1078 run_plant_and_detach_test(1);
1080 err = kgdb_register_io_module(&kgdbts_io_ops);
1097 static int __init init_kgdbts(void)
1099 /* Already configured? */
1100 if (configured == 1)
1103 return configure_kgdbts();
1105 device_initcall(init_kgdbts);
1107 static int kgdbts_get_char(void)
1112 val = ts.run_test(1, 0);
1117 static void kgdbts_put_char(u8 chr)
1120 ts.run_test(0, chr);
1123 static int param_set_kgdbts_var(const char *kmessage,
1124 const struct kernel_param *kp)
1126 size_t len = strlen(kmessage);
1128 if (len >= MAX_CONFIG_LEN) {
1129 printk(KERN_ERR "kgdbts: config string too long\n");
1133 /* Only copy in the string if the init function has not run yet */
1134 if (configured < 0) {
1135 strcpy(config, kmessage);
1139 if (configured == 1) {
1140 printk(KERN_ERR "kgdbts: ERROR: Already configured and running.\n");
1144 strcpy(config, kmessage);
1145 /* Chop out \n char as a result of echo */
1146 if (len && config[len - 1] == '\n')
1147 config[len - 1] = '\0';
1149 /* Go and configure with the new params. */
1150 return configure_kgdbts();
1153 static void kgdbts_pre_exp_handler(void)
1155 /* Increment the module count when the debugger is active */
1156 if (!kgdb_connected)
1157 try_module_get(THIS_MODULE);
1160 static void kgdbts_post_exp_handler(void)
1162 /* decrement the module count when the debugger detaches */
1163 if (!kgdb_connected)
1164 module_put(THIS_MODULE);
1167 static struct kgdb_io kgdbts_io_ops = {
1169 .read_char = kgdbts_get_char,
1170 .write_char = kgdbts_put_char,
1171 .pre_exception = kgdbts_pre_exp_handler,
1172 .post_exception = kgdbts_post_exp_handler,
1176 * not really modular, but the easiest way to keep compat with existing
1177 * bootargs behaviour is to continue using module_param here.
1179 module_param_call(kgdbts, param_set_kgdbts_var, param_get_string, &kps, 0644);
1180 MODULE_PARM_DESC(kgdbts, "<A|V1|V2>[F#|S#][N#]");