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 unsigned long long ULONGEST
;
90 /* The ptid struct is a collection of the various "ids" necessary
91 for identifying the inferior. This consists of the process id
92 (pid), thread id (tid), and other fields necessary for uniquely
93 identifying the inferior process/thread being debugged. When
94 manipulating ptids, the constructors, accessors, and predicate
95 declared in server.h should be used. These are as follows:
97 ptid_build - Make a new ptid from a pid, lwp, and tid.
98 pid_to_ptid - Make a new ptid from just a pid.
99 ptid_get_pid - Fetch the pid component of a ptid.
100 ptid_get_lwp - Fetch the lwp component of a ptid.
101 ptid_get_tid - Fetch the tid component of a ptid.
102 ptid_equal - Test to see if two ptids are equal.
104 Please do NOT access the struct ptid members directly (except, of
105 course, in the implementation of the above ptid manipulation
113 /* Lightweight process id */
120 typedef struct ptid ptid_t
;
122 /* The -1 ptid, often used to indicate either an error condition or a
123 "don't care" condition, i.e, "run all threads". */
124 extern ptid_t minus_one_ptid
;
126 /* The null or zero ptid, often used to indicate no process. */
127 extern ptid_t null_ptid
;
129 /* Attempt to find and return an existing ptid with the given PID,
130 LWP, and TID components. If none exists, create a new one and
132 ptid_t
ptid_build (int pid
, long lwp
, long tid
);
134 /* Create a ptid from just a pid. */
135 ptid_t
pid_to_ptid (int pid
);
137 /* Fetch the pid (process id) component from a ptid. */
138 int ptid_get_pid (ptid_t ptid
);
140 /* Fetch the lwp (lightweight process) component from a ptid. */
141 long ptid_get_lwp (ptid_t ptid
);
143 /* Fetch the tid (thread id) component from a ptid. */
144 long ptid_get_tid (ptid_t ptid
);
146 /* Compare two ptids to see if they are equal. */
147 extern int ptid_equal (ptid_t p1
, ptid_t p2
);
149 /* Return true if this ptid represents a process id. */
150 extern int ptid_is_pid (ptid_t ptid
);
152 /* Generic information for tracking a list of ``inferiors'' - threads,
156 struct inferior_list_entry
*head
;
157 struct inferior_list_entry
*tail
;
159 struct inferior_list_entry
162 struct inferior_list_entry
*next
;
169 #include "regcache.h"
170 #include "gdb/signals.h"
171 #include "gdb_signals.h"
173 #include "mem-break.h"
177 struct inferior_list_entry entry
;
181 /* The last wait status reported for this thread. */
182 struct target_waitstatus last_status
;
187 struct inferior_list_entry entry
;
194 struct raw_breakpoint
;
195 struct process_info_private
;
199 struct inferior_list_entry head
;
203 /* The symbol cache. */
204 struct sym_cache
*symbol_cache
;
206 /* If this flag has been set, assume symbol cache misses are
208 int all_symbols_looked_up
;
210 /* The list of memory breakpoints. */
211 struct breakpoint
*breakpoints
;
213 /* The list of raw memory breakpoints. */
214 struct raw_breakpoint
*raw_breakpoints
;
216 /* Private target data. */
217 struct process_info_private
*private;
220 /* Return a pointer to the process that corresponds to the current
221 thread (current_inferior). It is an error to call this if there is
222 no current thread selected. */
224 struct process_info
*current_process (void);
225 struct process_info
*get_thread_process (struct thread_info
*);
227 /* Target-specific functions */
229 void initialize_low ();
231 /* From inferiors.c. */
233 extern struct inferior_list all_processes
;
234 extern struct inferior_list all_threads
;
235 extern struct inferior_list all_dlls
;
236 extern int dlls_changed
;
238 void initialize_inferiors (void);
240 void add_inferior_to_list (struct inferior_list
*list
,
241 struct inferior_list_entry
*new_inferior
);
242 void for_each_inferior (struct inferior_list
*list
,
243 void (*action
) (struct inferior_list_entry
*));
245 extern struct thread_info
*current_inferior
;
246 void remove_inferior (struct inferior_list
*list
,
247 struct inferior_list_entry
*entry
);
248 void remove_thread (struct thread_info
*thread
);
249 void add_thread (ptid_t ptid
, void *target_data
);
251 struct process_info
*add_process (int pid
, int attached
);
252 void remove_process (struct process_info
*process
);
253 struct process_info
*find_process_pid (int pid
);
254 int have_started_inferiors_p (void);
255 int have_attached_inferiors_p (void);
257 struct thread_info
*find_thread_ptid (ptid_t ptid
);
259 ptid_t
thread_id_to_gdb_id (ptid_t
);
260 ptid_t
thread_to_gdb_id (struct thread_info
*);
261 ptid_t
gdb_id_to_thread_id (ptid_t
);
262 struct thread_info
*gdb_id_to_thread (unsigned int);
263 void clear_inferiors (void);
264 struct inferior_list_entry
*find_inferior
265 (struct inferior_list
*,
266 int (*func
) (struct inferior_list_entry
*,
269 struct inferior_list_entry
*find_inferior_id (struct inferior_list
*list
,
271 void *inferior_target_data (struct thread_info
*);
272 void set_inferior_target_data (struct thread_info
*, void *);
273 void *inferior_regcache_data (struct thread_info
*);
274 void set_inferior_regcache_data (struct thread_info
*, void *);
275 void add_pid_to_list (struct inferior_list
*list
, unsigned long pid
);
276 int pull_pid_from_list (struct inferior_list
*list
, unsigned long pid
);
278 void loaded_dll (const char *name
, CORE_ADDR base_addr
);
279 void unloaded_dll (const char *name
, CORE_ADDR base_addr
);
281 /* Public variables in server.c */
283 extern ptid_t cont_thread
;
284 extern ptid_t general_thread
;
285 extern ptid_t step_thread
;
287 extern int server_waiting
;
288 extern int debug_threads
;
289 extern int debug_hw_points
;
290 extern int pass_signals
[];
292 extern jmp_buf toplevel
;
294 extern int disable_packet_vCont
;
295 extern int disable_packet_Tthread
;
296 extern int disable_packet_qC
;
297 extern int disable_packet_qfThreadInfo
;
299 extern int multi_process
;
302 /* Functions from event-loop.c. */
303 typedef void *gdb_client_data
;
304 typedef void (handler_func
) (int, gdb_client_data
);
306 extern void delete_file_handler (int fd
);
307 extern void add_file_handler (int fd
, handler_func
*proc
,
308 gdb_client_data client_data
);
310 extern void start_event_loop (void);
312 /* Functions from server.c. */
313 extern void handle_serial_event (int err
, gdb_client_data client_data
);
314 extern void handle_target_event (int err
, gdb_client_data client_data
);
316 extern void push_event (ptid_t ptid
, struct target_waitstatus
*status
);
318 /* Functions from hostio.c. */
319 extern int handle_vFile (char *, int, int *);
321 /* Functions from hostio-errno.c. */
322 extern void hostio_last_error_from_errno (char *own_buf
);
324 /* From remote-utils.c */
326 extern int remote_debug
;
327 extern int all_symbols_looked_up
;
328 extern int noack_mode
;
329 extern int transport_is_reliable
;
331 ptid_t
read_ptid (char *buf
, char **obuf
);
332 char *write_ptid (char *buf
, ptid_t ptid
);
334 int putpkt (char *buf
);
335 int putpkt_binary (char *buf
, int len
);
336 int putpkt_notif (char *buf
);
337 int getpkt (char *buf
);
338 void remote_open (char *name
);
339 void remote_close (void);
340 void write_ok (char *buf
);
341 void write_enn (char *buf
);
342 void initialize_async_io (void);
343 void enable_async_io (void);
344 void disable_async_io (void);
345 void check_remote_input_interrupt_request (void);
346 void convert_ascii_to_int (char *from
, unsigned char *to
, int n
);
347 void convert_int_to_ascii (unsigned char *from
, char *to
, int n
);
348 void new_thread_notify (int id
);
349 void dead_thread_notify (int id
);
350 void prepare_resume_reply (char *buf
, ptid_t ptid
,
351 struct target_waitstatus
*status
);
353 const char *decode_address_to_semicolon (CORE_ADDR
*addrp
, const char *start
);
354 void decode_address (CORE_ADDR
*addrp
, const char *start
, int len
);
355 void decode_m_packet (char *from
, CORE_ADDR
* mem_addr_ptr
,
356 unsigned int *len_ptr
);
357 void decode_M_packet (char *from
, CORE_ADDR
* mem_addr_ptr
,
358 unsigned int *len_ptr
, unsigned char *to
);
359 int decode_X_packet (char *from
, int packet_len
, CORE_ADDR
* mem_addr_ptr
,
360 unsigned int *len_ptr
, unsigned char *to
);
361 int decode_xfer_write (char *buf
, int packet_len
, char **annex
,
362 CORE_ADDR
*offset
, unsigned int *len
,
363 unsigned char *data
);
364 int decode_search_memory_packet (const char *buf
, int packet_len
,
365 CORE_ADDR
*start_addrp
,
366 CORE_ADDR
*search_space_lenp
,
367 gdb_byte
*pattern
, unsigned int *pattern_lenp
);
369 int unhexify (char *bin
, const char *hex
, int count
);
370 int hexify (char *hex
, const char *bin
, int count
);
371 int remote_escape_output (const gdb_byte
*buffer
, int len
,
372 gdb_byte
*out_buf
, int *out_len
,
375 void clear_symbol_cache (struct sym_cache
**symcache_p
);
376 int look_up_one_symbol (const char *name
, CORE_ADDR
*addrp
);
378 void monitor_output (const char *msg
);
380 char *xml_escape_text (const char *text
);
382 /* Simple growing buffer. */
387 size_t buffer_size
; /* allocated size */
388 size_t used_size
; /* actually used size */
391 /* Append DATA of size SIZE to the end of BUFFER. Grows the buffer to
392 accommodate the new data. */
393 void buffer_grow (struct buffer
*buffer
, const char *data
, size_t size
);
395 /* Release any memory held by BUFFER. */
396 void buffer_free (struct buffer
*buffer
);
398 /* Initialize BUFFER. BUFFER holds no memory afterwards. */
399 void buffer_init (struct buffer
*buffer
);
401 /* Return a pointer into BUFFER data, effectivelly transfering
402 ownership of the buffer memory to the caller. Calling buffer_free
403 afterwards has no effect on the returned data. */
404 char* buffer_finish (struct buffer
*buffer
);
406 /* Simple printf to BUFFER function. Current implemented formatters:
407 %s - grow an xml escaped text in OBSTACK. */
408 void buffer_xml_printf (struct buffer
*buffer
, const char *format
, ...)
409 ATTR_FORMAT (printf
, 2, 3);;
411 #define buffer_grow_str(BUFFER,STRING) \
412 buffer_grow (BUFFER, STRING, strlen (STRING))
413 #define buffer_grow_str0(BUFFER,STRING) \
414 buffer_grow (BUFFER, STRING, strlen (STRING) + 1)
416 /* Functions from utils.c */
418 void *xmalloc (size_t) ATTR_MALLOC
;
419 void *xcalloc (size_t, size_t) ATTR_MALLOC
;
420 char *xstrdup (const char *) ATTR_MALLOC
;
421 void freeargv (char **argv
);
422 void perror_with_name (const char *string
);
423 void error (const char *string
,...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
424 void fatal (const char *string
,...) ATTR_NORETURN
ATTR_FORMAT (printf
, 1, 2);
425 void internal_error (const char *file
, int line
, const char *, ...)
426 ATTR_NORETURN
ATTR_FORMAT (printf
, 3, 4);
427 void warning (const char *string
,...) ATTR_FORMAT (printf
, 1, 2);
428 char *paddress (CORE_ADDR addr
);
430 #define gdb_assert(expr) \
431 ((void) ((expr) ? 0 : \
432 (gdb_assert_fail (#expr, __FILE__, __LINE__, ASSERT_FUNCTION), 0)))
434 /* Version 2.4 and later of GCC define a magical variable `__PRETTY_FUNCTION__'
435 which contains the name of the function currently being defined.
436 This is broken in G++ before version 2.6.
437 C9x has a similar variable called __func__, but prefer the GCC one since
438 it demangles C++ function names. */
439 #if (GCC_VERSION >= 2004)
440 #define ASSERT_FUNCTION __PRETTY_FUNCTION__
442 #if defined __STDC_VERSION__ && __STDC_VERSION__ >= 199901L
443 #define ASSERT_FUNCTION __func__
447 /* This prints an "Assertion failed" message, and exits. */
448 #if defined (ASSERT_FUNCTION)
449 #define gdb_assert_fail(assertion, file, line, function) \
450 internal_error (file, line, "%s: Assertion `%s' failed.", \
453 #define gdb_assert_fail(assertion, file, line, function) \
454 internal_error (file, line, "Assertion `%s' failed.", \
458 /* Maximum number of bytes to read/write at once. The value here
459 is chosen to fill up a packet (the headers account for the 32). */
460 #define MAXBUFBYTES(N) (((N)-32)/2)
462 /* Buffer sizes for transferring memory, registers, etc. Set to a constant
463 value to accomodate multiple register formats. This value must be at least
464 as large as the largest register set supported by gdbserver. */
465 #define PBUFSIZ 16384
467 /* Version information, from version.c. */
468 extern const char version
[];
469 extern const char host_name
[];
471 #endif /* SERVER_H */