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