drivers/misc/kgdbts.c

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