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