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>
95 #include <linux/kallsyms.h>
97 #include <asm/sections.h>
99 #define v1printk(a...) do { \
101 printk(KERN_INFO a); \
103 #define v2printk(a...) do { \
105 printk(KERN_INFO a); \
106 touch_nmi_watchdog(); \
108 #define eprintk(a...) do { \
109 printk(KERN_ERR a); \
112 #define MAX_CONFIG_LEN 40
114 static struct kgdb_io kgdbts_io_ops
;
115 static char get_buf
[BUFMAX
];
116 static int get_buf_cnt
;
117 static char put_buf
[BUFMAX
];
118 static int put_buf_cnt
;
119 static char scratch_buf
[BUFMAX
];
121 static int repeat_test
;
122 static int test_complete
;
124 static int final_ack
;
125 static int force_hwbrks
;
126 static int hwbreaks_ok
;
127 static int hw_break_val
;
128 static int hw_break_val2
;
129 static int cont_instead_of_sstep
;
130 static unsigned long cont_thread_id
;
131 static unsigned long sstep_thread_id
;
132 #if defined(CONFIG_ARM) || defined(CONFIG_MIPS) || defined(CONFIG_SPARC)
133 static int arch_needs_sstep_emulation
= 1;
135 static int arch_needs_sstep_emulation
;
137 static unsigned long cont_addr
;
138 static unsigned long sstep_addr
;
139 static int restart_from_top_after_write
;
140 static int sstep_state
;
142 /* Storage for the registers, in GDB format. */
143 static unsigned long kgdbts_gdb_regs
[(NUMREGBYTES
+
144 sizeof(unsigned long) - 1) /
145 sizeof(unsigned long)];
146 static struct pt_regs kgdbts_regs
;
148 /* -1 = init not run yet, 0 = unconfigured, 1 = configured. */
149 static int configured
= -1;
151 #ifdef CONFIG_KGDB_TESTS_BOOT_STRING
152 static char config
[MAX_CONFIG_LEN
] = CONFIG_KGDB_TESTS_BOOT_STRING
;
154 static char config
[MAX_CONFIG_LEN
];
156 static struct kparam_string kps
= {
158 .maxlen
= MAX_CONFIG_LEN
,
161 static void fill_get_buf(char *buf
);
166 void (*get_handler
)(char *);
167 int (*put_handler
)(char *, char *);
172 struct test_struct
*tst
;
174 int (*run_test
) (int, int);
175 int (*validate_put
) (char *);
178 static struct test_state ts
;
180 static int kgdbts_unreg_thread(void *ptr
)
182 /* Wait until the tests are complete and then ungresiter the I/O
186 msleep_interruptible(1500);
187 /* Pause for any other threads to exit after final ack. */
188 msleep_interruptible(1000);
190 kgdb_unregister_io_module(&kgdbts_io_ops
);
196 /* This is noinline such that it can be used for a single location to
199 static noinline
void kgdbts_break_test(void)
201 v2printk("kgdbts: breakpoint complete\n");
205 * This is a cached wrapper for kallsyms_lookup_name().
207 * The cache is a big win for several tests. For example it more the doubles
208 * the cycles per second during the sys_open test. This is not theoretic,
209 * the performance improvement shows up at human scale, especially when
210 * testing using emulators.
212 * Obviously neither re-entrant nor thread-safe but that is OK since it
213 * can only be called from the debug trap (and therefore all other CPUs
216 static unsigned long lookup_addr(char *arg
)
218 static char cached_arg
[KSYM_NAME_LEN
];
219 static unsigned long cached_addr
;
221 if (strcmp(arg
, cached_arg
)) {
222 strscpy(cached_arg
, arg
, KSYM_NAME_LEN
);
223 cached_addr
= kallsyms_lookup_name(arg
);
226 return (unsigned long)dereference_function_descriptor(
227 (void *)cached_addr
);
230 static void break_helper(char *bp_type
, char *arg
, unsigned long vaddr
)
235 addr
= lookup_addr(arg
);
239 sprintf(scratch_buf
, "%s,%lx,%i", bp_type
, addr
,
241 fill_get_buf(scratch_buf
);
244 static void sw_break(char *arg
)
246 break_helper(force_hwbrks
? "Z1" : "Z0", arg
, 0);
249 static void sw_rem_break(char *arg
)
251 break_helper(force_hwbrks
? "z1" : "z0", arg
, 0);
254 static void hw_break(char *arg
)
256 break_helper("Z1", arg
, 0);
259 static void hw_rem_break(char *arg
)
261 break_helper("z1", arg
, 0);
264 static void hw_write_break(char *arg
)
266 break_helper("Z2", arg
, 0);
269 static void hw_rem_write_break(char *arg
)
271 break_helper("z2", arg
, 0);
274 static void hw_access_break(char *arg
)
276 break_helper("Z4", arg
, 0);
279 static void hw_rem_access_break(char *arg
)
281 break_helper("z4", arg
, 0);
284 static void hw_break_val_access(void)
286 hw_break_val2
= hw_break_val
;
289 static void hw_break_val_write(void)
294 static int get_thread_id_continue(char *put_str
, char *arg
)
296 char *ptr
= &put_str
[11];
298 if (put_str
[1] != 'T' || put_str
[2] != '0')
300 kgdb_hex2long(&ptr
, &cont_thread_id
);
304 static int check_and_rewind_pc(char *put_str
, char *arg
)
306 unsigned long addr
= lookup_addr(arg
);
310 kgdb_hex2mem(&put_str
[1], (char *)kgdbts_gdb_regs
,
312 gdb_regs_to_pt_regs(kgdbts_gdb_regs
, &kgdbts_regs
);
313 ip
= instruction_pointer(&kgdbts_regs
);
314 v2printk("Stopped at IP: %lx\n", ip
);
315 #ifdef GDB_ADJUSTS_BREAK_OFFSET
316 /* On some arches, a breakpoint stop requires it to be decremented */
317 if (addr
+ BREAK_INSTR_SIZE
== ip
)
318 offset
= -BREAK_INSTR_SIZE
;
321 if (arch_needs_sstep_emulation
&& sstep_addr
&&
322 ip
+ offset
== sstep_addr
&&
323 ((!strcmp(arg
, "do_sys_openat2") || !strcmp(arg
, "kernel_clone")))) {
324 /* This is special case for emulated single step */
325 v2printk("Emul: rewind hit single step bp\n");
326 restart_from_top_after_write
= 1;
327 } else if (strcmp(arg
, "silent") && ip
+ offset
!= addr
) {
328 eprintk("kgdbts: BP mismatch %lx expected %lx\n",
332 /* Readjust the instruction pointer if needed */
335 #ifdef GDB_ADJUSTS_BREAK_OFFSET
336 instruction_pointer_set(&kgdbts_regs
, ip
);
341 static int check_single_step(char *put_str
, char *arg
)
343 unsigned long addr
= lookup_addr(arg
);
344 static int matched_id
;
347 * From an arch indepent point of view the instruction pointer
348 * should be on a different instruction
350 kgdb_hex2mem(&put_str
[1], (char *)kgdbts_gdb_regs
,
352 gdb_regs_to_pt_regs(kgdbts_gdb_regs
, &kgdbts_regs
);
353 v2printk("Singlestep stopped at IP: %lx\n",
354 instruction_pointer(&kgdbts_regs
));
356 if (sstep_thread_id
!= cont_thread_id
) {
358 * Ensure we stopped in the same thread id as before, else the
359 * debugger should continue until the original thread that was
360 * single stepped is scheduled again, emulating gdb's behavior.
362 v2printk("ThrID does not match: %lx\n", cont_thread_id
);
363 if (arch_needs_sstep_emulation
) {
365 instruction_pointer(&kgdbts_regs
) != addr
)
372 cont_instead_of_sstep
= 1;
378 if (instruction_pointer(&kgdbts_regs
) == addr
) {
379 eprintk("kgdbts: SingleStep failed at %lx\n",
380 instruction_pointer(&kgdbts_regs
));
387 static void write_regs(char *arg
)
389 memset(scratch_buf
, 0, sizeof(scratch_buf
));
390 scratch_buf
[0] = 'G';
391 pt_regs_to_gdb_regs(kgdbts_gdb_regs
, &kgdbts_regs
);
392 kgdb_mem2hex((char *)kgdbts_gdb_regs
, &scratch_buf
[1], NUMREGBYTES
);
393 fill_get_buf(scratch_buf
);
396 static void skip_back_repeat_test(char *arg
)
398 int go_back
= simple_strtol(arg
, NULL
, 10);
401 if (repeat_test
<= 0) {
404 if (repeat_test
% 100 == 0)
405 v1printk("kgdbts:RUN ... %d remaining\n", repeat_test
);
409 fill_get_buf(ts
.tst
[ts
.idx
].get
);
412 static int got_break(char *put_str
, char *arg
)
415 if (!strncmp(put_str
+1, arg
, 2)) {
416 if (!strncmp(arg
, "T0", 2))
423 static void get_cont_catch(char *arg
)
425 /* Always send detach because the test is completed at this point */
429 static int put_cont_catch(char *put_str
, char *arg
)
431 /* This is at the end of the test and we catch any and all input */
432 v2printk("kgdbts: cleanup task: %lx\n", sstep_thread_id
);
437 static int emul_reset(char *put_str
, char *arg
)
439 if (strncmp(put_str
, "$OK", 3))
441 if (restart_from_top_after_write
) {
442 restart_from_top_after_write
= 0;
448 static void emul_sstep_get(char *arg
)
450 if (!arch_needs_sstep_emulation
) {
451 if (cont_instead_of_sstep
) {
452 cont_instead_of_sstep
= 0;
459 switch (sstep_state
) {
461 v2printk("Emulate single step\n");
462 /* Start by looking at the current PC */
467 break_helper("Z0", NULL
, sstep_addr
);
474 /* Clear breakpoint */
475 break_helper("z0", NULL
, sstep_addr
);
478 eprintk("kgdbts: ERROR failed sstep get emulation\n");
483 static int emul_sstep_put(char *put_str
, char *arg
)
485 if (!arch_needs_sstep_emulation
) {
486 char *ptr
= &put_str
[11];
487 if (put_str
[1] != 'T' || put_str
[2] != '0')
489 kgdb_hex2long(&ptr
, &sstep_thread_id
);
492 switch (sstep_state
) {
494 /* validate the "g" packet to get the IP */
495 kgdb_hex2mem(&put_str
[1], (char *)kgdbts_gdb_regs
,
497 gdb_regs_to_pt_regs(kgdbts_gdb_regs
, &kgdbts_regs
);
498 v2printk("Stopped at IP: %lx\n",
499 instruction_pointer(&kgdbts_regs
));
500 /* Want to stop at IP + break instruction size by default */
501 sstep_addr
= cont_addr
+ BREAK_INSTR_SIZE
;
504 if (strncmp(put_str
, "$OK", 3)) {
505 eprintk("kgdbts: failed sstep break set\n");
510 if (strncmp(put_str
, "$T0", 3)) {
511 eprintk("kgdbts: failed continue sstep\n");
514 char *ptr
= &put_str
[11];
515 kgdb_hex2long(&ptr
, &sstep_thread_id
);
519 if (strncmp(put_str
, "$OK", 3)) {
520 eprintk("kgdbts: failed sstep break unset\n");
523 /* Single step is complete so continue on! */
527 eprintk("kgdbts: ERROR failed sstep put emulation\n");
530 /* Continue on the same test line until emulation is complete */
535 static int final_ack_set(char *put_str
, char *arg
)
537 if (strncmp(put_str
+1, arg
, 2))
543 * Test to plant a breakpoint and detach, which should clear out the
544 * breakpoint and restore the original instruction.
546 static struct test_struct plant_and_detach_test
[] = {
547 { "?", "S0*" }, /* Clear break points */
548 { "kgdbts_break_test", "OK", sw_break
, }, /* set sw breakpoint */
549 { "D", "OK" }, /* Detach */
554 * Simple test to write in a software breakpoint, check for the
555 * correct stop location and detach.
557 static struct test_struct sw_breakpoint_test
[] = {
558 { "?", "S0*" }, /* Clear break points */
559 { "kgdbts_break_test", "OK", sw_break
, }, /* set sw breakpoint */
560 { "c", "T0*", }, /* Continue */
561 { "g", "kgdbts_break_test", NULL
, check_and_rewind_pc
},
562 { "write", "OK", write_regs
},
563 { "kgdbts_break_test", "OK", sw_rem_break
}, /*remove breakpoint */
564 { "D", "OK" }, /* Detach */
565 { "D", "OK", NULL
, got_break
}, /* On success we made it here */
570 * Test a known bad memory read location to test the fault handler and
571 * read bytes 1-8 at the bad address
573 static struct test_struct bad_read_test
[] = {
574 { "?", "S0*" }, /* Clear break points */
575 { "m0,1", "E*" }, /* read 1 byte at address 1 */
576 { "m0,2", "E*" }, /* read 1 byte at address 2 */
577 { "m0,3", "E*" }, /* read 1 byte at address 3 */
578 { "m0,4", "E*" }, /* read 1 byte at address 4 */
579 { "m0,5", "E*" }, /* read 1 byte at address 5 */
580 { "m0,6", "E*" }, /* read 1 byte at address 6 */
581 { "m0,7", "E*" }, /* read 1 byte at address 7 */
582 { "m0,8", "E*" }, /* read 1 byte at address 8 */
583 { "D", "OK" }, /* Detach which removes all breakpoints and continues */
588 * Test for hitting a breakpoint, remove it, single step, plant it
591 static struct test_struct singlestep_break_test
[] = {
592 { "?", "S0*" }, /* Clear break points */
593 { "kgdbts_break_test", "OK", sw_break
, }, /* set sw breakpoint */
594 { "c", "T0*", NULL
, get_thread_id_continue
}, /* Continue */
595 { "kgdbts_break_test", "OK", sw_rem_break
}, /*remove breakpoint */
596 { "g", "kgdbts_break_test", NULL
, check_and_rewind_pc
},
597 { "write", "OK", write_regs
}, /* Write registers */
598 { "s", "T0*", emul_sstep_get
, emul_sstep_put
}, /* Single step */
599 { "g", "kgdbts_break_test", NULL
, check_single_step
},
600 { "kgdbts_break_test", "OK", sw_break
, }, /* set sw breakpoint */
601 { "c", "T0*", }, /* Continue */
602 { "g", "kgdbts_break_test", NULL
, check_and_rewind_pc
},
603 { "write", "OK", write_regs
}, /* Write registers */
604 { "D", "OK" }, /* Remove all breakpoints and continues */
609 * Test for hitting a breakpoint at kernel_clone for what ever the number
610 * of iterations required by the variable repeat_test.
612 static struct test_struct do_kernel_clone_test
[] = {
613 { "?", "S0*" }, /* Clear break points */
614 { "kernel_clone", "OK", sw_break
, }, /* set sw breakpoint */
615 { "c", "T0*", NULL
, get_thread_id_continue
}, /* Continue */
616 { "kernel_clone", "OK", sw_rem_break
}, /*remove breakpoint */
617 { "g", "kernel_clone", NULL
, check_and_rewind_pc
}, /* check location */
618 { "write", "OK", write_regs
, emul_reset
}, /* Write registers */
619 { "s", "T0*", emul_sstep_get
, emul_sstep_put
}, /* Single step */
620 { "g", "kernel_clone", NULL
, check_single_step
},
621 { "kernel_clone", "OK", sw_break
, }, /* set sw breakpoint */
622 { "7", "T0*", skip_back_repeat_test
}, /* Loop based on repeat_test */
623 { "D", "OK", NULL
, final_ack_set
}, /* detach and unregister I/O */
624 { "", "", get_cont_catch
, put_cont_catch
},
627 /* Test for hitting a breakpoint at sys_open for what ever the number
628 * of iterations required by the variable repeat_test.
630 static struct test_struct sys_open_test
[] = {
631 { "?", "S0*" }, /* Clear break points */
632 { "do_sys_openat2", "OK", sw_break
, }, /* set sw breakpoint */
633 { "c", "T0*", NULL
, get_thread_id_continue
}, /* Continue */
634 { "do_sys_openat2", "OK", sw_rem_break
}, /*remove breakpoint */
635 { "g", "do_sys_openat2", NULL
, check_and_rewind_pc
}, /* check location */
636 { "write", "OK", write_regs
, emul_reset
}, /* Write registers */
637 { "s", "T0*", emul_sstep_get
, emul_sstep_put
}, /* Single step */
638 { "g", "do_sys_openat2", NULL
, check_single_step
},
639 { "do_sys_openat2", "OK", sw_break
, }, /* set sw breakpoint */
640 { "7", "T0*", skip_back_repeat_test
}, /* Loop based on repeat_test */
641 { "D", "OK", NULL
, final_ack_set
}, /* detach and unregister I/O */
642 { "", "", get_cont_catch
, put_cont_catch
},
646 * Test for hitting a simple hw breakpoint
648 static struct test_struct hw_breakpoint_test
[] = {
649 { "?", "S0*" }, /* Clear break points */
650 { "kgdbts_break_test", "OK", hw_break
, }, /* set hw breakpoint */
651 { "c", "T0*", }, /* Continue */
652 { "g", "kgdbts_break_test", NULL
, check_and_rewind_pc
},
653 { "write", "OK", write_regs
},
654 { "kgdbts_break_test", "OK", hw_rem_break
}, /*remove breakpoint */
655 { "D", "OK" }, /* Detach */
656 { "D", "OK", NULL
, got_break
}, /* On success we made it here */
661 * Test for hitting a hw write breakpoint
663 static struct test_struct hw_write_break_test
[] = {
664 { "?", "S0*" }, /* Clear break points */
665 { "hw_break_val", "OK", hw_write_break
, }, /* set hw breakpoint */
666 { "c", "T0*", NULL
, got_break
}, /* Continue */
667 { "g", "silent", NULL
, check_and_rewind_pc
},
668 { "write", "OK", write_regs
},
669 { "hw_break_val", "OK", hw_rem_write_break
}, /*remove breakpoint */
670 { "D", "OK" }, /* Detach */
671 { "D", "OK", NULL
, got_break
}, /* On success we made it here */
676 * Test for hitting a hw access breakpoint
678 static struct test_struct hw_access_break_test
[] = {
679 { "?", "S0*" }, /* Clear break points */
680 { "hw_break_val", "OK", hw_access_break
, }, /* set hw breakpoint */
681 { "c", "T0*", NULL
, got_break
}, /* Continue */
682 { "g", "silent", NULL
, check_and_rewind_pc
},
683 { "write", "OK", write_regs
},
684 { "hw_break_val", "OK", hw_rem_access_break
}, /*remove breakpoint */
685 { "D", "OK" }, /* Detach */
686 { "D", "OK", NULL
, got_break
}, /* On success we made it here */
691 * Test for hitting a hw access breakpoint
693 static struct test_struct nmi_sleep_test
[] = {
694 { "?", "S0*" }, /* Clear break points */
695 { "c", "T0*", NULL
, got_break
}, /* Continue */
696 { "D", "OK" }, /* Detach */
697 { "D", "OK", NULL
, got_break
}, /* On success we made it here */
701 static void fill_get_buf(char *buf
)
703 unsigned char checksum
= 0;
707 strcpy(get_buf
, "$");
708 strcat(get_buf
, buf
);
709 while ((ch
= buf
[count
])) {
713 strcat(get_buf
, "#");
714 get_buf
[count
+ 2] = hex_asc_hi(checksum
);
715 get_buf
[count
+ 3] = hex_asc_lo(checksum
);
716 get_buf
[count
+ 4] = '\0';
717 v2printk("get%i: %s\n", ts
.idx
, get_buf
);
720 static int validate_simple_test(char *put_str
)
724 if (ts
.tst
[ts
.idx
].put_handler
)
725 return ts
.tst
[ts
.idx
].put_handler(put_str
,
728 chk_str
= ts
.tst
[ts
.idx
].put
;
732 while (*chk_str
!= '\0' && *put_str
!= '\0') {
733 /* If someone does a * to match the rest of the string, allow
734 * it, or stop if the received string is complete.
736 if (*put_str
== '#' || *chk_str
== '*')
738 if (*put_str
!= *chk_str
)
744 if (*chk_str
== '\0' && (*put_str
== '\0' || *put_str
== '#'))
750 static int run_simple_test(int is_get_char
, int chr
)
754 /* Send an ACK on the get if a prior put completed and set the
761 /* On the first get char, fill the transmit buffer and then
762 * take from the get_string.
764 if (get_buf_cnt
== 0) {
765 if (ts
.tst
[ts
.idx
].get_handler
)
766 ts
.tst
[ts
.idx
].get_handler(ts
.tst
[ts
.idx
].get
);
768 fill_get_buf(ts
.tst
[ts
.idx
].get
);
771 if (get_buf
[get_buf_cnt
] == '\0') {
772 eprintk("kgdbts: ERROR GET: EOB on '%s' at %i\n",
777 ret
= get_buf
[get_buf_cnt
];
782 /* This callback is a put char which is when kgdb sends data to
785 if (ts
.tst
[ts
.idx
].get
[0] == '\0' && ts
.tst
[ts
.idx
].put
[0] == '\0' &&
786 !ts
.tst
[ts
.idx
].get_handler
) {
787 eprintk("kgdbts: ERROR: beyond end of test on"
788 " '%s' line %i\n", ts
.name
, ts
.idx
);
792 if (put_buf_cnt
>= BUFMAX
) {
793 eprintk("kgdbts: ERROR: put buffer overflow on"
794 " '%s' line %i\n", ts
.name
, ts
.idx
);
798 /* Ignore everything until the first valid packet start '$' */
799 if (put_buf_cnt
== 0 && chr
!= '$')
802 put_buf
[put_buf_cnt
] = chr
;
805 /* End of packet == #XX so look for the '#' */
806 if (put_buf_cnt
> 3 && put_buf
[put_buf_cnt
- 3] == '#') {
807 if (put_buf_cnt
>= BUFMAX
) {
808 eprintk("kgdbts: ERROR: put buffer overflow on"
809 " '%s' line %i\n", ts
.name
, ts
.idx
);
813 put_buf
[put_buf_cnt
] = '\0';
814 v2printk("put%i: %s\n", ts
.idx
, put_buf
);
815 /* Trigger check here */
816 if (ts
.validate_put
&& ts
.validate_put(put_buf
)) {
817 eprintk("kgdbts: ERROR PUT: end of test "
818 "buffer on '%s' line %i expected %s got %s\n",
819 ts
.name
, ts
.idx
, ts
.tst
[ts
.idx
].put
, put_buf
);
829 static void init_simple_test(void)
831 memset(&ts
, 0, sizeof(ts
));
832 ts
.run_test
= run_simple_test
;
833 ts
.validate_put
= validate_simple_test
;
836 static void run_plant_and_detach_test(int is_early
)
838 char before
[BREAK_INSTR_SIZE
];
839 char after
[BREAK_INSTR_SIZE
];
841 copy_from_kernel_nofault(before
, (char *)kgdbts_break_test
,
844 ts
.tst
= plant_and_detach_test
;
845 ts
.name
= "plant_and_detach_test";
846 /* Activate test with initial breakpoint */
849 copy_from_kernel_nofault(after
, (char *)kgdbts_break_test
,
851 if (memcmp(before
, after
, BREAK_INSTR_SIZE
)) {
852 printk(KERN_CRIT
"kgdbts: ERROR kgdb corrupted memory\n");
853 panic("kgdb memory corruption");
856 /* complete the detach test */
861 static void run_breakpoint_test(int is_hw_breakpoint
)
865 if (is_hw_breakpoint
) {
866 ts
.tst
= hw_breakpoint_test
;
867 ts
.name
= "hw_breakpoint_test";
869 ts
.tst
= sw_breakpoint_test
;
870 ts
.name
= "sw_breakpoint_test";
872 /* Activate test with initial breakpoint */
874 /* run code with the break point in it */
881 eprintk("kgdbts: ERROR %s test failed\n", ts
.name
);
882 if (is_hw_breakpoint
)
886 static void run_hw_break_test(int is_write_test
)
891 ts
.tst
= hw_write_break_test
;
892 ts
.name
= "hw_write_break_test";
894 ts
.tst
= hw_access_break_test
;
895 ts
.name
= "hw_access_break_test";
897 /* Activate test with initial breakpoint */
899 hw_break_val_access();
901 if (test_complete
== 2) {
902 eprintk("kgdbts: ERROR %s broke on access\n",
906 hw_break_val_write();
910 if (test_complete
== 1)
913 eprintk("kgdbts: ERROR %s test failed\n", ts
.name
);
917 static void run_nmi_sleep_test(int nmi_sleep
)
922 ts
.tst
= nmi_sleep_test
;
923 ts
.name
= "nmi_sleep_test";
924 /* Activate test with initial breakpoint */
926 local_irq_save(flags
);
927 mdelay(nmi_sleep
*1000);
928 touch_nmi_watchdog();
929 local_irq_restore(flags
);
930 if (test_complete
!= 2)
931 eprintk("kgdbts: ERROR nmi_test did not hit nmi\n");
933 if (test_complete
== 1)
936 eprintk("kgdbts: ERROR %s test failed\n", ts
.name
);
939 static void run_bad_read_test(void)
942 ts
.tst
= bad_read_test
;
943 ts
.name
= "bad_read_test";
944 /* Activate test with initial breakpoint */
948 static void run_kernel_clone_test(void)
951 ts
.tst
= do_kernel_clone_test
;
952 ts
.name
= "do_kernel_clone_test";
953 /* Activate test with initial breakpoint */
957 static void run_sys_open_test(void)
960 ts
.tst
= sys_open_test
;
961 ts
.name
= "sys_open_test";
962 /* Activate test with initial breakpoint */
966 static void run_singlestep_break_test(void)
969 ts
.tst
= singlestep_break_test
;
970 ts
.name
= "singlestep_breakpoint_test";
971 /* Activate test with initial breakpoint */
977 static void kgdbts_run_tests(void)
981 int do_sys_open_test
= 0;
982 int sstep_test
= 1000;
987 if (strstr(config
, "V1"))
989 if (strstr(config
, "V2"))
992 ptr
= strchr(config
, 'F');
994 clone_test
= simple_strtol(ptr
+ 1, NULL
, 10);
995 ptr
= strchr(config
, 'S');
997 do_sys_open_test
= simple_strtol(ptr
+ 1, NULL
, 10);
998 ptr
= strchr(config
, 'N');
1000 nmi_sleep
= simple_strtol(ptr
+1, NULL
, 10);
1001 ptr
= strchr(config
, 'I');
1003 sstep_test
= simple_strtol(ptr
+1, NULL
, 10);
1005 /* All HW break point tests */
1006 if (arch_kgdb_ops
.flags
& KGDB_HW_BREAKPOINT
) {
1008 v1printk("kgdbts:RUN hw breakpoint test\n");
1009 run_breakpoint_test(1);
1010 v1printk("kgdbts:RUN hw write breakpoint test\n");
1011 run_hw_break_test(1);
1012 v1printk("kgdbts:RUN access write breakpoint test\n");
1013 run_hw_break_test(0);
1016 /* required internal KGDB tests */
1017 v1printk("kgdbts:RUN plant and detach test\n");
1018 run_plant_and_detach_test(0);
1019 v1printk("kgdbts:RUN sw breakpoint test\n");
1020 run_breakpoint_test(0);
1021 v1printk("kgdbts:RUN bad memory access test\n");
1022 run_bad_read_test();
1023 v1printk("kgdbts:RUN singlestep test %i iterations\n", sstep_test
);
1024 for (i
= 0; i
< sstep_test
; i
++) {
1025 run_singlestep_break_test();
1027 v1printk("kgdbts:RUN singlestep [%i/%i]\n",
1031 /* ===Optional tests=== */
1034 v1printk("kgdbts:RUN NMI sleep %i seconds test\n", nmi_sleep
);
1035 run_nmi_sleep_test(nmi_sleep
);
1038 /* If the kernel_clone test is run it will be the last test that is
1039 * executed because a kernel thread will be spawned at the very
1040 * end to unregister the debug hooks.
1043 repeat_test
= clone_test
;
1044 printk(KERN_INFO
"kgdbts:RUN kernel_clone for %i breakpoints\n",
1046 kthread_run(kgdbts_unreg_thread
, NULL
, "kgdbts_unreg");
1047 run_kernel_clone_test();
1051 /* If the sys_open test is run it will be the last test that is
1052 * executed because a kernel thread will be spawned at the very
1053 * end to unregister the debug hooks.
1055 if (do_sys_open_test
) {
1056 repeat_test
= do_sys_open_test
;
1057 printk(KERN_INFO
"kgdbts:RUN sys_open for %i breakpoints\n",
1059 kthread_run(kgdbts_unreg_thread
, NULL
, "kgdbts_unreg");
1060 run_sys_open_test();
1063 /* Shutdown and unregister */
1064 kgdb_unregister_io_module(&kgdbts_io_ops
);
1068 static int kgdbts_option_setup(char *opt
)
1070 if (strlen(opt
) >= MAX_CONFIG_LEN
) {
1071 printk(KERN_ERR
"kgdbts: config string too long\n");
1074 strcpy(config
, opt
);
1078 __setup("kgdbts=", kgdbts_option_setup
);
1080 static int configure_kgdbts(void)
1084 if (!strlen(config
) || isspace(config
[0]))
1088 run_plant_and_detach_test(1);
1090 err
= kgdb_register_io_module(&kgdbts_io_ops
);
1107 static int __init
init_kgdbts(void)
1109 /* Already configured? */
1110 if (configured
== 1)
1113 return configure_kgdbts();
1115 device_initcall(init_kgdbts
);
1117 static int kgdbts_get_char(void)
1122 val
= ts
.run_test(1, 0);
1127 static void kgdbts_put_char(u8 chr
)
1130 ts
.run_test(0, chr
);
1133 static int param_set_kgdbts_var(const char *kmessage
,
1134 const struct kernel_param
*kp
)
1136 size_t len
= strlen(kmessage
);
1138 if (len
>= MAX_CONFIG_LEN
) {
1139 printk(KERN_ERR
"kgdbts: config string too long\n");
1143 /* Only copy in the string if the init function has not run yet */
1144 if (configured
< 0) {
1145 strcpy(config
, kmessage
);
1149 if (configured
== 1) {
1150 printk(KERN_ERR
"kgdbts: ERROR: Already configured and running.\n");
1154 strcpy(config
, kmessage
);
1155 /* Chop out \n char as a result of echo */
1156 if (len
&& config
[len
- 1] == '\n')
1157 config
[len
- 1] = '\0';
1159 /* Go and configure with the new params. */
1160 return configure_kgdbts();
1163 static void kgdbts_pre_exp_handler(void)
1165 /* Increment the module count when the debugger is active */
1166 if (!kgdb_connected
)
1167 try_module_get(THIS_MODULE
);
1170 static void kgdbts_post_exp_handler(void)
1172 /* decrement the module count when the debugger detaches */
1173 if (!kgdb_connected
)
1174 module_put(THIS_MODULE
);
1177 static struct kgdb_io kgdbts_io_ops
= {
1179 .read_char
= kgdbts_get_char
,
1180 .write_char
= kgdbts_put_char
,
1181 .pre_exception
= kgdbts_pre_exp_handler
,
1182 .post_exception
= kgdbts_post_exp_handler
,
1186 * not really modular, but the easiest way to keep compat with existing
1187 * bootargs behaviour is to continue using module_param here.
1189 module_param_call(kgdbts
, param_set_kgdbts_var
, param_get_string
, &kps
, 0644);
1190 MODULE_PARM_DESC(kgdbts
, "<A|V1|V2>[F#|S#][N#]");