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