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