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