gdb/gdbserver/target.h

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