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