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