gdbserver/server.h

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