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