sys/kern/subr_kdb.c

   1 /*-
   2  * Copyright (c) 2004 The FreeBSD Project
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include "opt_kdb.h"
  31 #include "opt_stack.h"
  32
  33 #include <sys/param.h>
  34 #include <sys/systm.h>
  35 #include <sys/kdb.h>
  36 #include <sys/kernel.h>
  37 #include <sys/malloc.h>
  38 #include <sys/pcpu.h>
  39 #include <sys/proc.h>
  40 #include <sys/sbuf.h>
  41 #include <sys/smp.h>
  42 #include <sys/stack.h>
  43 #include <sys/sysctl.h>
  44
  45 #include <machine/kdb.h>
  46 #include <machine/pcb.h>
  47
  48 #ifdef SMP
  49 #include <machine/smp.h>
  50 #endif
  51
  52 int kdb_active = 0;
  53 static void *kdb_jmpbufp = NULL;
  54 struct kdb_dbbe *kdb_dbbe = NULL;
  55 static struct pcb kdb_pcb;
  56 struct pcb *kdb_thrctx = NULL;
  57 struct thread *kdb_thread = NULL;
  58 struct trapframe *kdb_frame = NULL;
  59
  60 KDB_BACKEND(null, NULL, NULL, NULL);
  61 SET_DECLARE(kdb_dbbe_set, struct kdb_dbbe);
  62
  63 static int kdb_sysctl_available(SYSCTL_HANDLER_ARGS);
  64 static int kdb_sysctl_current(SYSCTL_HANDLER_ARGS);
  65 static int kdb_sysctl_enter(SYSCTL_HANDLER_ARGS);
  66 static int kdb_sysctl_panic(SYSCTL_HANDLER_ARGS);
  67 static int kdb_sysctl_trap(SYSCTL_HANDLER_ARGS);
  68 static int kdb_sysctl_trap_code(SYSCTL_HANDLER_ARGS);
  69
  70 SYSCTL_NODE(_debug, OID_AUTO, kdb, CTLFLAG_RW, NULL, "KDB nodes");
  71
  72 SYSCTL_PROC(_debug_kdb, OID_AUTO, available, CTLTYPE_STRING | CTLFLAG_RD, NULL,
  73     0, kdb_sysctl_available, "A", "list of available KDB backends");
  74
  75 SYSCTL_PROC(_debug_kdb, OID_AUTO, current, CTLTYPE_STRING | CTLFLAG_RW, NULL,
  76     0, kdb_sysctl_current, "A", "currently selected KDB backend");
  77
  78 SYSCTL_PROC(_debug_kdb, OID_AUTO, enter, CTLTYPE_INT | CTLFLAG_RW, NULL, 0,
  79     kdb_sysctl_enter, "I", "set to enter the debugger");
  80
  81 SYSCTL_PROC(_debug_kdb, OID_AUTO, panic, CTLTYPE_INT | CTLFLAG_RW, NULL, 0,
  82     kdb_sysctl_panic, "I", "set to panic the kernel");
  83
  84 SYSCTL_PROC(_debug_kdb, OID_AUTO, trap, CTLTYPE_INT | CTLFLAG_RW, NULL, 0,
  85     kdb_sysctl_trap, "I", "set to cause a page fault via data access");
  86
  87 SYSCTL_PROC(_debug_kdb, OID_AUTO, trap_code, CTLTYPE_INT | CTLFLAG_RW, NULL, 0,
  88     kdb_sysctl_trap_code, "I", "set to cause a page fault via code access");
  89
  90 /*
  91  * Flag to indicate to debuggers why the debugger was entered.
  92  */
  93 const char * volatile kdb_why = KDB_WHY_UNSET;
  94
  95 static int
  96 kdb_sysctl_available(SYSCTL_HANDLER_ARGS)
  97 {
  98         struct kdb_dbbe **iter;
  99         struct sbuf sbuf;
 100         int error;
 101
 102         sbuf_new_for_sysctl(&sbuf, NULL, 64, req);
 103         SET_FOREACH(iter, kdb_dbbe_set) {
 104                 if ((*iter)->dbbe_active == 0)
 105                         sbuf_printf(&sbuf, "%s ", (*iter)->dbbe_name);
 106         }
 107         error = sbuf_finish(&sbuf);
 108         sbuf_delete(&sbuf);
 109         return (error);
 110 }
 111
 112 static int
 113 kdb_sysctl_current(SYSCTL_HANDLER_ARGS)
 114 {
 115         char buf[16];
 116         int error;
 117
 118         if (kdb_dbbe != NULL)
 119                 strlcpy(buf, kdb_dbbe->dbbe_name, sizeof(buf));
 120         else
 121                 *buf = '\0';
 122         error = sysctl_handle_string(oidp, buf, sizeof(buf), req);
 123         if (error != 0 || req->newptr == NULL)
 124                 return (error);
 125         if (kdb_active)
 126                 return (EBUSY);
 127         return (kdb_dbbe_select(buf));
 128 }
 129
 130 static int
 131 kdb_sysctl_enter(SYSCTL_HANDLER_ARGS)
 132 {
 133         int error, i;
 134
 135         error = sysctl_wire_old_buffer(req, sizeof(int));
 136         if (error == 0) {
 137                 i = 0;
 138                 error = sysctl_handle_int(oidp, &i, 0, req);
 139         }
 140         if (error != 0 || req->newptr == NULL)
 141                 return (error);
 142         if (kdb_active)
 143                 return (EBUSY);
 144         kdb_enter(KDB_WHY_SYSCTL, "sysctl debug.kdb.enter");
 145         return (0);
 146 }
 147
 148 static int
 149 kdb_sysctl_panic(SYSCTL_HANDLER_ARGS)
 150 {
 151         int error, i;
 152
 153         error = sysctl_wire_old_buffer(req, sizeof(int));
 154         if (error == 0) {
 155                 i = 0;
 156                 error = sysctl_handle_int(oidp, &i, 0, req);
 157         }
 158         if (error != 0 || req->newptr == NULL)
 159                 return (error);
 160         panic("kdb_sysctl_panic");
 161         return (0);
 162 }
 163
 164 static int
 165 kdb_sysctl_trap(SYSCTL_HANDLER_ARGS)
 166 {
 167         int error, i;
 168         int *addr = (int *)0x10;
 169
 170         error = sysctl_wire_old_buffer(req, sizeof(int));
 171         if (error == 0) {
 172                 i = 0;
 173                 error = sysctl_handle_int(oidp, &i, 0, req);
 174         }
 175         if (error != 0 || req->newptr == NULL)
 176                 return (error);
 177         return (*addr);
 178 }
 179
 180 static int
 181 kdb_sysctl_trap_code(SYSCTL_HANDLER_ARGS)
 182 {
 183         int error, i;
 184         void (*fp)(u_int, u_int, u_int) = (void *)0xdeadc0de;
 185
 186         error = sysctl_wire_old_buffer(req, sizeof(int));
 187         if (error == 0) {
 188                 i = 0;
 189                 error = sysctl_handle_int(oidp, &i, 0, req);
 190         }
 191         if (error != 0 || req->newptr == NULL)
 192                 return (error);
 193         (*fp)(0x11111111, 0x22222222, 0x33333333);
 194         return (0);
 195 }
 196
 197 void
 198 kdb_panic(const char *msg)
 199 {
 200 #ifdef SMP
 201         cpuset_t other_cpus;
 202
 203         other_cpus = all_cpus;
 204         CPU_CLR(PCPU_GET(cpuid), &other_cpus);
 205         stop_cpus_hard(other_cpus);
 206 #endif
 207         printf("KDB: panic\n");
 208         panic("%s", msg);
 209 }
 210
 211 void
 212 kdb_reboot(void)
 213 {
 214
 215         printf("KDB: reboot requested\n");
 216         shutdown_nice(0);
 217 }
 218
 219 /*
 220  * Solaris implements a new BREAK which is initiated by a character sequence
 221  * CR ~ ^b which is similar to a familiar pattern used on Sun servers by the
 222  * Remote Console.
 223  *
 224  * Note that this function may be called from almost anywhere, with interrupts
 225  * disabled and with unknown locks held, so it must not access data other than
 226  * its arguments.  Its up to the caller to ensure that the state variable is
 227  * consistent.
 228  */
 229
 230 #define KEY_CR          13      /* CR '\r' */
 231 #define KEY_TILDE       126     /* ~ */
 232 #define KEY_CRTLB       2       /* ^B */
 233 #define KEY_CRTLP       16      /* ^P */
 234 #define KEY_CRTLR       18      /* ^R */
 235
 236 /* States of th KDB "alternate break sequence" detecting state machine. */
 237 enum {
 238         KDB_ALT_BREAK_SEEN_NONE,
 239         KDB_ALT_BREAK_SEEN_CR,
 240         KDB_ALT_BREAK_SEEN_CR_TILDE,
 241 };
 242
 243 int
 244 kdb_alt_break(int key, int *state)
 245 {
 246         int brk;
 247
 248         /* All states transition to KDB_ALT_BREAK_SEEN_CR on a CR. */
 249         if (key == KEY_CR) {
 250                 *state = KDB_ALT_BREAK_SEEN_CR;
 251                 return (0);
 252         }
 253
 254         brk = 0;
 255         switch (*state) {
 256         case KDB_ALT_BREAK_SEEN_CR:
 257                 *state = KDB_ALT_BREAK_SEEN_NONE;
 258                 if (key == KEY_TILDE)
 259                         *state = KDB_ALT_BREAK_SEEN_CR_TILDE;
 260                 break;
 261         case KDB_ALT_BREAK_SEEN_CR_TILDE:
 262                 *state = KDB_ALT_BREAK_SEEN_NONE;
 263                 if (key == KEY_CRTLB)
 264                         brk = KDB_REQ_DEBUGGER;
 265                 else if (key == KEY_CRTLP)
 266                         brk = KDB_REQ_PANIC;
 267                 else if (key == KEY_CRTLR)
 268                         brk = KDB_REQ_REBOOT;
 269                 break;
 270         case KDB_ALT_BREAK_SEEN_NONE:
 271         default:
 272                 *state = KDB_ALT_BREAK_SEEN_NONE;
 273                 break;
 274         }
 275         return (brk);
 276 }
 277
 278 /*
 279  * Print a backtrace of the calling thread. The backtrace is generated by
 280  * the selected debugger, provided it supports backtraces. If no debugger
 281  * is selected or the current debugger does not support backtraces, this
 282  * function silently returns.
 283  */
 284
 285 void
 286 kdb_backtrace(void)
 287 {
 288
 289         if (kdb_dbbe != NULL && kdb_dbbe->dbbe_trace != NULL) {
 290                 printf("KDB: stack backtrace:\n");
 291                 kdb_dbbe->dbbe_trace();
 292         }
 293 #ifdef STACK
 294         else {
 295                 struct stack st;
 296
 297                 printf("KDB: stack backtrace:\n");
 298                 stack_save(&st);
 299                 stack_print_ddb(&st);
 300         }
 301 #endif
 302 }
 303
 304 /*
 305  * Set/change the current backend.
 306  */
 307
 308 int
 309 kdb_dbbe_select(const char *name)
 310 {
 311         struct kdb_dbbe *be, **iter;
 312
 313         SET_FOREACH(iter, kdb_dbbe_set) {
 314                 be = *iter;
 315                 if (be->dbbe_active == 0 && strcmp(be->dbbe_name, name) == 0) {
 316                         kdb_dbbe = be;
 317                         return (0);
 318                 }
 319         }
 320         return (EINVAL);
 321 }
 322
 323 /*
 324  * Enter the currently selected debugger. If a message has been provided,
 325  * it is printed first. If the debugger does not support the enter method,
 326  * it is entered by using breakpoint(), which enters the debugger through
 327  * kdb_trap().  The 'why' argument will contain a more mechanically usable
 328  * string than 'msg', and is relied upon by DDB scripting to identify the
 329  * reason for entering the debugger so that the right script can be run.
 330  */
 331 void
 332 kdb_enter(const char *why, const char *msg)
 333 {
 334
 335         if (kdb_dbbe != NULL && kdb_active == 0) {
 336                 if (msg != NULL)
 337                         printf("KDB: enter: %s\n", msg);
 338                 kdb_why = why;
 339                 breakpoint();
 340                 kdb_why = KDB_WHY_UNSET;
 341         }
 342 }
 343
 344 /*
 345  * Initialize the kernel debugger interface.
 346  */
 347
 348 void
 349 kdb_init(void)
 350 {
 351         struct kdb_dbbe *be, **iter;
 352         int cur_pri, pri;
 353
 354         kdb_active = 0;
 355         kdb_dbbe = NULL;
 356         cur_pri = -1;
 357         SET_FOREACH(iter, kdb_dbbe_set) {
 358                 be = *iter;
 359                 pri = (be->dbbe_init != NULL) ? be->dbbe_init() : -1;
 360                 be->dbbe_active = (pri >= 0) ? 0 : -1;
 361                 if (pri > cur_pri) {
 362                         cur_pri = pri;
 363                         kdb_dbbe = be;
 364                 }
 365         }
 366         if (kdb_dbbe != NULL) {
 367                 printf("KDB: debugger backends:");
 368                 SET_FOREACH(iter, kdb_dbbe_set) {
 369                         be = *iter;
 370                         if (be->dbbe_active == 0)
 371                                 printf(" %s", be->dbbe_name);
 372                 }
 373                 printf("\n");
 374                 printf("KDB: current backend: %s\n",
 375                     kdb_dbbe->dbbe_name);
 376         }
 377 }
 378
 379 /*
 380  * Handle contexts.
 381  */
 382
 383 void *
 384 kdb_jmpbuf(jmp_buf new)
 385 {
 386         void *old;
 387
 388         old = kdb_jmpbufp;
 389         kdb_jmpbufp = new;
 390         return (old);
 391 }
 392
 393 void
 394 kdb_reenter(void)
 395 {
 396
 397         if (!kdb_active || kdb_jmpbufp == NULL)
 398                 return;
 399
 400         longjmp(kdb_jmpbufp, 1);
 401         /* NOTREACHED */
 402 }
 403
 404 /*
 405  * Thread related support functions.
 406  */
 407
 408 struct pcb *
 409 kdb_thr_ctx(struct thread *thr)
 410 {
 411 #if defined(SMP) && defined(KDB_STOPPEDPCB)
 412         struct pcpu *pc;
 413 #endif
 414
 415         if (thr == curthread)
 416                 return (&kdb_pcb);
 417
 418 #if defined(SMP) && defined(KDB_STOPPEDPCB)
 419         STAILQ_FOREACH(pc, &cpuhead, pc_allcpu)  {
 420                 if (pc->pc_curthread == thr &&
 421                     CPU_ISSET(pc->pc_cpuid, &stopped_cpus))
 422                         return (KDB_STOPPEDPCB(pc));
 423         }
 424 #endif
 425         return (thr->td_pcb);
 426 }
 427
 428 struct thread *
 429 kdb_thr_first(void)
 430 {
 431         struct proc *p;
 432         struct thread *thr;
 433
 434         p = LIST_FIRST(&allproc);
 435         while (p != NULL) {
 436                 if (p->p_flag & P_INMEM) {
 437                         thr = FIRST_THREAD_IN_PROC(p);
 438                         if (thr != NULL)
 439                                 return (thr);
 440                 }
 441                 p = LIST_NEXT(p, p_list);
 442         }
 443         return (NULL);
 444 }
 445
 446 struct thread *
 447 kdb_thr_from_pid(pid_t pid)
 448 {
 449         struct proc *p;
 450
 451         p = LIST_FIRST(&allproc);
 452         while (p != NULL) {
 453                 if (p->p_flag & P_INMEM && p->p_pid == pid)
 454                         return (FIRST_THREAD_IN_PROC(p));
 455                 p = LIST_NEXT(p, p_list);
 456         }
 457         return (NULL);
 458 }
 459
 460 struct thread *
 461 kdb_thr_lookup(lwpid_t tid)
 462 {
 463         struct thread *thr;
 464
 465         thr = kdb_thr_first();
 466         while (thr != NULL && thr->td_tid != tid)
 467                 thr = kdb_thr_next(thr);
 468         return (thr);
 469 }
 470
 471 struct thread *
 472 kdb_thr_next(struct thread *thr)
 473 {
 474         struct proc *p;
 475
 476         p = thr->td_proc;
 477         thr = TAILQ_NEXT(thr, td_plist);
 478         do {
 479                 if (thr != NULL)
 480                         return (thr);
 481                 p = LIST_NEXT(p, p_list);
 482                 if (p != NULL && (p->p_flag & P_INMEM))
 483                         thr = FIRST_THREAD_IN_PROC(p);
 484         } while (p != NULL);
 485         return (NULL);
 486 }
 487
 488 int
 489 kdb_thr_select(struct thread *thr)
 490 {
 491         if (thr == NULL)
 492                 return (EINVAL);
 493         kdb_thread = thr;
 494         kdb_thrctx = kdb_thr_ctx(thr);
 495         return (0);
 496 }
 497
 498 /*
 499  * Enter the debugger due to a trap.
 500  */
 501
 502 int
 503 kdb_trap(int type, int code, struct trapframe *tf)
 504 {
 505 #ifdef SMP
 506         cpuset_t other_cpus;
 507 #endif
 508         struct kdb_dbbe *be;
 509         register_t intr;
 510         int handled;
 511
 512         be = kdb_dbbe;
 513         if (be == NULL || be->dbbe_trap == NULL)
 514                 return (0);
 515
 516         /* We reenter the debugger through kdb_reenter(). */
 517         if (kdb_active)
 518                 return (0);
 519
 520         intr = intr_disable();
 521
 522 #ifdef SMP
 523         other_cpus = all_cpus;
 524         CPU_CLR(PCPU_GET(cpuid), &other_cpus);
 525         stop_cpus_hard(other_cpus);
 526 #endif
 527
 528         kdb_active++;
 529
 530         kdb_frame = tf;
 531
 532         /* Let MD code do its thing first... */
 533         kdb_cpu_trap(type, code);
 534
 535         makectx(tf, &kdb_pcb);
 536         kdb_thr_select(curthread);
 537
 538         for (;;) {
 539                 handled = be->dbbe_trap(type, code);
 540                 if (be == kdb_dbbe)
 541                         break;
 542                 be = kdb_dbbe;
 543                 if (be == NULL || be->dbbe_trap == NULL)
 544                         break;
 545                 printf("Switching to %s back-end\n", be->dbbe_name);
 546         }
 547
 548         kdb_active--;
 549
 550 #ifdef SMP
 551         restart_cpus(stopped_cpus);
 552 #endif
 553
 554         intr_restore(intr);
 555
 556         return (handled);
 557 }