sys/sys/kdb.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 2004 Marcel Moolenaar
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef _SYS_KDB_H_
  30 #define _SYS_KDB_H_
  31
  32 #include <sys/linker_set.h>
  33 #include <machine/setjmp.h>
  34
  35 struct pcb;
  36 struct thread;
  37 struct trapframe;
  38
  39 typedef int dbbe_init_f(void);
  40 typedef void dbbe_trace_f(void);
  41 typedef void dbbe_trace_thread_f(struct thread *);
  42 typedef int dbbe_trap_f(int, int);
  43
  44 struct kdb_dbbe {
  45         const char      *dbbe_name;
  46         dbbe_init_f     *dbbe_init;
  47         dbbe_trace_f    *dbbe_trace;
  48         dbbe_trace_thread_f *dbbe_trace_thread;
  49         dbbe_trap_f     *dbbe_trap;
  50         int             dbbe_active;
  51 };
  52
  53 #define KDB_BACKEND(name, init, trace, trace_thread, trap) \
  54         static struct kdb_dbbe name##_dbbe = {          \
  55                 .dbbe_name = #name,                     \
  56                 .dbbe_init = init,                      \
  57                 .dbbe_trace = trace,                    \
  58                 .dbbe_trace_thread = trace_thread,      \
  59                 .dbbe_trap = trap                       \
  60         };                                              \
  61         DATA_SET(kdb_dbbe_set, name##_dbbe)
  62
  63 SET_DECLARE(kdb_dbbe_set, struct kdb_dbbe);
  64
  65 extern u_char kdb_active;               /* Non-zero while in debugger. */
  66 extern int debugger_on_panic;           /* enter the debugger on panic. */
  67 extern int debugger_on_trap;            /* enter the debugger on trap. */
  68 extern struct kdb_dbbe *kdb_dbbe;       /* Default debugger backend or NULL. */
  69 extern struct trapframe *kdb_frame;     /* Frame to kdb_trap(). */
  70 extern struct pcb *kdb_thrctx;          /* Current context. */
  71 extern struct thread *kdb_thread;       /* Current thread. */
  72
  73 int     kdb_alt_break(int, int *);
  74 int     kdb_alt_break_gdb(int, int *);
  75 int     kdb_break(void);
  76 void    kdb_backtrace(void);
  77 void    kdb_backtrace_thread(struct thread *);
  78 int     kdb_dbbe_select(const char *);
  79 void    kdb_enter(const char *, const char *);
  80 void    kdb_init(void);
  81 void *  kdb_jmpbuf(jmp_buf);
  82 void    kdb_panic(const char *);
  83 void    kdb_reboot(void);
  84 void    kdb_reenter(void);
  85 void    kdb_reenter_silent(void);
  86 struct pcb *kdb_thr_ctx(struct thread *);
  87 struct thread *kdb_thr_first(void);
  88 struct thread *kdb_thr_from_pid(pid_t);
  89 struct thread *kdb_thr_lookup(lwpid_t);
  90 struct thread *kdb_thr_next(struct thread *);
  91 int     kdb_thr_select(struct thread *);
  92 int     kdb_trap(int, int, struct trapframe *);
  93
  94 /*
  95  * KDB enters the debugger via breakpoint(), which leaves the debugger without
  96  * a lot of information about why it was entered.  This simple enumerated set
  97  * captures some basic information.
  98  *
  99  * It is recommended that values here be short (<16 character) alpha-numeric
 100  * strings, as they will be used to construct DDB(4) script names.
 101  */
 102 extern const char * volatile kdb_why;
 103 #define KDB_WHY_UNSET           NULL            /* No reason set. */
 104 #define KDB_WHY_PANIC           "panic"         /* panic() was called. */
 105 #define KDB_WHY_KASSERT         "kassert"       /* kassert failed. */
 106 #define KDB_WHY_TRAP            "trap"          /* Fatal trap. */
 107 #define KDB_WHY_SYSCTL          "sysctl"        /* Sysctl entered debugger. */
 108 #define KDB_WHY_BOOTFLAGS       "bootflags"     /* Boot flags were set. */
 109 #define KDB_WHY_WITNESS         "witness"       /* Witness entered debugger. */
 110 #define KDB_WHY_VFSLOCK         "vfslock"       /* VFS detected lock problem. */
 111 #define KDB_WHY_NETGRAPH        "netgraph"      /* Netgraph entered debugger. */
 112 #define KDB_WHY_BREAK           "break"         /* Console or serial break. */
 113 #define KDB_WHY_WATCHDOG        "watchdog"      /* Watchdog entered debugger. */
 114 #define KDB_WHY_CAM             "cam"           /* CAM has entered debugger. */
 115 #define KDB_WHY_ACPI            "acpi"          /* ACPI entered debugger. */
 116 #define KDB_WHY_TRAPSIG         "trapsig"       /* Sparc fault. */
 117 #define KDB_WHY_POWERFAIL       "powerfail"     /* Powerfail NMI. */
 118 #define KDB_WHY_MAC             "mac"           /* MAC Framework. */
 119 #define KDB_WHY_POWERPC         "powerpc"       /* Unhandled powerpc intr. */
 120 #define KDB_WHY_UNIONFS         "unionfs"       /* Unionfs bug. */
 121 #define KDB_WHY_DTRACE          "dtrace"        /* DTrace action entered debugger. */
 122 #define KDB_WHY_REBOOT          "reboot"        /* reboot was requested. */
 123
 124 /* Return values for kdb_alt_break */
 125 #define KDB_REQ_DEBUGGER        1       /* User requested Debugger */
 126 #define KDB_REQ_PANIC           2       /* User requested a panic */
 127 #define KDB_REQ_REBOOT          3       /* User requested a clean reboot */
 128
 129 /* Debug breakpoint/watchpoint access types */
 130 #define KDB_DBG_ACCESS_EXEC     0
 131 #define KDB_DBG_ACCESS_R        1
 132 #define KDB_DBG_ACCESS_W        2
 133 #define KDB_DBG_ACCESS_RW       3
 134
 135 #endif /* !_SYS_KDB_H_ */