gdb/target.h

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