convert to_mourn_inferior
[platform/upstream/binutils.git] / gdb / target.h
1 /* Interface between GDB and target environments, including files and processes
2
3    Copyright (C) 1990-2014 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 struct dcache_struct;
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 "target/resume.h"
62 #include "target/wait.h"
63 #include "target/waitstatus.h"
64 #include "bfd.h"
65 #include "symtab.h"
66 #include "memattr.h"
67 #include "vec.h"
68 #include "gdb_signals.h"
69 #include "btrace.h"
70 #include "command.h"
71
72 enum strata
73   {
74     dummy_stratum,              /* The lowest of the low */
75     file_stratum,               /* Executable files, etc */
76     process_stratum,            /* Executing processes or core dump files */
77     thread_stratum,             /* Executing threads */
78     record_stratum,             /* Support record debugging */
79     arch_stratum                /* Architecture overrides */
80   };
81
82 enum thread_control_capabilities
83   {
84     tc_none = 0,                /* Default: can't control thread execution.  */
85     tc_schedlock = 1,           /* Can lock the thread scheduler.  */
86   };
87
88 /* The structure below stores information about a system call.
89    It is basically used in the "catch syscall" command, and in
90    every function that gives information about a system call.
91    
92    It's also good to mention that its fields represent everything
93    that we currently know about a syscall in GDB.  */
94 struct syscall
95   {
96     /* The syscall number.  */
97     int number;
98
99     /* The syscall name.  */
100     const char *name;
101   };
102
103 /* Return a pretty printed form of target_waitstatus.
104    Space for the result is malloc'd, caller must free.  */
105 extern char *target_waitstatus_to_string (const struct target_waitstatus *);
106
107 /* Return a pretty printed form of TARGET_OPTIONS.
108    Space for the result is malloc'd, caller must free.  */
109 extern char *target_options_to_string (int target_options);
110
111 /* Possible types of events that the inferior handler will have to
112    deal with.  */
113 enum inferior_event_type
114   {
115     /* Process a normal inferior event which will result in target_wait
116        being called.  */
117     INF_REG_EVENT,
118     /* We are called because a timer went off.  */
119     INF_TIMER,
120     /* We are called to do stuff after the inferior stops.  */
121     INF_EXEC_COMPLETE,
122     /* We are called to do some stuff after the inferior stops, but we
123        are expected to reenter the proceed() and
124        handle_inferior_event() functions.  This is used only in case of
125        'step n' like commands.  */
126     INF_EXEC_CONTINUE
127   };
128 \f
129 /* Target objects which can be transfered using target_read,
130    target_write, et cetera.  */
131
132 enum target_object
133 {
134   /* AVR target specific transfer.  See "avr-tdep.c" and "remote.c".  */
135   TARGET_OBJECT_AVR,
136   /* SPU target specific transfer.  See "spu-tdep.c".  */
137   TARGET_OBJECT_SPU,
138   /* Transfer up-to LEN bytes of memory starting at OFFSET.  */
139   TARGET_OBJECT_MEMORY,
140   /* Memory, avoiding GDB's data cache and trusting the executable.
141      Target implementations of to_xfer_partial never need to handle
142      this object, and most callers should not use it.  */
143   TARGET_OBJECT_RAW_MEMORY,
144   /* Memory known to be part of the target's stack.  This is cached even
145      if it is not in a region marked as such, since it is known to be
146      "normal" RAM.  */
147   TARGET_OBJECT_STACK_MEMORY,
148   /* Memory known to be part of the target code.   This is cached even
149      if it is not in a region marked as such.  */
150   TARGET_OBJECT_CODE_MEMORY,
151   /* Kernel Unwind Table.  See "ia64-tdep.c".  */
152   TARGET_OBJECT_UNWIND_TABLE,
153   /* Transfer auxilliary vector.  */
154   TARGET_OBJECT_AUXV,
155   /* StackGhost cookie.  See "sparc-tdep.c".  */
156   TARGET_OBJECT_WCOOKIE,
157   /* Target memory map in XML format.  */
158   TARGET_OBJECT_MEMORY_MAP,
159   /* Flash memory.  This object can be used to write contents to
160      a previously erased flash memory.  Using it without erasing
161      flash can have unexpected results.  Addresses are physical
162      address on target, and not relative to flash start.  */
163   TARGET_OBJECT_FLASH,
164   /* Available target-specific features, e.g. registers and coprocessors.
165      See "target-descriptions.c".  ANNEX should never be empty.  */
166   TARGET_OBJECT_AVAILABLE_FEATURES,
167   /* Currently loaded libraries, in XML format.  */
168   TARGET_OBJECT_LIBRARIES,
169   /* Currently loaded libraries specific for SVR4 systems, in XML format.  */
170   TARGET_OBJECT_LIBRARIES_SVR4,
171   /* Currently loaded libraries specific to AIX systems, in XML format.  */
172   TARGET_OBJECT_LIBRARIES_AIX,
173   /* Get OS specific data.  The ANNEX specifies the type (running
174      processes, etc.).  The data being transfered is expected to follow
175      the DTD specified in features/osdata.dtd.  */
176   TARGET_OBJECT_OSDATA,
177   /* Extra signal info.  Usually the contents of `siginfo_t' on unix
178      platforms.  */
179   TARGET_OBJECT_SIGNAL_INFO,
180   /* The list of threads that are being debugged.  */
181   TARGET_OBJECT_THREADS,
182   /* Collected static trace data.  */
183   TARGET_OBJECT_STATIC_TRACE_DATA,
184   /* The HP-UX registers (those that can be obtained or modified by using
185      the TT_LWP_RUREGS/TT_LWP_WUREGS ttrace requests).  */
186   TARGET_OBJECT_HPUX_UREGS,
187   /* The HP-UX shared library linkage pointer.  ANNEX should be a string
188      image of the code address whose linkage pointer we are looking for.
189
190      The size of the data transfered is always 8 bytes (the size of an
191      address on ia64).  */
192   TARGET_OBJECT_HPUX_SOLIB_GOT,
193   /* Traceframe info, in XML format.  */
194   TARGET_OBJECT_TRACEFRAME_INFO,
195   /* Load maps for FDPIC systems.  */
196   TARGET_OBJECT_FDPIC,
197   /* Darwin dynamic linker info data.  */
198   TARGET_OBJECT_DARWIN_DYLD_INFO,
199   /* OpenVMS Unwind Information Block.  */
200   TARGET_OBJECT_OPENVMS_UIB,
201   /* Branch trace data, in XML format.  */
202   TARGET_OBJECT_BTRACE
203   /* Possible future objects: TARGET_OBJECT_FILE, ...  */
204 };
205
206 /* Possible values returned by target_xfer_partial, etc.  */
207
208 enum target_xfer_status
209 {
210   /* Some bytes are transferred.  */
211   TARGET_XFER_OK = 1,
212
213   /* No further transfer is possible.  */
214   TARGET_XFER_EOF = 0,
215
216   /* Generic I/O error.  Note that it's important that this is '-1',
217      as we still have target_xfer-related code returning hardcoded
218      '-1' on error.  */
219   TARGET_XFER_E_IO = -1,
220
221   /* Transfer failed because the piece of the object requested is
222      unavailable.  */
223   TARGET_XFER_E_UNAVAILABLE = -2,
224
225   /* Keep list in sync with target_xfer_error_to_string.  */
226 };
227
228 #define TARGET_XFER_STATUS_ERROR_P(STATUS) ((STATUS) < TARGET_XFER_EOF)
229
230 /* Return the string form of ERR.  */
231
232 extern const char *target_xfer_status_to_string (enum target_xfer_status err);
233
234 /* Enumeration of the kinds of traceframe searches that a target may
235    be able to perform.  */
236
237 enum trace_find_type
238   {
239     tfind_number,
240     tfind_pc,
241     tfind_tp,
242     tfind_range,
243     tfind_outside,
244   };
245
246 typedef struct static_tracepoint_marker *static_tracepoint_marker_p;
247 DEF_VEC_P(static_tracepoint_marker_p);
248
249 typedef enum target_xfer_status
250   target_xfer_partial_ftype (struct target_ops *ops,
251                              enum target_object object,
252                              const char *annex,
253                              gdb_byte *readbuf,
254                              const gdb_byte *writebuf,
255                              ULONGEST offset,
256                              ULONGEST len,
257                              ULONGEST *xfered_len);
258
259 /* Request that OPS transfer up to LEN 8-bit bytes of the target's
260    OBJECT.  The OFFSET, for a seekable object, specifies the
261    starting point.  The ANNEX can be used to provide additional
262    data-specific information to the target.
263
264    Return the number of bytes actually transfered, or a negative error
265    code (an 'enum target_xfer_error' value) if the transfer is not
266    supported or otherwise fails.  Return of a positive value less than
267    LEN indicates that no further transfer is possible.  Unlike the raw
268    to_xfer_partial interface, callers of these functions do not need
269    to retry partial transfers.  */
270
271 extern LONGEST target_read (struct target_ops *ops,
272                             enum target_object object,
273                             const char *annex, gdb_byte *buf,
274                             ULONGEST offset, LONGEST len);
275
276 struct memory_read_result
277   {
278     /* First address that was read.  */
279     ULONGEST begin;
280     /* Past-the-end address.  */
281     ULONGEST end;
282     /* The data.  */
283     gdb_byte *data;
284 };
285 typedef struct memory_read_result memory_read_result_s;
286 DEF_VEC_O(memory_read_result_s);
287
288 extern void free_memory_read_result_vector (void *);
289
290 extern VEC(memory_read_result_s)* read_memory_robust (struct target_ops *ops,
291                                                       ULONGEST offset,
292                                                       LONGEST len);
293   
294 extern LONGEST target_write (struct target_ops *ops,
295                              enum target_object object,
296                              const char *annex, const gdb_byte *buf,
297                              ULONGEST offset, LONGEST len);
298
299 /* Similar to target_write, except that it also calls PROGRESS with
300    the number of bytes written and the opaque BATON after every
301    successful partial write (and before the first write).  This is
302    useful for progress reporting and user interaction while writing
303    data.  To abort the transfer, the progress callback can throw an
304    exception.  */
305
306 LONGEST target_write_with_progress (struct target_ops *ops,
307                                     enum target_object object,
308                                     const char *annex, const gdb_byte *buf,
309                                     ULONGEST offset, LONGEST len,
310                                     void (*progress) (ULONGEST, void *),
311                                     void *baton);
312
313 /* Wrapper to perform a full read of unknown size.  OBJECT/ANNEX will
314    be read using OPS.  The return value will be -1 if the transfer
315    fails or is not supported; 0 if the object is empty; or the length
316    of the object otherwise.  If a positive value is returned, a
317    sufficiently large buffer will be allocated using xmalloc and
318    returned in *BUF_P containing the contents of the object.
319
320    This method should be used for objects sufficiently small to store
321    in a single xmalloc'd buffer, when no fixed bound on the object's
322    size is known in advance.  Don't try to read TARGET_OBJECT_MEMORY
323    through this function.  */
324
325 extern LONGEST target_read_alloc (struct target_ops *ops,
326                                   enum target_object object,
327                                   const char *annex, gdb_byte **buf_p);
328
329 /* Read OBJECT/ANNEX using OPS.  The result is NUL-terminated and
330    returned as a string, allocated using xmalloc.  If an error occurs
331    or the transfer is unsupported, NULL is returned.  Empty objects
332    are returned as allocated but empty strings.  A warning is issued
333    if the result contains any embedded NUL bytes.  */
334
335 extern char *target_read_stralloc (struct target_ops *ops,
336                                    enum target_object object,
337                                    const char *annex);
338
339 /* See target_ops->to_xfer_partial.  */
340 extern target_xfer_partial_ftype target_xfer_partial;
341
342 /* Wrappers to target read/write that perform memory transfers.  They
343    throw an error if the memory transfer fails.
344
345    NOTE: cagney/2003-10-23: The naming schema is lifted from
346    "frame.h".  The parameter order is lifted from get_frame_memory,
347    which in turn lifted it from read_memory.  */
348
349 extern void get_target_memory (struct target_ops *ops, CORE_ADDR addr,
350                                gdb_byte *buf, LONGEST len);
351 extern ULONGEST get_target_memory_unsigned (struct target_ops *ops,
352                                             CORE_ADDR addr, int len,
353                                             enum bfd_endian byte_order);
354 \f
355 struct thread_info;             /* fwd decl for parameter list below: */
356
357 /* The type of the callback to the to_async method.  */
358
359 typedef void async_callback_ftype (enum inferior_event_type event_type,
360                                    void *context);
361
362 /* These defines are used to mark target_ops methods.  The script
363    make-target-delegates scans these and auto-generates the base
364    method implementations.  There are four macros that can be used:
365    
366    1. TARGET_DEFAULT_IGNORE.  There is no argument.  The base method
367    does nothing.  This is only valid if the method return type is
368    'void'.
369    
370    2. TARGET_DEFAULT_NORETURN.  The argument is a function call, like
371    'tcomplain ()'.  The base method simply makes this call, which is
372    assumed not to return.
373    
374    3. TARGET_DEFAULT_RETURN.  The argument is a C expression.  The
375    base method returns this expression's value.
376    
377    4. TARGET_DEFAULT_FUNC.  The argument is the name of a function.
378    make-target-delegates does not generate a base method in this case,
379    but instead uses the argument function as the base method.  */
380
381 #define TARGET_DEFAULT_IGNORE()
382 #define TARGET_DEFAULT_NORETURN(ARG)
383 #define TARGET_DEFAULT_RETURN(ARG)
384 #define TARGET_DEFAULT_FUNC(ARG)
385
386 struct target_ops
387   {
388     struct target_ops *beneath; /* To the target under this one.  */
389     char *to_shortname;         /* Name this target type */
390     char *to_longname;          /* Name for printing */
391     char *to_doc;               /* Documentation.  Does not include trailing
392                                    newline, and starts with a one-line descrip-
393                                    tion (probably similar to to_longname).  */
394     /* Per-target scratch pad.  */
395     void *to_data;
396     /* The open routine takes the rest of the parameters from the
397        command, and (if successful) pushes a new target onto the
398        stack.  Targets should supply this routine, if only to provide
399        an error message.  */
400     void (*to_open) (char *, int);
401     /* Old targets with a static target vector provide "to_close".
402        New re-entrant targets provide "to_xclose" and that is expected
403        to xfree everything (including the "struct target_ops").  */
404     void (*to_xclose) (struct target_ops *targ);
405     void (*to_close) (struct target_ops *);
406     void (*to_attach) (struct target_ops *ops, char *, int)
407       TARGET_DEFAULT_FUNC (find_default_attach);
408     void (*to_post_attach) (struct target_ops *, int)
409       TARGET_DEFAULT_IGNORE ();
410     void (*to_detach) (struct target_ops *ops, const char *, int)
411       TARGET_DEFAULT_IGNORE ();
412     void (*to_disconnect) (struct target_ops *, char *, int);
413     void (*to_resume) (struct target_ops *, ptid_t, int, enum gdb_signal)
414       TARGET_DEFAULT_NORETURN (noprocess ());
415     ptid_t (*to_wait) (struct target_ops *,
416                        ptid_t, struct target_waitstatus *, int)
417       TARGET_DEFAULT_NORETURN (noprocess ());
418     void (*to_fetch_registers) (struct target_ops *, struct regcache *, int)
419       TARGET_DEFAULT_IGNORE ();
420     void (*to_store_registers) (struct target_ops *, struct regcache *, int)
421       TARGET_DEFAULT_NORETURN (noprocess ());
422     void (*to_prepare_to_store) (struct target_ops *, struct regcache *)
423       TARGET_DEFAULT_NORETURN (noprocess ());
424
425     /* Transfer LEN bytes of memory between GDB address MYADDR and
426        target address MEMADDR.  If WRITE, transfer them to the target, else
427        transfer them from the target.  TARGET is the target from which we
428        get this function.
429
430        Return value, N, is one of the following:
431
432        0 means that we can't handle this.  If errno has been set, it is the
433        error which prevented us from doing it (FIXME: What about bfd_error?).
434
435        positive (call it N) means that we have transferred N bytes
436        starting at MEMADDR.  We might be able to handle more bytes
437        beyond this length, but no promises.
438
439        negative (call its absolute value N) means that we cannot
440        transfer right at MEMADDR, but we could transfer at least
441        something at MEMADDR + N.
442
443        NOTE: cagney/2004-10-01: This has been entirely superseeded by
444        to_xfer_partial and inferior inheritance.  */
445
446     int (*deprecated_xfer_memory) (CORE_ADDR memaddr, gdb_byte *myaddr,
447                                    int len, int write,
448                                    struct mem_attrib *attrib,
449                                    struct target_ops *target);
450
451     void (*to_files_info) (struct target_ops *)
452       TARGET_DEFAULT_IGNORE ();
453     int (*to_insert_breakpoint) (struct target_ops *, struct gdbarch *,
454                                  struct bp_target_info *)
455       TARGET_DEFAULT_FUNC (memory_insert_breakpoint);
456     int (*to_remove_breakpoint) (struct target_ops *, struct gdbarch *,
457                                  struct bp_target_info *)
458       TARGET_DEFAULT_FUNC (memory_remove_breakpoint);
459     int (*to_can_use_hw_breakpoint) (struct target_ops *, int, int, int)
460       TARGET_DEFAULT_RETURN (0);
461     int (*to_ranged_break_num_registers) (struct target_ops *)
462       TARGET_DEFAULT_RETURN (-1);
463     int (*to_insert_hw_breakpoint) (struct target_ops *,
464                                     struct gdbarch *, struct bp_target_info *)
465       TARGET_DEFAULT_RETURN (-1);
466     int (*to_remove_hw_breakpoint) (struct target_ops *,
467                                     struct gdbarch *, struct bp_target_info *)
468       TARGET_DEFAULT_RETURN (-1);
469
470     /* Documentation of what the two routines below are expected to do is
471        provided with the corresponding target_* macros.  */
472     int (*to_remove_watchpoint) (struct target_ops *,
473                                  CORE_ADDR, int, int, struct expression *)
474       TARGET_DEFAULT_RETURN (-1);
475     int (*to_insert_watchpoint) (struct target_ops *,
476                                  CORE_ADDR, int, int, struct expression *)
477       TARGET_DEFAULT_RETURN (-1);
478
479     int (*to_insert_mask_watchpoint) (struct target_ops *,
480                                       CORE_ADDR, CORE_ADDR, int)
481       TARGET_DEFAULT_RETURN (1);
482     int (*to_remove_mask_watchpoint) (struct target_ops *,
483                                       CORE_ADDR, CORE_ADDR, int)
484       TARGET_DEFAULT_RETURN (1);
485     int (*to_stopped_by_watchpoint) (struct target_ops *)
486       TARGET_DEFAULT_RETURN (0);
487     int to_have_steppable_watchpoint;
488     int to_have_continuable_watchpoint;
489     int (*to_stopped_data_address) (struct target_ops *, CORE_ADDR *)
490       TARGET_DEFAULT_RETURN (0);
491     int (*to_watchpoint_addr_within_range) (struct target_ops *,
492                                             CORE_ADDR, CORE_ADDR, int)
493       TARGET_DEFAULT_FUNC (default_watchpoint_addr_within_range);
494
495     /* Documentation of this routine is provided with the corresponding
496        target_* macro.  */
497     int (*to_region_ok_for_hw_watchpoint) (struct target_ops *,
498                                            CORE_ADDR, int)
499       TARGET_DEFAULT_FUNC (default_region_ok_for_hw_watchpoint);
500
501     int (*to_can_accel_watchpoint_condition) (struct target_ops *,
502                                               CORE_ADDR, int, int,
503                                               struct expression *)
504       TARGET_DEFAULT_RETURN (0);
505     int (*to_masked_watch_num_registers) (struct target_ops *,
506                                           CORE_ADDR, CORE_ADDR)
507       TARGET_DEFAULT_RETURN (-1);
508     void (*to_terminal_init) (struct target_ops *)
509       TARGET_DEFAULT_IGNORE ();
510     void (*to_terminal_inferior) (struct target_ops *)
511       TARGET_DEFAULT_IGNORE ();
512     void (*to_terminal_ours_for_output) (struct target_ops *)
513       TARGET_DEFAULT_IGNORE ();
514     void (*to_terminal_ours) (struct target_ops *)
515       TARGET_DEFAULT_IGNORE ();
516     void (*to_terminal_save_ours) (struct target_ops *)
517       TARGET_DEFAULT_IGNORE ();
518     void (*to_terminal_info) (struct target_ops *, const char *, int)
519       TARGET_DEFAULT_FUNC (default_terminal_info);
520     void (*to_kill) (struct target_ops *)
521       TARGET_DEFAULT_NORETURN (noprocess ());
522     void (*to_load) (struct target_ops *, char *, int)
523       TARGET_DEFAULT_NORETURN (tcomplain ());
524     void (*to_create_inferior) (struct target_ops *, 
525                                 char *, char *, char **, int);
526     void (*to_post_startup_inferior) (struct target_ops *, ptid_t)
527       TARGET_DEFAULT_IGNORE ();
528     int (*to_insert_fork_catchpoint) (struct target_ops *, int)
529       TARGET_DEFAULT_RETURN (1);
530     int (*to_remove_fork_catchpoint) (struct target_ops *, int)
531       TARGET_DEFAULT_RETURN (1);
532     int (*to_insert_vfork_catchpoint) (struct target_ops *, int)
533       TARGET_DEFAULT_RETURN (1);
534     int (*to_remove_vfork_catchpoint) (struct target_ops *, int)
535       TARGET_DEFAULT_RETURN (1);
536     int (*to_follow_fork) (struct target_ops *, int, int)
537       TARGET_DEFAULT_FUNC (default_follow_fork);
538     int (*to_insert_exec_catchpoint) (struct target_ops *, int)
539       TARGET_DEFAULT_RETURN (1);
540     int (*to_remove_exec_catchpoint) (struct target_ops *, int)
541       TARGET_DEFAULT_RETURN (1);
542     int (*to_set_syscall_catchpoint) (struct target_ops *,
543                                       int, int, int, int, int *)
544       TARGET_DEFAULT_RETURN (1);
545     int (*to_has_exited) (struct target_ops *, int, int, int *)
546       TARGET_DEFAULT_RETURN (0);
547     void (*to_mourn_inferior) (struct target_ops *)
548       TARGET_DEFAULT_FUNC (default_mourn_inferior);
549     int (*to_can_run) (struct target_ops *);
550
551     /* Documentation of this routine is provided with the corresponding
552        target_* macro.  */
553     void (*to_pass_signals) (struct target_ops *, int, unsigned char *);
554
555     /* Documentation of this routine is provided with the
556        corresponding target_* function.  */
557     void (*to_program_signals) (struct target_ops *, int, unsigned char *);
558
559     int (*to_thread_alive) (struct target_ops *, ptid_t ptid);
560     void (*to_find_new_threads) (struct target_ops *);
561     char *(*to_pid_to_str) (struct target_ops *, ptid_t);
562     char *(*to_extra_thread_info) (struct target_ops *, struct thread_info *)
563       TARGET_DEFAULT_RETURN (0);
564     char *(*to_thread_name) (struct target_ops *, struct thread_info *)
565       TARGET_DEFAULT_RETURN (0);
566     void (*to_stop) (struct target_ops *, ptid_t)
567       TARGET_DEFAULT_IGNORE ();
568     void (*to_rcmd) (struct target_ops *,
569                      char *command, struct ui_file *output)
570       TARGET_DEFAULT_FUNC (default_rcmd);
571     char *(*to_pid_to_exec_file) (struct target_ops *, int pid)
572       TARGET_DEFAULT_RETURN (0);
573     void (*to_log_command) (struct target_ops *, const char *)
574       TARGET_DEFAULT_IGNORE ();
575     struct target_section_table *(*to_get_section_table) (struct target_ops *);
576     enum strata to_stratum;
577     int (*to_has_all_memory) (struct target_ops *);
578     int (*to_has_memory) (struct target_ops *);
579     int (*to_has_stack) (struct target_ops *);
580     int (*to_has_registers) (struct target_ops *);
581     int (*to_has_execution) (struct target_ops *, ptid_t);
582     int to_has_thread_control;  /* control thread execution */
583     int to_attach_no_wait;
584     /* ASYNC target controls */
585     int (*to_can_async_p) (struct target_ops *)
586       TARGET_DEFAULT_FUNC (find_default_can_async_p);
587     int (*to_is_async_p) (struct target_ops *)
588       TARGET_DEFAULT_FUNC (find_default_is_async_p);
589     void (*to_async) (struct target_ops *, async_callback_ftype *, void *)
590       TARGET_DEFAULT_NORETURN (tcomplain ());
591     int (*to_supports_non_stop) (struct target_ops *);
592     /* find_memory_regions support method for gcore */
593     int (*to_find_memory_regions) (struct target_ops *,
594                                    find_memory_region_ftype func, void *data)
595       TARGET_DEFAULT_FUNC (dummy_find_memory_regions);
596     /* make_corefile_notes support method for gcore */
597     char * (*to_make_corefile_notes) (struct target_ops *, bfd *, int *)
598       TARGET_DEFAULT_FUNC (dummy_make_corefile_notes);
599     /* get_bookmark support method for bookmarks */
600     gdb_byte * (*to_get_bookmark) (struct target_ops *, char *, int)
601       TARGET_DEFAULT_NORETURN (tcomplain ());
602     /* goto_bookmark support method for bookmarks */
603     void (*to_goto_bookmark) (struct target_ops *, gdb_byte *, int)
604       TARGET_DEFAULT_NORETURN (tcomplain ());
605     /* Return the thread-local address at OFFSET in the
606        thread-local storage for the thread PTID and the shared library
607        or executable file given by OBJFILE.  If that block of
608        thread-local storage hasn't been allocated yet, this function
609        may return an error.  */
610     CORE_ADDR (*to_get_thread_local_address) (struct target_ops *ops,
611                                               ptid_t ptid,
612                                               CORE_ADDR load_module_addr,
613                                               CORE_ADDR offset);
614
615     /* Request that OPS transfer up to LEN 8-bit bytes of the target's
616        OBJECT.  The OFFSET, for a seekable object, specifies the
617        starting point.  The ANNEX can be used to provide additional
618        data-specific information to the target.
619
620        Return the transferred status, error or OK (an
621        'enum target_xfer_status' value).  Save the number of bytes
622        actually transferred in *XFERED_LEN if transfer is successful
623        (TARGET_XFER_OK) or the number unavailable bytes if the requested
624        data is unavailable (TARGET_XFER_E_UNAVAILABLE).  *XFERED_LEN
625        smaller than LEN does not indicate the end of the object, only
626        the end of the transfer; higher level code should continue
627        transferring if desired.  This is handled in target.c.
628
629        The interface does not support a "retry" mechanism.  Instead it
630        assumes that at least one byte will be transfered on each
631        successful call.
632
633        NOTE: cagney/2003-10-17: The current interface can lead to
634        fragmented transfers.  Lower target levels should not implement
635        hacks, such as enlarging the transfer, in an attempt to
636        compensate for this.  Instead, the target stack should be
637        extended so that it implements supply/collect methods and a
638        look-aside object cache.  With that available, the lowest
639        target can safely and freely "push" data up the stack.
640
641        See target_read and target_write for more information.  One,
642        and only one, of readbuf or writebuf must be non-NULL.  */
643
644     enum target_xfer_status (*to_xfer_partial) (struct target_ops *ops,
645                                                 enum target_object object,
646                                                 const char *annex,
647                                                 gdb_byte *readbuf,
648                                                 const gdb_byte *writebuf,
649                                                 ULONGEST offset, ULONGEST len,
650                                                 ULONGEST *xfered_len)
651       TARGET_DEFAULT_RETURN (TARGET_XFER_E_IO);
652
653     /* Returns the memory map for the target.  A return value of NULL
654        means that no memory map is available.  If a memory address
655        does not fall within any returned regions, it's assumed to be
656        RAM.  The returned memory regions should not overlap.
657
658        The order of regions does not matter; target_memory_map will
659        sort regions by starting address.  For that reason, this
660        function should not be called directly except via
661        target_memory_map.
662
663        This method should not cache data; if the memory map could
664        change unexpectedly, it should be invalidated, and higher
665        layers will re-fetch it.  */
666     VEC(mem_region_s) *(*to_memory_map) (struct target_ops *);
667
668     /* Erases the region of flash memory starting at ADDRESS, of
669        length LENGTH.
670
671        Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned
672        on flash block boundaries, as reported by 'to_memory_map'.  */
673     void (*to_flash_erase) (struct target_ops *,
674                            ULONGEST address, LONGEST length);
675
676     /* Finishes a flash memory write sequence.  After this operation
677        all flash memory should be available for writing and the result
678        of reading from areas written by 'to_flash_write' should be
679        equal to what was written.  */
680     void (*to_flash_done) (struct target_ops *);
681
682     /* Describe the architecture-specific features of this target.
683        Returns the description found, or NULL if no description
684        was available.  */
685     const struct target_desc *(*to_read_description) (struct target_ops *ops);
686
687     /* Build the PTID of the thread on which a given task is running,
688        based on LWP and THREAD.  These values are extracted from the
689        task Private_Data section of the Ada Task Control Block, and
690        their interpretation depends on the target.  */
691     ptid_t (*to_get_ada_task_ptid) (struct target_ops *,
692                                     long lwp, long thread)
693       TARGET_DEFAULT_FUNC (default_get_ada_task_ptid);
694
695     /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
696        Return 0 if *READPTR is already at the end of the buffer.
697        Return -1 if there is insufficient buffer for a whole entry.
698        Return 1 if an entry was read into *TYPEP and *VALP.  */
699     int (*to_auxv_parse) (struct target_ops *ops, gdb_byte **readptr,
700                          gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
701
702     /* Search SEARCH_SPACE_LEN bytes beginning at START_ADDR for the
703        sequence of bytes in PATTERN with length PATTERN_LEN.
704
705        The result is 1 if found, 0 if not found, and -1 if there was an error
706        requiring halting of the search (e.g. memory read error).
707        If the pattern is found the address is recorded in FOUND_ADDRP.  */
708     int (*to_search_memory) (struct target_ops *ops,
709                              CORE_ADDR start_addr, ULONGEST search_space_len,
710                              const gdb_byte *pattern, ULONGEST pattern_len,
711                              CORE_ADDR *found_addrp);
712
713     /* Can target execute in reverse?  */
714     int (*to_can_execute_reverse) (struct target_ops *)
715       TARGET_DEFAULT_RETURN (0);
716
717     /* The direction the target is currently executing.  Must be
718        implemented on targets that support reverse execution and async
719        mode.  The default simply returns forward execution.  */
720     enum exec_direction_kind (*to_execution_direction) (struct target_ops *)
721       TARGET_DEFAULT_FUNC (default_execution_direction);
722
723     /* Does this target support debugging multiple processes
724        simultaneously?  */
725     int (*to_supports_multi_process) (struct target_ops *)
726       TARGET_DEFAULT_RETURN (0);
727
728     /* Does this target support enabling and disabling tracepoints while a trace
729        experiment is running?  */
730     int (*to_supports_enable_disable_tracepoint) (struct target_ops *)
731       TARGET_DEFAULT_RETURN (0);
732
733     /* Does this target support disabling address space randomization?  */
734     int (*to_supports_disable_randomization) (struct target_ops *);
735
736     /* Does this target support the tracenz bytecode for string collection?  */
737     int (*to_supports_string_tracing) (struct target_ops *)
738       TARGET_DEFAULT_RETURN (0);
739
740     /* Does this target support evaluation of breakpoint conditions on its
741        end?  */
742     int (*to_supports_evaluation_of_breakpoint_conditions) (struct target_ops *)
743       TARGET_DEFAULT_RETURN (0);
744
745     /* Does this target support evaluation of breakpoint commands on its
746        end?  */
747     int (*to_can_run_breakpoint_commands) (struct target_ops *)
748       TARGET_DEFAULT_RETURN (0);
749
750     /* Determine current architecture of thread PTID.
751
752        The target is supposed to determine the architecture of the code where
753        the target is currently stopped at (on Cell, if a target is in spu_run,
754        to_thread_architecture would return SPU, otherwise PPC32 or PPC64).
755        This is architecture used to perform decr_pc_after_break adjustment,
756        and also determines the frame architecture of the innermost frame.
757        ptrace operations need to operate according to target_gdbarch ().
758
759        The default implementation always returns target_gdbarch ().  */
760     struct gdbarch *(*to_thread_architecture) (struct target_ops *, ptid_t)
761       TARGET_DEFAULT_FUNC (default_thread_architecture);
762
763     /* Determine current address space of thread PTID.
764
765        The default implementation always returns the inferior's
766        address space.  */
767     struct address_space *(*to_thread_address_space) (struct target_ops *,
768                                                       ptid_t);
769
770     /* Target file operations.  */
771
772     /* Open FILENAME on the target, using FLAGS and MODE.  Return a
773        target file descriptor, or -1 if an error occurs (and set
774        *TARGET_ERRNO).  */
775     int (*to_fileio_open) (struct target_ops *,
776                            const char *filename, int flags, int mode,
777                            int *target_errno);
778
779     /* Write up to LEN bytes from WRITE_BUF to FD on the target.
780        Return the number of bytes written, or -1 if an error occurs
781        (and set *TARGET_ERRNO).  */
782     int (*to_fileio_pwrite) (struct target_ops *,
783                              int fd, const gdb_byte *write_buf, int len,
784                              ULONGEST offset, int *target_errno);
785
786     /* Read up to LEN bytes FD on the target into READ_BUF.
787        Return the number of bytes read, or -1 if an error occurs
788        (and set *TARGET_ERRNO).  */
789     int (*to_fileio_pread) (struct target_ops *,
790                             int fd, gdb_byte *read_buf, int len,
791                             ULONGEST offset, int *target_errno);
792
793     /* Close FD on the target.  Return 0, or -1 if an error occurs
794        (and set *TARGET_ERRNO).  */
795     int (*to_fileio_close) (struct target_ops *, int fd, int *target_errno);
796
797     /* Unlink FILENAME on the target.  Return 0, or -1 if an error
798        occurs (and set *TARGET_ERRNO).  */
799     int (*to_fileio_unlink) (struct target_ops *,
800                              const char *filename, int *target_errno);
801
802     /* Read value of symbolic link FILENAME on the target.  Return a
803        null-terminated string allocated via xmalloc, or NULL if an error
804        occurs (and set *TARGET_ERRNO).  */
805     char *(*to_fileio_readlink) (struct target_ops *,
806                                  const char *filename, int *target_errno);
807
808
809     /* Implement the "info proc" command.  */
810     void (*to_info_proc) (struct target_ops *, char *, enum info_proc_what);
811
812     /* Tracepoint-related operations.  */
813
814     /* Prepare the target for a tracing run.  */
815     void (*to_trace_init) (struct target_ops *)
816       TARGET_DEFAULT_NORETURN (tcomplain ());
817
818     /* Send full details of a tracepoint location to the target.  */
819     void (*to_download_tracepoint) (struct target_ops *,
820                                     struct bp_location *location)
821       TARGET_DEFAULT_NORETURN (tcomplain ());
822
823     /* Is the target able to download tracepoint locations in current
824        state?  */
825     int (*to_can_download_tracepoint) (struct target_ops *)
826       TARGET_DEFAULT_RETURN (0);
827
828     /* Send full details of a trace state variable to the target.  */
829     void (*to_download_trace_state_variable) (struct target_ops *,
830                                               struct trace_state_variable *tsv)
831       TARGET_DEFAULT_NORETURN (tcomplain ());
832
833     /* Enable a tracepoint on the target.  */
834     void (*to_enable_tracepoint) (struct target_ops *,
835                                   struct bp_location *location)
836       TARGET_DEFAULT_NORETURN (tcomplain ());
837
838     /* Disable a tracepoint on the target.  */
839     void (*to_disable_tracepoint) (struct target_ops *,
840                                    struct bp_location *location)
841       TARGET_DEFAULT_NORETURN (tcomplain ());
842
843     /* Inform the target info of memory regions that are readonly
844        (such as text sections), and so it should return data from
845        those rather than look in the trace buffer.  */
846     void (*to_trace_set_readonly_regions) (struct target_ops *)
847       TARGET_DEFAULT_NORETURN (tcomplain ());
848
849     /* Start a trace run.  */
850     void (*to_trace_start) (struct target_ops *)
851       TARGET_DEFAULT_NORETURN (tcomplain ());
852
853     /* Get the current status of a tracing run.  */
854     int (*to_get_trace_status) (struct target_ops *, struct trace_status *ts)
855       TARGET_DEFAULT_RETURN (-1);
856
857     void (*to_get_tracepoint_status) (struct target_ops *,
858                                       struct breakpoint *tp,
859                                       struct uploaded_tp *utp)
860       TARGET_DEFAULT_NORETURN (tcomplain ());
861
862     /* Stop a trace run.  */
863     void (*to_trace_stop) (struct target_ops *)
864       TARGET_DEFAULT_NORETURN (tcomplain ());
865
866    /* Ask the target to find a trace frame of the given type TYPE,
867       using NUM, ADDR1, and ADDR2 as search parameters.  Returns the
868       number of the trace frame, and also the tracepoint number at
869       TPP.  If no trace frame matches, return -1.  May throw if the
870       operation fails.  */
871     int (*to_trace_find) (struct target_ops *,
872                           enum trace_find_type type, int num,
873                           CORE_ADDR addr1, CORE_ADDR addr2, int *tpp)
874       TARGET_DEFAULT_RETURN (-1);
875
876     /* Get the value of the trace state variable number TSV, returning
877        1 if the value is known and writing the value itself into the
878        location pointed to by VAL, else returning 0.  */
879     int (*to_get_trace_state_variable_value) (struct target_ops *,
880                                               int tsv, LONGEST *val)
881       TARGET_DEFAULT_RETURN (0);
882
883     int (*to_save_trace_data) (struct target_ops *, const char *filename)
884       TARGET_DEFAULT_NORETURN (tcomplain ());
885
886     int (*to_upload_tracepoints) (struct target_ops *,
887                                   struct uploaded_tp **utpp)
888       TARGET_DEFAULT_RETURN (0);
889
890     int (*to_upload_trace_state_variables) (struct target_ops *,
891                                             struct uploaded_tsv **utsvp)
892       TARGET_DEFAULT_RETURN (0);
893
894     LONGEST (*to_get_raw_trace_data) (struct target_ops *, gdb_byte *buf,
895                                       ULONGEST offset, LONGEST len)
896       TARGET_DEFAULT_NORETURN (tcomplain ());
897
898     /* Get the minimum length of instruction on which a fast tracepoint
899        may be set on the target.  If this operation is unsupported,
900        return -1.  If for some reason the minimum length cannot be
901        determined, return 0.  */
902     int (*to_get_min_fast_tracepoint_insn_len) (struct target_ops *)
903       TARGET_DEFAULT_RETURN (-1);
904
905     /* Set the target's tracing behavior in response to unexpected
906        disconnection - set VAL to 1 to keep tracing, 0 to stop.  */
907     void (*to_set_disconnected_tracing) (struct target_ops *, int val)
908       TARGET_DEFAULT_IGNORE ();
909     void (*to_set_circular_trace_buffer) (struct target_ops *, int val)
910       TARGET_DEFAULT_IGNORE ();
911     /* Set the size of trace buffer in the target.  */
912     void (*to_set_trace_buffer_size) (struct target_ops *, LONGEST val)
913       TARGET_DEFAULT_IGNORE ();
914
915     /* Add/change textual notes about the trace run, returning 1 if
916        successful, 0 otherwise.  */
917     int (*to_set_trace_notes) (struct target_ops *,
918                                const char *user, const char *notes,
919                                const char *stopnotes)
920       TARGET_DEFAULT_RETURN (0);
921
922     /* Return the processor core that thread PTID was last seen on.
923        This information is updated only when:
924        - update_thread_list is called
925        - thread stops
926        If the core cannot be determined -- either for the specified
927        thread, or right now, or in this debug session, or for this
928        target -- return -1.  */
929     int (*to_core_of_thread) (struct target_ops *, ptid_t ptid);
930
931     /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range
932        matches the contents of [DATA,DATA+SIZE).  Returns 1 if there's
933        a match, 0 if there's a mismatch, and -1 if an error is
934        encountered while reading memory.  */
935     int (*to_verify_memory) (struct target_ops *, const gdb_byte *data,
936                              CORE_ADDR memaddr, ULONGEST size);
937
938     /* Return the address of the start of the Thread Information Block
939        a Windows OS specific feature.  */
940     int (*to_get_tib_address) (struct target_ops *,
941                                ptid_t ptid, CORE_ADDR *addr)
942       TARGET_DEFAULT_NORETURN (tcomplain ());
943
944     /* Send the new settings of write permission variables.  */
945     void (*to_set_permissions) (struct target_ops *)
946       TARGET_DEFAULT_IGNORE ();
947
948     /* Look for a static tracepoint marker at ADDR, and fill in MARKER
949        with its details.  Return 1 on success, 0 on failure.  */
950     int (*to_static_tracepoint_marker_at) (struct target_ops *, CORE_ADDR,
951                                            struct static_tracepoint_marker *marker)
952       TARGET_DEFAULT_RETURN (0);
953
954     /* Return a vector of all tracepoints markers string id ID, or all
955        markers if ID is NULL.  */
956     VEC(static_tracepoint_marker_p) *(*to_static_tracepoint_markers_by_strid) (struct target_ops *, const char *id)
957       TARGET_DEFAULT_NORETURN (tcomplain ());
958
959     /* Return a traceframe info object describing the current
960        traceframe's contents.  If the target doesn't support
961        traceframe info, return NULL.  If the current traceframe is not
962        selected (the current traceframe number is -1), the target can
963        choose to return either NULL or an empty traceframe info.  If
964        NULL is returned, for example in remote target, GDB will read
965        from the live inferior.  If an empty traceframe info is
966        returned, for example in tfile target, which means the
967        traceframe info is available, but the requested memory is not
968        available in it.  GDB will try to see if the requested memory
969        is available in the read-only sections.  This method should not
970        cache data; higher layers take care of caching, invalidating,
971        and re-fetching when necessary.  */
972     struct traceframe_info *(*to_traceframe_info) (struct target_ops *)
973       TARGET_DEFAULT_RETURN (0);
974
975     /* Ask the target to use or not to use agent according to USE.  Return 1
976        successful, 0 otherwise.  */
977     int (*to_use_agent) (struct target_ops *, int use)
978       TARGET_DEFAULT_NORETURN (tcomplain ());
979
980     /* Is the target able to use agent in current state?  */
981     int (*to_can_use_agent) (struct target_ops *)
982       TARGET_DEFAULT_RETURN (0);
983
984     /* Check whether the target supports branch tracing.  */
985     int (*to_supports_btrace) (struct target_ops *)
986       TARGET_DEFAULT_RETURN (0);
987
988     /* Enable branch tracing for PTID and allocate a branch trace target
989        information struct for reading and for disabling branch trace.  */
990     struct btrace_target_info *(*to_enable_btrace) (struct target_ops *,
991                                                     ptid_t ptid);
992
993     /* Disable branch tracing and deallocate TINFO.  */
994     void (*to_disable_btrace) (struct target_ops *,
995                                struct btrace_target_info *tinfo);
996
997     /* Disable branch tracing and deallocate TINFO.  This function is similar
998        to to_disable_btrace, except that it is called during teardown and is
999        only allowed to perform actions that are safe.  A counter-example would
1000        be attempting to talk to a remote target.  */
1001     void (*to_teardown_btrace) (struct target_ops *,
1002                                 struct btrace_target_info *tinfo);
1003
1004     /* Read branch trace data for the thread indicated by BTINFO into DATA.
1005        DATA is cleared before new trace is added.
1006        The branch trace will start with the most recent block and continue
1007        towards older blocks.  */
1008     enum btrace_error (*to_read_btrace) (struct target_ops *self,
1009                                          VEC (btrace_block_s) **data,
1010                                          struct btrace_target_info *btinfo,
1011                                          enum btrace_read_type type);
1012
1013     /* Stop trace recording.  */
1014     void (*to_stop_recording) (struct target_ops *);
1015
1016     /* Print information about the recording.  */
1017     void (*to_info_record) (struct target_ops *);
1018
1019     /* Save the recorded execution trace into a file.  */
1020     void (*to_save_record) (struct target_ops *, const char *filename);
1021
1022     /* Delete the recorded execution trace from the current position onwards.  */
1023     void (*to_delete_record) (struct target_ops *);
1024
1025     /* Query if the record target is currently replaying.  */
1026     int (*to_record_is_replaying) (struct target_ops *);
1027
1028     /* Go to the begin of the execution trace.  */
1029     void (*to_goto_record_begin) (struct target_ops *);
1030
1031     /* Go to the end of the execution trace.  */
1032     void (*to_goto_record_end) (struct target_ops *);
1033
1034     /* Go to a specific location in the recorded execution trace.  */
1035     void (*to_goto_record) (struct target_ops *, ULONGEST insn);
1036
1037     /* Disassemble SIZE instructions in the recorded execution trace from
1038        the current position.
1039        If SIZE < 0, disassemble abs (SIZE) preceding instructions; otherwise,
1040        disassemble SIZE succeeding instructions.  */
1041     void (*to_insn_history) (struct target_ops *, int size, int flags);
1042
1043     /* Disassemble SIZE instructions in the recorded execution trace around
1044        FROM.
1045        If SIZE < 0, disassemble abs (SIZE) instructions before FROM; otherwise,
1046        disassemble SIZE instructions after FROM.  */
1047     void (*to_insn_history_from) (struct target_ops *,
1048                                   ULONGEST from, int size, int flags);
1049
1050     /* Disassemble a section of the recorded execution trace from instruction
1051        BEGIN (inclusive) to instruction END (inclusive).  */
1052     void (*to_insn_history_range) (struct target_ops *,
1053                                    ULONGEST begin, ULONGEST end, int flags);
1054
1055     /* Print a function trace of the recorded execution trace.
1056        If SIZE < 0, print abs (SIZE) preceding functions; otherwise, print SIZE
1057        succeeding functions.  */
1058     void (*to_call_history) (struct target_ops *, int size, int flags);
1059
1060     /* Print a function trace of the recorded execution trace starting
1061        at function FROM.
1062        If SIZE < 0, print abs (SIZE) functions before FROM; otherwise, print
1063        SIZE functions after FROM.  */
1064     void (*to_call_history_from) (struct target_ops *,
1065                                   ULONGEST begin, int size, int flags);
1066
1067     /* Print a function trace of an execution trace section from function BEGIN
1068        (inclusive) to function END (inclusive).  */
1069     void (*to_call_history_range) (struct target_ops *,
1070                                    ULONGEST begin, ULONGEST end, int flags);
1071
1072     /* Nonzero if TARGET_OBJECT_LIBRARIES_SVR4 may be read with a
1073        non-empty annex.  */
1074     int (*to_augmented_libraries_svr4_read) (struct target_ops *)
1075       TARGET_DEFAULT_RETURN (0);
1076
1077     /* Those unwinders are tried before any other arch unwinders.  Use NULL if
1078        it is not used.  */
1079     const struct frame_unwind *to_get_unwinder;
1080     const struct frame_unwind *to_get_tailcall_unwinder;
1081
1082     /* Return the number of bytes by which the PC needs to be decremented
1083        after executing a breakpoint instruction.
1084        Defaults to gdbarch_decr_pc_after_break (GDBARCH).  */
1085     CORE_ADDR (*to_decr_pc_after_break) (struct target_ops *ops,
1086                                          struct gdbarch *gdbarch);
1087
1088     int to_magic;
1089     /* Need sub-structure for target machine related rather than comm related?
1090      */
1091   };
1092
1093 /* Magic number for checking ops size.  If a struct doesn't end with this
1094    number, somebody changed the declaration but didn't change all the
1095    places that initialize one.  */
1096
1097 #define OPS_MAGIC       3840
1098
1099 /* The ops structure for our "current" target process.  This should
1100    never be NULL.  If there is no target, it points to the dummy_target.  */
1101
1102 extern struct target_ops current_target;
1103
1104 /* Define easy words for doing these operations on our current target.  */
1105
1106 #define target_shortname        (current_target.to_shortname)
1107 #define target_longname         (current_target.to_longname)
1108
1109 /* Does whatever cleanup is required for a target that we are no
1110    longer going to be calling.  This routine is automatically always
1111    called after popping the target off the target stack - the target's
1112    own methods are no longer available through the target vector.
1113    Closing file descriptors and freeing all memory allocated memory are
1114    typical things it should do.  */
1115
1116 void target_close (struct target_ops *targ);
1117
1118 /* Attaches to a process on the target side.  Arguments are as passed
1119    to the `attach' command by the user.  This routine can be called
1120    when the target is not on the target-stack, if the target_can_run
1121    routine returns 1; in that case, it must push itself onto the stack.
1122    Upon exit, the target should be ready for normal operations, and
1123    should be ready to deliver the status of the process immediately
1124    (without waiting) to an upcoming target_wait call.  */
1125
1126 void target_attach (char *, int);
1127
1128 /* Some targets don't generate traps when attaching to the inferior,
1129    or their target_attach implementation takes care of the waiting.
1130    These targets must set to_attach_no_wait.  */
1131
1132 #define target_attach_no_wait \
1133      (current_target.to_attach_no_wait)
1134
1135 /* The target_attach operation places a process under debugger control,
1136    and stops the process.
1137
1138    This operation provides a target-specific hook that allows the
1139    necessary bookkeeping to be performed after an attach completes.  */
1140 #define target_post_attach(pid) \
1141      (*current_target.to_post_attach) (&current_target, pid)
1142
1143 /* Takes a program previously attached to and detaches it.
1144    The program may resume execution (some targets do, some don't) and will
1145    no longer stop on signals, etc.  We better not have left any breakpoints
1146    in the program or it'll die when it hits one.  ARGS is arguments
1147    typed by the user (e.g. a signal to send the process).  FROM_TTY
1148    says whether to be verbose or not.  */
1149
1150 extern void target_detach (const char *, int);
1151
1152 /* Disconnect from the current target without resuming it (leaving it
1153    waiting for a debugger).  */
1154
1155 extern void target_disconnect (char *, int);
1156
1157 /* Resume execution of the target process PTID (or a group of
1158    threads).  STEP says whether to single-step or to run free; SIGGNAL
1159    is the signal to be given to the target, or GDB_SIGNAL_0 for no
1160    signal.  The caller may not pass GDB_SIGNAL_DEFAULT.  A specific
1161    PTID means `step/resume only this process id'.  A wildcard PTID
1162    (all threads, or all threads of process) means `step/resume
1163    INFERIOR_PTID, and let other threads (for which the wildcard PTID
1164    matches) resume with their 'thread->suspend.stop_signal' signal
1165    (usually GDB_SIGNAL_0) if it is in "pass" state, or with no signal
1166    if in "no pass" state.  */
1167
1168 extern void target_resume (ptid_t ptid, int step, enum gdb_signal signal);
1169
1170 /* Wait for process pid to do something.  PTID = -1 to wait for any
1171    pid to do something.  Return pid of child, or -1 in case of error;
1172    store status through argument pointer STATUS.  Note that it is
1173    _NOT_ OK to throw_exception() out of target_wait() without popping
1174    the debugging target from the stack; GDB isn't prepared to get back
1175    to the prompt with a debugging target but without the frame cache,
1176    stop_pc, etc., set up.  OPTIONS is a bitwise OR of TARGET_W*
1177    options.  */
1178
1179 extern ptid_t target_wait (ptid_t ptid, struct target_waitstatus *status,
1180                            int options);
1181
1182 /* Fetch at least register REGNO, or all regs if regno == -1.  No result.  */
1183
1184 extern void target_fetch_registers (struct regcache *regcache, int regno);
1185
1186 /* Store at least register REGNO, or all regs if REGNO == -1.
1187    It can store as many registers as it wants to, so target_prepare_to_store
1188    must have been previously called.  Calls error() if there are problems.  */
1189
1190 extern void target_store_registers (struct regcache *regcache, int regs);
1191
1192 /* Get ready to modify the registers array.  On machines which store
1193    individual registers, this doesn't need to do anything.  On machines
1194    which store all the registers in one fell swoop, this makes sure
1195    that REGISTERS contains all the registers from the program being
1196    debugged.  */
1197
1198 #define target_prepare_to_store(regcache)       \
1199      (*current_target.to_prepare_to_store) (&current_target, regcache)
1200
1201 /* Determine current address space of thread PTID.  */
1202
1203 struct address_space *target_thread_address_space (ptid_t);
1204
1205 /* Implement the "info proc" command.  This returns one if the request
1206    was handled, and zero otherwise.  It can also throw an exception if
1207    an error was encountered while attempting to handle the
1208    request.  */
1209
1210 int target_info_proc (char *, enum info_proc_what);
1211
1212 /* Returns true if this target can debug multiple processes
1213    simultaneously.  */
1214
1215 #define target_supports_multi_process() \
1216      (*current_target.to_supports_multi_process) (&current_target)
1217
1218 /* Returns true if this target can disable address space randomization.  */
1219
1220 int target_supports_disable_randomization (void);
1221
1222 /* Returns true if this target can enable and disable tracepoints
1223    while a trace experiment is running.  */
1224
1225 #define target_supports_enable_disable_tracepoint() \
1226   (*current_target.to_supports_enable_disable_tracepoint) (&current_target)
1227
1228 #define target_supports_string_tracing() \
1229   (*current_target.to_supports_string_tracing) (&current_target)
1230
1231 /* Returns true if this target can handle breakpoint conditions
1232    on its end.  */
1233
1234 #define target_supports_evaluation_of_breakpoint_conditions() \
1235   (*current_target.to_supports_evaluation_of_breakpoint_conditions) (&current_target)
1236
1237 /* Returns true if this target can handle breakpoint commands
1238    on its end.  */
1239
1240 #define target_can_run_breakpoint_commands() \
1241   (*current_target.to_can_run_breakpoint_commands) (&current_target)
1242
1243 extern int target_read_string (CORE_ADDR, char **, int, int *);
1244
1245 extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1246                                ssize_t len);
1247
1248 extern int target_read_raw_memory (CORE_ADDR memaddr, gdb_byte *myaddr,
1249                                    ssize_t len);
1250
1251 extern int target_read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1252
1253 extern int target_read_code (CORE_ADDR memaddr, gdb_byte *myaddr, ssize_t len);
1254
1255 extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
1256                                 ssize_t len);
1257
1258 extern int target_write_raw_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
1259                                     ssize_t len);
1260
1261 /* Fetches the target's memory map.  If one is found it is sorted
1262    and returned, after some consistency checking.  Otherwise, NULL
1263    is returned.  */
1264 VEC(mem_region_s) *target_memory_map (void);
1265
1266 /* Erase the specified flash region.  */
1267 void target_flash_erase (ULONGEST address, LONGEST length);
1268
1269 /* Finish a sequence of flash operations.  */
1270 void target_flash_done (void);
1271
1272 /* Describes a request for a memory write operation.  */
1273 struct memory_write_request
1274   {
1275     /* Begining address that must be written.  */
1276     ULONGEST begin;
1277     /* Past-the-end address.  */
1278     ULONGEST end;
1279     /* The data to write.  */
1280     gdb_byte *data;
1281     /* A callback baton for progress reporting for this request.  */
1282     void *baton;
1283   };
1284 typedef struct memory_write_request memory_write_request_s;
1285 DEF_VEC_O(memory_write_request_s);
1286
1287 /* Enumeration specifying different flash preservation behaviour.  */
1288 enum flash_preserve_mode
1289   {
1290     flash_preserve,
1291     flash_discard
1292   };
1293
1294 /* Write several memory blocks at once.  This version can be more
1295    efficient than making several calls to target_write_memory, in
1296    particular because it can optimize accesses to flash memory.
1297
1298    Moreover, this is currently the only memory access function in gdb
1299    that supports writing to flash memory, and it should be used for
1300    all cases where access to flash memory is desirable.
1301
1302    REQUESTS is the vector (see vec.h) of memory_write_request.
1303    PRESERVE_FLASH_P indicates what to do with blocks which must be
1304      erased, but not completely rewritten.
1305    PROGRESS_CB is a function that will be periodically called to provide
1306      feedback to user.  It will be called with the baton corresponding
1307      to the request currently being written.  It may also be called
1308      with a NULL baton, when preserved flash sectors are being rewritten.
1309
1310    The function returns 0 on success, and error otherwise.  */
1311 int target_write_memory_blocks (VEC(memory_write_request_s) *requests,
1312                                 enum flash_preserve_mode preserve_flash_p,
1313                                 void (*progress_cb) (ULONGEST, void *));
1314
1315 /* Print a line about the current target.  */
1316
1317 #define target_files_info()     \
1318      (*current_target.to_files_info) (&current_target)
1319
1320 /* Insert a hardware breakpoint at address BP_TGT->placed_address in
1321    the target machine.  Returns 0 for success, and returns non-zero or
1322    throws an error (with a detailed failure reason error code and
1323    message) otherwise.  */
1324
1325 extern int target_insert_breakpoint (struct gdbarch *gdbarch,
1326                                      struct bp_target_info *bp_tgt);
1327
1328 /* Remove a breakpoint at address BP_TGT->placed_address in the target
1329    machine.  Result is 0 for success, non-zero for error.  */
1330
1331 extern int target_remove_breakpoint (struct gdbarch *gdbarch,
1332                                      struct bp_target_info *bp_tgt);
1333
1334 /* Initialize the terminal settings we record for the inferior,
1335    before we actually run the inferior.  */
1336
1337 #define target_terminal_init() \
1338      (*current_target.to_terminal_init) (&current_target)
1339
1340 /* Put the inferior's terminal settings into effect.
1341    This is preparation for starting or resuming the inferior.  */
1342
1343 extern void target_terminal_inferior (void);
1344
1345 /* Put some of our terminal settings into effect,
1346    enough to get proper results from our output,
1347    but do not change into or out of RAW mode
1348    so that no input is discarded.
1349
1350    After doing this, either terminal_ours or terminal_inferior
1351    should be called to get back to a normal state of affairs.  */
1352
1353 #define target_terminal_ours_for_output() \
1354      (*current_target.to_terminal_ours_for_output) (&current_target)
1355
1356 /* Put our terminal settings into effect.
1357    First record the inferior's terminal settings
1358    so they can be restored properly later.  */
1359
1360 #define target_terminal_ours() \
1361      (*current_target.to_terminal_ours) (&current_target)
1362
1363 /* Save our terminal settings.
1364    This is called from TUI after entering or leaving the curses
1365    mode.  Since curses modifies our terminal this call is here
1366    to take this change into account.  */
1367
1368 #define target_terminal_save_ours() \
1369      (*current_target.to_terminal_save_ours) (&current_target)
1370
1371 /* Print useful information about our terminal status, if such a thing
1372    exists.  */
1373
1374 #define target_terminal_info(arg, from_tty) \
1375      (*current_target.to_terminal_info) (&current_target, arg, from_tty)
1376
1377 /* Kill the inferior process.   Make it go away.  */
1378
1379 extern void target_kill (void);
1380
1381 /* Load an executable file into the target process.  This is expected
1382    to not only bring new code into the target process, but also to
1383    update GDB's symbol tables to match.
1384
1385    ARG contains command-line arguments, to be broken down with
1386    buildargv ().  The first non-switch argument is the filename to
1387    load, FILE; the second is a number (as parsed by strtoul (..., ...,
1388    0)), which is an offset to apply to the load addresses of FILE's
1389    sections.  The target may define switches, or other non-switch
1390    arguments, as it pleases.  */
1391
1392 extern void target_load (char *arg, int from_tty);
1393
1394 /* Start an inferior process and set inferior_ptid to its pid.
1395    EXEC_FILE is the file to run.
1396    ALLARGS is a string containing the arguments to the program.
1397    ENV is the environment vector to pass.  Errors reported with error().
1398    On VxWorks and various standalone systems, we ignore exec_file.  */
1399
1400 void target_create_inferior (char *exec_file, char *args,
1401                              char **env, int from_tty);
1402
1403 /* Some targets (such as ttrace-based HPUX) don't allow us to request
1404    notification of inferior events such as fork and vork immediately
1405    after the inferior is created.  (This because of how gdb gets an
1406    inferior created via invoking a shell to do it.  In such a scenario,
1407    if the shell init file has commands in it, the shell will fork and
1408    exec for each of those commands, and we will see each such fork
1409    event.  Very bad.)
1410
1411    Such targets will supply an appropriate definition for this function.  */
1412
1413 #define target_post_startup_inferior(ptid) \
1414      (*current_target.to_post_startup_inferior) (&current_target, ptid)
1415
1416 /* On some targets, we can catch an inferior fork or vfork event when
1417    it occurs.  These functions insert/remove an already-created
1418    catchpoint for such events.  They return  0 for success, 1 if the
1419    catchpoint type is not supported and -1 for failure.  */
1420
1421 #define target_insert_fork_catchpoint(pid) \
1422      (*current_target.to_insert_fork_catchpoint) (&current_target, pid)
1423
1424 #define target_remove_fork_catchpoint(pid) \
1425      (*current_target.to_remove_fork_catchpoint) (&current_target, pid)
1426
1427 #define target_insert_vfork_catchpoint(pid) \
1428      (*current_target.to_insert_vfork_catchpoint) (&current_target, pid)
1429
1430 #define target_remove_vfork_catchpoint(pid) \
1431      (*current_target.to_remove_vfork_catchpoint) (&current_target, pid)
1432
1433 /* If the inferior forks or vforks, this function will be called at
1434    the next resume in order to perform any bookkeeping and fiddling
1435    necessary to continue debugging either the parent or child, as
1436    requested, and releasing the other.  Information about the fork
1437    or vfork event is available via get_last_target_status ().
1438    This function returns 1 if the inferior should not be resumed
1439    (i.e. there is another event pending).  */
1440
1441 int target_follow_fork (int follow_child, int detach_fork);
1442
1443 /* On some targets, we can catch an inferior exec event when it
1444    occurs.  These functions insert/remove an already-created
1445    catchpoint for such events.  They return  0 for success, 1 if the
1446    catchpoint type is not supported and -1 for failure.  */
1447
1448 #define target_insert_exec_catchpoint(pid) \
1449      (*current_target.to_insert_exec_catchpoint) (&current_target, pid)
1450
1451 #define target_remove_exec_catchpoint(pid) \
1452      (*current_target.to_remove_exec_catchpoint) (&current_target, pid)
1453
1454 /* Syscall catch.
1455
1456    NEEDED is nonzero if any syscall catch (of any kind) is requested.
1457    If NEEDED is zero, it means the target can disable the mechanism to
1458    catch system calls because there are no more catchpoints of this type.
1459
1460    ANY_COUNT is nonzero if a generic (filter-less) syscall catch is
1461    being requested.  In this case, both TABLE_SIZE and TABLE should
1462    be ignored.
1463
1464    TABLE_SIZE is the number of elements in TABLE.  It only matters if
1465    ANY_COUNT is zero.
1466
1467    TABLE is an array of ints, indexed by syscall number.  An element in
1468    this array is nonzero if that syscall should be caught.  This argument
1469    only matters if ANY_COUNT is zero.
1470
1471    Return 0 for success, 1 if syscall catchpoints are not supported or -1
1472    for failure.  */
1473
1474 #define target_set_syscall_catchpoint(pid, needed, any_count, table_size, table) \
1475      (*current_target.to_set_syscall_catchpoint) (&current_target,      \
1476                                                   pid, needed, any_count, \
1477                                                   table_size, table)
1478
1479 /* Returns TRUE if PID has exited.  And, also sets EXIT_STATUS to the
1480    exit code of PID, if any.  */
1481
1482 #define target_has_exited(pid,wait_status,exit_status) \
1483      (*current_target.to_has_exited) (&current_target, \
1484                                       pid,wait_status,exit_status)
1485
1486 /* The debugger has completed a blocking wait() call.  There is now
1487    some process event that must be processed.  This function should
1488    be defined by those targets that require the debugger to perform
1489    cleanup or internal state changes in response to the process event.  */
1490
1491 /* The inferior process has died.  Do what is right.  */
1492
1493 void target_mourn_inferior (void);
1494
1495 /* Does target have enough data to do a run or attach command? */
1496
1497 #define target_can_run(t) \
1498      ((t)->to_can_run) (t)
1499
1500 /* Set list of signals to be handled in the target.
1501
1502    PASS_SIGNALS is an array of size NSIG, indexed by target signal number
1503    (enum gdb_signal).  For every signal whose entry in this array is
1504    non-zero, the target is allowed -but not required- to skip reporting
1505    arrival of the signal to the GDB core by returning from target_wait,
1506    and to pass the signal directly to the inferior instead.
1507
1508    However, if the target is hardware single-stepping a thread that is
1509    about to receive a signal, it needs to be reported in any case, even
1510    if mentioned in a previous target_pass_signals call.   */
1511
1512 extern void target_pass_signals (int nsig, unsigned char *pass_signals);
1513
1514 /* Set list of signals the target may pass to the inferior.  This
1515    directly maps to the "handle SIGNAL pass/nopass" setting.
1516
1517    PROGRAM_SIGNALS is an array of size NSIG, indexed by target signal
1518    number (enum gdb_signal).  For every signal whose entry in this
1519    array is non-zero, the target is allowed to pass the signal to the
1520    inferior.  Signals not present in the array shall be silently
1521    discarded.  This does not influence whether to pass signals to the
1522    inferior as a result of a target_resume call.  This is useful in
1523    scenarios where the target needs to decide whether to pass or not a
1524    signal to the inferior without GDB core involvement, such as for
1525    example, when detaching (as threads may have been suspended with
1526    pending signals not reported to GDB).  */
1527
1528 extern void target_program_signals (int nsig, unsigned char *program_signals);
1529
1530 /* Check to see if a thread is still alive.  */
1531
1532 extern int target_thread_alive (ptid_t ptid);
1533
1534 /* Query for new threads and add them to the thread list.  */
1535
1536 extern void target_find_new_threads (void);
1537
1538 /* Make target stop in a continuable fashion.  (For instance, under
1539    Unix, this should act like SIGSTOP).  This function is normally
1540    used by GUIs to implement a stop button.  */
1541
1542 extern void target_stop (ptid_t ptid);
1543
1544 /* Send the specified COMMAND to the target's monitor
1545    (shell,interpreter) for execution.  The result of the query is
1546    placed in OUTBUF.  */
1547
1548 #define target_rcmd(command, outbuf) \
1549      (*current_target.to_rcmd) (&current_target, command, outbuf)
1550
1551
1552 /* Does the target include all of memory, or only part of it?  This
1553    determines whether we look up the target chain for other parts of
1554    memory if this target can't satisfy a request.  */
1555
1556 extern int target_has_all_memory_1 (void);
1557 #define target_has_all_memory target_has_all_memory_1 ()
1558
1559 /* Does the target include memory?  (Dummy targets don't.)  */
1560
1561 extern int target_has_memory_1 (void);
1562 #define target_has_memory target_has_memory_1 ()
1563
1564 /* Does the target have a stack?  (Exec files don't, VxWorks doesn't, until
1565    we start a process.)  */
1566
1567 extern int target_has_stack_1 (void);
1568 #define target_has_stack target_has_stack_1 ()
1569
1570 /* Does the target have registers?  (Exec files don't.)  */
1571
1572 extern int target_has_registers_1 (void);
1573 #define target_has_registers target_has_registers_1 ()
1574
1575 /* Does the target have execution?  Can we make it jump (through
1576    hoops), or pop its stack a few times?  This means that the current
1577    target is currently executing; for some targets, that's the same as
1578    whether or not the target is capable of execution, but there are
1579    also targets which can be current while not executing.  In that
1580    case this will become true after target_create_inferior or
1581    target_attach.  */
1582
1583 extern int target_has_execution_1 (ptid_t);
1584
1585 /* Like target_has_execution_1, but always passes inferior_ptid.  */
1586
1587 extern int target_has_execution_current (void);
1588
1589 #define target_has_execution target_has_execution_current ()
1590
1591 /* Default implementations for process_stratum targets.  Return true
1592    if there's a selected inferior, false otherwise.  */
1593
1594 extern int default_child_has_all_memory (struct target_ops *ops);
1595 extern int default_child_has_memory (struct target_ops *ops);
1596 extern int default_child_has_stack (struct target_ops *ops);
1597 extern int default_child_has_registers (struct target_ops *ops);
1598 extern int default_child_has_execution (struct target_ops *ops,
1599                                         ptid_t the_ptid);
1600
1601 /* Can the target support the debugger control of thread execution?
1602    Can it lock the thread scheduler?  */
1603
1604 #define target_can_lock_scheduler \
1605      (current_target.to_has_thread_control & tc_schedlock)
1606
1607 /* Should the target enable async mode if it is supported?  Temporary
1608    cludge until async mode is a strict superset of sync mode.  */
1609 extern int target_async_permitted;
1610
1611 /* Can the target support asynchronous execution?  */
1612 #define target_can_async_p() (current_target.to_can_async_p (&current_target))
1613
1614 /* Is the target in asynchronous execution mode?  */
1615 #define target_is_async_p() (current_target.to_is_async_p (&current_target))
1616
1617 int target_supports_non_stop (void);
1618
1619 /* Put the target in async mode with the specified callback function.  */
1620 #define target_async(CALLBACK,CONTEXT) \
1621      (current_target.to_async (&current_target, (CALLBACK), (CONTEXT)))
1622
1623 #define target_execution_direction() \
1624   (current_target.to_execution_direction (&current_target))
1625
1626 /* Converts a process id to a string.  Usually, the string just contains
1627    `process xyz', but on some systems it may contain
1628    `process xyz thread abc'.  */
1629
1630 extern char *target_pid_to_str (ptid_t ptid);
1631
1632 extern char *normal_pid_to_str (ptid_t ptid);
1633
1634 /* Return a short string describing extra information about PID,
1635    e.g. "sleeping", "runnable", "running on LWP 3".  Null return value
1636    is okay.  */
1637
1638 #define target_extra_thread_info(TP) \
1639      (current_target.to_extra_thread_info (&current_target, TP))
1640
1641 /* Return the thread's name.  A NULL result means that the target
1642    could not determine this thread's name.  */
1643
1644 extern char *target_thread_name (struct thread_info *);
1645
1646 /* Attempts to find the pathname of the executable file
1647    that was run to create a specified process.
1648
1649    The process PID must be stopped when this operation is used.
1650
1651    If the executable file cannot be determined, NULL is returned.
1652
1653    Else, a pointer to a character string containing the pathname
1654    is returned.  This string should be copied into a buffer by
1655    the client if the string will not be immediately used, or if
1656    it must persist.  */
1657
1658 #define target_pid_to_exec_file(pid) \
1659      (current_target.to_pid_to_exec_file) (&current_target, pid)
1660
1661 /* See the to_thread_architecture description in struct target_ops.  */
1662
1663 #define target_thread_architecture(ptid) \
1664      (current_target.to_thread_architecture (&current_target, ptid))
1665
1666 /*
1667  * Iterator function for target memory regions.
1668  * Calls a callback function once for each memory region 'mapped'
1669  * in the child process.  Defined as a simple macro rather than
1670  * as a function macro so that it can be tested for nullity.
1671  */
1672
1673 #define target_find_memory_regions(FUNC, DATA) \
1674      (current_target.to_find_memory_regions) (&current_target, FUNC, DATA)
1675
1676 /*
1677  * Compose corefile .note section.
1678  */
1679
1680 #define target_make_corefile_notes(BFD, SIZE_P) \
1681      (current_target.to_make_corefile_notes) (&current_target, BFD, SIZE_P)
1682
1683 /* Bookmark interfaces.  */
1684 #define target_get_bookmark(ARGS, FROM_TTY) \
1685      (current_target.to_get_bookmark) (&current_target, ARGS, FROM_TTY)
1686
1687 #define target_goto_bookmark(ARG, FROM_TTY) \
1688      (current_target.to_goto_bookmark) (&current_target, ARG, FROM_TTY)
1689
1690 /* Hardware watchpoint interfaces.  */
1691
1692 /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1693    write).  Only the INFERIOR_PTID task is being queried.  */
1694
1695 #define target_stopped_by_watchpoint()          \
1696   ((*current_target.to_stopped_by_watchpoint) (&current_target))
1697
1698 /* Non-zero if we have steppable watchpoints  */
1699
1700 #define target_have_steppable_watchpoint \
1701    (current_target.to_have_steppable_watchpoint)
1702
1703 /* Non-zero if we have continuable watchpoints  */
1704
1705 #define target_have_continuable_watchpoint \
1706    (current_target.to_have_continuable_watchpoint)
1707
1708 /* Provide defaults for hardware watchpoint functions.  */
1709
1710 /* If the *_hw_beakpoint functions have not been defined
1711    elsewhere use the definitions in the target vector.  */
1712
1713 /* Returns non-zero if we can set a hardware watchpoint of type TYPE.  TYPE is
1714    one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1715    bp_hardware_breakpoint.  CNT is the number of such watchpoints used so far
1716    (including this one?).  OTHERTYPE is who knows what...  */
1717
1718 #define target_can_use_hardware_watchpoint(TYPE,CNT,OTHERTYPE) \
1719  (*current_target.to_can_use_hw_breakpoint) (&current_target,  \
1720                                              TYPE, CNT, OTHERTYPE);
1721
1722 /* Returns the number of debug registers needed to watch the given
1723    memory region, or zero if not supported.  */
1724
1725 #define target_region_ok_for_hw_watchpoint(addr, len) \
1726     (*current_target.to_region_ok_for_hw_watchpoint) (&current_target,  \
1727                                                       addr, len)
1728
1729
1730 /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes.
1731    TYPE is 0 for write, 1 for read, and 2 for read/write accesses.
1732    COND is the expression for its condition, or NULL if there's none.
1733    Returns 0 for success, 1 if the watchpoint type is not supported,
1734    -1 for failure.  */
1735
1736 #define target_insert_watchpoint(addr, len, type, cond) \
1737      (*current_target.to_insert_watchpoint) (&current_target,   \
1738                                              addr, len, type, cond)
1739
1740 #define target_remove_watchpoint(addr, len, type, cond) \
1741      (*current_target.to_remove_watchpoint) (&current_target,   \
1742                                              addr, len, type, cond)
1743
1744 /* Insert a new masked watchpoint at ADDR using the mask MASK.
1745    RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1746    or hw_access for an access watchpoint.  Returns 0 for success, 1 if
1747    masked watchpoints are not supported, -1 for failure.  */
1748
1749 extern int target_insert_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1750
1751 /* Remove a masked watchpoint at ADDR with the mask MASK.
1752    RW may be hw_read for a read watchpoint, hw_write for a write watchpoint
1753    or hw_access for an access watchpoint.  Returns 0 for success, non-zero
1754    for failure.  */
1755
1756 extern int target_remove_mask_watchpoint (CORE_ADDR, CORE_ADDR, int);
1757
1758 /* Insert a hardware breakpoint at address BP_TGT->placed_address in
1759    the target machine.  Returns 0 for success, and returns non-zero or
1760    throws an error (with a detailed failure reason error code and
1761    message) otherwise.  */
1762
1763 #define target_insert_hw_breakpoint(gdbarch, bp_tgt) \
1764      (*current_target.to_insert_hw_breakpoint) (&current_target,        \
1765                                                 gdbarch, bp_tgt)
1766
1767 #define target_remove_hw_breakpoint(gdbarch, bp_tgt) \
1768      (*current_target.to_remove_hw_breakpoint) (&current_target,        \
1769                                                 gdbarch, bp_tgt)
1770
1771 /* Return number of debug registers needed for a ranged breakpoint,
1772    or -1 if ranged breakpoints are not supported.  */
1773
1774 extern int target_ranged_break_num_registers (void);
1775
1776 /* Return non-zero if target knows the data address which triggered this
1777    target_stopped_by_watchpoint, in such case place it to *ADDR_P.  Only the
1778    INFERIOR_PTID task is being queried.  */
1779 #define target_stopped_data_address(target, addr_p) \
1780     (*target.to_stopped_data_address) (target, addr_p)
1781
1782 /* Return non-zero if ADDR is within the range of a watchpoint spanning
1783    LENGTH bytes beginning at START.  */
1784 #define target_watchpoint_addr_within_range(target, addr, start, length) \
1785   (*target.to_watchpoint_addr_within_range) (target, addr, start, length)
1786
1787 /* Return non-zero if the target is capable of using hardware to evaluate
1788    the condition expression.  In this case, if the condition is false when
1789    the watched memory location changes, execution may continue without the
1790    debugger being notified.
1791
1792    Due to limitations in the hardware implementation, it may be capable of
1793    avoiding triggering the watchpoint in some cases where the condition
1794    expression is false, but may report some false positives as well.
1795    For this reason, GDB will still evaluate the condition expression when
1796    the watchpoint triggers.  */
1797 #define target_can_accel_watchpoint_condition(addr, len, type, cond) \
1798   (*current_target.to_can_accel_watchpoint_condition) (&current_target, \
1799                                                        addr, len, type, cond)
1800
1801 /* Return number of debug registers needed for a masked watchpoint,
1802    -1 if masked watchpoints are not supported or -2 if the given address
1803    and mask combination cannot be used.  */
1804
1805 extern int target_masked_watch_num_registers (CORE_ADDR addr, CORE_ADDR mask);
1806
1807 /* Target can execute in reverse?  */
1808 #define target_can_execute_reverse \
1809       current_target.to_can_execute_reverse (&current_target)
1810
1811 extern const struct target_desc *target_read_description (struct target_ops *);
1812
1813 #define target_get_ada_task_ptid(lwp, tid) \
1814      (*current_target.to_get_ada_task_ptid) (&current_target, lwp,tid)
1815
1816 /* Utility implementation of searching memory.  */
1817 extern int simple_search_memory (struct target_ops* ops,
1818                                  CORE_ADDR start_addr,
1819                                  ULONGEST search_space_len,
1820                                  const gdb_byte *pattern,
1821                                  ULONGEST pattern_len,
1822                                  CORE_ADDR *found_addrp);
1823
1824 /* Main entry point for searching memory.  */
1825 extern int target_search_memory (CORE_ADDR start_addr,
1826                                  ULONGEST search_space_len,
1827                                  const gdb_byte *pattern,
1828                                  ULONGEST pattern_len,
1829                                  CORE_ADDR *found_addrp);
1830
1831 /* Target file operations.  */
1832
1833 /* Open FILENAME on the target, using FLAGS and MODE.  Return a
1834    target file descriptor, or -1 if an error occurs (and set
1835    *TARGET_ERRNO).  */
1836 extern int target_fileio_open (const char *filename, int flags, int mode,
1837                                int *target_errno);
1838
1839 /* Write up to LEN bytes from WRITE_BUF to FD on the target.
1840    Return the number of bytes written, or -1 if an error occurs
1841    (and set *TARGET_ERRNO).  */
1842 extern int target_fileio_pwrite (int fd, const gdb_byte *write_buf, int len,
1843                                  ULONGEST offset, int *target_errno);
1844
1845 /* Read up to LEN bytes FD on the target into READ_BUF.
1846    Return the number of bytes read, or -1 if an error occurs
1847    (and set *TARGET_ERRNO).  */
1848 extern int target_fileio_pread (int fd, gdb_byte *read_buf, int len,
1849                                 ULONGEST offset, int *target_errno);
1850
1851 /* Close FD on the target.  Return 0, or -1 if an error occurs
1852    (and set *TARGET_ERRNO).  */
1853 extern int target_fileio_close (int fd, int *target_errno);
1854
1855 /* Unlink FILENAME on the target.  Return 0, or -1 if an error
1856    occurs (and set *TARGET_ERRNO).  */
1857 extern int target_fileio_unlink (const char *filename, int *target_errno);
1858
1859 /* Read value of symbolic link FILENAME on the target.  Return a
1860    null-terminated string allocated via xmalloc, or NULL if an error
1861    occurs (and set *TARGET_ERRNO).  */
1862 extern char *target_fileio_readlink (const char *filename, int *target_errno);
1863
1864 /* Read target file FILENAME.  The return value will be -1 if the transfer
1865    fails or is not supported; 0 if the object is empty; or the length
1866    of the object otherwise.  If a positive value is returned, a
1867    sufficiently large buffer will be allocated using xmalloc and
1868    returned in *BUF_P containing the contents of the object.
1869
1870    This method should be used for objects sufficiently small to store
1871    in a single xmalloc'd buffer, when no fixed bound on the object's
1872    size is known in advance.  */
1873 extern LONGEST target_fileio_read_alloc (const char *filename,
1874                                          gdb_byte **buf_p);
1875
1876 /* Read target file FILENAME.  The result is NUL-terminated and
1877    returned as a string, allocated using xmalloc.  If an error occurs
1878    or the transfer is unsupported, NULL is returned.  Empty objects
1879    are returned as allocated but empty strings.  A warning is issued
1880    if the result contains any embedded NUL bytes.  */
1881 extern char *target_fileio_read_stralloc (const char *filename);
1882
1883
1884 /* Tracepoint-related operations.  */
1885
1886 #define target_trace_init() \
1887   (*current_target.to_trace_init) (&current_target)
1888
1889 #define target_download_tracepoint(t) \
1890   (*current_target.to_download_tracepoint) (&current_target, t)
1891
1892 #define target_can_download_tracepoint() \
1893   (*current_target.to_can_download_tracepoint) (&current_target)
1894
1895 #define target_download_trace_state_variable(tsv) \
1896   (*current_target.to_download_trace_state_variable) (&current_target, tsv)
1897
1898 #define target_enable_tracepoint(loc) \
1899   (*current_target.to_enable_tracepoint) (&current_target, loc)
1900
1901 #define target_disable_tracepoint(loc) \
1902   (*current_target.to_disable_tracepoint) (&current_target, loc)
1903
1904 #define target_trace_start() \
1905   (*current_target.to_trace_start) (&current_target)
1906
1907 #define target_trace_set_readonly_regions() \
1908   (*current_target.to_trace_set_readonly_regions) (&current_target)
1909
1910 #define target_get_trace_status(ts) \
1911   (*current_target.to_get_trace_status) (&current_target, ts)
1912
1913 #define target_get_tracepoint_status(tp,utp)            \
1914   (*current_target.to_get_tracepoint_status) (&current_target, tp, utp)
1915
1916 #define target_trace_stop() \
1917   (*current_target.to_trace_stop) (&current_target)
1918
1919 #define target_trace_find(type,num,addr1,addr2,tpp) \
1920   (*current_target.to_trace_find) (&current_target, \
1921                                    (type), (num), (addr1), (addr2), (tpp))
1922
1923 #define target_get_trace_state_variable_value(tsv,val) \
1924   (*current_target.to_get_trace_state_variable_value) (&current_target, \
1925                                                        (tsv), (val))
1926
1927 #define target_save_trace_data(filename) \
1928   (*current_target.to_save_trace_data) (&current_target, filename)
1929
1930 #define target_upload_tracepoints(utpp) \
1931   (*current_target.to_upload_tracepoints) (&current_target, utpp)
1932
1933 #define target_upload_trace_state_variables(utsvp) \
1934   (*current_target.to_upload_trace_state_variables) (&current_target, utsvp)
1935
1936 #define target_get_raw_trace_data(buf,offset,len) \
1937   (*current_target.to_get_raw_trace_data) (&current_target,     \
1938                                            (buf), (offset), (len))
1939
1940 #define target_get_min_fast_tracepoint_insn_len() \
1941   (*current_target.to_get_min_fast_tracepoint_insn_len) (&current_target)
1942
1943 #define target_set_disconnected_tracing(val) \
1944   (*current_target.to_set_disconnected_tracing) (&current_target, val)
1945
1946 #define target_set_circular_trace_buffer(val)   \
1947   (*current_target.to_set_circular_trace_buffer) (&current_target, val)
1948
1949 #define target_set_trace_buffer_size(val)       \
1950   (*current_target.to_set_trace_buffer_size) (&current_target, val)
1951
1952 #define target_set_trace_notes(user,notes,stopnotes)            \
1953   (*current_target.to_set_trace_notes) (&current_target,        \
1954                                         (user), (notes), (stopnotes))
1955
1956 #define target_get_tib_address(ptid, addr) \
1957   (*current_target.to_get_tib_address) (&current_target, (ptid), (addr))
1958
1959 #define target_set_permissions() \
1960   (*current_target.to_set_permissions) (&current_target)
1961
1962 #define target_static_tracepoint_marker_at(addr, marker) \
1963   (*current_target.to_static_tracepoint_marker_at) (&current_target,    \
1964                                                     addr, marker)
1965
1966 #define target_static_tracepoint_markers_by_strid(marker_id) \
1967   (*current_target.to_static_tracepoint_markers_by_strid) (&current_target, \
1968                                                            marker_id)
1969
1970 #define target_traceframe_info() \
1971   (*current_target.to_traceframe_info) (&current_target)
1972
1973 #define target_use_agent(use) \
1974   (*current_target.to_use_agent) (&current_target, use)
1975
1976 #define target_can_use_agent() \
1977   (*current_target.to_can_use_agent) (&current_target)
1978
1979 #define target_augmented_libraries_svr4_read() \
1980   (*current_target.to_augmented_libraries_svr4_read) (&current_target)
1981
1982 /* Command logging facility.  */
1983
1984 #define target_log_command(p)                                   \
1985   (*current_target.to_log_command) (&current_target, p)
1986
1987
1988 extern int target_core_of_thread (ptid_t ptid);
1989
1990 /* See to_get_unwinder in struct target_ops.  */
1991 extern const struct frame_unwind *target_get_unwinder (void);
1992
1993 /* See to_get_tailcall_unwinder in struct target_ops.  */
1994 extern const struct frame_unwind *target_get_tailcall_unwinder (void);
1995
1996 /* Verify that the memory in the [MEMADDR, MEMADDR+SIZE) range matches
1997    the contents of [DATA,DATA+SIZE).  Returns 1 if there's a match, 0
1998    if there's a mismatch, and -1 if an error is encountered while
1999    reading memory.  Throws an error if the functionality is found not
2000    to be supported by the current target.  */
2001 int target_verify_memory (const gdb_byte *data,
2002                           CORE_ADDR memaddr, ULONGEST size);
2003
2004 /* Routines for maintenance of the target structures...
2005
2006    complete_target_initialization: Finalize a target_ops by filling in
2007    any fields needed by the target implementation.
2008
2009    add_target:   Add a target to the list of all possible targets.
2010
2011    push_target:  Make this target the top of the stack of currently used
2012    targets, within its particular stratum of the stack.  Result
2013    is 0 if now atop the stack, nonzero if not on top (maybe
2014    should warn user).
2015
2016    unpush_target: Remove this from the stack of currently used targets,
2017    no matter where it is on the list.  Returns 0 if no
2018    change, 1 if removed from stack.  */
2019
2020 extern void add_target (struct target_ops *);
2021
2022 extern void add_target_with_completer (struct target_ops *t,
2023                                        completer_ftype *completer);
2024
2025 extern void complete_target_initialization (struct target_ops *t);
2026
2027 /* Adds a command ALIAS for target T and marks it deprecated.  This is useful
2028    for maintaining backwards compatibility when renaming targets.  */
2029
2030 extern void add_deprecated_target_alias (struct target_ops *t, char *alias);
2031
2032 extern void push_target (struct target_ops *);
2033
2034 extern int unpush_target (struct target_ops *);
2035
2036 extern void target_pre_inferior (int);
2037
2038 extern void target_preopen (int);
2039
2040 /* Does whatever cleanup is required to get rid of all pushed targets.  */
2041 extern void pop_all_targets (void);
2042
2043 /* Like pop_all_targets, but pops only targets whose stratum is
2044    strictly above ABOVE_STRATUM.  */
2045 extern void pop_all_targets_above (enum strata above_stratum);
2046
2047 extern int target_is_pushed (struct target_ops *t);
2048
2049 extern CORE_ADDR target_translate_tls_address (struct objfile *objfile,
2050                                                CORE_ADDR offset);
2051
2052 /* Struct target_section maps address ranges to file sections.  It is
2053    mostly used with BFD files, but can be used without (e.g. for handling
2054    raw disks, or files not in formats handled by BFD).  */
2055
2056 struct target_section
2057   {
2058     CORE_ADDR addr;             /* Lowest address in section */
2059     CORE_ADDR endaddr;          /* 1+highest address in section */
2060
2061     struct bfd_section *the_bfd_section;
2062
2063     /* The "owner" of the section.
2064        It can be any unique value.  It is set by add_target_sections
2065        and used by remove_target_sections.
2066        For example, for executables it is a pointer to exec_bfd and
2067        for shlibs it is the so_list pointer.  */
2068     void *owner;
2069   };
2070
2071 /* Holds an array of target sections.  Defined by [SECTIONS..SECTIONS_END[.  */
2072
2073 struct target_section_table
2074 {
2075   struct target_section *sections;
2076   struct target_section *sections_end;
2077 };
2078
2079 /* Return the "section" containing the specified address.  */
2080 struct target_section *target_section_by_addr (struct target_ops *target,
2081                                                CORE_ADDR addr);
2082
2083 /* Return the target section table this target (or the targets
2084    beneath) currently manipulate.  */
2085
2086 extern struct target_section_table *target_get_section_table
2087   (struct target_ops *target);
2088
2089 /* From mem-break.c */
2090
2091 extern int memory_remove_breakpoint (struct target_ops *, struct gdbarch *,
2092                                      struct bp_target_info *);
2093
2094 extern int memory_insert_breakpoint (struct target_ops *, struct gdbarch *,
2095                                      struct bp_target_info *);
2096
2097 extern int default_memory_remove_breakpoint (struct gdbarch *,
2098                                              struct bp_target_info *);
2099
2100 extern int default_memory_insert_breakpoint (struct gdbarch *,
2101                                              struct bp_target_info *);
2102
2103
2104 /* From target.c */
2105
2106 extern void initialize_targets (void);
2107
2108 extern void noprocess (void) ATTRIBUTE_NORETURN;
2109
2110 extern void target_require_runnable (void);
2111
2112 extern void find_default_attach (struct target_ops *, char *, int);
2113
2114 extern void find_default_create_inferior (struct target_ops *,
2115                                           char *, char *, char **, int);
2116
2117 extern struct target_ops *find_target_beneath (struct target_ops *);
2118
2119 /* Find the target at STRATUM.  If no target is at that stratum,
2120    return NULL.  */
2121
2122 struct target_ops *find_target_at (enum strata stratum);
2123
2124 /* Read OS data object of type TYPE from the target, and return it in
2125    XML format.  The result is NUL-terminated and returned as a string,
2126    allocated using xmalloc.  If an error occurs or the transfer is
2127    unsupported, NULL is returned.  Empty objects are returned as
2128    allocated but empty strings.  */
2129
2130 extern char *target_get_osdata (const char *type);
2131
2132 \f
2133 /* Stuff that should be shared among the various remote targets.  */
2134
2135 /* Debugging level.  0 is off, and non-zero values mean to print some debug
2136    information (higher values, more information).  */
2137 extern int remote_debug;
2138
2139 /* Speed in bits per second, or -1 which means don't mess with the speed.  */
2140 extern int baud_rate;
2141 /* Timeout limit for response from target.  */
2142 extern int remote_timeout;
2143
2144 \f
2145
2146 /* Set the show memory breakpoints mode to show, and installs a cleanup
2147    to restore it back to the current value.  */
2148 extern struct cleanup *make_show_memory_breakpoints_cleanup (int show);
2149
2150 extern int may_write_registers;
2151 extern int may_write_memory;
2152 extern int may_insert_breakpoints;
2153 extern int may_insert_tracepoints;
2154 extern int may_insert_fast_tracepoints;
2155 extern int may_stop;
2156
2157 extern void update_target_permissions (void);
2158
2159 \f
2160 /* Imported from machine dependent code.  */
2161
2162 /* Blank target vector entries are initialized to target_ignore.  */
2163 void target_ignore (void);
2164
2165 /* See to_supports_btrace in struct target_ops.  */
2166 #define target_supports_btrace() \
2167   (current_target.to_supports_btrace (&current_target))
2168
2169 /* See to_enable_btrace in struct target_ops.  */
2170 extern struct btrace_target_info *target_enable_btrace (ptid_t ptid);
2171
2172 /* See to_disable_btrace in struct target_ops.  */
2173 extern void target_disable_btrace (struct btrace_target_info *btinfo);
2174
2175 /* See to_teardown_btrace in struct target_ops.  */
2176 extern void target_teardown_btrace (struct btrace_target_info *btinfo);
2177
2178 /* See to_read_btrace in struct target_ops.  */
2179 extern enum btrace_error target_read_btrace (VEC (btrace_block_s) **,
2180                                              struct btrace_target_info *,
2181                                              enum btrace_read_type);
2182
2183 /* See to_stop_recording in struct target_ops.  */
2184 extern void target_stop_recording (void);
2185
2186 /* See to_info_record in struct target_ops.  */
2187 extern void target_info_record (void);
2188
2189 /* See to_save_record in struct target_ops.  */
2190 extern void target_save_record (const char *filename);
2191
2192 /* Query if the target supports deleting the execution log.  */
2193 extern int target_supports_delete_record (void);
2194
2195 /* See to_delete_record in struct target_ops.  */
2196 extern void target_delete_record (void);
2197
2198 /* See to_record_is_replaying in struct target_ops.  */
2199 extern int target_record_is_replaying (void);
2200
2201 /* See to_goto_record_begin in struct target_ops.  */
2202 extern void target_goto_record_begin (void);
2203
2204 /* See to_goto_record_end in struct target_ops.  */
2205 extern void target_goto_record_end (void);
2206
2207 /* See to_goto_record in struct target_ops.  */
2208 extern void target_goto_record (ULONGEST insn);
2209
2210 /* See to_insn_history.  */
2211 extern void target_insn_history (int size, int flags);
2212
2213 /* See to_insn_history_from.  */
2214 extern void target_insn_history_from (ULONGEST from, int size, int flags);
2215
2216 /* See to_insn_history_range.  */
2217 extern void target_insn_history_range (ULONGEST begin, ULONGEST end, int flags);
2218
2219 /* See to_call_history.  */
2220 extern void target_call_history (int size, int flags);
2221
2222 /* See to_call_history_from.  */
2223 extern void target_call_history_from (ULONGEST begin, int size, int flags);
2224
2225 /* See to_call_history_range.  */
2226 extern void target_call_history_range (ULONGEST begin, ULONGEST end, int flags);
2227
2228 /* See to_decr_pc_after_break.  Start searching for the target at OPS.  */
2229 extern CORE_ADDR forward_target_decr_pc_after_break (struct target_ops *ops,
2230                                                      struct gdbarch *gdbarch);
2231
2232 /* See to_decr_pc_after_break.  */
2233 extern CORE_ADDR target_decr_pc_after_break (struct gdbarch *gdbarch);
2234
2235 #endif /* !defined (TARGET_H) */