drivers/misc/kgdbts.c

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