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 struct process_info *get_thread_process (struct thread_info *);
 205
 206 #include "regcache.h"
 207 #include "gdb/signals.h"
 208 #include "gdb_signals.h"
 209 #include "target.h"
 210 #include "mem-break.h"
 211
 212 /* Target-specific functions */
 213
 214 void initialize_low ();
 215
 216 /* From inferiors.c.  */
 217
 218 extern struct inferior_list all_processes;
 219 extern struct inferior_list all_threads;
 220 extern struct inferior_list all_dlls;
 221 extern int dlls_changed;
 222
 223 void initialize_inferiors (void);
 224
 225 void add_inferior_to_list (struct inferior_list *list,
 226                            struct inferior_list_entry *new_inferior);
 227 void for_each_inferior (struct inferior_list *list,
 228                         void (*action) (struct inferior_list_entry *));
 229
 230 extern struct thread_info *current_inferior;
 231 void remove_inferior (struct inferior_list *list,
 232                       struct inferior_list_entry *entry);
 233 void remove_thread (struct thread_info *thread);
 234 void add_thread (ptid_t ptid, void *target_data);
 235
 236 struct process_info *add_process (int pid, int attached);
 237 void remove_process (struct process_info *process);
 238 struct process_info *find_process_pid (int pid);
 239
 240 struct thread_info *find_thread_pid (ptid_t ptid);
 241
 242 ptid_t thread_id_to_gdb_id (ptid_t);
 243 ptid_t thread_to_gdb_id (struct thread_info *);
 244 ptid_t gdb_id_to_thread_id (ptid_t);
 245 struct thread_info *gdb_id_to_thread (unsigned int);
 246 void clear_inferiors (void);
 247 struct inferior_list_entry *find_inferior
 248      (struct inferior_list *,
 249       int (*func) (struct inferior_list_entry *,
 250                    void *),
 251       void *arg);
 252 struct inferior_list_entry *find_inferior_id (struct inferior_list *list,
 253                                               ptid_t id);
 254 void *inferior_target_data (struct thread_info *);
 255 void set_inferior_target_data (struct thread_info *, void *);
 256 void *inferior_regcache_data (struct thread_info *);
 257 void set_inferior_regcache_data (struct thread_info *, void *);
 258 void add_pid_to_list (struct inferior_list *list, unsigned long pid);
 259 int pull_pid_from_list (struct inferior_list *list, unsigned long pid);
 260
 261 void loaded_dll (const char *name, CORE_ADDR base_addr);
 262 void unloaded_dll (const char *name, CORE_ADDR base_addr);
 263
 264 /* Public variables in server.c */
 265
 266 extern ptid_t cont_thread;
 267 extern ptid_t general_thread;
 268 extern ptid_t step_thread;
 269
 270 extern int server_waiting;
 271 extern int debug_threads;
 272 extern int pass_signals[];
 273
 274 extern jmp_buf toplevel;
 275
 276 extern int disable_packet_vCont;
 277 extern int disable_packet_Tthread;
 278 extern int disable_packet_qC;
 279 extern int disable_packet_qfThreadInfo;
 280
 281 extern int multi_process;
 282 extern int non_stop;
 283
 284 /* Functions from event-loop.c.  */
 285 typedef void *gdb_client_data;
 286 typedef void (handler_func) (int, gdb_client_data);
 287
 288 extern void delete_file_handler (int fd);
 289 extern void add_file_handler (int fd, handler_func *proc,
 290                               gdb_client_data client_data);
 291
 292 extern void start_event_loop (void);
 293
 294 /* Functions from server.c.  */
 295 extern void handle_serial_event (int err, gdb_client_data client_data);
 296 extern void handle_target_event (int err, gdb_client_data client_data);
 297
 298 extern void push_event (ptid_t ptid, struct target_waitstatus *status);
 299
 300 /* Functions from hostio.c.  */
 301 extern int handle_vFile (char *, int, int *);
 302
 303 /* Functions from hostio-errno.c.  */
 304 extern void hostio_last_error_from_errno (char *own_buf);
 305
 306 /* From remote-utils.c */
 307
 308 extern int remote_debug;
 309 extern int all_symbols_looked_up;
 310 extern int noack_mode;
 311 extern int transport_is_reliable;
 312
 313 ptid_t read_ptid (char *buf, char **obuf);
 314 char *write_ptid (char *buf, ptid_t ptid);
 315
 316 int putpkt (char *buf);
 317 int putpkt_binary (char *buf, int len);
 318 int putpkt_notif (char *buf);
 319 int getpkt (char *buf);
 320 void remote_open (char *name);
 321 void remote_close (void);
 322 void write_ok (char *buf);
 323 void write_enn (char *buf);
 324 void initialize_async_io (void);
 325 void enable_async_io (void);
 326 void disable_async_io (void);
 327 void check_remote_input_interrupt_request (void);
 328 void convert_ascii_to_int (char *from, unsigned char *to, int n);
 329 void convert_int_to_ascii (unsigned char *from, char *to, int n);
 330 void new_thread_notify (int id);
 331 void dead_thread_notify (int id);
 332 void prepare_resume_reply (char *buf, ptid_t ptid,
 333                            struct target_waitstatus *status);
 334
 335 const char *decode_address_to_semicolon (CORE_ADDR *addrp, const char *start);
 336 void decode_address (CORE_ADDR *addrp, const char *start, int len);
 337 void decode_m_packet (char *from, CORE_ADDR * mem_addr_ptr,
 338                       unsigned int *len_ptr);
 339 void decode_M_packet (char *from, CORE_ADDR * mem_addr_ptr,
 340                       unsigned int *len_ptr, unsigned char *to);
 341 int decode_X_packet (char *from, int packet_len, CORE_ADDR * mem_addr_ptr,
 342                      unsigned int *len_ptr, unsigned char *to);
 343 int decode_xfer_write (char *buf, int packet_len, char **annex,
 344                        CORE_ADDR *offset, unsigned int *len,
 345                        unsigned char *data);
 346 int decode_search_memory_packet (const char *buf, int packet_len,
 347                                  CORE_ADDR *start_addrp,
 348                                  CORE_ADDR *search_space_lenp,
 349                                  gdb_byte *pattern, unsigned int *pattern_lenp);
 350
 351 int unhexify (char *bin, const char *hex, int count);
 352 int hexify (char *hex, const char *bin, int count);
 353 int remote_escape_output (const gdb_byte *buffer, int len,
 354                           gdb_byte *out_buf, int *out_len,
 355                           int out_maxlen);
 356
 357 void clear_symbol_cache (struct sym_cache **symcache_p);
 358 int look_up_one_symbol (const char *name, CORE_ADDR *addrp);
 359
 360 void monitor_output (const char *msg);
 361
 362 char *xml_escape_text (const char *text);
 363
 364 /* Simple growing buffer.  */
 365
 366 struct buffer
 367 {
 368   char *buffer;
 369   size_t buffer_size; /* allocated size */
 370   size_t used_size; /* actually used size */
 371 };
 372
 373 /* Append DATA of size SIZE to the end of BUFFER.  Grows the buffer to
 374    accommodate the new data.  */
 375 void buffer_grow (struct buffer *buffer, const char *data, size_t size);
 376
 377 /* Release any memory held by BUFFER.  */
 378 void buffer_free (struct buffer *buffer);
 379
 380 /* Initialize BUFFER.  BUFFER holds no memory afterwards.  */
 381 void buffer_init (struct buffer *buffer);
 382
 383 /* Return a pointer into BUFFER data, effectivelly transfering
 384    ownership of the buffer memory to the caller.  Calling buffer_free
 385    afterwards has no effect on the returned data.  */
 386 char* buffer_finish (struct buffer *buffer);
 387
 388 /* Simple printf to BUFFER function.  Current implemented formatters:
 389    %s - grow an xml escaped text in OBSTACK.  */
 390 void buffer_xml_printf (struct buffer *buffer, const char *format, ...)
 391   ATTR_FORMAT (printf, 2, 3);;
 392
 393 #define buffer_grow_str(BUFFER,STRING)         \
 394   buffer_grow (BUFFER, STRING, strlen (STRING))
 395 #define buffer_grow_str0(BUFFER,STRING)                        \
 396   buffer_grow (BUFFER, STRING, strlen (STRING) + 1)
 397
 398 /* Functions from utils.c */
 399
 400 void *xmalloc (size_t) ATTR_MALLOC;
 401 void *xcalloc (size_t, size_t) ATTR_MALLOC;
 402 char *xstrdup (const char *) ATTR_MALLOC;
 403 void freeargv (char **argv);
 404 void perror_with_name (const char *string);
 405 void error (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 406 void fatal (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 407 void warning (const char *string,...) ATTR_FORMAT (printf, 1, 2);
 408
 409 /* Maximum number of bytes to read/write at once.  The value here
 410    is chosen to fill up a packet (the headers account for the 32).  */
 411 #define MAXBUFBYTES(N) (((N)-32)/2)
 412
 413 /* Buffer sizes for transferring memory, registers, etc.   Set to a constant
 414    value to accomodate multiple register formats.  This value must be at least
 415    as large as the largest register set supported by gdbserver.  */
 416 #define PBUFSIZ 16384
 417
 418 /* Version information, from version.c.  */
 419 extern const char version[];
 420 extern const char host_name[];
 421
 422 #endif /* SERVER_H */