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