blob: 3f7ad83ed740bc0f008ca50ec8efdc125369d644 [file] [log] [blame]
Jason Wessele8d31c22008-03-07 16:34:17 -06001/*
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.
5 *
6 * Created by: Jason Wessel <jason.wessel@windriver.com>
7 *
8 * Copyright (c) 2008 Wind River Systems, Inc.
9 *
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.
13 *
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.
18 *
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
22 */
23/* Information about the kgdb test suite.
24 * -------------------------------------
25 *
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
30 * sending a response.
31 *
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=
37 * line:
38 *
39 * When using the "kgdbts=" you only choose one of the following core
40 * test types:
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
44 *
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
Jason Wessel7cfcd982008-04-24 16:57:23 -050050 * I## = Run the single step test ## iterations
Jason Wessele8d31c22008-03-07 16:34:17 -060051 *
52 * NOTE: that the do_fork and sys_open tests are mutually exclusive.
53 *
54 * To invoke the kgdb test suite from boot you use a kernel start
55 * argument as follows:
56 * kgdbts=V1 kgdbwait
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
60 *
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
65 *
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.
69 *
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
73 * "kgdbts=V1N6F100
74 *
75 * 2) After the system boot run the basic test.
76 * echo kgdbts=V1 > /sys/module/kgdbts/parameters/kgdbts
77 *
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
81 * loops.
82 *
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
94 *
95 */
96
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>
Paul Gortmakereb12a672011-07-03 15:14:56 -0400105#include <linux/module.h>
Jason Wessele8d31c22008-03-07 16:34:17 -0600106
107#define v1printk(a...) do { \
108 if (verbose) \
109 printk(KERN_INFO a); \
110 } while (0)
111#define v2printk(a...) do { \
112 if (verbose > 1) \
113 printk(KERN_INFO a); \
114 touch_nmi_watchdog(); \
115 } while (0)
Jason Wessel974460c2008-03-20 13:43:44 -0500116#define eprintk(a...) do { \
117 printk(KERN_ERR a); \
118 WARN_ON(1); \
119 } while (0)
Jason Wessele8d31c22008-03-07 16:34:17 -0600120#define MAX_CONFIG_LEN 40
121
Jason Wessele8d31c22008-03-07 16:34:17 -0600122static struct kgdb_io kgdbts_io_ops;
123static char get_buf[BUFMAX];
124static int get_buf_cnt;
125static char put_buf[BUFMAX];
126static int put_buf_cnt;
127static char scratch_buf[BUFMAX];
128static int verbose;
129static int repeat_test;
130static int test_complete;
131static int send_ack;
132static int final_ack;
Jason Wesselb33cb812008-05-28 12:49:57 -0500133static int force_hwbrks;
134static int hwbreaks_ok;
Jason Wessele8d31c22008-03-07 16:34:17 -0600135static int hw_break_val;
136static int hw_break_val2;
David S. Miller4d7ffa42008-04-29 01:36:14 -0700137#if defined(CONFIG_ARM) || defined(CONFIG_MIPS) || defined(CONFIG_SPARC)
Jason Wessele8d31c22008-03-07 16:34:17 -0600138static int arch_needs_sstep_emulation = 1;
139#else
140static int arch_needs_sstep_emulation;
141#endif
142static unsigned long sstep_addr;
143static int sstep_state;
144
145/* Storage for the registers, in GDB format. */
146static unsigned long kgdbts_gdb_regs[(NUMREGBYTES +
147 sizeof(unsigned long) - 1) /
148 sizeof(unsigned long)];
149static struct pt_regs kgdbts_regs;
150
151/* -1 = init not run yet, 0 = unconfigured, 1 = configured. */
152static int configured = -1;
153
Jason Wessel974460c2008-03-20 13:43:44 -0500154#ifdef CONFIG_KGDB_TESTS_BOOT_STRING
155static char config[MAX_CONFIG_LEN] = CONFIG_KGDB_TESTS_BOOT_STRING;
156#else
Jason Wessele8d31c22008-03-07 16:34:17 -0600157static char config[MAX_CONFIG_LEN];
Jason Wessel974460c2008-03-20 13:43:44 -0500158#endif
Jason Wessele8d31c22008-03-07 16:34:17 -0600159static struct kparam_string kps = {
160 .string = config,
161 .maxlen = MAX_CONFIG_LEN,
162};
163
164static void fill_get_buf(char *buf);
165
166struct test_struct {
167 char *get;
168 char *put;
169 void (*get_handler)(char *);
170 int (*put_handler)(char *, char *);
171};
172
173struct test_state {
174 char *name;
175 struct test_struct *tst;
176 int idx;
177 int (*run_test) (int, int);
178 int (*validate_put) (char *);
179};
180
181static struct test_state ts;
182
183static int kgdbts_unreg_thread(void *ptr)
184{
185 /* Wait until the tests are complete and then ungresiter the I/O
186 * driver.
187 */
188 while (!final_ack)
189 msleep_interruptible(1500);
190
191 if (configured)
192 kgdb_unregister_io_module(&kgdbts_io_ops);
193 configured = 0;
194
195 return 0;
196}
197
198/* This is noinline such that it can be used for a single location to
199 * place a breakpoint
200 */
201static noinline void kgdbts_break_test(void)
202{
203 v2printk("kgdbts: breakpoint complete\n");
204}
205
206/* Lookup symbol info in the kernel */
207static unsigned long lookup_addr(char *arg)
208{
209 unsigned long addr = 0;
210
211 if (!strcmp(arg, "kgdbts_break_test"))
212 addr = (unsigned long)kgdbts_break_test;
213 else if (!strcmp(arg, "sys_open"))
214 addr = (unsigned long)sys_open;
215 else if (!strcmp(arg, "do_fork"))
216 addr = (unsigned long)do_fork;
217 else if (!strcmp(arg, "hw_break_val"))
218 addr = (unsigned long)&hw_break_val;
219 return addr;
220}
221
222static void break_helper(char *bp_type, char *arg, unsigned long vaddr)
223{
224 unsigned long addr;
225
226 if (arg)
227 addr = lookup_addr(arg);
228 else
229 addr = vaddr;
230
231 sprintf(scratch_buf, "%s,%lx,%i", bp_type, addr,
232 BREAK_INSTR_SIZE);
233 fill_get_buf(scratch_buf);
234}
235
236static void sw_break(char *arg)
237{
Jason Wesselb33cb812008-05-28 12:49:57 -0500238 break_helper(force_hwbrks ? "Z1" : "Z0", arg, 0);
Jason Wessele8d31c22008-03-07 16:34:17 -0600239}
240
241static void sw_rem_break(char *arg)
242{
Jason Wesselb33cb812008-05-28 12:49:57 -0500243 break_helper(force_hwbrks ? "z1" : "z0", arg, 0);
Jason Wessele8d31c22008-03-07 16:34:17 -0600244}
245
246static void hw_break(char *arg)
247{
248 break_helper("Z1", arg, 0);
249}
250
251static void hw_rem_break(char *arg)
252{
253 break_helper("z1", arg, 0);
254}
255
256static void hw_write_break(char *arg)
257{
258 break_helper("Z2", arg, 0);
259}
260
261static void hw_rem_write_break(char *arg)
262{
263 break_helper("z2", arg, 0);
264}
265
266static void hw_access_break(char *arg)
267{
268 break_helper("Z4", arg, 0);
269}
270
271static void hw_rem_access_break(char *arg)
272{
273 break_helper("z4", arg, 0);
274}
275
276static void hw_break_val_access(void)
277{
278 hw_break_val2 = hw_break_val;
279}
280
281static void hw_break_val_write(void)
282{
283 hw_break_val++;
284}
285
286static int check_and_rewind_pc(char *put_str, char *arg)
287{
288 unsigned long addr = lookup_addr(arg);
Mike Frysinger63ab25e2011-05-26 16:25:45 -0700289 unsigned long ip;
Jason Wessele8d31c22008-03-07 16:34:17 -0600290 int offset = 0;
291
292 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
293 NUMREGBYTES);
294 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
Mike Frysinger63ab25e2011-05-26 16:25:45 -0700295 ip = instruction_pointer(&kgdbts_regs);
296 v2printk("Stopped at IP: %lx\n", ip);
297#ifdef GDB_ADJUSTS_BREAK_OFFSET
298 /* On some arches, a breakpoint stop requires it to be decremented */
299 if (addr + BREAK_INSTR_SIZE == ip)
300 offset = -BREAK_INSTR_SIZE;
Jason Wessele8d31c22008-03-07 16:34:17 -0600301#endif
Mike Frysinger63ab25e2011-05-26 16:25:45 -0700302 if (strcmp(arg, "silent") && ip + offset != addr) {
Jason Wessel974460c2008-03-20 13:43:44 -0500303 eprintk("kgdbts: BP mismatch %lx expected %lx\n",
Mike Frysinger63ab25e2011-05-26 16:25:45 -0700304 ip + offset, addr);
Jason Wessele8d31c22008-03-07 16:34:17 -0600305 return 1;
306 }
Mike Frysinger63ab25e2011-05-26 16:25:45 -0700307 /* Readjust the instruction pointer if needed */
Mike Frysinger603d04b2011-05-28 10:04:25 -0400308 ip += offset;
309#ifdef GDB_ADJUSTS_BREAK_OFFSET
310 instruction_pointer_set(&kgdbts_regs, ip);
311#endif
Jason Wessele8d31c22008-03-07 16:34:17 -0600312 return 0;
313}
314
315static int check_single_step(char *put_str, char *arg)
316{
317 unsigned long addr = lookup_addr(arg);
318 /*
319 * From an arch indepent point of view the instruction pointer
320 * should be on a different instruction
321 */
322 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
323 NUMREGBYTES);
324 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
325 v2printk("Singlestep stopped at IP: %lx\n",
326 instruction_pointer(&kgdbts_regs));
327 if (instruction_pointer(&kgdbts_regs) == addr) {
Jason Wessel974460c2008-03-20 13:43:44 -0500328 eprintk("kgdbts: SingleStep failed at %lx\n",
Jason Wessele8d31c22008-03-07 16:34:17 -0600329 instruction_pointer(&kgdbts_regs));
330 return 1;
331 }
332
333 return 0;
334}
335
336static void write_regs(char *arg)
337{
338 memset(scratch_buf, 0, sizeof(scratch_buf));
339 scratch_buf[0] = 'G';
340 pt_regs_to_gdb_regs(kgdbts_gdb_regs, &kgdbts_regs);
341 kgdb_mem2hex((char *)kgdbts_gdb_regs, &scratch_buf[1], NUMREGBYTES);
342 fill_get_buf(scratch_buf);
343}
344
345static void skip_back_repeat_test(char *arg)
346{
347 int go_back = simple_strtol(arg, NULL, 10);
348
349 repeat_test--;
350 if (repeat_test <= 0)
351 ts.idx++;
352 else
353 ts.idx -= go_back;
354 fill_get_buf(ts.tst[ts.idx].get);
355}
356
357static int got_break(char *put_str, char *arg)
358{
359 test_complete = 1;
360 if (!strncmp(put_str+1, arg, 2)) {
361 if (!strncmp(arg, "T0", 2))
362 test_complete = 2;
363 return 0;
364 }
365 return 1;
366}
367
368static void emul_sstep_get(char *arg)
369{
370 if (!arch_needs_sstep_emulation) {
371 fill_get_buf(arg);
372 return;
373 }
374 switch (sstep_state) {
375 case 0:
376 v2printk("Emulate single step\n");
377 /* Start by looking at the current PC */
378 fill_get_buf("g");
379 break;
380 case 1:
381 /* set breakpoint */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500382 break_helper("Z0", NULL, sstep_addr);
Jason Wessele8d31c22008-03-07 16:34:17 -0600383 break;
384 case 2:
385 /* Continue */
386 fill_get_buf("c");
387 break;
388 case 3:
389 /* Clear breakpoint */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500390 break_helper("z0", NULL, sstep_addr);
Jason Wessele8d31c22008-03-07 16:34:17 -0600391 break;
392 default:
Jason Wessel974460c2008-03-20 13:43:44 -0500393 eprintk("kgdbts: ERROR failed sstep get emulation\n");
Jason Wessele8d31c22008-03-07 16:34:17 -0600394 }
395 sstep_state++;
396}
397
398static int emul_sstep_put(char *put_str, char *arg)
399{
400 if (!arch_needs_sstep_emulation) {
401 if (!strncmp(put_str+1, arg, 2))
402 return 0;
403 return 1;
404 }
405 switch (sstep_state) {
406 case 1:
407 /* validate the "g" packet to get the IP */
408 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
409 NUMREGBYTES);
410 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
411 v2printk("Stopped at IP: %lx\n",
412 instruction_pointer(&kgdbts_regs));
413 /* Want to stop at IP + break instruction size by default */
414 sstep_addr = instruction_pointer(&kgdbts_regs) +
415 BREAK_INSTR_SIZE;
416 break;
417 case 2:
418 if (strncmp(put_str, "$OK", 3)) {
Jason Wessel974460c2008-03-20 13:43:44 -0500419 eprintk("kgdbts: failed sstep break set\n");
Jason Wessele8d31c22008-03-07 16:34:17 -0600420 return 1;
421 }
422 break;
423 case 3:
424 if (strncmp(put_str, "$T0", 3)) {
Jason Wessel974460c2008-03-20 13:43:44 -0500425 eprintk("kgdbts: failed continue sstep\n");
Jason Wessele8d31c22008-03-07 16:34:17 -0600426 return 1;
427 }
428 break;
429 case 4:
430 if (strncmp(put_str, "$OK", 3)) {
Jason Wessel974460c2008-03-20 13:43:44 -0500431 eprintk("kgdbts: failed sstep break unset\n");
Jason Wessele8d31c22008-03-07 16:34:17 -0600432 return 1;
433 }
434 /* Single step is complete so continue on! */
435 sstep_state = 0;
436 return 0;
437 default:
Jason Wessel974460c2008-03-20 13:43:44 -0500438 eprintk("kgdbts: ERROR failed sstep put emulation\n");
Jason Wessele8d31c22008-03-07 16:34:17 -0600439 }
440
441 /* Continue on the same test line until emulation is complete */
442 ts.idx--;
443 return 0;
444}
445
446static int final_ack_set(char *put_str, char *arg)
447{
448 if (strncmp(put_str+1, arg, 2))
449 return 1;
450 final_ack = 1;
451 return 0;
452}
453/*
454 * Test to plant a breakpoint and detach, which should clear out the
455 * breakpoint and restore the original instruction.
456 */
457static struct test_struct plant_and_detach_test[] = {
458 { "?", "S0*" }, /* Clear break points */
459 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
460 { "D", "OK" }, /* Detach */
461 { "", "" },
462};
463
464/*
465 * Simple test to write in a software breakpoint, check for the
466 * correct stop location and detach.
467 */
468static struct test_struct sw_breakpoint_test[] = {
469 { "?", "S0*" }, /* Clear break points */
470 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
471 { "c", "T0*", }, /* Continue */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500472 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
Jason Wessele8d31c22008-03-07 16:34:17 -0600473 { "write", "OK", write_regs },
474 { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */
475 { "D", "OK" }, /* Detach */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500476 { "D", "OK", NULL, got_break }, /* On success we made it here */
Jason Wessele8d31c22008-03-07 16:34:17 -0600477 { "", "" },
478};
479
480/*
481 * Test a known bad memory read location to test the fault handler and
482 * read bytes 1-8 at the bad address
483 */
484static struct test_struct bad_read_test[] = {
485 { "?", "S0*" }, /* Clear break points */
486 { "m0,1", "E*" }, /* read 1 byte at address 1 */
487 { "m0,2", "E*" }, /* read 1 byte at address 2 */
488 { "m0,3", "E*" }, /* read 1 byte at address 3 */
489 { "m0,4", "E*" }, /* read 1 byte at address 4 */
490 { "m0,5", "E*" }, /* read 1 byte at address 5 */
491 { "m0,6", "E*" }, /* read 1 byte at address 6 */
492 { "m0,7", "E*" }, /* read 1 byte at address 7 */
493 { "m0,8", "E*" }, /* read 1 byte at address 8 */
494 { "D", "OK" }, /* Detach which removes all breakpoints and continues */
495 { "", "" },
496};
497
498/*
499 * Test for hitting a breakpoint, remove it, single step, plant it
500 * again and detach.
501 */
502static struct test_struct singlestep_break_test[] = {
503 { "?", "S0*" }, /* Clear break points */
504 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
505 { "c", "T0*", }, /* Continue */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500506 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
Jason Wessele8d31c22008-03-07 16:34:17 -0600507 { "write", "OK", write_regs }, /* Write registers */
508 { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */
509 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500510 { "g", "kgdbts_break_test", NULL, check_single_step },
Jason Wessele8d31c22008-03-07 16:34:17 -0600511 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
512 { "c", "T0*", }, /* Continue */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500513 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
Jason Wessele8d31c22008-03-07 16:34:17 -0600514 { "write", "OK", write_regs }, /* Write registers */
515 { "D", "OK" }, /* Remove all breakpoints and continues */
516 { "", "" },
517};
518
519/*
520 * Test for hitting a breakpoint at do_fork for what ever the number
521 * of iterations required by the variable repeat_test.
522 */
523static struct test_struct do_fork_test[] = {
524 { "?", "S0*" }, /* Clear break points */
525 { "do_fork", "OK", sw_break, }, /* set sw breakpoint */
526 { "c", "T0*", }, /* Continue */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500527 { "g", "do_fork", NULL, check_and_rewind_pc }, /* check location */
Jason Wessele8d31c22008-03-07 16:34:17 -0600528 { "write", "OK", write_regs }, /* Write registers */
529 { "do_fork", "OK", sw_rem_break }, /*remove breakpoint */
530 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500531 { "g", "do_fork", NULL, check_single_step },
Jason Wessele8d31c22008-03-07 16:34:17 -0600532 { "do_fork", "OK", sw_break, }, /* set sw breakpoint */
533 { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500534 { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */
Jason Wessele8d31c22008-03-07 16:34:17 -0600535 { "", "" },
536};
537
538/* Test for hitting a breakpoint at sys_open for what ever the number
539 * of iterations required by the variable repeat_test.
540 */
541static struct test_struct sys_open_test[] = {
542 { "?", "S0*" }, /* Clear break points */
543 { "sys_open", "OK", sw_break, }, /* set sw breakpoint */
544 { "c", "T0*", }, /* Continue */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500545 { "g", "sys_open", NULL, check_and_rewind_pc }, /* check location */
Jason Wessele8d31c22008-03-07 16:34:17 -0600546 { "write", "OK", write_regs }, /* Write registers */
547 { "sys_open", "OK", sw_rem_break }, /*remove breakpoint */
548 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500549 { "g", "sys_open", NULL, check_single_step },
Jason Wessele8d31c22008-03-07 16:34:17 -0600550 { "sys_open", "OK", sw_break, }, /* set sw breakpoint */
551 { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500552 { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */
Jason Wessele8d31c22008-03-07 16:34:17 -0600553 { "", "" },
554};
555
556/*
557 * Test for hitting a simple hw breakpoint
558 */
559static struct test_struct hw_breakpoint_test[] = {
560 { "?", "S0*" }, /* Clear break points */
561 { "kgdbts_break_test", "OK", hw_break, }, /* set hw breakpoint */
562 { "c", "T0*", }, /* Continue */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500563 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
Jason Wessele8d31c22008-03-07 16:34:17 -0600564 { "write", "OK", write_regs },
565 { "kgdbts_break_test", "OK", hw_rem_break }, /*remove breakpoint */
566 { "D", "OK" }, /* Detach */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500567 { "D", "OK", NULL, got_break }, /* On success we made it here */
Jason Wessele8d31c22008-03-07 16:34:17 -0600568 { "", "" },
569};
570
571/*
572 * Test for hitting a hw write breakpoint
573 */
574static struct test_struct hw_write_break_test[] = {
575 { "?", "S0*" }, /* Clear break points */
576 { "hw_break_val", "OK", hw_write_break, }, /* set hw breakpoint */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500577 { "c", "T0*", NULL, got_break }, /* Continue */
578 { "g", "silent", NULL, check_and_rewind_pc },
Jason Wessele8d31c22008-03-07 16:34:17 -0600579 { "write", "OK", write_regs },
580 { "hw_break_val", "OK", hw_rem_write_break }, /*remove breakpoint */
581 { "D", "OK" }, /* Detach */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500582 { "D", "OK", NULL, got_break }, /* On success we made it here */
Jason Wessele8d31c22008-03-07 16:34:17 -0600583 { "", "" },
584};
585
586/*
587 * Test for hitting a hw access breakpoint
588 */
589static struct test_struct hw_access_break_test[] = {
590 { "?", "S0*" }, /* Clear break points */
591 { "hw_break_val", "OK", hw_access_break, }, /* set hw breakpoint */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500592 { "c", "T0*", NULL, got_break }, /* Continue */
593 { "g", "silent", NULL, check_and_rewind_pc },
Jason Wessele8d31c22008-03-07 16:34:17 -0600594 { "write", "OK", write_regs },
595 { "hw_break_val", "OK", hw_rem_access_break }, /*remove breakpoint */
596 { "D", "OK" }, /* Detach */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500597 { "D", "OK", NULL, got_break }, /* On success we made it here */
Jason Wessele8d31c22008-03-07 16:34:17 -0600598 { "", "" },
599};
600
601/*
602 * Test for hitting a hw access breakpoint
603 */
604static struct test_struct nmi_sleep_test[] = {
605 { "?", "S0*" }, /* Clear break points */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500606 { "c", "T0*", NULL, got_break }, /* Continue */
Jason Wessele8d31c22008-03-07 16:34:17 -0600607 { "D", "OK" }, /* Detach */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500608 { "D", "OK", NULL, got_break }, /* On success we made it here */
Jason Wessele8d31c22008-03-07 16:34:17 -0600609 { "", "" },
610};
611
612static void fill_get_buf(char *buf)
613{
614 unsigned char checksum = 0;
615 int count = 0;
616 char ch;
617
618 strcpy(get_buf, "$");
619 strcat(get_buf, buf);
620 while ((ch = buf[count])) {
621 checksum += ch;
622 count++;
623 }
624 strcat(get_buf, "#");
Harvey Harrison827e6092008-05-28 12:49:56 -0500625 get_buf[count + 2] = hex_asc_hi(checksum);
626 get_buf[count + 3] = hex_asc_lo(checksum);
Jason Wessele8d31c22008-03-07 16:34:17 -0600627 get_buf[count + 4] = '\0';
628 v2printk("get%i: %s\n", ts.idx, get_buf);
629}
630
631static int validate_simple_test(char *put_str)
632{
633 char *chk_str;
634
635 if (ts.tst[ts.idx].put_handler)
636 return ts.tst[ts.idx].put_handler(put_str,
637 ts.tst[ts.idx].put);
638
639 chk_str = ts.tst[ts.idx].put;
640 if (*put_str == '$')
641 put_str++;
642
643 while (*chk_str != '\0' && *put_str != '\0') {
644 /* If someone does a * to match the rest of the string, allow
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300645 * it, or stop if the received string is complete.
Jason Wessele8d31c22008-03-07 16:34:17 -0600646 */
647 if (*put_str == '#' || *chk_str == '*')
648 return 0;
649 if (*put_str != *chk_str)
650 return 1;
651
652 chk_str++;
653 put_str++;
654 }
655 if (*chk_str == '\0' && (*put_str == '\0' || *put_str == '#'))
656 return 0;
657
658 return 1;
659}
660
661static int run_simple_test(int is_get_char, int chr)
662{
663 int ret = 0;
664 if (is_get_char) {
665 /* Send an ACK on the get if a prior put completed and set the
666 * send ack variable
667 */
668 if (send_ack) {
669 send_ack = 0;
670 return '+';
671 }
672 /* On the first get char, fill the transmit buffer and then
673 * take from the get_string.
674 */
675 if (get_buf_cnt == 0) {
676 if (ts.tst[ts.idx].get_handler)
677 ts.tst[ts.idx].get_handler(ts.tst[ts.idx].get);
678 else
679 fill_get_buf(ts.tst[ts.idx].get);
680 }
681
682 if (get_buf[get_buf_cnt] == '\0') {
Jason Wessel974460c2008-03-20 13:43:44 -0500683 eprintk("kgdbts: ERROR GET: EOB on '%s' at %i\n",
Jason Wessele8d31c22008-03-07 16:34:17 -0600684 ts.name, ts.idx);
685 get_buf_cnt = 0;
686 fill_get_buf("D");
687 }
688 ret = get_buf[get_buf_cnt];
689 get_buf_cnt++;
690 return ret;
691 }
692
693 /* This callback is a put char which is when kgdb sends data to
694 * this I/O module.
695 */
696 if (ts.tst[ts.idx].get[0] == '\0' &&
697 ts.tst[ts.idx].put[0] == '\0') {
Jason Wessel974460c2008-03-20 13:43:44 -0500698 eprintk("kgdbts: ERROR: beyond end of test on"
Jason Wessele8d31c22008-03-07 16:34:17 -0600699 " '%s' line %i\n", ts.name, ts.idx);
700 return 0;
701 }
702
703 if (put_buf_cnt >= BUFMAX) {
Jason Wessel974460c2008-03-20 13:43:44 -0500704 eprintk("kgdbts: ERROR: put buffer overflow on"
Jason Wessele8d31c22008-03-07 16:34:17 -0600705 " '%s' line %i\n", ts.name, ts.idx);
706 put_buf_cnt = 0;
707 return 0;
708 }
709 /* Ignore everything until the first valid packet start '$' */
710 if (put_buf_cnt == 0 && chr != '$')
711 return 0;
712
713 put_buf[put_buf_cnt] = chr;
714 put_buf_cnt++;
715
716 /* End of packet == #XX so look for the '#' */
717 if (put_buf_cnt > 3 && put_buf[put_buf_cnt - 3] == '#') {
Roel Kluinb4f1b672009-12-11 08:43:15 -0600718 if (put_buf_cnt >= BUFMAX) {
719 eprintk("kgdbts: ERROR: put buffer overflow on"
720 " '%s' line %i\n", ts.name, ts.idx);
721 put_buf_cnt = 0;
722 return 0;
723 }
Jason Wessele8d31c22008-03-07 16:34:17 -0600724 put_buf[put_buf_cnt] = '\0';
725 v2printk("put%i: %s\n", ts.idx, put_buf);
726 /* Trigger check here */
727 if (ts.validate_put && ts.validate_put(put_buf)) {
Jason Wessel974460c2008-03-20 13:43:44 -0500728 eprintk("kgdbts: ERROR PUT: end of test "
Jason Wessele8d31c22008-03-07 16:34:17 -0600729 "buffer on '%s' line %i expected %s got %s\n",
730 ts.name, ts.idx, ts.tst[ts.idx].put, put_buf);
731 }
732 ts.idx++;
733 put_buf_cnt = 0;
734 get_buf_cnt = 0;
735 send_ack = 1;
736 }
737 return 0;
738}
739
740static void init_simple_test(void)
741{
742 memset(&ts, 0, sizeof(ts));
743 ts.run_test = run_simple_test;
744 ts.validate_put = validate_simple_test;
745}
746
747static void run_plant_and_detach_test(int is_early)
748{
749 char before[BREAK_INSTR_SIZE];
750 char after[BREAK_INSTR_SIZE];
751
752 probe_kernel_read(before, (char *)kgdbts_break_test,
753 BREAK_INSTR_SIZE);
754 init_simple_test();
755 ts.tst = plant_and_detach_test;
756 ts.name = "plant_and_detach_test";
757 /* Activate test with initial breakpoint */
758 if (!is_early)
759 kgdb_breakpoint();
760 probe_kernel_read(after, (char *)kgdbts_break_test,
761 BREAK_INSTR_SIZE);
762 if (memcmp(before, after, BREAK_INSTR_SIZE)) {
763 printk(KERN_CRIT "kgdbts: ERROR kgdb corrupted memory\n");
764 panic("kgdb memory corruption");
765 }
766
767 /* complete the detach test */
768 if (!is_early)
769 kgdbts_break_test();
770}
771
772static void run_breakpoint_test(int is_hw_breakpoint)
773{
774 test_complete = 0;
775 init_simple_test();
776 if (is_hw_breakpoint) {
777 ts.tst = hw_breakpoint_test;
778 ts.name = "hw_breakpoint_test";
779 } else {
780 ts.tst = sw_breakpoint_test;
781 ts.name = "sw_breakpoint_test";
782 }
783 /* Activate test with initial breakpoint */
784 kgdb_breakpoint();
785 /* run code with the break point in it */
786 kgdbts_break_test();
787 kgdb_breakpoint();
788
789 if (test_complete)
790 return;
791
Jason Wessel974460c2008-03-20 13:43:44 -0500792 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
Jason Wesselb33cb812008-05-28 12:49:57 -0500793 if (is_hw_breakpoint)
794 hwbreaks_ok = 0;
Jason Wessele8d31c22008-03-07 16:34:17 -0600795}
796
797static void run_hw_break_test(int is_write_test)
798{
799 test_complete = 0;
800 init_simple_test();
801 if (is_write_test) {
802 ts.tst = hw_write_break_test;
803 ts.name = "hw_write_break_test";
804 } else {
805 ts.tst = hw_access_break_test;
806 ts.name = "hw_access_break_test";
807 }
808 /* Activate test with initial breakpoint */
809 kgdb_breakpoint();
810 hw_break_val_access();
811 if (is_write_test) {
Jason Wesselb33cb812008-05-28 12:49:57 -0500812 if (test_complete == 2) {
Jason Wessel974460c2008-03-20 13:43:44 -0500813 eprintk("kgdbts: ERROR %s broke on access\n",
Jason Wessele8d31c22008-03-07 16:34:17 -0600814 ts.name);
Jason Wesselb33cb812008-05-28 12:49:57 -0500815 hwbreaks_ok = 0;
816 }
Jason Wessele8d31c22008-03-07 16:34:17 -0600817 hw_break_val_write();
818 }
819 kgdb_breakpoint();
820
821 if (test_complete == 1)
822 return;
823
Jason Wessel974460c2008-03-20 13:43:44 -0500824 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
Jason Wesselb33cb812008-05-28 12:49:57 -0500825 hwbreaks_ok = 0;
Jason Wessele8d31c22008-03-07 16:34:17 -0600826}
827
828static void run_nmi_sleep_test(int nmi_sleep)
829{
830 unsigned long flags;
831
832 init_simple_test();
833 ts.tst = nmi_sleep_test;
834 ts.name = "nmi_sleep_test";
835 /* Activate test with initial breakpoint */
836 kgdb_breakpoint();
837 local_irq_save(flags);
838 mdelay(nmi_sleep*1000);
839 touch_nmi_watchdog();
840 local_irq_restore(flags);
841 if (test_complete != 2)
Jason Wessel974460c2008-03-20 13:43:44 -0500842 eprintk("kgdbts: ERROR nmi_test did not hit nmi\n");
Jason Wessele8d31c22008-03-07 16:34:17 -0600843 kgdb_breakpoint();
844 if (test_complete == 1)
845 return;
846
Jason Wessel974460c2008-03-20 13:43:44 -0500847 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
Jason Wessele8d31c22008-03-07 16:34:17 -0600848}
849
850static void run_bad_read_test(void)
851{
852 init_simple_test();
853 ts.tst = bad_read_test;
854 ts.name = "bad_read_test";
855 /* Activate test with initial breakpoint */
856 kgdb_breakpoint();
857}
858
859static void run_do_fork_test(void)
860{
861 init_simple_test();
862 ts.tst = do_fork_test;
863 ts.name = "do_fork_test";
864 /* Activate test with initial breakpoint */
865 kgdb_breakpoint();
866}
867
868static void run_sys_open_test(void)
869{
870 init_simple_test();
871 ts.tst = sys_open_test;
872 ts.name = "sys_open_test";
873 /* Activate test with initial breakpoint */
874 kgdb_breakpoint();
875}
876
877static void run_singlestep_break_test(void)
878{
879 init_simple_test();
880 ts.tst = singlestep_break_test;
881 ts.name = "singlestep_breakpoint_test";
882 /* Activate test with initial breakpoint */
883 kgdb_breakpoint();
884 kgdbts_break_test();
885 kgdbts_break_test();
886}
887
888static void kgdbts_run_tests(void)
889{
890 char *ptr;
891 int fork_test = 0;
Harvey Harrison001fddf2008-04-24 16:57:23 -0500892 int do_sys_open_test = 0;
Jason Wessel7cfcd982008-04-24 16:57:23 -0500893 int sstep_test = 1000;
Jason Wessele8d31c22008-03-07 16:34:17 -0600894 int nmi_sleep = 0;
Jason Wessel7cfcd982008-04-24 16:57:23 -0500895 int i;
Jason Wessele8d31c22008-03-07 16:34:17 -0600896
Geert Uytterhoeven59d309f2009-12-11 08:43:15 -0600897 ptr = strchr(config, 'F');
Jason Wessele8d31c22008-03-07 16:34:17 -0600898 if (ptr)
Harvey Harrison001fddf2008-04-24 16:57:23 -0500899 fork_test = simple_strtol(ptr + 1, NULL, 10);
Geert Uytterhoeven59d309f2009-12-11 08:43:15 -0600900 ptr = strchr(config, 'S');
Jason Wessele8d31c22008-03-07 16:34:17 -0600901 if (ptr)
Harvey Harrison001fddf2008-04-24 16:57:23 -0500902 do_sys_open_test = simple_strtol(ptr + 1, NULL, 10);
Geert Uytterhoeven59d309f2009-12-11 08:43:15 -0600903 ptr = strchr(config, 'N');
Jason Wessele8d31c22008-03-07 16:34:17 -0600904 if (ptr)
905 nmi_sleep = simple_strtol(ptr+1, NULL, 10);
Geert Uytterhoeven59d309f2009-12-11 08:43:15 -0600906 ptr = strchr(config, 'I');
Jason Wessel7cfcd982008-04-24 16:57:23 -0500907 if (ptr)
908 sstep_test = simple_strtol(ptr+1, NULL, 10);
Jason Wessele8d31c22008-03-07 16:34:17 -0600909
910 /* required internal KGDB tests */
911 v1printk("kgdbts:RUN plant and detach test\n");
912 run_plant_and_detach_test(0);
913 v1printk("kgdbts:RUN sw breakpoint test\n");
914 run_breakpoint_test(0);
915 v1printk("kgdbts:RUN bad memory access test\n");
916 run_bad_read_test();
Jason Wessel7cfcd982008-04-24 16:57:23 -0500917 v1printk("kgdbts:RUN singlestep test %i iterations\n", sstep_test);
918 for (i = 0; i < sstep_test; i++) {
919 run_singlestep_break_test();
920 if (i % 100 == 0)
921 v1printk("kgdbts:RUN singlestep [%i/%i]\n",
922 i, sstep_test);
923 }
Jason Wessele8d31c22008-03-07 16:34:17 -0600924
925 /* ===Optional tests=== */
926
927 /* All HW break point tests */
928 if (arch_kgdb_ops.flags & KGDB_HW_BREAKPOINT) {
Jason Wesselb33cb812008-05-28 12:49:57 -0500929 hwbreaks_ok = 1;
Jason Wessele8d31c22008-03-07 16:34:17 -0600930 v1printk("kgdbts:RUN hw breakpoint test\n");
931 run_breakpoint_test(1);
932 v1printk("kgdbts:RUN hw write breakpoint test\n");
933 run_hw_break_test(1);
934 v1printk("kgdbts:RUN access write breakpoint test\n");
935 run_hw_break_test(0);
936 }
937
938 if (nmi_sleep) {
939 v1printk("kgdbts:RUN NMI sleep %i seconds test\n", nmi_sleep);
940 run_nmi_sleep_test(nmi_sleep);
941 }
942
Jason Wesselb33cb812008-05-28 12:49:57 -0500943#ifdef CONFIG_DEBUG_RODATA
944 /* Until there is an api to write to read-only text segments, use
945 * HW breakpoints for the remainder of any tests, else print a
946 * failure message if hw breakpoints do not work.
947 */
948 if (!(arch_kgdb_ops.flags & KGDB_HW_BREAKPOINT && hwbreaks_ok)) {
949 eprintk("kgdbts: HW breakpoints do not work,"
950 "skipping remaining tests\n");
951 return;
952 }
953 force_hwbrks = 1;
954#endif /* CONFIG_DEBUG_RODATA */
955
Jason Wessele8d31c22008-03-07 16:34:17 -0600956 /* If the do_fork test is run it will be the last test that is
957 * executed because a kernel thread will be spawned at the very
958 * end to unregister the debug hooks.
959 */
960 if (fork_test) {
961 repeat_test = fork_test;
962 printk(KERN_INFO "kgdbts:RUN do_fork for %i breakpoints\n",
963 repeat_test);
Harvey Harrison001fddf2008-04-24 16:57:23 -0500964 kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg");
Jason Wessele8d31c22008-03-07 16:34:17 -0600965 run_do_fork_test();
966 return;
967 }
968
969 /* If the sys_open test is run it will be the last test that is
970 * executed because a kernel thread will be spawned at the very
971 * end to unregister the debug hooks.
972 */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500973 if (do_sys_open_test) {
974 repeat_test = do_sys_open_test;
Jason Wessele8d31c22008-03-07 16:34:17 -0600975 printk(KERN_INFO "kgdbts:RUN sys_open for %i breakpoints\n",
976 repeat_test);
Harvey Harrison001fddf2008-04-24 16:57:23 -0500977 kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg");
Jason Wessele8d31c22008-03-07 16:34:17 -0600978 run_sys_open_test();
979 return;
980 }
981 /* Shutdown and unregister */
982 kgdb_unregister_io_module(&kgdbts_io_ops);
983 configured = 0;
984}
985
986static int kgdbts_option_setup(char *opt)
987{
Dan Carpenteradb4b832010-03-15 07:28:00 -0500988 if (strlen(opt) >= MAX_CONFIG_LEN) {
Jason Wessele8d31c22008-03-07 16:34:17 -0600989 printk(KERN_ERR "kgdbts: config string too long\n");
990 return -ENOSPC;
991 }
992 strcpy(config, opt);
993
994 verbose = 0;
995 if (strstr(config, "V1"))
996 verbose = 1;
997 if (strstr(config, "V2"))
998 verbose = 2;
999
1000 return 0;
1001}
1002
1003__setup("kgdbts=", kgdbts_option_setup);
1004
1005static int configure_kgdbts(void)
1006{
1007 int err = 0;
1008
1009 if (!strlen(config) || isspace(config[0]))
1010 goto noconfig;
1011 err = kgdbts_option_setup(config);
1012 if (err)
1013 goto noconfig;
1014
1015 final_ack = 0;
1016 run_plant_and_detach_test(1);
1017
1018 err = kgdb_register_io_module(&kgdbts_io_ops);
1019 if (err) {
1020 configured = 0;
1021 return err;
1022 }
1023 configured = 1;
1024 kgdbts_run_tests();
1025
1026 return err;
1027
1028noconfig:
1029 config[0] = 0;
1030 configured = 0;
1031
1032 return err;
1033}
1034
1035static int __init init_kgdbts(void)
1036{
1037 /* Already configured? */
1038 if (configured == 1)
1039 return 0;
1040
1041 return configure_kgdbts();
1042}
1043
Jason Wessele8d31c22008-03-07 16:34:17 -06001044static int kgdbts_get_char(void)
1045{
1046 int val = 0;
1047
1048 if (ts.run_test)
1049 val = ts.run_test(1, 0);
1050
1051 return val;
1052}
1053
1054static void kgdbts_put_char(u8 chr)
1055{
1056 if (ts.run_test)
1057 ts.run_test(0, chr);
1058}
1059
1060static int param_set_kgdbts_var(const char *kmessage, struct kernel_param *kp)
1061{
1062 int len = strlen(kmessage);
1063
1064 if (len >= MAX_CONFIG_LEN) {
1065 printk(KERN_ERR "kgdbts: config string too long\n");
1066 return -ENOSPC;
1067 }
1068
1069 /* Only copy in the string if the init function has not run yet */
1070 if (configured < 0) {
1071 strcpy(config, kmessage);
1072 return 0;
1073 }
1074
Dongdong Deng4dacd5c2010-08-30 21:06:00 -05001075 if (configured == 1) {
1076 printk(KERN_ERR "kgdbts: ERROR: Already configured and running.\n");
Jason Wessele8d31c22008-03-07 16:34:17 -06001077 return -EBUSY;
1078 }
1079
1080 strcpy(config, kmessage);
1081 /* Chop out \n char as a result of echo */
1082 if (config[len - 1] == '\n')
1083 config[len - 1] = '\0';
1084
Jason Wessele8d31c22008-03-07 16:34:17 -06001085 /* Go and configure with the new params. */
1086 return configure_kgdbts();
1087}
1088
1089static void kgdbts_pre_exp_handler(void)
1090{
1091 /* Increment the module count when the debugger is active */
1092 if (!kgdb_connected)
1093 try_module_get(THIS_MODULE);
1094}
1095
1096static void kgdbts_post_exp_handler(void)
1097{
1098 /* decrement the module count when the debugger detaches */
1099 if (!kgdb_connected)
1100 module_put(THIS_MODULE);
1101}
1102
1103static struct kgdb_io kgdbts_io_ops = {
1104 .name = "kgdbts",
1105 .read_char = kgdbts_get_char,
1106 .write_char = kgdbts_put_char,
1107 .pre_exception = kgdbts_pre_exp_handler,
1108 .post_exception = kgdbts_post_exp_handler,
1109};
1110
1111module_init(init_kgdbts);
Jason Wessele8d31c22008-03-07 16:34:17 -06001112module_param_call(kgdbts, param_set_kgdbts_var, param_get_string, &kps, 0644);
1113MODULE_PARM_DESC(kgdbts, "<A|V1|V2>[F#|S#][N#]");
1114MODULE_DESCRIPTION("KGDB Test Suite");
1115MODULE_LICENSE("GPL");
1116MODULE_AUTHOR("Wind River Systems, Inc.");
1117