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 struct thread_info;
 166 struct process_info;
 167 struct regcache;
 168
 169 #include "regcache.h"
 170 #include "gdb/signals.h"
 171 #include "gdb_signals.h"
 172 #include "target.h"
 173 #include "mem-break.h"
 174
 175 struct thread_info
 176 {
 177   struct inferior_list_entry entry;
 178   void *target_data;
 179   void *regcache_data;
 180
 181   /* The last wait status reported for this thread.  */
 182   struct target_waitstatus last_status;
 183 };
 184
 185 struct dll_info
 186 {
 187   struct inferior_list_entry entry;
 188   char *name;
 189   CORE_ADDR base_addr;
 190 };
 191
 192 struct sym_cache;
 193 struct breakpoint;
 194 struct process_info_private;
 195
 196 struct process_info
 197 {
 198   struct inferior_list_entry head;
 199
 200   int attached;
 201
 202   /* The symbol cache.  */
 203   struct sym_cache *symbol_cache;
 204
 205   /* If this flag has been set, assume symbol cache misses are
 206      failures.  */
 207   int all_symbols_looked_up;
 208
 209   /* The list of memory breakpoints.  */
 210   struct breakpoint *breakpoints;
 211
 212   /* Private target data.  */
 213   struct process_info_private *private;
 214 };
 215
 216 /* Return a pointer to the process that corresponds to the current
 217    thread (current_inferior).  It is an error to call this if there is
 218    no current thread selected.  */
 219
 220 struct process_info *current_process (void);
 221 struct process_info *get_thread_process (struct thread_info *);
 222
 223 /* Target-specific functions */
 224
 225 void initialize_low ();
 226
 227 /* From inferiors.c.  */
 228
 229 extern struct inferior_list all_processes;
 230 extern struct inferior_list all_threads;
 231 extern struct inferior_list all_dlls;
 232 extern int dlls_changed;
 233
 234 void initialize_inferiors (void);
 235
 236 void add_inferior_to_list (struct inferior_list *list,
 237                            struct inferior_list_entry *new_inferior);
 238 void for_each_inferior (struct inferior_list *list,
 239                         void (*action) (struct inferior_list_entry *));
 240
 241 extern struct thread_info *current_inferior;
 242 void remove_inferior (struct inferior_list *list,
 243                       struct inferior_list_entry *entry);
 244 void remove_thread (struct thread_info *thread);
 245 void add_thread (ptid_t ptid, void *target_data);
 246
 247 struct process_info *add_process (int pid, int attached);
 248 void remove_process (struct process_info *process);
 249 struct process_info *find_process_pid (int pid);
 250 int have_started_inferiors_p (void);
 251 int have_attached_inferiors_p (void);
 252
 253 struct thread_info *find_thread_ptid (ptid_t ptid);
 254
 255 ptid_t thread_id_to_gdb_id (ptid_t);
 256 ptid_t thread_to_gdb_id (struct thread_info *);
 257 ptid_t gdb_id_to_thread_id (ptid_t);
 258 struct thread_info *gdb_id_to_thread (unsigned int);
 259 void clear_inferiors (void);
 260 struct inferior_list_entry *find_inferior
 261      (struct inferior_list *,
 262       int (*func) (struct inferior_list_entry *,
 263                    void *),
 264       void *arg);
 265 struct inferior_list_entry *find_inferior_id (struct inferior_list *list,
 266                                               ptid_t id);
 267 void *inferior_target_data (struct thread_info *);
 268 void set_inferior_target_data (struct thread_info *, void *);
 269 void *inferior_regcache_data (struct thread_info *);
 270 void set_inferior_regcache_data (struct thread_info *, void *);
 271 void add_pid_to_list (struct inferior_list *list, unsigned long pid);
 272 int pull_pid_from_list (struct inferior_list *list, unsigned long pid);
 273
 274 void loaded_dll (const char *name, CORE_ADDR base_addr);
 275 void unloaded_dll (const char *name, CORE_ADDR base_addr);
 276
 277 /* Public variables in server.c */
 278
 279 extern ptid_t cont_thread;
 280 extern ptid_t general_thread;
 281 extern ptid_t step_thread;
 282
 283 extern int server_waiting;
 284 extern int debug_threads;
 285 extern int debug_hw_points;
 286 extern int pass_signals[];
 287
 288 extern jmp_buf toplevel;
 289
 290 extern int disable_packet_vCont;
 291 extern int disable_packet_Tthread;
 292 extern int disable_packet_qC;
 293 extern int disable_packet_qfThreadInfo;
 294
 295 extern int multi_process;
 296 extern int non_stop;
 297
 298 /* Functions from event-loop.c.  */
 299 typedef void *gdb_client_data;
 300 typedef void (handler_func) (int, gdb_client_data);
 301
 302 extern void delete_file_handler (int fd);
 303 extern void add_file_handler (int fd, handler_func *proc,
 304                               gdb_client_data client_data);
 305
 306 extern void start_event_loop (void);
 307
 308 /* Functions from server.c.  */
 309 extern void handle_serial_event (int err, gdb_client_data client_data);
 310 extern void handle_target_event (int err, gdb_client_data client_data);
 311
 312 extern void push_event (ptid_t ptid, struct target_waitstatus *status);
 313
 314 /* Functions from hostio.c.  */
 315 extern int handle_vFile (char *, int, int *);
 316
 317 /* Functions from hostio-errno.c.  */
 318 extern void hostio_last_error_from_errno (char *own_buf);
 319
 320 /* From remote-utils.c */
 321
 322 extern int remote_debug;
 323 extern int all_symbols_looked_up;
 324 extern int noack_mode;
 325 extern int transport_is_reliable;
 326
 327 ptid_t read_ptid (char *buf, char **obuf);
 328 char *write_ptid (char *buf, ptid_t ptid);
 329
 330 int putpkt (char *buf);
 331 int putpkt_binary (char *buf, int len);
 332 int putpkt_notif (char *buf);
 333 int getpkt (char *buf);
 334 void remote_open (char *name);
 335 void remote_close (void);
 336 void write_ok (char *buf);
 337 void write_enn (char *buf);
 338 void initialize_async_io (void);
 339 void enable_async_io (void);
 340 void disable_async_io (void);
 341 void check_remote_input_interrupt_request (void);
 342 void convert_ascii_to_int (char *from, unsigned char *to, int n);
 343 void convert_int_to_ascii (unsigned char *from, char *to, int n);
 344 void new_thread_notify (int id);
 345 void dead_thread_notify (int id);
 346 void prepare_resume_reply (char *buf, ptid_t ptid,
 347                            struct target_waitstatus *status);
 348
 349 const char *decode_address_to_semicolon (CORE_ADDR *addrp, const char *start);
 350 void decode_address (CORE_ADDR *addrp, const char *start, int len);
 351 void decode_m_packet (char *from, CORE_ADDR * mem_addr_ptr,
 352                       unsigned int *len_ptr);
 353 void decode_M_packet (char *from, CORE_ADDR * mem_addr_ptr,
 354                       unsigned int *len_ptr, unsigned char *to);
 355 int decode_X_packet (char *from, int packet_len, CORE_ADDR * mem_addr_ptr,
 356                      unsigned int *len_ptr, unsigned char *to);
 357 int decode_xfer_write (char *buf, int packet_len, char **annex,
 358                        CORE_ADDR *offset, unsigned int *len,
 359                        unsigned char *data);
 360 int decode_search_memory_packet (const char *buf, int packet_len,
 361                                  CORE_ADDR *start_addrp,
 362                                  CORE_ADDR *search_space_lenp,
 363                                  gdb_byte *pattern, unsigned int *pattern_lenp);
 364
 365 int unhexify (char *bin, const char *hex, int count);
 366 int hexify (char *hex, const char *bin, int count);
 367 int remote_escape_output (const gdb_byte *buffer, int len,
 368                           gdb_byte *out_buf, int *out_len,
 369                           int out_maxlen);
 370
 371 void clear_symbol_cache (struct sym_cache **symcache_p);
 372 int look_up_one_symbol (const char *name, CORE_ADDR *addrp);
 373
 374 void monitor_output (const char *msg);
 375
 376 char *xml_escape_text (const char *text);
 377
 378 /* Simple growing buffer.  */
 379
 380 struct buffer
 381 {
 382   char *buffer;
 383   size_t buffer_size; /* allocated size */
 384   size_t used_size; /* actually used size */
 385 };
 386
 387 /* Append DATA of size SIZE to the end of BUFFER.  Grows the buffer to
 388    accommodate the new data.  */
 389 void buffer_grow (struct buffer *buffer, const char *data, size_t size);
 390
 391 /* Release any memory held by BUFFER.  */
 392 void buffer_free (struct buffer *buffer);
 393
 394 /* Initialize BUFFER.  BUFFER holds no memory afterwards.  */
 395 void buffer_init (struct buffer *buffer);
 396
 397 /* Return a pointer into BUFFER data, effectivelly transfering
 398    ownership of the buffer memory to the caller.  Calling buffer_free
 399    afterwards has no effect on the returned data.  */
 400 char* buffer_finish (struct buffer *buffer);
 401
 402 /* Simple printf to BUFFER function.  Current implemented formatters:
 403    %s - grow an xml escaped text in OBSTACK.  */
 404 void buffer_xml_printf (struct buffer *buffer, const char *format, ...)
 405   ATTR_FORMAT (printf, 2, 3);;
 406
 407 #define buffer_grow_str(BUFFER,STRING)         \
 408   buffer_grow (BUFFER, STRING, strlen (STRING))
 409 #define buffer_grow_str0(BUFFER,STRING)                        \
 410   buffer_grow (BUFFER, STRING, strlen (STRING) + 1)
 411
 412 /* Functions from utils.c */
 413
 414 void *xmalloc (size_t) ATTR_MALLOC;
 415 void *xcalloc (size_t, size_t) ATTR_MALLOC;
 416 char *xstrdup (const char *) ATTR_MALLOC;
 417 void freeargv (char **argv);
 418 void perror_with_name (const char *string);
 419 void error (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 420 void fatal (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 421 void internal_error (const char *file, int line, const char *, ...)
 422      ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
 423 void warning (const char *string,...) ATTR_FORMAT (printf, 1, 2);
 424 char *paddress (CORE_ADDR addr);
 425
 426 #define gdb_assert(expr)                                                      \
 427   ((void) ((expr) ? 0 :                                                       \
 428            (gdb_assert_fail (#expr, __FILE__, __LINE__, ASSERT_FUNCTION), 0)))
 429
 430 /* Version 2.4 and later of GCC define a magical variable `__PRETTY_FUNCTION__'
 431    which contains the name of the function currently being defined.
 432    This is broken in G++ before version 2.6.
 433    C9x has a similar variable called __func__, but prefer the GCC one since
 434    it demangles C++ function names.  */
 435 #if (GCC_VERSION >= 2004)
 436 #define ASSERT_FUNCTION         __PRETTY_FUNCTION__
 437 #else
 438 #if defined __STDC_VERSION__ && __STDC_VERSION__ >= 199901L
 439 #define ASSERT_FUNCTION         __func__
 440 #endif
 441 #endif
 442
 443 /* This prints an "Assertion failed" message, and exits.  */
 444 #if defined (ASSERT_FUNCTION)
 445 #define gdb_assert_fail(assertion, file, line, function)                \
 446   internal_error (file, line, "%s: Assertion `%s' failed.",             \
 447                   function, assertion)
 448 #else
 449 #define gdb_assert_fail(assertion, file, line, function)                \
 450   internal_error (file, line, "Assertion `%s' failed.",                 \
 451                   assertion)
 452 #endif
 453
 454 /* Maximum number of bytes to read/write at once.  The value here
 455    is chosen to fill up a packet (the headers account for the 32).  */
 456 #define MAXBUFBYTES(N) (((N)-32)/2)
 457
 458 /* Buffer sizes for transferring memory, registers, etc.   Set to a constant
 459    value to accomodate multiple register formats.  This value must be at least
 460    as large as the largest register set supported by gdbserver.  */
 461 #define PBUFSIZ 16384
 462
 463 /* Version information, from version.c.  */
 464 extern const char version[];
 465 extern const char host_name[];
 466
 467 #endif /* SERVER_H */