target factories, target open and multiple instances of targets
[external/binutils.git] / gdb / inf-child.h
1 /* Base/prototype target for default child (native) targets.
2
3    Copyright (C) 2004-2018 Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19
20 #ifndef INF_CHILD_H
21 #define INF_CHILD_H
22
23 #include "target.h"
24
25 /* A prototype child target.  The client can override it with local
26    methods.  */
27
28 class inf_child_target
29   : public memory_breakpoint_target<target_ops>
30 {
31 public:
32   inf_child_target ();
33   ~inf_child_target () override = 0;
34
35   const target_info &info () const override;
36
37   void close () override;
38
39   void disconnect (const char *, int) override;
40
41   void fetch_registers (struct regcache *, int) override = 0;
42   void store_registers (struct regcache *, int) override = 0;
43
44   void prepare_to_store (struct regcache *) override;
45
46   bool supports_terminal_ours () override;
47   void terminal_init () override;
48   void terminal_inferior () override;
49   void terminal_ours_for_output () override;
50   void terminal_ours () override;
51   void terminal_info (const char *, int) override;
52
53   void interrupt () override;
54   void pass_ctrlc () override;
55
56   void post_startup_inferior (ptid_t) override;
57
58   void mourn_inferior () override;
59
60   bool can_run () override;
61
62   bool can_create_inferior () override;
63   void create_inferior (const char *, const std::string &,
64                         char **, int) override = 0;
65
66   bool can_attach () override;
67   void attach (const char *, int) override = 0;
68
69   void post_attach (int) override;
70
71   /* We must default these because they must be implemented by any
72      target that can run.  */
73   bool can_async_p ()  override { return false; }
74   bool supports_non_stop ()  override { return false; }
75   bool supports_disable_randomization () override { return false; }
76
77   char *pid_to_exec_file (int pid) override;
78
79   bool has_all_memory () override;
80   bool has_memory () override;
81   bool has_stack () override;
82   bool has_registers () override;
83   bool has_execution (ptid_t) override;
84
85   int fileio_open (struct inferior *inf, const char *filename,
86                    int flags, int mode, int warn_if_slow,
87                    int *target_errno) override;
88   int fileio_pwrite (int fd, const gdb_byte *write_buf, int len,
89                      ULONGEST offset, int *target_errno) override;
90   int fileio_pread (int fd, gdb_byte *read_buf, int len,
91                     ULONGEST offset, int *target_errno) override;
92   int fileio_fstat (int fd, struct stat *sb, int *target_errno) override;
93   int fileio_close (int fd, int *target_errno) override;
94   int fileio_unlink (struct inferior *inf,
95                      const char *filename,
96                      int *target_errno) override;
97   gdb::optional<std::string> fileio_readlink (struct inferior *inf,
98                                               const char *filename,
99                                               int *target_errno) override;
100   bool use_agent (bool use) override;
101
102   bool can_use_agent () override;
103
104 protected:
105   /* Unpush the target if it wasn't explicitly open with "target native"
106      and there are no live inferiors left.  Note: if calling this as a
107      result of a mourn or detach, the current inferior shall already
108      have its PID cleared, so it isn't counted as live.  That's usually
109      done by calling either generic_mourn_inferior or
110      detach_inferior.  */
111   void maybe_unpush_target ();
112 };
113
114 /* Functions for helping to write a native target.  */
115
116 /* This is for native targets which use a unix/POSIX-style waitstatus.  */
117 extern void store_waitstatus (struct target_waitstatus *, int);
118
119 /* Register TARGET as native target and set it up to respond to the
120    "target native" command.  */
121 extern void add_inf_child_target (inf_child_target *target);
122
123 /* target_open_ftype callback for inf-child targets.  Used by targets
124    that want to register an alternative target_info object.  Most
125    targets use add_inf_child_target instead.  */
126 extern void inf_child_open_target (const char *arg, int from_tty);
127
128 #endif