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