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