xref: /freebsd/sys/arm64/arm64/db_interface.c (revision dbd5678d)
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/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
32 #include <sys/proc.h>
33 #include <vm/vm.h>
34 #include <vm/pmap.h>
35 #include <vm/vm_map.h>
36 
37 #ifdef KDB
38 #include <sys/kdb.h>
39 #endif
40 
41 #include <ddb/ddb.h>
42 #include <ddb/db_variables.h>
43 
44 #include <machine/cpu.h>
45 #include <machine/pcb.h>
46 #include <machine/stack.h>
47 #include <machine/vmparam.h>
48 
49 static int
50 db_frame(struct db_variable *vp, db_expr_t *valuep, int op)
51 {
52 	long *reg;
53 
54 	if (kdb_frame == NULL)
55 		return (0);
56 
57 	reg = (long *)((uintptr_t)kdb_frame + (db_expr_t)vp->valuep);
58 	if (op == DB_VAR_GET)
59 		*valuep = *reg;
60 	else
61 		*reg = *valuep;
62 	return (1);
63 }
64 
65 #define DB_OFFSET(x)	(db_expr_t *)offsetof(struct trapframe, x)
66 struct db_variable db_regs[] = {
67 	{ "spsr", DB_OFFSET(tf_spsr),	db_frame },
68 	{ "x0", DB_OFFSET(tf_x[0]),	db_frame },
69 	{ "x1", DB_OFFSET(tf_x[1]),	db_frame },
70 	{ "x2", DB_OFFSET(tf_x[2]),	db_frame },
71 	{ "x3", DB_OFFSET(tf_x[3]),	db_frame },
72 	{ "x4", DB_OFFSET(tf_x[4]),	db_frame },
73 	{ "x5", DB_OFFSET(tf_x[5]),	db_frame },
74 	{ "x6", DB_OFFSET(tf_x[6]),	db_frame },
75 	{ "x7", DB_OFFSET(tf_x[7]),	db_frame },
76 	{ "x8", DB_OFFSET(tf_x[8]),	db_frame },
77 	{ "x9", DB_OFFSET(tf_x[9]),	db_frame },
78 	{ "x10", DB_OFFSET(tf_x[10]),	db_frame },
79 	{ "x11", DB_OFFSET(tf_x[11]),	db_frame },
80 	{ "x12", DB_OFFSET(tf_x[12]),	db_frame },
81 	{ "x13", DB_OFFSET(tf_x[13]),	db_frame },
82 	{ "x14", DB_OFFSET(tf_x[14]),	db_frame },
83 	{ "x15", DB_OFFSET(tf_x[15]),	db_frame },
84 	{ "x16", DB_OFFSET(tf_x[16]),	db_frame },
85 	{ "x17", DB_OFFSET(tf_x[17]),	db_frame },
86 	{ "x18", DB_OFFSET(tf_x[18]),	db_frame },
87 	{ "x19", DB_OFFSET(tf_x[19]),	db_frame },
88 	{ "x20", DB_OFFSET(tf_x[20]),	db_frame },
89 	{ "x21", DB_OFFSET(tf_x[21]),	db_frame },
90 	{ "x22", DB_OFFSET(tf_x[22]),	db_frame },
91 	{ "x23", DB_OFFSET(tf_x[23]),	db_frame },
92 	{ "x24", DB_OFFSET(tf_x[24]),	db_frame },
93 	{ "x25", DB_OFFSET(tf_x[25]),	db_frame },
94 	{ "x26", DB_OFFSET(tf_x[26]),	db_frame },
95 	{ "x27", DB_OFFSET(tf_x[27]),	db_frame },
96 	{ "x28", DB_OFFSET(tf_x[28]),	db_frame },
97 	{ "x29", DB_OFFSET(tf_x[29]),	db_frame },
98 	{ "lr", DB_OFFSET(tf_lr),	db_frame },
99 	{ "elr", DB_OFFSET(tf_elr),	db_frame },
100 	{ "sp", DB_OFFSET(tf_sp), db_frame },
101 };
102 
103 struct db_variable *db_eregs = db_regs + nitems(db_regs);
104 
105 void
106 db_show_mdpcpu(struct pcpu *pc)
107 {
108 }
109 
110 /*
111  * Read bytes from kernel address space for debugger.
112  */
113 int
114 db_read_bytes(vm_offset_t addr, size_t size, char *data)
115 {
116 	jmp_buf jb;
117 	void *prev_jb;
118 	const char *src;
119 	int ret;
120 	uint64_t tmp64;
121 	uint32_t tmp32;
122 	uint16_t tmp16;
123 
124 	prev_jb = kdb_jmpbuf(jb);
125 	ret = setjmp(jb);
126 
127 	if (ret == 0) {
128 		src = (const char *)addr;
129 		if (size == 8 && (addr & 7) == 0) {
130 			tmp64 = *((const int *)src);
131 			src = (const char *)&tmp64;
132 		} else if (size == 4 && (addr & 3) == 0) {
133 			tmp32 = *((const int *)src);
134 			src = (const char *)&tmp32;
135 		} else if (size == 2 && (addr & 1) == 0) {
136 			tmp16 = *((const short *)src);
137 			src = (const char *)&tmp16;
138 		}
139 		while (size-- > 0)
140 			*data++ = *src++;
141 	}
142 	(void)kdb_jmpbuf(prev_jb);
143 
144 	return (ret);
145 }
146 
147 /*
148  * Write bytes to kernel address space for debugger.
149  */
150 int
151 db_write_bytes(vm_offset_t addr, size_t size, char *data)
152 {
153 	jmp_buf jb;
154 	void *prev_jb;
155 	char *dst;
156 	size_t i;
157 	int ret;
158 
159 	prev_jb = kdb_jmpbuf(jb);
160 	ret = setjmp(jb);
161 	if (ret == 0) {
162 		if (!arm64_get_writable_addr(addr, &addr)) {
163 			ret = 1;
164 		} else {
165 			dst = (char *)addr;
166 			for (i = 0; i < size; i++)
167 				*dst++ = *data++;
168 			dsb(ish);
169 
170 			/*
171 			 * Ensure the I & D cache are in sync if we wrote
172 			 * to executable memory.
173 			 */
174 			cpu_icache_sync_range(addr, (vm_size_t)size);
175 		}
176 	}
177 	(void)kdb_jmpbuf(prev_jb);
178 
179 	return (ret);
180 }
181