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