1 /* Common definitions for remote server for GDB.
2 Copyright (C) 1993, 1995, 1997-2000, 2002-2012 Free Software
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "build-gnulib-gdbserver/config.h"
27 #include "wincecompat.h"
45 /* On some systems such as MinGW, alloca is declared in malloc.h
46 (there is no alloca.h). */
51 #if !HAVE_DECL_STRERROR
53 extern char *strerror (int); /* X3.159-1989 4.11.6.2 */
59 extern void perror (const char *);
63 #if !HAVE_DECL_VASPRINTF
64 extern int vasprintf(char **strp, const char *fmt, va_list ap);
66 #if !HAVE_DECL_VSNPRINTF
67 int vsnprintf(char *str, size_t size, const char *format, va_list ap);
71 #if defined(__GNUC__) && (__GNUC__ > 2 \
72 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
73 #define ATTR_NORETURN __attribute__ ((noreturn))
75 #define ATTR_NORETURN /* nothing */
80 #if defined(__GNUC__) && (__GNUC__ > 2 \
81 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
82 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
84 #define ATTR_FORMAT(type, x, y) /* nothing */
89 #if defined(__GNUC__) && (__GNUC__ >= 3)
90 #define ATTR_MALLOC __attribute__ ((__malloc__))
92 #define ATTR_MALLOC /* nothing */
96 /* Define underscore macro, if not available, to be able to use it inside
97 code shared with gdb in common directory. */
99 #define _(String) (String)
102 #ifdef IN_PROCESS_AGENT
105 # define PROG "gdbserver"
108 /* A type used for binary buffers. */
109 typedef unsigned char gdb_byte;
113 #include "xml-utils.h"
114 #include "gdb_locale.h"
116 /* FIXME: This should probably be autoconf'd for. It's an integer type at
117 least the size of a (void *). */
118 typedef long long CORE_ADDR;
120 typedef long long LONGEST;
121 typedef unsigned long long ULONGEST;
123 /* Generic information for tracking a list of ``inferiors'' - threads,
127 struct inferior_list_entry *head;
128 struct inferior_list_entry *tail;
130 struct inferior_list_entry
133 struct inferior_list_entry *next;
140 #include "regcache.h"
141 #include "gdb/signals.h"
142 #include "gdb_signals.h"
144 #include "mem-break.h"
145 #include "gdbthread.h"
149 struct inferior_list_entry entry;
156 struct raw_breakpoint;
157 struct fast_tracepoint_jump;
158 struct process_info_private;
162 struct inferior_list_entry head;
164 /* Nonzero if this child process was attached rather than
168 /* True if GDB asked us to detach from this process, but we remained
172 /* The symbol cache. */
173 struct sym_cache *symbol_cache;
175 /* The list of memory breakpoints. */
176 struct breakpoint *breakpoints;
178 /* The list of raw memory breakpoints. */
179 struct raw_breakpoint *raw_breakpoints;
181 /* The list of installed fast tracepoints. */
182 struct fast_tracepoint_jump *fast_tracepoint_jumps;
184 /* Private target data. */
185 struct process_info_private *private;
188 /* Return a pointer to the process that corresponds to the current
189 thread (current_inferior). It is an error to call this if there is
190 no current thread selected. */
192 struct process_info *current_process (void);
193 struct process_info *get_thread_process (struct thread_info *);
195 /* Target-specific functions */
197 void initialize_low ();
199 /* From inferiors.c. */
201 extern struct inferior_list all_processes;
202 extern struct inferior_list all_dlls;
203 extern int dlls_changed;
204 extern void clear_dlls (void);
206 void add_inferior_to_list (struct inferior_list *list,
207 struct inferior_list_entry *new_inferior);
208 void for_each_inferior (struct inferior_list *list,
209 void (*action) (struct inferior_list_entry *));
211 extern struct thread_info *current_inferior;
212 void remove_inferior (struct inferior_list *list,
213 struct inferior_list_entry *entry);
215 struct process_info *add_process (int pid, int attached);
216 void remove_process (struct process_info *process);
217 struct process_info *find_process_pid (int pid);
218 int have_started_inferiors_p (void);
219 int have_attached_inferiors_p (void);
221 ptid_t thread_id_to_gdb_id (ptid_t);
222 ptid_t thread_to_gdb_id (struct thread_info *);
223 ptid_t gdb_id_to_thread_id (ptid_t);
225 void clear_inferiors (void);
226 struct inferior_list_entry *find_inferior
227 (struct inferior_list *,
228 int (*func) (struct inferior_list_entry *,
231 struct inferior_list_entry *find_inferior_id (struct inferior_list *list,
233 void *inferior_target_data (struct thread_info *);
234 void set_inferior_target_data (struct thread_info *, void *);
235 void *inferior_regcache_data (struct thread_info *);
236 void set_inferior_regcache_data (struct thread_info *, void *);
238 void loaded_dll (const char *name, CORE_ADDR base_addr);
239 void unloaded_dll (const char *name, CORE_ADDR base_addr);
241 /* Public variables in server.c */
243 extern ptid_t cont_thread;
244 extern ptid_t general_thread;
246 extern int server_waiting;
247 extern int debug_threads;
248 extern int debug_hw_points;
249 extern int pass_signals[];
250 extern int program_signals[];
251 extern int program_signals_p;
253 extern jmp_buf toplevel;
255 extern int disable_packet_vCont;
256 extern int disable_packet_Tthread;
257 extern int disable_packet_qC;
258 extern int disable_packet_qfThreadInfo;
261 extern int multi_process;
264 extern int disable_randomization;
267 #include <winsock2.h>
268 typedef SOCKET gdb_fildes_t;
270 typedef int gdb_fildes_t;
273 /* Functions from event-loop.c. */
274 typedef void *gdb_client_data;
275 typedef int (handler_func) (int, gdb_client_data);
276 typedef int (callback_handler_func) (gdb_client_data);
278 extern void delete_file_handler (gdb_fildes_t fd);
279 extern void add_file_handler (gdb_fildes_t fd, handler_func *proc,
280 gdb_client_data client_data);
281 extern int append_callback_event (callback_handler_func *proc,
282 gdb_client_data client_data);
283 extern void delete_callback_event (int id);
285 extern void start_event_loop (void);
287 /* Functions from server.c. */
288 extern int handle_serial_event (int err, gdb_client_data client_data);
289 extern int handle_target_event (int err, gdb_client_data client_data);
291 extern void push_event (ptid_t ptid, struct target_waitstatus *status);
293 /* Functions from hostio.c. */
294 extern int handle_vFile (char *, int, int *);
296 /* Functions from hostio-errno.c. */
297 extern void hostio_last_error_from_errno (char *own_buf);
299 /* From remote-utils.c */
301 extern int remote_debug;
302 extern int noack_mode;
303 extern int transport_is_reliable;
305 int gdb_connected (void);
307 #define STDIO_CONNECTION_NAME "stdio"
308 int remote_connection_is_stdio (void);
310 ptid_t read_ptid (char *buf, char **obuf);
311 char *write_ptid (char *buf, ptid_t ptid);
313 int putpkt (char *buf);
314 int putpkt_binary (char *buf, int len);
315 int putpkt_notif (char *buf);
316 int getpkt (char *buf);
317 void remote_prepare (char *name);
318 void remote_open (char *name);
319 void remote_close (void);
320 void write_ok (char *buf);
321 void write_enn (char *buf);
322 void initialize_async_io (void);
323 void enable_async_io (void);
324 void disable_async_io (void);
325 void check_remote_input_interrupt_request (void);
326 void convert_ascii_to_int (const char *from, unsigned char *to, int n);
327 void convert_int_to_ascii (const unsigned char *from, char *to, int n);
328 void new_thread_notify (int id);
329 void dead_thread_notify (int id);
330 void prepare_resume_reply (char *buf, ptid_t ptid,
331 struct target_waitstatus *status);
333 const char *decode_address_to_semicolon (CORE_ADDR *addrp, const char *start);
334 void decode_address (CORE_ADDR *addrp, const char *start, int len);
335 void decode_m_packet (char *from, CORE_ADDR * mem_addr_ptr,
336 unsigned int *len_ptr);
337 void decode_M_packet (char *from, CORE_ADDR * mem_addr_ptr,
338 unsigned int *len_ptr, unsigned char **to_p);
339 int decode_X_packet (char *from, int packet_len, CORE_ADDR * mem_addr_ptr,
340 unsigned int *len_ptr, unsigned char **to_p);
341 int decode_xfer_write (char *buf, int packet_len,
342 CORE_ADDR *offset, unsigned int *len,
343 unsigned char *data);
344 int decode_search_memory_packet (const char *buf, int packet_len,
345 CORE_ADDR *start_addrp,
346 CORE_ADDR *search_space_lenp,
348 unsigned int *pattern_lenp);
350 int unhexify (char *bin, const char *hex, int count);
351 int hexify (char *hex, const char *bin, int count);
352 int remote_escape_output (const gdb_byte *buffer, int len,
353 gdb_byte *out_buf, int *out_len,
355 char *unpack_varlen_hex (char *buff, ULONGEST *result);
357 void clear_symbol_cache (struct sym_cache **symcache_p);
358 int look_up_one_symbol (const char *name, CORE_ADDR *addrp, int may_ask_gdb);
360 int relocate_instruction (CORE_ADDR *to, CORE_ADDR oldloc);
362 void monitor_output (const char *msg);
364 /* Functions from utils.c */
365 #include "common-utils.h"
367 void *xmalloc (size_t) ATTR_MALLOC;
368 void *xrealloc (void *, size_t);
369 void *xcalloc (size_t, size_t) ATTR_MALLOC;
370 char *xstrdup (const char *) ATTR_MALLOC;
371 void freeargv (char **argv);
373 void perror_with_name (const char *string);
374 void error (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
375 void fatal (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
376 void warning (const char *string,...) ATTR_FORMAT (printf, 1, 2);
377 char *paddress (CORE_ADDR addr);
378 char *pulongest (ULONGEST u);
379 char *plongest (LONGEST l);
380 char *phex_nz (ULONGEST l, int sizeof_l);
381 char *pfildes (gdb_fildes_t fd);
383 #include "gdb_assert.h"
385 /* Maximum number of bytes to read/write at once. The value here
386 is chosen to fill up a packet (the headers account for the 32). */
387 #define MAXBUFBYTES(N) (((N)-32)/2)
389 /* Buffer sizes for transferring memory, registers, etc. Set to a constant
390 value to accomodate multiple register formats. This value must be at least
391 as large as the largest register set supported by gdbserver. */
392 #define PBUFSIZ 16384
394 /* Functions from tracepoint.c */
396 /* Size for a small buffer to report problems from the in-process
397 agent back to GDBserver. */
398 #define IPA_BUFSIZ 100
400 void initialize_tracepoint (void);
403 extern int disconnected_tracing;
405 void tracepoint_look_up_symbols (void);
407 void stop_tracing (void);
409 int handle_tracepoint_general_set (char *own_buf);
410 int handle_tracepoint_query (char *own_buf);
412 int tracepoint_finished_step (struct thread_info *tinfo, CORE_ADDR stop_pc);
413 int tracepoint_was_hit (struct thread_info *tinfo, CORE_ADDR stop_pc);
415 void release_while_stepping_state_list (struct thread_info *tinfo);
417 extern int current_traceframe;
419 int in_readonly_region (CORE_ADDR addr, ULONGEST length);
420 int traceframe_read_mem (int tfnum, CORE_ADDR addr,
421 unsigned char *buf, ULONGEST length,
423 int fetch_traceframe_registers (int tfnum,
424 struct regcache *regcache,
427 int traceframe_read_sdata (int tfnum, ULONGEST offset,
428 unsigned char *buf, ULONGEST length,
431 int traceframe_read_info (int tfnum, struct buffer *buffer);
433 /* If a thread is determined to be collecting a fast tracepoint, this
434 structure holds the collect status. */
436 struct fast_tpoint_collect_status
438 /* The tracepoint that is presently being collected. */
440 CORE_ADDR tpoint_addr;
442 /* The address range in the jump pad of where the original
443 instruction the tracepoint jump was inserted was relocated
445 CORE_ADDR adjusted_insn_addr;
446 CORE_ADDR adjusted_insn_addr_end;
449 int fast_tracepoint_collecting (CORE_ADDR thread_area,
451 struct fast_tpoint_collect_status *status);
452 void force_unlock_trace_buffer (void);
454 int handle_tracepoint_bkpts (struct thread_info *tinfo, CORE_ADDR stop_pc);
456 #ifdef IN_PROCESS_AGENT
457 void initialize_low_tracepoint (void);
458 void supply_fast_tracepoint_registers (struct regcache *regcache,
459 const unsigned char *regs);
460 void supply_static_tracepoint_registers (struct regcache *regcache,
461 const unsigned char *regs,
463 void set_trampoline_buffer_space (CORE_ADDR begin, CORE_ADDR end,
466 void stop_tracing (void);
468 int claim_trampoline_space (ULONGEST used, CORE_ADDR *trampoline);
469 int have_fast_tracepoint_trampoline_buffer (char *msgbuf);
470 void gdb_agent_about_to_close (int pid);
475 /* Do memory copies for bytecodes. */
476 /* Do the recording of memory blocks for actions and bytecodes. */
478 int agent_mem_read (struct traceframe *tframe,
479 unsigned char *to, CORE_ADDR from,
482 LONGEST agent_get_trace_state_variable_value (int num);
483 void agent_set_trace_state_variable_value (int num, LONGEST val);
485 /* Record the value of a trace state variable. */
487 int agent_tsv_read (struct traceframe *tframe, int n);
488 int agent_mem_read_string (struct traceframe *tframe,
493 /* Bytecode compilation function vector. */
497 void (*emit_prologue) (void);
498 void (*emit_epilogue) (void);
499 void (*emit_add) (void);
500 void (*emit_sub) (void);
501 void (*emit_mul) (void);
502 void (*emit_lsh) (void);
503 void (*emit_rsh_signed) (void);
504 void (*emit_rsh_unsigned) (void);
505 void (*emit_ext) (int arg);
506 void (*emit_log_not) (void);
507 void (*emit_bit_and) (void);
508 void (*emit_bit_or) (void);
509 void (*emit_bit_xor) (void);
510 void (*emit_bit_not) (void);
511 void (*emit_equal) (void);
512 void (*emit_less_signed) (void);
513 void (*emit_less_unsigned) (void);
514 void (*emit_ref) (int size);
515 void (*emit_if_goto) (int *offset_p, int *size_p);
516 void (*emit_goto) (int *offset_p, int *size_p);
517 void (*write_goto_address) (CORE_ADDR from, CORE_ADDR to, int size);
518 void (*emit_const) (LONGEST num);
519 void (*emit_call) (CORE_ADDR fn);
520 void (*emit_reg) (int reg);
521 void (*emit_pop) (void);
522 void (*emit_stack_flush) (void);
523 void (*emit_zero_ext) (int arg);
524 void (*emit_swap) (void);
525 void (*emit_stack_adjust) (int n);
527 /* Emit code for a generic function that takes one fixed integer
528 argument and returns a 64-bit int (for instance, tsv getter). */
529 void (*emit_int_call_1) (CORE_ADDR fn, int arg1);
531 /* Emit code for a generic function that takes one fixed integer
532 argument and a 64-bit int from the top of the stack, and returns
533 nothing (for instance, tsv setter). */
534 void (*emit_void_call_2) (CORE_ADDR fn, int arg1);
536 /* Emit code specialized for common combinations of compare followed
538 void (*emit_eq_goto) (int *offset_p, int *size_p);
539 void (*emit_ne_goto) (int *offset_p, int *size_p);
540 void (*emit_lt_goto) (int *offset_p, int *size_p);
541 void (*emit_le_goto) (int *offset_p, int *size_p);
542 void (*emit_gt_goto) (int *offset_p, int *size_p);
543 void (*emit_ge_goto) (int *offset_p, int *size_p);
546 /* Returns the address of the get_raw_reg function in the IPA. */
547 CORE_ADDR get_raw_reg_func_addr (void);
548 /* Returns the address of the get_trace_state_variable_value
549 function in the IPA. */
550 CORE_ADDR get_get_tsv_func_addr (void);
551 /* Returns the address of the set_trace_state_variable_value
552 function in the IPA. */
553 CORE_ADDR get_set_tsv_func_addr (void);
555 CORE_ADDR current_insn_ptr;
558 /* Version information, from version.c. */
559 extern const char version[];
560 extern const char host_name[];
562 #endif /* SERVER_H */