Commit | Line | Data |
---|---|---|
c906108c SS |
1 | /* Variables that describe the inferior process running under GDB: |
2 | Where it is, why it stopped, and how to step it. | |
1bac305b | 3 | |
e2882c85 | 4 | Copyright (C) 1986-2018 Free Software Foundation, Inc. |
c906108c | 5 | |
c5aa993b | 6 | This file is part of GDB. |
c906108c | 7 | |
c5aa993b JM |
8 | This program is free software; you can redistribute it and/or modify |
9 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 10 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 11 | (at your option) any later version. |
c906108c | 12 | |
c5aa993b JM |
13 | This program is distributed in the hope that it will be useful, |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | GNU General Public License for more details. | |
c906108c | 17 | |
c5aa993b | 18 | You should have received a copy of the GNU General Public License |
a9762ec7 | 19 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
20 | |
21 | #if !defined (INFERIOR_H) | |
22 | #define INFERIOR_H 1 | |
23 | ||
da3331ec AC |
24 | struct target_waitstatus; |
25 | struct frame_info; | |
26 | struct ui_file; | |
27 | struct type; | |
67a2b77e | 28 | struct gdbarch; |
72cec141 | 29 | struct regcache; |
b77209e0 | 30 | struct ui_out; |
7e1789f5 | 31 | struct terminal_info; |
6ecd4729 | 32 | struct target_desc_info; |
0550c955 | 33 | struct continuation; |
3a3fd0fd | 34 | struct inferior; |
00431a78 | 35 | struct thread_info; |
67a2b77e | 36 | |
c906108c SS |
37 | /* For bpstat. */ |
38 | #include "breakpoint.h" | |
39 | ||
2ea28649 | 40 | /* For enum gdb_signal. */ |
c906108c SS |
41 | #include "target.h" |
42 | ||
aa0cd9c1 AC |
43 | /* For struct frame_id. */ |
44 | #include "frame.h" | |
45 | ||
9a6c7d9c SDJ |
46 | /* For gdb_environ. */ |
47 | #include "environ.h" | |
48 | ||
6c95b8df | 49 | #include "progspace.h" |
8e260fc0 | 50 | #include "registry.h" |
6c95b8df | 51 | |
b15cc25c | 52 | #include "symfile-add-flags.h" |
3a3fd0fd | 53 | #include "common/refcounted-object.h" |
b15cc25c | 54 | |
2090129c SDJ |
55 | #include "common-inferior.h" |
56 | ||
16c381f0 JK |
57 | struct infcall_suspend_state; |
58 | struct infcall_control_state; | |
7a292a7a | 59 | |
16c381f0 JK |
60 | extern struct infcall_suspend_state *save_infcall_suspend_state (void); |
61 | extern struct infcall_control_state *save_infcall_control_state (void); | |
c906108c | 62 | |
16c381f0 JK |
63 | extern void restore_infcall_suspend_state (struct infcall_suspend_state *); |
64 | extern void restore_infcall_control_state (struct infcall_control_state *); | |
b89667eb | 65 | |
c7c4d3fa TT |
66 | /* A deleter for infcall_suspend_state that calls |
67 | restore_infcall_suspend_state. */ | |
68 | struct infcall_suspend_state_deleter | |
69 | { | |
70 | void operator() (struct infcall_suspend_state *state) const | |
71 | { | |
72 | restore_infcall_suspend_state (state); | |
73 | } | |
74 | }; | |
75 | ||
76 | /* A unique_ptr specialization for infcall_suspend_state. */ | |
77 | typedef std::unique_ptr<infcall_suspend_state, infcall_suspend_state_deleter> | |
78 | infcall_suspend_state_up; | |
79 | ||
80 | /* A deleter for infcall_control_state that calls | |
81 | restore_infcall_control_state. */ | |
82 | struct infcall_control_state_deleter | |
83 | { | |
84 | void operator() (struct infcall_control_state *state) const | |
85 | { | |
86 | restore_infcall_control_state (state); | |
87 | } | |
88 | }; | |
89 | ||
90 | /* A unique_ptr specialization for infcall_control_state. */ | |
91 | typedef std::unique_ptr<infcall_control_state, infcall_control_state_deleter> | |
92 | infcall_control_state_up; | |
b89667eb | 93 | |
16c381f0 JK |
94 | extern void discard_infcall_suspend_state (struct infcall_suspend_state *); |
95 | extern void discard_infcall_control_state (struct infcall_control_state *); | |
7a292a7a | 96 | |
daf6667d | 97 | extern readonly_detached_regcache * |
16c381f0 | 98 | get_infcall_suspend_state_regcache (struct infcall_suspend_state *); |
b89667eb | 99 | |
a14ed312 | 100 | extern void set_sigint_trap (void); |
c906108c | 101 | |
a14ed312 | 102 | extern void clear_sigint_trap (void); |
c906108c | 103 | |
3cb3b8df | 104 | /* Set/get file name for default use for standard in/out in the inferior. */ |
c906108c | 105 | |
3cb3b8df BR |
106 | extern void set_inferior_io_terminal (const char *terminal_name); |
107 | extern const char *get_inferior_io_terminal (void); | |
c906108c | 108 | |
39f77062 | 109 | /* Collected pid, tid, etc. of the debugged inferior. When there's |
e99b03dc | 110 | no inferior, inferior_ptid.pid () will be 0. */ |
c906108c | 111 | |
39f77062 | 112 | extern ptid_t inferior_ptid; |
c906108c | 113 | |
a14ed312 | 114 | extern void generic_mourn_inferior (void); |
c906108c | 115 | |
9898f801 UW |
116 | extern CORE_ADDR unsigned_pointer_to_address (struct gdbarch *gdbarch, |
117 | struct type *type, | |
b60c417a | 118 | const gdb_byte *buf); |
9898f801 UW |
119 | extern void unsigned_address_to_pointer (struct gdbarch *gdbarch, |
120 | struct type *type, gdb_byte *buf, | |
ac2e2ef7 | 121 | CORE_ADDR addr); |
9898f801 UW |
122 | extern CORE_ADDR signed_pointer_to_address (struct gdbarch *gdbarch, |
123 | struct type *type, | |
b60c417a | 124 | const gdb_byte *buf); |
9898f801 UW |
125 | extern void address_to_signed_pointer (struct gdbarch *gdbarch, |
126 | struct type *type, gdb_byte *buf, | |
ac2e2ef7 | 127 | CORE_ADDR addr); |
4478b372 | 128 | |
a14ed312 | 129 | extern void reopen_exec_file (void); |
c906108c | 130 | |
c906108c SS |
131 | /* From misc files */ |
132 | ||
0ab7a791 AC |
133 | extern void default_print_registers_info (struct gdbarch *gdbarch, |
134 | struct ui_file *file, | |
135 | struct frame_info *frame, | |
136 | int regnum, int all); | |
666e11c5 | 137 | |
cc86d1cb YQ |
138 | /* Default implementation of gdbarch_print_float_info. Print |
139 | the values of all floating point registers. */ | |
140 | ||
141 | extern void default_print_float_info (struct gdbarch *gdbarch, | |
142 | struct ui_file *file, | |
143 | struct frame_info *frame, | |
144 | const char *args); | |
145 | ||
0a4f40a2 | 146 | extern void child_terminal_info (struct target_ops *self, const char *, int); |
c906108c | 147 | |
11db9430 | 148 | extern void info_terminal_command (char *, int); |
c906108c | 149 | |
d6b64346 PA |
150 | extern void child_terminal_ours (struct target_ops *self); |
151 | ||
152 | extern void child_terminal_ours_for_output (struct target_ops *self); | |
c906108c | 153 | |
d6b64346 | 154 | extern void child_terminal_inferior (struct target_ops *self); |
c906108c | 155 | |
e671cd59 PA |
156 | extern void child_terminal_save_inferior (struct target_ops *self); |
157 | ||
d6b64346 | 158 | extern void child_terminal_init (struct target_ops *self); |
c906108c | 159 | |
d6b64346 | 160 | extern void child_terminal_init_with_pgrp (int pgrp); |
c906108c | 161 | |
e671cd59 PA |
162 | extern void child_pass_ctrlc (struct target_ops *self); |
163 | ||
164 | extern void child_interrupt (struct target_ops *self); | |
165 | ||
c906108c SS |
166 | /* From fork-child.c */ |
167 | ||
2090129c SDJ |
168 | /* Helper function to call STARTUP_INFERIOR with PID and NUM_TRAPS. |
169 | This function already calls set_executing. Return the ptid_t from | |
170 | STARTUP_INFERIOR. */ | |
171 | extern ptid_t gdb_startup_inferior (pid_t pid, int num_traps); | |
c906108c | 172 | |
bd57a748 | 173 | extern char *construct_inferior_arguments (int, char **); |
552c04a7 | 174 | |
c906108c SS |
175 | /* From infcmd.c */ |
176 | ||
6efcd9a8 PA |
177 | /* Initial inferior setup. Determines the exec file is not yet known, |
178 | takes any necessary post-attaching actions, fetches the target | |
179 | description and syncs the shared library list. */ | |
180 | ||
181 | extern void setup_inferior (int from_tty); | |
182 | ||
281b533b DJ |
183 | extern void post_create_inferior (struct target_ops *, int); |
184 | ||
0b39b52e | 185 | extern void attach_command (const char *, int); |
c906108c | 186 | |
cbaaa0ca | 187 | extern const char *get_inferior_args (void); |
07091751 | 188 | |
0b39b52e | 189 | extern void set_inferior_args (const char *); |
07091751 | 190 | |
552c04a7 TT |
191 | extern void set_inferior_args_vector (int, char **); |
192 | ||
1d12d88f | 193 | extern void registers_info (const char *, int); |
36dc181b | 194 | |
77ebaa5a VP |
195 | extern void continue_1 (int all_threads); |
196 | ||
77ebaa5a VP |
197 | extern void interrupt_target_1 (int all_threads); |
198 | ||
186c406b TT |
199 | extern void delete_longjmp_breakpoint_cleanup (void *arg); |
200 | ||
981a3fb3 | 201 | extern void detach_command (const char *, int); |
6418d433 | 202 | |
75cbc781 | 203 | extern void notice_new_inferior (struct thread_info *, int, int); |
1941c569 | 204 | |
0700e23e PA |
205 | extern struct value *get_return_value (struct value *function, |
206 | struct type *value_type); | |
cc72b2a2 | 207 | |
329ea579 PA |
208 | /* Prepare for execution command. TARGET is the target that will run |
209 | the command. BACKGROUND determines whether this is a foreground | |
210 | (synchronous) or background (asynchronous) command. */ | |
211 | ||
212 | extern void prepare_execution_command (struct target_ops *target, | |
213 | int background); | |
214 | ||
98882a26 PA |
215 | /* Whether to start up the debuggee under a shell. |
216 | ||
217 | If startup-with-shell is set, GDB's "run" will attempt to start up | |
218 | the debuggee under a shell. | |
219 | ||
220 | This is in order for argument-expansion to occur. E.g., | |
221 | ||
222 | (gdb) run * | |
223 | ||
224 | The "*" gets expanded by the shell into a list of files. | |
225 | ||
226 | While this is a nice feature, it may be handy to bypass the shell | |
227 | in some cases. To disable this feature, do "set startup-with-shell | |
228 | false". | |
229 | ||
230 | The catch-exec traps expected during start-up will be one more if | |
231 | the target is started up with a shell. */ | |
232 | extern int startup_with_shell; | |
233 | ||
c906108c SS |
234 | /* Nonzero if stopped due to completion of a stack dummy routine. */ |
235 | ||
aa7d318d | 236 | extern enum stop_stack_kind stop_stack_dummy; |
c906108c SS |
237 | |
238 | /* Nonzero if program stopped due to a random (unexpected) signal in | |
239 | inferior process. */ | |
240 | ||
241 | extern int stopped_by_random_signal; | |
242 | ||
f67c0c91 SDJ |
243 | /* Print notices on inferior events (attach, detach, etc.), set with |
244 | `set print inferior-events'. */ | |
245 | extern int print_inferior_events; | |
246 | ||
a49f981f MS |
247 | /* STEP_OVER_ALL means step over all subroutine calls. |
248 | STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions. | |
249 | STEP_OVER_NONE means don't step over any subroutine calls. */ | |
c906108c | 250 | |
5fbbeb29 CF |
251 | enum step_over_calls_kind |
252 | { | |
253 | STEP_OVER_NONE, | |
254 | STEP_OVER_ALL, | |
a4acd088 CF |
255 | STEP_OVER_UNDEBUGGABLE |
256 | }; | |
257 | ||
b0f4b84b DJ |
258 | /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller |
259 | will handle it themselves. STOP_QUIETLY is used when running in | |
260 | the shell before the child program has been exec'd and when running | |
261 | through shared library loading. STOP_QUIETLY_REMOTE is used when | |
262 | setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP | |
263 | except that there is no need to hide a signal. */ | |
c54cfec8 | 264 | |
7c0bc051 DE |
265 | /* STOP_QUIETLY_NO_SIGSTOP is used to handle a tricky situation with attach. |
266 | When doing an attach, the kernel stops the debuggee with a SIGSTOP. | |
267 | On newer GNU/Linux kernels (>= 2.5.61) the handling of SIGSTOP for | |
268 | a ptraced process has changed. Earlier versions of the kernel | |
269 | would ignore these SIGSTOPs, while now SIGSTOP is treated like any | |
270 | other signal, i.e. it is not muffled. | |
271 | ||
c54cfec8 EZ |
272 | If the gdb user does a 'continue' after the 'attach', gdb passes |
273 | the global variable stop_signal (which stores the signal from the | |
274 | attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is | |
275 | problematic, because the kernel doesn't ignore such SIGSTOP | |
1777feb0 | 276 | now. I.e. it is reported back to gdb, which in turn presents it |
c54cfec8 | 277 | back to the user. |
7c0bc051 | 278 | |
c54cfec8 EZ |
279 | To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows |
280 | gdb to clear the value of stop_signal after the attach, so that it | |
281 | is not passed back down to the kernel. */ | |
282 | ||
283 | enum stop_kind | |
284 | { | |
285 | NO_STOP_QUIETLY = 0, | |
286 | STOP_QUIETLY, | |
b0f4b84b | 287 | STOP_QUIETLY_REMOTE, |
c54cfec8 EZ |
288 | STOP_QUIETLY_NO_SIGSTOP |
289 | }; | |
c906108c | 290 | |
c906108c | 291 | \f |
faaf634c | 292 | /* Possible values for gdbarch_call_dummy_location. */ |
c906108c | 293 | #define ON_STACK 1 |
c906108c SS |
294 | #define AT_ENTRY_POINT 4 |
295 | ||
089354bb SM |
296 | /* Base class for target-specific inferior data. */ |
297 | ||
298 | struct private_inferior | |
299 | { | |
300 | virtual ~private_inferior () = 0; | |
301 | }; | |
b77209e0 | 302 | |
16c381f0 JK |
303 | /* Inferior process specific part of `struct infcall_control_state'. |
304 | ||
305 | Inferior thread counterpart is `struct thread_control_state'. */ | |
306 | ||
307 | struct inferior_control_state | |
308 | { | |
ee841dd8 TT |
309 | inferior_control_state () |
310 | : stop_soon (NO_STOP_QUIETLY) | |
311 | { | |
312 | } | |
313 | ||
314 | explicit inferior_control_state (enum stop_kind when) | |
315 | : stop_soon (when) | |
316 | { | |
317 | } | |
318 | ||
16c381f0 JK |
319 | /* See the definition of stop_kind above. */ |
320 | enum stop_kind stop_soon; | |
321 | }; | |
322 | ||
3a3fd0fd PA |
323 | /* Return a pointer to the current inferior. */ |
324 | extern inferior *current_inferior (); | |
325 | ||
326 | extern void set_current_inferior (inferior *); | |
327 | ||
b77209e0 PA |
328 | /* GDB represents the state of each program execution with an object |
329 | called an inferior. An inferior typically corresponds to a process | |
330 | but is more general and applies also to targets that do not have a | |
331 | notion of processes. Each run of an executable creates a new | |
332 | inferior, as does each attachment to an existing process. | |
333 | Inferiors have unique internal identifiers that are different from | |
334 | target process ids. Each inferior may in turn have multiple | |
3a3fd0fd PA |
335 | threads running in it. |
336 | ||
337 | Inferiors are intrusively refcounted objects. Unlike thread | |
338 | objects, being the user-selected inferior is considered a strong | |
339 | reference and is thus accounted for in the inferior object's | |
340 | refcount (see set_current_inferior). When GDB needs to remember | |
341 | the selected inferior to later restore it, GDB temporarily bumps | |
342 | the inferior object's refcount, to prevent something deleting the | |
343 | inferior object before reverting back (e.g., due to a | |
344 | "remove-inferiors" command (see | |
345 | make_cleanup_restore_current_thread). All other inferior | |
346 | references are considered weak references. Inferiors are always | |
347 | listed exactly once in the inferior list, so placing an inferior in | |
348 | the inferior list is an implicit, not counted strong reference. */ | |
349 | ||
350 | class inferior : public refcounted_object | |
b77209e0 | 351 | { |
0550c955 PA |
352 | public: |
353 | explicit inferior (int pid); | |
354 | ~inferior (); | |
355 | ||
3a3fd0fd PA |
356 | /* Returns true if we can delete this inferior. */ |
357 | bool deletable () const { return refcount () == 0; } | |
358 | ||
b77209e0 | 359 | /* Pointer to next inferior in singly-linked list of inferiors. */ |
0550c955 | 360 | struct inferior *next = NULL; |
b77209e0 PA |
361 | |
362 | /* Convenient handle (GDB inferior id). Unique across all | |
363 | inferiors. */ | |
0550c955 | 364 | int num = 0; |
b77209e0 PA |
365 | |
366 | /* Actual target inferior id, usually, a process id. This matches | |
367 | the ptid_t.pid member of threads of this inferior. */ | |
0550c955 | 368 | int pid = 0; |
e714e1bf | 369 | /* True if the PID was actually faked by GDB. */ |
0550c955 | 370 | bool fake_pid_p = false; |
b77209e0 | 371 | |
5d5658a1 | 372 | /* The highest thread number this inferior ever had. */ |
0550c955 | 373 | int highest_thread_num = 0; |
5d5658a1 | 374 | |
16c381f0 JK |
375 | /* State of GDB control of inferior process execution. |
376 | See `struct inferior_control_state'. */ | |
ee841dd8 | 377 | inferior_control_state control; |
16c381f0 | 378 | |
6c95b8df PA |
379 | /* True if this was an auto-created inferior, e.g. created from |
380 | following a fork; false, if this inferior was manually added by | |
381 | the user, and we should not attempt to prune it | |
382 | automatically. */ | |
0550c955 | 383 | bool removable = false; |
6c95b8df PA |
384 | |
385 | /* The address space bound to this inferior. */ | |
0550c955 | 386 | struct address_space *aspace = NULL; |
6c95b8df PA |
387 | |
388 | /* The program space bound to this inferior. */ | |
0550c955 | 389 | struct program_space *pspace = NULL; |
6c95b8df | 390 | |
3f81c18a | 391 | /* The arguments string to use when running. */ |
0550c955 | 392 | char *args = NULL; |
3f81c18a VP |
393 | |
394 | /* The size of elements in argv. */ | |
0550c955 | 395 | int argc = 0; |
3f81c18a VP |
396 | |
397 | /* The vector version of arguments. If ARGC is nonzero, | |
398 | then we must compute ARGS from this (via the target). | |
399 | This is always coming from main's argv and therefore | |
400 | should never be freed. */ | |
0550c955 | 401 | char **argv = NULL; |
3f81c18a | 402 | |
d092c5a2 SDJ |
403 | /* The current working directory that will be used when starting |
404 | this inferior. */ | |
405 | gdb::unique_xmalloc_ptr<char> cwd; | |
406 | ||
3f81c18a | 407 | /* The name of terminal device to use for I/O. */ |
0550c955 | 408 | char *terminal = NULL; |
3f81c18a | 409 | |
e671cd59 PA |
410 | /* The terminal state as set by the last target_terminal::terminal_* |
411 | call. */ | |
412 | target_terminal_state terminal_state = target_terminal_state::is_ours; | |
413 | ||
3f81c18a VP |
414 | /* Environment to use for running inferior, |
415 | in format described in environ.h. */ | |
9a6c7d9c | 416 | gdb_environ environment; |
3f81c18a | 417 | |
0550c955 PA |
418 | /* True if this child process was attached rather than forked. */ |
419 | bool attach_flag = false; | |
181e7f93 | 420 | |
6c95b8df PA |
421 | /* If this inferior is a vfork child, then this is the pointer to |
422 | its vfork parent, if GDB is still attached to it. */ | |
0550c955 | 423 | inferior *vfork_parent = NULL; |
6c95b8df PA |
424 | |
425 | /* If this process is a vfork parent, this is the pointer to the | |
426 | child. Since a vfork parent is left frozen by the kernel until | |
427 | the child execs or exits, a process can only have one vfork child | |
428 | at a given time. */ | |
0550c955 | 429 | inferior *vfork_child = NULL; |
6c95b8df PA |
430 | |
431 | /* True if this inferior should be detached when it's vfork sibling | |
432 | exits or execs. */ | |
0550c955 | 433 | bool pending_detach = false; |
6c95b8df PA |
434 | |
435 | /* True if this inferior is a vfork parent waiting for a vfork child | |
436 | not under our control to be done with the shared memory region, | |
437 | either by exiting or execing. */ | |
0550c955 | 438 | bool waiting_for_vfork_done = false; |
6c95b8df | 439 | |
24291992 | 440 | /* True if we're in the process of detaching from this inferior. */ |
9bcb1f16 | 441 | bool detaching = false; |
24291992 | 442 | |
e0ba6746 PA |
443 | /* What is left to do for an execution command after any thread of |
444 | this inferior stops. For continuations associated with a | |
445 | specific thread, see `struct thread_info'. */ | |
0550c955 | 446 | continuation *continuations = NULL; |
e0ba6746 | 447 | |
6efcd9a8 PA |
448 | /* True if setup_inferior wasn't called for this inferior yet. |
449 | Until that is done, we must not access inferior memory or | |
450 | registers, as we haven't determined the target | |
451 | architecture/description. */ | |
0550c955 | 452 | bool needs_setup = false; |
6efcd9a8 | 453 | |
b77209e0 | 454 | /* Private data used by the target vector implementation. */ |
089354bb | 455 | std::unique_ptr<private_inferior> priv; |
a96d9b2e | 456 | |
8cf64490 TT |
457 | /* HAS_EXIT_CODE is true if the inferior exited with an exit code. |
458 | In this case, the EXIT_CODE field is also valid. */ | |
0550c955 PA |
459 | bool has_exit_code = false; |
460 | LONGEST exit_code = 0; | |
8cf64490 | 461 | |
7dcd53a0 | 462 | /* Default flags to pass to the symbol reading functions. These are |
b15cc25c | 463 | used whenever a new objfile is created. */ |
0550c955 | 464 | symfile_add_flags symfile_flags = 0; |
7dcd53a0 | 465 | |
6ecd4729 PA |
466 | /* Info about an inferior's target description (if it's fetched; the |
467 | user supplied description's filename, if any; etc.). */ | |
0550c955 | 468 | target_desc_info *tdesc_info = NULL; |
6ecd4729 PA |
469 | |
470 | /* The architecture associated with the inferior through the | |
471 | connection to the target. | |
472 | ||
473 | The architecture vector provides some information that is really | |
474 | a property of the inferior, accessed through a particular target: | |
475 | ptrace operations; the layout of certain RSP packets; the | |
476 | solib_ops vector; etc. To differentiate architecture accesses to | |
477 | per-inferior/target properties from | |
478 | per-thread/per-frame/per-objfile properties, accesses to | |
479 | per-inferior/target properties should be made through | |
480 | this gdbarch. */ | |
0550c955 | 481 | struct gdbarch *gdbarch = NULL; |
6ecd4729 | 482 | |
6c95b8df | 483 | /* Per inferior data-pointers required by other GDB modules. */ |
8e260fc0 | 484 | REGISTRY_FIELDS; |
b77209e0 PA |
485 | }; |
486 | ||
6c95b8df PA |
487 | /* Keep a registry of per-inferior data-pointers required by other GDB |
488 | modules. */ | |
489 | ||
8e260fc0 | 490 | DECLARE_REGISTRY (inferior); |
6c95b8df | 491 | |
b77209e0 PA |
492 | /* Add an inferior to the inferior list, print a message that a new |
493 | inferior is found, and return the pointer to the new inferior. | |
494 | Caller may use this pointer to initialize the private inferior | |
495 | data. */ | |
496 | extern struct inferior *add_inferior (int pid); | |
497 | ||
498 | /* Same as add_inferior, but don't print new inferior notifications to | |
499 | the CLI. */ | |
500 | extern struct inferior *add_inferior_silent (int pid); | |
501 | ||
7a41607e | 502 | extern void delete_inferior (struct inferior *todel); |
b77209e0 PA |
503 | |
504 | /* Delete an existing inferior list entry, due to inferior detaching. */ | |
bc09b0c1 SM |
505 | extern void detach_inferior (inferior *inf); |
506 | ||
00431a78 | 507 | extern void exit_inferior (inferior *inf); |
b77209e0 | 508 | |
00431a78 | 509 | extern void exit_inferior_silent (inferior *inf); |
6c95b8df PA |
510 | |
511 | extern void exit_inferior_num_silent (int num); | |
512 | ||
513 | extern void inferior_appeared (struct inferior *inf, int pid); | |
514 | ||
82f73884 PA |
515 | /* Get rid of all inferiors. */ |
516 | extern void discard_all_inferiors (void); | |
517 | ||
6c95b8df | 518 | /* Search function to lookup an inferior by target 'pid'. */ |
b77209e0 PA |
519 | extern struct inferior *find_inferior_pid (int pid); |
520 | ||
c9657e70 SM |
521 | /* Search function to lookup an inferior whose pid is equal to 'ptid.pid'. */ |
522 | extern struct inferior *find_inferior_ptid (ptid_t ptid); | |
523 | ||
6c95b8df PA |
524 | /* Search function to lookup an inferior by GDB 'num'. */ |
525 | extern struct inferior *find_inferior_id (int num); | |
526 | ||
32990ada PA |
527 | /* Find an inferior bound to PSPACE, giving preference to the current |
528 | inferior. */ | |
6c95b8df PA |
529 | extern struct inferior * |
530 | find_inferior_for_program_space (struct program_space *pspace); | |
531 | ||
b77209e0 PA |
532 | /* Inferior iterator function. |
533 | ||
534 | Calls a callback function once for each inferior, so long as the | |
535 | callback function returns false. If the callback function returns | |
536 | true, the iteration will end and the current inferior will be | |
537 | returned. This can be useful for implementing a search for a | |
538 | inferior with arbitrary attributes, or for applying some operation | |
539 | to every inferior. | |
540 | ||
541 | It is safe to delete the iterated inferior from the callback. */ | |
542 | extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *, | |
543 | void *), | |
544 | void *); | |
545 | ||
b77209e0 PA |
546 | /* Returns true if the inferior list is not empty. */ |
547 | extern int have_inferiors (void); | |
548 | ||
8020350c DB |
549 | /* Returns the number of live inferiors (real live processes). */ |
550 | extern int number_of_live_inferiors (void); | |
551 | ||
c35b1492 PA |
552 | /* Returns true if there are any live inferiors in the inferior list |
553 | (not cores, not executables, real live processes). */ | |
554 | extern int have_live_inferiors (void); | |
555 | ||
5ed8105e PA |
556 | /* Save/restore the current inferior. */ |
557 | ||
558 | class scoped_restore_current_inferior | |
559 | { | |
560 | public: | |
561 | scoped_restore_current_inferior () | |
562 | : m_saved_inf (current_inferior ()) | |
563 | {} | |
564 | ||
565 | ~scoped_restore_current_inferior () | |
566 | { set_current_inferior (m_saved_inf); } | |
567 | ||
d6541620 | 568 | DISABLE_COPY_AND_ASSIGN (scoped_restore_current_inferior); |
5ed8105e PA |
569 | |
570 | private: | |
571 | inferior *m_saved_inf; | |
572 | }; | |
573 | ||
6c95b8df | 574 | |
c65b3e0d PA |
575 | /* Traverse all inferiors. */ |
576 | ||
577 | #define ALL_INFERIORS(I) \ | |
578 | for ((I) = inferior_list; (I); (I) = (I)->next) | |
579 | ||
85ad3aaf PA |
580 | /* Traverse all non-exited inferiors. */ |
581 | ||
582 | #define ALL_NON_EXITED_INFERIORS(I) \ | |
583 | ALL_INFERIORS (I) \ | |
584 | if ((I)->pid != 0) | |
585 | ||
6c95b8df PA |
586 | extern struct inferior *inferior_list; |
587 | ||
588 | /* Prune away automatically added inferiors that aren't required | |
589 | anymore. */ | |
590 | extern void prune_inferiors (void); | |
591 | ||
592 | extern int number_of_inferiors (void); | |
593 | ||
a79b8f6e VP |
594 | extern struct inferior *add_inferior_with_spaces (void); |
595 | ||
4034d0ff AT |
596 | /* Print the current selected inferior. */ |
597 | extern void print_selected_inferior (struct ui_out *uiout); | |
598 | ||
c906108c | 599 | #endif /* !defined (INFERIOR_H) */ |