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