Implement Ali's review feedback.
[gem5.git] / src / arch / alpha / remote_gdb.cc
1 /*
2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * 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
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Nathan Binkert
29 */
30
31 /*
32 * Copyright (c) 1990, 1993 The Regents of the University of California
33 * All rights reserved.
34 *
35 * This software was developed by the Computer Systems Engineering group
36 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
37 * contributed to Berkeley.
38 *
39 * All advertising materials mentioning features or use of this software
40 * must display the following acknowledgement:
41 * This product includes software developed by the University of
42 * California, Lawrence Berkeley Laboratories.
43 *
44 * Redistribution and use in source and binary forms, with or without
45 * modification, are permitted provided that the following conditions
46 * are met:
47 * 1. Redistributions of source code must retain the above copyright
48 * notice, this list of conditions and the following disclaimer.
49 * 2. Redistributions in binary form must reproduce the above copyright
50 * notice, this list of conditions and the following disclaimer in the
51 * documentation and/or other materials provided with the distribution.
52 * 3. All advertising materials mentioning features or use of this software
53 * must display the following acknowledgement:
54 * This product includes software developed by the University of
55 * California, Berkeley and its contributors.
56 * 4. Neither the name of the University nor the names of its contributors
57 * may be used to endorse or promote products derived from this software
58 * without specific prior written permission.
59 *
60 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
61 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
62 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
63 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
64 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
65 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
66 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
67 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
68 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
69 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
70 * SUCH DAMAGE.
71 *
72 * @(#)kgdb_stub.c 8.4 (Berkeley) 1/12/94
73 */
74
75 /*-
76 * Copyright (c) 2001 The NetBSD Foundation, Inc.
77 * All rights reserved.
78 *
79 * This code is derived from software contributed to The NetBSD Foundation
80 * by Jason R. Thorpe.
81 *
82 * Redistribution and use in source and binary forms, with or without
83 * modification, are permitted provided that the following conditions
84 * are met:
85 * 1. Redistributions of source code must retain the above copyright
86 * notice, this list of conditions and the following disclaimer.
87 * 2. Redistributions in binary form must reproduce the above copyright
88 * notice, this list of conditions and the following disclaimer in the
89 * documentation and/or other materials provided with the distribution.
90 * 3. All advertising materials mentioning features or use of this software
91 * must display the following acknowledgement:
92 * This product includes software developed by the NetBSD
93 * Foundation, Inc. and its contributors.
94 * 4. Neither the name of The NetBSD Foundation nor the names of its
95 * contributors may be used to endorse or promote products derived
96 * from this software without specific prior written permission.
97 *
98 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
99 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
100 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
101 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
102 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
103 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
104 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
105 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
106 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
107 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
108 * POSSIBILITY OF SUCH DAMAGE.
109 */
110
111 /*
112 * $NetBSD: kgdb_stub.c,v 1.8 2001/07/07 22:58:00 wdk Exp $
113 *
114 * Taken from NetBSD
115 *
116 * "Stub" to allow remote cpu to debug over a serial line using gdb.
117 */
118
119 #include <sys/signal.h>
120 #include <unistd.h>
121
122 #include <string>
123
124
125 #include "arch/alpha/kgdb.h"
126 #include "arch/alpha/regredir.hh"
127 #include "arch/alpha/remote_gdb.hh"
128 #include "arch/alpha/utility.hh"
129 #include "arch/alpha/vtophys.hh"
130 #include "base/intmath.hh"
131 #include "base/remote_gdb.hh"
132 #include "base/socket.hh"
133 #include "base/trace.hh"
134 #include "cpu/decode.hh"
135 #include "cpu/static_inst.hh"
136 #include "cpu/thread_context.hh"
137 #include "debug/GDBAcc.hh"
138 #include "debug/GDBMisc.hh"
139 #include "mem/physical.hh"
140 #include "mem/port.hh"
141 #include "sim/system.hh"
142 #include "sim/full_system.hh"
143
144 using namespace std;
145 using namespace AlphaISA;
146
147 RemoteGDB::RemoteGDB(System *_system, ThreadContext *tc)
148 : BaseRemoteGDB(_system, tc, KGDB_NUMREGS)
149 {
150 memset(gdbregs.regs, 0, gdbregs.bytes());
151 }
152
153 /*
154 * Determine if the mapping at va..(va+len) is valid.
155 */
156 bool
157 RemoteGDB::acc(Addr va, size_t len)
158 {
159 if (!FullSystem)
160 panic("acc function needs to be rewritten for SE mode\n");
161
162 Addr last_va;
163
164 va = TruncPage(va);
165 last_va = RoundPage(va + len);
166
167 do {
168 if (IsK0Seg(va)) {
169 if (va < (K0SegBase + pmem->size())) {
170 DPRINTF(GDBAcc, "acc: Mapping is valid K0SEG <= "
171 "%#x < K0SEG + size\n", va);
172 return true;
173 } else {
174 DPRINTF(GDBAcc, "acc: Mapping invalid %#x "
175 "> K0SEG + size\n", va);
176 return false;
177 }
178 }
179
180 /**
181 * This code says that all accesses to palcode (instruction
182 * and data) are valid since there isn't a va->pa mapping
183 * because palcode is accessed physically. At some point this
184 * should probably be cleaned up but there is no easy way to
185 * do it.
186 */
187
188 if (PcPAL(va) || va < 0x10000)
189 return true;
190
191 Addr ptbr = context->readMiscRegNoEffect(IPR_PALtemp20);
192 PageTableEntry pte =
193 kernel_pte_lookup(context->getPhysProxy(), ptbr, va);
194 if (!pte.valid()) {
195 DPRINTF(GDBAcc, "acc: %#x pte is invalid\n", va);
196 return false;
197 }
198 va += PageBytes;
199 } while (va < last_va);
200
201 DPRINTF(GDBAcc, "acc: %#x mapping is valid\n", va);
202 return true;
203 }
204
205 /*
206 * Translate the kernel debugger register format into the GDB register
207 * format.
208 */
209 void
210 RemoteGDB::getregs()
211 {
212 memset(gdbregs.regs, 0, gdbregs.bytes());
213
214 gdbregs.regs[KGDB_REG_PC] = context->pcState().pc();
215
216 // @todo: Currently this is very Alpha specific.
217 if (PcPAL(gdbregs.regs[KGDB_REG_PC])) {
218 for (int i = 0; i < NumIntArchRegs; ++i) {
219 gdbregs.regs[i] = context->readIntReg(reg_redir[i]);
220 }
221 } else {
222 for (int i = 0; i < NumIntArchRegs; ++i) {
223 gdbregs.regs[i] = context->readIntReg(i);
224 }
225 }
226
227 #ifdef KGDB_FP_REGS
228 for (int i = 0; i < NumFloatArchRegs; ++i) {
229 gdbregs.regs[i + KGDB_REG_F0] = context->readFloatRegBits(i);
230 }
231 #endif
232 }
233
234 /*
235 * Translate the GDB register format into the kernel debugger register
236 * format.
237 */
238 void
239 RemoteGDB::setregs()
240 {
241 // @todo: Currently this is very Alpha specific.
242 if (PcPAL(gdbregs.regs[KGDB_REG_PC])) {
243 for (int i = 0; i < NumIntArchRegs; ++i) {
244 context->setIntReg(reg_redir[i], gdbregs.regs[i]);
245 }
246 } else {
247 for (int i = 0; i < NumIntArchRegs; ++i) {
248 context->setIntReg(i, gdbregs.regs[i]);
249 }
250 }
251
252 #ifdef KGDB_FP_REGS
253 for (int i = 0; i < NumFloatArchRegs; ++i) {
254 context->setFloatRegBits(i, gdbregs.regs[i + KGDB_REG_F0]);
255 }
256 #endif
257 context->pcState(gdbregs.regs[KGDB_REG_PC]);
258 }
259
260 void
261 RemoteGDB::clearSingleStep()
262 {
263 DPRINTF(GDBMisc, "clearSingleStep bt_addr=%#x nt_addr=%#x\n",
264 takenBkpt, notTakenBkpt);
265
266 if (takenBkpt != 0)
267 clearTempBreakpoint(takenBkpt);
268
269 if (notTakenBkpt != 0)
270 clearTempBreakpoint(notTakenBkpt);
271 }
272
273 void
274 RemoteGDB::setSingleStep()
275 {
276 PCState pc = context->pcState();
277 PCState bpc;
278 bool set_bt = false;
279
280 // User was stopped at pc, e.g. the instruction at pc was not
281 // executed.
282 MachInst inst = read<MachInst>(pc.pc());
283 StaticInstPtr si = context->getDecoderPtr()->decode(inst, pc.pc());
284 if (si->hasBranchTarget(pc, context, bpc)) {
285 // Don't bother setting a breakpoint on the taken branch if it
286 // is the same as the next pc
287 if (bpc.pc() != pc.npc())
288 set_bt = true;
289 }
290
291 DPRINTF(GDBMisc, "setSingleStep bt_addr=%#x nt_addr=%#x\n",
292 takenBkpt, notTakenBkpt);
293
294 setTempBreakpoint(notTakenBkpt = pc.npc());
295
296 if (set_bt)
297 setTempBreakpoint(takenBkpt = bpc.pc());
298 }
299
300 // Write bytes to kernel address space for debugger.
301 bool
302 RemoteGDB::write(Addr vaddr, size_t size, const char *data)
303 {
304 if (BaseRemoteGDB::write(vaddr, size, data)) {
305 #ifdef IMB
306 alpha_pal_imb();
307 #endif
308 return true;
309 } else {
310 return false;
311 }
312 }
313
314
315 bool
316 RemoteGDB::insertHardBreak(Addr addr, size_t len)
317 {
318 warn_once("Breakpoints do not work in Alpha PAL mode.\n"
319 " See PCEventQueue::doService() in cpu/pc_event.cc.\n");
320 return BaseRemoteGDB::insertHardBreak(addr, len);
321 }