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