xref: /freebsd/sys/amd64/amd64/gdb_machdep.c (revision ec994981447e8a974426660b5071bc405280af73)
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 AUTHORS ``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 AUTHORS 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 #include <sys/cdefs.h>
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/kdb.h>
33 #include <sys/kernel.h>
34 #include <sys/proc.h>
35 #include <sys/reg.h>
36 #include <sys/signal.h>
37 
38 #include <machine/cpufunc.h>
39 #include <machine/frame.h>
40 #include <machine/gdb_machdep.h>
41 #include <machine/md_var.h>
42 #include <machine/pcb.h>
43 #include <machine/psl.h>
44 #include <machine/specialreg.h>
45 #include <machine/trap.h>
46 #include <machine/frame.h>
47 #include <machine/endian.h>
48 
49 #include <gdb/gdb.h>
50 #include <gdb/gdb_int.h>
51 
52 void *
53 gdb_cpu_getreg(int regnum, size_t *regsz)
54 {
55 	static uint32_t _kcodesel = GSEL(GCODE_SEL, SEL_KPL);
56 	static uint32_t _kdatasel = GSEL(GDATA_SEL, SEL_KPL);
57 
58 	*regsz = gdb_cpu_regsz(regnum);
59 
60 	if (kdb_thread  == curthread) {
61 		switch (regnum) {
62 		case GDB_REG_RAX: return (&kdb_frame->tf_rax);
63 		case GDB_REG_RCX: return (&kdb_frame->tf_rcx);
64 		case GDB_REG_RDX: return (&kdb_frame->tf_rdx);
65 		case GDB_REG_RSI: return (&kdb_frame->tf_rsi);
66 		case GDB_REG_RDI: return (&kdb_frame->tf_rdi);
67 		case GDB_REG_R8:  return (&kdb_frame->tf_r8);
68 		case GDB_REG_R9:  return (&kdb_frame->tf_r9);
69 		case GDB_REG_R10: return (&kdb_frame->tf_r10);
70 		case GDB_REG_R11: return (&kdb_frame->tf_r11);
71 		case GDB_REG_RFLAGS: return (&kdb_frame->tf_rflags);
72 		case GDB_REG_CS:  return (&kdb_frame->tf_cs);
73 		case GDB_REG_SS:  return (&kdb_frame->tf_ss);
74 		}
75 	}
76 	switch (regnum) {
77 	case GDB_REG_RBX: return (&kdb_thrctx->pcb_rbx);
78 	case GDB_REG_RBP: return (&kdb_thrctx->pcb_rbp);
79 	case GDB_REG_RSP: return (&kdb_thrctx->pcb_rsp);
80 	case GDB_REG_R12: return (&kdb_thrctx->pcb_r12);
81 	case GDB_REG_R13: return (&kdb_thrctx->pcb_r13);
82 	case GDB_REG_R14: return (&kdb_thrctx->pcb_r14);
83 	case GDB_REG_R15: return (&kdb_thrctx->pcb_r15);
84 	case GDB_REG_PC:  return (&kdb_thrctx->pcb_rip);
85 	case GDB_REG_CS:  return (&_kcodesel);
86 	case GDB_REG_SS:  return (&_kdatasel);
87 	}
88 	return (NULL);
89 }
90 
91 void
92 gdb_cpu_setreg(int regnum, void *val)
93 {
94 	register_t regval = *(register_t *)val;
95 
96 	/*
97 	 * Write registers to the trapframe and pcb, if applicable.
98 	 * Some scratch registers are not tracked by the pcb.
99 	 */
100 	if (kdb_thread == curthread) {
101 		switch (regnum) {
102 		case GDB_REG_RAX: kdb_frame->tf_rax = regval; break;
103 		case GDB_REG_RBX: kdb_frame->tf_rbx = regval; break;
104 		case GDB_REG_RCX: kdb_frame->tf_rcx = regval; break;
105 		case GDB_REG_RDX: kdb_frame->tf_rdx = regval; break;
106 		case GDB_REG_RSI: kdb_frame->tf_rsi = regval; break;
107 		case GDB_REG_RDI: kdb_frame->tf_rdi = regval; break;
108 		case GDB_REG_RBP: kdb_frame->tf_rbp = regval; break;
109 		case GDB_REG_RSP: kdb_frame->tf_rsp = regval; break;
110 		case GDB_REG_R8:  kdb_frame->tf_r8  = regval; break;
111 		case GDB_REG_R9:  kdb_frame->tf_r9  = regval; break;
112 		case GDB_REG_R10: kdb_frame->tf_r10 = regval; break;
113 		case GDB_REG_R11: kdb_frame->tf_r11 = regval; break;
114 		case GDB_REG_R12: kdb_frame->tf_r12 = regval; break;
115 		case GDB_REG_R13: kdb_frame->tf_r13 = regval; break;
116 		case GDB_REG_R14: kdb_frame->tf_r14 = regval; break;
117 		case GDB_REG_R15: kdb_frame->tf_r15 = regval; break;
118 		case GDB_REG_PC:  kdb_frame->tf_rip = regval; break;
119 		}
120 	}
121 	switch (regnum) {
122 	case GDB_REG_RBX: kdb_thrctx->pcb_rbx = regval; break;
123 	case GDB_REG_RBP: kdb_thrctx->pcb_rbp = regval; break;
124 	case GDB_REG_RSP: kdb_thrctx->pcb_rsp = regval; break;
125 	case GDB_REG_R12: kdb_thrctx->pcb_r12 = regval; break;
126 	case GDB_REG_R13: kdb_thrctx->pcb_r13 = regval; break;
127 	case GDB_REG_R14: kdb_thrctx->pcb_r14 = regval; break;
128 	case GDB_REG_R15: kdb_thrctx->pcb_r15 = regval; break;
129 	case GDB_REG_PC:  kdb_thrctx->pcb_rip = regval; break;
130 	}
131 }
132 
133 int
134 gdb_cpu_signal(int type, int code)
135 {
136 
137 	switch (type) {
138 	case T_BPTFLT: return (SIGTRAP);
139 	case T_ARITHTRAP: return (SIGFPE);
140 	case T_PROTFLT: return (SIGSEGV);
141 	case T_TRCTRAP: return (SIGTRAP);
142 	case T_PAGEFLT: return (SIGSEGV);
143 	case T_DIVIDE: return (SIGFPE);
144 	case T_NMI: return (SIGTRAP);
145 	case T_FPOPFLT: return (SIGILL);
146 	case T_TSSFLT: return (SIGSEGV);
147 	case T_SEGNPFLT: return (SIGSEGV);
148 	case T_STKFLT: return (SIGSEGV);
149 	case T_XMMFLT: return (SIGFPE);
150 	}
151 	return (SIGEMT);
152 }
153 
154 void
155 gdb_cpu_stop_reason(int type, int code)
156 {
157 	uintmax_t val;
158 
159 	val = 0;
160 	if (type == T_TRCTRAP) {
161 		/* NB: 'code' contains the value of dr6 at the trap. */
162 		if ((code & DBREG_DR6_B(0)) != 0) {
163 			val = rdr0();
164 		}
165 		if ((code & DBREG_DR6_B(1)) != 0) {
166 			val = rdr1();
167 		}
168 		if ((code & DBREG_DR6_B(2)) != 0) {
169 			val = rdr2();
170 		}
171 		if ((code & DBREG_DR6_B(3)) != 0) {
172 			val = rdr3();
173 		}
174 
175 		/*
176 		 * TODO: validate the bits in DR7 to differentiate between a
177 		 * watchpoint trap and a hardware breakpoint trap (currently
178 		 * unsupported).
179 		 */
180 		if (val != 0) {
181 			gdb_tx_str("watch:");
182 			gdb_tx_varhex(val);
183 			gdb_tx_char(';');
184 		}
185 	}
186 }
187 
188 void *
189 gdb_begin_write(void)
190 {
191 
192 	return (disable_wp() ? &gdb_begin_write : NULL);
193 }
194 
195 void
196 gdb_end_write(void *arg)
197 {
198 
199 	restore_wp(arg != NULL);
200 }
201