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