db_machdep.h revision 1.12 1 /* $NetBSD: db_machdep.h,v 1.12 2021/03/09 16:44:27 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 #include <ddb/db_user.h>
72
73 typedef long long int db_expr_t;
74 #define DDB_EXPR_FMT "ll"
75 typedef uintptr_t db_addr_t;
76
77 #define BKPT_ADDR(addr) (addr)
78 #define BKPT_SIZE 4
79 #ifdef __AARCH64EB__
80 #define BKPT_INSN 0x000020d4 /* brk #0 */
81 #else
82 #define BKPT_INSN 0xd4200000 /* brk #0 */
83 #endif
84 #define BKPT_SET(insn, addr) (BKPT_INSN)
85
86 typedef struct trapframe db_regs_t;
87 extern db_regs_t ddb_regs;
88 #define DDB_REGS (&ddb_regs)
89 #define PC_REGS(tf) ((tf)->tf_pc)
90
91 int kdb_trap(int, struct trapframe *);
92 #define DB_TRAP_UNKNOWN 0
93 #define DB_TRAP_BREAKPOINT 1
94 #define DB_TRAP_BKPT_INSN 2
95 #define DB_TRAP_WATCHPOINT 3
96 #define DB_TRAP_SW_STEP 4
97
98 #define IS_BREAKPOINT_TRAP(type, code) \
99 ((type) == DB_TRAP_BKPT_INSN)
100 #define IS_WATCHPOINT_TRAP(type, code) \
101 ((type) == DB_TRAP_BREAKPOINT || (type) == DB_TRAP_WATCHPOINT)
102
103 static inline bool
104 inst_return(db_expr_t insn)
105 {
106 LE32TOH(insn);
107 return ((insn & 0xfffffc1f) == 0xd65f0000); /* ret xN */
108 }
109
110 static inline bool
111 inst_trap_return(db_expr_t insn)
112 {
113 LE32TOH(insn);
114 return insn == 0xd69f03e0; /* eret */
115 }
116
117 static inline bool
118 inst_call(db_expr_t insn)
119 {
120 LE32TOH(insn);
121 return ((insn & 0xfc000000) == 0x94000000) /* bl */
122 || ((insn & 0xfffffc1f) == 0xd63f0000); /* blr */
123 }
124
125 static inline bool
126 inst_load(db_expr_t insn)
127 {
128 LE32TOH(insn);
129 return
130 ((insn & 0xffe00c00) == 0xb8800000) || /* ldursw */
131 /* ldrsw imm{pre,post}idx */
132 ((insn & 0xffe00400) == 0xb8800400) ||
133 ((insn & 0xffc00c00) == 0xb8800800) || /* ldrsw reg,ldtrsw */
134 ((insn & 0xffc00000) == 0xb9800000) || /* ldrsw immunsign */
135 ((insn & 0xffc00000) == 0x39400000) || /* ldrb immunsign */
136 ((insn & 0xff000000) == 0x98000000) || /* ldrsw literal */
137 /* ldpsw {pre,post}idx */
138 ((insn & 0xfec00000) == 0x68c00000) ||
139 /* ldrh immunsign,ldpsw signed */
140 ((insn & 0xefc00000) == 0x69400000) ||
141 ((insn & 0xbfff0000) == 0x887f0000) || /* ldaxp,ldxp */
142 ((insn & 0xbfc00000) == 0xb9400000) || /* ldr immunsign */
143 ((insn & 0xbfa00c00) == 0x38800000) || /* ldursh,ldursb */
144 /* ldrsh imm{pre,post}idx,ldrsb imm{pre,post}idx */
145 ((insn & 0xbfa00400) == 0x38800400) ||
146 /* ldrs[bh] reg,ldtrs[bh] */
147 ((insn & 0xbf800c00) == 0x38800800) ||
148 /* ldrsh immunsign,ldrsb immunsign */
149 ((insn & 0xbf800000) == 0x39800000) ||
150 ((insn & 0xbf000000) == 0x18000000) || /* ldr literal */
151 /* ldp {pre,post}idx,ldp signed,ldnp */
152 ((insn & 0x7e400000) == 0x28400000) ||
153 ((insn & 0x3ffffc00) == 0x085f7c00) || /* ldxr,ldxr[bh] */
154 ((insn & 0x3fe00c00) == 0x38400000) || /* ldur,ldur[bh] */
155 /* ldr imm{pre,post}idx,ldr[bh]_imm{pre,post}idx */
156 ((insn & 0x3fe00400) == 0x38400400) ||
157 /* ldtr,ldtr[bh],ldr_reg,ldr[bh]_reg */
158 ((insn & 0x3fc00c00) == 0x38400800) ||
159 /* ldaxr,ldaxr[bh],ldar,ldar[bh] */
160 ((insn & 0x3f7ffc00) == 0x085ffc00);
161 }
162
163 static inline bool
164 inst_store(db_expr_t insn)
165 {
166 LE32TOH(insn);
167 return
168 ((insn & 0xbfe00000) == 0x88200000) || /* stlxp,stxp */
169 /* stp {pre,post}idx,stp signed,stnp */
170 ((insn & 0x7e400000) == 0x28000000) ||
171 ((insn & 0x3ffffc00) == 0x089ffc00) || /* stlr,stlr[bh] */
172 /* stlxr,stlxr[bh],stxr,stxr[bh] */
173 ((insn & 0x3fe07c00) == 0x08007c00) ||
174 ((insn & 0x3fe00c00) == 0x38000000) || /* stur,stur[bh] */
175 /* str imm{pre,post}idx,str[bh] imm{pre,post}idx */
176 ((insn & 0x3fe00400) == 0x38000400) ||
177 /* str reg,str[bh] reg,sttr,sttr[bh] */
178 ((insn & 0x3fc00c00) == 0x38000800) ||
179 /* str immunsign,str[bh] immunsign */
180 ((insn & 0x3fc00000) == 0x39000000);
181 }
182
183 #define SOFTWARE_SSTEP
184
185 #ifdef SOFTWARE_SSTEP
186
187 static inline bool
188 inst_branch(db_expr_t insn)
189 {
190 LE32TOH(insn);
191 return
192 ((insn & 0xff000010) == 0x54000000) || /* b.cond */
193 ((insn & 0xfc000000) == 0x14000000) || /* b imm */
194 ((insn & 0xfffffc1f) == 0xd61f0000) || /* br */
195 ((insn & 0x7f000000) == 0x35000000) || /* cbnz */
196 ((insn & 0x7f000000) == 0x34000000) || /* cbz */
197 ((insn & 0x7f000000) == 0x37000000) || /* tbnz */
198 ((insn & 0x7f000000) == 0x36000000); /* tbz */
199 }
200
201 bool db_inst_unconditional_flow_transfer(db_expr_t);
202 db_addr_t db_branch_taken(db_expr_t, db_addr_t, db_regs_t *);
203
204 #define next_instr_address(pc, bd) \
205 ((bd) ? (pc) : ((pc) + 4))
206 #define branch_taken(ins, pc, regs) \
207 db_branch_taken((ins), (pc), (regs))
208 #define inst_unconditional_flow_transfer(ins) \
209 db_inst_unconditional_flow_transfer(ins)
210
211 #endif /* SOFTWARE_SSTEP */
212
213 #define DB_MACHINE_COMMANDS
214 void dump_trapframe(struct trapframe *, void (*)(const char *, ...));
215 void dump_switchframe(struct trapframe *, void (*)(const char *, ...));
216 const char *strdisasm(vaddr_t, uint64_t);
217 void db_machdep_init(void);
218
219 /* hardware breakpoint/watchpoint functions */
220 void aarch64_breakpoint_set(int, vaddr_t);
221 void aarch64_watchpoint_set(int, vaddr_t, int, int);
222 #define WATCHPOINT_ACCESS_LOAD 0x01
223 #define WATCHPOINT_ACCESS_STORE 0x02
224 #define WATCHPOINT_ACCESS_LOADSTORE 0x03
225 #define WATCHPOINT_ACCESS_MASK 0x03
226
227 #define DB_ELF_SYMBOLS
228
229 #elif defined(__arm__)
230
231 #include <arm/db_machdep.h>
232
233 #endif
234
235 #endif /* _AARCH64_DB_MACHDEP_H_ */
236