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