gdb/gdbserver/server.h

   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 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   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.
  11
  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.
  16
  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/>.  */
  19
  20 #ifndef SERVER_H
  21 #define SERVER_H
  22
  23 #include "config.h"
  24
  25 #ifdef __MINGW32CE__
  26 #include "wincecompat.h"
  27 #endif
  28
  29 #include <stdarg.h>
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #ifdef HAVE_ERRNO_H
  33 #include <errno.h>
  34 #endif
  35 #include <setjmp.h>
  36
  37 #ifdef HAVE_STRING_H
  38 #include <string.h>
  39 #endif
  40
  41 #if !HAVE_DECL_STRERROR
  42 #ifndef strerror
  43 extern char *strerror (int);    /* X3.159-1989  4.11.6.2 */
  44 #endif
  45 #endif
  46
  47 #if !HAVE_DECL_PERROR
  48 #ifndef perror
  49 extern void perror (const char *);
  50 #endif
  51 #endif
  52
  53 #if !HAVE_DECL_MEMMEM
  54 extern void *memmem (const void *, size_t , const void *, size_t);
  55 #endif
  56
  57 #ifndef ATTR_NORETURN
  58 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
  59 #define ATTR_NORETURN __attribute__ ((noreturn))
  60 #else
  61 #define ATTR_NORETURN           /* nothing */
  62 #endif
  63 #endif
  64
  65 #ifndef ATTR_FORMAT
  66 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
  67 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
  68 #else
  69 #define ATTR_FORMAT(type, x, y) /* nothing */
  70 #endif
  71 #endif
  72
  73 #ifndef ATTR_MALLOC
  74 #if defined(__GNUC__) && (__GNUC__ >= 3)
  75 #define ATTR_MALLOC __attribute__ ((__malloc__))
  76 #else
  77 #define ATTR_MALLOC             /* nothing */
  78 #endif
  79 #endif
  80
  81 /* A type used for binary buffers.  */
  82 typedef unsigned char gdb_byte;
  83
  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;
  87
  88 typedef unsigned long long ULONGEST;
  89
  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:
  96
  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.
 103
 104    Please do NOT access the struct ptid members directly (except, of
 105    course, in the implementation of the above ptid manipulation
 106    functions).  */
 107
 108 struct ptid
 109   {
 110     /* Process id */
 111     int pid;
 112
 113     /* Lightweight process id */
 114     long lwp;
 115
 116     /* Thread id */
 117     long tid;
 118   };
 119
 120 typedef struct ptid ptid_t;
 121
 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;
 125
 126 /* The null or zero ptid, often used to indicate no process.  */
 127 extern ptid_t null_ptid;
 128
 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
 131    return that.  */
 132 ptid_t ptid_build (int pid, long lwp, long tid);
 133
 134 /* Create a ptid from just a pid.  */
 135 ptid_t pid_to_ptid (int pid);
 136
 137 /* Fetch the pid (process id) component from a ptid.  */
 138 int ptid_get_pid (ptid_t ptid);
 139
 140 /* Fetch the lwp (lightweight process) component from a ptid.  */
 141 long ptid_get_lwp (ptid_t ptid);
 142
 143 /* Fetch the tid (thread id) component from a ptid.  */
 144 long ptid_get_tid (ptid_t ptid);
 145
 146 /* Compare two ptids to see if they are equal.  */
 147 extern int ptid_equal (ptid_t p1, ptid_t p2);
 148
 149 /* Return true if this ptid represents a process id.  */
 150 extern int ptid_is_pid (ptid_t ptid);
 151
 152 /* Generic information for tracking a list of ``inferiors'' - threads,
 153    processes, etc.  */
 154 struct inferior_list
 155 {
 156   struct inferior_list_entry *head;
 157   struct inferior_list_entry *tail;
 158 };
 159 struct inferior_list_entry
 160 {
 161   ptid_t id;
 162   struct inferior_list_entry *next;
 163 };
 164
 165 /* Opaque type for user-visible threads.  */
 166 struct thread_info;
 167
 168 struct dll_info
 169 {
 170   struct inferior_list_entry entry;
 171   char *name;
 172   CORE_ADDR base_addr;
 173 };
 174
 175 struct sym_cache;
 176 struct breakpoint;
 177 struct process_info_private;
 178
 179 struct process_info
 180 {
 181   struct inferior_list_entry head;
 182
 183   int attached;
 184
 185   /* The symbol cache.  */
 186   struct sym_cache *symbol_cache;
 187
 188   /* If this flag has been set, assume symbol cache misses are
 189      failures.  */
 190   int all_symbols_looked_up;
 191
 192   /* The list of memory breakpoints.  */
 193   struct breakpoint *breakpoints;
 194
 195   /* Private target data.  */
 196   struct process_info_private *private;
 197 };
 198
 199 /* Return a pointer to the process that corresponds to the current
 200    thread (current_inferior).  It is an error to call this if there is
 201    no current thread selected.  */
 202
 203 struct process_info *current_process (void);
 204
 205 #include "regcache.h"
 206 #include "gdb/signals.h"
 207 #include "gdb_signals.h"
 208 #include "target.h"
 209 #include "mem-break.h"
 210
 211 /* Target-specific functions */
 212
 213 void initialize_low ();
 214
 215 /* From inferiors.c.  */
 216
 217 extern struct inferior_list all_processes;
 218 extern struct inferior_list all_threads;
 219 extern struct inferior_list all_dlls;
 220 extern int dlls_changed;
 221
 222 void initialize_inferiors (void);
 223
 224 void add_inferior_to_list (struct inferior_list *list,
 225                            struct inferior_list_entry *new_inferior);
 226 void for_each_inferior (struct inferior_list *list,
 227                         void (*action) (struct inferior_list_entry *));
 228
 229 extern struct thread_info *current_inferior;
 230 void remove_inferior (struct inferior_list *list,
 231                       struct inferior_list_entry *entry);
 232 void remove_thread (struct thread_info *thread);
 233 void add_thread (ptid_t ptid, void *target_data);
 234
 235 struct process_info *add_process (int pid, int attached);
 236 void remove_process (struct process_info *process);
 237 struct process_info *find_process_pid (int pid);
 238
 239 struct thread_info *find_thread_pid (ptid_t ptid);
 240
 241 ptid_t thread_id_to_gdb_id (ptid_t);
 242 ptid_t thread_to_gdb_id (struct thread_info *);
 243 ptid_t gdb_id_to_thread_id (ptid_t);
 244 struct thread_info *gdb_id_to_thread (unsigned int);
 245 void clear_inferiors (void);
 246 struct inferior_list_entry *find_inferior
 247      (struct inferior_list *,
 248       int (*func) (struct inferior_list_entry *,
 249                    void *),
 250       void *arg);
 251 struct inferior_list_entry *find_inferior_id (struct inferior_list *list,
 252                                               ptid_t id);
 253 void *inferior_target_data (struct thread_info *);
 254 void set_inferior_target_data (struct thread_info *, void *);
 255 void *inferior_regcache_data (struct thread_info *);
 256 void set_inferior_regcache_data (struct thread_info *, void *);
 257 void add_pid_to_list (struct inferior_list *list, unsigned long pid);
 258 int pull_pid_from_list (struct inferior_list *list, unsigned long pid);
 259
 260 void loaded_dll (const char *name, CORE_ADDR base_addr);
 261 void unloaded_dll (const char *name, CORE_ADDR base_addr);
 262
 263 /* Public variables in server.c */
 264
 265 extern ptid_t cont_thread;
 266 extern ptid_t general_thread;
 267 extern ptid_t step_thread;
 268
 269 extern int server_waiting;
 270 extern int debug_threads;
 271 extern int pass_signals[];
 272
 273 extern jmp_buf toplevel;
 274
 275 extern int disable_packet_vCont;
 276 extern int disable_packet_Tthread;
 277 extern int disable_packet_qC;
 278 extern int disable_packet_qfThreadInfo;
 279
 280 extern int multi_process;
 281 extern int non_stop;
 282
 283 /* Functions from event-loop.c.  */
 284 typedef void *gdb_client_data;
 285 typedef void (handler_func) (int, gdb_client_data);
 286
 287 extern void delete_file_handler (int fd);
 288 extern void add_file_handler (int fd, handler_func *proc,
 289                               gdb_client_data client_data);
 290
 291 extern void start_event_loop (void);
 292
 293 /* Functions from server.c.  */
 294 extern void handle_serial_event (int err, gdb_client_data client_data);
 295 extern void handle_target_event (int err, gdb_client_data client_data);
 296
 297 extern void push_event (ptid_t ptid, struct target_waitstatus *status);
 298
 299 /* Functions from hostio.c.  */
 300 extern int handle_vFile (char *, int, int *);
 301
 302 /* Functions from hostio-errno.c.  */
 303 extern void hostio_last_error_from_errno (char *own_buf);
 304
 305 /* From remote-utils.c */
 306
 307 extern int remote_debug;
 308 extern int all_symbols_looked_up;
 309 extern int noack_mode;
 310 extern int transport_is_reliable;
 311
 312 ptid_t read_ptid (char *buf, char **obuf);
 313 char *write_ptid (char *buf, ptid_t ptid);
 314
 315 int putpkt (char *buf);
 316 int putpkt_binary (char *buf, int len);
 317 int putpkt_notif (char *buf);
 318 int getpkt (char *buf);
 319 void remote_open (char *name);
 320 void remote_close (void);
 321 void write_ok (char *buf);
 322 void write_enn (char *buf);
 323 void initialize_async_io (void);
 324 void enable_async_io (void);
 325 void disable_async_io (void);
 326 void check_remote_input_interrupt_request (void);
 327 void convert_ascii_to_int (char *from, unsigned char *to, int n);
 328 void convert_int_to_ascii (unsigned char *from, char *to, int n);
 329 void new_thread_notify (int id);
 330 void dead_thread_notify (int id);
 331 void prepare_resume_reply (char *buf, ptid_t ptid,
 332                            struct target_waitstatus *status);
 333
 334 const char *decode_address_to_semicolon (CORE_ADDR *addrp, const char *start);
 335 void decode_address (CORE_ADDR *addrp, const char *start, int len);
 336 void decode_m_packet (char *from, CORE_ADDR * mem_addr_ptr,
 337                       unsigned int *len_ptr);
 338 void decode_M_packet (char *from, CORE_ADDR * mem_addr_ptr,
 339                       unsigned int *len_ptr, unsigned char *to);
 340 int decode_X_packet (char *from, int packet_len, CORE_ADDR * mem_addr_ptr,
 341                      unsigned int *len_ptr, unsigned char *to);
 342 int decode_xfer_write (char *buf, int packet_len, char **annex,
 343                        CORE_ADDR *offset, unsigned int *len,
 344                        unsigned char *data);
 345 int decode_search_memory_packet (const char *buf, int packet_len,
 346                                  CORE_ADDR *start_addrp,
 347                                  CORE_ADDR *search_space_lenp,
 348                                  gdb_byte *pattern, unsigned int *pattern_lenp);
 349
 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,
 354                           int out_maxlen);
 355
 356 void clear_symbol_cache (struct sym_cache **symcache_p);
 357 int look_up_one_symbol (const char *name, CORE_ADDR *addrp);
 358
 359 void monitor_output (const char *msg);
 360
 361 char *xml_escape_text (const char *text);
 362
 363 /* Simple growing buffer.  */
 364
 365 struct buffer
 366 {
 367   char *buffer;
 368   size_t buffer_size; /* allocated size */
 369   size_t used_size; /* actually used size */
 370 };
 371
 372 /* Append DATA of size SIZE to the end of BUFFER.  Grows the buffer to
 373    accommodate the new data.  */
 374 void buffer_grow (struct buffer *buffer, const char *data, size_t size);
 375
 376 /* Release any memory held by BUFFER.  */
 377 void buffer_free (struct buffer *buffer);
 378
 379 /* Initialize BUFFER.  BUFFER holds no memory afterwards.  */
 380 void buffer_init (struct buffer *buffer);
 381
 382 /* Return a pointer into BUFFER data, effectivelly transfering
 383    ownership of the buffer memory to the caller.  Calling buffer_free
 384    afterwards has no effect on the returned data.  */
 385 char* buffer_finish (struct buffer *buffer);
 386
 387 /* Simple printf to BUFFER function.  Current implemented formatters:
 388    %s - grow an xml escaped text in OBSTACK.  */
 389 void buffer_xml_printf (struct buffer *buffer, const char *format, ...)
 390   ATTR_FORMAT (printf, 2, 3);;
 391
 392 #define buffer_grow_str(BUFFER,STRING)         \
 393   buffer_grow (BUFFER, STRING, strlen (STRING))
 394 #define buffer_grow_str0(BUFFER,STRING)                        \
 395   buffer_grow (BUFFER, STRING, strlen (STRING) + 1)
 396
 397 /* Functions from utils.c */
 398
 399 void *xmalloc (size_t) ATTR_MALLOC;
 400 void *xcalloc (size_t, size_t) ATTR_MALLOC;
 401 char *xstrdup (const char *) ATTR_MALLOC;
 402 void freeargv (char **argv);
 403 void perror_with_name (const char *string);
 404 void error (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 405 void fatal (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 406 void warning (const char *string,...) ATTR_FORMAT (printf, 1, 2);
 407
 408 /* Maximum number of bytes to read/write at once.  The value here
 409    is chosen to fill up a packet (the headers account for the 32).  */
 410 #define MAXBUFBYTES(N) (((N)-32)/2)
 411
 412 /* Buffer sizes for transferring memory, registers, etc.   Set to a constant
 413    value to accomodate multiple register formats.  This value must be at least
 414    as large as the largest register set supported by gdbserver.  */
 415 #define PBUFSIZ 16384
 416
 417 /* Version information, from version.c.  */
 418 extern const char version[];
 419 extern const char host_name[];
 420
 421 #endif /* SERVER_H */