gdb/gdbserver/server.h

   1 /* Common definitions for remote server for GDB.
   2    Copyright (C) 1993-2019 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef GDBSERVER_SERVER_H
  20 #define GDBSERVER_SERVER_H
  21
  22 #include "common/common-defs.h"
  23
  24 gdb_static_assert (sizeof (CORE_ADDR) >= sizeof (void *));
  25
  26 #ifdef __MINGW32CE__
  27 #include "wincecompat.h"
  28 #endif
  29
  30 #include "common/version.h"
  31
  32 #if !HAVE_DECL_STRERROR
  33 #ifndef strerror
  34 extern char *strerror (int);    /* X3.159-1989  4.11.6.2 */
  35 #endif
  36 #endif
  37
  38 #if !HAVE_DECL_PERROR
  39 #ifndef perror
  40 extern void perror (const char *);
  41 #endif
  42 #endif
  43
  44 #if !HAVE_DECL_VASPRINTF
  45 extern int vasprintf(char **strp, const char *fmt, va_list ap);
  46 #endif
  47 #if !HAVE_DECL_VSNPRINTF
  48 int vsnprintf(char *str, size_t size, const char *format, va_list ap);
  49 #endif
  50
  51 #ifdef IN_PROCESS_AGENT
  52 #  define PROG "ipa"
  53 #else
  54 #  define PROG "gdbserver"
  55 #endif
  56
  57 #include "common/buffer.h"
  58 #include "common/xml-utils.h"
  59 #include "regcache.h"
  60 #include "common/gdb_signals.h"
  61 #include "target.h"
  62 #include "mem-break.h"
  63 #include "common/environ.h"
  64
  65 /* Target-specific functions */
  66
  67 void initialize_low ();
  68
  69 /* Public variables in server.c */
  70
  71 extern int server_waiting;
  72
  73 extern int disable_packet_vCont;
  74 extern int disable_packet_Tthread;
  75 extern int disable_packet_qC;
  76 extern int disable_packet_qfThreadInfo;
  77
  78 extern int run_once;
  79 extern int non_stop;
  80
  81 #if USE_WIN32API
  82 #include <winsock2.h>
  83 typedef SOCKET gdb_fildes_t;
  84 #else
  85 typedef int gdb_fildes_t;
  86 #endif
  87
  88 #include "event-loop.h"
  89
  90 /* Functions from server.c.  */
  91 extern void handle_v_requests (char *own_buf, int packet_len,
  92                                int *new_packet_len);
  93 extern int handle_serial_event (int err, gdb_client_data client_data);
  94 extern int handle_target_event (int err, gdb_client_data client_data);
  95
  96 /* Get rid of the currently pending stop replies that match PTID.  */
  97 extern void discard_queued_stop_replies (ptid_t ptid);
  98
  99 /* Returns true if there's a pending stop reply that matches PTID in
 100    the vStopped notifications queue.  */
 101 extern int in_queued_stop_replies (ptid_t ptid);
 102
 103 #include "remote-utils.h"
 104
 105 #include "utils.h"
 106 #include "debug.h"
 107 #include "common/gdb_vecs.h"
 108
 109 /* Maximum number of bytes to read/write at once.  The value here
 110    is chosen to fill up a packet (the headers account for the 32).  */
 111 #define MAXBUFBYTES(N) (((N)-32)/2)
 112
 113 /* Buffer sizes for transferring memory, registers, etc.   Set to a constant
 114    value to accomodate multiple register formats.  This value must be at least
 115    as large as the largest register set supported by gdbserver.  */
 116 #define PBUFSIZ 18432
 117
 118 /* Definition for an unknown syscall, used basically in error-cases.  */
 119 #define UNKNOWN_SYSCALL (-1)
 120
 121 /* Definition for any syscall, used for unfiltered syscall reporting.  */
 122 #define ANY_SYSCALL (-2)
 123
 124 /* After fork_inferior has been called, we need to adjust a few
 125    signals and call startup_inferior to start the inferior and consume
 126    its first events.  This is done here.  PID is the pid of the new
 127    inferior and PROGRAM is its name.  */
 128 extern void post_fork_inferior (int pid, const char *program);
 129
 130 /* Get the gdb_environ being used in the current session.  */
 131 extern gdb_environ *get_environ ();
 132
 133 extern unsigned long signal_pid;
 134
 135
 136 /* Description of the client remote protocol state for the currently
 137    connected client.  */
 138
 139 struct client_state
 140 {
 141   client_state ():
 142     own_buf ((char *) xmalloc (PBUFSIZ + 1))
 143   {}
 144
 145   /* The thread set with an `Hc' packet.  `Hc' is deprecated in favor of
 146      `vCont'.  Note the multi-process extensions made `vCont' a
 147      requirement, so `Hc pPID.TID' is pretty much undefined.  So
 148      CONT_THREAD can be null_ptid for no `Hc' thread, minus_one_ptid for
 149      resuming all threads of the process (again, `Hc' isn't used for
 150      multi-process), or a specific thread ptid_t.  */
 151   ptid_t cont_thread;
 152
 153   /* The thread set with an `Hg' packet.  */
 154   ptid_t general_thread;
 155
 156   int multi_process = 0;
 157   int report_fork_events = 0;
 158   int report_vfork_events = 0;
 159   int report_exec_events = 0;
 160   int report_thread_events = 0;
 161
 162   /* True if the "swbreak+" feature is active.  In that case, GDB wants
 163      us to report whether a trap is explained by a software breakpoint
 164      and for the server to handle PC adjustment if necessary on this
 165      target.  Only enabled if the target supports it.  */
 166   int swbreak_feature = 0;
 167   /* True if the "hwbreak+" feature is active.  In that case, GDB wants
 168      us to report whether a trap is explained by a hardware breakpoint.
 169      Only enabled if the target supports it.  */
 170   int hwbreak_feature = 0;
 171
 172   /* True if the "vContSupported" feature is active.  In that case, GDB
 173      wants us to report whether single step is supported in the reply to
 174      "vCont?" packet.  */
 175   int vCont_supported = 0;
 176
 177   /* Whether we should attempt to disable the operating system's address
 178      space randomization feature before starting an inferior.  */
 179   int disable_randomization = 1;
 180
 181   int pass_signals[GDB_SIGNAL_LAST];
 182   int program_signals[GDB_SIGNAL_LAST];
 183   int program_signals_p = 0;
 184
 185   /* Last status reported to GDB.  */
 186   struct target_waitstatus last_status;
 187   ptid_t last_ptid;
 188
 189   char *own_buf;
 190
 191   /* If true, then GDB has requested noack mode.  */
 192   int noack_mode = 0;
 193   /* If true, then we tell GDB to use noack mode by default.  */
 194   int transport_is_reliable = 0;
 195
 196   /* The traceframe to be used as the source of data to send back to
 197      GDB.  A value of -1 means to get data from the live program.  */
 198
 199   int current_traceframe = -1;
 200
 201 };
 202
 203 client_state &get_client_state ();
 204
 205 #include "gdbthread.h"
 206 #include "inferiors.h"
 207
 208 #endif /* GDBSERVER_SERVER_H */