xref: /freebsd/sys/arm64/arm64/db_interface.c (revision 069ac184)
1 /*-
2  * Copyright (c) 2015 The FreeBSD Foundation
3  *
4  * This software was developed by Semihalf under
5  * the sponsorship of the FreeBSD Foundation.
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  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/param.h>
30 #include <sys/proc.h>
31 #include <vm/vm.h>
32 #include <vm/pmap.h>
33 #include <vm/vm_map.h>
34 
35 #ifdef KDB
36 #include <sys/kdb.h>
37 #endif
38 
39 #include <ddb/ddb.h>
40 #include <ddb/db_variables.h>
41 
42 #include <machine/cpu.h>
43 #include <machine/pcb.h>
44 #include <machine/stack.h>
45 #include <machine/vmparam.h>
46 
47 static int
48 db_frame(struct db_variable *vp, db_expr_t *valuep, int op)
49 {
50 	long *reg;
51 
52 	if (kdb_frame == NULL)
53 		return (0);
54 
55 	reg = (long *)((uintptr_t)kdb_frame + (db_expr_t)vp->valuep);
56 	if (op == DB_VAR_GET)
57 		*valuep = *reg;
58 	else
59 		*reg = *valuep;
60 	return (1);
61 }
62 
63 #define DB_OFFSET(x)	(db_expr_t *)offsetof(struct trapframe, x)
64 struct db_variable db_regs[] = {
65 	{ "spsr", DB_OFFSET(tf_spsr),	db_frame },
66 	{ "x0", DB_OFFSET(tf_x[0]),	db_frame },
67 	{ "x1", DB_OFFSET(tf_x[1]),	db_frame },
68 	{ "x2", DB_OFFSET(tf_x[2]),	db_frame },
69 	{ "x3", DB_OFFSET(tf_x[3]),	db_frame },
70 	{ "x4", DB_OFFSET(tf_x[4]),	db_frame },
71 	{ "x5", DB_OFFSET(tf_x[5]),	db_frame },
72 	{ "x6", DB_OFFSET(tf_x[6]),	db_frame },
73 	{ "x7", DB_OFFSET(tf_x[7]),	db_frame },
74 	{ "x8", DB_OFFSET(tf_x[8]),	db_frame },
75 	{ "x9", DB_OFFSET(tf_x[9]),	db_frame },
76 	{ "x10", DB_OFFSET(tf_x[10]),	db_frame },
77 	{ "x11", DB_OFFSET(tf_x[11]),	db_frame },
78 	{ "x12", DB_OFFSET(tf_x[12]),	db_frame },
79 	{ "x13", DB_OFFSET(tf_x[13]),	db_frame },
80 	{ "x14", DB_OFFSET(tf_x[14]),	db_frame },
81 	{ "x15", DB_OFFSET(tf_x[15]),	db_frame },
82 	{ "x16", DB_OFFSET(tf_x[16]),	db_frame },
83 	{ "x17", DB_OFFSET(tf_x[17]),	db_frame },
84 	{ "x18", DB_OFFSET(tf_x[18]),	db_frame },
85 	{ "x19", DB_OFFSET(tf_x[19]),	db_frame },
86 	{ "x20", DB_OFFSET(tf_x[20]),	db_frame },
87 	{ "x21", DB_OFFSET(tf_x[21]),	db_frame },
88 	{ "x22", DB_OFFSET(tf_x[22]),	db_frame },
89 	{ "x23", DB_OFFSET(tf_x[23]),	db_frame },
90 	{ "x24", DB_OFFSET(tf_x[24]),	db_frame },
91 	{ "x25", DB_OFFSET(tf_x[25]),	db_frame },
92 	{ "x26", DB_OFFSET(tf_x[26]),	db_frame },
93 	{ "x27", DB_OFFSET(tf_x[27]),	db_frame },
94 	{ "x28", DB_OFFSET(tf_x[28]),	db_frame },
95 	{ "x29", DB_OFFSET(tf_x[29]),	db_frame },
96 	{ "lr", DB_OFFSET(tf_lr),	db_frame },
97 	{ "elr", DB_OFFSET(tf_elr),	db_frame },
98 	{ "sp", DB_OFFSET(tf_sp), db_frame },
99 };
100 
101 struct db_variable *db_eregs = db_regs + nitems(db_regs);
102 
103 void
104 db_show_mdpcpu(struct pcpu *pc)
105 {
106 }
107 
108 /*
109  * Read bytes from kernel address space for debugger.
110  */
111 int
112 db_read_bytes(vm_offset_t addr, size_t size, char *data)
113 {
114 	jmp_buf jb;
115 	void *prev_jb;
116 	const char *src;
117 	int ret;
118 	uint64_t tmp64;
119 	uint32_t tmp32;
120 	uint16_t tmp16;
121 
122 	prev_jb = kdb_jmpbuf(jb);
123 	ret = setjmp(jb);
124 
125 	if (ret == 0) {
126 		src = (const char *)addr;
127 		if (size == 8 && (addr & 7) == 0) {
128 			tmp64 = *((const int *)src);
129 			src = (const char *)&tmp64;
130 		} else if (size == 4 && (addr & 3) == 0) {
131 			tmp32 = *((const int *)src);
132 			src = (const char *)&tmp32;
133 		} else if (size == 2 && (addr & 1) == 0) {
134 			tmp16 = *((const short *)src);
135 			src = (const char *)&tmp16;
136 		}
137 		while (size-- > 0)
138 			*data++ = *src++;
139 	}
140 	(void)kdb_jmpbuf(prev_jb);
141 
142 	return (ret);
143 }
144 
145 /*
146  * Write bytes to kernel address space for debugger.
147  */
148 int
149 db_write_bytes(vm_offset_t addr, size_t size, char *data)
150 {
151 	jmp_buf jb;
152 	void *prev_jb;
153 	char *dst;
154 	size_t i;
155 	int ret;
156 
157 	prev_jb = kdb_jmpbuf(jb);
158 	ret = setjmp(jb);
159 	if (ret == 0) {
160 		if (!arm64_get_writable_addr(addr, &addr)) {
161 			ret = 1;
162 		} else {
163 			dst = (char *)addr;
164 			for (i = 0; i < size; i++)
165 				*dst++ = *data++;
166 			dsb(ish);
167 
168 			/*
169 			 * Ensure the I & D cache are in sync if we wrote
170 			 * to executable memory.
171 			 */
172 			cpu_icache_sync_range(addr, (vm_size_t)size);
173 		}
174 	}
175 	(void)kdb_jmpbuf(prev_jb);
176 
177 	return (ret);
178 }
179