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"
41 #if !HAVE_DECL_STRERROR
43 extern char *strerror (int); /* X3.159-1989 4.11.6.2 */
49 extern void perror (const char *);
54 extern void *memmem (const void *, size_t , const void *, size_t);
58 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
59 #define ATTR_NORETURN __attribute__ ((noreturn))
61 #define ATTR_NORETURN /* nothing */
66 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
67 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
69 #define ATTR_FORMAT(type, x, y) /* nothing */
74 #if defined(__GNUC__) && (__GNUC__ >= 3)
75 #define ATTR_MALLOC __attribute__ ((__malloc__))
77 #define ATTR_MALLOC /* nothing */
81 /* A type used for binary buffers. */
82 typedef unsigned char gdb_byte;
84 /* FIXME: This should probably be autoconf'd for. It's an integer type at
85 least the size of a (void *). */
86 typedef long long CORE_ADDR;
88 typedef long long LONGEST;
89 typedef unsigned long long ULONGEST;
91 /* The ptid struct is a collection of the various "ids" necessary
92 for identifying the inferior. This consists of the process id
93 (pid), thread id (tid), and other fields necessary for uniquely
94 identifying the inferior process/thread being debugged. When
95 manipulating ptids, the constructors, accessors, and predicate
96 declared in server.h should be used. These are as follows:
98 ptid_build - Make a new ptid from a pid, lwp, and tid.
99 pid_to_ptid - Make a new ptid from just a pid.
100 ptid_get_pid - Fetch the pid component of a ptid.
101 ptid_get_lwp - Fetch the lwp component of a ptid.
102 ptid_get_tid - Fetch the tid component of a ptid.
103 ptid_equal - Test to see if two ptids are equal.
105 Please do NOT access the struct ptid members directly (except, of
106 course, in the implementation of the above ptid manipulation
114 /* Lightweight process id */
121 typedef struct ptid ptid_t;
123 /* The -1 ptid, often used to indicate either an error condition or a
124 "don't care" condition, i.e, "run all threads". */
125 extern ptid_t minus_one_ptid;
127 /* The null or zero ptid, often used to indicate no process. */
128 extern ptid_t null_ptid;
130 /* Attempt to find and return an existing ptid with the given PID,
131 LWP, and TID components. If none exists, create a new one and
133 ptid_t ptid_build (int pid, long lwp, long tid);
135 /* Create a ptid from just a pid. */
136 ptid_t pid_to_ptid (int pid);
138 /* Fetch the pid (process id) component from a ptid. */
139 int ptid_get_pid (ptid_t ptid);
141 /* Fetch the lwp (lightweight process) component from a ptid. */
142 long ptid_get_lwp (ptid_t ptid);
144 /* Fetch the tid (thread id) component from a ptid. */
145 long ptid_get_tid (ptid_t ptid);
147 /* Compare two ptids to see if they are equal. */
148 extern int ptid_equal (ptid_t p1, ptid_t p2);
150 /* Return true if this ptid represents a process id. */
151 extern int ptid_is_pid (ptid_t ptid);
153 /* Generic information for tracking a list of ``inferiors'' - threads,
157 struct inferior_list_entry *head;
158 struct inferior_list_entry *tail;
160 struct inferior_list_entry
163 struct inferior_list_entry *next;
170 #include "regcache.h"
171 #include "gdb/signals.h"
172 #include "gdb_signals.h"
174 #include "mem-break.h"
178 struct inferior_list_entry entry;
182 /* The last resume GDB requested on this thread. */
183 enum resume_kind last_resume_kind;
185 /* The last wait status reported for this thread. */
186 struct target_waitstatus last_status;
188 /* Given `while-stepping', a thread may be collecting data for more
189 than one tracepoint simultaneously. E.g.:
191 ff0001 INSN1 <-- TP1, while-stepping 10 collect $regs
193 ff0003 INSN3 <-- TP2, collect $regs
194 ff0004 INSN4 <-- TP3, while-stepping 10 collect $regs
197 Notice that when instruction INSN5 is reached, the while-stepping
198 actions of both TP1 and TP3 are still being collected, and that TP2
199 had been collected meanwhile. The whole range of ff0001-ff0005
200 should be single-stepped, due to at least TP1's while-stepping
201 action covering the whole range.
203 On the other hand, the same tracepoint with a while-stepping action
204 may be hit by more than one thread simultaneously, hence we can't
205 keep the current step count in the tracepoint itself.
207 This is the head of the list of the states of `while-stepping'
208 tracepoint actions this thread is now collecting; NULL if empty.
209 Each item in the list holds the current step of the while-stepping
211 struct wstep_state *while_stepping;
216 struct inferior_list_entry entry;
223 struct raw_breakpoint;
224 struct process_info_private;
228 struct inferior_list_entry head;
230 /* Nonzero if this child process was attached rather than
234 /* True if GDB asked us to detach from this process, but we remained
238 /* The symbol cache. */
239 struct sym_cache *symbol_cache;
241 /* The list of memory breakpoints. */
242 struct breakpoint *breakpoints;
244 /* The list of raw memory breakpoints. */
245 struct raw_breakpoint *raw_breakpoints;
247 /* Private target data. */
248 struct process_info_private *private;
251 /* Return a pointer to the process that corresponds to the current
252 thread (current_inferior). It is an error to call this if there is
253 no current thread selected. */
255 struct process_info *current_process (void);
256 struct process_info *get_thread_process (struct thread_info *);
258 /* Target-specific functions */
260 void initialize_low ();
262 /* From inferiors.c. */
264 extern struct inferior_list all_processes;
265 extern struct inferior_list all_threads;
266 extern struct inferior_list all_dlls;
267 extern int dlls_changed;
269 void initialize_inferiors (void);
271 void add_inferior_to_list (struct inferior_list *list,
272 struct inferior_list_entry *new_inferior);
273 void for_each_inferior (struct inferior_list *list,
274 void (*action) (struct inferior_list_entry *));
276 extern struct thread_info *current_inferior;
277 void remove_inferior (struct inferior_list *list,
278 struct inferior_list_entry *entry);
279 void remove_thread (struct thread_info *thread);
280 void add_thread (ptid_t ptid, void *target_data);
282 struct process_info *add_process (int pid, int attached);
283 void remove_process (struct process_info *process);
284 struct process_info *find_process_pid (int pid);
285 int have_started_inferiors_p (void);
286 int have_attached_inferiors_p (void);
288 struct thread_info *find_thread_ptid (ptid_t ptid);
290 ptid_t thread_id_to_gdb_id (ptid_t);
291 ptid_t thread_to_gdb_id (struct thread_info *);
292 ptid_t gdb_id_to_thread_id (ptid_t);
293 struct thread_info *gdb_id_to_thread (unsigned int);
294 void clear_inferiors (void);
295 struct inferior_list_entry *find_inferior
296 (struct inferior_list *,
297 int (*func) (struct inferior_list_entry *,
300 struct inferior_list_entry *find_inferior_id (struct inferior_list *list,
302 void *inferior_target_data (struct thread_info *);
303 void set_inferior_target_data (struct thread_info *, void *);
304 void *inferior_regcache_data (struct thread_info *);
305 void set_inferior_regcache_data (struct thread_info *, void *);
306 void add_pid_to_list (struct inferior_list *list, unsigned long pid);
307 int pull_pid_from_list (struct inferior_list *list, unsigned long pid);
309 void loaded_dll (const char *name, CORE_ADDR base_addr);
310 void unloaded_dll (const char *name, CORE_ADDR base_addr);
312 /* Public variables in server.c */
314 extern ptid_t cont_thread;
315 extern ptid_t general_thread;
316 extern ptid_t step_thread;
318 extern int server_waiting;
319 extern int debug_threads;
320 extern int debug_hw_points;
321 extern int pass_signals[];
323 extern jmp_buf toplevel;
325 extern int disable_packet_vCont;
326 extern int disable_packet_Tthread;
327 extern int disable_packet_qC;
328 extern int disable_packet_qfThreadInfo;
330 extern int multi_process;
333 /* Functions from event-loop.c. */
334 typedef void *gdb_client_data;
335 typedef int (handler_func) (int, gdb_client_data);
337 extern void delete_file_handler (int fd);
338 extern void add_file_handler (int fd, handler_func *proc,
339 gdb_client_data client_data);
341 extern void start_event_loop (void);
343 /* Functions from server.c. */
344 extern int handle_serial_event (int err, gdb_client_data client_data);
345 extern int handle_target_event (int err, gdb_client_data client_data);
347 extern void push_event (ptid_t ptid, struct target_waitstatus *status);
349 /* Functions from hostio.c. */
350 extern int handle_vFile (char *, int, int *);
352 /* Functions from hostio-errno.c. */
353 extern void hostio_last_error_from_errno (char *own_buf);
355 /* From remote-utils.c */
357 extern int remote_debug;
358 extern int noack_mode;
359 extern int transport_is_reliable;
361 int gdb_connected (void);
363 ptid_t read_ptid (char *buf, char **obuf);
364 char *write_ptid (char *buf, ptid_t ptid);
366 int putpkt (char *buf);
367 int putpkt_binary (char *buf, int len);
368 int putpkt_notif (char *buf);
369 int getpkt (char *buf);
370 void remote_open (char *name);
371 void remote_close (void);
372 void write_ok (char *buf);
373 void write_enn (char *buf);
374 void initialize_async_io (void);
375 void enable_async_io (void);
376 void disable_async_io (void);
377 void check_remote_input_interrupt_request (void);
378 void convert_ascii_to_int (char *from, unsigned char *to, int n);
379 void convert_int_to_ascii (unsigned char *from, char *to, int n);
380 void new_thread_notify (int id);
381 void dead_thread_notify (int id);
382 void prepare_resume_reply (char *buf, ptid_t ptid,
383 struct target_waitstatus *status);
385 const char *decode_address_to_semicolon (CORE_ADDR *addrp, const char *start);
386 void decode_address (CORE_ADDR *addrp, const char *start, int len);
387 void decode_m_packet (char *from, CORE_ADDR * mem_addr_ptr,
388 unsigned int *len_ptr);
389 void decode_M_packet (char *from, CORE_ADDR * mem_addr_ptr,
390 unsigned int *len_ptr, unsigned char *to);
391 int decode_X_packet (char *from, int packet_len, CORE_ADDR * mem_addr_ptr,
392 unsigned int *len_ptr, unsigned char *to);
393 int decode_xfer_write (char *buf, int packet_len, char **annex,
394 CORE_ADDR *offset, unsigned int *len,
395 unsigned char *data);
396 int decode_search_memory_packet (const char *buf, int packet_len,
397 CORE_ADDR *start_addrp,
398 CORE_ADDR *search_space_lenp,
399 gdb_byte *pattern, unsigned int *pattern_lenp);
401 int unhexify (char *bin, const char *hex, int count);
402 int hexify (char *hex, const char *bin, int count);
403 int remote_escape_output (const gdb_byte *buffer, int len,
404 gdb_byte *out_buf, int *out_len,
406 char *unpack_varlen_hex (char *buff, ULONGEST *result);
408 void clear_symbol_cache (struct sym_cache **symcache_p);
409 int look_up_one_symbol (const char *name, CORE_ADDR *addrp, int may_ask_gdb);
411 void monitor_output (const char *msg);
413 char *xml_escape_text (const char *text);
415 /* Simple growing buffer. */
420 size_t buffer_size; /* allocated size */
421 size_t used_size; /* actually used size */
424 /* Append DATA of size SIZE to the end of BUFFER. Grows the buffer to
425 accommodate the new data. */
426 void buffer_grow (struct buffer *buffer, const char *data, size_t size);
428 /* Release any memory held by BUFFER. */
429 void buffer_free (struct buffer *buffer);
431 /* Initialize BUFFER. BUFFER holds no memory afterwards. */
432 void buffer_init (struct buffer *buffer);
434 /* Return a pointer into BUFFER data, effectivelly transfering
435 ownership of the buffer memory to the caller. Calling buffer_free
436 afterwards has no effect on the returned data. */
437 char* buffer_finish (struct buffer *buffer);
439 /* Simple printf to BUFFER function. Current implemented formatters:
440 %s - grow an xml escaped text in OBSTACK. */
441 void buffer_xml_printf (struct buffer *buffer, const char *format, ...)
442 ATTR_FORMAT (printf, 2, 3);
444 #define buffer_grow_str(BUFFER,STRING) \
445 buffer_grow (BUFFER, STRING, strlen (STRING))
446 #define buffer_grow_str0(BUFFER,STRING) \
447 buffer_grow (BUFFER, STRING, strlen (STRING) + 1)
449 /* Functions from utils.c */
451 void *xmalloc (size_t) ATTR_MALLOC;
452 void *xrealloc (void *, size_t);
453 void *xcalloc (size_t, size_t) ATTR_MALLOC;
454 char *xstrdup (const char *) ATTR_MALLOC;
455 void freeargv (char **argv);
456 void perror_with_name (const char *string);
457 void error (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
458 void fatal (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
459 void internal_error (const char *file, int line, const char *, ...)
460 ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
461 void warning (const char *string,...) ATTR_FORMAT (printf, 1, 2);
462 char *paddress (CORE_ADDR addr);
463 char *pulongest (ULONGEST u);
464 char *plongest (LONGEST l);
465 char *phex_nz (ULONGEST l, int sizeof_l);
467 #define gdb_assert(expr) \
468 ((void) ((expr) ? 0 : \
469 (gdb_assert_fail (#expr, __FILE__, __LINE__, ASSERT_FUNCTION), 0)))
471 /* Version 2.4 and later of GCC define a magical variable `__PRETTY_FUNCTION__'
472 which contains the name of the function currently being defined.
473 This is broken in G++ before version 2.6.
474 C9x has a similar variable called __func__, but prefer the GCC one since
475 it demangles C++ function names. */
476 #if (GCC_VERSION >= 2004)
477 #define ASSERT_FUNCTION __PRETTY_FUNCTION__
479 #if defined __STDC_VERSION__ && __STDC_VERSION__ >= 199901L
480 #define ASSERT_FUNCTION __func__
484 /* This prints an "Assertion failed" message, and exits. */
485 #if defined (ASSERT_FUNCTION)
486 #define gdb_assert_fail(assertion, file, line, function) \
487 internal_error (file, line, "%s: Assertion `%s' failed.", \
490 #define gdb_assert_fail(assertion, file, line, function) \
491 internal_error (file, line, "Assertion `%s' failed.", \
495 /* Maximum number of bytes to read/write at once. The value here
496 is chosen to fill up a packet (the headers account for the 32). */
497 #define MAXBUFBYTES(N) (((N)-32)/2)
499 /* Buffer sizes for transferring memory, registers, etc. Set to a constant
500 value to accomodate multiple register formats. This value must be at least
501 as large as the largest register set supported by gdbserver. */
502 #define PBUFSIZ 16384
504 /* Functions from tracepoint.c */
506 void initialize_tracepoint (void);
509 extern int disconnected_tracing;
511 void stop_tracing (void);
513 int handle_tracepoint_general_set (char *own_buf);
514 int handle_tracepoint_query (char *own_buf);
516 int tracepoint_finished_step (struct thread_info *tinfo, CORE_ADDR stop_pc);
517 int tracepoint_was_hit (struct thread_info *tinfo, CORE_ADDR stop_pc);
519 void release_while_stepping_state_list (struct thread_info *tinfo);
521 extern int current_traceframe;
523 int in_readonly_region (CORE_ADDR addr, ULONGEST length);
524 int traceframe_read_mem (int tfnum, CORE_ADDR addr,
525 unsigned char *buf, ULONGEST length,
527 int fetch_traceframe_registers (int tfnum,
528 struct regcache *regcache,
531 /* Version information, from version.c. */
532 extern const char version[];
533 extern const char host_name[];
535 #endif /* SERVER_H */