sys/sys/kdb.h

   1 /*-
   2  * Copyright (c) 2004 Marcel Moolenaar
   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 AUTHOR ``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 AUTHOR 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  * $FreeBSD$
  27  */
  28
  29 #ifndef _SYS_KDB_H_
  30 #define _SYS_KDB_H_
  31
  32 #include <machine/setjmp.h>
  33
  34 typedef int dbbe_init_f(void);
  35 typedef void dbbe_trace_f(void);
  36 typedef int dbbe_trap_f(int, int);
  37
  38 struct kdb_dbbe {
  39         const char      *dbbe_name;
  40         dbbe_init_f     *dbbe_init;
  41         dbbe_trace_f    *dbbe_trace;
  42         dbbe_trap_f     *dbbe_trap;
  43         int             dbbe_active;
  44 };
  45
  46 #define KDB_BACKEND(name, init, trace, trap)            \
  47         static struct kdb_dbbe name##_dbbe = {          \
  48                 .dbbe_name = #name,                     \
  49                 .dbbe_init = init,                      \
  50                 .dbbe_trace = trace,                    \
  51                 .dbbe_trap = trap                       \
  52         };                                              \
  53         DATA_SET(kdb_dbbe_set, name##_dbbe)
  54
  55 struct pcb;
  56 struct thread;
  57 struct trapframe;
  58
  59 extern int kdb_active;                  /* Non-zero while in debugger. */
  60 extern int debugger_on_panic;           /* enter the debugger on panic. */
  61 extern struct kdb_dbbe *kdb_dbbe;       /* Default debugger backend or NULL. */
  62 extern struct trapframe *kdb_frame;     /* Frame to kdb_trap(). */
  63 extern struct pcb *kdb_thrctx;          /* Current context. */
  64 extern struct thread *kdb_thread;       /* Current thread. */
  65
  66 int     kdb_alt_break(int, int *);
  67 void    kdb_backtrace(void);
  68 int     kdb_dbbe_select(const char *);
  69 void    kdb_enter(const char *, const char *);
  70 void    kdb_init(void);
  71 void *  kdb_jmpbuf(jmp_buf);
  72 void    kdb_panic(const char *);
  73 void    kdb_reboot(void);
  74 void    kdb_reenter(void);
  75 struct pcb *kdb_thr_ctx(struct thread *);
  76 struct thread *kdb_thr_first(void);
  77 struct thread *kdb_thr_from_pid(pid_t);
  78 struct thread *kdb_thr_lookup(lwpid_t);
  79 struct thread *kdb_thr_next(struct thread *);
  80 int     kdb_thr_select(struct thread *);
  81 int     kdb_trap(int, int, struct trapframe *);
  82
  83 /*
  84  * KDB enters the debugger via breakpoint(), which leaves the debugger without
  85  * a lot of information about why it was entered.  This simple enumerated set
  86  * captures some basic information.
  87  *
  88  * It is recommended that values here be short (<16 character) alpha-numeric
  89  * strings, as they will be used to construct DDB(4) script names.
  90  */
  91 extern const char * volatile kdb_why;
  92 #define KDB_WHY_UNSET           NULL            /* No reason set. */
  93 #define KDB_WHY_PANIC           "panic"         /* panic() was called. */
  94 #define KDB_WHY_SYSCTL          "sysctl"        /* Sysctl entered debugger. */
  95 #define KDB_WHY_BOOTFLAGS       "bootflags"     /* Boot flags were set. */
  96 #define KDB_WHY_WITNESS         "witness"       /* Witness entered debugger. */
  97 #define KDB_WHY_VFSLOCK         "vfslock"       /* VFS detected lock problem. */
  98 #define KDB_WHY_NETGRAPH        "netgraph"      /* Netgraph entered debugger. */
  99 #define KDB_WHY_BREAK           "break"         /* Console or serial break. */
 100 #define KDB_WHY_WATCHDOG        "watchdog"      /* Watchdog entered debugger. */
 101 #define KDB_WHY_CAM             "cam"           /* CAM has entered debugger. */
 102 #define KDB_WHY_NDIS            "ndis"          /* NDIS entered debugger. */
 103 #define KDB_WHY_ACPI            "acpi"          /* ACPI entered debugger. */
 104 #define KDB_WHY_TRAPSIG         "trapsig"       /* Sun4v/Sparc fault. */
 105 #define KDB_WHY_POWERFAIL       "powerfail"     /* Powerfail NMI. */
 106 #define KDB_WHY_MAC             "mac"           /* MAC Framework. */
 107 #define KDB_WHY_POWERPC         "powerpc"       /* Unhandled powerpc intr. */
 108 #define KDB_WHY_UNIONFS         "unionfs"       /* Unionfs bug. */
 109 #define KDB_WHY_DTRACE          "dtrace"        /* DTrace action entered debugger. */
 110
 111 /* Return values for kdb_alt_break */
 112 #define KDB_REQ_DEBUGGER        1       /* User requested Debugger */
 113 #define KDB_REQ_PANIC           2       /* User requested a panic */
 114 #define KDB_REQ_REBOOT          3       /* User requested a clean reboot */
 115
 116 #endif /* !_SYS_KDB_H_ */