remote_gdb.hh revision 2665:a124942bacb8 
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#ifndef __REMOTE_GDB_HH__
32#define __REMOTE_GDB_HH__
33
34#include <map>
35
36#include "base/kgdb.h"
37#include "cpu/pc_event.hh"
38#include "base/pollevent.hh"
39#include "base/socket.hh"
40
41class System;
42class ExecContext;
43class PhysicalMemory;
44
45class GDBListener;
46class RemoteGDB
47{
48  protected:
49    typedef TheISA::MachInst MachInst;
50  private:
51    friend void debugger();
52    friend class GDBListener;
53
54  protected:
55    class Event : public PollEvent
56    {
57      protected:
58        RemoteGDB *gdb;
59
60      public:
61        Event(RemoteGDB *g, int fd, int e);
62        void process(int revent);
63    };
64
65    friend class Event;
66    Event *event;
67    GDBListener *listener;
68    int number;
69
70  protected:
71    int fd;
72    uint64_t gdbregs[KGDB_NUMREGS];
73
74  protected:
75#ifdef notyet
76    label_t recover;
77#endif
78    bool active;
79    bool attached;
80
81    System *system;
82    PhysicalMemory *pmem;
83    ExecContext *context;
84
85  protected:
86    uint8_t getbyte();
87    void putbyte(uint8_t b);
88
89    int recv(char *data, int len);
90    void send(const char *data);
91
92  protected:
93    // Machine memory
94    bool read(Addr addr, size_t size, char *data);
95    bool write(Addr addr, size_t size, const char *data);
96
97    template <class T> T read(Addr addr);
98    template <class T> void write(Addr addr, T data);
99
100  public:
101    RemoteGDB(System *system, ExecContext *context);
102    ~RemoteGDB();
103
104    void replaceExecContext(ExecContext *xc) { context = xc; }
105
106    void attach(int fd);
107    void detach();
108    bool isattached();
109
110    bool acc(Addr addr, size_t len);
111    static int signal(int type);
112    bool trap(int type);
113
114  protected:
115    void getregs();
116    void setregs();
117
118    void clearSingleStep();
119    void setSingleStep();
120
121    PCEventQueue *getPcEventQueue();
122
123  protected:
124    class HardBreakpoint : public PCEvent
125    {
126      private:
127        RemoteGDB *gdb;
128
129      public:
130        int refcount;
131
132      public:
133        HardBreakpoint(RemoteGDB *_gdb, Addr addr);
134        std::string name() { return gdb->name() + ".hwbkpt"; }
135
136        virtual void process(ExecContext *xc);
137    };
138    friend class HardBreakpoint;
139
140    typedef std::map<Addr, HardBreakpoint *> break_map_t;
141    typedef break_map_t::iterator break_iter_t;
142    break_map_t hardBreakMap;
143
144    bool insertSoftBreak(Addr addr, size_t len);
145    bool removeSoftBreak(Addr addr, size_t len);
146    bool insertHardBreak(Addr addr, size_t len);
147    bool removeHardBreak(Addr addr, size_t len);
148
149  protected:
150    struct TempBreakpoint {
151        Addr	address;		// set here
152        MachInst	bkpt_inst;		// saved instruction at bkpt
153        int		init_count;		// number of times to skip bkpt
154        int		count;			// current count
155    };
156
157    TempBreakpoint notTakenBkpt;
158    TempBreakpoint takenBkpt;
159
160    void clearTempBreakpoint(TempBreakpoint &bkpt);
161    void setTempBreakpoint(TempBreakpoint &bkpt, Addr addr);
162
163  public:
164    std::string name();
165};
166
167template <class T>
168inline T
169RemoteGDB::read(Addr addr)
170{
171    T temp;
172    read(addr, sizeof(T), (char *)&temp);
173    return temp;
174}
175
176template <class T>
177inline void
178RemoteGDB::write(Addr addr, T data)
179{ write(addr, sizeof(T), (const char *)&data); }
180
181class GDBListener
182{
183  protected:
184    class Event : public PollEvent
185    {
186      protected:
187        GDBListener *listener;
188
189      public:
190        Event(GDBListener *l, int fd, int e);
191        void process(int revent);
192    };
193
194    friend class Event;
195    Event *event;
196
197  protected:
198    ListenSocket listener;
199    RemoteGDB *gdb;
200    int port;
201
202  public:
203    GDBListener(RemoteGDB *g, int p);
204    ~GDBListener();
205
206    void accept();
207    void listen();
208    std::string name();
209};
210
211#endif /* __REMOTE_GDB_H__ */
212