Root/
1 | /* |
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 |
50 | * I## = Run the single step test ## iterations |
51 | * |
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> |
105 | |
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) |
115 | #define eprintk(a...) do { \ |
116 | printk(KERN_ERR a); \ |
117 | WARN_ON(1); \ |
118 | } while (0) |
119 | #define MAX_CONFIG_LEN 40 |
120 | |
121 | static struct kgdb_io kgdbts_io_ops; |
122 | static char get_buf[BUFMAX]; |
123 | static int get_buf_cnt; |
124 | static char put_buf[BUFMAX]; |
125 | static int put_buf_cnt; |
126 | static char scratch_buf[BUFMAX]; |
127 | static int verbose; |
128 | static int repeat_test; |
129 | static int test_complete; |
130 | static int send_ack; |
131 | static int final_ack; |
132 | static int force_hwbrks; |
133 | static int hwbreaks_ok; |
134 | static int hw_break_val; |
135 | static int hw_break_val2; |
136 | #if defined(CONFIG_ARM) || defined(CONFIG_MIPS) || defined(CONFIG_SPARC) |
137 | static int arch_needs_sstep_emulation = 1; |
138 | #else |
139 | static int arch_needs_sstep_emulation; |
140 | #endif |
141 | static unsigned long sstep_addr; |
142 | static int sstep_state; |
143 | |
144 | /* Storage for the registers, in GDB format. */ |
145 | static unsigned long kgdbts_gdb_regs[(NUMREGBYTES + |
146 | sizeof(unsigned long) - 1) / |
147 | sizeof(unsigned long)]; |
148 | static struct pt_regs kgdbts_regs; |
149 | |
150 | /* -1 = init not run yet, 0 = unconfigured, 1 = configured. */ |
151 | static int configured = -1; |
152 | |
153 | #ifdef CONFIG_KGDB_TESTS_BOOT_STRING |
154 | static char config[MAX_CONFIG_LEN] = CONFIG_KGDB_TESTS_BOOT_STRING; |
155 | #else |
156 | static char config[MAX_CONFIG_LEN]; |
157 | #endif |
158 | static struct kparam_string kps = { |
159 | .string = config, |
160 | .maxlen = MAX_CONFIG_LEN, |
161 | }; |
162 | |
163 | static void fill_get_buf(char *buf); |
164 | |
165 | struct test_struct { |
166 | char *get; |
167 | char *put; |
168 | void (*get_handler)(char *); |
169 | int (*put_handler)(char *, char *); |
170 | }; |
171 | |
172 | struct 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 | |
180 | static struct test_state ts; |
181 | |
182 | static 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 | */ |
200 | static noinline void kgdbts_break_test(void) |
201 | { |
202 | v2printk("kgdbts: breakpoint complete\n"); |
203 | } |
204 | |
205 | /* Lookup symbol info in the kernel */ |
206 | static 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 | |
221 | static 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 | |
235 | static void sw_break(char *arg) |
236 | { |
237 | break_helper(force_hwbrks ? "Z1" : "Z0", arg, 0); |
238 | } |
239 | |
240 | static void sw_rem_break(char *arg) |
241 | { |
242 | break_helper(force_hwbrks ? "z1" : "z0", arg, 0); |
243 | } |
244 | |
245 | static void hw_break(char *arg) |
246 | { |
247 | break_helper("Z1", arg, 0); |
248 | } |
249 | |
250 | static void hw_rem_break(char *arg) |
251 | { |
252 | break_helper("z1", arg, 0); |
253 | } |
254 | |
255 | static void hw_write_break(char *arg) |
256 | { |
257 | break_helper("Z2", arg, 0); |
258 | } |
259 | |
260 | static void hw_rem_write_break(char *arg) |
261 | { |
262 | break_helper("z2", arg, 0); |
263 | } |
264 | |
265 | static void hw_access_break(char *arg) |
266 | { |
267 | break_helper("Z4", arg, 0); |
268 | } |
269 | |
270 | static void hw_rem_access_break(char *arg) |
271 | { |
272 | break_helper("z4", arg, 0); |
273 | } |
274 | |
275 | static void hw_break_val_access(void) |
276 | { |
277 | hw_break_val2 = hw_break_val; |
278 | } |
279 | |
280 | static void hw_break_val_write(void) |
281 | { |
282 | hw_break_val++; |
283 | } |
284 | |
285 | static int check_and_rewind_pc(char *put_str, char *arg) |
286 | { |
287 | unsigned long addr = lookup_addr(arg); |
288 | int offset = 0; |
289 | |
290 | kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs, |
291 | NUMREGBYTES); |
292 | gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs); |
293 | v2printk("Stopped at IP: %lx\n", instruction_pointer(&kgdbts_regs)); |
294 | #ifdef CONFIG_X86 |
295 | /* On x86 a breakpoint stop requires it to be decremented */ |
296 | if (addr + 1 == kgdbts_regs.ip) |
297 | offset = -1; |
298 | #endif |
299 | if (strcmp(arg, "silent") && |
300 | instruction_pointer(&kgdbts_regs) + offset != addr) { |
301 | eprintk("kgdbts: BP mismatch %lx expected %lx\n", |
302 | instruction_pointer(&kgdbts_regs) + offset, addr); |
303 | return 1; |
304 | } |
305 | #ifdef CONFIG_X86 |
306 | /* On x86 adjust the instruction pointer if needed */ |
307 | kgdbts_regs.ip += offset; |
308 | #endif |
309 | return 0; |
310 | } |
311 | |
312 | static int check_single_step(char *put_str, char *arg) |
313 | { |
314 | unsigned long addr = lookup_addr(arg); |
315 | /* |
316 | * From an arch indepent point of view the instruction pointer |
317 | * should be on a different instruction |
318 | */ |
319 | kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs, |
320 | NUMREGBYTES); |
321 | gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs); |
322 | v2printk("Singlestep stopped at IP: %lx\n", |
323 | instruction_pointer(&kgdbts_regs)); |
324 | if (instruction_pointer(&kgdbts_regs) == addr) { |
325 | eprintk("kgdbts: SingleStep failed at %lx\n", |
326 | instruction_pointer(&kgdbts_regs)); |
327 | return 1; |
328 | } |
329 | |
330 | return 0; |
331 | } |
332 | |
333 | static void write_regs(char *arg) |
334 | { |
335 | memset(scratch_buf, 0, sizeof(scratch_buf)); |
336 | scratch_buf[0] = 'G'; |
337 | pt_regs_to_gdb_regs(kgdbts_gdb_regs, &kgdbts_regs); |
338 | kgdb_mem2hex((char *)kgdbts_gdb_regs, &scratch_buf[1], NUMREGBYTES); |
339 | fill_get_buf(scratch_buf); |
340 | } |
341 | |
342 | static void skip_back_repeat_test(char *arg) |
343 | { |
344 | int go_back = simple_strtol(arg, NULL, 10); |
345 | |
346 | repeat_test--; |
347 | if (repeat_test <= 0) |
348 | ts.idx++; |
349 | else |
350 | ts.idx -= go_back; |
351 | fill_get_buf(ts.tst[ts.idx].get); |
352 | } |
353 | |
354 | static int got_break(char *put_str, char *arg) |
355 | { |
356 | test_complete = 1; |
357 | if (!strncmp(put_str+1, arg, 2)) { |
358 | if (!strncmp(arg, "T0", 2)) |
359 | test_complete = 2; |
360 | return 0; |
361 | } |
362 | return 1; |
363 | } |
364 | |
365 | static void emul_sstep_get(char *arg) |
366 | { |
367 | if (!arch_needs_sstep_emulation) { |
368 | fill_get_buf(arg); |
369 | return; |
370 | } |
371 | switch (sstep_state) { |
372 | case 0: |
373 | v2printk("Emulate single step\n"); |
374 | /* Start by looking at the current PC */ |
375 | fill_get_buf("g"); |
376 | break; |
377 | case 1: |
378 | /* set breakpoint */ |
379 | break_helper("Z0", NULL, sstep_addr); |
380 | break; |
381 | case 2: |
382 | /* Continue */ |
383 | fill_get_buf("c"); |
384 | break; |
385 | case 3: |
386 | /* Clear breakpoint */ |
387 | break_helper("z0", NULL, sstep_addr); |
388 | break; |
389 | default: |
390 | eprintk("kgdbts: ERROR failed sstep get emulation\n"); |
391 | } |
392 | sstep_state++; |
393 | } |
394 | |
395 | static int emul_sstep_put(char *put_str, char *arg) |
396 | { |
397 | if (!arch_needs_sstep_emulation) { |
398 | if (!strncmp(put_str+1, arg, 2)) |
399 | return 0; |
400 | return 1; |
401 | } |
402 | switch (sstep_state) { |
403 | case 1: |
404 | /* validate the "g" packet to get the IP */ |
405 | kgdb_hex2mem(&put_str[1], (char *)kgdbts_gdb_regs, |
406 | NUMREGBYTES); |
407 | gdb_regs_to_pt_regs(kgdbts_gdb_regs, &kgdbts_regs); |
408 | v2printk("Stopped at IP: %lx\n", |
409 | instruction_pointer(&kgdbts_regs)); |
410 | /* Want to stop at IP + break instruction size by default */ |
411 | sstep_addr = instruction_pointer(&kgdbts_regs) + |
412 | BREAK_INSTR_SIZE; |
413 | break; |
414 | case 2: |
415 | if (strncmp(put_str, "$OK", 3)) { |
416 | eprintk("kgdbts: failed sstep break set\n"); |
417 | return 1; |
418 | } |
419 | break; |
420 | case 3: |
421 | if (strncmp(put_str, "$T0", 3)) { |
422 | eprintk("kgdbts: failed continue sstep\n"); |
423 | return 1; |
424 | } |
425 | break; |
426 | case 4: |
427 | if (strncmp(put_str, "$OK", 3)) { |
428 | eprintk("kgdbts: failed sstep break unset\n"); |
429 | return 1; |
430 | } |
431 | /* Single step is complete so continue on! */ |
432 | sstep_state = 0; |
433 | return 0; |
434 | default: |
435 | eprintk("kgdbts: ERROR failed sstep put emulation\n"); |
436 | } |
437 | |
438 | /* Continue on the same test line until emulation is complete */ |
439 | ts.idx--; |
440 | return 0; |
441 | } |
442 | |
443 | static int final_ack_set(char *put_str, char *arg) |
444 | { |
445 | if (strncmp(put_str+1, arg, 2)) |
446 | return 1; |
447 | final_ack = 1; |
448 | return 0; |
449 | } |
450 | /* |
451 | * Test to plant a breakpoint and detach, which should clear out the |
452 | * breakpoint and restore the original instruction. |
453 | */ |
454 | static struct test_struct plant_and_detach_test[] = { |
455 | { "?", "S0*" }, /* Clear break points */ |
456 | { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */ |
457 | { "D", "OK" }, /* Detach */ |
458 | { "", "" }, |
459 | }; |
460 | |
461 | /* |
462 | * Simple test to write in a software breakpoint, check for the |
463 | * correct stop location and detach. |
464 | */ |
465 | static struct test_struct sw_breakpoint_test[] = { |
466 | { "?", "S0*" }, /* Clear break points */ |
467 | { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */ |
468 | { "c", "T0*", }, /* Continue */ |
469 | { "g", "kgdbts_break_test", NULL, check_and_rewind_pc }, |
470 | { "write", "OK", write_regs }, |
471 | { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */ |
472 | { "D", "OK" }, /* Detach */ |
473 | { "D", "OK", NULL, got_break }, /* On success we made it here */ |
474 | { "", "" }, |
475 | }; |
476 | |
477 | /* |
478 | * Test a known bad memory read location to test the fault handler and |
479 | * read bytes 1-8 at the bad address |
480 | */ |
481 | static struct test_struct bad_read_test[] = { |
482 | { "?", "S0*" }, /* Clear break points */ |
483 | { "m0,1", "E*" }, /* read 1 byte at address 1 */ |
484 | { "m0,2", "E*" }, /* read 1 byte at address 2 */ |
485 | { "m0,3", "E*" }, /* read 1 byte at address 3 */ |
486 | { "m0,4", "E*" }, /* read 1 byte at address 4 */ |
487 | { "m0,5", "E*" }, /* read 1 byte at address 5 */ |
488 | { "m0,6", "E*" }, /* read 1 byte at address 6 */ |
489 | { "m0,7", "E*" }, /* read 1 byte at address 7 */ |
490 | { "m0,8", "E*" }, /* read 1 byte at address 8 */ |
491 | { "D", "OK" }, /* Detach which removes all breakpoints and continues */ |
492 | { "", "" }, |
493 | }; |
494 | |
495 | /* |
496 | * Test for hitting a breakpoint, remove it, single step, plant it |
497 | * again and detach. |
498 | */ |
499 | static struct test_struct singlestep_break_test[] = { |
500 | { "?", "S0*" }, /* Clear break points */ |
501 | { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */ |
502 | { "c", "T0*", }, /* Continue */ |
503 | { "g", "kgdbts_break_test", NULL, check_and_rewind_pc }, |
504 | { "write", "OK", write_regs }, /* Write registers */ |
505 | { "kgdbts_break_test", "OK", sw_rem_break }, /*remove breakpoint */ |
506 | { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */ |
507 | { "g", "kgdbts_break_test", NULL, check_single_step }, |
508 | { "kgdbts_break_test", "OK", sw_break, }, /* set sw breakpoint */ |
509 | { "c", "T0*", }, /* Continue */ |
510 | { "g", "kgdbts_break_test", NULL, check_and_rewind_pc }, |
511 | { "write", "OK", write_regs }, /* Write registers */ |
512 | { "D", "OK" }, /* Remove all breakpoints and continues */ |
513 | { "", "" }, |
514 | }; |
515 | |
516 | /* |
517 | * Test for hitting a breakpoint at do_fork for what ever the number |
518 | * of iterations required by the variable repeat_test. |
519 | */ |
520 | static struct test_struct do_fork_test[] = { |
521 | { "?", "S0*" }, /* Clear break points */ |
522 | { "do_fork", "OK", sw_break, }, /* set sw breakpoint */ |
523 | { "c", "T0*", }, /* Continue */ |
524 | { "g", "do_fork", NULL, check_and_rewind_pc }, /* check location */ |
525 | { "write", "OK", write_regs }, /* Write registers */ |
526 | { "do_fork", "OK", sw_rem_break }, /*remove breakpoint */ |
527 | { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */ |
528 | { "g", "do_fork", NULL, check_single_step }, |
529 | { "do_fork", "OK", sw_break, }, /* set sw breakpoint */ |
530 | { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */ |
531 | { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */ |
532 | { "", "" }, |
533 | }; |
534 | |
535 | /* Test for hitting a breakpoint at sys_open for what ever the number |
536 | * of iterations required by the variable repeat_test. |
537 | */ |
538 | static struct test_struct sys_open_test[] = { |
539 | { "?", "S0*" }, /* Clear break points */ |
540 | { "sys_open", "OK", sw_break, }, /* set sw breakpoint */ |
541 | { "c", "T0*", }, /* Continue */ |
542 | { "g", "sys_open", NULL, check_and_rewind_pc }, /* check location */ |
543 | { "write", "OK", write_regs }, /* Write registers */ |
544 | { "sys_open", "OK", sw_rem_break }, /*remove breakpoint */ |
545 | { "s", "T0*", emul_sstep_get, emul_sstep_put }, /* Single step */ |
546 | { "g", "sys_open", NULL, check_single_step }, |
547 | { "sys_open", "OK", sw_break, }, /* set sw breakpoint */ |
548 | { "7", "T0*", skip_back_repeat_test }, /* Loop based on repeat_test */ |
549 | { "D", "OK", NULL, final_ack_set }, /* detach and unregister I/O */ |
550 | { "", "" }, |
551 | }; |
552 | |
553 | /* |
554 | * Test for hitting a simple hw breakpoint |
555 | */ |
556 | static struct test_struct hw_breakpoint_test[] = { |
557 | { "?", "S0*" }, /* Clear break points */ |
558 | { "kgdbts_break_test", "OK", hw_break, }, /* set hw breakpoint */ |
559 | { "c", "T0*", }, /* Continue */ |
560 | { "g", "kgdbts_break_test", NULL, check_and_rewind_pc }, |
561 | { "write", "OK", write_regs }, |
562 | { "kgdbts_break_test", "OK", hw_rem_break }, /*remove breakpoint */ |
563 | { "D", "OK" }, /* Detach */ |
564 | { "D", "OK", NULL, got_break }, /* On success we made it here */ |
565 | { "", "" }, |
566 | }; |
567 | |
568 | /* |
569 | * Test for hitting a hw write breakpoint |
570 | */ |
571 | static struct test_struct hw_write_break_test[] = { |
572 | { "?", "S0*" }, /* Clear break points */ |
573 | { "hw_break_val", "OK", hw_write_break, }, /* set hw breakpoint */ |
574 | { "c", "T0*", NULL, got_break }, /* Continue */ |
575 | { "g", "silent", NULL, check_and_rewind_pc }, |
576 | { "write", "OK", write_regs }, |
577 | { "hw_break_val", "OK", hw_rem_write_break }, /*remove breakpoint */ |
578 | { "D", "OK" }, /* Detach */ |
579 | { "D", "OK", NULL, got_break }, /* On success we made it here */ |
580 | { "", "" }, |
581 | }; |
582 | |
583 | /* |
584 | * Test for hitting a hw access breakpoint |
585 | */ |
586 | static struct test_struct hw_access_break_test[] = { |
587 | { "?", "S0*" }, /* Clear break points */ |
588 | { "hw_break_val", "OK", hw_access_break, }, /* set hw breakpoint */ |
589 | { "c", "T0*", NULL, got_break }, /* Continue */ |
590 | { "g", "silent", NULL, check_and_rewind_pc }, |
591 | { "write", "OK", write_regs }, |
592 | { "hw_break_val", "OK", hw_rem_access_break }, /*remove breakpoint */ |
593 | { "D", "OK" }, /* Detach */ |
594 | { "D", "OK", NULL, got_break }, /* On success we made it here */ |
595 | { "", "" }, |
596 | }; |
597 | |
598 | /* |
599 | * Test for hitting a hw access breakpoint |
600 | */ |
601 | static struct test_struct nmi_sleep_test[] = { |
602 | { "?", "S0*" }, /* Clear break points */ |
603 | { "c", "T0*", NULL, got_break }, /* Continue */ |
604 | { "D", "OK" }, /* Detach */ |
605 | { "D", "OK", NULL, got_break }, /* On success we made it here */ |
606 | { "", "" }, |
607 | }; |
608 | |
609 | static void fill_get_buf(char *buf) |
610 | { |
611 | unsigned char checksum = 0; |
612 | int count = 0; |
613 | char ch; |
614 | |
615 | strcpy(get_buf, "$"); |
616 | strcat(get_buf, buf); |
617 | while ((ch = buf[count])) { |
618 | checksum += ch; |
619 | count++; |
620 | } |
621 | strcat(get_buf, "#"); |
622 | get_buf[count + 2] = hex_asc_hi(checksum); |
623 | get_buf[count + 3] = hex_asc_lo(checksum); |
624 | get_buf[count + 4] = '\0'; |
625 | v2printk("get%i: %s\n", ts.idx, get_buf); |
626 | } |
627 | |
628 | static int validate_simple_test(char *put_str) |
629 | { |
630 | char *chk_str; |
631 | |
632 | if (ts.tst[ts.idx].put_handler) |
633 | return ts.tst[ts.idx].put_handler(put_str, |
634 | ts.tst[ts.idx].put); |
635 | |
636 | chk_str = ts.tst[ts.idx].put; |
637 | if (*put_str == '$') |
638 | put_str++; |
639 | |
640 | while (*chk_str != '\0' && *put_str != '\0') { |
641 | /* If someone does a * to match the rest of the string, allow |
642 | * it, or stop if the recieved string is complete. |
643 | */ |
644 | if (*put_str == '#' || *chk_str == '*') |
645 | return 0; |
646 | if (*put_str != *chk_str) |
647 | return 1; |
648 | |
649 | chk_str++; |
650 | put_str++; |
651 | } |
652 | if (*chk_str == '\0' && (*put_str == '\0' || *put_str == '#')) |
653 | return 0; |
654 | |
655 | return 1; |
656 | } |
657 | |
658 | static int run_simple_test(int is_get_char, int chr) |
659 | { |
660 | int ret = 0; |
661 | if (is_get_char) { |
662 | /* Send an ACK on the get if a prior put completed and set the |
663 | * send ack variable |
664 | */ |
665 | if (send_ack) { |
666 | send_ack = 0; |
667 | return '+'; |
668 | } |
669 | /* On the first get char, fill the transmit buffer and then |
670 | * take from the get_string. |
671 | */ |
672 | if (get_buf_cnt == 0) { |
673 | if (ts.tst[ts.idx].get_handler) |
674 | ts.tst[ts.idx].get_handler(ts.tst[ts.idx].get); |
675 | else |
676 | fill_get_buf(ts.tst[ts.idx].get); |
677 | } |
678 | |
679 | if (get_buf[get_buf_cnt] == '\0') { |
680 | eprintk("kgdbts: ERROR GET: EOB on '%s' at %i\n", |
681 | ts.name, ts.idx); |
682 | get_buf_cnt = 0; |
683 | fill_get_buf("D"); |
684 | } |
685 | ret = get_buf[get_buf_cnt]; |
686 | get_buf_cnt++; |
687 | return ret; |
688 | } |
689 | |
690 | /* This callback is a put char which is when kgdb sends data to |
691 | * this I/O module. |
692 | */ |
693 | if (ts.tst[ts.idx].get[0] == '\0' && |
694 | ts.tst[ts.idx].put[0] == '\0') { |
695 | eprintk("kgdbts: ERROR: beyond end of test on" |
696 | " '%s' line %i\n", ts.name, ts.idx); |
697 | return 0; |
698 | } |
699 | |
700 | if (put_buf_cnt >= BUFMAX) { |
701 | eprintk("kgdbts: ERROR: put buffer overflow on" |
702 | " '%s' line %i\n", ts.name, ts.idx); |
703 | put_buf_cnt = 0; |
704 | return 0; |
705 | } |
706 | /* Ignore everything until the first valid packet start '$' */ |
707 | if (put_buf_cnt == 0 && chr != '$') |
708 | return 0; |
709 | |
710 | put_buf[put_buf_cnt] = chr; |
711 | put_buf_cnt++; |
712 | |
713 | /* End of packet == #XX so look for the '#' */ |
714 | if (put_buf_cnt > 3 && put_buf[put_buf_cnt - 3] == '#') { |
715 | put_buf[put_buf_cnt] = '\0'; |
716 | v2printk("put%i: %s\n", ts.idx, put_buf); |
717 | /* Trigger check here */ |
718 | if (ts.validate_put && ts.validate_put(put_buf)) { |
719 | eprintk("kgdbts: ERROR PUT: end of test " |
720 | "buffer on '%s' line %i expected %s got %s\n", |
721 | ts.name, ts.idx, ts.tst[ts.idx].put, put_buf); |
722 | } |
723 | ts.idx++; |
724 | put_buf_cnt = 0; |
725 | get_buf_cnt = 0; |
726 | send_ack = 1; |
727 | } |
728 | return 0; |
729 | } |
730 | |
731 | static void init_simple_test(void) |
732 | { |
733 | memset(&ts, 0, sizeof(ts)); |
734 | ts.run_test = run_simple_test; |
735 | ts.validate_put = validate_simple_test; |
736 | } |
737 | |
738 | static void run_plant_and_detach_test(int is_early) |
739 | { |
740 | char before[BREAK_INSTR_SIZE]; |
741 | char after[BREAK_INSTR_SIZE]; |
742 | |
743 | probe_kernel_read(before, (char *)kgdbts_break_test, |
744 | BREAK_INSTR_SIZE); |
745 | init_simple_test(); |
746 | ts.tst = plant_and_detach_test; |
747 | ts.name = "plant_and_detach_test"; |
748 | /* Activate test with initial breakpoint */ |
749 | if (!is_early) |
750 | kgdb_breakpoint(); |
751 | probe_kernel_read(after, (char *)kgdbts_break_test, |
752 | BREAK_INSTR_SIZE); |
753 | if (memcmp(before, after, BREAK_INSTR_SIZE)) { |
754 | printk(KERN_CRIT "kgdbts: ERROR kgdb corrupted memory\n"); |
755 | panic("kgdb memory corruption"); |
756 | } |
757 | |
758 | /* complete the detach test */ |
759 | if (!is_early) |
760 | kgdbts_break_test(); |
761 | } |
762 | |
763 | static void run_breakpoint_test(int is_hw_breakpoint) |
764 | { |
765 | test_complete = 0; |
766 | init_simple_test(); |
767 | if (is_hw_breakpoint) { |
768 | ts.tst = hw_breakpoint_test; |
769 | ts.name = "hw_breakpoint_test"; |
770 | } else { |
771 | ts.tst = sw_breakpoint_test; |
772 | ts.name = "sw_breakpoint_test"; |
773 | } |
774 | /* Activate test with initial breakpoint */ |
775 | kgdb_breakpoint(); |
776 | /* run code with the break point in it */ |
777 | kgdbts_break_test(); |
778 | kgdb_breakpoint(); |
779 | |
780 | if (test_complete) |
781 | return; |
782 | |
783 | eprintk("kgdbts: ERROR %s test failed\n", ts.name); |
784 | if (is_hw_breakpoint) |
785 | hwbreaks_ok = 0; |
786 | } |
787 | |
788 | static void run_hw_break_test(int is_write_test) |
789 | { |
790 | test_complete = 0; |
791 | init_simple_test(); |
792 | if (is_write_test) { |
793 | ts.tst = hw_write_break_test; |
794 | ts.name = "hw_write_break_test"; |
795 | } else { |
796 | ts.tst = hw_access_break_test; |
797 | ts.name = "hw_access_break_test"; |
798 | } |
799 | /* Activate test with initial breakpoint */ |
800 | kgdb_breakpoint(); |
801 | hw_break_val_access(); |
802 | if (is_write_test) { |
803 | if (test_complete == 2) { |
804 | eprintk("kgdbts: ERROR %s broke on access\n", |
805 | ts.name); |
806 | hwbreaks_ok = 0; |
807 | } |
808 | hw_break_val_write(); |
809 | } |
810 | kgdb_breakpoint(); |
811 | |
812 | if (test_complete == 1) |
813 | return; |
814 | |
815 | eprintk("kgdbts: ERROR %s test failed\n", ts.name); |
816 | hwbreaks_ok = 0; |
817 | } |
818 | |
819 | static void run_nmi_sleep_test(int nmi_sleep) |
820 | { |
821 | unsigned long flags; |
822 | |
823 | init_simple_test(); |
824 | ts.tst = nmi_sleep_test; |
825 | ts.name = "nmi_sleep_test"; |
826 | /* Activate test with initial breakpoint */ |
827 | kgdb_breakpoint(); |
828 | local_irq_save(flags); |
829 | mdelay(nmi_sleep*1000); |
830 | touch_nmi_watchdog(); |
831 | local_irq_restore(flags); |
832 | if (test_complete != 2) |
833 | eprintk("kgdbts: ERROR nmi_test did not hit nmi\n"); |
834 | kgdb_breakpoint(); |
835 | if (test_complete == 1) |
836 | return; |
837 | |
838 | eprintk("kgdbts: ERROR %s test failed\n", ts.name); |
839 | } |
840 | |
841 | static void run_bad_read_test(void) |
842 | { |
843 | init_simple_test(); |
844 | ts.tst = bad_read_test; |
845 | ts.name = "bad_read_test"; |
846 | /* Activate test with initial breakpoint */ |
847 | kgdb_breakpoint(); |
848 | } |
849 | |
850 | static void run_do_fork_test(void) |
851 | { |
852 | init_simple_test(); |
853 | ts.tst = do_fork_test; |
854 | ts.name = "do_fork_test"; |
855 | /* Activate test with initial breakpoint */ |
856 | kgdb_breakpoint(); |
857 | } |
858 | |
859 | static void run_sys_open_test(void) |
860 | { |
861 | init_simple_test(); |
862 | ts.tst = sys_open_test; |
863 | ts.name = "sys_open_test"; |
864 | /* Activate test with initial breakpoint */ |
865 | kgdb_breakpoint(); |
866 | } |
867 | |
868 | static void run_singlestep_break_test(void) |
869 | { |
870 | init_simple_test(); |
871 | ts.tst = singlestep_break_test; |
872 | ts.name = "singlestep_breakpoint_test"; |
873 | /* Activate test with initial breakpoint */ |
874 | kgdb_breakpoint(); |
875 | kgdbts_break_test(); |
876 | kgdbts_break_test(); |
877 | } |
878 | |
879 | static void kgdbts_run_tests(void) |
880 | { |
881 | char *ptr; |
882 | int fork_test = 0; |
883 | int do_sys_open_test = 0; |
884 | int sstep_test = 1000; |
885 | int nmi_sleep = 0; |
886 | int i; |
887 | |
888 | ptr = strstr(config, "F"); |
889 | if (ptr) |
890 | fork_test = simple_strtol(ptr + 1, NULL, 10); |
891 | ptr = strstr(config, "S"); |
892 | if (ptr) |
893 | do_sys_open_test = simple_strtol(ptr + 1, NULL, 10); |
894 | ptr = strstr(config, "N"); |
895 | if (ptr) |
896 | nmi_sleep = simple_strtol(ptr+1, NULL, 10); |
897 | ptr = strstr(config, "I"); |
898 | if (ptr) |
899 | sstep_test = simple_strtol(ptr+1, NULL, 10); |
900 | |
901 | /* required internal KGDB tests */ |
902 | v1printk("kgdbts:RUN plant and detach test\n"); |
903 | run_plant_and_detach_test(0); |
904 | v1printk("kgdbts:RUN sw breakpoint test\n"); |
905 | run_breakpoint_test(0); |
906 | v1printk("kgdbts:RUN bad memory access test\n"); |
907 | run_bad_read_test(); |
908 | v1printk("kgdbts:RUN singlestep test %i iterations\n", sstep_test); |
909 | for (i = 0; i < sstep_test; i++) { |
910 | run_singlestep_break_test(); |
911 | if (i % 100 == 0) |
912 | v1printk("kgdbts:RUN singlestep [%i/%i]\n", |
913 | i, sstep_test); |
914 | } |
915 | |
916 | /* ===Optional tests=== */ |
917 | |
918 | /* All HW break point tests */ |
919 | if (arch_kgdb_ops.flags & KGDB_HW_BREAKPOINT) { |
920 | hwbreaks_ok = 1; |
921 | v1printk("kgdbts:RUN hw breakpoint test\n"); |
922 | run_breakpoint_test(1); |
923 | v1printk("kgdbts:RUN hw write breakpoint test\n"); |
924 | run_hw_break_test(1); |
925 | v1printk("kgdbts:RUN access write breakpoint test\n"); |
926 | run_hw_break_test(0); |
927 | } |
928 | |
929 | if (nmi_sleep) { |
930 | v1printk("kgdbts:RUN NMI sleep %i seconds test\n", nmi_sleep); |
931 | run_nmi_sleep_test(nmi_sleep); |
932 | } |
933 | |
934 | #ifdef CONFIG_DEBUG_RODATA |
935 | /* Until there is an api to write to read-only text segments, use |
936 | * HW breakpoints for the remainder of any tests, else print a |
937 | * failure message if hw breakpoints do not work. |
938 | */ |
939 | if (!(arch_kgdb_ops.flags & KGDB_HW_BREAKPOINT && hwbreaks_ok)) { |
940 | eprintk("kgdbts: HW breakpoints do not work," |
941 | "skipping remaining tests\n"); |
942 | return; |
943 | } |
944 | force_hwbrks = 1; |
945 | #endif /* CONFIG_DEBUG_RODATA */ |
946 | |
947 | /* If the do_fork test is run it will be the last test that is |
948 | * executed because a kernel thread will be spawned at the very |
949 | * end to unregister the debug hooks. |
950 | */ |
951 | if (fork_test) { |
952 | repeat_test = fork_test; |
953 | printk(KERN_INFO "kgdbts:RUN do_fork for %i breakpoints\n", |
954 | repeat_test); |
955 | kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg"); |
956 | run_do_fork_test(); |
957 | return; |
958 | } |
959 | |
960 | /* If the sys_open test is run it will be the last test that is |
961 | * executed because a kernel thread will be spawned at the very |
962 | * end to unregister the debug hooks. |
963 | */ |
964 | if (do_sys_open_test) { |
965 | repeat_test = do_sys_open_test; |
966 | printk(KERN_INFO "kgdbts:RUN sys_open for %i breakpoints\n", |
967 | repeat_test); |
968 | kthread_run(kgdbts_unreg_thread, NULL, "kgdbts_unreg"); |
969 | run_sys_open_test(); |
970 | return; |
971 | } |
972 | /* Shutdown and unregister */ |
973 | kgdb_unregister_io_module(&kgdbts_io_ops); |
974 | configured = 0; |
975 | } |
976 | |
977 | static int kgdbts_option_setup(char *opt) |
978 | { |
979 | if (strlen(opt) > MAX_CONFIG_LEN) { |
980 | printk(KERN_ERR "kgdbts: config string too long\n"); |
981 | return -ENOSPC; |
982 | } |
983 | strcpy(config, opt); |
984 | |
985 | verbose = 0; |
986 | if (strstr(config, "V1")) |
987 | verbose = 1; |
988 | if (strstr(config, "V2")) |
989 | verbose = 2; |
990 | |
991 | return 0; |
992 | } |
993 | |
994 | __setup("kgdbts=", kgdbts_option_setup); |
995 | |
996 | static int configure_kgdbts(void) |
997 | { |
998 | int err = 0; |
999 | |
1000 | if (!strlen(config) || isspace(config[0])) |
1001 | goto noconfig; |
1002 | err = kgdbts_option_setup(config); |
1003 | if (err) |
1004 | goto noconfig; |
1005 | |
1006 | final_ack = 0; |
1007 | run_plant_and_detach_test(1); |
1008 | |
1009 | err = kgdb_register_io_module(&kgdbts_io_ops); |
1010 | if (err) { |
1011 | configured = 0; |
1012 | return err; |
1013 | } |
1014 | configured = 1; |
1015 | kgdbts_run_tests(); |
1016 | |
1017 | return err; |
1018 | |
1019 | noconfig: |
1020 | config[0] = 0; |
1021 | configured = 0; |
1022 | |
1023 | return err; |
1024 | } |
1025 | |
1026 | static int __init init_kgdbts(void) |
1027 | { |
1028 | /* Already configured? */ |
1029 | if (configured == 1) |
1030 | return 0; |
1031 | |
1032 | return configure_kgdbts(); |
1033 | } |
1034 | |
1035 | static void cleanup_kgdbts(void) |
1036 | { |
1037 | if (configured == 1) |
1038 | kgdb_unregister_io_module(&kgdbts_io_ops); |
1039 | } |
1040 | |
1041 | static int kgdbts_get_char(void) |
1042 | { |
1043 | int val = 0; |
1044 | |
1045 | if (ts.run_test) |
1046 | val = ts.run_test(1, 0); |
1047 | |
1048 | return val; |
1049 | } |
1050 | |
1051 | static void kgdbts_put_char(u8 chr) |
1052 | { |
1053 | if (ts.run_test) |
1054 | ts.run_test(0, chr); |
1055 | } |
1056 | |
1057 | static int param_set_kgdbts_var(const char *kmessage, struct kernel_param *kp) |
1058 | { |
1059 | int len = strlen(kmessage); |
1060 | |
1061 | if (len >= MAX_CONFIG_LEN) { |
1062 | printk(KERN_ERR "kgdbts: config string too long\n"); |
1063 | return -ENOSPC; |
1064 | } |
1065 | |
1066 | /* Only copy in the string if the init function has not run yet */ |
1067 | if (configured < 0) { |
1068 | strcpy(config, kmessage); |
1069 | return 0; |
1070 | } |
1071 | |
1072 | if (kgdb_connected) { |
1073 | printk(KERN_ERR |
1074 | "kgdbts: Cannot reconfigure while KGDB is connected.\n"); |
1075 | |
1076 | 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 | |
1084 | if (configured == 1) |
1085 | cleanup_kgdbts(); |
1086 | |
1087 | /* Go and configure with the new params. */ |
1088 | return configure_kgdbts(); |
1089 | } |
1090 | |
1091 | static void kgdbts_pre_exp_handler(void) |
1092 | { |
1093 | /* Increment the module count when the debugger is active */ |
1094 | if (!kgdb_connected) |
1095 | try_module_get(THIS_MODULE); |
1096 | } |
1097 | |
1098 | static void kgdbts_post_exp_handler(void) |
1099 | { |
1100 | /* decrement the module count when the debugger detaches */ |
1101 | if (!kgdb_connected) |
1102 | module_put(THIS_MODULE); |
1103 | } |
1104 | |
1105 | static struct kgdb_io kgdbts_io_ops = { |
1106 | .name = "kgdbts", |
1107 | .read_char = kgdbts_get_char, |
1108 | .write_char = kgdbts_put_char, |
1109 | .pre_exception = kgdbts_pre_exp_handler, |
1110 | .post_exception = kgdbts_post_exp_handler, |
1111 | }; |
1112 | |
1113 | module_init(init_kgdbts); |
1114 | module_exit(cleanup_kgdbts); |
1115 | module_param_call(kgdbts, param_set_kgdbts_var, param_get_string, &kps, 0644); |
1116 | MODULE_PARM_DESC(kgdbts, "<A|V1|V2>[F#|S#][N#]"); |
1117 | MODULE_DESCRIPTION("KGDB Test Suite"); |
1118 | MODULE_LICENSE("GPL"); |
1119 | MODULE_AUTHOR("Wind River Systems, Inc."); |
1120 | |
1121 |
Branches:
ben-wpan
ben-wpan-stefan
javiroman/ks7010
jz-2.6.34
jz-2.6.34-rc5
jz-2.6.34-rc6
jz-2.6.34-rc7
jz-2.6.35
jz-2.6.36
jz-2.6.37
jz-2.6.38
jz-2.6.39
jz-3.0
jz-3.1
jz-3.11
jz-3.12
jz-3.13
jz-3.15
jz-3.16
jz-3.18-dt
jz-3.2
jz-3.3
jz-3.4
jz-3.5
jz-3.6
jz-3.6-rc2-pwm
jz-3.9
jz-3.9-clk
jz-3.9-rc8
jz47xx
jz47xx-2.6.38
master
Tags:
od-2011-09-04
od-2011-09-18
v2.6.34-rc5
v2.6.34-rc6
v2.6.34-rc7
v3.9