gdb/target.h

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