| 1 | /* Variables that describe the inferior process running under GDB: |
| 2 | Where it is, why it stopped, and how to step it. |
| 3 | |
| 4 | Copyright (C) 1986-2020 Free Software Foundation, Inc. |
| 5 | |
| 6 | This file is part of GDB. |
| 7 | |
| 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 |
| 10 | the Free Software Foundation; either version 3 of the License, or |
| 11 | (at your option) any later version. |
| 12 | |
| 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. |
| 17 | |
| 18 | You should have received a copy of the GNU General Public License |
| 19 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
| 20 | |
| 21 | #if !defined (INFERIOR_H) |
| 22 | #define INFERIOR_H 1 |
| 23 | |
| 24 | struct target_waitstatus; |
| 25 | struct frame_info; |
| 26 | struct ui_file; |
| 27 | struct type; |
| 28 | struct gdbarch; |
| 29 | struct regcache; |
| 30 | struct ui_out; |
| 31 | struct terminal_info; |
| 32 | struct target_desc_info; |
| 33 | struct continuation; |
| 34 | struct inferior; |
| 35 | struct thread_info; |
| 36 | |
| 37 | /* For bpstat. */ |
| 38 | #include "breakpoint.h" |
| 39 | |
| 40 | /* For enum gdb_signal. */ |
| 41 | #include "target.h" |
| 42 | |
| 43 | /* For struct frame_id. */ |
| 44 | #include "frame.h" |
| 45 | |
| 46 | /* For gdb_environ. */ |
| 47 | #include "gdbsupport/environ.h" |
| 48 | |
| 49 | #include "progspace.h" |
| 50 | #include "registry.h" |
| 51 | |
| 52 | #include "symfile-add-flags.h" |
| 53 | #include "gdbsupport/refcounted-object.h" |
| 54 | #include "gdbsupport/forward-scope-exit.h" |
| 55 | |
| 56 | #include "gdbsupport/common-inferior.h" |
| 57 | #include "gdbthread.h" |
| 58 | |
| 59 | #include "process-stratum-target.h" |
| 60 | |
| 61 | struct infcall_suspend_state; |
| 62 | struct infcall_control_state; |
| 63 | |
| 64 | extern void restore_infcall_suspend_state (struct infcall_suspend_state *); |
| 65 | extern void restore_infcall_control_state (struct infcall_control_state *); |
| 66 | |
| 67 | /* A deleter for infcall_suspend_state that calls |
| 68 | restore_infcall_suspend_state. */ |
| 69 | struct infcall_suspend_state_deleter |
| 70 | { |
| 71 | void operator() (struct infcall_suspend_state *state) const |
| 72 | { |
| 73 | try |
| 74 | { |
| 75 | restore_infcall_suspend_state (state); |
| 76 | } |
| 77 | catch (const gdb_exception_error &e) |
| 78 | { |
| 79 | /* If we are restoring the inferior state due to an exception, |
| 80 | some error message will be printed. So, only warn the user |
| 81 | when we cannot restore during normal execution. */ |
| 82 | if (!std::uncaught_exception ()) |
| 83 | warning (_("Failed to restore inferior state: %s"), e.what ()); |
| 84 | } |
| 85 | } |
| 86 | }; |
| 87 | |
| 88 | /* A unique_ptr specialization for infcall_suspend_state. */ |
| 89 | typedef std::unique_ptr<infcall_suspend_state, infcall_suspend_state_deleter> |
| 90 | infcall_suspend_state_up; |
| 91 | |
| 92 | extern infcall_suspend_state_up save_infcall_suspend_state (); |
| 93 | |
| 94 | /* A deleter for infcall_control_state that calls |
| 95 | restore_infcall_control_state. */ |
| 96 | struct infcall_control_state_deleter |
| 97 | { |
| 98 | void operator() (struct infcall_control_state *state) const |
| 99 | { |
| 100 | restore_infcall_control_state (state); |
| 101 | } |
| 102 | }; |
| 103 | |
| 104 | /* A unique_ptr specialization for infcall_control_state. */ |
| 105 | typedef std::unique_ptr<infcall_control_state, infcall_control_state_deleter> |
| 106 | infcall_control_state_up; |
| 107 | |
| 108 | extern infcall_control_state_up save_infcall_control_state (); |
| 109 | |
| 110 | extern void discard_infcall_suspend_state (struct infcall_suspend_state *); |
| 111 | extern void discard_infcall_control_state (struct infcall_control_state *); |
| 112 | |
| 113 | extern readonly_detached_regcache * |
| 114 | get_infcall_suspend_state_regcache (struct infcall_suspend_state *); |
| 115 | |
| 116 | extern void set_sigint_trap (void); |
| 117 | |
| 118 | extern void clear_sigint_trap (void); |
| 119 | |
| 120 | /* Set/get file name for default use for standard in/out in the inferior. */ |
| 121 | |
| 122 | extern void set_inferior_io_terminal (const char *terminal_name); |
| 123 | extern const char *get_inferior_io_terminal (void); |
| 124 | |
| 125 | /* Collected pid, tid, etc. of the debugged inferior. When there's |
| 126 | no inferior, inferior_ptid.pid () will be 0. */ |
| 127 | |
| 128 | extern ptid_t inferior_ptid; |
| 129 | |
| 130 | extern void generic_mourn_inferior (void); |
| 131 | |
| 132 | extern CORE_ADDR unsigned_pointer_to_address (struct gdbarch *gdbarch, |
| 133 | struct type *type, |
| 134 | const gdb_byte *buf); |
| 135 | extern void unsigned_address_to_pointer (struct gdbarch *gdbarch, |
| 136 | struct type *type, gdb_byte *buf, |
| 137 | CORE_ADDR addr); |
| 138 | extern CORE_ADDR signed_pointer_to_address (struct gdbarch *gdbarch, |
| 139 | struct type *type, |
| 140 | const gdb_byte *buf); |
| 141 | extern void address_to_signed_pointer (struct gdbarch *gdbarch, |
| 142 | struct type *type, gdb_byte *buf, |
| 143 | CORE_ADDR addr); |
| 144 | |
| 145 | extern void reopen_exec_file (void); |
| 146 | |
| 147 | /* From misc files */ |
| 148 | |
| 149 | extern void default_print_registers_info (struct gdbarch *gdbarch, |
| 150 | struct ui_file *file, |
| 151 | struct frame_info *frame, |
| 152 | int regnum, int all); |
| 153 | |
| 154 | /* Default implementation of gdbarch_print_float_info. Print |
| 155 | the values of all floating point registers. */ |
| 156 | |
| 157 | extern void default_print_float_info (struct gdbarch *gdbarch, |
| 158 | struct ui_file *file, |
| 159 | struct frame_info *frame, |
| 160 | const char *args); |
| 161 | |
| 162 | extern void child_terminal_info (struct target_ops *self, const char *, int); |
| 163 | |
| 164 | extern void child_terminal_ours (struct target_ops *self); |
| 165 | |
| 166 | extern void child_terminal_ours_for_output (struct target_ops *self); |
| 167 | |
| 168 | extern void child_terminal_inferior (struct target_ops *self); |
| 169 | |
| 170 | extern void child_terminal_save_inferior (struct target_ops *self); |
| 171 | |
| 172 | extern void child_terminal_init (struct target_ops *self); |
| 173 | |
| 174 | extern void child_terminal_init_with_pgrp (int pgrp); |
| 175 | |
| 176 | extern void child_pass_ctrlc (struct target_ops *self); |
| 177 | |
| 178 | extern void child_interrupt (struct target_ops *self); |
| 179 | |
| 180 | /* From fork-child.c */ |
| 181 | |
| 182 | /* Helper function to call STARTUP_INFERIOR with PID and NUM_TRAPS. |
| 183 | This function already calls set_executing. Return the ptid_t from |
| 184 | STARTUP_INFERIOR. */ |
| 185 | extern ptid_t gdb_startup_inferior (pid_t pid, int num_traps); |
| 186 | |
| 187 | extern char *construct_inferior_arguments (int, char **); |
| 188 | |
| 189 | /* From infcmd.c */ |
| 190 | |
| 191 | /* Initial inferior setup. Determines the exec file is not yet known, |
| 192 | takes any necessary post-attaching actions, fetches the target |
| 193 | description and syncs the shared library list. */ |
| 194 | |
| 195 | extern void setup_inferior (int from_tty); |
| 196 | |
| 197 | extern void post_create_inferior (struct target_ops *, int); |
| 198 | |
| 199 | extern void attach_command (const char *, int); |
| 200 | |
| 201 | extern const char *get_inferior_args (void); |
| 202 | |
| 203 | extern void set_inferior_args (const char *); |
| 204 | |
| 205 | extern void set_inferior_args_vector (int, char **); |
| 206 | |
| 207 | extern void registers_info (const char *, int); |
| 208 | |
| 209 | extern void continue_1 (int all_threads); |
| 210 | |
| 211 | extern void interrupt_target_1 (bool all_threads); |
| 212 | |
| 213 | using delete_longjmp_breakpoint_cleanup |
| 214 | = FORWARD_SCOPE_EXIT (delete_longjmp_breakpoint); |
| 215 | |
| 216 | extern void detach_command (const char *, int); |
| 217 | |
| 218 | extern void notice_new_inferior (struct thread_info *, int, int); |
| 219 | |
| 220 | extern struct value *get_return_value (struct value *function, |
| 221 | struct type *value_type); |
| 222 | |
| 223 | /* Prepare for execution command. TARGET is the target that will run |
| 224 | the command. BACKGROUND determines whether this is a foreground |
| 225 | (synchronous) or background (asynchronous) command. */ |
| 226 | |
| 227 | extern void prepare_execution_command (struct target_ops *target, |
| 228 | int background); |
| 229 | |
| 230 | /* Nonzero if stopped due to completion of a stack dummy routine. */ |
| 231 | |
| 232 | extern enum stop_stack_kind stop_stack_dummy; |
| 233 | |
| 234 | /* Nonzero if program stopped due to a random (unexpected) signal in |
| 235 | inferior process. */ |
| 236 | |
| 237 | extern int stopped_by_random_signal; |
| 238 | |
| 239 | /* Print notices on inferior events (attach, detach, etc.), set with |
| 240 | `set print inferior-events'. */ |
| 241 | extern bool print_inferior_events; |
| 242 | |
| 243 | /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller |
| 244 | will handle it themselves. STOP_QUIETLY is used when running in |
| 245 | the shell before the child program has been exec'd and when running |
| 246 | through shared library loading. STOP_QUIETLY_REMOTE is used when |
| 247 | setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP |
| 248 | except that there is no need to hide a signal. */ |
| 249 | |
| 250 | /* STOP_QUIETLY_NO_SIGSTOP is used to handle a tricky situation with attach. |
| 251 | When doing an attach, the kernel stops the debuggee with a SIGSTOP. |
| 252 | On newer GNU/Linux kernels (>= 2.5.61) the handling of SIGSTOP for |
| 253 | a ptraced process has changed. Earlier versions of the kernel |
| 254 | would ignore these SIGSTOPs, while now SIGSTOP is treated like any |
| 255 | other signal, i.e. it is not muffled. |
| 256 | |
| 257 | If the gdb user does a 'continue' after the 'attach', gdb passes |
| 258 | the global variable stop_signal (which stores the signal from the |
| 259 | attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is |
| 260 | problematic, because the kernel doesn't ignore such SIGSTOP |
| 261 | now. I.e. it is reported back to gdb, which in turn presents it |
| 262 | back to the user. |
| 263 | |
| 264 | To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows |
| 265 | gdb to clear the value of stop_signal after the attach, so that it |
| 266 | is not passed back down to the kernel. */ |
| 267 | |
| 268 | enum stop_kind |
| 269 | { |
| 270 | NO_STOP_QUIETLY = 0, |
| 271 | STOP_QUIETLY, |
| 272 | STOP_QUIETLY_REMOTE, |
| 273 | STOP_QUIETLY_NO_SIGSTOP |
| 274 | }; |
| 275 | |
| 276 | \f |
| 277 | /* Possible values for gdbarch_call_dummy_location. */ |
| 278 | #define ON_STACK 1 |
| 279 | #define AT_ENTRY_POINT 4 |
| 280 | |
| 281 | /* Base class for target-specific inferior data. */ |
| 282 | |
| 283 | struct private_inferior |
| 284 | { |
| 285 | virtual ~private_inferior () = 0; |
| 286 | }; |
| 287 | |
| 288 | /* Inferior process specific part of `struct infcall_control_state'. |
| 289 | |
| 290 | Inferior thread counterpart is `struct thread_control_state'. */ |
| 291 | |
| 292 | struct inferior_control_state |
| 293 | { |
| 294 | inferior_control_state () |
| 295 | : stop_soon (NO_STOP_QUIETLY) |
| 296 | { |
| 297 | } |
| 298 | |
| 299 | explicit inferior_control_state (enum stop_kind when) |
| 300 | : stop_soon (when) |
| 301 | { |
| 302 | } |
| 303 | |
| 304 | /* See the definition of stop_kind above. */ |
| 305 | enum stop_kind stop_soon; |
| 306 | }; |
| 307 | |
| 308 | /* Return a pointer to the current inferior. */ |
| 309 | extern inferior *current_inferior (); |
| 310 | |
| 311 | extern void set_current_inferior (inferior *); |
| 312 | |
| 313 | /* Switch inferior (and program space) to INF, and switch to no thread |
| 314 | selected. */ |
| 315 | extern void switch_to_inferior_no_thread (inferior *inf); |
| 316 | |
| 317 | /* GDB represents the state of each program execution with an object |
| 318 | called an inferior. An inferior typically corresponds to a process |
| 319 | but is more general and applies also to targets that do not have a |
| 320 | notion of processes. Each run of an executable creates a new |
| 321 | inferior, as does each attachment to an existing process. |
| 322 | Inferiors have unique internal identifiers that are different from |
| 323 | target process ids. Each inferior may in turn have multiple |
| 324 | threads running in it. |
| 325 | |
| 326 | Inferiors are intrusively refcounted objects. Unlike thread |
| 327 | objects, being the user-selected inferior is considered a strong |
| 328 | reference and is thus accounted for in the inferior object's |
| 329 | refcount (see set_current_inferior). When GDB needs to remember |
| 330 | the selected inferior to later restore it, GDB temporarily bumps |
| 331 | the inferior object's refcount, to prevent something deleting the |
| 332 | inferior object before reverting back (e.g., due to a |
| 333 | "remove-inferiors" command (see |
| 334 | scoped_restore_current_inferior). All other inferior |
| 335 | references are considered weak references. Inferiors are always |
| 336 | listed exactly once in the inferior list, so placing an inferior in |
| 337 | the inferior list is an implicit, not counted strong reference. */ |
| 338 | |
| 339 | class inferior : public refcounted_object |
| 340 | { |
| 341 | public: |
| 342 | explicit inferior (int pid); |
| 343 | ~inferior (); |
| 344 | |
| 345 | /* Returns true if we can delete this inferior. */ |
| 346 | bool deletable () const { return refcount () == 0; } |
| 347 | |
| 348 | /* Push T in this inferior's target stack. */ |
| 349 | void push_target (struct target_ops *t) |
| 350 | { m_target_stack.push (t); } |
| 351 | |
| 352 | /* Unpush T from this inferior's target stack. */ |
| 353 | int unpush_target (struct target_ops *t) |
| 354 | { return m_target_stack.unpush (t); } |
| 355 | |
| 356 | /* Returns true if T is pushed in this inferior's target stack. */ |
| 357 | bool target_is_pushed (target_ops *t) |
| 358 | { return m_target_stack.is_pushed (t); } |
| 359 | |
| 360 | /* Find the target beneath T in this inferior's target stack. */ |
| 361 | target_ops *find_target_beneath (const target_ops *t) |
| 362 | { return m_target_stack.find_beneath (t); } |
| 363 | |
| 364 | /* Return the target at the top of this inferior's target stack. */ |
| 365 | target_ops *top_target () |
| 366 | { return m_target_stack.top (); } |
| 367 | |
| 368 | /* Return the target at process_stratum level in this inferior's |
| 369 | target stack. */ |
| 370 | struct process_stratum_target *process_target () |
| 371 | { return (process_stratum_target *) m_target_stack.at (process_stratum); } |
| 372 | |
| 373 | /* Return the target at STRATUM in this inferior's target stack. */ |
| 374 | target_ops *target_at (enum strata stratum) |
| 375 | { return m_target_stack.at (stratum); } |
| 376 | |
| 377 | bool has_execution () |
| 378 | { return target_has_execution_1 (this); } |
| 379 | |
| 380 | /* Pointer to next inferior in singly-linked list of inferiors. */ |
| 381 | struct inferior *next = NULL; |
| 382 | |
| 383 | /* This inferior's thread list. */ |
| 384 | thread_info *thread_list = nullptr; |
| 385 | |
| 386 | /* Returns a range adapter covering the inferior's threads, |
| 387 | including exited threads. Used like this: |
| 388 | |
| 389 | for (thread_info *thr : inf->threads ()) |
| 390 | { .... } |
| 391 | */ |
| 392 | inf_threads_range threads () |
| 393 | { return inf_threads_range (this->thread_list); } |
| 394 | |
| 395 | /* Returns a range adapter covering the inferior's non-exited |
| 396 | threads. Used like this: |
| 397 | |
| 398 | for (thread_info *thr : inf->non_exited_threads ()) |
| 399 | { .... } |
| 400 | */ |
| 401 | inf_non_exited_threads_range non_exited_threads () |
| 402 | { return inf_non_exited_threads_range (this->thread_list); } |
| 403 | |
| 404 | /* Like inferior::threads(), but returns a range adapter that can be |
| 405 | used with range-for, safely. I.e., it is safe to delete the |
| 406 | currently-iterated thread, like this: |
| 407 | |
| 408 | for (thread_info *t : inf->threads_safe ()) |
| 409 | if (some_condition ()) |
| 410 | delete f; |
| 411 | */ |
| 412 | inline safe_inf_threads_range threads_safe () |
| 413 | { return safe_inf_threads_range (this->thread_list); } |
| 414 | |
| 415 | /* Convenient handle (GDB inferior id). Unique across all |
| 416 | inferiors. */ |
| 417 | int num = 0; |
| 418 | |
| 419 | /* Actual target inferior id, usually, a process id. This matches |
| 420 | the ptid_t.pid member of threads of this inferior. */ |
| 421 | int pid = 0; |
| 422 | /* True if the PID was actually faked by GDB. */ |
| 423 | bool fake_pid_p = false; |
| 424 | |
| 425 | /* The highest thread number this inferior ever had. */ |
| 426 | int highest_thread_num = 0; |
| 427 | |
| 428 | /* State of GDB control of inferior process execution. |
| 429 | See `struct inferior_control_state'. */ |
| 430 | inferior_control_state control; |
| 431 | |
| 432 | /* True if this was an auto-created inferior, e.g. created from |
| 433 | following a fork; false, if this inferior was manually added by |
| 434 | the user, and we should not attempt to prune it |
| 435 | automatically. */ |
| 436 | bool removable = false; |
| 437 | |
| 438 | /* The address space bound to this inferior. */ |
| 439 | struct address_space *aspace = NULL; |
| 440 | |
| 441 | /* The program space bound to this inferior. */ |
| 442 | struct program_space *pspace = NULL; |
| 443 | |
| 444 | /* The arguments string to use when running. */ |
| 445 | char *args = NULL; |
| 446 | |
| 447 | /* The size of elements in argv. */ |
| 448 | int argc = 0; |
| 449 | |
| 450 | /* The vector version of arguments. If ARGC is nonzero, |
| 451 | then we must compute ARGS from this (via the target). |
| 452 | This is always coming from main's argv and therefore |
| 453 | should never be freed. */ |
| 454 | char **argv = NULL; |
| 455 | |
| 456 | /* The current working directory that will be used when starting |
| 457 | this inferior. */ |
| 458 | gdb::unique_xmalloc_ptr<char> cwd; |
| 459 | |
| 460 | /* The name of terminal device to use for I/O. */ |
| 461 | char *terminal = NULL; |
| 462 | |
| 463 | /* The terminal state as set by the last target_terminal::terminal_* |
| 464 | call. */ |
| 465 | target_terminal_state terminal_state = target_terminal_state::is_ours; |
| 466 | |
| 467 | /* Environment to use for running inferior, |
| 468 | in format described in environ.h. */ |
| 469 | gdb_environ environment; |
| 470 | |
| 471 | /* True if this child process was attached rather than forked. */ |
| 472 | bool attach_flag = false; |
| 473 | |
| 474 | /* If this inferior is a vfork child, then this is the pointer to |
| 475 | its vfork parent, if GDB is still attached to it. */ |
| 476 | inferior *vfork_parent = NULL; |
| 477 | |
| 478 | /* If this process is a vfork parent, this is the pointer to the |
| 479 | child. Since a vfork parent is left frozen by the kernel until |
| 480 | the child execs or exits, a process can only have one vfork child |
| 481 | at a given time. */ |
| 482 | inferior *vfork_child = NULL; |
| 483 | |
| 484 | /* True if this inferior should be detached when it's vfork sibling |
| 485 | exits or execs. */ |
| 486 | bool pending_detach = false; |
| 487 | |
| 488 | /* True if this inferior is a vfork parent waiting for a vfork child |
| 489 | not under our control to be done with the shared memory region, |
| 490 | either by exiting or execing. */ |
| 491 | bool waiting_for_vfork_done = false; |
| 492 | |
| 493 | /* True if we're in the process of detaching from this inferior. */ |
| 494 | bool detaching = false; |
| 495 | |
| 496 | /* What is left to do for an execution command after any thread of |
| 497 | this inferior stops. For continuations associated with a |
| 498 | specific thread, see `struct thread_info'. */ |
| 499 | continuation *continuations = NULL; |
| 500 | |
| 501 | /* True if setup_inferior wasn't called for this inferior yet. |
| 502 | Until that is done, we must not access inferior memory or |
| 503 | registers, as we haven't determined the target |
| 504 | architecture/description. */ |
| 505 | bool needs_setup = false; |
| 506 | |
| 507 | /* Private data used by the target vector implementation. */ |
| 508 | std::unique_ptr<private_inferior> priv; |
| 509 | |
| 510 | /* HAS_EXIT_CODE is true if the inferior exited with an exit code. |
| 511 | In this case, the EXIT_CODE field is also valid. */ |
| 512 | bool has_exit_code = false; |
| 513 | LONGEST exit_code = 0; |
| 514 | |
| 515 | /* Default flags to pass to the symbol reading functions. These are |
| 516 | used whenever a new objfile is created. */ |
| 517 | symfile_add_flags symfile_flags = 0; |
| 518 | |
| 519 | /* Info about an inferior's target description (if it's fetched; the |
| 520 | user supplied description's filename, if any; etc.). */ |
| 521 | target_desc_info *tdesc_info = NULL; |
| 522 | |
| 523 | /* The architecture associated with the inferior through the |
| 524 | connection to the target. |
| 525 | |
| 526 | The architecture vector provides some information that is really |
| 527 | a property of the inferior, accessed through a particular target: |
| 528 | ptrace operations; the layout of certain RSP packets; the |
| 529 | solib_ops vector; etc. To differentiate architecture accesses to |
| 530 | per-inferior/target properties from |
| 531 | per-thread/per-frame/per-objfile properties, accesses to |
| 532 | per-inferior/target properties should be made through |
| 533 | this gdbarch. */ |
| 534 | struct gdbarch *gdbarch = NULL; |
| 535 | |
| 536 | /* Data related to displaced stepping. */ |
| 537 | displaced_step_inferior_state displaced_step_state; |
| 538 | |
| 539 | /* Per inferior data-pointers required by other GDB modules. */ |
| 540 | REGISTRY_FIELDS; |
| 541 | |
| 542 | private: |
| 543 | /* The inferior's target stack. */ |
| 544 | target_stack m_target_stack; |
| 545 | }; |
| 546 | |
| 547 | /* Keep a registry of per-inferior data-pointers required by other GDB |
| 548 | modules. */ |
| 549 | |
| 550 | DECLARE_REGISTRY (inferior); |
| 551 | |
| 552 | /* Add an inferior to the inferior list, print a message that a new |
| 553 | inferior is found, and return the pointer to the new inferior. |
| 554 | Caller may use this pointer to initialize the private inferior |
| 555 | data. */ |
| 556 | extern struct inferior *add_inferior (int pid); |
| 557 | |
| 558 | /* Same as add_inferior, but don't print new inferior notifications to |
| 559 | the CLI. */ |
| 560 | extern struct inferior *add_inferior_silent (int pid); |
| 561 | |
| 562 | extern void delete_inferior (struct inferior *todel); |
| 563 | |
| 564 | /* Delete an existing inferior list entry, due to inferior detaching. */ |
| 565 | extern void detach_inferior (inferior *inf); |
| 566 | |
| 567 | extern void exit_inferior (inferior *inf); |
| 568 | |
| 569 | extern void exit_inferior_silent (inferior *inf); |
| 570 | |
| 571 | extern void exit_inferior_num_silent (int num); |
| 572 | |
| 573 | extern void inferior_appeared (struct inferior *inf, int pid); |
| 574 | |
| 575 | /* Search function to lookup an inferior of TARG by target 'pid'. */ |
| 576 | extern struct inferior *find_inferior_pid (process_stratum_target *targ, |
| 577 | int pid); |
| 578 | |
| 579 | /* Search function to lookup an inferior of TARG whose pid is equal to |
| 580 | 'ptid.pid'. */ |
| 581 | extern struct inferior *find_inferior_ptid (process_stratum_target *targ, |
| 582 | ptid_t ptid); |
| 583 | |
| 584 | /* Search function to lookup an inferior by GDB 'num'. */ |
| 585 | extern struct inferior *find_inferior_id (int num); |
| 586 | |
| 587 | /* Find an inferior bound to PSPACE, giving preference to the current |
| 588 | inferior. */ |
| 589 | extern struct inferior * |
| 590 | find_inferior_for_program_space (struct program_space *pspace); |
| 591 | |
| 592 | /* Inferior iterator function. |
| 593 | |
| 594 | Calls a callback function once for each inferior, so long as the |
| 595 | callback function returns false. If the callback function returns |
| 596 | true, the iteration will end and the current inferior will be |
| 597 | returned. This can be useful for implementing a search for a |
| 598 | inferior with arbitrary attributes, or for applying some operation |
| 599 | to every inferior. |
| 600 | |
| 601 | It is safe to delete the iterated inferior from the callback. */ |
| 602 | extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *, |
| 603 | void *), |
| 604 | void *); |
| 605 | |
| 606 | /* Returns true if the inferior list is not empty. */ |
| 607 | extern int have_inferiors (void); |
| 608 | |
| 609 | /* Returns the number of live inferiors running on PROC_TARGET (real |
| 610 | live processes with execution). */ |
| 611 | extern int number_of_live_inferiors (process_stratum_target *proc_target); |
| 612 | |
| 613 | /* Returns true if there are any live inferiors in the inferior list |
| 614 | (not cores, not executables, real live processes). */ |
| 615 | extern int have_live_inferiors (void); |
| 616 | |
| 617 | /* Save/restore the current inferior. */ |
| 618 | |
| 619 | class scoped_restore_current_inferior |
| 620 | { |
| 621 | public: |
| 622 | scoped_restore_current_inferior () |
| 623 | : m_saved_inf (current_inferior ()) |
| 624 | {} |
| 625 | |
| 626 | ~scoped_restore_current_inferior () |
| 627 | { set_current_inferior (m_saved_inf); } |
| 628 | |
| 629 | DISABLE_COPY_AND_ASSIGN (scoped_restore_current_inferior); |
| 630 | |
| 631 | private: |
| 632 | inferior *m_saved_inf; |
| 633 | }; |
| 634 | |
| 635 | |
| 636 | /* Traverse all inferiors. */ |
| 637 | |
| 638 | extern struct inferior *inferior_list; |
| 639 | |
| 640 | /* Pull in the internals of the inferiors ranges and iterators. Must |
| 641 | be done after struct inferior is defined. */ |
| 642 | #include "inferior-iter.h" |
| 643 | |
| 644 | /* Return a range that can be used to walk over all inferiors |
| 645 | inferiors, with range-for, safely. I.e., it is safe to delete the |
| 646 | currently-iterated inferior. When combined with range-for, this |
| 647 | allow convenient patterns like this: |
| 648 | |
| 649 | for (inferior *inf : all_inferiors_safe ()) |
| 650 | if (some_condition ()) |
| 651 | delete inf; |
| 652 | */ |
| 653 | |
| 654 | inline all_inferiors_safe_range |
| 655 | all_inferiors_safe () |
| 656 | { |
| 657 | return {}; |
| 658 | } |
| 659 | |
| 660 | /* Returns a range representing all inferiors, suitable to use with |
| 661 | range-for, like this: |
| 662 | |
| 663 | for (inferior *inf : all_inferiors ()) |
| 664 | [...] |
| 665 | */ |
| 666 | |
| 667 | inline all_inferiors_range |
| 668 | all_inferiors (process_stratum_target *proc_target = nullptr) |
| 669 | { |
| 670 | return all_inferiors_range (proc_target); |
| 671 | } |
| 672 | |
| 673 | /* Return a range that can be used to walk over all inferiors with PID |
| 674 | not zero, with range-for. */ |
| 675 | |
| 676 | inline all_non_exited_inferiors_range |
| 677 | all_non_exited_inferiors (process_stratum_target *proc_target = nullptr) |
| 678 | { |
| 679 | return all_non_exited_inferiors_range (proc_target); |
| 680 | } |
| 681 | |
| 682 | /* Prune away automatically added inferiors that aren't required |
| 683 | anymore. */ |
| 684 | extern void prune_inferiors (void); |
| 685 | |
| 686 | extern int number_of_inferiors (void); |
| 687 | |
| 688 | extern struct inferior *add_inferior_with_spaces (void); |
| 689 | |
| 690 | /* Print the current selected inferior. */ |
| 691 | extern void print_selected_inferior (struct ui_out *uiout); |
| 692 | |
| 693 | #endif /* !defined (INFERIOR_H) */ |