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