gdb/target.h

   1 /* Interface between GDB and target environments, including files and processes
   2
   3    Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   4    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
   5    Free Software Foundation, Inc.
   6
   7    Contributed by Cygnus Support.  Written by John Gilmore.
   8
   9    This file is part of GDB.
  10
  11    This program is free software; you can redistribute it and/or modify
  12    it under the terms of the GNU General Public License as published by
  13    the Free Software Foundation; either version 3 of the License, or
  14    (at your option) any later version.
  15
  16    This program is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19    GNU General Public License for more details.
  20
  21    You should have received a copy of the GNU General Public License
  22    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  23
  24 #if !defined (TARGET_H)
  25 #define TARGET_H
  26
  27 struct objfile;
  28 struct ui_file;
  29 struct mem_attrib;
  30 struct target_ops;
  31 struct bp_target_info;
  32 struct regcache;
  33 struct target_section_table;
  34
  35 /* This include file defines the interface between the main part
  36    of the debugger, and the part which is target-specific, or
  37    specific to the communications interface between us and the
  38    target.
  39
  40    A TARGET is an interface between the debugger and a particular
  41    kind of file or process.  Targets can be STACKED in STRATA,
  42    so that more than one target can potentially respond to a request.
  43    In particular, memory accesses will walk down the stack of targets
  44    until they find a target that is interested in handling that particular
  45    address.  STRATA are artificial boundaries on the stack, within
  46    which particular kinds of targets live.  Strata exist so that
  47    people don't get confused by pushing e.g. a process target and then
  48    a file target, and wondering why they can't see the current values
  49    of variables any more (the file target is handling them and they
  50    never get to the process target).  So when you push a file target,
  51    it goes into the file stratum, which is always below the process
  52    stratum.  */
  53
  54 #include "bfd.h"
  55 #include "symtab.h"
  56 #include "memattr.h"
  57 #include "vec.h"
  58 #include "gdb_signals.h"
  59
  60 enum strata
  61   {
  62     dummy_stratum,              /* The lowest of the low */
  63     file_stratum,               /* Executable files, etc */
  64     core_stratum,               /* Core dump files */
  65     process_stratum,            /* Executing processes */
  66     thread_stratum,             /* Executing threads */
  67     record_stratum,             /* Support record debugging */
  68     arch_stratum                /* Architecture overrides */
  69   };
  70
  71 enum thread_control_capabilities
  72   {
  73     tc_none = 0,                /* Default: can't control thread execution.  */
  74     tc_schedlock = 1,           /* Can lock the thread scheduler.  */
  75   };
  76
  77 /* Stuff for target_wait.  */
  78
  79 /* Generally, what has the program done?  */
  80 enum target_waitkind
  81   {
  82     /* The program has exited.  The exit status is in value.integer.  */
  83     TARGET_WAITKIND_EXITED,
  84
  85     /* The program has stopped with a signal.  Which signal is in
  86        value.sig.  */
  87     TARGET_WAITKIND_STOPPED,
  88
  89     /* The program has terminated with a signal.  Which signal is in
  90        value.sig.  */
  91     TARGET_WAITKIND_SIGNALLED,
  92
  93     /* The program is letting us know that it dynamically loaded something
  94        (e.g. it called load(2) on AIX).  */
  95     TARGET_WAITKIND_LOADED,
  96
  97     /* The program has forked.  A "related" process' PTID is in
  98        value.related_pid.  I.e., if the child forks, value.related_pid
  99        is the parent's ID.  */
 100
 101     TARGET_WAITKIND_FORKED,
 102
 103     /* The program has vforked.  A "related" process's PTID is in
 104        value.related_pid.  */
 105
 106     TARGET_WAITKIND_VFORKED,
 107
 108     /* The program has exec'ed a new executable file.  The new file's
 109        pathname is pointed to by value.execd_pathname.  */
 110
 111     TARGET_WAITKIND_EXECD,
 112
 113     /* The program had previously vforked, and now the child is done
 114        with the shared memory region, because it exec'ed or exited.
 115        Note that the event is reported to the vfork parent.  This is
 116        only used if GDB did not stay attached to the vfork child,
 117        otherwise, a TARGET_WAITKIND_EXECD or
 118        TARGET_WAITKIND_EXIT|SIGNALLED event associated with the child
 119        has the same effect.  */
 120     TARGET_WAITKIND_VFORK_DONE,
 121
 122     /* The program has entered or returned from a system call.  On
 123        HP-UX, this is used in the hardware watchpoint implementation.
 124        The syscall's unique integer ID number is in value.syscall_id */
 125
 126     TARGET_WAITKIND_SYSCALL_ENTRY,
 127     TARGET_WAITKIND_SYSCALL_RETURN,
 128
 129     /* Nothing happened, but we stopped anyway.  This perhaps should be handled
 130        within target_wait, but I'm not sure target_wait should be resuming the
 131        inferior.  */
 132     TARGET_WAITKIND_SPURIOUS,
 133
 134     /* An event has occured, but we should wait again.
 135        Remote_async_wait() returns this when there is an event
 136        on the inferior, but the rest of the world is not interested in
 137        it. The inferior has not stopped, but has just sent some output
 138        to the console, for instance. In this case, we want to go back
 139        to the event loop and wait there for another event from the
 140        inferior, rather than being stuck in the remote_async_wait()
 141        function. This way the event loop is responsive to other events,
 142        like for instance the user typing.  */
 143     TARGET_WAITKIND_IGNORE,
 144
 145     /* The target has run out of history information,
 146        and cannot run backward any further.  */
 147     TARGET_WAITKIND_NO_HISTORY
 148   };
 149
 150 struct target_waitstatus
 151   {
 152     enum target_waitkind kind;
 153
 154     /* Forked child pid, execd pathname, exit status, signal number or
 155        syscall number.  */
 156     union
 157       {
 158         int integer;
 159         enum target_signal sig;
 160         ptid_t related_pid;
 161         char *execd_pathname;
 162         int syscall_number;
 163       }
 164     value;
 165   };
 166
 167 /* Options that can be passed to target_wait.  */
 168
 169 /* Return immediately if there's no event already queued.  If this
 170    options is not requested, target_wait blocks waiting for an
 171    event.  */
 172 #define TARGET_WNOHANG 1
 173
 174 /* The structure below stores information about a system call.
 175    It is basically used in the "catch syscall" command, and in
 176    every function that gives information about a system call.
 177
 178    It's also good to mention that its fields represent everything
 179    that we currently know about a syscall in GDB.  */
 180 struct syscall
 181   {
 182     /* The syscall number.  */
 183     int number;
 184
 185     /* The syscall name.  */
 186     const char *name;
 187   };
 188
 189 /* Return a pretty printed form of target_waitstatus.
 190    Space for the result is malloc'd, caller must free.  */
 191 extern char *target_waitstatus_to_string (const struct target_waitstatus *);
 192
 193 /* Possible types of events that the inferior handler will have to
 194    deal with.  */
 195 enum inferior_event_type
 196   {
 197     /* There is a request to quit the inferior, abandon it.  */
 198     INF_QUIT_REQ,
 199     /* Process a normal inferior event which will result in target_wait
 200        being called.  */
 201     INF_REG_EVENT,
 202     /* Deal with an error on the inferior.  */
 203     INF_ERROR,
 204     /* We are called because a timer went off.  */
 205     INF_TIMER,
 206     /* We are called to do stuff after the inferior stops.  */
 207     INF_EXEC_COMPLETE,
 208     /* We are called to do some stuff after the inferior stops, but we
 209        are expected to reenter the proceed() and
 210        handle_inferior_event() functions. This is used only in case of
 211        'step n' like commands.  */
 212     INF_EXEC_CONTINUE
 213   };
 214 \f
 215 /* Target objects which can be transfered using target_read,
 216    target_write, et cetera.  */
 217
 218 enum target_object
 219 {
 220   /* AVR target specific transfer.  See "avr-tdep.c" and "remote.c".  */
 221   TARGET_OBJECT_AVR,
 222   /* SPU target specific transfer.  See "spu-tdep.c".  */
 223   TARGET_OBJECT_SPU,
 224   /* Transfer up-to LEN bytes of memory starting at OFFSET.  */
 225   TARGET_OBJECT_MEMORY,
 226   /* Memory, avoiding GDB's data cache and trusting the executable.
 227      Target implementations of to_xfer_partial never need to handle
 228      this object, and most callers should not use it.  */
 229   TARGET_OBJECT_RAW_MEMORY,
 230   /* Memory known to be part of the target's stack.  This is cached even
 231      if it is not in a region marked as such, since it is known to be
 232      "normal" RAM.  */
 233   TARGET_OBJECT_STACK_MEMORY,
 234   /* Kernel Unwind Table.  See "ia64-tdep.c".  */
 235   TARGET_OBJECT_UNWIND_TABLE,
 236   /* Transfer auxilliary vector.  */
 237   TARGET_OBJECT_AUXV,
 238   /* StackGhost cookie.  See "sparc-tdep.c".  */
 239   TARGET_OBJECT_WCOOKIE,
 240   /* Target memory map in XML format.  */
 241   TARGET_OBJECT_MEMORY_MAP,
 242   /* Flash memory.  This object can be used to write contents to
 243      a previously erased flash memory.  Using it without erasing
 244      flash can have unexpected results.  Addresses are physical
 245      address on target, and not relative to flash start.  */
 246   TARGET_OBJECT_FLASH,
 247   /* Available target-specific features, e.g. registers and coprocessors.
 248      See "target-descriptions.c".  ANNEX should never be empty.  */
 249   TARGET_OBJECT_AVAILABLE_FEATURES,
 250   /* Currently loaded libraries, in XML format.  */
 251   TARGET_OBJECT_LIBRARIES,
 252   /* Get OS specific data.  The ANNEX specifies the type (running
 253      processes, etc.).  */
 254   TARGET_OBJECT_OSDATA,
 255   /* Extra signal info.  Usually the contents of `siginfo_t' on unix
 256      platforms.  */
 257   TARGET_OBJECT_SIGNAL_INFO,
 258   /* Possible future objects: TARGET_OBJECT_FILE, ... */
 259 };
 260
 261 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
 262    OBJECT.  The OFFSET, for a seekable object, specifies the
 263    starting point.  The ANNEX can be used to provide additional
 264    data-specific information to the target.
 265
 266    Return the number of bytes actually transfered, or -1 if the
 267    transfer is not supported or otherwise fails.  Return of a positive
 268    value less than LEN indicates that no further transfer is possible.
 269    Unlike the raw to_xfer_partial interface, callers of these
 270    functions do not need to retry partial transfers.  */
 271
 272 extern LONGEST target_read (struct target_ops *ops,
 273                             enum target_object object,
 274                             const char *annex, gdb_byte *buf,
 275                             ULONGEST offset, LONGEST len);
 276
 277 extern LONGEST target_read_until_error (struct target_ops *ops,
 278                                         enum target_object object,
 279                                         const char *annex, gdb_byte *buf,
 280                                         ULONGEST offset, LONGEST len);
 281
 282 extern LONGEST target_write (struct target_ops *ops,
 283                              enum target_object object,
 284                              const char *annex, const gdb_byte *buf,
 285                              ULONGEST offset, LONGEST len);
 286
 287 /* Similar to target_write, except that it also calls PROGRESS with
 288    the number of bytes written and the opaque BATON after every
 289    successful partial write (and before the first write).  This is
 290    useful for progress reporting and user interaction while writing
 291    data.  To abort the transfer, the progress callback can throw an
 292    exception.  */
 293
 294 LONGEST target_write_with_progress (struct target_ops *ops,
 295                                     enum target_object object,
 296                                     const char *annex, const gdb_byte *buf,
 297                                     ULONGEST offset, LONGEST len,
 298                                     void (*progress) (ULONGEST, void *),
 299                                     void *baton);
 300
 301 /* Wrapper to perform a full read of unknown size.  OBJECT/ANNEX will
 302    be read using OPS.  The return value will be -1 if the transfer
 303    fails or is not supported; 0 if the object is empty; or the length
 304    of the object otherwise.  If a positive value is returned, a
 305    sufficiently large buffer will be allocated using xmalloc and
 306    returned in *BUF_P containing the contents of the object.
 307
 308    This method should be used for objects sufficiently small to store
 309    in a single xmalloc'd buffer, when no fixed bound on the object's
 310    size is known in advance.  Don't try to read TARGET_OBJECT_MEMORY
 311    through this function.  */
 312
 313 extern LONGEST target_read_alloc (struct target_ops *ops,
 314                                   enum target_object object,
 315                                   const char *annex, gdb_byte **buf_p);
 316
 317 /* Read OBJECT/ANNEX using OPS.  The result is NUL-terminated and
 318    returned as a string, allocated using xmalloc.  If an error occurs
 319    or the transfer is unsupported, NULL is returned.  Empty objects
 320    are returned as allocated but empty strings.  A warning is issued
 321    if the result contains any embedded NUL bytes.  */
 322
 323 extern char *target_read_stralloc (struct target_ops *ops,
 324                                    enum target_object object,
 325                                    const char *annex);
 326
 327 /* Wrappers to target read/write that perform memory transfers.  They
 328    throw an error if the memory transfer fails.
 329
 330    NOTE: cagney/2003-10-23: The naming schema is lifted from
 331    "frame.h".  The parameter order is lifted from get_frame_memory,
 332    which in turn lifted it from read_memory.  */
 333
 334 extern void get_target_memory (struct target_ops *ops, CORE_ADDR addr,
 335                                gdb_byte *buf, LONGEST len);
 336 extern ULONGEST get_target_memory_unsigned (struct target_ops *ops,
 337                                             CORE_ADDR addr, int len,
 338                                             enum bfd_endian byte_order);
 339 \f
 340 struct thread_info;             /* fwd decl for parameter list below: */
 341
 342 struct target_ops
 343   {
 344     struct target_ops *beneath; /* To the target under this one.  */
 345     char *to_shortname;         /* Name this target type */
 346     char *to_longname;          /* Name for printing */
 347     char *to_doc;               /* Documentation.  Does not include trailing
 348                                    newline, and starts with a one-line descrip-
 349                                    tion (probably similar to to_longname).  */
 350     /* Per-target scratch pad.  */
 351     void *to_data;
 352     /* The open routine takes the rest of the parameters from the
 353        command, and (if successful) pushes a new target onto the
 354        stack.  Targets should supply this routine, if only to provide
 355        an error message.  */
 356     void (*to_open) (char *, int);
 357     /* Old targets with a static target vector provide "to_close".
 358        New re-entrant targets provide "to_xclose" and that is expected
 359        to xfree everything (including the "struct target_ops").  */
 360     void (*to_xclose) (struct target_ops *targ, int quitting);
 361     void (*to_close) (int);
 362     void (*to_attach) (struct target_ops *ops, char *, int);
 363     void (*to_post_attach) (int);
 364     void (*to_detach) (struct target_ops *ops, char *, int);
 365     void (*to_disconnect) (struct target_ops *, char *, int);
 366     void (*to_resume) (struct target_ops *, ptid_t, int, enum target_signal);
 367     ptid_t (*to_wait) (struct target_ops *,
 368                        ptid_t, struct target_waitstatus *, int);
 369     void (*to_fetch_registers) (struct target_ops *, struct regcache *, int);
 370     void (*to_store_registers) (struct target_ops *, struct regcache *, int);
 371     void (*to_prepare_to_store) (struct regcache *);
 372
 373     /* Transfer LEN bytes of memory between GDB address MYADDR and
 374        target address MEMADDR.  If WRITE, transfer them to the target, else
 375        transfer them from the target.  TARGET is the target from which we
 376        get this function.
 377
 378        Return value, N, is one of the following:
 379
 380        0 means that we can't handle this.  If errno has been set, it is the
 381        error which prevented us from doing it (FIXME: What about bfd_error?).
 382
 383        positive (call it N) means that we have transferred N bytes
 384        starting at MEMADDR.  We might be able to handle more bytes
 385        beyond this length, but no promises.
 386
 387        negative (call its absolute value N) means that we cannot
 388        transfer right at MEMADDR, but we could transfer at least
 389        something at MEMADDR + N.
 390
 391        NOTE: cagney/2004-10-01: This has been entirely superseeded by
 392        to_xfer_partial and inferior inheritance.  */
 393
 394     int (*deprecated_xfer_memory) (CORE_ADDR memaddr, gdb_byte *myaddr,
 395                                    int len, int write,
 396                                    struct mem_attrib *attrib,
 397                                    struct target_ops *target);
 398
 399     void (*to_files_info) (struct target_ops *);
 400     int (*to_insert_breakpoint) (struct gdbarch *, struct bp_target_info *);
 401     int (*to_remove_breakpoint) (struct gdbarch *, struct bp_target_info *);
 402     int (*to_can_use_hw_breakpoint) (int, int, int);
 403     int (*to_insert_hw_breakpoint) (struct gdbarch *, struct bp_target_info *);
 404     int (*to_remove_hw_breakpoint) (struct gdbarch *, struct bp_target_info *);
 405     int (*to_remove_watchpoint) (CORE_ADDR, int, int);
 406     int (*to_insert_watchpoint) (CORE_ADDR, int, int);
 407     int (*to_stopped_by_watchpoint) (void);
 408     int to_have_steppable_watchpoint;
 409     int to_have_continuable_watchpoint;
 410     int (*to_stopped_data_address) (struct target_ops *, CORE_ADDR *);
 411     int (*to_watchpoint_addr_within_range) (struct target_ops *,
 412                                             CORE_ADDR, CORE_ADDR, int);
 413     int (*to_region_ok_for_hw_watchpoint) (CORE_ADDR, int);
 414     void (*to_terminal_init) (void);
 415     void (*to_terminal_inferior) (void);
 416     void (*to_terminal_ours_for_output) (void);
 417     void (*to_terminal_ours) (void);
 418     void (*to_terminal_save_ours) (void);
 419     void (*to_terminal_info) (char *, int);
 420     void (*to_kill) (struct target_ops *);
 421     void (*to_load) (char *, int);
 422     int (*to_lookup_symbol) (char *, CORE_ADDR *);
 423     void (*to_create_inferior) (struct target_ops *,
 424                                 char *, char *, char **, int);
 425     void (*to_post_startup_inferior) (ptid_t);
 426     void (*to_acknowledge_created_inferior) (int);
 427     void (*to_insert_fork_catchpoint) (int);
 428     int (*to_remove_fork_catchpoint) (int);
 429     void (*to_insert_vfork_catchpoint) (int);
 430     int (*to_remove_vfork_catchpoint) (int);
 431     int (*to_follow_fork) (struct target_ops *, int);
 432     void (*to_insert_exec_catchpoint) (int);
 433     int (*to_remove_exec_catchpoint) (int);
 434     int (*to_set_syscall_catchpoint) (int, int, int, int, int *);
 435     int (*to_has_exited) (int, int, int *);
 436     void (*to_mourn_inferior) (struct target_ops *);
 437     int (*to_can_run) (void);
 438     void (*to_notice_signals) (ptid_t ptid);
 439     int (*to_thread_alive) (struct target_ops *, ptid_t ptid);
 440     void (*to_find_new_threads) (struct target_ops *);
 441     char *(*to_pid_to_str) (struct target_ops *, ptid_t);
 442     char *(*to_extra_thread_info) (struct thread_info *);
 443     void (*to_stop) (ptid_t);
 444     void (*to_rcmd) (char *command, struct ui_file *output);
 445     char *(*to_pid_to_exec_file) (int pid);
 446     void (*to_log_command) (const char *);
 447     struct target_section_table *(*to_get_section_table) (struct target_ops *);
 448     enum strata to_stratum;
 449     int (*to_has_all_memory) (struct target_ops *);
 450     int (*to_has_memory) (struct target_ops *);
 451     int (*to_has_stack) (struct target_ops *);
 452     int (*to_has_registers) (struct target_ops *);
 453     int (*to_has_execution) (struct target_ops *);
 454     int to_has_thread_control;  /* control thread execution */
 455     int to_attach_no_wait;
 456     /* ASYNC target controls */
 457     int (*to_can_async_p) (void);
 458     int (*to_is_async_p) (void);
 459     void (*to_async) (void (*) (enum inferior_event_type, void *), void *);
 460     int (*to_async_mask) (int);
 461     int (*to_supports_non_stop) (void);
 462     /* find_memory_regions support method for gcore */
 463     int (*to_find_memory_regions) (int (*) (CORE_ADDR,
 464                                             unsigned long,
 465                                             int, int, int,
 466                                             void *),
 467                                    void *);
 468     /* make_corefile_notes support method for gcore */
 469     char * (*to_make_corefile_notes) (bfd *, int *);
 470     /* get_bookmark support method for bookmarks */
 471     gdb_byte * (*to_get_bookmark) (char *, int);
 472     /* goto_bookmark support method for bookmarks */
 473     void (*to_goto_bookmark) (gdb_byte *, int);
 474     /* Return the thread-local address at OFFSET in the
 475        thread-local storage for the thread PTID and the shared library
 476        or executable file given by OBJFILE.  If that block of
 477        thread-local storage hasn't been allocated yet, this function
 478        may return an error.  */
 479     CORE_ADDR (*to_get_thread_local_address) (struct target_ops *ops,
 480                                               ptid_t ptid,
 481                                               CORE_ADDR load_module_addr,
 482                                               CORE_ADDR offset);
 483
 484     /* Request that OPS transfer up to LEN 8-bit bytes of the target's
 485        OBJECT.  The OFFSET, for a seekable object, specifies the
 486        starting point.  The ANNEX can be used to provide additional
 487        data-specific information to the target.
 488
 489        Return the number of bytes actually transfered, zero when no
 490        further transfer is possible, and -1 when the transfer is not
 491        supported.  Return of a positive value smaller than LEN does
 492        not indicate the end of the object, only the end of the
 493        transfer; higher level code should continue transferring if
 494        desired.  This is handled in target.c.
 495
 496        The interface does not support a "retry" mechanism.  Instead it
 497        assumes that at least one byte will be transfered on each
 498        successful call.
 499
 500        NOTE: cagney/2003-10-17: The current interface can lead to
 501        fragmented transfers.  Lower target levels should not implement
 502        hacks, such as enlarging the transfer, in an attempt to
 503        compensate for this.  Instead, the target stack should be
 504        extended so that it implements supply/collect methods and a
 505        look-aside object cache.  With that available, the lowest
 506        target can safely and freely "push" data up the stack.
 507
 508        See target_read and target_write for more information.  One,
 509        and only one, of readbuf or writebuf must be non-NULL.  */
 510
 511     LONGEST (*to_xfer_partial) (struct target_ops *ops,
 512                                 enum target_object object, const char *annex,
 513                                 gdb_byte *readbuf, const gdb_byte *writebuf,
 514                                 ULONGEST offset, LONGEST len);
 515
 516     /* Returns the memory map for the target.  A return value of NULL
 517        means that no memory map is available.  If a memory address
 518        does not fall within any returned regions, it's assumed to be
 519        RAM.  The returned memory regions should not overlap.
 520
 521        The order of regions does not matter; target_memory_map will
 522        sort regions by starting address. For that reason, this
 523        function should not be called directly except via
 524        target_memory_map.
 525
 526        This method should not cache data; if the memory map could
 527        change unexpectedly, it should be invalidated, and higher
 528        layers will re-fetch it.  */
 529     VEC(mem_region_s) *(*to_memory_map) (struct target_ops *);
 530
 531     /* Erases the region of flash memory starting at ADDRESS, of
 532        length LENGTH.
 533
 534        Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
 535        on flash block boundaries, as reported by 'to_memory_map'.  */
 536     void (*to_flash_erase) (struct target_ops *,
 537                            ULONGEST address, LONGEST length);
 538
 539     /* Finishes a flash memory write sequence.  After this operation
 540        all flash memory should be available for writing and the result
 541        of reading from areas written by 'to_flash_write' should be
 542        equal to what was written.  */
 543     void (*to_flash_done) (struct target_ops *);
 544
 545     /* Describe the architecture-specific features of this target.
 546        Returns the description found, or NULL if no description
 547        was available.  */
 548     const struct target_desc *(*to_read_description) (struct target_ops *ops);
 549
 550     /* Build the PTID of the thread on which a given task is running,
 551        based on LWP and THREAD.  These values are extracted from the
 552        task Private_Data section of the Ada Task Control Block, and
 553        their interpretation depends on the target.  */
 554     ptid_t (*to_get_ada_task_ptid) (long lwp, long thread);
 555
 556     /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
 557        Return 0 if *READPTR is already at the end of the buffer.
 558        Return -1 if there is insufficient buffer for a whole entry.
 559        Return 1 if an entry was read into *TYPEP and *VALP.  */
 560     int (*to_auxv_parse) (struct target_ops *ops, gdb_byte **readptr,
 561                          gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
 562
 563     /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
 564        sequence of bytes in PATTERN with length PATTERN_LEN.
 565
 566        The result is 1 if found, 0 if not found, and -1 if there was an error
 567        requiring halting of the search (e.g. memory read error).
 568        If the pattern is found the address is recorded in FOUND_ADDRP.  */
 569     int (*to_search_memory) (struct target_ops *ops,
 570                              CORE_ADDR start_addr, ULONGEST search_space_len,
 571                              const gdb_byte *pattern, ULONGEST pattern_len,
 572                              CORE_ADDR *found_addrp);
 573
 574     /* Can target execute in reverse?  */
 575     int (*to_can_execute_reverse) (void);
 576
 577     /* Does this target support debugging multiple processes
 578        simultaneously?  */
 579     int (*to_supports_multi_process) (void);
 580
 581     /* Determine current architecture of thread PTID.
 582
 583        The target is supposed to determine the architecture of the code where
 584        the target is currently stopped at (on Cell, if a target is in spu_run,
 585        to_thread_architecture would return SPU, otherwise PPC32 or PPC64).
 586        This is architecture used to perform decr_pc_after_break adjustment,
 587        and also determines the frame architecture of the innermost frame.
 588        ptrace operations need to operate according to target_gdbarch.
 589
 590        The default implementation always returns target_gdbarch.  */
 591     struct gdbarch *(*to_thread_architecture) (struct target_ops *, ptid_t);
 592
 593     /* Determine current address space of thread PTID.
 594
 595        The default implementation always returns the inferior's
 596        address space.  */
 597     struct address_space *(*to_thread_address_space) (struct target_ops *,
 598                                                       ptid_t);
 599
 600     int to_magic;
 601     /* Need sub-structure for target machine related rather than comm related?
 602      */
 603   };
 604
 605 /* Magic number for checking ops size.  If a struct doesn't end with this
 606    number, somebody changed the declaration but didn't change all the
 607    places that initialize one.  */
 608
 609 #define OPS_MAGIC       3840
 610
 611 /* The ops structure for our "current" target process.  This should
 612    never be NULL.  If there is no target, it points to the dummy_target.  */
 613
 614 extern struct target_ops current_target;
 615
 616 /* Define easy words for doing these operations on our current target.  */
 617
 618 #define target_shortname        (current_target.to_shortname)
 619 #define target_longname         (current_target.to_longname)
 620
 621 /* Does whatever cleanup is required for a target that we are no
 622    longer going to be calling.  QUITTING indicates that GDB is exiting
 623    and should not get hung on an error (otherwise it is important to
 624    perform clean termination, even if it takes a while).  This routine
 625    is automatically always called when popping the target off the
 626    target stack (to_beneath is undefined).  Closing file descriptors
 627    and freeing all memory allocated memory are typical things it
 628    should do.  */
 629
 630 void target_close (struct target_ops *targ, int quitting);
 631
 632 /* Attaches to a process on the target side.  Arguments are as passed
 633    to the `attach' command by the user.  This routine can be called
 634    when the target is not on the target-stack, if the target_can_run
 635    routine returns 1; in that case, it must push itself onto the stack.
 636    Upon exit, the target should be ready for normal operations, and
 637    should be ready to deliver the status of the process immediately
 638    (without waiting) to an upcoming target_wait call.  */
 639
 640 void target_attach (char *, int);
 641
 642 /* Some targets don't generate traps when attaching to the inferior,
 643    or their target_attach implementation takes care of the waiting.
 644    These targets must set to_attach_no_wait.  */
 645
 646 #define target_attach_no_wait \
 647      (current_target.to_attach_no_wait)
 648
 649 /* The target_attach operation places a process under debugger control,
 650    and stops the process.
 651
 652    This operation provides a target-specific hook that allows the
 653    necessary bookkeeping to be performed after an attach completes.  */
 654 #define target_post_attach(pid) \
 655      (*current_target.to_post_attach) (pid)
 656
 657 /* Takes a program previously attached to and detaches it.
 658    The program may resume execution (some targets do, some don't) and will
 659    no longer stop on signals, etc.  We better not have left any breakpoints
 660    in the program or it'll die when it hits one.  ARGS is arguments
 661    typed by the user (e.g. a signal to send the process).  FROM_TTY
 662    says whether to be verbose or not.  */
 663
 664 extern void target_detach (char *, int);
 665
 666 /* Disconnect from the current target without resuming it (leaving it
 667    waiting for a debugger).  */
 668
 669 extern void target_disconnect (char *, int);
 670
 671 /* Resume execution of the target process PTID.  STEP says whether to
 672    single-step or to run free; SIGGNAL is the signal to be given to
 673    the target, or TARGET_SIGNAL_0 for no signal.  The caller may not
 674    pass TARGET_SIGNAL_DEFAULT.  */
 675
 676 extern void target_resume (ptid_t ptid, int step, enum target_signal signal);
 677
 678 /* Wait for process pid to do something.  PTID = -1 to wait for any
 679    pid to do something.  Return pid of child, or -1 in case of error;
 680    store status through argument pointer STATUS.  Note that it is
 681    _NOT_ OK to throw_exception() out of target_wait() without popping
 682    the debugging target from the stack; GDB isn't prepared to get back
 683    to the prompt with a debugging target but without the frame cache,
 684    stop_pc, etc., set up.  OPTIONS is a bitwise OR of TARGET_W*
 685    options.  */
 686
 687 extern ptid_t target_wait (ptid_t ptid, struct target_waitstatus *status,
 688                            int options);
 689
 690 /* Fetch at least register REGNO, or all regs if regno == -1.  No result.  */
 691
 692 extern void target_fetch_registers (struct regcache *regcache, int regno);
 693
 694 /* Store at least register REGNO, or all regs if REGNO == -1.
 695    It can store as many registers as it wants to, so target_prepare_to_store
 696    must have been previously called.  Calls error() if there are problems.  */
 697
 698 extern void target_store_registers (struct regcache *regcache, int regs);
 699
 700 /* Get ready to modify the registers array.  On machines which store
 701    individual registers, this doesn't need to do anything.  On machines
 702    which store all the registers in one fell swoop, this makes sure
 703    that REGISTERS contains all the registers from the program being
 704    debugged.  */
 705
 706 #define target_prepare_to_store(regcache)       \
 707      (*current_target.to_prepare_to_store) (regcache)
 708
 709 /* Determine current address space of thread PTID.  */
 710
 711 struct address_space *target_thread_address_space (ptid_t);
 712
 713 /* Returns true if this target can debug multiple processes
 714    simultaneously.  */
 715
 716 #define target_supports_multi_process() \
 717      (*current_target.to_supports_multi_process) ()
 718
 719 /* Invalidate all target dcaches.  */
 720 extern void target_dcache_invalidate (void);
 721
 722 extern int target_read_string (CORE_ADDR, char **, int, int *);
 723
 724 extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr, int len);
 725
 726 extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, int len);
 727
 728 extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
 729                                 int len);
 730
 731 /* Fetches the target's memory map.  If one is found it is sorted
 732    and returned, after some consistency checking.  Otherwise, NULL
 733    is returned.  */
 734 VEC(mem_region_s) *target_memory_map (void);
 735
 736 /* Erase the specified flash region.  */
 737 void target_flash_erase (ULONGEST address, LONGEST length);
 738
 739 /* Finish a sequence of flash operations.  */
 740 void target_flash_done (void);
 741
 742 /* Describes a request for a memory write operation.  */
 743 struct memory_write_request
 744   {
 745     /* Begining address that must be written. */
 746     ULONGEST begin;
 747     /* Past-the-end address. */
 748     ULONGEST end;
 749     /* The data to write. */
 750     gdb_byte *data;
 751     /* A callback baton for progress reporting for this request.  */
 752     void *baton;
 753   };
 754 typedef struct memory_write_request memory_write_request_s;
 755 DEF_VEC_O(memory_write_request_s);
 756
 757 /* Enumeration specifying different flash preservation behaviour.  */
 758 enum flash_preserve_mode
 759   {
 760     flash_preserve,
 761     flash_discard
 762   };
 763
 764 /* Write several memory blocks at once.  This version can be more
 765    efficient than making several calls to target_write_memory, in
 766    particular because it can optimize accesses to flash memory.
 767
 768    Moreover, this is currently the only memory access function in gdb
 769    that supports writing to flash memory, and it should be used for
 770    all cases where access to flash memory is desirable.
 771
 772    REQUESTS is the vector (see vec.h) of memory_write_request.
 773    PRESERVE_FLASH_P indicates what to do with blocks which must be
 774      erased, but not completely rewritten.
 775    PROGRESS_CB is a function that will be periodically called to provide
 776      feedback to user.  It will be called with the baton corresponding
 777      to the request currently being written.  It may also be called
 778      with a NULL baton, when preserved flash sectors are being rewritten.
 779
 780    The function returns 0 on success, and error otherwise.  */
 781 int target_write_memory_blocks (VEC(memory_write_request_s) *requests,
 782                                 enum flash_preserve_mode preserve_flash_p,
 783                                 void (*progress_cb) (ULONGEST, void *));
 784
 785 /* From infrun.c.  */
 786
 787 extern int inferior_has_forked (ptid_t pid, ptid_t *child_pid);
 788
 789 extern int inferior_has_vforked (ptid_t pid, ptid_t *child_pid);
 790
 791 extern int inferior_has_execd (ptid_t pid, char **execd_pathname);
 792
 793 extern int inferior_has_called_syscall (ptid_t pid, int *syscall_number);
 794
 795 /* Print a line about the current target.  */
 796
 797 #define target_files_info()     \
 798      (*current_target.to_files_info) (&current_target)
 799
 800 /* Insert a breakpoint at address BP_TGT->placed_address in the target
 801    machine.  Result is 0 for success, or an errno value.  */
 802
 803 #define target_insert_breakpoint(gdbarch, bp_tgt)       \
 804      (*current_target.to_insert_breakpoint) (gdbarch, bp_tgt)
 805
 806 /* Remove a breakpoint at address BP_TGT->placed_address in the target
 807    machine.  Result is 0 for success, or an errno value.  */
 808
 809 #define target_remove_breakpoint(gdbarch, bp_tgt)       \
 810      (*current_target.to_remove_breakpoint) (gdbarch, bp_tgt)
 811
 812 /* Initialize the terminal settings we record for the inferior,
 813    before we actually run the inferior.  */
 814
 815 #define target_terminal_init() \
 816      (*current_target.to_terminal_init) ()
 817
 818 /* Put the inferior's terminal settings into effect.
 819    This is preparation for starting or resuming the inferior.  */
 820
 821 extern void target_terminal_inferior (void);
 822
 823 /* Put some of our terminal settings into effect,
 824    enough to get proper results from our output,
 825    but do not change into or out of RAW mode
 826    so that no input is discarded.
 827
 828    After doing this, either terminal_ours or terminal_inferior
 829    should be called to get back to a normal state of affairs.  */
 830
 831 #define target_terminal_ours_for_output() \
 832      (*current_target.to_terminal_ours_for_output) ()
 833
 834 /* Put our terminal settings into effect.
 835    First record the inferior's terminal settings
 836    so they can be restored properly later.  */
 837
 838 #define target_terminal_ours() \
 839      (*current_target.to_terminal_ours) ()
 840
 841 /* Save our terminal settings.
 842    This is called from TUI after entering or leaving the curses
 843    mode.  Since curses modifies our terminal this call is here
 844    to take this change into account.  */
 845
 846 #define target_terminal_save_ours() \
 847      (*current_target.to_terminal_save_ours) ()
 848
 849 /* Print useful information about our terminal status, if such a thing
 850    exists.  */
 851
 852 #define target_terminal_info(arg, from_tty) \
 853      (*current_target.to_terminal_info) (arg, from_tty)
 854
 855 /* Kill the inferior process.   Make it go away.  */
 856
 857 extern void target_kill (void);
 858
 859 /* Load an executable file into the target process.  This is expected
 860    to not only bring new code into the target process, but also to
 861    update GDB's symbol tables to match.
 862
 863    ARG contains command-line arguments, to be broken down with
 864    buildargv ().  The first non-switch argument is the filename to
 865    load, FILE; the second is a number (as parsed by strtoul (..., ...,
 866    0)), which is an offset to apply to the load addresses of FILE's
 867    sections.  The target may define switches, or other non-switch
 868    arguments, as it pleases.  */
 869
 870 extern void target_load (char *arg, int from_tty);
 871
 872 /* Look up a symbol in the target's symbol table.  NAME is the symbol
 873    name.  ADDRP is a CORE_ADDR * pointing to where the value of the
 874    symbol should be returned.  The result is 0 if successful, nonzero
 875    if the symbol does not exist in the target environment.  This
 876    function should not call error() if communication with the target
 877    is interrupted, since it is called from symbol reading, but should
 878    return nonzero, possibly doing a complain().  */
 879
 880 #define target_lookup_symbol(name, addrp) \
 881      (*current_target.to_lookup_symbol) (name, addrp)
 882
 883 /* Start an inferior process and set inferior_ptid to its pid.
 884    EXEC_FILE is the file to run.
 885    ALLARGS is a string containing the arguments to the program.
 886    ENV is the environment vector to pass.  Errors reported with error().
 887    On VxWorks and various standalone systems, we ignore exec_file.  */
 888
 889 void target_create_inferior (char *exec_file, char *args,
 890                              char **env, int from_tty);
 891
 892 /* Some targets (such as ttrace-based HPUX) don't allow us to request
 893    notification of inferior events such as fork and vork immediately
 894    after the inferior is created.  (This because of how gdb gets an
 895    inferior created via invoking a shell to do it.  In such a scenario,
 896    if the shell init file has commands in it, the shell will fork and
 897    exec for each of those commands, and we will see each such fork
 898    event.  Very bad.)
 899
 900    Such targets will supply an appropriate definition for this function.  */
 901
 902 #define target_post_startup_inferior(ptid) \
 903      (*current_target.to_post_startup_inferior) (ptid)
 904
 905 /* On some targets, the sequence of starting up an inferior requires
 906    some synchronization between gdb and the new inferior process, PID.  */
 907
 908 #define target_acknowledge_created_inferior(pid) \
 909      (*current_target.to_acknowledge_created_inferior) (pid)
 910
 911 /* On some targets, we can catch an inferior fork or vfork event when
 912    it occurs.  These functions insert/remove an already-created
 913    catchpoint for such events.  */
 914
 915 #define target_insert_fork_catchpoint(pid) \
 916      (*current_target.to_insert_fork_catchpoint) (pid)
 917
 918 #define target_remove_fork_catchpoint(pid) \
 919      (*current_target.to_remove_fork_catchpoint) (pid)
 920
 921 #define target_insert_vfork_catchpoint(pid) \
 922      (*current_target.to_insert_vfork_catchpoint) (pid)
 923
 924 #define target_remove_vfork_catchpoint(pid) \
 925      (*current_target.to_remove_vfork_catchpoint) (pid)
 926
 927 /* If the inferior forks or vforks, this function will be called at
 928    the next resume in order to perform any bookkeeping and fiddling
 929    necessary to continue debugging either the parent or child, as
 930    requested, and releasing the other.  Information about the fork
 931    or vfork event is available via get_last_target_status ().
 932    This function returns 1 if the inferior should not be resumed
 933    (i.e. there is another event pending).  */
 934
 935 int target_follow_fork (int follow_child);
 936
 937 /* On some targets, we can catch an inferior exec event when it
 938    occurs.  These functions insert/remove an already-created
 939    catchpoint for such events.  */
 940
 941 #define target_insert_exec_catchpoint(pid) \
 942      (*current_target.to_insert_exec_catchpoint) (pid)
 943
 944 #define target_remove_exec_catchpoint(pid) \
 945      (*current_target.to_remove_exec_catchpoint) (pid)
 946
 947 /* Syscall catch.
 948
 949    NEEDED is nonzero if any syscall catch (of any kind) is requested.
 950    If NEEDED is zero, it means the target can disable the mechanism to
 951    catch system calls because there are no more catchpoints of this type.
 952
 953    ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
 954    being requested.  In this case, both TABLE_SIZE and TABLE should
 955    be ignored.
 956
 957    TABLE_SIZE is the number of elements in TABLE.  It only matters if
 958    ANY_COUNT is zero.
 959
 960    TABLE is an array of ints, indexed by syscall number.  An element in
 961    this array is nonzero if that syscall should be caught.  This argument
 962    only matters if ANY_COUNT is zero.  */
 963
 964 #define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
 965      (*current_target.to_set_syscall_catchpoint) (pid, needed, any_count, \
 966                                                   table_size, table)
 967
 968 /* Returns TRUE if PID has exited.  And, also sets EXIT_STATUS to the
 969    exit code of PID, if any.  */
 970
 971 #define target_has_exited(pid,wait_status,exit_status) \
 972      (*current_target.to_has_exited) (pid,wait_status,exit_status)
 973
 974 /* The debugger has completed a blocking wait() call.  There is now
 975    some process event that must be processed.  This function should
 976    be defined by those targets that require the debugger to perform
 977    cleanup or internal state changes in response to the process event.  */
 978
 979 /* The inferior process has died.  Do what is right.  */
 980
 981 void target_mourn_inferior (void);
 982
 983 /* Does target have enough data to do a run or attach command? */
 984
 985 #define target_can_run(t) \
 986      ((t)->to_can_run) ()
 987
 988 /* post process changes to signal handling in the inferior.  */
 989
 990 #define target_notice_signals(ptid) \
 991      (*current_target.to_notice_signals) (ptid)
 992
 993 /* Check to see if a thread is still alive.  */
 994
 995 extern int target_thread_alive (ptid_t ptid);
 996
 997 /* Query for new threads and add them to the thread list.  */
 998
 999 extern void target_find_new_threads (void);
1000
1001 /* Make target stop in a continuable fashion.  (For instance, under
1002    Unix, this should act like SIGSTOP).  This function is normally
1003    used by GUIs to implement a stop button.  */
1004
1005 #define target_stop(ptid) (*current_target.to_stop) (ptid)
1006
1007 /* Send the specified COMMAND to the target's monitor
1008    (shell,interpreter) for execution.  The result of the query is
1009    placed in OUTBUF.  */
1010
1011 #define target_rcmd(command, outbuf) \
1012      (*current_target.to_rcmd) (command, outbuf)
1013
1014
1015 /* Does the target include all of memory, or only part of it?  This
1016    determines whether we look up the target chain for other parts of
1017    memory if this target can't satisfy a request.  */
1018
1019 extern int target_has_all_memory_1 (void);
1020 #define target_has_all_memory target_has_all_memory_1 ()
1021
1022 /* Does the target include memory?  (Dummy targets don't.)  */
1023
1024 extern int target_has_memory_1 (void);
1025 #define target_has_memory target_has_memory_1 ()
1026
1027 /* Does the target have a stack?  (Exec files don't, VxWorks doesn't, until
1028    we start a process.)  */
1029
1030 extern int target_has_stack_1 (void);
1031 #define target_has_stack target_has_stack_1 ()
1032
1033 /* Does the target have registers?  (Exec files don't.)  */
1034
1035 extern int target_has_registers_1 (void);
1036 #define target_has_registers target_has_registers_1 ()
1037
1038 /* Does the target have execution?  Can we make it jump (through
1039    hoops), or pop its stack a few times?  This means that the current
1040    target is currently executing; for some targets, that's the same as
1041    whether or not the target is capable of execution, but there are
1042    also targets which can be current while not executing.  In that
1043    case this will become true after target_create_inferior or
1044    target_attach.  */
1045
1046 extern int target_has_execution_1 (void);
1047 #define target_has_execution target_has_execution_1 ()
1048
1049 /* Default implementations for process_stratum targets.  Return true
1050    if there's a selected inferior, false otherwise.  */
1051
1052 extern int default_child_has_all_memory (struct target_ops *ops);
1053 extern int default_child_has_memory (struct target_ops *ops);
1054 extern int default_child_has_stack (struct target_ops *ops);
1055 extern int default_child_has_registers (struct target_ops *ops);
1056 extern int default_child_has_execution (struct target_ops *ops);
1057
1058 /* Can the target support the debugger control of thread execution?
1059    Can it lock the thread scheduler?  */
1060
1061 #define target_can_lock_scheduler \
1062      (current_target.to_has_thread_control & tc_schedlock)
1063
1064 /* Should the target enable async mode if it is supported?  Temporary
1065    cludge until async mode is a strict superset of sync mode.  */
1066 extern int target_async_permitted;
1067
1068 /* Can the target support asynchronous execution? */
1069 #define target_can_async_p() (current_target.to_can_async_p ())
1070
1071 /* Is the target in asynchronous execution mode? */
1072 #define target_is_async_p() (current_target.to_is_async_p ())
1073
1074 int target_supports_non_stop (void);
1075
1076 /* Put the target in async mode with the specified callback function. */
1077 #define target_async(CALLBACK,CONTEXT) \
1078      (current_target.to_async ((CALLBACK), (CONTEXT)))
1079
1080 /* This is to be used ONLY within call_function_by_hand(). It provides
1081    a workaround, to have inferior function calls done in sychronous
1082    mode, even though the target is asynchronous. After
1083    target_async_mask(0) is called, calls to target_can_async_p() will
1084    return FALSE , so that target_resume() will not try to start the
1085    target asynchronously. After the inferior stops, we IMMEDIATELY
1086    restore the previous nature of the target, by calling
1087    target_async_mask(1). After that, target_can_async_p() will return
1088    TRUE. ANY OTHER USE OF THIS FEATURE IS DEPRECATED.
1089
1090    FIXME ezannoni 1999-12-13: we won't need this once we move
1091    the turning async on and off to the single execution commands,
1092    from where it is done currently, in remote_resume().  */
1093
1094 #define target_async_mask(MASK) \
1095   (current_target.to_async_mask (MASK))
1096
1097 /* Converts a process id to a string.  Usually, the string just contains
1098    `process xyz', but on some systems it may contain
1099    `process xyz thread abc'.  */
1100
1101 extern char *target_pid_to_str (ptid_t ptid);
1102
1103 extern char *normal_pid_to_str (ptid_t ptid);
1104
1105 /* Return a short string describing extra information about PID,
1106    e.g. "sleeping", "runnable", "running on LWP 3".  Null return value
1107    is okay.  */
1108
1109 #define target_extra_thread_info(TP) \
1110      (current_target.to_extra_thread_info (TP))
1111
1112 /* Attempts to find the pathname of the executable file
1113    that was run to create a specified process.
1114
1115    The process PID must be stopped when this operation is used.
1116
1117    If the executable file cannot be determined, NULL is returned.
1118
1119    Else, a pointer to a character string containing the pathname
1120    is returned.  This string should be copied into a buffer by
1121    the client if the string will not be immediately used, or if
1122    it must persist.  */
1123
1124 #define target_pid_to_exec_file(pid) \
1125      (current_target.to_pid_to_exec_file) (pid)
1126
1127 /* See the to_thread_architecture description in struct target_ops.  */
1128
1129 #define target_thread_architecture(ptid) \
1130      (current_target.to_thread_architecture (&current_target, ptid))
1131
1132 /*
1133  * Iterator function for target memory regions.
1134  * Calls a callback function once for each memory region 'mapped'
1135  * in the child process.  Defined as a simple macro rather than
1136  * as a function macro so that it can be tested for nullity.
1137  */
1138
1139 #define target_find_memory_regions(FUNC, DATA) \
1140      (current_target.to_find_memory_regions) (FUNC, DATA)
1141
1142 /*
1143  * Compose corefile .note section.
1144  */
1145
1146 #define target_make_corefile_notes(BFD, SIZE_P) \
1147      (current_target.to_make_corefile_notes) (BFD, SIZE_P)
1148
1149 /* Bookmark interfaces.  */
1150 #define target_get_bookmark(ARGS, FROM_TTY) \
1151      (current_target.to_get_bookmark) (ARGS, FROM_TTY)
1152
1153 #define target_goto_bookmark(ARG, FROM_TTY) \
1154      (current_target.to_goto_bookmark) (ARG, FROM_TTY)
1155
1156 /* Hardware watchpoint interfaces.  */
1157
1158 /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1159    write).  Only the INFERIOR_PTID task is being queried.  */
1160
1161 #define target_stopped_by_watchpoint \
1162    (*current_target.to_stopped_by_watchpoint)
1163
1164 /* Non-zero if we have steppable watchpoints  */
1165
1166 #define target_have_steppable_watchpoint \
1167    (current_target.to_have_steppable_watchpoint)
1168
1169 /* Non-zero if we have continuable watchpoints  */
1170
1171 #define target_have_continuable_watchpoint \
1172    (current_target.to_have_continuable_watchpoint)
1173
1174 /* Provide defaults for hardware watchpoint functions.  */
1175
1176 /* If the *_hw_beakpoint functions have not been defined
1177    elsewhere use the definitions in the target vector.  */
1178
1179 /* Returns non-zero if we can set a hardware watchpoint of type TYPE.  TYPE is
1180    one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1181    bp_hardware_breakpoint.  CNT is the number of such watchpoints used so far
1182    (including this one?).  OTHERTYPE is who knows what...  */
1183
1184 #define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
1185  (*current_target.to_can_use_hw_breakpoint) (TYPE, CNT, OTHERTYPE);
1186
1187 #define target_region_ok_for_hw_watchpoint(addr, len) \
1188     (*current_target.to_region_ok_for_hw_watchpoint) (addr, len)
1189
1190
1191 /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.  TYPE is 0
1192    for write, 1 for read, and 2 for read/write accesses.  Returns 0 for
1193    success, non-zero for failure.  */
1194
1195 #define target_insert_watchpoint(addr, len, type)       \
1196      (*current_target.to_insert_watchpoint) (addr, len, type)
1197
1198 #define target_remove_watchpoint(addr, len, type)       \
1199      (*current_target.to_remove_watchpoint) (addr, len, type)
1200
1201 #define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1202      (*current_target.to_insert_hw_breakpoint) (gdbarch, bp_tgt)
1203
1204 #define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1205      (*current_target.to_remove_hw_breakpoint) (gdbarch, bp_tgt)
1206
1207 /* Return non-zero if target knows the data address which triggered this
1208    target_stopped_by_watchpoint, in such case place it to *ADDR_P.  Only the
1209    INFERIOR_PTID task is being queried.  */
1210 #define target_stopped_data_address(target, addr_p) \
1211     (*target.to_stopped_data_address) (target, addr_p)
1212
1213 #define target_watchpoint_addr_within_range(target, addr, start, length) \
1214   (*target.to_watchpoint_addr_within_range) (target, addr, start, length)
1215
1216 /* Target can execute in reverse?  */
1217 #define target_can_execute_reverse \
1218      (current_target.to_can_execute_reverse ? \
1219       current_target.to_can_execute_reverse () : 0)
1220
1221 extern const struct target_desc *target_read_description (struct target_ops *);
1222
1223 #define target_get_ada_task_ptid(lwp, tid) \
1224      (*current_target.to_get_ada_task_ptid) (lwp,tid)
1225
1226 /* Utility implementation of searching memory.  */
1227 extern int simple_search_memory (struct target_ops* ops,
1228                                  CORE_ADDR start_addr,
1229                                  ULONGEST search_space_len,
1230                                  const gdb_byte *pattern,
1231                                  ULONGEST pattern_len,
1232                                  CORE_ADDR *found_addrp);
1233
1234 /* Main entry point for searching memory.  */
1235 extern int target_search_memory (CORE_ADDR start_addr,
1236                                  ULONGEST search_space_len,
1237                                  const gdb_byte *pattern,
1238                                  ULONGEST pattern_len,
1239                                  CORE_ADDR *found_addrp);
1240
1241 /* Command logging facility.  */
1242
1243 #define target_log_command(p)                                           \
1244   do                                                                    \
1245     if (current_target.to_log_command)                                  \
1246       (*current_target.to_log_command) (p);                             \
1247   while (0)
1248
1249 /* Routines for maintenance of the target structures...
1250
1251    add_target:   Add a target to the list of all possible targets.
1252
1253    push_target:  Make this target the top of the stack of currently used
1254    targets, within its particular stratum of the stack.  Result
1255    is 0 if now atop the stack, nonzero if not on top (maybe
1256    should warn user).
1257
1258    unpush_target: Remove this from the stack of currently used targets,
1259    no matter where it is on the list.  Returns 0 if no
1260    change, 1 if removed from stack.
1261
1262    pop_target:   Remove the top thing on the stack of current targets.  */
1263
1264 extern void add_target (struct target_ops *);
1265
1266 extern int push_target (struct target_ops *);
1267
1268 extern int unpush_target (struct target_ops *);
1269
1270 extern void target_pre_inferior (int);
1271
1272 extern void target_preopen (int);
1273
1274 extern void pop_target (void);
1275
1276 /* Does whatever cleanup is required to get rid of all pushed targets.
1277    QUITTING is propagated to target_close; it indicates that GDB is
1278    exiting and should not get hung on an error (otherwise it is
1279    important to perform clean termination, even if it takes a
1280    while).  */
1281 extern void pop_all_targets (int quitting);
1282
1283 /* Like pop_all_targets, but pops only targets whose stratum is
1284    strictly above ABOVE_STRATUM.  */
1285 extern void pop_all_targets_above (enum strata above_stratum, int quitting);
1286
1287 extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
1288                                                CORE_ADDR offset);
1289
1290 /* Struct target_section maps address ranges to file sections.  It is
1291    mostly used with BFD files, but can be used without (e.g. for handling
1292    raw disks, or files not in formats handled by BFD).  */
1293
1294 struct target_section
1295   {
1296     CORE_ADDR addr;             /* Lowest address in section */
1297     CORE_ADDR endaddr;          /* 1+highest address in section */
1298
1299     struct bfd_section *the_bfd_section;
1300
1301     bfd *bfd;                   /* BFD file pointer */
1302   };
1303
1304 /* Holds an array of target sections.  Defined by [SECTIONS..SECTIONS_END[.  */
1305
1306 struct target_section_table
1307 {
1308   struct target_section *sections;
1309   struct target_section *sections_end;
1310 };
1311
1312 /* Return the "section" containing the specified address.  */
1313 struct target_section *target_section_by_addr (struct target_ops *target,
1314                                                CORE_ADDR addr);
1315
1316 /* Return the target section table this target (or the targets
1317    beneath) currently manipulate.  */
1318
1319 extern struct target_section_table *target_get_section_table
1320   (struct target_ops *target);
1321
1322 /* From mem-break.c */
1323
1324 extern int memory_remove_breakpoint (struct gdbarch *, struct bp_target_info *);
1325
1326 extern int memory_insert_breakpoint (struct gdbarch *, struct bp_target_info *);
1327
1328 extern int default_memory_remove_breakpoint (struct gdbarch *, struct bp_target_info *);
1329
1330 extern int default_memory_insert_breakpoint (struct gdbarch *, struct bp_target_info *);
1331
1332
1333 /* From target.c */
1334
1335 extern void initialize_targets (void);
1336
1337 extern NORETURN void noprocess (void) ATTR_NORETURN;
1338
1339 extern void target_require_runnable (void);
1340
1341 extern void find_default_attach (struct target_ops *, char *, int);
1342
1343 extern void find_default_create_inferior (struct target_ops *,
1344                                           char *, char *, char **, int);
1345
1346 extern struct target_ops *find_run_target (void);
1347
1348 extern struct target_ops *find_core_target (void);
1349
1350 extern struct target_ops *find_target_beneath (struct target_ops *);
1351
1352 /* Read OS data object of type TYPE from the target, and return it in
1353    XML format.  The result is NUL-terminated and returned as a string,
1354    allocated using xmalloc.  If an error occurs or the transfer is
1355    unsupported, NULL is returned.  Empty objects are returned as
1356    allocated but empty strings.  */
1357
1358 extern char *target_get_osdata (const char *type);
1359
1360 \f
1361 /* Stuff that should be shared among the various remote targets.  */
1362
1363 /* Debugging level.  0 is off, and non-zero values mean to print some debug
1364    information (higher values, more information).  */
1365 extern int remote_debug;
1366
1367 /* Speed in bits per second, or -1 which means don't mess with the speed.  */
1368 extern int baud_rate;
1369 /* Timeout limit for response from target. */
1370 extern int remote_timeout;
1371
1372 \f
1373 /* Functions for helping to write a native target.  */
1374
1375 /* This is for native targets which use a unix/POSIX-style waitstatus.  */
1376 extern void store_waitstatus (struct target_waitstatus *, int);
1377
1378 /* These are in common/signals.c, but they're only used by gdb.  */
1379 extern enum target_signal default_target_signal_from_host (struct gdbarch *,
1380                                                            int);
1381 extern int default_target_signal_to_host (struct gdbarch *,
1382                                           enum target_signal);
1383
1384 /* Convert from a number used in a GDB command to an enum target_signal.  */
1385 extern enum target_signal target_signal_from_command (int);
1386 /* End of files in common/signals.c.  */
1387
1388 /* Set the show memory breakpoints mode to show, and installs a cleanup
1389    to restore it back to the current value.  */
1390 extern struct cleanup *make_show_memory_breakpoints_cleanup (int show);
1391
1392 \f
1393 /* Imported from machine dependent code */
1394
1395 /* Blank target vector entries are initialized to target_ignore. */
1396 void target_ignore (void);
1397
1398 extern struct target_ops deprecated_child_ops;
1399
1400 #endif /* !defined (TARGET_H) */