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