base/remote_gdb.hh

   1 /*
   2  * Copyright (c) 2003 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
  39 class System;
  40 class ExecContext;
  41 class PhysicalMemory;
  42
  43 class 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         HardBreakpoint(RemoteGDB *_gdb, Addr addr);
 120
 121         int refcount;
 122         virtual void process(ExecContext *xc);
 123     };
 124     friend class HardBreakpoint;
 125
 126     typedef std::map<Addr, HardBreakpoint *> break_map_t;
 127     typedef break_map_t::iterator break_iter_t;
 128     break_map_t hardBreakMap;
 129
 130     bool insertSoftBreak(Addr addr, size_t len);
 131     bool removeSoftBreak(Addr addr, size_t len);
 132     bool insertHardBreak(Addr addr, size_t len);
 133     bool removeHardBreak(Addr addr, size_t len);
 134
 135   protected:
 136     struct TempBreakpoint {
 137         Addr    address;                // set here
 138         MachInst        bkpt_inst;              // saved instruction at bkpt
 139         int             init_count;             // number of times to skip bkpt
 140         int             count;                  // current count
 141     };
 142
 143     TempBreakpoint notTakenBkpt;
 144     TempBreakpoint takenBkpt;
 145
 146     void clearTempBreakpoint(TempBreakpoint &bkpt);
 147     void setTempBreakpoint(TempBreakpoint &bkpt, Addr addr);
 148 };
 149
 150 template <class T>
 151 inline T
 152 RemoteGDB::read(Addr addr)
 153 {
 154     T temp;
 155     read(addr, sizeof(T), (char *)&temp);
 156     return temp;
 157 }
 158
 159 template <class T>
 160 inline void
 161 RemoteGDB::write(Addr addr, T data)
 162 { write(addr, sizeof(T), (const char *)&data); }
 163
 164 class GDBListener
 165 {
 166   protected:
 167     class Event : public PollEvent
 168     {
 169       protected:
 170         GDBListener *listener;
 171
 172       public:
 173         Event(GDBListener *l, int fd, int e);
 174         void process(int revent);
 175     };
 176
 177     friend class Event;
 178     Event *event;
 179
 180   protected:
 181     ListenSocket listener;
 182     RemoteGDB *gdb;
 183     int port;
 184
 185   public:
 186     GDBListener(RemoteGDB *g, int p);
 187     ~GDBListener();
 188
 189     void accept();
 190     void listen();
 191 };
 192
 193 #endif /* __REMOTE_GDB_H__ */