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 indicating whether or not to IPI the other CPUs to stop them on
  92  * entering the debugger.  Sometimes, this will result in a deadlock as
  93  * stop_cpus() waits for the other cpus to stop, so we allow it to be
  94  * disabled.  In order to maximize the chances of success, use a hard
  95  * stop for that.
  96  */
  97 #ifdef SMP
  98 static int kdb_stop_cpus = 1;
  99 SYSCTL_INT(_debug_kdb, OID_AUTO, stop_cpus, CTLFLAG_RW | CTLFLAG_TUN,
 100     &kdb_stop_cpus, 0, "stop other CPUs when entering the debugger");
 101 TUNABLE_INT("debug.kdb.stop_cpus", &kdb_stop_cpus);
 102 #endif
 103
 104 /*
 105  * Flag to indicate to debuggers why the debugger was entered.
 106  */
 107 const char * volatile kdb_why = KDB_WHY_UNSET;
 108
 109 static int
 110 kdb_sysctl_available(SYSCTL_HANDLER_ARGS)
 111 {
 112         struct kdb_dbbe **iter;
 113         struct sbuf sbuf;
 114         int error;
 115
 116         sbuf_new_for_sysctl(&sbuf, NULL, 64, req);
 117         SET_FOREACH(iter, kdb_dbbe_set) {
 118                 if ((*iter)->dbbe_active == 0)
 119                         sbuf_printf(&sbuf, "%s ", (*iter)->dbbe_name);
 120         }
 121         error = sbuf_finish(&sbuf);
 122         sbuf_delete(&sbuf);
 123         return (error);
 124 }
 125
 126 static int
 127 kdb_sysctl_current(SYSCTL_HANDLER_ARGS)
 128 {
 129         char buf[16];
 130         int error;
 131
 132         if (kdb_dbbe != NULL)
 133                 strlcpy(buf, kdb_dbbe->dbbe_name, sizeof(buf));
 134         else
 135                 *buf = '\0';
 136         error = sysctl_handle_string(oidp, buf, sizeof(buf), req);
 137         if (error != 0 || req->newptr == NULL)
 138                 return (error);
 139         if (kdb_active)
 140                 return (EBUSY);
 141         return (kdb_dbbe_select(buf));
 142 }
 143
 144 static int
 145 kdb_sysctl_enter(SYSCTL_HANDLER_ARGS)
 146 {
 147         int error, i;
 148
 149         error = sysctl_wire_old_buffer(req, sizeof(int));
 150         if (error == 0) {
 151                 i = 0;
 152                 error = sysctl_handle_int(oidp, &i, 0, req);
 153         }
 154         if (error != 0 || req->newptr == NULL)
 155                 return (error);
 156         if (kdb_active)
 157                 return (EBUSY);
 158         kdb_enter(KDB_WHY_SYSCTL, "sysctl debug.kdb.enter");
 159         return (0);
 160 }
 161
 162 static int
 163 kdb_sysctl_panic(SYSCTL_HANDLER_ARGS)
 164 {
 165         int error, i;
 166
 167         error = sysctl_wire_old_buffer(req, sizeof(int));
 168         if (error == 0) {
 169                 i = 0;
 170                 error = sysctl_handle_int(oidp, &i, 0, req);
 171         }
 172         if (error != 0 || req->newptr == NULL)
 173                 return (error);
 174         panic("kdb_sysctl_panic");
 175         return (0);
 176 }
 177
 178 static int
 179 kdb_sysctl_trap(SYSCTL_HANDLER_ARGS)
 180 {
 181         int error, i;
 182         int *addr = (int *)0x10;
 183
 184         error = sysctl_wire_old_buffer(req, sizeof(int));
 185         if (error == 0) {
 186                 i = 0;
 187                 error = sysctl_handle_int(oidp, &i, 0, req);
 188         }
 189         if (error != 0 || req->newptr == NULL)
 190                 return (error);
 191         return (*addr);
 192 }
 193
 194 static int
 195 kdb_sysctl_trap_code(SYSCTL_HANDLER_ARGS)
 196 {
 197         int error, i;
 198         void (*fp)(u_int, u_int, u_int) = (void *)0xdeadc0de;
 199
 200         error = sysctl_wire_old_buffer(req, sizeof(int));
 201         if (error == 0) {
 202                 i = 0;
 203                 error = sysctl_handle_int(oidp, &i, 0, req);
 204         }
 205         if (error != 0 || req->newptr == NULL)
 206                 return (error);
 207         (*fp)(0x11111111, 0x22222222, 0x33333333);
 208         return (0);
 209 }
 210
 211 void
 212 kdb_panic(const char *msg)
 213 {
 214
 215 #ifdef SMP
 216         stop_cpus_hard(PCPU_GET(other_cpus));
 217 #endif
 218         printf("KDB: panic\n");
 219         panic("%s", msg);
 220 }
 221
 222 void
 223 kdb_reboot(void)
 224 {
 225
 226         printf("KDB: reboot requested\n");
 227         shutdown_nice(0);
 228 }
 229
 230 /*
 231  * Solaris implements a new BREAK which is initiated by a character sequence
 232  * CR ~ ^b which is similar to a familiar pattern used on Sun servers by the
 233  * Remote Console.
 234  *
 235  * Note that this function may be called from almost anywhere, with interrupts
 236  * disabled and with unknown locks held, so it must not access data other than
 237  * its arguments.  Its up to the caller to ensure that the state variable is
 238  * consistent.
 239  */
 240
 241 #define KEY_CR          13      /* CR '\r' */
 242 #define KEY_TILDE       126     /* ~ */
 243 #define KEY_CRTLB       2       /* ^B */
 244 #define KEY_CRTLP       16      /* ^P */
 245 #define KEY_CRTLR       18      /* ^R */
 246
 247 /* States of th KDB "alternate break sequence" detecting state machine. */
 248 enum {
 249         KDB_ALT_BREAK_SEEN_NONE,
 250         KDB_ALT_BREAK_SEEN_CR,
 251         KDB_ALT_BREAK_SEEN_CR_TILDE,
 252 };
 253
 254 int
 255 kdb_alt_break(int key, int *state)
 256 {
 257         int brk;
 258
 259         /* All states transition to KDB_ALT_BREAK_SEEN_CR on a CR. */
 260         if (key == KEY_CR) {
 261                 *state = KDB_ALT_BREAK_SEEN_CR;
 262                 return (0);
 263         }
 264
 265         brk = 0;
 266         switch (*state) {
 267         case KDB_ALT_BREAK_SEEN_CR:
 268                 *state = KDB_ALT_BREAK_SEEN_NONE;
 269                 if (key == KEY_TILDE)
 270                         *state = KDB_ALT_BREAK_SEEN_CR_TILDE;
 271                 break;
 272         case KDB_ALT_BREAK_SEEN_CR_TILDE:
 273                 *state = KDB_ALT_BREAK_SEEN_NONE;
 274                 if (key == KEY_CRTLB)
 275                         brk = KDB_REQ_DEBUGGER;
 276                 else if (key == KEY_CRTLP)
 277                         brk = KDB_REQ_PANIC;
 278                 else if (key == KEY_CRTLR)
 279                         brk = KDB_REQ_REBOOT;
 280                 break;
 281         case KDB_ALT_BREAK_SEEN_NONE:
 282         default:
 283                 *state = KDB_ALT_BREAK_SEEN_NONE;
 284                 break;
 285         }
 286         return (brk);
 287 }
 288
 289 /*
 290  * Print a backtrace of the calling thread. The backtrace is generated by
 291  * the selected debugger, provided it supports backtraces. If no debugger
 292  * is selected or the current debugger does not support backtraces, this
 293  * function silently returns.
 294  */
 295
 296 void
 297 kdb_backtrace(void)
 298 {
 299
 300         if (kdb_dbbe != NULL && kdb_dbbe->dbbe_trace != NULL) {
 301                 printf("KDB: stack backtrace:\n");
 302                 kdb_dbbe->dbbe_trace();
 303         }
 304 #ifdef STACK
 305         else {
 306                 struct stack st;
 307
 308                 printf("KDB: stack backtrace:\n");
 309                 stack_save(&st);
 310                 stack_print_ddb(&st);
 311         }
 312 #endif
 313 }
 314
 315 /*
 316  * Set/change the current backend.
 317  */
 318
 319 int
 320 kdb_dbbe_select(const char *name)
 321 {
 322         struct kdb_dbbe *be, **iter;
 323
 324         SET_FOREACH(iter, kdb_dbbe_set) {
 325                 be = *iter;
 326                 if (be->dbbe_active == 0 && strcmp(be->dbbe_name, name) == 0) {
 327                         kdb_dbbe = be;
 328                         return (0);
 329                 }
 330         }
 331         return (EINVAL);
 332 }
 333
 334 /*
 335  * Enter the currently selected debugger. If a message has been provided,
 336  * it is printed first. If the debugger does not support the enter method,
 337  * it is entered by using breakpoint(), which enters the debugger through
 338  * kdb_trap().  The 'why' argument will contain a more mechanically usable
 339  * string than 'msg', and is relied upon by DDB scripting to identify the
 340  * reason for entering the debugger so that the right script can be run.
 341  */
 342 void
 343 kdb_enter(const char *why, const char *msg)
 344 {
 345
 346         if (kdb_dbbe != NULL && kdb_active == 0) {
 347                 if (msg != NULL)
 348                         printf("KDB: enter: %s\n", msg);
 349                 kdb_why = why;
 350                 breakpoint();
 351                 kdb_why = KDB_WHY_UNSET;
 352         }
 353 }
 354
 355 /*
 356  * Initialize the kernel debugger interface.
 357  */
 358
 359 void
 360 kdb_init(void)
 361 {
 362         struct kdb_dbbe *be, **iter;
 363         int cur_pri, pri;
 364
 365         kdb_active = 0;
 366         kdb_dbbe = NULL;
 367         cur_pri = -1;
 368         SET_FOREACH(iter, kdb_dbbe_set) {
 369                 be = *iter;
 370                 pri = (be->dbbe_init != NULL) ? be->dbbe_init() : -1;
 371                 be->dbbe_active = (pri >= 0) ? 0 : -1;
 372                 if (pri > cur_pri) {
 373                         cur_pri = pri;
 374                         kdb_dbbe = be;
 375                 }
 376         }
 377         if (kdb_dbbe != NULL) {
 378                 printf("KDB: debugger backends:");
 379                 SET_FOREACH(iter, kdb_dbbe_set) {
 380                         be = *iter;
 381                         if (be->dbbe_active == 0)
 382                                 printf(" %s", be->dbbe_name);
 383                 }
 384                 printf("\n");
 385                 printf("KDB: current backend: %s\n",
 386                     kdb_dbbe->dbbe_name);
 387         }
 388 }
 389
 390 /*
 391  * Handle contexts.
 392  */
 393
 394 void *
 395 kdb_jmpbuf(jmp_buf new)
 396 {
 397         void *old;
 398
 399         old = kdb_jmpbufp;
 400         kdb_jmpbufp = new;
 401         return (old);
 402 }
 403
 404 void
 405 kdb_reenter(void)
 406 {
 407
 408         if (!kdb_active || kdb_jmpbufp == NULL)
 409                 return;
 410
 411         longjmp(kdb_jmpbufp, 1);
 412         /* NOTREACHED */
 413 }
 414
 415 /*
 416  * Thread related support functions.
 417  */
 418
 419 struct pcb *
 420 kdb_thr_ctx(struct thread *thr)
 421 {
 422 #if defined(SMP) && defined(KDB_STOPPEDPCB)
 423         struct pcpu *pc;
 424 #endif
 425
 426         if (thr == curthread)
 427                 return (&kdb_pcb);
 428
 429 #if defined(SMP) && defined(KDB_STOPPEDPCB)
 430         STAILQ_FOREACH(pc, &cpuhead, pc_allcpu)  {
 431                 if (pc->pc_curthread == thr &&
 432                     CPU_OVERLAP(&stopped_cpus, &pc->pc_cpumask))
 433                         return (KDB_STOPPEDPCB(pc));
 434         }
 435 #endif
 436         return (thr->td_pcb);
 437 }
 438
 439 struct thread *
 440 kdb_thr_first(void)
 441 {
 442         struct proc *p;
 443         struct thread *thr;
 444
 445         p = LIST_FIRST(&allproc);
 446         while (p != NULL) {
 447                 if (p->p_flag & P_INMEM) {
 448                         thr = FIRST_THREAD_IN_PROC(p);
 449                         if (thr != NULL)
 450                                 return (thr);
 451                 }
 452                 p = LIST_NEXT(p, p_list);
 453         }
 454         return (NULL);
 455 }
 456
 457 struct thread *
 458 kdb_thr_from_pid(pid_t pid)
 459 {
 460         struct proc *p;
 461
 462         p = LIST_FIRST(&allproc);
 463         while (p != NULL) {
 464                 if (p->p_flag & P_INMEM && p->p_pid == pid)
 465                         return (FIRST_THREAD_IN_PROC(p));
 466                 p = LIST_NEXT(p, p_list);
 467         }
 468         return (NULL);
 469 }
 470
 471 struct thread *
 472 kdb_thr_lookup(lwpid_t tid)
 473 {
 474         struct thread *thr;
 475
 476         thr = kdb_thr_first();
 477         while (thr != NULL && thr->td_tid != tid)
 478                 thr = kdb_thr_next(thr);
 479         return (thr);
 480 }
 481
 482 struct thread *
 483 kdb_thr_next(struct thread *thr)
 484 {
 485         struct proc *p;
 486
 487         p = thr->td_proc;
 488         thr = TAILQ_NEXT(thr, td_plist);
 489         do {
 490                 if (thr != NULL)
 491                         return (thr);
 492                 p = LIST_NEXT(p, p_list);
 493                 if (p != NULL && (p->p_flag & P_INMEM))
 494                         thr = FIRST_THREAD_IN_PROC(p);
 495         } while (p != NULL);
 496         return (NULL);
 497 }
 498
 499 int
 500 kdb_thr_select(struct thread *thr)
 501 {
 502         if (thr == NULL)
 503                 return (EINVAL);
 504         kdb_thread = thr;
 505         kdb_thrctx = kdb_thr_ctx(thr);
 506         return (0);
 507 }
 508
 509 /*
 510  * Enter the debugger due to a trap.
 511  */
 512
 513 int
 514 kdb_trap(int type, int code, struct trapframe *tf)
 515 {
 516         struct kdb_dbbe *be;
 517         register_t intr;
 518 #ifdef SMP
 519         int did_stop_cpus;
 520 #endif
 521         int handled;
 522
 523         be = kdb_dbbe;
 524         if (be == NULL || be->dbbe_trap == NULL)
 525                 return (0);
 526
 527         /* We reenter the debugger through kdb_reenter(). */
 528         if (kdb_active)
 529                 return (0);
 530
 531         intr = intr_disable();
 532
 533 #ifdef SMP
 534         if ((did_stop_cpus = kdb_stop_cpus) != 0)
 535                 stop_cpus_hard(PCPU_GET(other_cpus));
 536 #endif
 537
 538         kdb_active++;
 539
 540         kdb_frame = tf;
 541
 542         /* Let MD code do its thing first... */
 543         kdb_cpu_trap(type, code);
 544
 545         makectx(tf, &kdb_pcb);
 546         kdb_thr_select(curthread);
 547
 548         for (;;) {
 549                 handled = be->dbbe_trap(type, code);
 550                 if (be == kdb_dbbe)
 551                         break;
 552                 be = kdb_dbbe;
 553                 if (be == NULL || be->dbbe_trap == NULL)
 554                         break;
 555                 printf("Switching to %s back-end\n", be->dbbe_name);
 556         }
 557
 558         kdb_active--;
 559
 560 #ifdef SMP
 561         if (did_stop_cpus)
 562                 restart_cpus(stopped_cpus);
 563 #endif
 564
 565         intr_restore(intr);
 566
 567         return (handled);
 568 }