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