gdb/gdbserver/server.h

   1 /* Common definitions for remote server for GDB.
   2    Copyright (C) 1993, 1995, 1997-2000, 2002-2012 Free Software
   3    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 #include "build-gnulib-gdbserver/config.h"
  25
  26 #ifdef __MINGW32CE__
  27 #include "wincecompat.h"
  28 #endif
  29
  30 #include <stdarg.h>
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #ifdef HAVE_ERRNO_H
  34 #include <errno.h>
  35 #endif
  36 #include <setjmp.h>
  37
  38 #ifdef HAVE_STRING_H
  39 #include <string.h>
  40 #endif
  41
  42 #ifdef HAVE_ALLOCA_H
  43 #include <alloca.h>
  44 #endif
  45 /* On some systems such as MinGW, alloca is declared in malloc.h
  46    (there is no alloca.h).  */
  47 #if HAVE_MALLOC_H
  48 #include <malloc.h>
  49 #endif
  50
  51 #if !HAVE_DECL_STRERROR
  52 #ifndef strerror
  53 extern char *strerror (int);    /* X3.159-1989  4.11.6.2 */
  54 #endif
  55 #endif
  56
  57 #if !HAVE_DECL_PERROR
  58 #ifndef perror
  59 extern void perror (const char *);
  60 #endif
  61 #endif
  62
  63 #if !HAVE_DECL_VASPRINTF
  64 extern int vasprintf(char **strp, const char *fmt, va_list ap);
  65 #endif
  66 #if !HAVE_DECL_VSNPRINTF
  67 int vsnprintf(char *str, size_t size, const char *format, va_list ap);
  68 #endif
  69
  70 #ifndef ATTR_NORETURN
  71 #if defined(__GNUC__) && (__GNUC__ > 2 \
  72                           || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
  73 #define ATTR_NORETURN __attribute__ ((noreturn))
  74 #else
  75 #define ATTR_NORETURN           /* nothing */
  76 #endif
  77 #endif
  78
  79 #ifndef ATTR_FORMAT
  80 #if defined(__GNUC__) && (__GNUC__ > 2 \
  81                           || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
  82 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
  83 #else
  84 #define ATTR_FORMAT(type, x, y) /* nothing */
  85 #endif
  86 #endif
  87
  88 #ifndef ATTR_MALLOC
  89 #if defined(__GNUC__) && (__GNUC__ >= 3)
  90 #define ATTR_MALLOC __attribute__ ((__malloc__))
  91 #else
  92 #define ATTR_MALLOC             /* nothing */
  93 #endif
  94 #endif
  95
  96 /* Define underscore macro, if not available, to be able to use it inside
  97    code shared with gdb in common directory.  */
  98 #ifndef _
  99 #define _(String) (String)
 100 #endif
 101
 102 #ifdef IN_PROCESS_AGENT
 103 #  define PROG "ipa"
 104 #else
 105 #  define PROG "gdbserver"
 106 #endif
 107
 108 /* A type used for binary buffers.  */
 109 typedef unsigned char gdb_byte;
 110
 111 #include "ptid.h"
 112 #include "buffer.h"
 113 #include "xml-utils.h"
 114 #include "gdb_locale.h"
 115
 116 /* FIXME: This should probably be autoconf'd for.  It's an integer type at
 117    least the size of a (void *).  */
 118 typedef long long CORE_ADDR;
 119
 120 typedef long long LONGEST;
 121 typedef unsigned long long ULONGEST;
 122
 123 /* Generic information for tracking a list of ``inferiors'' - threads,
 124    processes, etc.  */
 125 struct inferior_list
 126 {
 127   struct inferior_list_entry *head;
 128   struct inferior_list_entry *tail;
 129 };
 130 struct inferior_list_entry
 131 {
 132   ptid_t id;
 133   struct inferior_list_entry *next;
 134 };
 135
 136 struct thread_info;
 137 struct process_info;
 138 struct regcache;
 139
 140 #include "regcache.h"
 141 #include "gdb/signals.h"
 142 #include "gdb_signals.h"
 143 #include "target.h"
 144 #include "mem-break.h"
 145 #include "gdbthread.h"
 146
 147 struct dll_info
 148 {
 149   struct inferior_list_entry entry;
 150   char *name;
 151   CORE_ADDR base_addr;
 152 };
 153
 154 struct sym_cache;
 155 struct breakpoint;
 156 struct raw_breakpoint;
 157 struct fast_tracepoint_jump;
 158 struct process_info_private;
 159
 160 struct process_info
 161 {
 162   struct inferior_list_entry head;
 163
 164   /* Nonzero if this child process was attached rather than
 165      spawned.  */
 166   int attached;
 167
 168   /* True if GDB asked us to detach from this process, but we remained
 169      attached anyway.  */
 170   int gdb_detached;
 171
 172   /* The symbol cache.  */
 173   struct sym_cache *symbol_cache;
 174
 175   /* The list of memory breakpoints.  */
 176   struct breakpoint *breakpoints;
 177
 178   /* The list of raw memory breakpoints.  */
 179   struct raw_breakpoint *raw_breakpoints;
 180
 181   /* The list of installed fast tracepoints.  */
 182   struct fast_tracepoint_jump *fast_tracepoint_jumps;
 183
 184   /* Private target data.  */
 185   struct process_info_private *private;
 186 };
 187
 188 /* Return a pointer to the process that corresponds to the current
 189    thread (current_inferior).  It is an error to call this if there is
 190    no current thread selected.  */
 191
 192 struct process_info *current_process (void);
 193 struct process_info *get_thread_process (struct thread_info *);
 194
 195 /* Target-specific functions */
 196
 197 void initialize_low ();
 198
 199 /* From inferiors.c.  */
 200
 201 extern struct inferior_list all_processes;
 202 extern struct inferior_list all_dlls;
 203 extern int dlls_changed;
 204 extern void clear_dlls (void);
 205
 206 void add_inferior_to_list (struct inferior_list *list,
 207                            struct inferior_list_entry *new_inferior);
 208 void for_each_inferior (struct inferior_list *list,
 209                         void (*action) (struct inferior_list_entry *));
 210
 211 extern struct thread_info *current_inferior;
 212 void remove_inferior (struct inferior_list *list,
 213                       struct inferior_list_entry *entry);
 214
 215 struct process_info *add_process (int pid, int attached);
 216 void remove_process (struct process_info *process);
 217 struct process_info *find_process_pid (int pid);
 218 int have_started_inferiors_p (void);
 219 int have_attached_inferiors_p (void);
 220
 221 ptid_t thread_id_to_gdb_id (ptid_t);
 222 ptid_t thread_to_gdb_id (struct thread_info *);
 223 ptid_t gdb_id_to_thread_id (ptid_t);
 224
 225 void clear_inferiors (void);
 226 struct inferior_list_entry *find_inferior
 227      (struct inferior_list *,
 228       int (*func) (struct inferior_list_entry *,
 229                    void *),
 230       void *arg);
 231 struct inferior_list_entry *find_inferior_id (struct inferior_list *list,
 232                                               ptid_t id);
 233 void *inferior_target_data (struct thread_info *);
 234 void set_inferior_target_data (struct thread_info *, void *);
 235 void *inferior_regcache_data (struct thread_info *);
 236 void set_inferior_regcache_data (struct thread_info *, void *);
 237
 238 void loaded_dll (const char *name, CORE_ADDR base_addr);
 239 void unloaded_dll (const char *name, CORE_ADDR base_addr);
 240
 241 /* Public variables in server.c */
 242
 243 extern ptid_t cont_thread;
 244 extern ptid_t general_thread;
 245
 246 extern int server_waiting;
 247 extern int debug_threads;
 248 extern int debug_hw_points;
 249 extern int pass_signals[];
 250 extern int program_signals[];
 251 extern int program_signals_p;
 252
 253 extern jmp_buf toplevel;
 254
 255 extern int disable_packet_vCont;
 256 extern int disable_packet_Tthread;
 257 extern int disable_packet_qC;
 258 extern int disable_packet_qfThreadInfo;
 259
 260 extern int run_once;
 261 extern int multi_process;
 262 extern int non_stop;
 263
 264 extern int disable_randomization;
 265
 266 #if USE_WIN32API
 267 #include <winsock2.h>
 268 typedef SOCKET gdb_fildes_t;
 269 #else
 270 typedef int gdb_fildes_t;
 271 #endif
 272
 273 /* Functions from event-loop.c.  */
 274 typedef void *gdb_client_data;
 275 typedef int (handler_func) (int, gdb_client_data);
 276 typedef int (callback_handler_func) (gdb_client_data);
 277
 278 extern void delete_file_handler (gdb_fildes_t fd);
 279 extern void add_file_handler (gdb_fildes_t fd, handler_func *proc,
 280                               gdb_client_data client_data);
 281 extern int append_callback_event (callback_handler_func *proc,
 282                                    gdb_client_data client_data);
 283 extern void delete_callback_event (int id);
 284
 285 extern void start_event_loop (void);
 286
 287 /* Functions from server.c.  */
 288 extern int handle_serial_event (int err, gdb_client_data client_data);
 289 extern int handle_target_event (int err, gdb_client_data client_data);
 290
 291 extern void push_event (ptid_t ptid, struct target_waitstatus *status);
 292
 293 /* Functions from hostio.c.  */
 294 extern int handle_vFile (char *, int, int *);
 295
 296 /* Functions from hostio-errno.c.  */
 297 extern void hostio_last_error_from_errno (char *own_buf);
 298
 299 /* From remote-utils.c */
 300
 301 extern int remote_debug;
 302 extern int noack_mode;
 303 extern int transport_is_reliable;
 304
 305 int gdb_connected (void);
 306
 307 #define STDIO_CONNECTION_NAME "stdio"
 308 int remote_connection_is_stdio (void);
 309
 310 ptid_t read_ptid (char *buf, char **obuf);
 311 char *write_ptid (char *buf, ptid_t ptid);
 312
 313 int putpkt (char *buf);
 314 int putpkt_binary (char *buf, int len);
 315 int putpkt_notif (char *buf);
 316 int getpkt (char *buf);
 317 void remote_prepare (char *name);
 318 void remote_open (char *name);
 319 void remote_close (void);
 320 void write_ok (char *buf);
 321 void write_enn (char *buf);
 322 void initialize_async_io (void);
 323 void enable_async_io (void);
 324 void disable_async_io (void);
 325 void check_remote_input_interrupt_request (void);
 326 void convert_ascii_to_int (const char *from, unsigned char *to, int n);
 327 void convert_int_to_ascii (const unsigned char *from, char *to, int n);
 328 void new_thread_notify (int id);
 329 void dead_thread_notify (int id);
 330 void prepare_resume_reply (char *buf, ptid_t ptid,
 331                            struct target_waitstatus *status);
 332
 333 const char *decode_address_to_semicolon (CORE_ADDR *addrp, const char *start);
 334 void decode_address (CORE_ADDR *addrp, const char *start, int len);
 335 void decode_m_packet (char *from, CORE_ADDR * mem_addr_ptr,
 336                       unsigned int *len_ptr);
 337 void decode_M_packet (char *from, CORE_ADDR * mem_addr_ptr,
 338                       unsigned int *len_ptr, unsigned char **to_p);
 339 int decode_X_packet (char *from, int packet_len, CORE_ADDR * mem_addr_ptr,
 340                      unsigned int *len_ptr, unsigned char **to_p);
 341 int decode_xfer_write (char *buf, int packet_len,
 342                        CORE_ADDR *offset, unsigned int *len,
 343                        unsigned char *data);
 344 int decode_search_memory_packet (const char *buf, int packet_len,
 345                                  CORE_ADDR *start_addrp,
 346                                  CORE_ADDR *search_space_lenp,
 347                                  gdb_byte *pattern,
 348                                  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 char *unpack_varlen_hex (char *buff,  ULONGEST *result);
 356
 357 void clear_symbol_cache (struct sym_cache **symcache_p);
 358 int look_up_one_symbol (const char *name, CORE_ADDR *addrp, int may_ask_gdb);
 359
 360 int relocate_instruction (CORE_ADDR *to, CORE_ADDR oldloc);
 361
 362 void monitor_output (const char *msg);
 363
 364 /* Functions from utils.c */
 365 #include "common-utils.h"
 366
 367 void *xmalloc (size_t) ATTR_MALLOC;
 368 void *xrealloc (void *, size_t);
 369 void *xcalloc (size_t, size_t) ATTR_MALLOC;
 370 char *xstrdup (const char *) ATTR_MALLOC;
 371 int xsnprintf (char *str, size_t size, const char *format, ...)
 372   ATTR_FORMAT (printf, 3, 4);;
 373 void freeargv (char **argv);
 374 void perror_with_name (const char *string);
 375 void error (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 376 void fatal (const char *string,...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 377 void warning (const char *string,...) ATTR_FORMAT (printf, 1, 2);
 378 char *paddress (CORE_ADDR addr);
 379 char *pulongest (ULONGEST u);
 380 char *plongest (LONGEST l);
 381 char *phex_nz (ULONGEST l, int sizeof_l);
 382 char *pfildes (gdb_fildes_t fd);
 383
 384 #include "gdb_assert.h"
 385
 386 /* Maximum number of bytes to read/write at once.  The value here
 387    is chosen to fill up a packet (the headers account for the 32).  */
 388 #define MAXBUFBYTES(N) (((N)-32)/2)
 389
 390 /* Buffer sizes for transferring memory, registers, etc.   Set to a constant
 391    value to accomodate multiple register formats.  This value must be at least
 392    as large as the largest register set supported by gdbserver.  */
 393 #define PBUFSIZ 16384
 394
 395 /* Functions from tracepoint.c */
 396
 397 /* Size for a small buffer to report problems from the in-process
 398    agent back to GDBserver.  */
 399 #define IPA_BUFSIZ 100
 400
 401 void initialize_tracepoint (void);
 402
 403 extern int tracing;
 404 extern int disconnected_tracing;
 405
 406 void tracepoint_look_up_symbols (void);
 407
 408 void stop_tracing (void);
 409
 410 int handle_tracepoint_general_set (char *own_buf);
 411 int handle_tracepoint_query (char *own_buf);
 412
 413 int tracepoint_finished_step (struct thread_info *tinfo, CORE_ADDR stop_pc);
 414 int tracepoint_was_hit (struct thread_info *tinfo, CORE_ADDR stop_pc);
 415
 416 void release_while_stepping_state_list (struct thread_info *tinfo);
 417
 418 extern int current_traceframe;
 419
 420 int in_readonly_region (CORE_ADDR addr, ULONGEST length);
 421 int traceframe_read_mem (int tfnum, CORE_ADDR addr,
 422                          unsigned char *buf, ULONGEST length,
 423                          ULONGEST *nbytes);
 424 int fetch_traceframe_registers (int tfnum,
 425                                 struct regcache *regcache,
 426                                 int regnum);
 427
 428 int traceframe_read_sdata (int tfnum, ULONGEST offset,
 429                            unsigned char *buf, ULONGEST length,
 430                            ULONGEST *nbytes);
 431
 432 int traceframe_read_info (int tfnum, struct buffer *buffer);
 433
 434 /* If a thread is determined to be collecting a fast tracepoint, this
 435    structure holds the collect status.  */
 436
 437 struct fast_tpoint_collect_status
 438 {
 439   /* The tracepoint that is presently being collected.  */
 440   int tpoint_num;
 441   CORE_ADDR tpoint_addr;
 442
 443   /* The address range in the jump pad of where the original
 444      instruction the tracepoint jump was inserted was relocated
 445      to.  */
 446   CORE_ADDR adjusted_insn_addr;
 447   CORE_ADDR adjusted_insn_addr_end;
 448 };
 449
 450 int fast_tracepoint_collecting (CORE_ADDR thread_area,
 451                                 CORE_ADDR stop_pc,
 452                                 struct fast_tpoint_collect_status *status);
 453 void force_unlock_trace_buffer (void);
 454
 455 int handle_tracepoint_bkpts (struct thread_info *tinfo, CORE_ADDR stop_pc);
 456
 457 #ifdef IN_PROCESS_AGENT
 458 void initialize_low_tracepoint (void);
 459 void supply_fast_tracepoint_registers (struct regcache *regcache,
 460                                        const unsigned char *regs);
 461 void supply_static_tracepoint_registers (struct regcache *regcache,
 462                                          const unsigned char *regs,
 463                                          CORE_ADDR pc);
 464 void set_trampoline_buffer_space (CORE_ADDR begin, CORE_ADDR end,
 465                                   char *errmsg);
 466 #else
 467 void stop_tracing (void);
 468
 469 int claim_trampoline_space (ULONGEST used, CORE_ADDR *trampoline);
 470 int have_fast_tracepoint_trampoline_buffer (char *msgbuf);
 471 void gdb_agent_about_to_close (int pid);
 472 #endif
 473
 474 struct traceframe;
 475
 476 /* Do memory copies for bytecodes.  */
 477 /* Do the recording of memory blocks for actions and bytecodes.  */
 478
 479 int agent_mem_read (struct traceframe *tframe,
 480                     unsigned char *to, CORE_ADDR from,
 481                     ULONGEST len);
 482
 483 LONGEST agent_get_trace_state_variable_value (int num);
 484 void agent_set_trace_state_variable_value (int num, LONGEST val);
 485
 486 /* Record the value of a trace state variable.  */
 487
 488 int agent_tsv_read (struct traceframe *tframe, int n);
 489 int agent_mem_read_string (struct traceframe *tframe,
 490                            unsigned char *to,
 491                            CORE_ADDR from,
 492                            ULONGEST len);
 493
 494 /* Bytecode compilation function vector.  */
 495
 496 struct emit_ops
 497 {
 498   void (*emit_prologue) (void);
 499   void (*emit_epilogue) (void);
 500   void (*emit_add) (void);
 501   void (*emit_sub) (void);
 502   void (*emit_mul) (void);
 503   void (*emit_lsh) (void);
 504   void (*emit_rsh_signed) (void);
 505   void (*emit_rsh_unsigned) (void);
 506   void (*emit_ext) (int arg);
 507   void (*emit_log_not) (void);
 508   void (*emit_bit_and) (void);
 509   void (*emit_bit_or) (void);
 510   void (*emit_bit_xor) (void);
 511   void (*emit_bit_not) (void);
 512   void (*emit_equal) (void);
 513   void (*emit_less_signed) (void);
 514   void (*emit_less_unsigned) (void);
 515   void (*emit_ref) (int size);
 516   void (*emit_if_goto) (int *offset_p, int *size_p);
 517   void (*emit_goto) (int *offset_p, int *size_p);
 518   void (*write_goto_address) (CORE_ADDR from, CORE_ADDR to, int size);
 519   void (*emit_const) (LONGEST num);
 520   void (*emit_call) (CORE_ADDR fn);
 521   void (*emit_reg) (int reg);
 522   void (*emit_pop) (void);
 523   void (*emit_stack_flush) (void);
 524   void (*emit_zero_ext) (int arg);
 525   void (*emit_swap) (void);
 526   void (*emit_stack_adjust) (int n);
 527
 528   /* Emit code for a generic function that takes one fixed integer
 529      argument and returns a 64-bit int (for instance, tsv getter).  */
 530   void (*emit_int_call_1) (CORE_ADDR fn, int arg1);
 531
 532   /* Emit code for a generic function that takes one fixed integer
 533      argument and a 64-bit int from the top of the stack, and returns
 534      nothing (for instance, tsv setter).  */
 535   void (*emit_void_call_2) (CORE_ADDR fn, int arg1);
 536
 537   /* Emit code specialized for common combinations of compare followed
 538      by a goto.  */
 539   void (*emit_eq_goto) (int *offset_p, int *size_p);
 540   void (*emit_ne_goto) (int *offset_p, int *size_p);
 541   void (*emit_lt_goto) (int *offset_p, int *size_p);
 542   void (*emit_le_goto) (int *offset_p, int *size_p);
 543   void (*emit_gt_goto) (int *offset_p, int *size_p);
 544   void (*emit_ge_goto) (int *offset_p, int *size_p);
 545 };
 546
 547 /* Returns the address of the get_raw_reg function in the IPA.  */
 548 CORE_ADDR get_raw_reg_func_addr (void);
 549 /* Returns the address of the get_trace_state_variable_value
 550    function in the IPA.  */
 551 CORE_ADDR get_get_tsv_func_addr (void);
 552 /* Returns the address of the set_trace_state_variable_value
 553    function in the IPA.  */
 554 CORE_ADDR get_set_tsv_func_addr (void);
 555
 556 CORE_ADDR current_insn_ptr;
 557 int emit_error;
 558
 559 /* Version information, from version.c.  */
 560 extern const char version[];
 561 extern const char host_name[];
 562
 563 #endif /* SERVER_H */