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