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