1 /* Common definitions for remote server for GDB.
2 Copyright (C) 1993, 1995, 1997, 1998, 1999, 2000, 2002, 2003, 2004, 2005,
3 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
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"
45 #if !HAVE_DECL_STRERROR
47 extern char *strerror (int); /* X3.159-1989 4.11.6.2 */
53 extern void perror (const char *);
58 extern void *memmem (const void *, size_t , const void *, size_t);
62 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
63 #define ATTR_NORETURN __attribute__ ((noreturn))
65 #define ATTR_NORETURN /* nothing */
70 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
71 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
73 #define ATTR_FORMAT(type, x, y) /* nothing */
78 #if defined(__GNUC__) && (__GNUC__ >= 3)
79 #define ATTR_MALLOC __attribute__ ((__malloc__))
81 #define ATTR_MALLOC /* nothing */
85 /* A type used for binary buffers. */
86 typedef unsigned char gdb_byte;
88 /* FIXME: This should probably be autoconf'd for. It's an integer type at
89 least the size of a (void *). */
90 typedef long long CORE_ADDR;
92 typedef long long LONGEST;
93 typedef unsigned long long ULONGEST;
95 /* The ptid struct is a collection of the various "ids" necessary
96 for identifying the inferior. This consists of the process id
97 (pid), thread id (tid), and other fields necessary for uniquely
98 identifying the inferior process/thread being debugged. When
99 manipulating ptids, the constructors, accessors, and predicate
100 declared in server.h should be used. These are as follows:
102 ptid_build - Make a new ptid from a pid, lwp, and tid.
103 pid_to_ptid - Make a new ptid from just a pid.
104 ptid_get_pid - Fetch the pid component of a ptid.
105 ptid_get_lwp - Fetch the lwp component of a ptid.
106 ptid_get_tid - Fetch the tid component of a ptid.
107 ptid_equal - Test to see if two ptids are equal.
109 Please do NOT access the struct ptid members directly (except, of
110 course, in the implementation of the above ptid manipulation
118 /* Lightweight process id */
125 typedef struct ptid ptid_t;
127 /* The -1 ptid, often used to indicate either an error condition or a
128 "don't care" condition, i.e, "run all threads". */
129 extern ptid_t minus_one_ptid;
131 /* The null or zero ptid, often used to indicate no process. */
132 extern ptid_t null_ptid;
134 /* Attempt to find and return an existing ptid with the given PID,
135 LWP, and TID components. If none exists, create a new one and
137 ptid_t ptid_build (int pid, long lwp, long tid);
139 /* Create a ptid from just a pid. */
140 ptid_t pid_to_ptid (int pid);
142 /* Fetch the pid (process id) component from a ptid. */
143 int ptid_get_pid (ptid_t ptid);
145 /* Fetch the lwp (lightweight process) component from a ptid. */
146 long ptid_get_lwp (ptid_t ptid);
148 /* Fetch the tid (thread id) component from a ptid. */
149 long ptid_get_tid (ptid_t ptid);
151 /* Compare two ptids to see if they are equal. */
152 extern int ptid_equal (ptid_t p1, ptid_t p2);
154 /* Return true if this ptid represents a process id. */
155 extern int ptid_is_pid (ptid_t ptid);
157 /* Generic information for tracking a list of ``inferiors'' - threads,
161 struct inferior_list_entry *head;
162 struct inferior_list_entry *tail;
164 struct inferior_list_entry
167 struct inferior_list_entry *next;
174 #include "regcache.h"
175 #include "gdb/signals.h"
176 #include "gdb_signals.h"
178 #include "mem-break.h"
182 struct inferior_list_entry entry;
186 /* The last resume GDB requested on this thread. */
187 enum resume_kind last_resume_kind;
189 /* The last wait status reported for this thread. */
190 struct target_waitstatus last_status;
192 /* Given `while-stepping', a thread may be collecting data for more
193 than one tracepoint simultaneously. E.g.:
195 ff0001 INSN1 <-- TP1, while-stepping 10 collect $regs
197 ff0003 INSN3 <-- TP2, collect $regs
198 ff0004 INSN4 <-- TP3, while-stepping 10 collect $regs
201 Notice that when instruction INSN5 is reached, the while-stepping
202 actions of both TP1 and TP3 are still being collected, and that TP2
203 had been collected meanwhile. The whole range of ff0001-ff0005
204 should be single-stepped, due to at least TP1's while-stepping
205 action covering the whole range.
207 On the other hand, the same tracepoint with a while-stepping action
208 may be hit by more than one thread simultaneously, hence we can't
209 keep the current step count in the tracepoint itself.
211 This is the head of the list of the states of `while-stepping'
212 tracepoint actions this thread is now collecting; NULL if empty.
213 Each item in the list holds the current step of the while-stepping
215 struct wstep_state *while_stepping;
220 struct inferior_list_entry entry;
227 struct raw_breakpoint;
228 struct fast_tracepoint_jump;
229 struct process_info_private;
233 struct inferior_list_entry head;
235 /* Nonzero if this child process was attached rather than
239 /* True if GDB asked us to detach from this process, but we remained
243 /* The symbol cache. */
244 struct sym_cache *symbol_cache;
246 /* The list of memory breakpoints. */
247 struct breakpoint *breakpoints;
249 /* The list of raw memory breakpoints. */
250 struct raw_breakpoint *raw_breakpoints;
252 /* The list of installed fast tracepoints. */
253 struct fast_tracepoint_jump *fast_tracepoint_jumps;
255 /* Private target data. */
256 struct process_info_private *private;
259 /* Return a pointer to the process that corresponds to the current
260 thread (current_inferior). It is an error to call this if there is
261 no current thread selected. */
263 struct process_info *current_process (void);
264 struct process_info *get_thread_process (struct thread_info *);
266 /* Target-specific functions */
268 void initialize_low ();
270 /* From inferiors.c. */
272 extern struct inferior_list all_processes;
273 extern struct inferior_list all_threads;
274 extern struct inferior_list all_dlls;
275 extern int dlls_changed;
277 void initialize_inferiors (void);
279 void add_inferior_to_list (struct inferior_list *list,
280 struct inferior_list_entry *new_inferior);
281 void for_each_inferior (struct inferior_list *list,
282 void (*action) (struct inferior_list_entry *));
284 extern struct thread_info *current_inferior;
285 void remove_inferior (struct inferior_list *list,
286 struct inferior_list_entry *entry);
287 void remove_thread (struct thread_info *thread);
288 void add_thread (ptid_t ptid, void *target_data);
290 struct process_info *add_process (int pid, int attached);
291 void remove_process (struct process_info *process);
292 struct process_info *find_process_pid (int pid);
293 int have_started_inferiors_p (void);
294 int have_attached_inferiors_p (void);
296 struct thread_info *find_thread_ptid (ptid_t ptid);
298 ptid_t thread_id_to_gdb_id (ptid_t);
299 ptid_t thread_to_gdb_id (struct thread_info *);
300 ptid_t gdb_id_to_thread_id (ptid_t);
301 struct thread_info *gdb_id_to_thread (unsigned int);
302 void clear_inferiors (void);
303 struct inferior_list_entry *find_inferior
304 (struct inferior_list *,
305 int (*func) (struct inferior_list_entry *,
308 struct inferior_list_entry *find_inferior_id (struct inferior_list *list,
310 void *inferior_target_data (struct thread_info *);
311 void set_inferior_target_data (struct thread_info *, void *);
312 void *inferior_regcache_data (struct thread_info *);
313 void set_inferior_regcache_data (struct thread_info *, void *);
314 void add_pid_to_list (struct inferior_list *list, unsigned long pid);
315 int pull_pid_from_list (struct inferior_list *list, unsigned long pid);
317 void loaded_dll (const char *name, CORE_ADDR base_addr);
318 void unloaded_dll (const char *name, CORE_ADDR base_addr);
320 /* Public variables in server.c */
322 extern ptid_t cont_thread;
323 extern ptid_t general_thread;
324 extern ptid_t step_thread;
326 extern int server_waiting;
327 extern int debug_threads;
328 extern int debug_hw_points;
329 extern int pass_signals[];
331 extern jmp_buf toplevel;
333 extern int disable_packet_vCont;
334 extern int disable_packet_Tthread;
335 extern int disable_packet_qC;
336 extern int disable_packet_qfThreadInfo;
338 extern int multi_process;
342 #include <winsock2.h>
343 typedef SOCKET gdb_fildes_t;
345 typedef int gdb_fildes_t;
348 /* Functions from event-loop.c. */
349 typedef void *gdb_client_data;
350 typedef int (handler_func) (int, gdb_client_data);
351 typedef int (callback_handler_func) (gdb_client_data);
353 extern void delete_file_handler (gdb_fildes_t fd);
354 extern void add_file_handler (gdb_fildes_t fd, handler_func *proc,
355 gdb_client_data client_data);
356 extern int append_callback_event (callback_handler_func *proc,
357 gdb_client_data client_data);
358 extern void delete_callback_event (int id);
360 extern void start_event_loop (void);
362 /* Functions from server.c. */
363 extern int handle_serial_event (int err, gdb_client_data client_data);
364 extern int handle_target_event (int err, gdb_client_data client_data);
366 extern void push_event (ptid_t ptid, struct target_waitstatus *status);
368 /* Functions from hostio.c. */
369 extern int handle_vFile (char *, int, int *);
371 /* Functions from hostio-errno.c. */
372 extern void hostio_last_error_from_errno (char *own_buf);
374 /* From remote-utils.c */
376 extern int remote_debug;
377 extern int noack_mode;
378 extern int transport_is_reliable;
380 int gdb_connected (void);
382 ptid_t read_ptid (char *buf, char **obuf);
383 char *write_ptid (char *buf, ptid_t ptid);
385 int putpkt (char *buf);
386 int putpkt_binary (char *buf, int len);
387 int putpkt_notif (char *buf);
388 int getpkt (char *buf);
389 void remote_open (char *name);
390 void remote_close (void);
391 void write_ok (char *buf);
392 void write_enn (char *buf);
393 void initialize_async_io (void);
394 void enable_async_io (void);
395 void disable_async_io (void);
396 void check_remote_input_interrupt_request (void);
397 void convert_ascii_to_int (const char *from, unsigned char *to, int n);
398 void convert_int_to_ascii (const unsigned char *from, char *to, int n);
399 void new_thread_notify (int id);
400 void dead_thread_notify (int id);
401 void prepare_resume_reply (char *buf, ptid_t ptid,
402 struct target_waitstatus *status);
404 const char *decode_address_to_semicolon (CORE_ADDR *addrp, const char *start);
405 void decode_address (CORE_ADDR *addrp, const char *start, int len);
406 void decode_m_packet (char *from, CORE_ADDR * mem_addr_ptr,
407 unsigned int *len_ptr);
408 void decode_M_packet (char *from, CORE_ADDR * mem_addr_ptr,
409 unsigned int *len_ptr, unsigned char **to_p);
410 int decode_X_packet (char *from, int packet_len, CORE_ADDR * mem_addr_ptr,
411 unsigned int *len_ptr, unsigned char **to_p);
412 int decode_xfer_write (char *buf, int packet_len, char **annex,
413 CORE_ADDR *offset, unsigned int *len,
414 unsigned char *data);
415 int decode_search_memory_packet (const char *buf, int packet_len,
416 CORE_ADDR *start_addrp,
417 CORE_ADDR *search_space_lenp,
418 gdb_byte *pattern, unsigned int *pattern_lenp);
420 int unhexify (char *bin, const char *hex, int count);
421 int hexify (char *hex, const char *bin, int count);
422 int remote_escape_output (const gdb_byte *buffer, int len,
423 gdb_byte *out_buf, int *out_len,
425 char *unpack_varlen_hex (char *buff, ULONGEST *result);
427 void clear_symbol_cache (struct sym_cache **symcache_p);
428 int look_up_one_symbol (const char *name, CORE_ADDR *addrp, int may_ask_gdb);
430 int relocate_instruction (CORE_ADDR *to, CORE_ADDR oldloc);
432 void monitor_output (const char *msg);
434 char *xml_escape_text (const char *text);
436 /* Simple growing buffer. */
441 size_t buffer_size; /* allocated size */
442 size_t used_size; /* actually used size */
445 /* Append DATA of size SIZE to the end of BUFFER. Grows the buffer to
446 accommodate the new data. */
447 void buffer_grow (struct buffer *buffer, const char *data, size_t size);
449 /* Release any memory held by BUFFER. */
450 void buffer_free (struct buffer *buffer);
452 /* Initialize BUFFER. BUFFER holds no memory afterwards. */
453 void buffer_init (struct buffer *buffer);
455 /* Return a pointer into BUFFER data, effectivelly transfering
456 ownership of the buffer memory to the caller. Calling buffer_free
457 afterwards has no effect on the returned data. */
458 char* buffer_finish (struct buffer *buffer);
460 /* Simple printf to BUFFER function. Current implemented formatters:
461 %s - grow an xml escaped text in OBSTACK. */
462 void buffer_xml_printf (struct buffer *buffer, const char *format, ...)
463 ATTR_FORMAT (printf, 2, 3);
465 #define buffer_grow_str(BUFFER,STRING) \
466 buffer_grow (BUFFER, STRING, strlen (STRING))
467 #define buffer_grow_str0(BUFFER,STRING) \
468 buffer_grow (BUFFER, STRING, strlen (STRING) + 1)
470 /* Functions from utils.c */
472 void *xmalloc (size_t) ATTR_MALLOC;
473 void *xrealloc (void *, size_t);
474 void *xcalloc (size_t, size_t) ATTR_MALLOC;
475 char *xstrdup (const char *) ATTR_MALLOC;
476 int xsnprintf (char *str, size_t size, const char *format, ...)
477 ATTR_FORMAT (printf, 3, 4);;
478 void freeargv (char **argv);
479 void perror_with_name (const char *string);
480 void error (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
481 void fatal (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
482 void internal_error (const char *file, int line, const char *, ...)
483 ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
484 void warning (const char *string,...) ATTR_FORMAT (printf, 1, 2);
485 char *paddress (CORE_ADDR addr);
486 char *pulongest (ULONGEST u);
487 char *plongest (LONGEST l);
488 char *phex_nz (ULONGEST l, int sizeof_l);
489 char *pfildes (gdb_fildes_t fd);
491 #define gdb_assert(expr) \
492 ((void) ((expr) ? 0 : \
493 (gdb_assert_fail (#expr, __FILE__, __LINE__, ASSERT_FUNCTION), 0)))
495 /* Version 2.4 and later of GCC define a magical variable `__PRETTY_FUNCTION__'
496 which contains the name of the function currently being defined.
497 This is broken in G++ before version 2.6.
498 C9x has a similar variable called __func__, but prefer the GCC one since
499 it demangles C++ function names. */
500 #if (GCC_VERSION >= 2004)
501 #define ASSERT_FUNCTION __PRETTY_FUNCTION__
503 #if defined __STDC_VERSION__ && __STDC_VERSION__ >= 199901L
504 #define ASSERT_FUNCTION __func__
508 /* This prints an "Assertion failed" message, and exits. */
509 #if defined (ASSERT_FUNCTION)
510 #define gdb_assert_fail(assertion, file, line, function) \
511 internal_error (file, line, "%s: Assertion `%s' failed.", \
514 #define gdb_assert_fail(assertion, file, line, function) \
515 internal_error (file, line, "Assertion `%s' failed.", \
519 /* Maximum number of bytes to read/write at once. The value here
520 is chosen to fill up a packet (the headers account for the 32). */
521 #define MAXBUFBYTES(N) (((N)-32)/2)
523 /* Buffer sizes for transferring memory, registers, etc. Set to a constant
524 value to accomodate multiple register formats. This value must be at least
525 as large as the largest register set supported by gdbserver. */
526 #define PBUFSIZ 16384
528 /* Functions from tracepoint.c */
530 int in_process_agent_loaded (void);
532 void initialize_tracepoint (void);
535 extern int disconnected_tracing;
537 void tracepoint_look_up_symbols (void);
539 void stop_tracing (void);
541 int handle_tracepoint_general_set (char *own_buf);
542 int handle_tracepoint_query (char *own_buf);
544 int tracepoint_finished_step (struct thread_info *tinfo, CORE_ADDR stop_pc);
545 int tracepoint_was_hit (struct thread_info *tinfo, CORE_ADDR stop_pc);
547 void release_while_stepping_state_list (struct thread_info *tinfo);
549 extern int current_traceframe;
551 int in_readonly_region (CORE_ADDR addr, ULONGEST length);
552 int traceframe_read_mem (int tfnum, CORE_ADDR addr,
553 unsigned char *buf, ULONGEST length,
555 int fetch_traceframe_registers (int tfnum,
556 struct regcache *regcache,
559 int traceframe_read_sdata (int tfnum, ULONGEST offset,
560 unsigned char *buf, ULONGEST length,
563 /* If a thread is determined to be collecting a fast tracepoint, this
564 structure holds the collect status. */
566 struct fast_tpoint_collect_status
568 /* The tracepoint that is presently being collected. */
570 CORE_ADDR tpoint_addr;
572 /* The address range in the jump pad of where the original
573 instruction the tracepoint jump was inserted was relocated
575 CORE_ADDR adjusted_insn_addr;
576 CORE_ADDR adjusted_insn_addr_end;
579 int fast_tracepoint_collecting (CORE_ADDR thread_area,
581 struct fast_tpoint_collect_status *status);
582 void force_unlock_trace_buffer (void);
584 int handle_tracepoint_bkpts (struct thread_info *tinfo, CORE_ADDR stop_pc);
586 #ifdef IN_PROCESS_AGENT
587 void initialize_low_tracepoint (void);
588 void supply_fast_tracepoint_registers (struct regcache *regcache,
589 const unsigned char *regs);
590 void supply_static_tracepoint_registers (struct regcache *regcache,
591 const unsigned char *regs,
594 void stop_tracing (void);
597 /* Bytecode compilation function vector. */
601 void (*emit_prologue) (void);
602 void (*emit_epilogue) (void);
603 void (*emit_add) (void);
604 void (*emit_sub) (void);
605 void (*emit_mul) (void);
606 void (*emit_lsh) (void);
607 void (*emit_rsh_signed) (void);
608 void (*emit_rsh_unsigned) (void);
609 void (*emit_ext) (int arg);
610 void (*emit_log_not) (void);
611 void (*emit_bit_and) (void);
612 void (*emit_bit_or) (void);
613 void (*emit_bit_xor) (void);
614 void (*emit_bit_not) (void);
615 void (*emit_equal) (void);
616 void (*emit_less_signed) (void);
617 void (*emit_less_unsigned) (void);
618 void (*emit_ref) (int size);
619 void (*emit_if_goto) (int *offset_p, int *size_p);
620 void (*emit_goto) (int *offset_p, int *size_p);
621 void (*write_goto_address) (CORE_ADDR from, CORE_ADDR to, int size);
622 void (*emit_const) (LONGEST num);
623 void (*emit_call) (CORE_ADDR fn);
624 void (*emit_reg) (int reg);
625 void (*emit_pop) (void);
626 void (*emit_stack_flush) (void);
627 void (*emit_zero_ext) (int arg);
628 void (*emit_swap) (void);
629 void (*emit_stack_adjust) (int n);
631 /* Emit code for a generic function that takes one fixed integer
632 argument and returns a 64-bit int (for instance, tsv getter). */
633 void (*emit_int_call_1) (CORE_ADDR fn, int arg1);
635 /* Emit code for a generic function that takes one fixed integer
636 argument and a 64-bit int from the top of the stack, and returns
637 nothing (for instance, tsv setter). */
638 void (*emit_void_call_2) (CORE_ADDR fn, int arg1);
641 /* Returns the address of the get_raw_reg function in the IPA. */
642 CORE_ADDR get_raw_reg_func_addr (void);
644 CORE_ADDR current_insn_ptr;
647 /* Version information, from version.c. */
648 extern const char version[];
649 extern const char host_name[];
651 #endif /* SERVER_H */