gdb/target.h

   1 /* Interface between GDB and target environments, including files and processes
   2
   3    Copyright (C) 1990-2014 Free Software Foundation, Inc.
   4
   5    Contributed by Cygnus Support.  Written by John Gilmore.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #if !defined (TARGET_H)
  23 #define TARGET_H
  24
  25 struct objfile;
  26 struct ui_file;
  27 struct mem_attrib;
  28 struct target_ops;
  29 struct bp_location;
  30 struct bp_target_info;
  31 struct regcache;
  32 struct target_section_table;
  33 struct trace_state_variable;
  34 struct trace_status;
  35 struct uploaded_tsv;
  36 struct uploaded_tp;
  37 struct static_tracepoint_marker;
  38 struct traceframe_info;
  39 struct expression;
  40 struct dcache_struct;
  41
  42 /* This include file defines the interface between the main part
  43    of the debugger, and the part which is target-specific, or
  44    specific to the communications interface between us and the
  45    target.
  46
  47    A TARGET is an interface between the debugger and a particular
  48    kind of file or process.  Targets can be STACKED in STRATA,
  49    so that more than one target can potentially respond to a request.
  50    In particular, memory accesses will walk down the stack of targets
  51    until they find a target that is interested in handling that particular
  52    address.  STRATA are artificial boundaries on the stack, within
  53    which particular kinds of targets live.  Strata exist so that
  54    people don't get confused by pushing e.g. a process target and then
  55    a file target, and wondering why they can't see the current values
  56    of variables any more (the file target is handling them and they
  57    never get to the process target).  So when you push a file target,
  58    it goes into the file stratum, which is always below the process
  59    stratum.  */
  60
  61 #include "target/resume.h"
  62 #include "target/wait.h"
  63 #include "target/waitstatus.h"
  64 #include "bfd.h"
  65 #include "symtab.h"
  66 #include "memattr.h"
  67 #include "vec.h"
  68 #include "gdb_signals.h"
  69 #include "btrace.h"
  70 #include "command.h"
  71
  72 enum strata
  73   {
  74     dummy_stratum,              /* The lowest of the low */
  75     file_stratum,               /* Executable files, etc */
  76     process_stratum,            /* Executing processes or core dump files */
  77     thread_stratum,             /* Executing threads */
  78     record_stratum,             /* Support record debugging */
  79     arch_stratum                /* Architecture overrides */
  80   };
  81
  82 enum thread_control_capabilities
  83   {
  84     tc_none = 0,                /* Default: can't control thread execution.  */
  85     tc_schedlock = 1,           /* Can lock the thread scheduler.  */
  86   };
  87
  88 /* The structure below stores information about a system call.
  89    It is basically used in the "catch syscall" command, and in
  90    every function that gives information about a system call.
  91
  92    It's also good to mention that its fields represent everything
  93    that we currently know about a syscall in GDB.  */
  94 struct syscall
  95   {
  96     /* The syscall number.  */
  97     int number;
  98
  99     /* The syscall name.  */
 100     const char *name;
 101   };
 102
 103 /* Return a pretty printed form of target_waitstatus.
 104    Space for the result is malloc'd, caller must free.  */
 105 extern char *target_waitstatus_to_string (const struct target_waitstatus *);
 106
 107 /* Return a pretty printed form of TARGET_OPTIONS.
 108    Space for the result is malloc'd, caller must free.  */
 109 extern char *target_options_to_string (int target_options);
 110
 111 /* Possible types of events that the inferior handler will have to
 112    deal with.  */
 113 enum inferior_event_type
 114   {
 115     /* Process a normal inferior event which will result in target_wait
 116        being called.  */
 117     INF_REG_EVENT,
 118     /* We are called because a timer went off.  */
 119     INF_TIMER,
 120     /* We are called to do stuff after the inferior stops.  */
 121     INF_EXEC_COMPLETE,
 122     /* We are called to do some stuff after the inferior stops, but we
 123        are expected to reenter the proceed() and
 124        handle_inferior_event() functions.  This is used only in case of
 125        'step n' like commands.  */
 126     INF_EXEC_CONTINUE
 127   };
 128 \f
 129 /* Target objects which can be transfered using target_read,
 130    target_write, et cetera.  */
 131
 132 enum target_object
 133 {
 134   /* AVR target specific transfer.  See "avr-tdep.c" and "remote.c".  */
 135   TARGET_OBJECT_AVR,
 136   /* SPU target specific transfer.  See "spu-tdep.c".  */
 137   TARGET_OBJECT_SPU,
 138   /* Transfer up-to LEN bytes of memory starting at OFFSET.  */
 139   TARGET_OBJECT_MEMORY,
 140   /* Memory, avoiding GDB's data cache and trusting the executable.
 141      Target implementations of to_xfer_partial never need to handle
 142      this object, and most callers should not use it.  */
 143   TARGET_OBJECT_RAW_MEMORY,
 144   /* Memory known to be part of the target's stack.  This is cached even
 145      if it is not in a region marked as such, since it is known to be
 146      "normal" RAM.  */
 147   TARGET_OBJECT_STACK_MEMORY,
 148   /* Memory known to be part of the target code.   This is cached even
 149      if it is not in a region marked as such.  */
 150   TARGET_OBJECT_CODE_MEMORY,
 151   /* Kernel Unwind Table.  See "ia64-tdep.c".  */
 152   TARGET_OBJECT_UNWIND_TABLE,
 153   /* Transfer auxilliary vector.  */
 154   TARGET_OBJECT_AUXV,
 155   /* StackGhost cookie.  See "sparc-tdep.c".  */
 156   TARGET_OBJECT_WCOOKIE,
 157   /* Target memory map in XML format.  */
 158   TARGET_OBJECT_MEMORY_MAP,
 159   /* Flash memory.  This object can be used to write contents to
 160      a previously erased flash memory.  Using it without erasing
 161      flash can have unexpected results.  Addresses are physical
 162      address on target, and not relative to flash start.  */
 163   TARGET_OBJECT_FLASH,
 164   /* Available target-specific features, e.g. registers and coprocessors.
 165      See "target-descriptions.c".  ANNEX should never be empty.  */
 166   TARGET_OBJECT_AVAILABLE_FEATURES,
 167   /* Currently loaded libraries, in XML format.  */
 168   TARGET_OBJECT_LIBRARIES,
 169   /* Currently loaded libraries specific for SVR4 systems, in XML format.  */
 170   TARGET_OBJECT_LIBRARIES_SVR4,
 171   /* Currently loaded libraries specific to AIX systems, in XML format.  */
 172   TARGET_OBJECT_LIBRARIES_AIX,
 173   /* Get OS specific data.  The ANNEX specifies the type (running
 174      processes, etc.).  The data being transfered is expected to follow
 175      the DTD specified in features/osdata.dtd.  */
 176   TARGET_OBJECT_OSDATA,
 177   /* Extra signal info.  Usually the contents of `siginfo_t' on unix
 178      platforms.  */
 179   TARGET_OBJECT_SIGNAL_INFO,
 180   /* The list of threads that are being debugged.  */
 181   TARGET_OBJECT_THREADS,
 182   /* Collected static trace data.  */
 183   TARGET_OBJECT_STATIC_TRACE_DATA,
 184   /* The HP-UX registers (those that can be obtained or modified by using
 185      the TT_LWP_RUREGS/TT_LWP_WUREGS ttrace requests).  */
 186   TARGET_OBJECT_HPUX_UREGS,
 187   /* The HP-UX shared library linkage pointer.  ANNEX should be a string
 188      image of the code address whose linkage pointer we are looking for.
 189
 190      The size of the data transfered is always 8 bytes (the size of an
 191      address on ia64).  */
 192   TARGET_OBJECT_HPUX_SOLIB_GOT,
 193   /* Traceframe info, in XML format.  */
 194   TARGET_OBJECT_TRACEFRAME_INFO,
 195   /* Load maps for FDPIC systems.  */
 196   TARGET_OBJECT_FDPIC,
 197   /* Darwin dynamic linker info data.  */
 198   TARGET_OBJECT_DARWIN_DYLD_INFO,
 199   /* OpenVMS Unwind Information Block.  */
 200   TARGET_OBJECT_OPENVMS_UIB,
 201   /* Branch trace data, in XML format.  */
 202   TARGET_OBJECT_BTRACE
 203   /* Possible future objects: TARGET_OBJECT_FILE, ...  */
 204 };
 205
 206 /* Possible values returned by target_xfer_partial, etc.  */
 207
 208 enum target_xfer_status
 209 {
 210   /* Some bytes are transferred.  */
 211   TARGET_XFER_OK = 1,
 212
 213   /* No further transfer is possible.  */
 214   TARGET_XFER_EOF = 0,
 215
 216   /* Generic I/O error.  Note that it's important that this is '-1',
 217      as we still have target_xfer-related code returning hardcoded
 218      '-1' on error.  */
 219   TARGET_XFER_E_IO = -1,
 220
 221   /* Transfer failed because the piece of the object requested is
 222      unavailable.  */
 223   TARGET_XFER_E_UNAVAILABLE = -2,
 224
 225   /* Keep list in sync with target_xfer_error_to_string.  */
 226 };
 227
 228 #define TARGET_XFER_STATUS_ERROR_P(STATUS) ((STATUS) < TARGET_XFER_EOF)
 229
 230 /* Return the string form of ERR.  */
 231
 232 extern const char *target_xfer_status_to_string (enum target_xfer_status err);
 233
 234 /* Enumeration of the kinds of traceframe searches that a target may
 235    be able to perform.  */
 236
 237 enum trace_find_type
 238   {
 239     tfind_number,
 240     tfind_pc,
 241     tfind_tp,
 242     tfind_range,
 243     tfind_outside,
 244   };
 245
 246 typedef struct static_tracepoint_marker *static_tracepoint_marker_p;
 247 DEF_VEC_P(static_tracepoint_marker_p);
 248
 249 typedef enum target_xfer_status
 250   target_xfer_partial_ftype (struct target_ops *ops,
 251                              enum target_object object,
 252                              const char *annex,
 253                              gdb_byte *readbuf,
 254                              const gdb_byte *writebuf,
 255                              ULONGEST offset,
 256                              ULONGEST len,
 257                              ULONGEST *xfered_len);
 258
 259 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
 260    OBJECT.  The OFFSET, for a seekable object, specifies the
 261    starting point.  The ANNEX can be used to provide additional
 262    data-specific information to the target.
 263
 264    Return the number of bytes actually transfered, or a negative error
 265    code (an 'enum target_xfer_error' value) if the transfer is not
 266    supported or otherwise fails.  Return of a positive value less than
 267    LEN indicates that no further transfer is possible.  Unlike the raw
 268    to_xfer_partial interface, callers of these functions do not need
 269    to retry partial transfers.  */
 270
 271 extern LONGEST target_read (struct target_ops *ops,
 272                             enum target_object object,
 273                             const char *annex, gdb_byte *buf,
 274                             ULONGEST offset, LONGEST len);
 275
 276 struct memory_read_result
 277   {
 278     /* First address that was read.  */
 279     ULONGEST begin;
 280     /* Past-the-end address.  */
 281     ULONGEST end;
 282     /* The data.  */
 283     gdb_byte *data;
 284 };
 285 typedef struct memory_read_result memory_read_result_s;
 286 DEF_VEC_O(memory_read_result_s);
 287
 288 extern void free_memory_read_result_vector (void *);
 289
 290 extern VEC(memory_read_result_s)* read_memory_robust (struct target_ops *ops,
 291                                                       ULONGEST offset,
 292                                                       LONGEST len);
 293
 294 extern LONGEST target_write (struct target_ops *ops,
 295                              enum target_object object,
 296                              const char *annex, const gdb_byte *buf,
 297                              ULONGEST offset, LONGEST len);
 298
 299 /* Similar to target_write, except that it also calls PROGRESS with
 300    the number of bytes written and the opaque BATON after every
 301    successful partial write (and before the first write).  This is
 302    useful for progress reporting and user interaction while writing
 303    data.  To abort the transfer, the progress callback can throw an
 304    exception.  */
 305
 306 LONGEST target_write_with_progress (struct target_ops *ops,
 307                                     enum target_object object,
 308                                     const char *annex, const gdb_byte *buf,
 309                                     ULONGEST offset, LONGEST len,
 310                                     void (*progress) (ULONGEST, void *),
 311                                     void *baton);
 312
 313 /* Wrapper to perform a full read of unknown size.  OBJECT/ANNEX will
 314    be read using OPS.  The return value will be -1 if the transfer
 315    fails or is not supported; 0 if the object is empty; or the length
 316    of the object otherwise.  If a positive value is returned, a
 317    sufficiently large buffer will be allocated using xmalloc and
 318    returned in *BUF_P containing the contents of the object.
 319
 320    This method should be used for objects sufficiently small to store
 321    in a single xmalloc'd buffer, when no fixed bound on the object's
 322    size is known in advance.  Don't try to read TARGET_OBJECT_MEMORY
 323    through this function.  */
 324
 325 extern LONGEST target_read_alloc (struct target_ops *ops,
 326                                   enum target_object object,
 327                                   const char *annex, gdb_byte **buf_p);
 328
 329 /* Read OBJECT/ANNEX using OPS.  The result is NUL-terminated and
 330    returned as a string, allocated using xmalloc.  If an error occurs
 331    or the transfer is unsupported, NULL is returned.  Empty objects
 332    are returned as allocated but empty strings.  A warning is issued
 333    if the result contains any embedded NUL bytes.  */
 334
 335 extern char *target_read_stralloc (struct target_ops *ops,
 336                                    enum target_object object,
 337                                    const char *annex);
 338
 339 /* See target_ops->to_xfer_partial.  */
 340 extern target_xfer_partial_ftype target_xfer_partial;
 341
 342 /* Wrappers to target read/write that perform memory transfers.  They
 343    throw an error if the memory transfer fails.
 344
 345    NOTE: cagney/2003-10-23: The naming schema is lifted from
 346    "frame.h".  The parameter order is lifted from get_frame_memory,
 347    which in turn lifted it from read_memory.  */
 348
 349 extern void get_target_memory (struct target_ops *ops, CORE_ADDR addr,
 350                                gdb_byte *buf, LONGEST len);
 351 extern ULONGEST get_target_memory_unsigned (struct target_ops *ops,
 352                                             CORE_ADDR addr, int len,
 353                                             enum bfd_endian byte_order);
 354 \f
 355 struct thread_info;             /* fwd decl for parameter list below: */
 356
 357 /* The type of the callback to the to_async method.  */
 358
 359 typedef void async_callback_ftype (enum inferior_event_type event_type,
 360                                    void *context);
 361
 362 /* These defines are used to mark target_ops methods.  The script
 363    make-target-delegates scans these and auto-generates the base
 364    method implementations.  There are four macros that can be used:
 365
 366    1. TARGET_DEFAULT_IGNORE.  There is no argument.  The base method
 367    does nothing.  This is only valid if the method return type is
 368    'void'.
 369
 370    2. TARGET_DEFAULT_NORETURN.  The argument is a function call, like
 371    'tcomplain ()'.  The base method simply makes this call, which is
 372    assumed not to return.
 373
 374    3. TARGET_DEFAULT_RETURN.  The argument is a C expression.  The
 375    base method returns this expression's value.
 376
 377    4. TARGET_DEFAULT_FUNC.  The argument is the name of a function.
 378    make-target-delegates does not generate a base method in this case,
 379    but instead uses the argument function as the base method.  */
 380
 381 #define TARGET_DEFAULT_IGNORE()
 382 #define TARGET_DEFAULT_NORETURN(ARG)
 383 #define TARGET_DEFAULT_RETURN(ARG)
 384 #define TARGET_DEFAULT_FUNC(ARG)
 385
 386 struct target_ops
 387   {
 388     struct target_ops *beneath; /* To the target under this one.  */
 389     char *to_shortname;         /* Name this target type */
 390     char *to_longname;          /* Name for printing */
 391     char *to_doc;               /* Documentation.  Does not include trailing
 392                                    newline, and starts with a one-line descrip-
 393                                    tion (probably similar to to_longname).  */
 394     /* Per-target scratch pad.  */
 395     void *to_data;
 396     /* The open routine takes the rest of the parameters from the
 397        command, and (if successful) pushes a new target onto the
 398        stack.  Targets should supply this routine, if only to provide
 399        an error message.  */
 400     void (*to_open) (char *, int);
 401     /* Old targets with a static target vector provide "to_close".
 402        New re-entrant targets provide "to_xclose" and that is expected
 403        to xfree everything (including the "struct target_ops").  */
 404     void (*to_xclose) (struct target_ops *targ);
 405     void (*to_close) (struct target_ops *);
 406     void (*to_attach) (struct target_ops *ops, char *, int);
 407     void (*to_post_attach) (struct target_ops *, int);
 408     void (*to_detach) (struct target_ops *ops, const char *, int);
 409     void (*to_disconnect) (struct target_ops *, char *, int);
 410     void (*to_resume) (struct target_ops *, ptid_t, int, enum gdb_signal)
 411       TARGET_DEFAULT_NORETURN (noprocess ());
 412     ptid_t (*to_wait) (struct target_ops *,
 413                        ptid_t, struct target_waitstatus *, int)
 414       TARGET_DEFAULT_NORETURN (noprocess ());
 415     void (*to_fetch_registers) (struct target_ops *, struct regcache *, int);
 416     void (*to_store_registers) (struct target_ops *, struct regcache *, int)
 417       TARGET_DEFAULT_NORETURN (noprocess ());
 418     void (*to_prepare_to_store) (struct target_ops *, struct regcache *);
 419
 420     /* Transfer LEN bytes of memory between GDB address MYADDR and
 421        target address MEMADDR.  If WRITE, transfer them to the target, else
 422        transfer them from the target.  TARGET is the target from which we
 423        get this function.
 424
 425        Return value, N, is one of the following:
 426
 427        0 means that we can't handle this.  If errno has been set, it is the
 428        error which prevented us from doing it (FIXME: What about bfd_error?).
 429
 430        positive (call it N) means that we have transferred N bytes
 431        starting at MEMADDR.  We might be able to handle more bytes
 432        beyond this length, but no promises.
 433
 434        negative (call its absolute value N) means that we cannot
 435        transfer right at MEMADDR, but we could transfer at least
 436        something at MEMADDR + N.
 437
 438        NOTE: cagney/2004-10-01: This has been entirely superseeded by
 439        to_xfer_partial and inferior inheritance.  */
 440
 441     int (*deprecated_xfer_memory) (CORE_ADDR memaddr, gdb_byte *myaddr,
 442                                    int len, int write,
 443                                    struct mem_attrib *attrib,
 444                                    struct target_ops *target);
 445
 446     void (*to_files_info) (struct target_ops *);
 447     int (*to_insert_breakpoint) (struct target_ops *, struct gdbarch *,
 448                                  struct bp_target_info *)
 449       TARGET_DEFAULT_FUNC (memory_insert_breakpoint);
 450     int (*to_remove_breakpoint) (struct target_ops *, struct gdbarch *,
 451                                  struct bp_target_info *)
 452       TARGET_DEFAULT_FUNC (memory_remove_breakpoint);
 453     int (*to_can_use_hw_breakpoint) (struct target_ops *, int, int, int);
 454     int (*to_ranged_break_num_registers) (struct target_ops *);
 455     int (*to_insert_hw_breakpoint) (struct target_ops *,
 456                                     struct gdbarch *, struct bp_target_info *);
 457     int (*to_remove_hw_breakpoint) (struct target_ops *,
 458                                     struct gdbarch *, struct bp_target_info *);
 459
 460     /* Documentation of what the two routines below are expected to do is
 461        provided with the corresponding target_* macros.  */
 462     int (*to_remove_watchpoint) (struct target_ops *,
 463                                  CORE_ADDR, int, int, struct expression *);
 464     int (*to_insert_watchpoint) (struct target_ops *,
 465                                  CORE_ADDR, int, int, struct expression *);
 466
 467     int (*to_insert_mask_watchpoint) (struct target_ops *,
 468                                       CORE_ADDR, CORE_ADDR, int);
 469     int (*to_remove_mask_watchpoint) (struct target_ops *,
 470                                       CORE_ADDR, CORE_ADDR, int);
 471     int (*to_stopped_by_watchpoint) (struct target_ops *)
 472       TARGET_DEFAULT_RETURN (0);
 473     int to_have_steppable_watchpoint;
 474     int to_have_continuable_watchpoint;
 475     int (*to_stopped_data_address) (struct target_ops *, CORE_ADDR *)
 476       TARGET_DEFAULT_RETURN (0);
 477     int (*to_watchpoint_addr_within_range) (struct target_ops *,
 478                                             CORE_ADDR, CORE_ADDR, int);
 479
 480     /* Documentation of this routine is provided with the corresponding
 481        target_* macro.  */
 482     int (*to_region_ok_for_hw_watchpoint) (struct target_ops *,
 483                                            CORE_ADDR, int);
 484
 485     int (*to_can_accel_watchpoint_condition) (CORE_ADDR, int, int,
 486                                               struct expression *);
 487     int (*to_masked_watch_num_registers) (struct target_ops *,
 488                                           CORE_ADDR, CORE_ADDR);
 489     void (*to_terminal_init) (void);
 490     void (*to_terminal_inferior) (void);
 491     void (*to_terminal_ours_for_output) (void);
 492     void (*to_terminal_ours) (void);
 493     void (*to_terminal_save_ours) (void);
 494     void (*to_terminal_info) (const char *, int);
 495     void (*to_kill) (struct target_ops *);
 496     void (*to_load) (char *, int);
 497     void (*to_create_inferior) (struct target_ops *,
 498                                 char *, char *, char **, int);
 499     void (*to_post_startup_inferior) (ptid_t);
 500     int (*to_insert_fork_catchpoint) (int);
 501     int (*to_remove_fork_catchpoint) (int);
 502     int (*to_insert_vfork_catchpoint) (int);
 503     int (*to_remove_vfork_catchpoint) (int);
 504     int (*to_follow_fork) (struct target_ops *, int, int);
 505     int (*to_insert_exec_catchpoint) (int);
 506     int (*to_remove_exec_catchpoint) (int);
 507     int (*to_set_syscall_catchpoint) (int, int, int, int, int *);
 508     int (*to_has_exited) (int, int, int *);
 509     void (*to_mourn_inferior) (struct target_ops *);
 510     int (*to_can_run) (void);
 511
 512     /* Documentation of this routine is provided with the corresponding
 513        target_* macro.  */
 514     void (*to_pass_signals) (int, unsigned char *);
 515
 516     /* Documentation of this routine is provided with the
 517        corresponding target_* function.  */
 518     void (*to_program_signals) (int, unsigned char *);
 519
 520     int (*to_thread_alive) (struct target_ops *, ptid_t ptid);
 521     void (*to_find_new_threads) (struct target_ops *);
 522     char *(*to_pid_to_str) (struct target_ops *, ptid_t);
 523     char *(*to_extra_thread_info) (struct thread_info *);
 524     char *(*to_thread_name) (struct thread_info *);
 525     void (*to_stop) (ptid_t);
 526     void (*to_rcmd) (char *command, struct ui_file *output);
 527     char *(*to_pid_to_exec_file) (int pid);
 528     void (*to_log_command) (const char *);
 529     struct target_section_table *(*to_get_section_table) (struct target_ops *);
 530     enum strata to_stratum;
 531     int (*to_has_all_memory) (struct target_ops *);
 532     int (*to_has_memory) (struct target_ops *);
 533     int (*to_has_stack) (struct target_ops *);
 534     int (*to_has_registers) (struct target_ops *);
 535     int (*to_has_execution) (struct target_ops *, ptid_t);
 536     int to_has_thread_control;  /* control thread execution */
 537     int to_attach_no_wait;
 538     /* ASYNC target controls */
 539     int (*to_can_async_p) (struct target_ops *)
 540       TARGET_DEFAULT_FUNC (find_default_can_async_p);
 541     int (*to_is_async_p) (struct target_ops *)
 542       TARGET_DEFAULT_FUNC (find_default_is_async_p);
 543     void (*to_async) (struct target_ops *, async_callback_ftype *, void *)
 544       TARGET_DEFAULT_NORETURN (tcomplain ());
 545     int (*to_supports_non_stop) (void);
 546     /* find_memory_regions support method for gcore */
 547     int (*to_find_memory_regions) (find_memory_region_ftype func, void *data);
 548     /* make_corefile_notes support method for gcore */
 549     char * (*to_make_corefile_notes) (bfd *, int *);
 550     /* get_bookmark support method for bookmarks */
 551     gdb_byte * (*to_get_bookmark) (char *, int);
 552     /* goto_bookmark support method for bookmarks */
 553     void (*to_goto_bookmark) (gdb_byte *, int);
 554     /* Return the thread-local address at OFFSET in the
 555        thread-local storage for the thread PTID and the shared library
 556        or executable file given by OBJFILE.  If that block of
 557        thread-local storage hasn't been allocated yet, this function
 558        may return an error.  */
 559     CORE_ADDR (*to_get_thread_local_address) (struct target_ops *ops,
 560                                               ptid_t ptid,
 561                                               CORE_ADDR load_module_addr,
 562                                               CORE_ADDR offset);
 563
 564     /* Request that OPS transfer up to LEN 8-bit bytes of the target's
 565        OBJECT.  The OFFSET, for a seekable object, specifies the
 566        starting point.  The ANNEX can be used to provide additional
 567        data-specific information to the target.
 568
 569        Return the transferred status, error or OK (an
 570        'enum target_xfer_status' value).  Save the number of bytes
 571        actually transferred in *XFERED_LEN if transfer is successful
 572        (TARGET_XFER_OK) or the number unavailable bytes if the requested
 573        data is unavailable (TARGET_XFER_E_UNAVAILABLE).  *XFERED_LEN
 574        smaller than LEN does not indicate the end of the object, only
 575        the end of the transfer; higher level code should continue
 576        transferring if desired.  This is handled in target.c.
 577
 578        The interface does not support a "retry" mechanism.  Instead it
 579        assumes that at least one byte will be transfered on each
 580        successful call.
 581
 582        NOTE: cagney/2003-10-17: The current interface can lead to
 583        fragmented transfers.  Lower target levels should not implement
 584        hacks, such as enlarging the transfer, in an attempt to
 585        compensate for this.  Instead, the target stack should be
 586        extended so that it implements supply/collect methods and a
 587        look-aside object cache.  With that available, the lowest
 588        target can safely and freely "push" data up the stack.
 589
 590        See target_read and target_write for more information.  One,
 591        and only one, of readbuf or writebuf must be non-NULL.  */
 592
 593     enum target_xfer_status (*to_xfer_partial) (struct target_ops *ops,
 594                                                 enum target_object object,
 595                                                 const char *annex,
 596                                                 gdb_byte *readbuf,
 597                                                 const gdb_byte *writebuf,
 598                                                 ULONGEST offset, ULONGEST len,
 599                                                 ULONGEST *xfered_len)
 600       TARGET_DEFAULT_RETURN (TARGET_XFER_E_IO);
 601
 602     /* Returns the memory map for the target.  A return value of NULL
 603        means that no memory map is available.  If a memory address
 604        does not fall within any returned regions, it's assumed to be
 605        RAM.  The returned memory regions should not overlap.
 606
 607        The order of regions does not matter; target_memory_map will
 608        sort regions by starting address.  For that reason, this
 609        function should not be called directly except via
 610        target_memory_map.
 611
 612        This method should not cache data; if the memory map could
 613        change unexpectedly, it should be invalidated, and higher
 614        layers will re-fetch it.  */
 615     VEC(mem_region_s) *(*to_memory_map) (struct target_ops *);
 616
 617     /* Erases the region of flash memory starting at ADDRESS, of
 618        length LENGTH.
 619
 620        Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
 621        on flash block boundaries, as reported by 'to_memory_map'.  */
 622     void (*to_flash_erase) (struct target_ops *,
 623                            ULONGEST address, LONGEST length);
 624
 625     /* Finishes a flash memory write sequence.  After this operation
 626        all flash memory should be available for writing and the result
 627        of reading from areas written by 'to_flash_write' should be
 628        equal to what was written.  */
 629     void (*to_flash_done) (struct target_ops *);
 630
 631     /* Describe the architecture-specific features of this target.
 632        Returns the description found, or NULL if no description
 633        was available.  */
 634     const struct target_desc *(*to_read_description) (struct target_ops *ops);
 635
 636     /* Build the PTID of the thread on which a given task is running,
 637        based on LWP and THREAD.  These values are extracted from the
 638        task Private_Data section of the Ada Task Control Block, and
 639        their interpretation depends on the target.  */
 640     ptid_t (*to_get_ada_task_ptid) (long lwp, long thread);
 641
 642     /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
 643        Return 0 if *READPTR is already at the end of the buffer.
 644        Return -1 if there is insufficient buffer for a whole entry.
 645        Return 1 if an entry was read into *TYPEP and *VALP.  */
 646     int (*to_auxv_parse) (struct target_ops *ops, gdb_byte **readptr,
 647                          gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
 648
 649     /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
 650        sequence of bytes in PATTERN with length PATTERN_LEN.
 651
 652        The result is 1 if found, 0 if not found, and -1 if there was an error
 653        requiring halting of the search (e.g. memory read error).
 654        If the pattern is found the address is recorded in FOUND_ADDRP.  */
 655     int (*to_search_memory) (struct target_ops *ops,
 656                              CORE_ADDR start_addr, ULONGEST search_space_len,
 657                              const gdb_byte *pattern, ULONGEST pattern_len,
 658                              CORE_ADDR *found_addrp);
 659
 660     /* Can target execute in reverse?  */
 661     int (*to_can_execute_reverse) (void);
 662
 663     /* The direction the target is currently executing.  Must be
 664        implemented on targets that support reverse execution and async
 665        mode.  The default simply returns forward execution.  */
 666     enum exec_direction_kind (*to_execution_direction) (void);
 667
 668     /* Does this target support debugging multiple processes
 669        simultaneously?  */
 670     int (*to_supports_multi_process) (void);
 671
 672     /* Does this target support enabling and disabling tracepoints while a trace
 673        experiment is running?  */
 674     int (*to_supports_enable_disable_tracepoint) (void);
 675
 676     /* Does this target support disabling address space randomization?  */
 677     int (*to_supports_disable_randomization) (void);
 678
 679     /* Does this target support the tracenz bytecode for string collection?  */
 680     int (*to_supports_string_tracing) (void);
 681
 682     /* Does this target support evaluation of breakpoint conditions on its
 683        end?  */
 684     int (*to_supports_evaluation_of_breakpoint_conditions) (void);
 685
 686     /* Does this target support evaluation of breakpoint commands on its
 687        end?  */
 688     int (*to_can_run_breakpoint_commands) (void);
 689
 690     /* Determine current architecture of thread PTID.
 691
 692        The target is supposed to determine the architecture of the code where
 693        the target is currently stopped at (on Cell, if a target is in spu_run,
 694        to_thread_architecture would return SPU, otherwise PPC32 or PPC64).
 695        This is architecture used to perform decr_pc_after_break adjustment,
 696        and also determines the frame architecture of the innermost frame.
 697        ptrace operations need to operate according to target_gdbarch ().
 698
 699        The default implementation always returns target_gdbarch ().  */
 700     struct gdbarch *(*to_thread_architecture) (struct target_ops *, ptid_t);
 701
 702     /* Determine current address space of thread PTID.
 703
 704        The default implementation always returns the inferior's
 705        address space.  */
 706     struct address_space *(*to_thread_address_space) (struct target_ops *,
 707                                                       ptid_t);
 708
 709     /* Target file operations.  */
 710
 711     /* Open FILENAME on the target, using FLAGS and MODE.  Return a
 712        target file descriptor, or -1 if an error occurs (and set
 713        *TARGET_ERRNO).  */
 714     int (*to_fileio_open) (const char *filename, int flags, int mode,
 715                            int *target_errno);
 716
 717     /* Write up to LEN bytes from WRITE_BUF to FD on the target.
 718        Return the number of bytes written, or -1 if an error occurs
 719        (and set *TARGET_ERRNO).  */
 720     int (*to_fileio_pwrite) (int fd, const gdb_byte *write_buf, int len,
 721                              ULONGEST offset, int *target_errno);
 722
 723     /* Read up to LEN bytes FD on the target into READ_BUF.
 724        Return the number of bytes read, or -1 if an error occurs
 725        (and set *TARGET_ERRNO).  */
 726     int (*to_fileio_pread) (int fd, gdb_byte *read_buf, int len,
 727                             ULONGEST offset, int *target_errno);
 728
 729     /* Close FD on the target.  Return 0, or -1 if an error occurs
 730        (and set *TARGET_ERRNO).  */
 731     int (*to_fileio_close) (int fd, int *target_errno);
 732
 733     /* Unlink FILENAME on the target.  Return 0, or -1 if an error
 734        occurs (and set *TARGET_ERRNO).  */
 735     int (*to_fileio_unlink) (const char *filename, int *target_errno);
 736
 737     /* Read value of symbolic link FILENAME on the target.  Return a
 738        null-terminated string allocated via xmalloc, or NULL if an error
 739        occurs (and set *TARGET_ERRNO).  */
 740     char *(*to_fileio_readlink) (const char *filename, int *target_errno);
 741
 742
 743     /* Implement the "info proc" command.  */
 744     void (*to_info_proc) (struct target_ops *, char *, enum info_proc_what);
 745
 746     /* Tracepoint-related operations.  */
 747
 748     /* Prepare the target for a tracing run.  */
 749     void (*to_trace_init) (void);
 750
 751     /* Send full details of a tracepoint location to the target.  */
 752     void (*to_download_tracepoint) (struct bp_location *location);
 753
 754     /* Is the target able to download tracepoint locations in current
 755        state?  */
 756     int (*to_can_download_tracepoint) (void);
 757
 758     /* Send full details of a trace state variable to the target.  */
 759     void (*to_download_trace_state_variable) (struct trace_state_variable *tsv);
 760
 761     /* Enable a tracepoint on the target.  */
 762     void (*to_enable_tracepoint) (struct bp_location *location);
 763
 764     /* Disable a tracepoint on the target.  */
 765     void (*to_disable_tracepoint) (struct bp_location *location);
 766
 767     /* Inform the target info of memory regions that are readonly
 768        (such as text sections), and so it should return data from
 769        those rather than look in the trace buffer.  */
 770     void (*to_trace_set_readonly_regions) (void);
 771
 772     /* Start a trace run.  */
 773     void (*to_trace_start) (void);
 774
 775     /* Get the current status of a tracing run.  */
 776     int (*to_get_trace_status) (struct trace_status *ts);
 777
 778     void (*to_get_tracepoint_status) (struct breakpoint *tp,
 779                                       struct uploaded_tp *utp);
 780
 781     /* Stop a trace run.  */
 782     void (*to_trace_stop) (void);
 783
 784    /* Ask the target to find a trace frame of the given type TYPE,
 785       using NUM, ADDR1, and ADDR2 as search parameters.  Returns the
 786       number of the trace frame, and also the tracepoint number at
 787       TPP.  If no trace frame matches, return -1.  May throw if the
 788       operation fails.  */
 789     int (*to_trace_find) (enum trace_find_type type, int num,
 790                           CORE_ADDR addr1, CORE_ADDR addr2, int *tpp);
 791
 792     /* Get the value of the trace state variable number TSV, returning
 793        1 if the value is known and writing the value itself into the
 794        location pointed to by VAL, else returning 0.  */
 795     int (*to_get_trace_state_variable_value) (int tsv, LONGEST *val);
 796
 797     int (*to_save_trace_data) (const char *filename);
 798
 799     int (*to_upload_tracepoints) (struct uploaded_tp **utpp);
 800
 801     int (*to_upload_trace_state_variables) (struct uploaded_tsv **utsvp);
 802
 803     LONGEST (*to_get_raw_trace_data) (gdb_byte *buf,
 804                                       ULONGEST offset, LONGEST len);
 805
 806     /* Get the minimum length of instruction on which a fast tracepoint
 807        may be set on the target.  If this operation is unsupported,
 808        return -1.  If for some reason the minimum length cannot be
 809        determined, return 0.  */
 810     int (*to_get_min_fast_tracepoint_insn_len) (void);
 811
 812     /* Set the target's tracing behavior in response to unexpected
 813        disconnection - set VAL to 1 to keep tracing, 0 to stop.  */
 814     void (*to_set_disconnected_tracing) (int val);
 815     void (*to_set_circular_trace_buffer) (int val);
 816     /* Set the size of trace buffer in the target.  */
 817     void (*to_set_trace_buffer_size) (LONGEST val);
 818
 819     /* Add/change textual notes about the trace run, returning 1 if
 820        successful, 0 otherwise.  */
 821     int (*to_set_trace_notes) (const char *user, const char *notes,
 822                                const char *stopnotes);
 823
 824     /* Return the processor core that thread PTID was last seen on.
 825        This information is updated only when:
 826        - update_thread_list is called
 827        - thread stops
 828        If the core cannot be determined -- either for the specified
 829        thread, or right now, or in this debug session, or for this
 830        target -- return -1.  */
 831     int (*to_core_of_thread) (struct target_ops *, ptid_t ptid);
 832
 833     /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range
 834        matches the contents of [DATA,DATA+SIZE).  Returns 1 if there's
 835        a match, 0 if there's a mismatch, and -1 if an error is
 836        encountered while reading memory.  */
 837     int (*to_verify_memory) (struct target_ops *, const gdb_byte *data,
 838                              CORE_ADDR memaddr, ULONGEST size);
 839
 840     /* Return the address of the start of the Thread Information Block
 841        a Windows OS specific feature.  */
 842     int (*to_get_tib_address) (ptid_t ptid, CORE_ADDR *addr);
 843
 844     /* Send the new settings of write permission variables.  */
 845     void (*to_set_permissions) (void);
 846
 847     /* Look for a static tracepoint marker at ADDR, and fill in MARKER
 848        with its details.  Return 1 on success, 0 on failure.  */
 849     int (*to_static_tracepoint_marker_at) (CORE_ADDR,
 850                                            struct static_tracepoint_marker *marker);
 851
 852     /* Return a vector of all tracepoints markers string id ID, or all
 853        markers if ID is NULL.  */
 854     VEC(static_tracepoint_marker_p) *(*to_static_tracepoint_markers_by_strid)
 855       (const char *id);
 856
 857     /* Return a traceframe info object describing the current
 858        traceframe's contents.  If the target doesn't support
 859        traceframe info, return NULL.  If the current traceframe is not
 860        selected (the current traceframe number is -1), the target can
 861        choose to return either NULL or an empty traceframe info.  If
 862        NULL is returned, for example in remote target, GDB will read
 863        from the live inferior.  If an empty traceframe info is
 864        returned, for example in tfile target, which means the
 865        traceframe info is available, but the requested memory is not
 866        available in it.  GDB will try to see if the requested memory
 867        is available in the read-only sections.  This method should not
 868        cache data; higher layers take care of caching, invalidating,
 869        and re-fetching when necessary.  */
 870     struct traceframe_info *(*to_traceframe_info) (void);
 871
 872     /* Ask the target to use or not to use agent according to USE.  Return 1
 873        successful, 0 otherwise.  */
 874     int (*to_use_agent) (int use);
 875
 876     /* Is the target able to use agent in current state?  */
 877     int (*to_can_use_agent) (void);
 878
 879     /* Check whether the target supports branch tracing.  */
 880     int (*to_supports_btrace) (struct target_ops *)
 881       TARGET_DEFAULT_RETURN (0);
 882
 883     /* Enable branch tracing for PTID and allocate a branch trace target
 884        information struct for reading and for disabling branch trace.  */
 885     struct btrace_target_info *(*to_enable_btrace) (ptid_t ptid);
 886
 887     /* Disable branch tracing and deallocate TINFO.  */
 888     void (*to_disable_btrace) (struct btrace_target_info *tinfo);
 889
 890     /* Disable branch tracing and deallocate TINFO.  This function is similar
 891        to to_disable_btrace, except that it is called during teardown and is
 892        only allowed to perform actions that are safe.  A counter-example would
 893        be attempting to talk to a remote target.  */
 894     void (*to_teardown_btrace) (struct btrace_target_info *tinfo);
 895
 896     /* Read branch trace data for the thread indicated by BTINFO into DATA.
 897        DATA is cleared before new trace is added.
 898        The branch trace will start with the most recent block and continue
 899        towards older blocks.  */
 900     enum btrace_error (*to_read_btrace) (VEC (btrace_block_s) **data,
 901                                          struct btrace_target_info *btinfo,
 902                                          enum btrace_read_type type);
 903
 904     /* Stop trace recording.  */
 905     void (*to_stop_recording) (void);
 906
 907     /* Print information about the recording.  */
 908     void (*to_info_record) (void);
 909
 910     /* Save the recorded execution trace into a file.  */
 911     void (*to_save_record) (const char *filename);
 912
 913     /* Delete the recorded execution trace from the current position onwards.  */
 914     void (*to_delete_record) (void);
 915
 916     /* Query if the record target is currently replaying.  */
 917     int (*to_record_is_replaying) (void);
 918
 919     /* Go to the begin of the execution trace.  */
 920     void (*to_goto_record_begin) (void);
 921
 922     /* Go to the end of the execution trace.  */
 923     void (*to_goto_record_end) (void);
 924
 925     /* Go to a specific location in the recorded execution trace.  */
 926     void (*to_goto_record) (ULONGEST insn);
 927
 928     /* Disassemble SIZE instructions in the recorded execution trace from
 929        the current position.
 930        If SIZE < 0, disassemble abs (SIZE) preceding instructions; otherwise,
 931        disassemble SIZE succeeding instructions.  */
 932     void (*to_insn_history) (int size, int flags);
 933
 934     /* Disassemble SIZE instructions in the recorded execution trace around
 935        FROM.
 936        If SIZE < 0, disassemble abs (SIZE) instructions before FROM; otherwise,
 937        disassemble SIZE instructions after FROM.  */
 938     void (*to_insn_history_from) (ULONGEST from, int size, int flags);
 939
 940     /* Disassemble a section of the recorded execution trace from instruction
 941        BEGIN (inclusive) to instruction END (inclusive).  */
 942     void (*to_insn_history_range) (ULONGEST begin, ULONGEST end, int flags);
 943
 944     /* Print a function trace of the recorded execution trace.
 945        If SIZE < 0, print abs (SIZE) preceding functions; otherwise, print SIZE
 946        succeeding functions.  */
 947     void (*to_call_history) (int size, int flags);
 948
 949     /* Print a function trace of the recorded execution trace starting
 950        at function FROM.
 951        If SIZE < 0, print abs (SIZE) functions before FROM; otherwise, print
 952        SIZE functions after FROM.  */
 953     void (*to_call_history_from) (ULONGEST begin, int size, int flags);
 954
 955     /* Print a function trace of an execution trace section from function BEGIN
 956        (inclusive) to function END (inclusive).  */
 957     void (*to_call_history_range) (ULONGEST begin, ULONGEST end, int flags);
 958
 959     /* Nonzero if TARGET_OBJECT_LIBRARIES_SVR4 may be read with a
 960        non-empty annex.  */
 961     int (*to_augmented_libraries_svr4_read) (void);
 962
 963     /* Those unwinders are tried before any other arch unwinders.  Use NULL if
 964        it is not used.  */
 965     const struct frame_unwind *to_get_unwinder;
 966     const struct frame_unwind *to_get_tailcall_unwinder;
 967
 968     /* Return the number of bytes by which the PC needs to be decremented
 969        after executing a breakpoint instruction.
 970        Defaults to gdbarch_decr_pc_after_break (GDBARCH).  */
 971     CORE_ADDR (*to_decr_pc_after_break) (struct target_ops *ops,
 972                                          struct gdbarch *gdbarch);
 973
 974     int to_magic;
 975     /* Need sub-structure for target machine related rather than comm related?
 976      */
 977   };
 978
 979 /* Magic number for checking ops size.  If a struct doesn't end with this
 980    number, somebody changed the declaration but didn't change all the
 981    places that initialize one.  */
 982
 983 #define OPS_MAGIC       3840
 984
 985 /* The ops structure for our "current" target process.  This should
 986    never be NULL.  If there is no target, it points to the dummy_target.  */
 987
 988 extern struct target_ops current_target;
 989
 990 /* Define easy words for doing these operations on our current target.  */
 991
 992 #define target_shortname        (current_target.to_shortname)
 993 #define target_longname         (current_target.to_longname)
 994
 995 /* Does whatever cleanup is required for a target that we are no
 996    longer going to be calling.  This routine is automatically always
 997    called after popping the target off the target stack - the target's
 998    own methods are no longer available through the target vector.
 999    Closing file descriptors and freeing all memory allocated memory are
1000    typical things it should do.  */
1001
1002 void target_close (struct target_ops *targ);
1003
1004 /* Attaches to a process on the target side.  Arguments are as passed
1005    to the `attach' command by the user.  This routine can be called
1006    when the target is not on the target-stack, if the target_can_run
1007    routine returns 1; in that case, it must push itself onto the stack.
1008    Upon exit, the target should be ready for normal operations, and
1009    should be ready to deliver the status of the process immediately
1010    (without waiting) to an upcoming target_wait call.  */
1011
1012 void target_attach (char *, int);
1013
1014 /* Some targets don't generate traps when attaching to the inferior,
1015    or their target_attach implementation takes care of the waiting.
1016    These targets must set to_attach_no_wait.  */
1017
1018 #define target_attach_no_wait \
1019      (current_target.to_attach_no_wait)
1020
1021 /* The target_attach operation places a process under debugger control,
1022    and stops the process.
1023
1024    This operation provides a target-specific hook that allows the
1025    necessary bookkeeping to be performed after an attach completes.  */
1026 #define target_post_attach(pid) \
1027      (*current_target.to_post_attach) (&current_target, pid)
1028
1029 /* Takes a program previously attached to and detaches it.
1030    The program may resume execution (some targets do, some don't) and will
1031    no longer stop on signals, etc.  We better not have left any breakpoints
1032    in the program or it'll die when it hits one.  ARGS is arguments
1033    typed by the user (e.g. a signal to send the process).  FROM_TTY
1034    says whether to be verbose or not.  */
1035
1036 extern void target_detach (const char *, int);
1037
1038 /* Disconnect from the current target without resuming it (leaving it
1039    waiting for a debugger).  */
1040
1041 extern void target_disconnect (char *, int);
1042
1043 /* Resume execution of the target process PTID (or a group of
1044    threads).  STEP says whether to single-step or to run free; SIGGNAL
1045    is the signal to be given to the target, or GDB_SIGNAL_0 for no
1046    signal.  The caller may not pass GDB_SIGNAL_DEFAULT.  A specific
1047    PTID means `step/resume only this process id'.  A wildcard PTID
1048    (all threads, or all threads of process) means `step/resume
1049    INFERIOR_PTID, and let other threads (for which the wildcard PTID
1050    matches) resume with their 'thread->suspend.stop_signal' signal
1051    (usually GDB_SIGNAL_0) if it is in "pass" state, or with no signal
1052    if in "no pass" state.  */
1053
1054 extern void target_resume (ptid_t ptid, int step, enum gdb_signal signal);
1055
1056 /* Wait for process pid to do something.  PTID = -1 to wait for any
1057    pid to do something.  Return pid of child, or -1 in case of error;
1058    store status through argument pointer STATUS.  Note that it is
1059    _NOT_ OK to throw_exception() out of target_wait() without popping
1060    the debugging target from the stack; GDB isn't prepared to get back
1061    to the prompt with a debugging target but without the frame cache,
1062    stop_pc, etc., set up.  OPTIONS is a bitwise OR of TARGET_W*
1063    options.  */
1064
1065 extern ptid_t target_wait (ptid_t ptid, struct target_waitstatus *status,
1066                            int options);
1067
1068 /* Fetch at least register REGNO, or all regs if regno == -1.  No result.  */
1069
1070 extern void target_fetch_registers (struct regcache *regcache, int regno);
1071
1072 /* Store at least register REGNO, or all regs if REGNO == -1.
1073    It can store as many registers as it wants to, so target_prepare_to_store
1074    must have been previously called.  Calls error() if there are problems.  */
1075
1076 extern void target_store_registers (struct regcache *regcache, int regs);
1077
1078 /* Get ready to modify the registers array.  On machines which store
1079    individual registers, this doesn't need to do anything.  On machines
1080    which store all the registers in one fell swoop, this makes sure
1081    that REGISTERS contains all the registers from the program being
1082    debugged.  */
1083
1084 #define target_prepare_to_store(regcache)       \
1085      (*current_target.to_prepare_to_store) (&current_target, regcache)
1086
1087 /* Determine current address space of thread PTID.  */
1088
1089 struct address_space *target_thread_address_space (ptid_t);
1090
1091 /* Implement the "info proc" command.  This returns one if the request
1092    was handled, and zero otherwise.  It can also throw an exception if
1093    an error was encountered while attempting to handle the
1094    request.  */
1095
1096 int target_info_proc (char *, enum info_proc_what);
1097
1098 /* Returns true if this target can debug multiple processes
1099    simultaneously.  */
1100
1101 #define target_supports_multi_process() \
1102      (*current_target.to_supports_multi_process) ()
1103
1104 /* Returns true if this target can disable address space randomization.  */
1105
1106 int target_supports_disable_randomization (void);
1107
1108 /* Returns true if this target can enable and disable tracepoints
1109    while a trace experiment is running.  */
1110
1111 #define target_supports_enable_disable_tracepoint() \
1112   (*current_target.to_supports_enable_disable_tracepoint) ()
1113
1114 #define target_supports_string_tracing() \
1115   (*current_target.to_supports_string_tracing) ()
1116
1117 /* Returns true if this target can handle breakpoint conditions
1118    on its end.  */
1119
1120 #define target_supports_evaluation_of_breakpoint_conditions() \
1121   (*current_target.to_supports_evaluation_of_breakpoint_conditions) ()
1122
1123 /* Returns true if this target can handle breakpoint commands
1124    on its end.  */
1125
1126 #define target_can_run_breakpoint_commands() \
1127   (*current_target.to_can_run_breakpoint_commands) ()
1128
1129 extern int target_read_string (CORE_ADDR, char **, int, int *);
1130
1131 extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1132                                ssize_t len);
1133
1134 extern int target_read_raw_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1135                                    ssize_t len);
1136
1137 extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1138
1139 extern int target_read_code (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1140
1141 extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
1142                                 ssize_t len);
1143
1144 extern int target_write_raw_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
1145                                     ssize_t len);
1146
1147 /* Fetches the target's memory map.  If one is found it is sorted
1148    and returned, after some consistency checking.  Otherwise, NULL
1149    is returned.  */
1150 VEC(mem_region_s) *target_memory_map (void);
1151
1152 /* Erase the specified flash region.  */
1153 void target_flash_erase (ULONGEST address, LONGEST length);
1154
1155 /* Finish a sequence of flash operations.  */
1156 void target_flash_done (void);
1157
1158 /* Describes a request for a memory write operation.  */
1159 struct memory_write_request
1160   {
1161     /* Begining address that must be written.  */
1162     ULONGEST begin;
1163     /* Past-the-end address.  */
1164     ULONGEST end;
1165     /* The data to write.  */
1166     gdb_byte *data;
1167     /* A callback baton for progress reporting for this request.  */
1168     void *baton;
1169   };
1170 typedef struct memory_write_request memory_write_request_s;
1171 DEF_VEC_O(memory_write_request_s);
1172
1173 /* Enumeration specifying different flash preservation behaviour.  */
1174 enum flash_preserve_mode
1175   {
1176     flash_preserve,
1177     flash_discard
1178   };
1179
1180 /* Write several memory blocks at once.  This version can be more
1181    efficient than making several calls to target_write_memory, in
1182    particular because it can optimize accesses to flash memory.
1183
1184    Moreover, this is currently the only memory access function in gdb
1185    that supports writing to flash memory, and it should be used for
1186    all cases where access to flash memory is desirable.
1187
1188    REQUESTS is the vector (see vec.h) of memory_write_request.
1189    PRESERVE_FLASH_P indicates what to do with blocks which must be
1190      erased, but not completely rewritten.
1191    PROGRESS_CB is a function that will be periodically called to provide
1192      feedback to user.  It will be called with the baton corresponding
1193      to the request currently being written.  It may also be called
1194      with a NULL baton, when preserved flash sectors are being rewritten.
1195
1196    The function returns 0 on success, and error otherwise.  */
1197 int target_write_memory_blocks (VEC(memory_write_request_s) *requests,
1198                                 enum flash_preserve_mode preserve_flash_p,
1199                                 void (*progress_cb) (ULONGEST, void *));
1200
1201 /* Print a line about the current target.  */
1202
1203 #define target_files_info()     \
1204      (*current_target.to_files_info) (&current_target)
1205
1206 /* Insert a hardware breakpoint at address BP_TGT->placed_address in
1207    the target machine.  Returns 0 for success, and returns non-zero or
1208    throws an error (with a detailed failure reason error code and
1209    message) otherwise.  */
1210
1211 extern int target_insert_breakpoint (struct gdbarch *gdbarch,
1212                                      struct bp_target_info *bp_tgt);
1213
1214 /* Remove a breakpoint at address BP_TGT->placed_address in the target
1215    machine.  Result is 0 for success, non-zero for error.  */
1216
1217 extern int target_remove_breakpoint (struct gdbarch *gdbarch,
1218                                      struct bp_target_info *bp_tgt);
1219
1220 /* Initialize the terminal settings we record for the inferior,
1221    before we actually run the inferior.  */
1222
1223 #define target_terminal_init() \
1224      (*current_target.to_terminal_init) ()
1225
1226 /* Put the inferior's terminal settings into effect.
1227    This is preparation for starting or resuming the inferior.  */
1228
1229 extern void target_terminal_inferior (void);
1230
1231 /* Put some of our terminal settings into effect,
1232    enough to get proper results from our output,
1233    but do not change into or out of RAW mode
1234    so that no input is discarded.
1235
1236    After doing this, either terminal_ours or terminal_inferior
1237    should be called to get back to a normal state of affairs.  */
1238
1239 #define target_terminal_ours_for_output() \
1240      (*current_target.to_terminal_ours_for_output) ()
1241
1242 /* Put our terminal settings into effect.
1243    First record the inferior's terminal settings
1244    so they can be restored properly later.  */
1245
1246 #define target_terminal_ours() \
1247      (*current_target.to_terminal_ours) ()
1248
1249 /* Save our terminal settings.
1250    This is called from TUI after entering or leaving the curses
1251    mode.  Since curses modifies our terminal this call is here
1252    to take this change into account.  */
1253
1254 #define target_terminal_save_ours() \
1255      (*current_target.to_terminal_save_ours) ()
1256
1257 /* Print useful information about our terminal status, if such a thing
1258    exists.  */
1259
1260 #define target_terminal_info(arg, from_tty) \
1261      (*current_target.to_terminal_info) (arg, from_tty)
1262
1263 /* Kill the inferior process.   Make it go away.  */
1264
1265 extern void target_kill (void);
1266
1267 /* Load an executable file into the target process.  This is expected
1268    to not only bring new code into the target process, but also to
1269    update GDB's symbol tables to match.
1270
1271    ARG contains command-line arguments, to be broken down with
1272    buildargv ().  The first non-switch argument is the filename to
1273    load, FILE; the second is a number (as parsed by strtoul (..., ...,
1274    0)), which is an offset to apply to the load addresses of FILE's
1275    sections.  The target may define switches, or other non-switch
1276    arguments, as it pleases.  */
1277
1278 extern void target_load (char *arg, int from_tty);
1279
1280 /* Start an inferior process and set inferior_ptid to its pid.
1281    EXEC_FILE is the file to run.
1282    ALLARGS is a string containing the arguments to the program.
1283    ENV is the environment vector to pass.  Errors reported with error().
1284    On VxWorks and various standalone systems, we ignore exec_file.  */
1285
1286 void target_create_inferior (char *exec_file, char *args,
1287                              char **env, int from_tty);
1288
1289 /* Some targets (such as ttrace-based HPUX) don't allow us to request
1290    notification of inferior events such as fork and vork immediately
1291    after the inferior is created.  (This because of how gdb gets an
1292    inferior created via invoking a shell to do it.  In such a scenario,
1293    if the shell init file has commands in it, the shell will fork and
1294    exec for each of those commands, and we will see each such fork
1295    event.  Very bad.)
1296
1297    Such targets will supply an appropriate definition for this function.  */
1298
1299 #define target_post_startup_inferior(ptid) \
1300      (*current_target.to_post_startup_inferior) (ptid)
1301
1302 /* On some targets, we can catch an inferior fork or vfork event when
1303    it occurs.  These functions insert/remove an already-created
1304    catchpoint for such events.  They return  0 for success, 1 if the
1305    catchpoint type is not supported and -1 for failure.  */
1306
1307 #define target_insert_fork_catchpoint(pid) \
1308      (*current_target.to_insert_fork_catchpoint) (pid)
1309
1310 #define target_remove_fork_catchpoint(pid) \
1311      (*current_target.to_remove_fork_catchpoint) (pid)
1312
1313 #define target_insert_vfork_catchpoint(pid) \
1314      (*current_target.to_insert_vfork_catchpoint) (pid)
1315
1316 #define target_remove_vfork_catchpoint(pid) \
1317      (*current_target.to_remove_vfork_catchpoint) (pid)
1318
1319 /* If the inferior forks or vforks, this function will be called at
1320    the next resume in order to perform any bookkeeping and fiddling
1321    necessary to continue debugging either the parent or child, as
1322    requested, and releasing the other.  Information about the fork
1323    or vfork event is available via get_last_target_status ().
1324    This function returns 1 if the inferior should not be resumed
1325    (i.e. there is another event pending).  */
1326
1327 int target_follow_fork (int follow_child, int detach_fork);
1328
1329 /* On some targets, we can catch an inferior exec event when it
1330    occurs.  These functions insert/remove an already-created
1331    catchpoint for such events.  They return  0 for success, 1 if the
1332    catchpoint type is not supported and -1 for failure.  */
1333
1334 #define target_insert_exec_catchpoint(pid) \
1335      (*current_target.to_insert_exec_catchpoint) (pid)
1336
1337 #define target_remove_exec_catchpoint(pid) \
1338      (*current_target.to_remove_exec_catchpoint) (pid)
1339
1340 /* Syscall catch.
1341
1342    NEEDED is nonzero if any syscall catch (of any kind) is requested.
1343    If NEEDED is zero, it means the target can disable the mechanism to
1344    catch system calls because there are no more catchpoints of this type.
1345
1346    ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
1347    being requested.  In this case, both TABLE_SIZE and TABLE should
1348    be ignored.
1349
1350    TABLE_SIZE is the number of elements in TABLE.  It only matters if
1351    ANY_COUNT is zero.
1352
1353    TABLE is an array of ints, indexed by syscall number.  An element in
1354    this array is nonzero if that syscall should be caught.  This argument
1355    only matters if ANY_COUNT is zero.
1356
1357    Return 0 for success, 1 if syscall catchpoints are not supported or -1
1358    for failure.  */
1359
1360 #define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
1361      (*current_target.to_set_syscall_catchpoint) (pid, needed, any_count, \
1362                                                   table_size, table)
1363
1364 /* Returns TRUE if PID has exited.  And, also sets EXIT_STATUS to the
1365    exit code of PID, if any.  */
1366
1367 #define target_has_exited(pid,wait_status,exit_status) \
1368      (*current_target.to_has_exited) (pid,wait_status,exit_status)
1369
1370 /* The debugger has completed a blocking wait() call.  There is now
1371    some process event that must be processed.  This function should
1372    be defined by those targets that require the debugger to perform
1373    cleanup or internal state changes in response to the process event.  */
1374
1375 /* The inferior process has died.  Do what is right.  */
1376
1377 void target_mourn_inferior (void);
1378
1379 /* Does target have enough data to do a run or attach command? */
1380
1381 #define target_can_run(t) \
1382      ((t)->to_can_run) ()
1383
1384 /* Set list of signals to be handled in the target.
1385
1386    PASS_SIGNALS is an array of size NSIG, indexed by target signal number
1387    (enum gdb_signal).  For every signal whose entry in this array is
1388    non-zero, the target is allowed -but not required- to skip reporting
1389    arrival of the signal to the GDB core by returning from target_wait,
1390    and to pass the signal directly to the inferior instead.
1391
1392    However, if the target is hardware single-stepping a thread that is
1393    about to receive a signal, it needs to be reported in any case, even
1394    if mentioned in a previous target_pass_signals call.   */
1395
1396 extern void target_pass_signals (int nsig, unsigned char *pass_signals);
1397
1398 /* Set list of signals the target may pass to the inferior.  This
1399    directly maps to the "handle SIGNAL pass/nopass" setting.
1400
1401    PROGRAM_SIGNALS is an array of size NSIG, indexed by target signal
1402    number (enum gdb_signal).  For every signal whose entry in this
1403    array is non-zero, the target is allowed to pass the signal to the
1404    inferior.  Signals not present in the array shall be silently
1405    discarded.  This does not influence whether to pass signals to the
1406    inferior as a result of a target_resume call.  This is useful in
1407    scenarios where the target needs to decide whether to pass or not a
1408    signal to the inferior without GDB core involvement, such as for
1409    example, when detaching (as threads may have been suspended with
1410    pending signals not reported to GDB).  */
1411
1412 extern void target_program_signals (int nsig, unsigned char *program_signals);
1413
1414 /* Check to see if a thread is still alive.  */
1415
1416 extern int target_thread_alive (ptid_t ptid);
1417
1418 /* Query for new threads and add them to the thread list.  */
1419
1420 extern void target_find_new_threads (void);
1421
1422 /* Make target stop in a continuable fashion.  (For instance, under
1423    Unix, this should act like SIGSTOP).  This function is normally
1424    used by GUIs to implement a stop button.  */
1425
1426 extern void target_stop (ptid_t ptid);
1427
1428 /* Send the specified COMMAND to the target's monitor
1429    (shell,interpreter) for execution.  The result of the query is
1430    placed in OUTBUF.  */
1431
1432 #define target_rcmd(command, outbuf) \
1433      (*current_target.to_rcmd) (command, outbuf)
1434
1435
1436 /* Does the target include all of memory, or only part of it?  This
1437    determines whether we look up the target chain for other parts of
1438    memory if this target can't satisfy a request.  */
1439
1440 extern int target_has_all_memory_1 (void);
1441 #define target_has_all_memory target_has_all_memory_1 ()
1442
1443 /* Does the target include memory?  (Dummy targets don't.)  */
1444
1445 extern int target_has_memory_1 (void);
1446 #define target_has_memory target_has_memory_1 ()
1447
1448 /* Does the target have a stack?  (Exec files don't, VxWorks doesn't, until
1449    we start a process.)  */
1450
1451 extern int target_has_stack_1 (void);
1452 #define target_has_stack target_has_stack_1 ()
1453
1454 /* Does the target have registers?  (Exec files don't.)  */
1455
1456 extern int target_has_registers_1 (void);
1457 #define target_has_registers target_has_registers_1 ()
1458
1459 /* Does the target have execution?  Can we make it jump (through
1460    hoops), or pop its stack a few times?  This means that the current
1461    target is currently executing; for some targets, that's the same as
1462    whether or not the target is capable of execution, but there are
1463    also targets which can be current while not executing.  In that
1464    case this will become true after target_create_inferior or
1465    target_attach.  */
1466
1467 extern int target_has_execution_1 (ptid_t);
1468
1469 /* Like target_has_execution_1, but always passes inferior_ptid.  */
1470
1471 extern int target_has_execution_current (void);
1472
1473 #define target_has_execution target_has_execution_current ()
1474
1475 /* Default implementations for process_stratum targets.  Return true
1476    if there's a selected inferior, false otherwise.  */
1477
1478 extern int default_child_has_all_memory (struct target_ops *ops);
1479 extern int default_child_has_memory (struct target_ops *ops);
1480 extern int default_child_has_stack (struct target_ops *ops);
1481 extern int default_child_has_registers (struct target_ops *ops);
1482 extern int default_child_has_execution (struct target_ops *ops,
1483                                         ptid_t the_ptid);
1484
1485 /* Can the target support the debugger control of thread execution?
1486    Can it lock the thread scheduler?  */
1487
1488 #define target_can_lock_scheduler \
1489      (current_target.to_has_thread_control & tc_schedlock)
1490
1491 /* Should the target enable async mode if it is supported?  Temporary
1492    cludge until async mode is a strict superset of sync mode.  */
1493 extern int target_async_permitted;
1494
1495 /* Can the target support asynchronous execution?  */
1496 #define target_can_async_p() (current_target.to_can_async_p (&current_target))
1497
1498 /* Is the target in asynchronous execution mode?  */
1499 #define target_is_async_p() (current_target.to_is_async_p (&current_target))
1500
1501 int target_supports_non_stop (void);
1502
1503 /* Put the target in async mode with the specified callback function.  */
1504 #define target_async(CALLBACK,CONTEXT) \
1505      (current_target.to_async (&current_target, (CALLBACK), (CONTEXT)))
1506
1507 #define target_execution_direction() \
1508   (current_target.to_execution_direction ())
1509
1510 /* Converts a process id to a string.  Usually, the string just contains
1511    `process xyz', but on some systems it may contain
1512    `process xyz thread abc'.  */
1513
1514 extern char *target_pid_to_str (ptid_t ptid);
1515
1516 extern char *normal_pid_to_str (ptid_t ptid);
1517
1518 /* Return a short string describing extra information about PID,
1519    e.g. "sleeping", "runnable", "running on LWP 3".  Null return value
1520    is okay.  */
1521
1522 #define target_extra_thread_info(TP) \
1523      (current_target.to_extra_thread_info (TP))
1524
1525 /* Return the thread's name.  A NULL result means that the target
1526    could not determine this thread's name.  */
1527
1528 extern char *target_thread_name (struct thread_info *);
1529
1530 /* Attempts to find the pathname of the executable file
1531    that was run to create a specified process.
1532
1533    The process PID must be stopped when this operation is used.
1534
1535    If the executable file cannot be determined, NULL is returned.
1536
1537    Else, a pointer to a character string containing the pathname
1538    is returned.  This string should be copied into a buffer by
1539    the client if the string will not be immediately used, or if
1540    it must persist.  */
1541
1542 #define target_pid_to_exec_file(pid) \
1543      (current_target.to_pid_to_exec_file) (pid)
1544
1545 /* See the to_thread_architecture description in struct target_ops.  */
1546
1547 #define target_thread_architecture(ptid) \
1548      (current_target.to_thread_architecture (&current_target, ptid))
1549
1550 /*
1551  * Iterator function for target memory regions.
1552  * Calls a callback function once for each memory region 'mapped'
1553  * in the child process.  Defined as a simple macro rather than
1554  * as a function macro so that it can be tested for nullity.
1555  */
1556
1557 #define target_find_memory_regions(FUNC, DATA) \
1558      (current_target.to_find_memory_regions) (FUNC, DATA)
1559
1560 /*
1561  * Compose corefile .note section.
1562  */
1563
1564 #define target_make_corefile_notes(BFD, SIZE_P) \
1565      (current_target.to_make_corefile_notes) (BFD, SIZE_P)
1566
1567 /* Bookmark interfaces.  */
1568 #define target_get_bookmark(ARGS, FROM_TTY) \
1569      (current_target.to_get_bookmark) (ARGS, FROM_TTY)
1570
1571 #define target_goto_bookmark(ARG, FROM_TTY) \
1572      (current_target.to_goto_bookmark) (ARG, FROM_TTY)
1573
1574 /* Hardware watchpoint interfaces.  */
1575
1576 /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1577    write).  Only the INFERIOR_PTID task is being queried.  */
1578
1579 #define target_stopped_by_watchpoint()          \
1580   ((*current_target.to_stopped_by_watchpoint) (&current_target))
1581
1582 /* Non-zero if we have steppable watchpoints  */
1583
1584 #define target_have_steppable_watchpoint \
1585    (current_target.to_have_steppable_watchpoint)
1586
1587 /* Non-zero if we have continuable watchpoints  */
1588
1589 #define target_have_continuable_watchpoint \
1590    (current_target.to_have_continuable_watchpoint)
1591
1592 /* Provide defaults for hardware watchpoint functions.  */
1593
1594 /* If the *_hw_beakpoint functions have not been defined
1595    elsewhere use the definitions in the target vector.  */
1596
1597 /* Returns non-zero if we can set a hardware watchpoint of type TYPE.  TYPE is
1598    one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1599    bp_hardware_breakpoint.  CNT is the number of such watchpoints used so far
1600    (including this one?).  OTHERTYPE is who knows what...  */
1601
1602 #define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
1603  (*current_target.to_can_use_hw_breakpoint) (&current_target,  \
1604                                              TYPE, CNT, OTHERTYPE);
1605
1606 /* Returns the number of debug registers needed to watch the given
1607    memory region, or zero if not supported.  */
1608
1609 #define target_region_ok_for_hw_watchpoint(addr, len) \
1610     (*current_target.to_region_ok_for_hw_watchpoint) (&current_target,  \
1611                                                       addr, len)
1612
1613
1614 /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
1615    TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
1616    COND is the expression for its condition, or NULL if there's none.
1617    Returns 0 for success, 1 if the watchpoint type is not supported,
1618    -1 for failure.  */
1619
1620 #define target_insert_watchpoint(addr, len, type, cond) \
1621      (*current_target.to_insert_watchpoint) (&current_target,   \
1622                                              addr, len, type, cond)
1623
1624 #define target_remove_watchpoint(addr, len, type, cond) \
1625      (*current_target.to_remove_watchpoint) (&current_target,   \
1626                                              addr, len, type, cond)
1627
1628 /* Insert a new masked watchpoint at ADDR using the mask MASK.
1629    RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1630    or hw_access for an access watchpoint.  Returns 0 for success, 1 if
1631    masked watchpoints are not supported, -1 for failure.  */
1632
1633 extern int target_insert_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1634
1635 /* Remove a masked watchpoint at ADDR with the mask MASK.
1636    RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1637    or hw_access for an access watchpoint.  Returns 0 for success, non-zero
1638    for failure.  */
1639
1640 extern int target_remove_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1641
1642 /* Insert a hardware breakpoint at address BP_TGT->placed_address in
1643    the target machine.  Returns 0 for success, and returns non-zero or
1644    throws an error (with a detailed failure reason error code and
1645    message) otherwise.  */
1646
1647 #define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1648      (*current_target.to_insert_hw_breakpoint) (&current_target,        \
1649                                                 gdbarch, bp_tgt)
1650
1651 #define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1652      (*current_target.to_remove_hw_breakpoint) (&current_target,        \
1653                                                 gdbarch, bp_tgt)
1654
1655 /* Return number of debug registers needed for a ranged breakpoint,
1656    or -1 if ranged breakpoints are not supported.  */
1657
1658 extern int target_ranged_break_num_registers (void);
1659
1660 /* Return non-zero if target knows the data address which triggered this
1661    target_stopped_by_watchpoint, in such case place it to *ADDR_P.  Only the
1662    INFERIOR_PTID task is being queried.  */
1663 #define target_stopped_data_address(target, addr_p) \
1664     (*target.to_stopped_data_address) (target, addr_p)
1665
1666 /* Return non-zero if ADDR is within the range of a watchpoint spanning
1667    LENGTH bytes beginning at START.  */
1668 #define target_watchpoint_addr_within_range(target, addr, start, length) \
1669   (*target.to_watchpoint_addr_within_range) (target, addr, start, length)
1670
1671 /* Return non-zero if the target is capable of using hardware to evaluate
1672    the condition expression.  In this case, if the condition is false when
1673    the watched memory location changes, execution may continue without the
1674    debugger being notified.
1675
1676    Due to limitations in the hardware implementation, it may be capable of
1677    avoiding triggering the watchpoint in some cases where the condition
1678    expression is false, but may report some false positives as well.
1679    For this reason, GDB will still evaluate the condition expression when
1680    the watchpoint triggers.  */
1681 #define target_can_accel_watchpoint_condition(addr, len, type, cond) \
1682   (*current_target.to_can_accel_watchpoint_condition) (addr, len, type, cond)
1683
1684 /* Return number of debug registers needed for a masked watchpoint,
1685    -1 if masked watchpoints are not supported or -2 if the given address
1686    and mask combination cannot be used.  */
1687
1688 extern int target_masked_watch_num_registers (CORE_ADDR addr, CORE_ADDR mask);
1689
1690 /* Target can execute in reverse?  */
1691 #define target_can_execute_reverse \
1692      (current_target.to_can_execute_reverse ? \
1693       current_target.to_can_execute_reverse () : 0)
1694
1695 extern const struct target_desc *target_read_description (struct target_ops *);
1696
1697 #define target_get_ada_task_ptid(lwp, tid) \
1698      (*current_target.to_get_ada_task_ptid) (lwp,tid)
1699
1700 /* Utility implementation of searching memory.  */
1701 extern int simple_search_memory (struct target_ops* ops,
1702                                  CORE_ADDR start_addr,
1703                                  ULONGEST search_space_len,
1704                                  const gdb_byte *pattern,
1705                                  ULONGEST pattern_len,
1706                                  CORE_ADDR *found_addrp);
1707
1708 /* Main entry point for searching memory.  */
1709 extern int target_search_memory (CORE_ADDR start_addr,
1710                                  ULONGEST search_space_len,
1711                                  const gdb_byte *pattern,
1712                                  ULONGEST pattern_len,
1713                                  CORE_ADDR *found_addrp);
1714
1715 /* Target file operations.  */
1716
1717 /* Open FILENAME on the target, using FLAGS and MODE.  Return a
1718    target file descriptor, or -1 if an error occurs (and set
1719    *TARGET_ERRNO).  */
1720 extern int target_fileio_open (const char *filename, int flags, int mode,
1721                                int *target_errno);
1722
1723 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
1724    Return the number of bytes written, or -1 if an error occurs
1725    (and set *TARGET_ERRNO).  */
1726 extern int target_fileio_pwrite (int fd, const gdb_byte *write_buf, int len,
1727                                  ULONGEST offset, int *target_errno);
1728
1729 /* Read up to LEN bytes FD on the target into READ_BUF.
1730    Return the number of bytes read, or -1 if an error occurs
1731    (and set *TARGET_ERRNO).  */
1732 extern int target_fileio_pread (int fd, gdb_byte *read_buf, int len,
1733                                 ULONGEST offset, int *target_errno);
1734
1735 /* Close FD on the target.  Return 0, or -1 if an error occurs
1736    (and set *TARGET_ERRNO).  */
1737 extern int target_fileio_close (int fd, int *target_errno);
1738
1739 /* Unlink FILENAME on the target.  Return 0, or -1 if an error
1740    occurs (and set *TARGET_ERRNO).  */
1741 extern int target_fileio_unlink (const char *filename, int *target_errno);
1742
1743 /* Read value of symbolic link FILENAME on the target.  Return a
1744    null-terminated string allocated via xmalloc, or NULL if an error
1745    occurs (and set *TARGET_ERRNO).  */
1746 extern char *target_fileio_readlink (const char *filename, int *target_errno);
1747
1748 /* Read target file FILENAME.  The return value will be -1 if the transfer
1749    fails or is not supported; 0 if the object is empty; or the length
1750    of the object otherwise.  If a positive value is returned, a
1751    sufficiently large buffer will be allocated using xmalloc and
1752    returned in *BUF_P containing the contents of the object.
1753
1754    This method should be used for objects sufficiently small to store
1755    in a single xmalloc'd buffer, when no fixed bound on the object's
1756    size is known in advance.  */
1757 extern LONGEST target_fileio_read_alloc (const char *filename,
1758                                          gdb_byte **buf_p);
1759
1760 /* Read target file FILENAME.  The result is NUL-terminated and
1761    returned as a string, allocated using xmalloc.  If an error occurs
1762    or the transfer is unsupported, NULL is returned.  Empty objects
1763    are returned as allocated but empty strings.  A warning is issued
1764    if the result contains any embedded NUL bytes.  */
1765 extern char *target_fileio_read_stralloc (const char *filename);
1766
1767
1768 /* Tracepoint-related operations.  */
1769
1770 #define target_trace_init() \
1771   (*current_target.to_trace_init) ()
1772
1773 #define target_download_tracepoint(t) \
1774   (*current_target.to_download_tracepoint) (t)
1775
1776 #define target_can_download_tracepoint() \
1777   (*current_target.to_can_download_tracepoint) ()
1778
1779 #define target_download_trace_state_variable(tsv) \
1780   (*current_target.to_download_trace_state_variable) (tsv)
1781
1782 #define target_enable_tracepoint(loc) \
1783   (*current_target.to_enable_tracepoint) (loc)
1784
1785 #define target_disable_tracepoint(loc) \
1786   (*current_target.to_disable_tracepoint) (loc)
1787
1788 #define target_trace_start() \
1789   (*current_target.to_trace_start) ()
1790
1791 #define target_trace_set_readonly_regions() \
1792   (*current_target.to_trace_set_readonly_regions) ()
1793
1794 #define target_get_trace_status(ts) \
1795   (*current_target.to_get_trace_status) (ts)
1796
1797 #define target_get_tracepoint_status(tp,utp)            \
1798   (*current_target.to_get_tracepoint_status) (tp, utp)
1799
1800 #define target_trace_stop() \
1801   (*current_target.to_trace_stop) ()
1802
1803 #define target_trace_find(type,num,addr1,addr2,tpp) \
1804   (*current_target.to_trace_find) ((type), (num), (addr1), (addr2), (tpp))
1805
1806 #define target_get_trace_state_variable_value(tsv,val) \
1807   (*current_target.to_get_trace_state_variable_value) ((tsv), (val))
1808
1809 #define target_save_trace_data(filename) \
1810   (*current_target.to_save_trace_data) (filename)
1811
1812 #define target_upload_tracepoints(utpp) \
1813   (*current_target.to_upload_tracepoints) (utpp)
1814
1815 #define target_upload_trace_state_variables(utsvp) \
1816   (*current_target.to_upload_trace_state_variables) (utsvp)
1817
1818 #define target_get_raw_trace_data(buf,offset,len) \
1819   (*current_target.to_get_raw_trace_data) ((buf), (offset), (len))
1820
1821 #define target_get_min_fast_tracepoint_insn_len() \
1822   (*current_target.to_get_min_fast_tracepoint_insn_len) ()
1823
1824 #define target_set_disconnected_tracing(val) \
1825   (*current_target.to_set_disconnected_tracing) (val)
1826
1827 #define target_set_circular_trace_buffer(val)   \
1828   (*current_target.to_set_circular_trace_buffer) (val)
1829
1830 #define target_set_trace_buffer_size(val)       \
1831   (*current_target.to_set_trace_buffer_size) (val)
1832
1833 #define target_set_trace_notes(user,notes,stopnotes)            \
1834   (*current_target.to_set_trace_notes) ((user), (notes), (stopnotes))
1835
1836 #define target_get_tib_address(ptid, addr) \
1837   (*current_target.to_get_tib_address) ((ptid), (addr))
1838
1839 #define target_set_permissions() \
1840   (*current_target.to_set_permissions) ()
1841
1842 #define target_static_tracepoint_marker_at(addr, marker) \
1843   (*current_target.to_static_tracepoint_marker_at) (addr, marker)
1844
1845 #define target_static_tracepoint_markers_by_strid(marker_id) \
1846   (*current_target.to_static_tracepoint_markers_by_strid) (marker_id)
1847
1848 #define target_traceframe_info() \
1849   (*current_target.to_traceframe_info) ()
1850
1851 #define target_use_agent(use) \
1852   (*current_target.to_use_agent) (use)
1853
1854 #define target_can_use_agent() \
1855   (*current_target.to_can_use_agent) ()
1856
1857 #define target_augmented_libraries_svr4_read() \
1858   (*current_target.to_augmented_libraries_svr4_read) ()
1859
1860 /* Command logging facility.  */
1861
1862 #define target_log_command(p)                                           \
1863   do                                                                    \
1864     if (current_target.to_log_command)                                  \
1865       (*current_target.to_log_command) (p);                             \
1866   while (0)
1867
1868
1869 extern int target_core_of_thread (ptid_t ptid);
1870
1871 /* See to_get_unwinder in struct target_ops.  */
1872 extern const struct frame_unwind *target_get_unwinder (void);
1873
1874 /* See to_get_tailcall_unwinder in struct target_ops.  */
1875 extern const struct frame_unwind *target_get_tailcall_unwinder (void);
1876
1877 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
1878    the contents of [DATA,DATA+SIZE).  Returns 1 if there's a match, 0
1879    if there's a mismatch, and -1 if an error is encountered while
1880    reading memory.  Throws an error if the functionality is found not
1881    to be supported by the current target.  */
1882 int target_verify_memory (const gdb_byte *data,
1883                           CORE_ADDR memaddr, ULONGEST size);
1884
1885 /* Routines for maintenance of the target structures...
1886
1887    complete_target_initialization: Finalize a target_ops by filling in
1888    any fields needed by the target implementation.
1889
1890    add_target:   Add a target to the list of all possible targets.
1891
1892    push_target:  Make this target the top of the stack of currently used
1893    targets, within its particular stratum of the stack.  Result
1894    is 0 if now atop the stack, nonzero if not on top (maybe
1895    should warn user).
1896
1897    unpush_target: Remove this from the stack of currently used targets,
1898    no matter where it is on the list.  Returns 0 if no
1899    change, 1 if removed from stack.  */
1900
1901 extern void add_target (struct target_ops *);
1902
1903 extern void add_target_with_completer (struct target_ops *t,
1904                                        completer_ftype *completer);
1905
1906 extern void complete_target_initialization (struct target_ops *t);
1907
1908 /* Adds a command ALIAS for target T and marks it deprecated.  This is useful
1909    for maintaining backwards compatibility when renaming targets.  */
1910
1911 extern void add_deprecated_target_alias (struct target_ops *t, char *alias);
1912
1913 extern void push_target (struct target_ops *);
1914
1915 extern int unpush_target (struct target_ops *);
1916
1917 extern void target_pre_inferior (int);
1918
1919 extern void target_preopen (int);
1920
1921 /* Does whatever cleanup is required to get rid of all pushed targets.  */
1922 extern void pop_all_targets (void);
1923
1924 /* Like pop_all_targets, but pops only targets whose stratum is
1925    strictly above ABOVE_STRATUM.  */
1926 extern void pop_all_targets_above (enum strata above_stratum);
1927
1928 extern int target_is_pushed (struct target_ops *t);
1929
1930 extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
1931                                                CORE_ADDR offset);
1932
1933 /* Struct target_section maps address ranges to file sections.  It is
1934    mostly used with BFD files, but can be used without (e.g. for handling
1935    raw disks, or files not in formats handled by BFD).  */
1936
1937 struct target_section
1938   {
1939     CORE_ADDR addr;             /* Lowest address in section */
1940     CORE_ADDR endaddr;          /* 1+highest address in section */
1941
1942     struct bfd_section *the_bfd_section;
1943
1944     /* The "owner" of the section.
1945        It can be any unique value.  It is set by add_target_sections
1946        and used by remove_target_sections.
1947        For example, for executables it is a pointer to exec_bfd and
1948        for shlibs it is the so_list pointer.  */
1949     void *owner;
1950   };
1951
1952 /* Holds an array of target sections.  Defined by [SECTIONS..SECTIONS_END[.  */
1953
1954 struct target_section_table
1955 {
1956   struct target_section *sections;
1957   struct target_section *sections_end;
1958 };
1959
1960 /* Return the "section" containing the specified address.  */
1961 struct target_section *target_section_by_addr (struct target_ops *target,
1962                                                CORE_ADDR addr);
1963
1964 /* Return the target section table this target (or the targets
1965    beneath) currently manipulate.  */
1966
1967 extern struct target_section_table *target_get_section_table
1968   (struct target_ops *target);
1969
1970 /* From mem-break.c */
1971
1972 extern int memory_remove_breakpoint (struct target_ops *, struct gdbarch *,
1973                                      struct bp_target_info *);
1974
1975 extern int memory_insert_breakpoint (struct target_ops *, struct gdbarch *,
1976                                      struct bp_target_info *);
1977
1978 extern int default_memory_remove_breakpoint (struct gdbarch *,
1979                                              struct bp_target_info *);
1980
1981 extern int default_memory_insert_breakpoint (struct gdbarch *,
1982                                              struct bp_target_info *);
1983
1984
1985 /* From target.c */
1986
1987 extern void initialize_targets (void);
1988
1989 extern void noprocess (void) ATTRIBUTE_NORETURN;
1990
1991 extern void target_require_runnable (void);
1992
1993 extern void find_default_attach (struct target_ops *, char *, int);
1994
1995 extern void find_default_create_inferior (struct target_ops *,
1996                                           char *, char *, char **, int);
1997
1998 extern struct target_ops *find_target_beneath (struct target_ops *);
1999
2000 /* Find the target at STRATUM.  If no target is at that stratum,
2001    return NULL.  */
2002
2003 struct target_ops *find_target_at (enum strata stratum);
2004
2005 /* Read OS data object of type TYPE from the target, and return it in
2006    XML format.  The result is NUL-terminated and returned as a string,
2007    allocated using xmalloc.  If an error occurs or the transfer is
2008    unsupported, NULL is returned.  Empty objects are returned as
2009    allocated but empty strings.  */
2010
2011 extern char *target_get_osdata (const char *type);
2012
2013 \f
2014 /* Stuff that should be shared among the various remote targets.  */
2015
2016 /* Debugging level.  0 is off, and non-zero values mean to print some debug
2017    information (higher values, more information).  */
2018 extern int remote_debug;
2019
2020 /* Speed in bits per second, or -1 which means don't mess with the speed.  */
2021 extern int baud_rate;
2022 /* Timeout limit for response from target.  */
2023 extern int remote_timeout;
2024
2025 \f
2026
2027 /* Set the show memory breakpoints mode to show, and installs a cleanup
2028    to restore it back to the current value.  */
2029 extern struct cleanup *make_show_memory_breakpoints_cleanup (int show);
2030
2031 extern int may_write_registers;
2032 extern int may_write_memory;
2033 extern int may_insert_breakpoints;
2034 extern int may_insert_tracepoints;
2035 extern int may_insert_fast_tracepoints;
2036 extern int may_stop;
2037
2038 extern void update_target_permissions (void);
2039
2040 \f
2041 /* Imported from machine dependent code.  */
2042
2043 /* Blank target vector entries are initialized to target_ignore.  */
2044 void target_ignore (void);
2045
2046 /* See to_supports_btrace in struct target_ops.  */
2047 #define target_supports_btrace() \
2048   (current_target.to_supports_btrace (&current_target))
2049
2050 /* See to_enable_btrace in struct target_ops.  */
2051 extern struct btrace_target_info *target_enable_btrace (ptid_t ptid);
2052
2053 /* See to_disable_btrace in struct target_ops.  */
2054 extern void target_disable_btrace (struct btrace_target_info *btinfo);
2055
2056 /* See to_teardown_btrace in struct target_ops.  */
2057 extern void target_teardown_btrace (struct btrace_target_info *btinfo);
2058
2059 /* See to_read_btrace in struct target_ops.  */
2060 extern enum btrace_error target_read_btrace (VEC (btrace_block_s) **,
2061                                              struct btrace_target_info *,
2062                                              enum btrace_read_type);
2063
2064 /* See to_stop_recording in struct target_ops.  */
2065 extern void target_stop_recording (void);
2066
2067 /* See to_info_record in struct target_ops.  */
2068 extern void target_info_record (void);
2069
2070 /* See to_save_record in struct target_ops.  */
2071 extern void target_save_record (const char *filename);
2072
2073 /* Query if the target supports deleting the execution log.  */
2074 extern int target_supports_delete_record (void);
2075
2076 /* See to_delete_record in struct target_ops.  */
2077 extern void target_delete_record (void);
2078
2079 /* See to_record_is_replaying in struct target_ops.  */
2080 extern int target_record_is_replaying (void);
2081
2082 /* See to_goto_record_begin in struct target_ops.  */
2083 extern void target_goto_record_begin (void);
2084
2085 /* See to_goto_record_end in struct target_ops.  */
2086 extern void target_goto_record_end (void);
2087
2088 /* See to_goto_record in struct target_ops.  */
2089 extern void target_goto_record (ULONGEST insn);
2090
2091 /* See to_insn_history.  */
2092 extern void target_insn_history (int size, int flags);
2093
2094 /* See to_insn_history_from.  */
2095 extern void target_insn_history_from (ULONGEST from, int size, int flags);
2096
2097 /* See to_insn_history_range.  */
2098 extern void target_insn_history_range (ULONGEST begin, ULONGEST end, int flags);
2099
2100 /* See to_call_history.  */
2101 extern void target_call_history (int size, int flags);
2102
2103 /* See to_call_history_from.  */
2104 extern void target_call_history_from (ULONGEST begin, int size, int flags);
2105
2106 /* See to_call_history_range.  */
2107 extern void target_call_history_range (ULONGEST begin, ULONGEST end, int flags);
2108
2109 /* See to_decr_pc_after_break.  Start searching for the target at OPS.  */
2110 extern CORE_ADDR forward_target_decr_pc_after_break (struct target_ops *ops,
2111                                                      struct gdbarch *gdbarch);
2112
2113 /* See to_decr_pc_after_break.  */
2114 extern CORE_ADDR target_decr_pc_after_break (struct gdbarch *gdbarch);
2115
2116 #endif /* !defined (TARGET_H) */