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