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