gdb/target.h

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