gdb/target.h

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