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/>. */
26 #include "wincecompat.h"
44 /* On some systems such as MinGW, alloca is declared in malloc.h
45 (there is no alloca.h). */
50 #if !HAVE_DECL_STRERROR
52 extern char *strerror (int); /* X3.159-1989 4.11.6.2 */
58 extern void perror (const char *);
63 extern void *memmem (const void *, size_t , const void *, size_t);
66 #if !HAVE_DECL_VASPRINTF
67 extern int vasprintf(char **strp, const char *fmt, va_list ap);
69 #if !HAVE_DECL_VSNPRINTF
70 int vsnprintf(char *str, size_t size, const char *format, va_list ap);
74 #if defined(__GNUC__) && (__GNUC__ > 2 \
75 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
76 #define ATTR_NORETURN __attribute__ ((noreturn))
78 #define ATTR_NORETURN /* nothing */
83 #if defined(__GNUC__) && (__GNUC__ > 2 \
84 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
85 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
87 #define ATTR_FORMAT(type, x, y) /* nothing */
92 #if defined(__GNUC__) && (__GNUC__ >= 3)
93 #define ATTR_MALLOC __attribute__ ((__malloc__))
95 #define ATTR_MALLOC /* nothing */
99 /* Define underscore macro, if not available, to be able to use it inside
100 code shared with gdb in common directory. */
102 #define _(String) (String)
105 #ifdef IN_PROCESS_AGENT
108 # define PROG "gdbserver"
111 /* A type used for binary buffers. */
112 typedef unsigned char gdb_byte;
116 #include "xml-utils.h"
117 #include "gdb_locale.h"
119 /* FIXME: This should probably be autoconf'd for. It's an integer type at
120 least the size of a (void *). */
121 typedef long long CORE_ADDR;
123 typedef long long LONGEST;
124 typedef unsigned long long ULONGEST;
126 /* Generic information for tracking a list of ``inferiors'' - threads,
130 struct inferior_list_entry *head;
131 struct inferior_list_entry *tail;
133 struct inferior_list_entry
136 struct inferior_list_entry *next;
143 #include "regcache.h"
144 #include "gdb/signals.h"
145 #include "gdb_signals.h"
147 #include "mem-break.h"
151 struct inferior_list_entry entry;
155 /* The last resume GDB requested on this thread. */
156 enum resume_kind last_resume_kind;
158 /* The last wait status reported for this thread. */
159 struct target_waitstatus last_status;
161 /* Given `while-stepping', a thread may be collecting data for more
162 than one tracepoint simultaneously. E.g.:
164 ff0001 INSN1 <-- TP1, while-stepping 10 collect $regs
166 ff0003 INSN3 <-- TP2, collect $regs
167 ff0004 INSN4 <-- TP3, while-stepping 10 collect $regs
170 Notice that when instruction INSN5 is reached, the while-stepping
171 actions of both TP1 and TP3 are still being collected, and that TP2
172 had been collected meanwhile. The whole range of ff0001-ff0005
173 should be single-stepped, due to at least TP1's while-stepping
174 action covering the whole range.
176 On the other hand, the same tracepoint with a while-stepping action
177 may be hit by more than one thread simultaneously, hence we can't
178 keep the current step count in the tracepoint itself.
180 This is the head of the list of the states of `while-stepping'
181 tracepoint actions this thread is now collecting; NULL if empty.
182 Each item in the list holds the current step of the while-stepping
184 struct wstep_state *while_stepping;
189 struct inferior_list_entry entry;
196 struct raw_breakpoint;
197 struct fast_tracepoint_jump;
198 struct process_info_private;
202 struct inferior_list_entry head;
204 /* Nonzero if this child process was attached rather than
208 /* True if GDB asked us to detach from this process, but we remained
212 /* The symbol cache. */
213 struct sym_cache *symbol_cache;
215 /* The list of memory breakpoints. */
216 struct breakpoint *breakpoints;
218 /* The list of raw memory breakpoints. */
219 struct raw_breakpoint *raw_breakpoints;
221 /* The list of installed fast tracepoints. */
222 struct fast_tracepoint_jump *fast_tracepoint_jumps;
224 /* Private target data. */
225 struct process_info_private *private;
228 /* Return a pointer to the process that corresponds to the current
229 thread (current_inferior). It is an error to call this if there is
230 no current thread selected. */
232 struct process_info *current_process (void);
233 struct process_info *get_thread_process (struct thread_info *);
235 /* Target-specific functions */
237 void initialize_low ();
239 /* From inferiors.c. */
241 extern struct inferior_list all_processes;
242 extern struct inferior_list all_threads;
243 extern struct inferior_list all_dlls;
244 extern int dlls_changed;
245 extern void clear_dlls (void);
247 void add_inferior_to_list (struct inferior_list *list,
248 struct inferior_list_entry *new_inferior);
249 void for_each_inferior (struct inferior_list *list,
250 void (*action) (struct inferior_list_entry *));
252 extern struct thread_info *current_inferior;
253 void remove_inferior (struct inferior_list *list,
254 struct inferior_list_entry *entry);
255 void remove_thread (struct thread_info *thread);
256 void add_thread (ptid_t ptid, void *target_data);
258 struct process_info *add_process (int pid, int attached);
259 void remove_process (struct process_info *process);
260 struct process_info *find_process_pid (int pid);
261 int have_started_inferiors_p (void);
262 int have_attached_inferiors_p (void);
264 struct thread_info *find_thread_ptid (ptid_t ptid);
266 ptid_t thread_id_to_gdb_id (ptid_t);
267 ptid_t thread_to_gdb_id (struct thread_info *);
268 ptid_t gdb_id_to_thread_id (ptid_t);
269 struct thread_info *gdb_id_to_thread (unsigned int);
270 void clear_inferiors (void);
271 struct inferior_list_entry *find_inferior
272 (struct inferior_list *,
273 int (*func) (struct inferior_list_entry *,
276 struct inferior_list_entry *find_inferior_id (struct inferior_list *list,
278 void *inferior_target_data (struct thread_info *);
279 void set_inferior_target_data (struct thread_info *, void *);
280 void *inferior_regcache_data (struct thread_info *);
281 void set_inferior_regcache_data (struct thread_info *, void *);
283 void loaded_dll (const char *name, CORE_ADDR base_addr);
284 void unloaded_dll (const char *name, CORE_ADDR base_addr);
286 /* Public variables in server.c */
288 extern ptid_t cont_thread;
289 extern ptid_t general_thread;
291 extern int server_waiting;
292 extern int debug_threads;
293 extern int debug_hw_points;
294 extern int pass_signals[];
296 extern jmp_buf toplevel;
298 extern int disable_packet_vCont;
299 extern int disable_packet_Tthread;
300 extern int disable_packet_qC;
301 extern int disable_packet_qfThreadInfo;
304 extern int multi_process;
307 extern int disable_randomization;
310 #include <winsock2.h>
311 typedef SOCKET gdb_fildes_t;
313 typedef int gdb_fildes_t;
316 /* Functions from event-loop.c. */
317 typedef void *gdb_client_data;
318 typedef int (handler_func) (int, gdb_client_data);
319 typedef int (callback_handler_func) (gdb_client_data);
321 extern void delete_file_handler (gdb_fildes_t fd);
322 extern void add_file_handler (gdb_fildes_t fd, handler_func *proc,
323 gdb_client_data client_data);
324 extern int append_callback_event (callback_handler_func *proc,
325 gdb_client_data client_data);
326 extern void delete_callback_event (int id);
328 extern void start_event_loop (void);
330 /* Functions from server.c. */
331 extern int handle_serial_event (int err, gdb_client_data client_data);
332 extern int handle_target_event (int err, gdb_client_data client_data);
334 extern void push_event (ptid_t ptid, struct target_waitstatus *status);
336 /* Functions from hostio.c. */
337 extern int handle_vFile (char *, int, int *);
339 /* Functions from hostio-errno.c. */
340 extern void hostio_last_error_from_errno (char *own_buf);
342 /* From remote-utils.c */
344 extern int remote_debug;
345 extern int noack_mode;
346 extern int transport_is_reliable;
348 int gdb_connected (void);
350 #define STDIO_CONNECTION_NAME "stdio"
351 int remote_connection_is_stdio (void);
353 ptid_t read_ptid (char *buf, char **obuf);
354 char *write_ptid (char *buf, ptid_t ptid);
356 int putpkt (char *buf);
357 int putpkt_binary (char *buf, int len);
358 int putpkt_notif (char *buf);
359 int getpkt (char *buf);
360 void remote_prepare (char *name);
361 void remote_open (char *name);
362 void remote_close (void);
363 void write_ok (char *buf);
364 void write_enn (char *buf);
365 void initialize_async_io (void);
366 void enable_async_io (void);
367 void disable_async_io (void);
368 void check_remote_input_interrupt_request (void);
369 void convert_ascii_to_int (const char *from, unsigned char *to, int n);
370 void convert_int_to_ascii (const unsigned char *from, char *to, int n);
371 void new_thread_notify (int id);
372 void dead_thread_notify (int id);
373 void prepare_resume_reply (char *buf, ptid_t ptid,
374 struct target_waitstatus *status);
376 const char *decode_address_to_semicolon (CORE_ADDR *addrp, const char *start);
377 void decode_address (CORE_ADDR *addrp, const char *start, int len);
378 void decode_m_packet (char *from, CORE_ADDR * mem_addr_ptr,
379 unsigned int *len_ptr);
380 void decode_M_packet (char *from, CORE_ADDR * mem_addr_ptr,
381 unsigned int *len_ptr, unsigned char **to_p);
382 int decode_X_packet (char *from, int packet_len, CORE_ADDR * mem_addr_ptr,
383 unsigned int *len_ptr, unsigned char **to_p);
384 int decode_xfer_write (char *buf, int packet_len,
385 CORE_ADDR *offset, unsigned int *len,
386 unsigned char *data);
387 int decode_search_memory_packet (const char *buf, int packet_len,
388 CORE_ADDR *start_addrp,
389 CORE_ADDR *search_space_lenp,
391 unsigned int *pattern_lenp);
393 int unhexify (char *bin, const char *hex, int count);
394 int hexify (char *hex, const char *bin, int count);
395 int remote_escape_output (const gdb_byte *buffer, int len,
396 gdb_byte *out_buf, int *out_len,
398 char *unpack_varlen_hex (char *buff, ULONGEST *result);
400 void clear_symbol_cache (struct sym_cache **symcache_p);
401 int look_up_one_symbol (const char *name, CORE_ADDR *addrp, int may_ask_gdb);
403 int relocate_instruction (CORE_ADDR *to, CORE_ADDR oldloc);
405 void monitor_output (const char *msg);
407 /* Functions from utils.c */
408 #include "common-utils.h"
410 void *xmalloc (size_t) ATTR_MALLOC;
411 void *xrealloc (void *, size_t);
412 void *xcalloc (size_t, size_t) ATTR_MALLOC;
413 char *xstrdup (const char *) ATTR_MALLOC;
414 int xsnprintf (char *str, size_t size, const char *format, ...)
415 ATTR_FORMAT (printf, 3, 4);;
416 void freeargv (char **argv);
417 void perror_with_name (const char *string);
418 void error (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
419 void fatal (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
420 void warning (const char *string,...) ATTR_FORMAT (printf, 1, 2);
421 char *paddress (CORE_ADDR addr);
422 char *pulongest (ULONGEST u);
423 char *plongest (LONGEST l);
424 char *phex_nz (ULONGEST l, int sizeof_l);
425 char *pfildes (gdb_fildes_t fd);
427 #include "gdb_assert.h"
429 /* Maximum number of bytes to read/write at once. The value here
430 is chosen to fill up a packet (the headers account for the 32). */
431 #define MAXBUFBYTES(N) (((N)-32)/2)
433 /* Buffer sizes for transferring memory, registers, etc. Set to a constant
434 value to accomodate multiple register formats. This value must be at least
435 as large as the largest register set supported by gdbserver. */
436 #define PBUFSIZ 16384
438 /* Functions from tracepoint.c */
440 /* Size for a small buffer to report problems from the in-process
441 agent back to GDBserver. */
442 #define IPA_BUFSIZ 100
444 int in_process_agent_loaded (void);
446 void initialize_tracepoint (void);
449 extern int disconnected_tracing;
451 void tracepoint_look_up_symbols (void);
453 void stop_tracing (void);
455 int handle_tracepoint_general_set (char *own_buf);
456 int handle_tracepoint_query (char *own_buf);
458 int tracepoint_finished_step (struct thread_info *tinfo, CORE_ADDR stop_pc);
459 int tracepoint_was_hit (struct thread_info *tinfo, CORE_ADDR stop_pc);
461 void release_while_stepping_state_list (struct thread_info *tinfo);
463 extern int current_traceframe;
465 int in_readonly_region (CORE_ADDR addr, ULONGEST length);
466 int traceframe_read_mem (int tfnum, CORE_ADDR addr,
467 unsigned char *buf, ULONGEST length,
469 int fetch_traceframe_registers (int tfnum,
470 struct regcache *regcache,
473 int traceframe_read_sdata (int tfnum, ULONGEST offset,
474 unsigned char *buf, ULONGEST length,
477 int traceframe_read_info (int tfnum, struct buffer *buffer);
479 /* If a thread is determined to be collecting a fast tracepoint, this
480 structure holds the collect status. */
482 struct fast_tpoint_collect_status
484 /* The tracepoint that is presently being collected. */
486 CORE_ADDR tpoint_addr;
488 /* The address range in the jump pad of where the original
489 instruction the tracepoint jump was inserted was relocated
491 CORE_ADDR adjusted_insn_addr;
492 CORE_ADDR adjusted_insn_addr_end;
495 int fast_tracepoint_collecting (CORE_ADDR thread_area,
497 struct fast_tpoint_collect_status *status);
498 void force_unlock_trace_buffer (void);
500 int handle_tracepoint_bkpts (struct thread_info *tinfo, CORE_ADDR stop_pc);
502 #ifdef IN_PROCESS_AGENT
503 void initialize_low_tracepoint (void);
504 void supply_fast_tracepoint_registers (struct regcache *regcache,
505 const unsigned char *regs);
506 void supply_static_tracepoint_registers (struct regcache *regcache,
507 const unsigned char *regs,
509 void set_trampoline_buffer_space (CORE_ADDR begin, CORE_ADDR end,
512 void stop_tracing (void);
514 int claim_trampoline_space (ULONGEST used, CORE_ADDR *trampoline);
515 int have_fast_tracepoint_trampoline_buffer (char *msgbuf);
520 /* Do memory copies for bytecodes. */
521 /* Do the recording of memory blocks for actions and bytecodes. */
523 int agent_mem_read (struct traceframe *tframe,
524 unsigned char *to, CORE_ADDR from,
527 LONGEST agent_get_trace_state_variable_value (int num);
528 void agent_set_trace_state_variable_value (int num, LONGEST val);
530 /* Record the value of a trace state variable. */
532 int agent_tsv_read (struct traceframe *tframe, int n);
533 int agent_mem_read_string (struct traceframe *tframe,
538 /* Bytecode compilation function vector. */
542 void (*emit_prologue) (void);
543 void (*emit_epilogue) (void);
544 void (*emit_add) (void);
545 void (*emit_sub) (void);
546 void (*emit_mul) (void);
547 void (*emit_lsh) (void);
548 void (*emit_rsh_signed) (void);
549 void (*emit_rsh_unsigned) (void);
550 void (*emit_ext) (int arg);
551 void (*emit_log_not) (void);
552 void (*emit_bit_and) (void);
553 void (*emit_bit_or) (void);
554 void (*emit_bit_xor) (void);
555 void (*emit_bit_not) (void);
556 void (*emit_equal) (void);
557 void (*emit_less_signed) (void);
558 void (*emit_less_unsigned) (void);
559 void (*emit_ref) (int size);
560 void (*emit_if_goto) (int *offset_p, int *size_p);
561 void (*emit_goto) (int *offset_p, int *size_p);
562 void (*write_goto_address) (CORE_ADDR from, CORE_ADDR to, int size);
563 void (*emit_const) (LONGEST num);
564 void (*emit_call) (CORE_ADDR fn);
565 void (*emit_reg) (int reg);
566 void (*emit_pop) (void);
567 void (*emit_stack_flush) (void);
568 void (*emit_zero_ext) (int arg);
569 void (*emit_swap) (void);
570 void (*emit_stack_adjust) (int n);
572 /* Emit code for a generic function that takes one fixed integer
573 argument and returns a 64-bit int (for instance, tsv getter). */
574 void (*emit_int_call_1) (CORE_ADDR fn, int arg1);
576 /* Emit code for a generic function that takes one fixed integer
577 argument and a 64-bit int from the top of the stack, and returns
578 nothing (for instance, tsv setter). */
579 void (*emit_void_call_2) (CORE_ADDR fn, int arg1);
581 /* Emit code specialized for common combinations of compare followed
583 void (*emit_eq_goto) (int *offset_p, int *size_p);
584 void (*emit_ne_goto) (int *offset_p, int *size_p);
585 void (*emit_lt_goto) (int *offset_p, int *size_p);
586 void (*emit_le_goto) (int *offset_p, int *size_p);
587 void (*emit_gt_goto) (int *offset_p, int *size_p);
588 void (*emit_ge_goto) (int *offset_p, int *size_p);
591 /* Returns the address of the get_raw_reg function in the IPA. */
592 CORE_ADDR get_raw_reg_func_addr (void);
593 /* Returns the address of the get_trace_state_variable_value
594 function in the IPA. */
595 CORE_ADDR get_get_tsv_func_addr (void);
596 /* Returns the address of the set_trace_state_variable_value
597 function in the IPA. */
598 CORE_ADDR get_set_tsv_func_addr (void);
600 CORE_ADDR current_insn_ptr;
603 /* Version information, from version.c. */
604 extern const char version[];
605 extern const char host_name[];
607 #endif /* SERVER_H */