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