gdb/target.h

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