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