gdb/target.h

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