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