db_machdep.h revision 1.4 1 /* $NetBSD: db_machdep.h,v 1.4 2018/04/27 09:05:26 ryo Exp $ */
2
3 /*-
4 * Copyright (c) 2014 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Matt Thomas of 3am Software Foundry.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 /*-
33 * Copyright (c) 2014 Andrew Turner
34 * Copyright (c) 2014-2015 The FreeBSD Foundation
35 * All rights reserved.
36 *
37 * This software was developed by Semihalf under
38 * sponsorship from the FreeBSD Foundation.
39 *
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
42 * are met:
43 * 1. Redistributions of source code must retain the above copyright
44 * notice, this list of conditions and the following disclaimer.
45 * 2. Redistributions in binary form must reproduce the above copyright
46 * notice, this list of conditions and the following disclaimer in the
47 * documentation and/or other materials provided with the distribution.
48 *
49 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59 * SUCH DAMAGE.
60 *
61 * $FreeBSD: head/sys/arm64/include/db_machdep.h 316001 2017-03-26 18:46:35Z bde $
62 */
63
64 #ifndef _AARCH64_DB_MACHDEP_H_
65 #define _AARCH64_DB_MACHDEP_H_
66
67 #ifdef __aarch64__
68
69 #include <sys/types.h>
70 #include <aarch64/frame.h>
71
72 typedef long long int db_expr_t;
73 #define DDB_EXPR_FMT "ll"
74 typedef uintptr_t db_addr_t;
75
76 #define BKPT_ADDR(addr) (addr)
77 #define BKPT_SIZE 4
78 #define BKPT_INSN 0xd4200000 /* brk #0 */
79 #define BKPT_SET(insn, addr) (BKPT_INSN)
80
81 typedef struct trapframe db_regs_t;
82 extern db_regs_t ddb_regs;
83 #define DDB_REGS (&ddb_regs)
84 #define PC_REGS(tf) ((tf)->tf_pc)
85
86 int kdb_trap(int, struct trapframe *);
87 #define DB_TRAP_UNKNOWN 0
88 #define DB_TRAP_BREAKPOINT 1
89 #define DB_TRAP_BKPT_INSN 2
90 #define DB_TRAP_WATCHPOINT 3
91 #define DB_TRAP_SW_STEP 4
92
93 #define IS_BREAKPOINT_TRAP(type, code) \
94 ((type) == DB_TRAP_BREAKPOINT || (type) == DB_TRAP_BKPT_INSN)
95 #define IS_WATCHPOINT_TRAP(type, code) \
96 ((type) == DB_TRAP_WATCHPOINT)
97
98 static inline bool
99 inst_return(db_expr_t insn)
100 {
101 return ((insn & 0xfffffc1f) == 0xd65f0000); /* ret xN */
102 }
103
104 static inline bool
105 inst_trap_return(db_expr_t insn)
106 {
107 return insn == 0xd69f03e0; /* eret */
108 }
109
110 static inline bool
111 inst_call(db_expr_t insn)
112 {
113 return ((insn & 0xfc000000) == 0x94000000) /* bl */
114 || ((insn & 0xfffffc1f) == 0xd63f0000); /* blr */
115 }
116
117 static inline bool
118 inst_load(db_expr_t insn)
119 {
120 return
121 ((insn & 0xffe00c00) == 0xb8800000) || /* ldursw */
122 /* ldrsw imm{preidx,postidx} */
123 ((insn & 0xffe00400) == 0xb8800c00) ||
124 ((insn & 0xffc00c00) == 0xb8a00800) || /* ldrsw reg,ldtrsw */
125 ((insn & 0xffc00000) == 0xb9800000) || /* ldrsw immunsign */
126 ((insn & 0xffc00000) == 0x39400000) || /* ldrb immunsign */
127 ((insn & 0xff000000) == 0x98000000) || /* ldrsw literal */
128 /* ldpsw {preidx,postidx} */
129 ((insn & 0xfec00000) == 0x69c00000) ||
130 /* ldrh immunsign,ldpsw signed */
131 ((insn & 0xefc00000) == 0x79400000) ||
132 ((insn & 0xbffffc00) == 0x885f7c00) || /* ldxr */
133 ((insn & 0xbffffc00) == 0x485f7c00) || /* ldxr[bh] */
134 ((insn & 0xbfff0000) == 0x887f8000) || /* ldaxp,ldxp */
135 ((insn & 0xbfe00c00) == 0xb8400000) || /* ldur */
136 ((insn & 0xbfe00c00) == 0x78400000) || /* ldur[bh] */
137 /* ldr imm{preidx,postidx} */
138 ((insn & 0xbfe00400) == 0xb8400c00) ||
139 /* ldr[bh] imm{preidx,postidx} */
140 ((insn & 0xbfe00400) == 0x78400c00) ||
141 ((insn & 0xbfc00c00) == 0xb8600800) || /* ldr reg,ldtr */
142 /* ldr[bh] reg,ldtr[bh] */
143 ((insn & 0xbfc00c00) == 0x78600800) ||
144 ((insn & 0xbfc00000) == 0xb9400000) || /* ldr immunsign */
145 ((insn & 0xbfa00c00) == 0x78800000) || /* ldursh,ldursb */
146 /* ldrs[bh] imm{preidx,postidx} */
147 ((insn & 0xbfa00400) == 0x78800c00) ||
148 /* ldrs[bh] reg,ldtrs[bh] */
149 ((insn & 0xbf800c00) == 0x78a00800) ||
150 ((insn & 0xbf800000) == 0x79800000) || /* ldrs[bh] immunsign */
151 ((insn & 0xbf7ffc00) == 0x88dffc00) || /* ldar,ldaxr */
152 ((insn & 0xbf7ffc00) == 0x48dffc00) || /* ldar[bh],ldaxr[bh] */
153 ((insn & 0xbf000000) == 0x18000000) || /* ldr literal */
154 /* ldp {preidx,postidx,signed},ldnp */
155 ((insn & 0x7e400000) == 0x29c00000);
156 }
157
158 static inline bool
159 inst_store(db_expr_t insn)
160 {
161 return
162 ((insn & 0xbffffc00) == 0x889ffc00) || /* stlr */
163 ((insn & 0xbffffc00) == 0x489ffc00) || /* stlr[bh] */
164 ((insn & 0xbfe07c00) == 0x8800fc00) || /* stlxr,stxr */
165 ((insn & 0xbfe07c00) == 0x4800fc00) || /* stlxr[bh],stxr[bh] */
166 ((insn & 0xbfe00c00) == 0xb8000000) || /* stur */
167 ((insn & 0xbfe00c00) == 0x78000000) || /* stur[bh] */
168 /* str imm{preidx,postidx} */
169 ((insn & 0xbfe00400) == 0xb8000c00) ||
170 /* str[bh] imm{preidx,postidx} */
171 ((insn & 0xbfe00400) == 0x78000c00) ||
172 ((insn & 0xbfe00000) == 0x88208000) || /* stlxp,stxp */
173 ((insn & 0xbfc00c00) == 0xb8200800) || /* str reg,sttr */
174 /* str[bh] reg,sttr[bh] */
175 ((insn & 0xbfc00c00) == 0x78200800) ||
176 ((insn & 0xbfc00000) == 0xb9000000) || /* str immunsign */
177 ((insn & 0xbfc00000) == 0x79000000) || /* str[bh] immunsign */
178 /* stp {preidx,postidx,signed},stnp */
179 ((insn & 0x7e400000) == 0x29800000);
180 }
181
182 #define SOFTWARE_SSTEP
183
184 #ifdef SOFTWARE_SSTEP
185
186 static inline bool
187 inst_branch(db_expr_t insn)
188 {
189 return
190 ((insn & 0xff000010) == 0x54000000) || /* b.cond */
191 ((insn & 0xfc000000) == 0x14000000) || /* b imm */
192 ((insn & 0xfffffc1f) == 0xd61f0000) || /* br */
193 ((insn & 0x7f000000) == 0x35000000) || /* cbnz */
194 ((insn & 0x7f000000) == 0x34000000) || /* cbz */
195 ((insn & 0x7f000000) == 0x37000000) || /* tbnz */
196 ((insn & 0x7f000000) == 0x36000000); /* tbz */
197 }
198
199 bool db_inst_unconditional_flow_transfer(db_expr_t);
200 db_addr_t db_branch_taken(db_expr_t, db_addr_t, db_regs_t *);
201
202 #define next_instr_address(pc, bd) \
203 ((bd) ? (pc) : ((pc) + 4))
204 #define branch_taken(ins, pc, regs) \
205 db_branch_taken((ins), (pc), (regs))
206 #define inst_unconditional_flow_transfer(ins) \
207 db_inst_unconditional_flow_transfer(ins)
208
209 #endif /* SOFTWARE_SSTEP */
210
211 #define DB_MACHINE_COMMANDS
212 void dump_trapframe(struct trapframe *, void (*)(const char *, ...));
213
214
215
216 void db_machdep_init(void);
217
218 /* hardware breakpoint/watchpoint functions */
219 void aarch64_breakpoint_clear(int);
220 void aarch64_breakpoint_set(int, vaddr_t);
221 void aarch64_watchpoint_clear(int);
222 void aarch64_watchpoint_set(int, vaddr_t, int, int);
223 #define WATCHPOINT_ACCESS_LOAD 0x01
224 #define WATCHPOINT_ACCESS_STORE 0x02
225 #define WATCHPOINT_ACCESS_LOADSTORE 0x03
226 #define WATCHPOINT_ACCESS_MASK 0x03
227
228
229 #elif defined(__arm__)
230
231 #include <arm/db_machdep.h>
232
233 #endif
234
235 #endif /* _AARCH64_DB_MACHDEP_H_ */
236