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