gdb/gdbserver/target.h

   1 /* Target operations for the remote server for GDB.
   2    Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008
   3    Free Software Foundation, Inc.
   4
   5    Contributed by MontaVista Software.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #ifndef TARGET_H
  23 #define TARGET_H
  24
  25 /* This structure describes how to resume a particular thread (or
  26    all threads) based on the client's request.  If thread is -1, then
  27    this entry applies to all threads.  These are generally passed around
  28    as an array, and terminated by a thread == -1 entry.  */
  29
  30 struct thread_resume
  31 {
  32   unsigned long thread;
  33
  34   /* If non-zero, leave this thread stopped.  */
  35   int leave_stopped;
  36
  37   /* If non-zero, we want to single-step.  */
  38   int step;
  39
  40   /* If non-zero, send this signal when we resume.  */
  41   int sig;
  42 };
  43
  44 struct target_ops
  45 {
  46   /* Start a new process.
  47
  48      PROGRAM is a path to the program to execute.
  49      ARGS is a standard NULL-terminated array of arguments,
  50      to be passed to the inferior as ``argv''.
  51
  52      Returns the new PID on success, -1 on failure.  Registers the new
  53      process with the process list.  */
  54
  55   int (*create_inferior) (char *program, char **args);
  56
  57   /* Attach to a running process.
  58
  59      PID is the process ID to attach to, specified by the user
  60      or a higher layer.
  61
  62      Returns -1 if attaching is unsupported, 0 on success, and calls
  63      error() otherwise.  */
  64
  65   int (*attach) (unsigned long pid);
  66
  67   /* Kill all inferiors.  */
  68
  69   void (*kill) (void);
  70
  71   /* Detach from all inferiors.
  72      Return -1 on failure, and 0 on success.  */
  73
  74   int (*detach) (void);
  75
  76   /* Wait for inferiors to end.  */
  77
  78   void (*join) (void);
  79
  80   /* Return 1 iff the thread with process ID PID is alive.  */
  81
  82   int (*thread_alive) (unsigned long pid);
  83
  84   /* Resume the inferior process.  */
  85
  86   void (*resume) (struct thread_resume *resume_info);
  87
  88   /* Wait for the inferior process to change state.
  89
  90      STATUS will be filled in with a response code to send to GDB.
  91
  92      Returns the signal which caused the process to stop, in the
  93      remote protocol numbering (e.g. TARGET_SIGNAL_STOP), or the
  94      exit code as an integer if *STATUS is 'W'.  */
  95
  96   unsigned char (*wait) (char *status);
  97
  98   /* Fetch registers from the inferior process.
  99
 100      If REGNO is -1, fetch all registers; otherwise, fetch at least REGNO.  */
 101
 102   void (*fetch_registers) (int regno);
 103
 104   /* Store registers to the inferior process.
 105
 106      If REGNO is -1, store all registers; otherwise, store at least REGNO.  */
 107
 108   void (*store_registers) (int regno);
 109
 110   /* Read memory from the inferior process.  This should generally be
 111      called through read_inferior_memory, which handles breakpoint shadowing.
 112
 113      Read LEN bytes at MEMADDR into a buffer at MYADDR.
 114
 115      Returns 0 on success and errno on failure.  */
 116
 117   int (*read_memory) (CORE_ADDR memaddr, unsigned char *myaddr, int len);
 118
 119   /* Write memory to the inferior process.  This should generally be
 120      called through write_inferior_memory, which handles breakpoint shadowing.
 121
 122      Write LEN bytes from the buffer at MYADDR to MEMADDR.
 123
 124      Returns 0 on success and errno on failure.  */
 125
 126   int (*write_memory) (CORE_ADDR memaddr, const unsigned char *myaddr,
 127                        int len);
 128
 129   /* Query GDB for the values of any symbols we're interested in.
 130      This function is called whenever we receive a "qSymbols::"
 131      query, which corresponds to every time more symbols (might)
 132      become available.  NULL if we aren't interested in any
 133      symbols.  */
 134
 135   void (*look_up_symbols) (void);
 136
 137   /* Send an interrupt request to the inferior process,
 138      however is appropriate.  */
 139
 140   void (*request_interrupt) (void);
 141
 142   /* Read auxiliary vector data from the inferior process.
 143
 144      Read LEN bytes at OFFSET into a buffer at MYADDR.  */
 145
 146   int (*read_auxv) (CORE_ADDR offset, unsigned char *myaddr,
 147                     unsigned int len);
 148
 149   /* Insert and remove a hardware watchpoint.
 150      Returns 0 on success, -1 on failure and 1 on unsupported.
 151      The type is coded as follows:
 152        2 = write watchpoint
 153        3 = read watchpoint
 154        4 = access watchpoint
 155   */
 156
 157   int (*insert_watchpoint) (char type, CORE_ADDR addr, int len);
 158   int (*remove_watchpoint) (char type, CORE_ADDR addr, int len);
 159
 160   /* Returns 1 if target was stopped due to a watchpoint hit, 0 otherwise.  */
 161
 162   int (*stopped_by_watchpoint) (void);
 163
 164   /* Returns the address associated with the watchpoint that hit, if any;
 165      returns 0 otherwise.  */
 166
 167   CORE_ADDR (*stopped_data_address) (void);
 168
 169   /* Reports the text, data offsets of the executable.  This is
 170      needed for uclinux where the executable is relocated during load
 171      time.  */
 172
 173   int (*read_offsets) (CORE_ADDR *text, CORE_ADDR *data);
 174
 175   /* Fetch the address associated with a specific thread local storage
 176      area, determined by the specified THREAD, OFFSET, and LOAD_MODULE.
 177      Stores it in *ADDRESS and returns zero on success; otherwise returns
 178      an error code.  A return value of -1 means this system does not
 179      support the operation.  */
 180
 181   int (*get_tls_address) (struct thread_info *thread, CORE_ADDR offset,
 182                           CORE_ADDR load_module, CORE_ADDR *address);
 183
 184    /* Read/Write from/to spufs using qXfer packets.  */
 185   int (*qxfer_spu) (const char *annex, unsigned char *readbuf,
 186                     unsigned const char *writebuf, CORE_ADDR offset, int len);
 187
 188   /* Fill BUF with an hostio error packet representing the last hostio
 189      error.  */
 190   void (*hostio_last_error) (char *buf);
 191
 192   /* Read/Write OS data using qXfer packets.  */
 193   int (*qxfer_osdata) (const char *annex, unsigned char *readbuf,
 194                        unsigned const char *writebuf, CORE_ADDR offset,
 195                        int len);
 196 };
 197
 198 extern struct target_ops *the_target;
 199
 200 void set_target_ops (struct target_ops *);
 201
 202 #define create_inferior(program, args) \
 203   (*the_target->create_inferior) (program, args)
 204
 205 #define myattach(pid) \
 206   (*the_target->attach) (pid)
 207
 208 #define kill_inferior() \
 209   (*the_target->kill) ()
 210
 211 #define detach_inferior() \
 212   (*the_target->detach) ()
 213
 214 #define mythread_alive(pid) \
 215   (*the_target->thread_alive) (pid)
 216
 217 #define fetch_inferior_registers(regno) \
 218   (*the_target->fetch_registers) (regno)
 219
 220 #define store_inferior_registers(regno) \
 221   (*the_target->store_registers) (regno)
 222
 223 #define join_inferior() \
 224   (*the_target->join) ()
 225
 226 unsigned char mywait (char *statusp, int connected_wait);
 227
 228 int read_inferior_memory (CORE_ADDR memaddr, unsigned char *myaddr, int len);
 229
 230 int write_inferior_memory (CORE_ADDR memaddr, const unsigned char *myaddr,
 231                            int len);
 232
 233 void set_desired_inferior (int id);
 234
 235 #endif /* TARGET_H */