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