gdb/target.h

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