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
   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 /* Possible types of events that the inferior handler will have to
 155    deal with.  */
 156 enum inferior_event_type
 157   {
 158     /* There is a request to quit the inferior, abandon it.  */
 159     INF_QUIT_REQ,
 160     /* Process a normal inferior event which will result in target_wait
 161        being called.  */
 162     INF_REG_EVENT,
 163     /* Deal with an error on the inferior.  */
 164     INF_ERROR,
 165     /* We are called because a timer went off.  */
 166     INF_TIMER,
 167     /* We are called to do stuff after the inferior stops.  */
 168     INF_EXEC_COMPLETE,
 169     /* We are called to do some stuff after the inferior stops, but we
 170        are expected to reenter the proceed() and
 171        handle_inferior_event() functions. This is used only in case of
 172        'step n' like commands.  */
 173     INF_EXEC_CONTINUE
 174   };
 175
 176 /* Return the string for a signal.  */
 177 extern char *target_signal_to_string (enum target_signal);
 178
 179 /* Return the name (SIGHUP, etc.) for a signal.  */
 180 extern char *target_signal_to_name (enum target_signal);
 181
 182 /* Given a name (SIGHUP, etc.), return its signal.  */
 183 enum target_signal target_signal_from_name (char *);
 184 \f
 185 /* Target objects which can be transfered using target_read,
 186    target_write, et cetera.  */
 187
 188 enum target_object
 189 {
 190   /* AVR target specific transfer.  See "avr-tdep.c" and "remote.c".  */
 191   TARGET_OBJECT_AVR,
 192   /* SPU target specific transfer.  See "spu-tdep.c".  */
 193   TARGET_OBJECT_SPU,
 194   /* Transfer up-to LEN bytes of memory starting at OFFSET.  */
 195   TARGET_OBJECT_MEMORY,
 196   /* Memory, avoiding GDB's data cache and trusting the executable.
 197      Target implementations of to_xfer_partial never need to handle
 198      this object, and most callers should not use it.  */
 199   TARGET_OBJECT_RAW_MEMORY,
 200   /* Kernel Unwind Table.  See "ia64-tdep.c".  */
 201   TARGET_OBJECT_UNWIND_TABLE,
 202   /* Transfer auxilliary vector.  */
 203   TARGET_OBJECT_AUXV,
 204   /* StackGhost cookie.  See "sparc-tdep.c".  */
 205   TARGET_OBJECT_WCOOKIE,
 206   /* Target memory map in XML format.  */
 207   TARGET_OBJECT_MEMORY_MAP,
 208   /* Flash memory.  This object can be used to write contents to
 209      a previously erased flash memory.  Using it without erasing
 210      flash can have unexpected results.  Addresses are physical
 211      address on target, and not relative to flash start.  */
 212   TARGET_OBJECT_FLASH,
 213   /* Available target-specific features, e.g. registers and coprocessors.
 214      See "target-descriptions.c".  ANNEX should never be empty.  */
 215   TARGET_OBJECT_AVAILABLE_FEATURES,
 216   /* Currently loaded libraries, in XML format.  */
 217   TARGET_OBJECT_LIBRARIES,
 218   /* Get OS specific data.  The ANNEX specifies the type (running
 219      processes, etc.).  */
 220   TARGET_OBJECT_OSDATA
 221   /* Possible future objects: TARGET_OBJECT_FILE, ... */
 222 };
 223
 224 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
 225    OBJECT.  The OFFSET, for a seekable object, specifies the
 226    starting point.  The ANNEX can be used to provide additional
 227    data-specific information to the target.
 228
 229    Return the number of bytes actually transfered, or -1 if the
 230    transfer is not supported or otherwise fails.  Return of a positive
 231    value less than LEN indicates that no further transfer is possible.
 232    Unlike the raw to_xfer_partial interface, callers of these
 233    functions do not need to retry partial transfers.  */
 234
 235 extern LONGEST target_read (struct target_ops *ops,
 236                             enum target_object object,
 237                             const char *annex, gdb_byte *buf,
 238                             ULONGEST offset, LONGEST len);
 239
 240 extern LONGEST target_read_until_error (struct target_ops *ops,
 241                                         enum target_object object,
 242                                         const char *annex, gdb_byte *buf,
 243                                         ULONGEST offset, LONGEST len);
 244
 245 extern LONGEST target_write (struct target_ops *ops,
 246                              enum target_object object,
 247                              const char *annex, const gdb_byte *buf,
 248                              ULONGEST offset, LONGEST len);
 249
 250 /* Similar to target_write, except that it also calls PROGRESS with
 251    the number of bytes written and the opaque BATON after every
 252    successful partial write (and before the first write).  This is
 253    useful for progress reporting and user interaction while writing
 254    data.  To abort the transfer, the progress callback can throw an
 255    exception.  */
 256
 257 LONGEST target_write_with_progress (struct target_ops *ops,
 258                                     enum target_object object,
 259                                     const char *annex, const gdb_byte *buf,
 260                                     ULONGEST offset, LONGEST len,
 261                                     void (*progress) (ULONGEST, void *),
 262                                     void *baton);
 263
 264 /* Wrapper to perform a full read of unknown size.  OBJECT/ANNEX will
 265    be read using OPS.  The return value will be -1 if the transfer
 266    fails or is not supported; 0 if the object is empty; or the length
 267    of the object otherwise.  If a positive value is returned, a
 268    sufficiently large buffer will be allocated using xmalloc and
 269    returned in *BUF_P containing the contents of the object.
 270
 271    This method should be used for objects sufficiently small to store
 272    in a single xmalloc'd buffer, when no fixed bound on the object's
 273    size is known in advance.  Don't try to read TARGET_OBJECT_MEMORY
 274    through this function.  */
 275
 276 extern LONGEST target_read_alloc (struct target_ops *ops,
 277                                   enum target_object object,
 278                                   const char *annex, gdb_byte **buf_p);
 279
 280 /* Read OBJECT/ANNEX using OPS.  The result is NUL-terminated and
 281    returned as a string, allocated using xmalloc.  If an error occurs
 282    or the transfer is unsupported, NULL is returned.  Empty objects
 283    are returned as allocated but empty strings.  A warning is issued
 284    if the result contains any embedded NUL bytes.  */
 285
 286 extern char *target_read_stralloc (struct target_ops *ops,
 287                                    enum target_object object,
 288                                    const char *annex);
 289
 290 /* Wrappers to target read/write that perform memory transfers.  They
 291    throw an error if the memory transfer fails.
 292
 293    NOTE: cagney/2003-10-23: The naming schema is lifted from
 294    "frame.h".  The parameter order is lifted from get_frame_memory,
 295    which in turn lifted it from read_memory.  */
 296
 297 extern void get_target_memory (struct target_ops *ops, CORE_ADDR addr,
 298                                gdb_byte *buf, LONGEST len);
 299 extern ULONGEST get_target_memory_unsigned (struct target_ops *ops,
 300                                             CORE_ADDR addr, int len);
 301 \f
 302
 303 /* If certain kinds of activity happen, target_wait should perform
 304    callbacks.  */
 305 /* Right now we just call (*TARGET_ACTIVITY_FUNCTION) if I/O is possible
 306    on TARGET_ACTIVITY_FD.  */
 307 extern int target_activity_fd;
 308 /* Returns zero to leave the inferior alone, one to interrupt it.  */
 309 extern int (*target_activity_function) (void);
 310 \f
 311 struct thread_info;             /* fwd decl for parameter list below: */
 312
 313 struct target_ops
 314   {
 315     struct target_ops *beneath; /* To the target under this one.  */
 316     char *to_shortname;         /* Name this target type */
 317     char *to_longname;          /* Name for printing */
 318     char *to_doc;               /* Documentation.  Does not include trailing
 319                                    newline, and starts with a one-line descrip-
 320                                    tion (probably similar to to_longname).  */
 321     /* Per-target scratch pad.  */
 322     void *to_data;
 323     /* The open routine takes the rest of the parameters from the
 324        command, and (if successful) pushes a new target onto the
 325        stack.  Targets should supply this routine, if only to provide
 326        an error message.  */
 327     void (*to_open) (char *, int);
 328     /* Old targets with a static target vector provide "to_close".
 329        New re-entrant targets provide "to_xclose" and that is expected
 330        to xfree everything (including the "struct target_ops").  */
 331     void (*to_xclose) (struct target_ops *targ, int quitting);
 332     void (*to_close) (int);
 333     void (*to_attach) (struct target_ops *ops, char *, int);
 334     void (*to_post_attach) (int);
 335     void (*to_detach) (struct target_ops *ops, char *, int);
 336     void (*to_disconnect) (struct target_ops *, char *, int);
 337     void (*to_resume) (ptid_t, int, enum target_signal);
 338     ptid_t (*to_wait) (ptid_t, struct target_waitstatus *);
 339     void (*to_fetch_registers) (struct regcache *, int);
 340     void (*to_store_registers) (struct regcache *, int);
 341     void (*to_prepare_to_store) (struct regcache *);
 342
 343     /* Transfer LEN bytes of memory between GDB address MYADDR and
 344        target address MEMADDR.  If WRITE, transfer them to the target, else
 345        transfer them from the target.  TARGET is the target from which we
 346        get this function.
 347
 348        Return value, N, is one of the following:
 349
 350        0 means that we can't handle this.  If errno has been set, it is the
 351        error which prevented us from doing it (FIXME: What about bfd_error?).
 352
 353        positive (call it N) means that we have transferred N bytes
 354        starting at MEMADDR.  We might be able to handle more bytes
 355        beyond this length, but no promises.
 356
 357        negative (call its absolute value N) means that we cannot
 358        transfer right at MEMADDR, but we could transfer at least
 359        something at MEMADDR + N.
 360
 361        NOTE: cagney/2004-10-01: This has been entirely superseeded by
 362        to_xfer_partial and inferior inheritance.  */
 363
 364     int (*deprecated_xfer_memory) (CORE_ADDR memaddr, gdb_byte *myaddr,
 365                                    int len, int write,
 366                                    struct mem_attrib *attrib,
 367                                    struct target_ops *target);
 368
 369     void (*to_files_info) (struct target_ops *);
 370     int (*to_insert_breakpoint) (struct bp_target_info *);
 371     int (*to_remove_breakpoint) (struct bp_target_info *);
 372     int (*to_can_use_hw_breakpoint) (int, int, int);
 373     int (*to_insert_hw_breakpoint) (struct bp_target_info *);
 374     int (*to_remove_hw_breakpoint) (struct bp_target_info *);
 375     int (*to_remove_watchpoint) (CORE_ADDR, int, int);
 376     int (*to_insert_watchpoint) (CORE_ADDR, int, int);
 377     int (*to_stopped_by_watchpoint) (void);
 378     int to_have_steppable_watchpoint;
 379     int to_have_continuable_watchpoint;
 380     int (*to_stopped_data_address) (struct target_ops *, CORE_ADDR *);
 381     int (*to_watchpoint_addr_within_range) (struct target_ops *,
 382                                             CORE_ADDR, CORE_ADDR, int);
 383     int (*to_region_ok_for_hw_watchpoint) (CORE_ADDR, int);
 384     void (*to_terminal_init) (void);
 385     void (*to_terminal_inferior) (void);
 386     void (*to_terminal_ours_for_output) (void);
 387     void (*to_terminal_ours) (void);
 388     void (*to_terminal_save_ours) (void);
 389     void (*to_terminal_info) (char *, int);
 390     void (*to_kill) (void);
 391     void (*to_load) (char *, int);
 392     int (*to_lookup_symbol) (char *, CORE_ADDR *);
 393     void (*to_create_inferior) (struct target_ops *,
 394                                 char *, char *, char **, int);
 395     void (*to_post_startup_inferior) (ptid_t);
 396     void (*to_acknowledge_created_inferior) (int);
 397     void (*to_insert_fork_catchpoint) (int);
 398     int (*to_remove_fork_catchpoint) (int);
 399     void (*to_insert_vfork_catchpoint) (int);
 400     int (*to_remove_vfork_catchpoint) (int);
 401     int (*to_follow_fork) (struct target_ops *, int);
 402     void (*to_insert_exec_catchpoint) (int);
 403     int (*to_remove_exec_catchpoint) (int);
 404     int (*to_has_exited) (int, int, int *);
 405     void (*to_mourn_inferior) (struct target_ops *);
 406     int (*to_can_run) (void);
 407     void (*to_notice_signals) (ptid_t ptid);
 408     int (*to_thread_alive) (ptid_t ptid);
 409     void (*to_find_new_threads) (void);
 410     char *(*to_pid_to_str) (ptid_t);
 411     char *(*to_extra_thread_info) (struct thread_info *);
 412     void (*to_stop) (ptid_t);
 413     void (*to_rcmd) (char *command, struct ui_file *output);
 414     char *(*to_pid_to_exec_file) (int pid);
 415     void (*to_log_command) (const char *);
 416     enum strata to_stratum;
 417     int to_has_all_memory;
 418     int to_has_memory;
 419     int to_has_stack;
 420     int to_has_registers;
 421     int to_has_execution;
 422     int to_has_thread_control;  /* control thread execution */
 423     int to_attach_no_wait;
 424     struct section_table
 425      *to_sections;
 426     struct section_table
 427      *to_sections_end;
 428     /* ASYNC target controls */
 429     int (*to_can_async_p) (void);
 430     int (*to_is_async_p) (void);
 431     void (*to_async) (void (*) (enum inferior_event_type, void *), void *);
 432     int (*to_async_mask) (int);
 433     int (*to_supports_non_stop) (void);
 434     int (*to_find_memory_regions) (int (*) (CORE_ADDR,
 435                                             unsigned long,
 436                                             int, int, int,
 437                                             void *),
 438                                    void *);
 439     char * (*to_make_corefile_notes) (bfd *, int *);
 440
 441     /* Return the thread-local address at OFFSET in the
 442        thread-local storage for the thread PTID and the shared library
 443        or executable file given by OBJFILE.  If that block of
 444        thread-local storage hasn't been allocated yet, this function
 445        may return an error.  */
 446     CORE_ADDR (*to_get_thread_local_address) (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 #define target_wait(ptid, status)               \
 634      (*current_target.to_wait) (ptid, status)
 635
 636 /* Fetch at least register REGNO, or all regs if regno == -1.  No result.  */
 637
 638 #define target_fetch_registers(regcache, regno) \
 639      (*current_target.to_fetch_registers) (regcache, regno)
 640
 641 /* Store at least register REGNO, or all regs if REGNO == -1.
 642    It can store as many registers as it wants to, so target_prepare_to_store
 643    must have been previously called.  Calls error() if there are problems.  */
 644
 645 #define target_store_registers(regcache, regs)  \
 646      (*current_target.to_store_registers) (regcache, regs)
 647
 648 /* Get ready to modify the registers array.  On machines which store
 649    individual registers, this doesn't need to do anything.  On machines
 650    which store all the registers in one fell swoop, this makes sure
 651    that REGISTERS contains all the registers from the program being
 652    debugged.  */
 653
 654 #define target_prepare_to_store(regcache)       \
 655      (*current_target.to_prepare_to_store) (regcache)
 656
 657 /* Returns true if this target can debug multiple processes
 658    simultaneously.  */
 659
 660 #define target_supports_multi_process() \
 661      (*current_target.to_supports_multi_process) ()
 662
 663 extern DCACHE *target_dcache;
 664
 665 extern int target_read_string (CORE_ADDR, char **, int, int *);
 666
 667 extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr, int len);
 668
 669 extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
 670                                 int len);
 671
 672 extern int xfer_memory (CORE_ADDR, gdb_byte *, int, int,
 673                         struct mem_attrib *, struct target_ops *);
 674
 675 /* Fetches the target's memory map.  If one is found it is sorted
 676    and returned, after some consistency checking.  Otherwise, NULL
 677    is returned.  */
 678 VEC(mem_region_s) *target_memory_map (void);
 679
 680 /* Erase the specified flash region.  */
 681 void target_flash_erase (ULONGEST address, LONGEST length);
 682
 683 /* Finish a sequence of flash operations.  */
 684 void target_flash_done (void);
 685
 686 /* Describes a request for a memory write operation.  */
 687 struct memory_write_request
 688   {
 689     /* Begining address that must be written. */
 690     ULONGEST begin;
 691     /* Past-the-end address. */
 692     ULONGEST end;
 693     /* The data to write. */
 694     gdb_byte *data;
 695     /* A callback baton for progress reporting for this request.  */
 696     void *baton;
 697   };
 698 typedef struct memory_write_request memory_write_request_s;
 699 DEF_VEC_O(memory_write_request_s);
 700
 701 /* Enumeration specifying different flash preservation behaviour.  */
 702 enum flash_preserve_mode
 703   {
 704     flash_preserve,
 705     flash_discard
 706   };
 707
 708 /* Write several memory blocks at once.  This version can be more
 709    efficient than making several calls to target_write_memory, in
 710    particular because it can optimize accesses to flash memory.
 711
 712    Moreover, this is currently the only memory access function in gdb
 713    that supports writing to flash memory, and it should be used for
 714    all cases where access to flash memory is desirable.
 715
 716    REQUESTS is the vector (see vec.h) of memory_write_request.
 717    PRESERVE_FLASH_P indicates what to do with blocks which must be
 718      erased, but not completely rewritten.
 719    PROGRESS_CB is a function that will be periodically called to provide
 720      feedback to user.  It will be called with the baton corresponding
 721      to the request currently being written.  It may also be called
 722      with a NULL baton, when preserved flash sectors are being rewritten.
 723
 724    The function returns 0 on success, and error otherwise.  */
 725 int target_write_memory_blocks (VEC(memory_write_request_s) *requests,
 726                                 enum flash_preserve_mode preserve_flash_p,
 727                                 void (*progress_cb) (ULONGEST, void *));
 728
 729 /* From infrun.c.  */
 730
 731 extern int inferior_has_forked (ptid_t pid, ptid_t *child_pid);
 732
 733 extern int inferior_has_vforked (ptid_t pid, ptid_t *child_pid);
 734
 735 extern int inferior_has_execd (ptid_t pid, char **execd_pathname);
 736
 737 /* From exec.c */
 738
 739 extern void print_section_info (struct target_ops *, bfd *);
 740
 741 /* Print a line about the current target.  */
 742
 743 #define target_files_info()     \
 744      (*current_target.to_files_info) (&current_target)
 745
 746 /* Insert a breakpoint at address BP_TGT->placed_address in the target
 747    machine.  Result is 0 for success, or an errno value.  */
 748
 749 #define target_insert_breakpoint(bp_tgt)        \
 750      (*current_target.to_insert_breakpoint) (bp_tgt)
 751
 752 /* Remove a breakpoint at address BP_TGT->placed_address in the target
 753    machine.  Result is 0 for success, or an errno value.  */
 754
 755 #define target_remove_breakpoint(bp_tgt)        \
 756      (*current_target.to_remove_breakpoint) (bp_tgt)
 757
 758 /* Initialize the terminal settings we record for the inferior,
 759    before we actually run the inferior.  */
 760
 761 #define target_terminal_init() \
 762      (*current_target.to_terminal_init) ()
 763
 764 /* Put the inferior's terminal settings into effect.
 765    This is preparation for starting or resuming the inferior.  */
 766
 767 #define target_terminal_inferior() \
 768      (*current_target.to_terminal_inferior) ()
 769
 770 /* Put some of our terminal settings into effect,
 771    enough to get proper results from our output,
 772    but do not change into or out of RAW mode
 773    so that no input is discarded.
 774
 775    After doing this, either terminal_ours or terminal_inferior
 776    should be called to get back to a normal state of affairs.  */
 777
 778 #define target_terminal_ours_for_output() \
 779      (*current_target.to_terminal_ours_for_output) ()
 780
 781 /* Put our terminal settings into effect.
 782    First record the inferior's terminal settings
 783    so they can be restored properly later.  */
 784
 785 #define target_terminal_ours() \
 786      (*current_target.to_terminal_ours) ()
 787
 788 /* Save our terminal settings.
 789    This is called from TUI after entering or leaving the curses
 790    mode.  Since curses modifies our terminal this call is here
 791    to take this change into account.  */
 792
 793 #define target_terminal_save_ours() \
 794      (*current_target.to_terminal_save_ours) ()
 795
 796 /* Print useful information about our terminal status, if such a thing
 797    exists.  */
 798
 799 #define target_terminal_info(arg, from_tty) \
 800      (*current_target.to_terminal_info) (arg, from_tty)
 801
 802 /* Kill the inferior process.   Make it go away.  */
 803
 804 #define target_kill() \
 805      (*current_target.to_kill) ()
 806
 807 /* Load an executable file into the target process.  This is expected
 808    to not only bring new code into the target process, but also to
 809    update GDB's symbol tables to match.
 810
 811    ARG contains command-line arguments, to be broken down with
 812    buildargv ().  The first non-switch argument is the filename to
 813    load, FILE; the second is a number (as parsed by strtoul (..., ...,
 814    0)), which is an offset to apply to the load addresses of FILE's
 815    sections.  The target may define switches, or other non-switch
 816    arguments, as it pleases.  */
 817
 818 extern void target_load (char *arg, int from_tty);
 819
 820 /* Look up a symbol in the target's symbol table.  NAME is the symbol
 821    name.  ADDRP is a CORE_ADDR * pointing to where the value of the
 822    symbol should be returned.  The result is 0 if successful, nonzero
 823    if the symbol does not exist in the target environment.  This
 824    function should not call error() if communication with the target
 825    is interrupted, since it is called from symbol reading, but should
 826    return nonzero, possibly doing a complain().  */
 827
 828 #define target_lookup_symbol(name, addrp) \
 829      (*current_target.to_lookup_symbol) (name, addrp)
 830
 831 /* Start an inferior process and set inferior_ptid to its pid.
 832    EXEC_FILE is the file to run.
 833    ALLARGS is a string containing the arguments to the program.
 834    ENV is the environment vector to pass.  Errors reported with error().
 835    On VxWorks and various standalone systems, we ignore exec_file.  */
 836
 837 void target_create_inferior (char *exec_file, char *args,
 838                              char **env, int from_tty);
 839
 840 /* Some targets (such as ttrace-based HPUX) don't allow us to request
 841    notification of inferior events such as fork and vork immediately
 842    after the inferior is created.  (This because of how gdb gets an
 843    inferior created via invoking a shell to do it.  In such a scenario,
 844    if the shell init file has commands in it, the shell will fork and
 845    exec for each of those commands, and we will see each such fork
 846    event.  Very bad.)
 847
 848    Such targets will supply an appropriate definition for this function.  */
 849
 850 #define target_post_startup_inferior(ptid) \
 851      (*current_target.to_post_startup_inferior) (ptid)
 852
 853 /* On some targets, the sequence of starting up an inferior requires
 854    some synchronization between gdb and the new inferior process, PID.  */
 855
 856 #define target_acknowledge_created_inferior(pid) \
 857      (*current_target.to_acknowledge_created_inferior) (pid)
 858
 859 /* On some targets, we can catch an inferior fork or vfork event when
 860    it occurs.  These functions insert/remove an already-created
 861    catchpoint for such events.  */
 862
 863 #define target_insert_fork_catchpoint(pid) \
 864      (*current_target.to_insert_fork_catchpoint) (pid)
 865
 866 #define target_remove_fork_catchpoint(pid) \
 867      (*current_target.to_remove_fork_catchpoint) (pid)
 868
 869 #define target_insert_vfork_catchpoint(pid) \
 870      (*current_target.to_insert_vfork_catchpoint) (pid)
 871
 872 #define target_remove_vfork_catchpoint(pid) \
 873      (*current_target.to_remove_vfork_catchpoint) (pid)
 874
 875 /* If the inferior forks or vforks, this function will be called at
 876    the next resume in order to perform any bookkeeping and fiddling
 877    necessary to continue debugging either the parent or child, as
 878    requested, and releasing the other.  Information about the fork
 879    or vfork event is available via get_last_target_status ().
 880    This function returns 1 if the inferior should not be resumed
 881    (i.e. there is another event pending).  */
 882
 883 int target_follow_fork (int follow_child);
 884
 885 /* On some targets, we can catch an inferior exec event when it
 886    occurs.  These functions insert/remove an already-created
 887    catchpoint for such events.  */
 888
 889 #define target_insert_exec_catchpoint(pid) \
 890      (*current_target.to_insert_exec_catchpoint) (pid)
 891
 892 #define target_remove_exec_catchpoint(pid) \
 893      (*current_target.to_remove_exec_catchpoint) (pid)
 894
 895 /* Returns TRUE if PID has exited.  And, also sets EXIT_STATUS to the
 896    exit code of PID, if any.  */
 897
 898 #define target_has_exited(pid,wait_status,exit_status) \
 899      (*current_target.to_has_exited) (pid,wait_status,exit_status)
 900
 901 /* The debugger has completed a blocking wait() call.  There is now
 902    some process event that must be processed.  This function should
 903    be defined by those targets that require the debugger to perform
 904    cleanup or internal state changes in response to the process event.  */
 905
 906 /* The inferior process has died.  Do what is right.  */
 907
 908 void target_mourn_inferior (void);
 909
 910 /* Does target have enough data to do a run or attach command? */
 911
 912 #define target_can_run(t) \
 913      ((t)->to_can_run) ()
 914
 915 /* post process changes to signal handling in the inferior.  */
 916
 917 #define target_notice_signals(ptid) \
 918      (*current_target.to_notice_signals) (ptid)
 919
 920 /* Check to see if a thread is still alive.  */
 921
 922 #define target_thread_alive(ptid) \
 923      (*current_target.to_thread_alive) (ptid)
 924
 925 /* Query for new threads and add them to the thread list.  */
 926
 927 #define target_find_new_threads() \
 928      (*current_target.to_find_new_threads) ()
 929
 930 /* Make target stop in a continuable fashion.  (For instance, under
 931    Unix, this should act like SIGSTOP).  This function is normally
 932    used by GUIs to implement a stop button.  */
 933
 934 #define target_stop(ptid) (*current_target.to_stop) (ptid)
 935
 936 /* Send the specified COMMAND to the target's monitor
 937    (shell,interpreter) for execution.  The result of the query is
 938    placed in OUTBUF.  */
 939
 940 #define target_rcmd(command, outbuf) \
 941      (*current_target.to_rcmd) (command, outbuf)
 942
 943
 944 /* Does the target include all of memory, or only part of it?  This
 945    determines whether we look up the target chain for other parts of
 946    memory if this target can't satisfy a request.  */
 947
 948 #define target_has_all_memory   \
 949      (current_target.to_has_all_memory)
 950
 951 /* Does the target include memory?  (Dummy targets don't.)  */
 952
 953 #define target_has_memory       \
 954      (current_target.to_has_memory)
 955
 956 /* Does the target have a stack?  (Exec files don't, VxWorks doesn't, until
 957    we start a process.)  */
 958
 959 #define target_has_stack        \
 960      (current_target.to_has_stack)
 961
 962 /* Does the target have registers?  (Exec files don't.)  */
 963
 964 #define target_has_registers    \
 965      (current_target.to_has_registers)
 966
 967 /* Does the target have execution?  Can we make it jump (through
 968    hoops), or pop its stack a few times?  This means that the current
 969    target is currently executing; for some targets, that's the same as
 970    whether or not the target is capable of execution, but there are
 971    also targets which can be current while not executing.  In that
 972    case this will become true after target_create_inferior or
 973    target_attach.  */
 974
 975 #define target_has_execution    \
 976      (current_target.to_has_execution)
 977
 978 /* Can the target support the debugger control of thread execution?
 979    Can it lock the thread scheduler?  */
 980
 981 #define target_can_lock_scheduler \
 982      (current_target.to_has_thread_control & tc_schedlock)
 983
 984 /* Should the target enable async mode if it is supported?  Temporary
 985    cludge until async mode is a strict superset of sync mode.  */
 986 extern int target_async_permitted;
 987
 988 /* Can the target support asynchronous execution? */
 989 #define target_can_async_p() (current_target.to_can_async_p ())
 990
 991 /* Is the target in asynchronous execution mode? */
 992 #define target_is_async_p() (current_target.to_is_async_p ())
 993
 994 int target_supports_non_stop (void);
 995
 996 /* Put the target in async mode with the specified callback function. */
 997 #define target_async(CALLBACK,CONTEXT) \
 998      (current_target.to_async ((CALLBACK), (CONTEXT)))
 999
1000 /* This is to be used ONLY within call_function_by_hand(). It provides
1001    a workaround, to have inferior function calls done in sychronous
1002    mode, even though the target is asynchronous. After
1003    target_async_mask(0) is called, calls to target_can_async_p() will
1004    return FALSE , so that target_resume() will not try to start the
1005    target asynchronously. After the inferior stops, we IMMEDIATELY
1006    restore the previous nature of the target, by calling
1007    target_async_mask(1). After that, target_can_async_p() will return
1008    TRUE. ANY OTHER USE OF THIS FEATURE IS DEPRECATED.
1009
1010    FIXME ezannoni 1999-12-13: we won't need this once we move
1011    the turning async on and off to the single execution commands,
1012    from where it is done currently, in remote_resume().  */
1013
1014 #define target_async_mask(MASK) \
1015   (current_target.to_async_mask (MASK))
1016
1017 /* Converts a process id to a string.  Usually, the string just contains
1018    `process xyz', but on some systems it may contain
1019    `process xyz thread abc'.  */
1020
1021 #undef target_pid_to_str
1022 #define target_pid_to_str(PID) current_target.to_pid_to_str (PID)
1023
1024 #ifndef target_tid_to_str
1025 #define target_tid_to_str(PID) \
1026      target_pid_to_str (PID)
1027 extern char *normal_pid_to_str (ptid_t ptid);
1028 #endif
1029
1030 /* Return a short string describing extra information about PID,
1031    e.g. "sleeping", "runnable", "running on LWP 3".  Null return value
1032    is okay.  */
1033
1034 #define target_extra_thread_info(TP) \
1035      (current_target.to_extra_thread_info (TP))
1036
1037 /* Attempts to find the pathname of the executable file
1038    that was run to create a specified process.
1039
1040    The process PID must be stopped when this operation is used.
1041
1042    If the executable file cannot be determined, NULL is returned.
1043
1044    Else, a pointer to a character string containing the pathname
1045    is returned.  This string should be copied into a buffer by
1046    the client if the string will not be immediately used, or if
1047    it must persist.  */
1048
1049 #define target_pid_to_exec_file(pid) \
1050      (current_target.to_pid_to_exec_file) (pid)
1051
1052 /*
1053  * Iterator function for target memory regions.
1054  * Calls a callback function once for each memory region 'mapped'
1055  * in the child process.  Defined as a simple macro rather than
1056  * as a function macro so that it can be tested for nullity.
1057  */
1058
1059 #define target_find_memory_regions(FUNC, DATA) \
1060      (current_target.to_find_memory_regions) (FUNC, DATA)
1061
1062 /*
1063  * Compose corefile .note section.
1064  */
1065
1066 #define target_make_corefile_notes(BFD, SIZE_P) \
1067      (current_target.to_make_corefile_notes) (BFD, SIZE_P)
1068
1069 /* Thread-local values.  */
1070 #define target_get_thread_local_address \
1071     (current_target.to_get_thread_local_address)
1072 #define target_get_thread_local_address_p() \
1073     (target_get_thread_local_address != NULL)
1074
1075
1076 /* Hardware watchpoint interfaces.  */
1077
1078 /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1079    write).  */
1080
1081 #ifndef STOPPED_BY_WATCHPOINT
1082 #define STOPPED_BY_WATCHPOINT(w) \
1083    (*current_target.to_stopped_by_watchpoint) ()
1084 #endif
1085
1086 /* Non-zero if we have steppable watchpoints  */
1087
1088 #ifndef HAVE_STEPPABLE_WATCHPOINT
1089 #define HAVE_STEPPABLE_WATCHPOINT \
1090    (current_target.to_have_steppable_watchpoint)
1091 #endif
1092
1093 /* Non-zero if we have continuable watchpoints  */
1094
1095 #ifndef HAVE_CONTINUABLE_WATCHPOINT
1096 #define HAVE_CONTINUABLE_WATCHPOINT \
1097    (current_target.to_have_continuable_watchpoint)
1098 #endif
1099
1100 /* Provide defaults for hardware watchpoint functions.  */
1101
1102 /* If the *_hw_beakpoint functions have not been defined
1103    elsewhere use the definitions in the target vector.  */
1104
1105 /* Returns non-zero if we can set a hardware watchpoint of type TYPE.  TYPE is
1106    one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1107    bp_hardware_breakpoint.  CNT is the number of such watchpoints used so far
1108    (including this one?).  OTHERTYPE is who knows what...  */
1109
1110 #ifndef TARGET_CAN_USE_HARDWARE_WATCHPOINT
1111 #define TARGET_CAN_USE_HARDWARE_WATCHPOINT(TYPE,CNT,OTHERTYPE) \
1112  (*current_target.to_can_use_hw_breakpoint) (TYPE, CNT, OTHERTYPE);
1113 #endif
1114
1115 #ifndef TARGET_REGION_OK_FOR_HW_WATCHPOINT
1116 #define TARGET_REGION_OK_FOR_HW_WATCHPOINT(addr, len) \
1117     (*current_target.to_region_ok_for_hw_watchpoint) (addr, len)
1118 #endif
1119
1120
1121 /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.  TYPE is 0
1122    for write, 1 for read, and 2 for read/write accesses.  Returns 0 for
1123    success, non-zero for failure.  */
1124
1125 #ifndef target_insert_watchpoint
1126 #define target_insert_watchpoint(addr, len, type)       \
1127      (*current_target.to_insert_watchpoint) (addr, len, type)
1128
1129 #define target_remove_watchpoint(addr, len, type)       \
1130      (*current_target.to_remove_watchpoint) (addr, len, type)
1131 #endif
1132
1133 #ifndef target_insert_hw_breakpoint
1134 #define target_insert_hw_breakpoint(bp_tgt) \
1135      (*current_target.to_insert_hw_breakpoint) (bp_tgt)
1136
1137 #define target_remove_hw_breakpoint(bp_tgt) \
1138      (*current_target.to_remove_hw_breakpoint) (bp_tgt)
1139 #endif
1140
1141 extern int target_stopped_data_address_p (struct target_ops *);
1142
1143 #ifndef target_stopped_data_address
1144 #define target_stopped_data_address(target, x) \
1145     (*target.to_stopped_data_address) (target, x)
1146 #else
1147 /* Horrible hack to get around existing macros :-(.  */
1148 #define target_stopped_data_address_p(CURRENT_TARGET) (1)
1149 #endif
1150
1151 #define target_watchpoint_addr_within_range(target, addr, start, length) \
1152   (*target.to_watchpoint_addr_within_range) (target, addr, start, length)
1153
1154 /* Target can execute in reverse?  */
1155 #define target_can_execute_reverse \
1156      (current_target.to_can_execute_reverse ? \
1157       current_target.to_can_execute_reverse () : 0)
1158
1159 extern const struct target_desc *target_read_description (struct target_ops *);
1160
1161 #define target_get_ada_task_ptid(lwp, tid) \
1162      (*current_target.to_get_ada_task_ptid) (lwp,tid)
1163
1164 /* Utility implementation of searching memory.  */
1165 extern int simple_search_memory (struct target_ops* ops,
1166                                  CORE_ADDR start_addr,
1167                                  ULONGEST search_space_len,
1168                                  const gdb_byte *pattern,
1169                                  ULONGEST pattern_len,
1170                                  CORE_ADDR *found_addrp);
1171
1172 /* Main entry point for searching memory.  */
1173 extern int target_search_memory (CORE_ADDR start_addr,
1174                                  ULONGEST search_space_len,
1175                                  const gdb_byte *pattern,
1176                                  ULONGEST pattern_len,
1177                                  CORE_ADDR *found_addrp);
1178
1179 /* Command logging facility.  */
1180
1181 #define target_log_command(p)                                           \
1182   do                                                                    \
1183     if (current_target.to_log_command)                                  \
1184       (*current_target.to_log_command) (p);                             \
1185   while (0)
1186
1187 /* Routines for maintenance of the target structures...
1188
1189    add_target:   Add a target to the list of all possible targets.
1190
1191    push_target:  Make this target the top of the stack of currently used
1192    targets, within its particular stratum of the stack.  Result
1193    is 0 if now atop the stack, nonzero if not on top (maybe
1194    should warn user).
1195
1196    unpush_target: Remove this from the stack of currently used targets,
1197    no matter where it is on the list.  Returns 0 if no
1198    change, 1 if removed from stack.
1199
1200    pop_target:   Remove the top thing on the stack of current targets.  */
1201
1202 extern void add_target (struct target_ops *);
1203
1204 extern int push_target (struct target_ops *);
1205
1206 extern int unpush_target (struct target_ops *);
1207
1208 extern void target_pre_inferior (int);
1209
1210 extern void target_preopen (int);
1211
1212 extern void pop_target (void);
1213
1214 /* Does whatever cleanup is required to get rid of all pushed targets.
1215    QUITTING is propagated to target_close; it indicates that GDB is
1216    exiting and should not get hung on an error (otherwise it is
1217    important to perform clean termination, even if it takes a
1218    while).  */
1219 extern void pop_all_targets (int quitting);
1220
1221 /* Like pop_all_targets, but pops only targets whose stratum is
1222    strictly above ABOVE_STRATUM.  */
1223 extern void pop_all_targets_above (enum strata above_stratum, int quitting);
1224
1225 extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
1226                                                CORE_ADDR offset);
1227
1228 /* Mark a pushed target as running or exited, for targets which do not
1229    automatically pop when not active.  */
1230
1231 void target_mark_running (struct target_ops *);
1232
1233 void target_mark_exited (struct target_ops *);
1234
1235 /* Struct section_table maps address ranges to file sections.  It is
1236    mostly used with BFD files, but can be used without (e.g. for handling
1237    raw disks, or files not in formats handled by BFD).  */
1238
1239 struct section_table
1240   {
1241     CORE_ADDR addr;             /* Lowest address in section */
1242     CORE_ADDR endaddr;          /* 1+highest address in section */
1243
1244     struct bfd_section *the_bfd_section;
1245
1246     bfd *bfd;                   /* BFD file pointer */
1247   };
1248
1249 /* Return the "section" containing the specified address.  */
1250 struct section_table *target_section_by_addr (struct target_ops *target,
1251                                               CORE_ADDR addr);
1252
1253
1254 /* From mem-break.c */
1255
1256 extern int memory_remove_breakpoint (struct bp_target_info *);
1257
1258 extern int memory_insert_breakpoint (struct bp_target_info *);
1259
1260 extern int default_memory_remove_breakpoint (struct gdbarch *, struct bp_target_info *);
1261
1262 extern int default_memory_insert_breakpoint (struct gdbarch *, struct bp_target_info *);
1263
1264
1265 /* From target.c */
1266
1267 extern void initialize_targets (void);
1268
1269 extern void noprocess (void);
1270
1271 extern void target_require_runnable (void);
1272
1273 extern void find_default_attach (struct target_ops *, char *, int);
1274
1275 extern void find_default_create_inferior (struct target_ops *,
1276                                           char *, char *, char **, int);
1277
1278 extern struct target_ops *find_run_target (void);
1279
1280 extern struct target_ops *find_core_target (void);
1281
1282 extern struct target_ops *find_target_beneath (struct target_ops *);
1283
1284 extern int target_resize_to_sections (struct target_ops *target,
1285                                       int num_added);
1286
1287 extern void remove_target_sections (bfd *abfd);
1288
1289 extern char *target_get_osdata (const char *type);
1290
1291 \f
1292 /* Stuff that should be shared among the various remote targets.  */
1293
1294 /* Debugging level.  0 is off, and non-zero values mean to print some debug
1295    information (higher values, more information).  */
1296 extern int remote_debug;
1297
1298 /* Speed in bits per second, or -1 which means don't mess with the speed.  */
1299 extern int baud_rate;
1300 /* Timeout limit for response from target. */
1301 extern int remote_timeout;
1302
1303 \f
1304 /* Functions for helping to write a native target.  */
1305
1306 /* This is for native targets which use a unix/POSIX-style waitstatus.  */
1307 extern void store_waitstatus (struct target_waitstatus *, int);
1308
1309 /* Predicate to target_signal_to_host(). Return non-zero if the enum
1310    targ_signal SIGNO has an equivalent ``host'' representation.  */
1311 /* FIXME: cagney/1999-11-22: The name below was chosen in preference
1312    to the shorter target_signal_p() because it is far less ambigious.
1313    In this context ``target_signal'' refers to GDB's internal
1314    representation of the target's set of signals while ``host signal''
1315    refers to the target operating system's signal.  Confused?  */
1316
1317 extern int target_signal_to_host_p (enum target_signal signo);
1318
1319 /* Convert between host signal numbers and enum target_signal's.
1320    target_signal_to_host() returns 0 and prints a warning() on GDB's
1321    console if SIGNO has no equivalent host representation.  */
1322 /* FIXME: cagney/1999-11-22: Here ``host'' is used incorrectly, it is
1323    refering to the target operating system's signal numbering.
1324    Similarly, ``enum target_signal'' is named incorrectly, ``enum
1325    gdb_signal'' would probably be better as it is refering to GDB's
1326    internal representation of a target operating system's signal.  */
1327
1328 extern enum target_signal target_signal_from_host (int);
1329 extern int target_signal_to_host (enum target_signal);
1330
1331 extern enum target_signal default_target_signal_from_host (struct gdbarch *,
1332                                                            int);
1333 extern int default_target_signal_to_host (struct gdbarch *,
1334                                           enum target_signal);
1335
1336 /* Convert from a number used in a GDB command to an enum target_signal.  */
1337 extern enum target_signal target_signal_from_command (int);
1338
1339 /* Set the show memory breakpoints mode to show, and installs a cleanup
1340    to restore it back to the current value.  */
1341 extern struct cleanup *make_show_memory_breakpoints_cleanup (int show);
1342
1343 \f
1344 /* Imported from machine dependent code */
1345
1346 /* Blank target vector entries are initialized to target_ignore. */
1347 void target_ignore (void);
1348
1349 extern struct target_ops deprecated_child_ops;
1350
1351 #endif /* !defined (TARGET_H) */