blob: 8cebec5e85eeb3d3c80bd998815a3e07f1a913ad [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>
Jason Wessele8d31c22008-03-07 16:34:17 -0600105
106#define v1printk(a...) do { \
107 if (verbose) \
108 printk(KERN_INFO a); \
109 } while (0)
110#define v2printk(a...) do { \
111 if (verbose > 1) \
112 printk(KERN_INFO a); \
113 touch_nmi_watchdog(); \
114 } while (0)
Jason Wessel974460c2008-03-20 13:43:44 -0500115#define eprintk(a...) do { \
116 printk(KERN_ERR a); \
117 WARN_ON(1); \
118 } while (0)
Jason Wessele8d31c22008-03-07 16:34:17 -0600119#define MAX_CONFIG_LEN 40
120
Jason Wessele8d31c22008-03-07 16:34:17 -0600121static struct kgdb_io kgdbts_io_ops;
122static char get_buf[BUFMAX];
123static int get_buf_cnt;
124static char put_buf[BUFMAX];
125static int put_buf_cnt;
126static char scratch_buf[BUFMAX];
127static int verbose;
128static int repeat_test;
129static int test_complete;
130static int send_ack;
131static int final_ack;
Jason Wesselb33cb812008-05-28 12:49:57 -0500132static int force_hwbrks;
133static int hwbreaks_ok;
Jason Wessele8d31c22008-03-07 16:34:17 -0600134static int hw_break_val;
135static int hw_break_val2;
David S. Miller4d7ffa42008-04-29 01:36:14 -0700136#if defined(CONFIG_ARM) || defined(CONFIG_MIPS) || defined(CONFIG_SPARC)
Jason Wessele8d31c22008-03-07 16:34:17 -0600137static int arch_needs_sstep_emulation = 1;
138#else
139static int arch_needs_sstep_emulation;
140#endif
141static unsigned long sstep_addr;
142static int sstep_state;
143
144/* Storage for the registers, in GDB format. */
145static unsigned long kgdbts_gdb_regs[(NUMREGBYTES +
146 sizeof(unsigned long) - 1) /
147 sizeof(unsigned long)];
148static struct pt_regs kgdbts_regs;
149
150/* -1 = init not run yet, 0 = unconfigured, 1 = configured. */
151static int configured = -1;
152
Jason Wessel974460c2008-03-20 13:43:44 -0500153#ifdef CONFIG_KGDB_TESTS_BOOT_STRING
154static char config[MAX_CONFIG_LEN] = CONFIG_KGDB_TESTS_BOOT_STRING;
155#else
Jason Wessele8d31c22008-03-07 16:34:17 -0600156static char config[MAX_CONFIG_LEN];
Jason Wessel974460c2008-03-20 13:43:44 -0500157#endif
Jason Wessele8d31c22008-03-07 16:34:17 -0600158static struct kparam_string kps = {
159 .string = config,
160 .maxlen = MAX_CONFIG_LEN,
161};
162
163static void fill_get_buf(char *buf);
164
165struct test_struct {
166 char *get;
167 char *put;
168 void (*get_handler)(char *);
169 int (*put_handler)(char *, char *);
170};
171
172struct test_state {
173 char *name;
174 struct test_struct *tst;
175 int idx;
176 int (*run_test) (int, int);
177 int (*validate_put) (char *);
178};
179
180static struct test_state ts;
181
182static int kgdbts_unreg_thread(void *ptr)
183{
184 /* Wait until the tests are complete and then ungresiter the I/O
185 * driver.
186 */
187 while (!final_ack)
188 msleep_interruptible(1500);
189
190 if (configured)
191 kgdb_unregister_io_module(&kgdbts_io_ops);
192 configured = 0;
193
194 return 0;
195}
196
197/* This is noinline such that it can be used for a single location to
198 * place a breakpoint
199 */
200static noinline void kgdbts_break_test(void)
201{
202 v2printk("kgdbts: breakpoint complete\n");
203}
204
205/* Lookup symbol info in the kernel */
206static unsigned long lookup_addr(char *arg)
207{
208 unsigned long addr = 0;
209
210 if (!strcmp(arg, "kgdbts_break_test"))
211 addr = (unsigned long)kgdbts_break_test;
212 else if (!strcmp(arg, "sys_open"))
213 addr = (unsigned long)sys_open;
214 else if (!strcmp(arg, "do_fork"))
215 addr = (unsigned long)do_fork;
216 else if (!strcmp(arg, "hw_break_val"))
217 addr = (unsigned long)&hw_break_val;
218 return addr;
219}
220
221static void break_helper(char *bp_type, char *arg, unsigned long vaddr)
222{
223 unsigned long addr;
224
225 if (arg)
226 addr = lookup_addr(arg);
227 else
228 addr = vaddr;
229
230 sprintf(scratch_buf, "%s,%lx,%i", bp_type, addr,
231 BREAK_INSTR_SIZE);
232 fill_get_buf(scratch_buf);
233}
234
235static void sw_break(char *arg)
236{
Jason Wesselb33cb812008-05-28 12:49:57 -0500237 break_helper(force_hwbrks ? "Z1" : "Z0", arg, 0);
Jason Wessele8d31c22008-03-07 16:34:17 -0600238}
239
240static void sw_rem_break(char *arg)
241{
Jason Wesselb33cb812008-05-28 12:49:57 -0500242 break_helper(force_hwbrks ? "z1" : "z0", arg, 0);
Jason Wessele8d31c22008-03-07 16:34:17 -0600243}
244
245static void hw_break(char *arg)
246{
247 break_helper("Z1", arg, 0);
248}
249
250static void hw_rem_break(char *arg)
251{
252 break_helper("z1", arg, 0);
253}
254
255static void hw_write_break(char *arg)
256{
257 break_helper("Z2", arg, 0);
258}
259
260static void hw_rem_write_break(char *arg)
261{
262 break_helper("z2", arg, 0);
263}
264
265static void hw_access_break(char *arg)
266{
267 break_helper("Z4", arg, 0);
268}
269
270static void hw_rem_access_break(char *arg)
271{
272 break_helper("z4", arg, 0);
273}
274
275static void hw_break_val_access(void)
276{
277 hw_break_val2 = hw_break_val;
278}
279
280static void hw_break_val_write(void)
281{
282 hw_break_val++;
283}
284
285static int check_and_rewind_pc(char *put_str, char *arg)
286{
287 unsigned long addr = lookup_addr(arg);
Mike Frysinger63ab25e2011-05-26 16:25:45 -0700288 unsigned long ip;
Jason Wessele8d31c22008-03-07 16:34:17 -0600289 int offset = 0;
290
291 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
292 NUMREGBYTES);
293 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
Mike Frysinger63ab25e2011-05-26 16:25:45 -0700294 ip = instruction_pointer(&kgdbts_regs);
295 v2printk("Stopped at IP: %lx\n", ip);
296#ifdef GDB_ADJUSTS_BREAK_OFFSET
297 /* On some arches, a breakpoint stop requires it to be decremented */
298 if (addr + BREAK_INSTR_SIZE == ip)
299 offset = -BREAK_INSTR_SIZE;
Jason Wessele8d31c22008-03-07 16:34:17 -0600300#endif
Mike Frysinger63ab25e2011-05-26 16:25:45 -0700301 if (strcmp(arg, "silent") && ip + offset != addr) {
Jason Wessel974460c2008-03-20 13:43:44 -0500302 eprintk("kgdbts: BP mismatch %lx expected %lx\n",
Mike Frysinger63ab25e2011-05-26 16:25:45 -0700303 ip + offset, addr);
Jason Wessele8d31c22008-03-07 16:34:17 -0600304 return 1;
305 }
Mike Frysinger63ab25e2011-05-26 16:25:45 -0700306 /* Readjust the instruction pointer if needed */
Mike Frysinger603d04b2011-05-28 10:04:25 -0400307 ip += offset;
308#ifdef GDB_ADJUSTS_BREAK_OFFSET
309 instruction_pointer_set(&kgdbts_regs, ip);
310#endif
Jason Wessele8d31c22008-03-07 16:34:17 -0600311 return 0;
312}
313
314static int check_single_step(char *put_str, char *arg)
315{
316 unsigned long addr = lookup_addr(arg);
317 /*
318 * From an arch indepent point of view the instruction pointer
319 * should be on a different instruction
320 */
321 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
322 NUMREGBYTES);
323 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
324 v2printk("Singlestep stopped at IP: %lx\n",
325 instruction_pointer(&kgdbts_regs));
326 if (instruction_pointer(&kgdbts_regs) == addr) {
Jason Wessel974460c2008-03-20 13:43:44 -0500327 eprintk("kgdbts: SingleStep failed at %lx\n",
Jason Wessele8d31c22008-03-07 16:34:17 -0600328 instruction_pointer(&kgdbts_regs));
329 return 1;
330 }
331
332 return 0;
333}
334
335static void write_regs(char *arg)
336{
337 memset(scratch_buf, 0, sizeof(scratch_buf));
338 scratch_buf[0] = 'G';
339 pt_regs_to_gdb_regs(kgdbts_gdb_regs, &kgdbts_regs);
340 kgdb_mem2hex((char *)kgdbts_gdb_regs, &scratch_buf[1], NUMREGBYTES);
341 fill_get_buf(scratch_buf);
342}
343
344static void skip_back_repeat_test(char *arg)
345{
346 int go_back = simple_strtol(arg, NULL, 10);
347
348 repeat_test--;
349 if (repeat_test <= 0)
350 ts.idx++;
351 else
352 ts.idx -= go_back;
353 fill_get_buf(ts.tst[ts.idx].get);
354}
355
356static int got_break(char *put_str, char *arg)
357{
358 test_complete = 1;
359 if (!strncmp(put_str+1, arg, 2)) {
360 if (!strncmp(arg, "T0", 2))
361 test_complete = 2;
362 return 0;
363 }
364 return 1;
365}
366
367static void emul_sstep_get(char *arg)
368{
369 if (!arch_needs_sstep_emulation) {
370 fill_get_buf(arg);
371 return;
372 }
373 switch (sstep_state) {
374 case 0:
375 v2printk("Emulate single step\n");
376 /* Start by looking at the current PC */
377 fill_get_buf("g");
378 break;
379 case 1:
380 /* set breakpoint */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500381 break_helper("Z0", NULL, sstep_addr);
Jason Wessele8d31c22008-03-07 16:34:17 -0600382 break;
383 case 2:
384 /* Continue */
385 fill_get_buf("c");
386 break;
387 case 3:
388 /* Clear breakpoint */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500389 break_helper("z0", NULL, sstep_addr);
Jason Wessele8d31c22008-03-07 16:34:17 -0600390 break;
391 default:
Jason Wessel974460c2008-03-20 13:43:44 -0500392 eprintk("kgdbts: ERROR failed sstep get emulation\n");
Jason Wessele8d31c22008-03-07 16:34:17 -0600393 }
394 sstep_state++;
395}
396
397static int emul_sstep_put(char *put_str, char *arg)
398{
399 if (!arch_needs_sstep_emulation) {
400 if (!strncmp(put_str+1, arg, 2))
401 return 0;
402 return 1;
403 }
404 switch (sstep_state) {
405 case 1:
406 /* validate the "g" packet to get the IP */
407 kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs,
408 NUMREGBYTES);
409 gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs);
410 v2printk("Stopped at IP: %lx\n",
411 instruction_pointer(&kgdbts_regs));
412 /* Want to stop at IP + break instruction size by default */
413 sstep_addr = instruction_pointer(&kgdbts_regs) +
414 BREAK_INSTR_SIZE;
415 break;
416 case 2:
417 if (strncmp(put_str, "$OK", 3)) {
Jason Wessel974460c2008-03-20 13:43:44 -0500418 eprintk("kgdbts: failed sstep break set\n");
Jason Wessele8d31c22008-03-07 16:34:17 -0600419 return 1;
420 }
421 break;
422 case 3:
423 if (strncmp(put_str, "$T0", 3)) {
Jason Wessel974460c2008-03-20 13:43:44 -0500424 eprintk("kgdbts: failed continue sstep\n");
Jason Wessele8d31c22008-03-07 16:34:17 -0600425 return 1;
426 }
427 break;
428 case 4:
429 if (strncmp(put_str, "$OK", 3)) {
Jason Wessel974460c2008-03-20 13:43:44 -0500430 eprintk("kgdbts: failed sstep break unset\n");
Jason Wessele8d31c22008-03-07 16:34:17 -0600431 return 1;
432 }
433 /* Single step is complete so continue on! */
434 sstep_state = 0;
435 return 0;
436 default:
Jason Wessel974460c2008-03-20 13:43:44 -0500437 eprintk("kgdbts: ERROR failed sstep put emulation\n");
Jason Wessele8d31c22008-03-07 16:34:17 -0600438 }
439
440 /* Continue on the same test line until emulation is complete */
441 ts.idx--;
442 return 0;
443}
444
445static int final_ack_set(char *put_str, char *arg)
446{
447 if (strncmp(put_str+1, arg, 2))
448 return 1;
449 final_ack = 1;
450 return 0;
451}
452/*
453 * Test to plant a breakpoint and detach, which should clear out the
454 * breakpoint and restore the original instruction.
455 */
456static struct test_struct plant_and_detach_test[] = {
457 { "?", "S0*" }, /* Clear break points */
458 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
459 { "D", "OK" }, /* Detach */
460 { "", "" },
461};
462
463/*
464 * Simple test to write in a software breakpoint, check for the
465 * correct stop location and detach.
466 */
467static struct test_struct sw_breakpoint_test[] = {
468 { "?", "S0*" }, /* Clear break points */
469 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
470 { "c", "T0*", }, /* Continue */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500471 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
Jason Wessele8d31c22008-03-07 16:34:17 -0600472 { "write", "OK", write_regs },
473 { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */
474 { "D", "OK" }, /* Detach */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500475 { "D", "OK", NULL, got_break }, /* On success we made it here */
Jason Wessele8d31c22008-03-07 16:34:17 -0600476 { "", "" },
477};
478
479/*
480 * Test a known bad memory read location to test the fault handler and
481 * read bytes 1-8 at the bad address
482 */
483static struct test_struct bad_read_test[] = {
484 { "?", "S0*" }, /* Clear break points */
485 { "m0,1", "E*" }, /* read 1 byte at address 1 */
486 { "m0,2", "E*" }, /* read 1 byte at address 2 */
487 { "m0,3", "E*" }, /* read 1 byte at address 3 */
488 { "m0,4", "E*" }, /* read 1 byte at address 4 */
489 { "m0,5", "E*" }, /* read 1 byte at address 5 */
490 { "m0,6", "E*" }, /* read 1 byte at address 6 */
491 { "m0,7", "E*" }, /* read 1 byte at address 7 */
492 { "m0,8", "E*" }, /* read 1 byte at address 8 */
493 { "D", "OK" }, /* Detach which removes all breakpoints and continues */
494 { "", "" },
495};
496
497/*
498 * Test for hitting a breakpoint, remove it, single step, plant it
499 * again and detach.
500 */
501static struct test_struct singlestep_break_test[] = {
502 { "?", "S0*" }, /* Clear break points */
503 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
504 { "c", "T0*", }, /* Continue */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500505 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
Jason Wessele8d31c22008-03-07 16:34:17 -0600506 { "write", "OK", write_regs }, /* Write registers */
507 { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */
508 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500509 { "g", "kgdbts_break_test", NULL, check_single_step },
Jason Wessele8d31c22008-03-07 16:34:17 -0600510 { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */
511 { "c", "T0*", }, /* Continue */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500512 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
Jason Wessele8d31c22008-03-07 16:34:17 -0600513 { "write", "OK", write_regs }, /* Write registers */
514 { "D", "OK" }, /* Remove all breakpoints and continues */
515 { "", "" },
516};
517
518/*
519 * Test for hitting a breakpoint at do_fork for what ever the number
520 * of iterations required by the variable repeat_test.
521 */
522static struct test_struct do_fork_test[] = {
523 { "?", "S0*" }, /* Clear break points */
524 { "do_fork", "OK", sw_break, }, /* set sw breakpoint */
525 { "c", "T0*", }, /* Continue */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500526 { "g", "do_fork", NULL, check_and_rewind_pc }, /* check location */
Jason Wessele8d31c22008-03-07 16:34:17 -0600527 { "write", "OK", write_regs }, /* Write registers */
528 { "do_fork", "OK", sw_rem_break }, /*remove breakpoint */
529 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500530 { "g", "do_fork", NULL, check_single_step },
Jason Wessele8d31c22008-03-07 16:34:17 -0600531 { "do_fork", "OK", sw_break, }, /* set sw breakpoint */
532 { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500533 { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */
Jason Wessele8d31c22008-03-07 16:34:17 -0600534 { "", "" },
535};
536
537/* Test for hitting a breakpoint at sys_open for what ever the number
538 * of iterations required by the variable repeat_test.
539 */
540static struct test_struct sys_open_test[] = {
541 { "?", "S0*" }, /* Clear break points */
542 { "sys_open", "OK", sw_break, }, /* set sw breakpoint */
543 { "c", "T0*", }, /* Continue */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500544 { "g", "sys_open", NULL, check_and_rewind_pc }, /* check location */
Jason Wessele8d31c22008-03-07 16:34:17 -0600545 { "write", "OK", write_regs }, /* Write registers */
546 { "sys_open", "OK", sw_rem_break }, /*remove breakpoint */
547 { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500548 { "g", "sys_open", NULL, check_single_step },
Jason Wessele8d31c22008-03-07 16:34:17 -0600549 { "sys_open", "OK", sw_break, }, /* set sw breakpoint */
550 { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500551 { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */
Jason Wessele8d31c22008-03-07 16:34:17 -0600552 { "", "" },
553};
554
555/*
556 * Test for hitting a simple hw breakpoint
557 */
558static struct test_struct hw_breakpoint_test[] = {
559 { "?", "S0*" }, /* Clear break points */
560 { "kgdbts_break_test", "OK", hw_break, }, /* set hw breakpoint */
561 { "c", "T0*", }, /* Continue */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500562 { "g", "kgdbts_break_test", NULL, check_and_rewind_pc },
Jason Wessele8d31c22008-03-07 16:34:17 -0600563 { "write", "OK", write_regs },
564 { "kgdbts_break_test", "OK", hw_rem_break }, /*remove breakpoint */
565 { "D", "OK" }, /* Detach */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500566 { "D", "OK", NULL, got_break }, /* On success we made it here */
Jason Wessele8d31c22008-03-07 16:34:17 -0600567 { "", "" },
568};
569
570/*
571 * Test for hitting a hw write breakpoint
572 */
573static struct test_struct hw_write_break_test[] = {
574 { "?", "S0*" }, /* Clear break points */
575 { "hw_break_val", "OK", hw_write_break, }, /* set hw breakpoint */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500576 { "c", "T0*", NULL, got_break }, /* Continue */
577 { "g", "silent", NULL, check_and_rewind_pc },
Jason Wessele8d31c22008-03-07 16:34:17 -0600578 { "write", "OK", write_regs },
579 { "hw_break_val", "OK", hw_rem_write_break }, /*remove breakpoint */
580 { "D", "OK" }, /* Detach */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500581 { "D", "OK", NULL, got_break }, /* On success we made it here */
Jason Wessele8d31c22008-03-07 16:34:17 -0600582 { "", "" },
583};
584
585/*
586 * Test for hitting a hw access breakpoint
587 */
588static struct test_struct hw_access_break_test[] = {
589 { "?", "S0*" }, /* Clear break points */
590 { "hw_break_val", "OK", hw_access_break, }, /* set hw breakpoint */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500591 { "c", "T0*", NULL, got_break }, /* Continue */
592 { "g", "silent", NULL, check_and_rewind_pc },
Jason Wessele8d31c22008-03-07 16:34:17 -0600593 { "write", "OK", write_regs },
594 { "hw_break_val", "OK", hw_rem_access_break }, /*remove breakpoint */
595 { "D", "OK" }, /* Detach */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500596 { "D", "OK", NULL, got_break }, /* On success we made it here */
Jason Wessele8d31c22008-03-07 16:34:17 -0600597 { "", "" },
598};
599
600/*
601 * Test for hitting a hw access breakpoint
602 */
603static struct test_struct nmi_sleep_test[] = {
604 { "?", "S0*" }, /* Clear break points */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500605 { "c", "T0*", NULL, got_break }, /* Continue */
Jason Wessele8d31c22008-03-07 16:34:17 -0600606 { "D", "OK" }, /* Detach */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500607 { "D", "OK", NULL, got_break }, /* On success we made it here */
Jason Wessele8d31c22008-03-07 16:34:17 -0600608 { "", "" },
609};
610
611static void fill_get_buf(char *buf)
612{
613 unsigned char checksum = 0;
614 int count = 0;
615 char ch;
616
617 strcpy(get_buf, "$");
618 strcat(get_buf, buf);
619 while ((ch = buf[count])) {
620 checksum += ch;
621 count++;
622 }
623 strcat(get_buf, "#");
Harvey Harrison827e6092008-05-28 12:49:56 -0500624 get_buf[count + 2] = hex_asc_hi(checksum);
625 get_buf[count + 3] = hex_asc_lo(checksum);
Jason Wessele8d31c22008-03-07 16:34:17 -0600626 get_buf[count + 4] = '\0';
627 v2printk("get%i: %s\n", ts.idx, get_buf);
628}
629
630static int validate_simple_test(char *put_str)
631{
632 char *chk_str;
633
634 if (ts.tst[ts.idx].put_handler)
635 return ts.tst[ts.idx].put_handler(put_str,
636 ts.tst[ts.idx].put);
637
638 chk_str = ts.tst[ts.idx].put;
639 if (*put_str == '$')
640 put_str++;
641
642 while (*chk_str != '\0' && *put_str != '\0') {
643 /* If someone does a * to match the rest of the string, allow
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300644 * it, or stop if the received string is complete.
Jason Wessele8d31c22008-03-07 16:34:17 -0600645 */
646 if (*put_str == '#' || *chk_str == '*')
647 return 0;
648 if (*put_str != *chk_str)
649 return 1;
650
651 chk_str++;
652 put_str++;
653 }
654 if (*chk_str == '\0' && (*put_str == '\0' || *put_str == '#'))
655 return 0;
656
657 return 1;
658}
659
660static int run_simple_test(int is_get_char, int chr)
661{
662 int ret = 0;
663 if (is_get_char) {
664 /* Send an ACK on the get if a prior put completed and set the
665 * send ack variable
666 */
667 if (send_ack) {
668 send_ack = 0;
669 return '+';
670 }
671 /* On the first get char, fill the transmit buffer and then
672 * take from the get_string.
673 */
674 if (get_buf_cnt == 0) {
675 if (ts.tst[ts.idx].get_handler)
676 ts.tst[ts.idx].get_handler(ts.tst[ts.idx].get);
677 else
678 fill_get_buf(ts.tst[ts.idx].get);
679 }
680
681 if (get_buf[get_buf_cnt] == '\0') {
Jason Wessel974460c2008-03-20 13:43:44 -0500682 eprintk("kgdbts: ERROR GET: EOB on '%s' at %i\n",
Jason Wessele8d31c22008-03-07 16:34:17 -0600683 ts.name, ts.idx);
684 get_buf_cnt = 0;
685 fill_get_buf("D");
686 }
687 ret = get_buf[get_buf_cnt];
688 get_buf_cnt++;
689 return ret;
690 }
691
692 /* This callback is a put char which is when kgdb sends data to
693 * this I/O module.
694 */
695 if (ts.tst[ts.idx].get[0] == '\0' &&
696 ts.tst[ts.idx].put[0] == '\0') {
Jason Wessel974460c2008-03-20 13:43:44 -0500697 eprintk("kgdbts: ERROR: beyond end of test on"
Jason Wessele8d31c22008-03-07 16:34:17 -0600698 " '%s' line %i\n", ts.name, ts.idx);
699 return 0;
700 }
701
702 if (put_buf_cnt >= BUFMAX) {
Jason Wessel974460c2008-03-20 13:43:44 -0500703 eprintk("kgdbts: ERROR: put buffer overflow on"
Jason Wessele8d31c22008-03-07 16:34:17 -0600704 " '%s' line %i\n", ts.name, ts.idx);
705 put_buf_cnt = 0;
706 return 0;
707 }
708 /* Ignore everything until the first valid packet start '$' */
709 if (put_buf_cnt == 0 && chr != '$')
710 return 0;
711
712 put_buf[put_buf_cnt] = chr;
713 put_buf_cnt++;
714
715 /* End of packet == #XX so look for the '#' */
716 if (put_buf_cnt > 3 && put_buf[put_buf_cnt - 3] == '#') {
Roel Kluinb4f1b672009-12-11 08:43:15 -0600717 if (put_buf_cnt >= BUFMAX) {
718 eprintk("kgdbts: ERROR: put buffer overflow on"
719 " '%s' line %i\n", ts.name, ts.idx);
720 put_buf_cnt = 0;
721 return 0;
722 }
Jason Wessele8d31c22008-03-07 16:34:17 -0600723 put_buf[put_buf_cnt] = '\0';
724 v2printk("put%i: %s\n", ts.idx, put_buf);
725 /* Trigger check here */
726 if (ts.validate_put && ts.validate_put(put_buf)) {
Jason Wessel974460c2008-03-20 13:43:44 -0500727 eprintk("kgdbts: ERROR PUT: end of test "
Jason Wessele8d31c22008-03-07 16:34:17 -0600728 "buffer on '%s' line %i expected %s got %s\n",
729 ts.name, ts.idx, ts.tst[ts.idx].put, put_buf);
730 }
731 ts.idx++;
732 put_buf_cnt = 0;
733 get_buf_cnt = 0;
734 send_ack = 1;
735 }
736 return 0;
737}
738
739static void init_simple_test(void)
740{
741 memset(&ts, 0, sizeof(ts));
742 ts.run_test = run_simple_test;
743 ts.validate_put = validate_simple_test;
744}
745
746static void run_plant_and_detach_test(int is_early)
747{
748 char before[BREAK_INSTR_SIZE];
749 char after[BREAK_INSTR_SIZE];
750
751 probe_kernel_read(before, (char *)kgdbts_break_test,
752 BREAK_INSTR_SIZE);
753 init_simple_test();
754 ts.tst = plant_and_detach_test;
755 ts.name = "plant_and_detach_test";
756 /* Activate test with initial breakpoint */
757 if (!is_early)
758 kgdb_breakpoint();
759 probe_kernel_read(after, (char *)kgdbts_break_test,
760 BREAK_INSTR_SIZE);
761 if (memcmp(before, after, BREAK_INSTR_SIZE)) {
762 printk(KERN_CRIT "kgdbts: ERROR kgdb corrupted memory\n");
763 panic("kgdb memory corruption");
764 }
765
766 /* complete the detach test */
767 if (!is_early)
768 kgdbts_break_test();
769}
770
771static void run_breakpoint_test(int is_hw_breakpoint)
772{
773 test_complete = 0;
774 init_simple_test();
775 if (is_hw_breakpoint) {
776 ts.tst = hw_breakpoint_test;
777 ts.name = "hw_breakpoint_test";
778 } else {
779 ts.tst = sw_breakpoint_test;
780 ts.name = "sw_breakpoint_test";
781 }
782 /* Activate test with initial breakpoint */
783 kgdb_breakpoint();
784 /* run code with the break point in it */
785 kgdbts_break_test();
786 kgdb_breakpoint();
787
788 if (test_complete)
789 return;
790
Jason Wessel974460c2008-03-20 13:43:44 -0500791 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
Jason Wesselb33cb812008-05-28 12:49:57 -0500792 if (is_hw_breakpoint)
793 hwbreaks_ok = 0;
Jason Wessele8d31c22008-03-07 16:34:17 -0600794}
795
796static void run_hw_break_test(int is_write_test)
797{
798 test_complete = 0;
799 init_simple_test();
800 if (is_write_test) {
801 ts.tst = hw_write_break_test;
802 ts.name = "hw_write_break_test";
803 } else {
804 ts.tst = hw_access_break_test;
805 ts.name = "hw_access_break_test";
806 }
807 /* Activate test with initial breakpoint */
808 kgdb_breakpoint();
809 hw_break_val_access();
810 if (is_write_test) {
Jason Wesselb33cb812008-05-28 12:49:57 -0500811 if (test_complete == 2) {
Jason Wessel974460c2008-03-20 13:43:44 -0500812 eprintk("kgdbts: ERROR %s broke on access\n",
Jason Wessele8d31c22008-03-07 16:34:17 -0600813 ts.name);
Jason Wesselb33cb812008-05-28 12:49:57 -0500814 hwbreaks_ok = 0;
815 }
Jason Wessele8d31c22008-03-07 16:34:17 -0600816 hw_break_val_write();
817 }
818 kgdb_breakpoint();
819
820 if (test_complete == 1)
821 return;
822
Jason Wessel974460c2008-03-20 13:43:44 -0500823 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
Jason Wesselb33cb812008-05-28 12:49:57 -0500824 hwbreaks_ok = 0;
Jason Wessele8d31c22008-03-07 16:34:17 -0600825}
826
827static void run_nmi_sleep_test(int nmi_sleep)
828{
829 unsigned long flags;
830
831 init_simple_test();
832 ts.tst = nmi_sleep_test;
833 ts.name = "nmi_sleep_test";
834 /* Activate test with initial breakpoint */
835 kgdb_breakpoint();
836 local_irq_save(flags);
837 mdelay(nmi_sleep*1000);
838 touch_nmi_watchdog();
839 local_irq_restore(flags);
840 if (test_complete != 2)
Jason Wessel974460c2008-03-20 13:43:44 -0500841 eprintk("kgdbts: ERROR nmi_test did not hit nmi\n");
Jason Wessele8d31c22008-03-07 16:34:17 -0600842 kgdb_breakpoint();
843 if (test_complete == 1)
844 return;
845
Jason Wessel974460c2008-03-20 13:43:44 -0500846 eprintk("kgdbts: ERROR %s test failed\n", ts.name);
Jason Wessele8d31c22008-03-07 16:34:17 -0600847}
848
849static void run_bad_read_test(void)
850{
851 init_simple_test();
852 ts.tst = bad_read_test;
853 ts.name = "bad_read_test";
854 /* Activate test with initial breakpoint */
855 kgdb_breakpoint();
856}
857
858static void run_do_fork_test(void)
859{
860 init_simple_test();
861 ts.tst = do_fork_test;
862 ts.name = "do_fork_test";
863 /* Activate test with initial breakpoint */
864 kgdb_breakpoint();
865}
866
867static void run_sys_open_test(void)
868{
869 init_simple_test();
870 ts.tst = sys_open_test;
871 ts.name = "sys_open_test";
872 /* Activate test with initial breakpoint */
873 kgdb_breakpoint();
874}
875
876static void run_singlestep_break_test(void)
877{
878 init_simple_test();
879 ts.tst = singlestep_break_test;
880 ts.name = "singlestep_breakpoint_test";
881 /* Activate test with initial breakpoint */
882 kgdb_breakpoint();
883 kgdbts_break_test();
884 kgdbts_break_test();
885}
886
887static void kgdbts_run_tests(void)
888{
889 char *ptr;
890 int fork_test = 0;
Harvey Harrison001fddf2008-04-24 16:57:23 -0500891 int do_sys_open_test = 0;
Jason Wessel7cfcd982008-04-24 16:57:23 -0500892 int sstep_test = 1000;
Jason Wessele8d31c22008-03-07 16:34:17 -0600893 int nmi_sleep = 0;
Jason Wessel7cfcd982008-04-24 16:57:23 -0500894 int i;
Jason Wessele8d31c22008-03-07 16:34:17 -0600895
Geert Uytterhoeven59d309f2009-12-11 08:43:15 -0600896 ptr = strchr(config, 'F');
Jason Wessele8d31c22008-03-07 16:34:17 -0600897 if (ptr)
Harvey Harrison001fddf2008-04-24 16:57:23 -0500898 fork_test = simple_strtol(ptr + 1, NULL, 10);
Geert Uytterhoeven59d309f2009-12-11 08:43:15 -0600899 ptr = strchr(config, 'S');
Jason Wessele8d31c22008-03-07 16:34:17 -0600900 if (ptr)
Harvey Harrison001fddf2008-04-24 16:57:23 -0500901 do_sys_open_test = simple_strtol(ptr + 1, NULL, 10);
Geert Uytterhoeven59d309f2009-12-11 08:43:15 -0600902 ptr = strchr(config, 'N');
Jason Wessele8d31c22008-03-07 16:34:17 -0600903 if (ptr)
904 nmi_sleep = simple_strtol(ptr+1, NULL, 10);
Geert Uytterhoeven59d309f2009-12-11 08:43:15 -0600905 ptr = strchr(config, 'I');
Jason Wessel7cfcd982008-04-24 16:57:23 -0500906 if (ptr)
907 sstep_test = simple_strtol(ptr+1, NULL, 10);
Jason Wessele8d31c22008-03-07 16:34:17 -0600908
909 /* required internal KGDB tests */
910 v1printk("kgdbts:RUN plant and detach test\n");
911 run_plant_and_detach_test(0);
912 v1printk("kgdbts:RUN sw breakpoint test\n");
913 run_breakpoint_test(0);
914 v1printk("kgdbts:RUN bad memory access test\n");
915 run_bad_read_test();
Jason Wessel7cfcd982008-04-24 16:57:23 -0500916 v1printk("kgdbts:RUN singlestep test %i iterations\n", sstep_test);
917 for (i = 0; i < sstep_test; i++) {
918 run_singlestep_break_test();
919 if (i % 100 == 0)
920 v1printk("kgdbts:RUN singlestep [%i/%i]\n",
921 i, sstep_test);
922 }
Jason Wessele8d31c22008-03-07 16:34:17 -0600923
924 /* ===Optional tests=== */
925
926 /* All HW break point tests */
927 if (arch_kgdb_ops.flags & KGDB_HW_BREAKPOINT) {
Jason Wesselb33cb812008-05-28 12:49:57 -0500928 hwbreaks_ok = 1;
Jason Wessele8d31c22008-03-07 16:34:17 -0600929 v1printk("kgdbts:RUN hw breakpoint test\n");
930 run_breakpoint_test(1);
931 v1printk("kgdbts:RUN hw write breakpoint test\n");
932 run_hw_break_test(1);
933 v1printk("kgdbts:RUN access write breakpoint test\n");
934 run_hw_break_test(0);
935 }
936
937 if (nmi_sleep) {
938 v1printk("kgdbts:RUN NMI sleep %i seconds test\n", nmi_sleep);
939 run_nmi_sleep_test(nmi_sleep);
940 }
941
Jason Wesselb33cb812008-05-28 12:49:57 -0500942#ifdef CONFIG_DEBUG_RODATA
943 /* Until there is an api to write to read-only text segments, use
944 * HW breakpoints for the remainder of any tests, else print a
945 * failure message if hw breakpoints do not work.
946 */
947 if (!(arch_kgdb_ops.flags & KGDB_HW_BREAKPOINT && hwbreaks_ok)) {
948 eprintk("kgdbts: HW breakpoints do not work,"
949 "skipping remaining tests\n");
950 return;
951 }
952 force_hwbrks = 1;
953#endif /* CONFIG_DEBUG_RODATA */
954
Jason Wessele8d31c22008-03-07 16:34:17 -0600955 /* If the do_fork test is run it will be the last test that is
956 * executed because a kernel thread will be spawned at the very
957 * end to unregister the debug hooks.
958 */
959 if (fork_test) {
960 repeat_test = fork_test;
961 printk(KERN_INFO "kgdbts:RUN do_fork for %i breakpoints\n",
962 repeat_test);
Harvey Harrison001fddf2008-04-24 16:57:23 -0500963 kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg");
Jason Wessele8d31c22008-03-07 16:34:17 -0600964 run_do_fork_test();
965 return;
966 }
967
968 /* If the sys_open test is run it will be the last test that is
969 * executed because a kernel thread will be spawned at the very
970 * end to unregister the debug hooks.
971 */
Harvey Harrison001fddf2008-04-24 16:57:23 -0500972 if (do_sys_open_test) {
973 repeat_test = do_sys_open_test;
Jason Wessele8d31c22008-03-07 16:34:17 -0600974 printk(KERN_INFO "kgdbts:RUN sys_open for %i breakpoints\n",
975 repeat_test);
Harvey Harrison001fddf2008-04-24 16:57:23 -0500976 kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg");
Jason Wessele8d31c22008-03-07 16:34:17 -0600977 run_sys_open_test();
978 return;
979 }
980 /* Shutdown and unregister */
981 kgdb_unregister_io_module(&kgdbts_io_ops);
982 configured = 0;
983}
984
985static int kgdbts_option_setup(char *opt)
986{
Dan Carpenteradb4b832010-03-15 07:28:00 -0500987 if (strlen(opt) >= MAX_CONFIG_LEN) {
Jason Wessele8d31c22008-03-07 16:34:17 -0600988 printk(KERN_ERR "kgdbts: config string too long\n");
989 return -ENOSPC;
990 }
991 strcpy(config, opt);
992
993 verbose = 0;
994 if (strstr(config, "V1"))
995 verbose = 1;
996 if (strstr(config, "V2"))
997 verbose = 2;
998
999 return 0;
1000}
1001
1002__setup("kgdbts=", kgdbts_option_setup);
1003
1004static int configure_kgdbts(void)
1005{
1006 int err = 0;
1007
1008 if (!strlen(config) || isspace(config[0]))
1009 goto noconfig;
1010 err = kgdbts_option_setup(config);
1011 if (err)
1012 goto noconfig;
1013
1014 final_ack = 0;
1015 run_plant_and_detach_test(1);
1016
1017 err = kgdb_register_io_module(&kgdbts_io_ops);
1018 if (err) {
1019 configured = 0;
1020 return err;
1021 }
1022 configured = 1;
1023 kgdbts_run_tests();
1024
1025 return err;
1026
1027noconfig:
1028 config[0] = 0;
1029 configured = 0;
1030
1031 return err;
1032}
1033
1034static int __init init_kgdbts(void)
1035{
1036 /* Already configured? */
1037 if (configured == 1)
1038 return 0;
1039
1040 return configure_kgdbts();
1041}
1042
Jason Wessele8d31c22008-03-07 16:34:17 -06001043static int kgdbts_get_char(void)
1044{
1045 int val = 0;
1046
1047 if (ts.run_test)
1048 val = ts.run_test(1, 0);
1049
1050 return val;
1051}
1052
1053static void kgdbts_put_char(u8 chr)
1054{
1055 if (ts.run_test)
1056 ts.run_test(0, chr);
1057}
1058
1059static int param_set_kgdbts_var(const char *kmessage, struct kernel_param *kp)
1060{
1061 int len = strlen(kmessage);
1062
1063 if (len >= MAX_CONFIG_LEN) {
1064 printk(KERN_ERR "kgdbts: config string too long\n");
1065 return -ENOSPC;
1066 }
1067
1068 /* Only copy in the string if the init function has not run yet */
1069 if (configured < 0) {
1070 strcpy(config, kmessage);
1071 return 0;
1072 }
1073
Dongdong Deng4dacd5c2010-08-30 21:06:00 -05001074 if (configured == 1) {
1075 printk(KERN_ERR "kgdbts: ERROR: Already configured and running.\n");
Jason Wessele8d31c22008-03-07 16:34:17 -06001076 return -EBUSY;
1077 }
1078
1079 strcpy(config, kmessage);
1080 /* Chop out \n char as a result of echo */
1081 if (config[len - 1] == '\n')
1082 config[len - 1] = '\0';
1083
Jason Wessele8d31c22008-03-07 16:34:17 -06001084 /* Go and configure with the new params. */
1085 return configure_kgdbts();
1086}
1087
1088static void kgdbts_pre_exp_handler(void)
1089{
1090 /* Increment the module count when the debugger is active */
1091 if (!kgdb_connected)
1092 try_module_get(THIS_MODULE);
1093}
1094
1095static void kgdbts_post_exp_handler(void)
1096{
1097 /* decrement the module count when the debugger detaches */
1098 if (!kgdb_connected)
1099 module_put(THIS_MODULE);
1100}
1101
1102static struct kgdb_io kgdbts_io_ops = {
1103 .name = "kgdbts",
1104 .read_char = kgdbts_get_char,
1105 .write_char = kgdbts_put_char,
1106 .pre_exception = kgdbts_pre_exp_handler,
1107 .post_exception = kgdbts_post_exp_handler,
1108};
1109
1110module_init(init_kgdbts);
Jason Wessele8d31c22008-03-07 16:34:17 -06001111module_param_call(kgdbts, param_set_kgdbts_var, param_get_string, &kps, 0644);
1112MODULE_PARM_DESC(kgdbts, "<A|V1|V2>[F#|S#][N#]");
1113MODULE_DESCRIPTION("KGDB Test Suite");
1114MODULE_LICENSE("GPL");
1115MODULE_AUTHOR("Wind River Systems, Inc.");
1116