2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
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.
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.
28 * Authors: Nathan Binkert
31 #ifndef __REMOTE_GDB_HH__
32 #define __REMOTE_GDB_HH__
35 #include <sys/signal.h>
37 #include "arch/types.hh"
38 #include "cpu/pc_event.hh"
39 #include "base/pollevent.hh"
40 #include "base/socket.hh"
50 GDBSignal = '?', // last signal
51 GDBSetBaud = 'b', // set baud (depracated)
52 GDBSetBreak = 'B', // set breakpoint (depracated)
53 GDBCont = 'c', // resume
54 GDBAsyncCont = 'C', // continue with signal
55 GDBDebug = 'd', // toggle debug flags (deprecated)
56 GDBDetach = 'D', // detach remote gdb
57 GDBRegR = 'g', // read general registers
58 GDBRegW = 'G', // write general registers
59 GDBSetThread = 'H', // set thread
60 GDBCycleStep = 'i', // step a single cycle
61 GDBSigCycleStep = 'I', // signal then cycle step
62 GDBKill = 'k', // kill program
63 GDBMemR = 'm', // read memory
64 GDBMemW = 'M', // write memory
65 GDBReadReg = 'p', // read register
66 GDBSetReg = 'P', // write register
67 GDBQueryVar = 'q', // query variable
68 GDBSetVar = 'Q', // set variable
69 GDBReset = 'r', // reset system. (Deprecated)
70 GDBStep = 's', // step
71 GDBAsyncStep = 'S', // signal and step
72 GDBThreadAlive = 'T', // find out if the thread is alive
73 GDBTargetExit = 'W', // target exited
74 GDBBinaryDload = 'X', // write memory
75 GDBClrHwBkpt = 'z', // remove breakpoint or watchpoint
76 GDBSetHwBkpt = 'Z' // insert breakpoint or watchpoint
79 const char GDBStart = '$';
80 const char GDBEnd = '#';
81 const char GDBGoodP = '+';
82 const char GDBBadP = '-';
84 const int GDBPacketBufLen = 1024;
89 friend void debugger();
90 friend class GDBListener;
96 Addr hex2i(const char **);
97 //Address formats, break types, and gdb commands may change
98 //between architectures, so they're defined as virtual
100 virtual void mem2hex(void *, const void *, int);
101 virtual const char * hex2mem(void *, const char *, int);
102 virtual const char * break_type(char c);
103 virtual const char * gdb_command(char cmd);
106 class Event : public PollEvent
112 Event(BaseRemoteGDB *g, int fd, int e);
113 void process(int revent);
118 GDBListener *listener;
122 //The socket commands come in through
133 PhysicalMemory *pmem;
134 ThreadContext *context;
140 GdbRegCache(size_t newSize) : regs(new uint64_t[newSize]), size(newSize)
149 size_t bytes() { return size * sizeof(uint64_t); }
156 void putbyte(uint8_t b);
158 int recv(char *data, int len);
159 void send(const char *data);
163 virtual bool read(Addr addr, size_t size, char *data);
164 virtual bool write(Addr addr, size_t size, const char *data);
166 template <class T> T read(Addr addr);
167 template <class T> void write(Addr addr, T data);
170 BaseRemoteGDB(System *system, ThreadContext *context, size_t cacheSize);
171 virtual ~BaseRemoteGDB();
173 void replaceThreadContext(ThreadContext *tc) { context = tc; }
179 virtual bool acc(Addr addr, size_t len) = 0;
181 virtual bool breakpoint()
183 return trap(SIGTRAP);
187 virtual void getregs() = 0;
188 virtual void setregs() = 0;
190 virtual void clearSingleStep() = 0;
191 virtual void setSingleStep() = 0;
193 PCEventQueue *getPcEventQueue();
196 class HardBreakpoint : public PCEvent
205 HardBreakpoint(BaseRemoteGDB *_gdb, Addr addr);
206 std::string name() { return gdb->name() + ".hwbkpt"; }
208 virtual void process(ThreadContext *tc);
210 friend class HardBreakpoint;
212 typedef std::map<Addr, HardBreakpoint *> break_map_t;
213 typedef break_map_t::iterator break_iter_t;
214 break_map_t hardBreakMap;
216 bool insertSoftBreak(Addr addr, size_t len);
217 bool removeSoftBreak(Addr addr, size_t len);
218 bool insertHardBreak(Addr addr, size_t len);
219 bool removeHardBreak(Addr addr, size_t len);
222 void clearTempBreakpoint(Addr &bkpt);
223 void setTempBreakpoint(Addr bkpt);
231 BaseRemoteGDB::read(Addr addr)
234 read(addr, sizeof(T), (char *)&temp);
240 BaseRemoteGDB::write(Addr addr, T data)
241 { write(addr, sizeof(T), (const char *)&data); }
246 class Event : public PollEvent
249 GDBListener *listener;
252 Event(GDBListener *l, int fd, int e);
253 void process(int revent);
260 ListenSocket listener;
265 GDBListener(BaseRemoteGDB *g, int p);
273 #endif /* __REMOTE_GDB_H__ */