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