1 /* Variables that describe the inferior process running under GDB:
2 Where it is, why it stopped, and how to step it.
4 Copyright (C) 1986-2017 Free Software Foundation, Inc.
6 This file is part of GDB.
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.
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.
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/>. */
21 #if !defined (INFERIOR_H)
24 struct target_waitstatus
;
32 struct target_desc_info
;
35 #include "breakpoint.h"
37 /* For enum gdb_signal. */
40 /* For struct frame_id. */
43 #include "progspace.h"
46 #include "symfile-add-flags.h"
48 struct infcall_suspend_state
;
49 struct infcall_control_state
;
51 extern struct infcall_suspend_state
*save_infcall_suspend_state (void);
52 extern struct infcall_control_state
*save_infcall_control_state (void);
54 extern void restore_infcall_suspend_state (struct infcall_suspend_state
*);
55 extern void restore_infcall_control_state (struct infcall_control_state
*);
57 extern struct cleanup
*make_cleanup_restore_infcall_suspend_state
58 (struct infcall_suspend_state
*);
59 extern struct cleanup
*make_cleanup_restore_infcall_control_state
60 (struct infcall_control_state
*);
62 extern void discard_infcall_suspend_state (struct infcall_suspend_state
*);
63 extern void discard_infcall_control_state (struct infcall_control_state
*);
65 extern struct regcache
*
66 get_infcall_suspend_state_regcache (struct infcall_suspend_state
*);
68 /* Save value of inferior_ptid so that it may be restored by
69 a later call to do_cleanups(). Returns the struct cleanup
70 pointer needed for later doing the cleanup. */
71 extern struct cleanup
* save_inferior_ptid (void);
73 extern void set_sigint_trap (void);
75 extern void clear_sigint_trap (void);
77 /* Set/get file name for default use for standard in/out in the inferior. */
79 extern void set_inferior_io_terminal (const char *terminal_name
);
80 extern const char *get_inferior_io_terminal (void);
82 /* Collected pid, tid, etc. of the debugged inferior. When there's
83 no inferior, ptid_get_pid (inferior_ptid) will be 0. */
85 extern ptid_t inferior_ptid
;
87 extern void generic_mourn_inferior (void);
89 extern CORE_ADDR
unsigned_pointer_to_address (struct gdbarch
*gdbarch
,
92 extern void unsigned_address_to_pointer (struct gdbarch
*gdbarch
,
93 struct type
*type
, gdb_byte
*buf
,
95 extern CORE_ADDR
signed_pointer_to_address (struct gdbarch
*gdbarch
,
98 extern void address_to_signed_pointer (struct gdbarch
*gdbarch
,
99 struct type
*type
, gdb_byte
*buf
,
102 extern void reopen_exec_file (void);
104 /* From misc files */
106 extern void default_print_registers_info (struct gdbarch
*gdbarch
,
107 struct ui_file
*file
,
108 struct frame_info
*frame
,
109 int regnum
, int all
);
111 /* Default implementation of gdbarch_print_float_info. Print
112 the values of all floating point registers. */
114 extern void default_print_float_info (struct gdbarch
*gdbarch
,
115 struct ui_file
*file
,
116 struct frame_info
*frame
,
119 extern void child_terminal_info (struct target_ops
*self
, const char *, int);
121 extern void term_info (char *, int);
123 extern void child_terminal_ours (struct target_ops
*self
);
125 extern void child_terminal_ours_for_output (struct target_ops
*self
);
127 extern void child_terminal_inferior (struct target_ops
*self
);
129 extern void child_terminal_init (struct target_ops
*self
);
131 extern void child_terminal_init_with_pgrp (int pgrp
);
133 /* From fork-child.c */
135 /* Report an error that happened when starting to trace the inferior
136 (i.e., when the "traceme_fun" callback is called on fork_inferior)
137 and bail out. This function does not return. */
139 extern void trace_start_error (const char *fmt
, ...)
142 /* Like "trace_start_error", but the error message is constructed by
143 combining STRING with the system error message for errno. This
144 function does not return. */
146 extern void trace_start_error_with_name (const char *string
)
149 extern int fork_inferior (char *, char *, char **,
151 void (*)(int), void (*)(void), char *,
152 void (*)(const char *,
153 char * const *, char * const *));
156 extern void startup_inferior (int);
158 extern char *construct_inferior_arguments (int, char **);
162 /* Initial inferior setup. Determines the exec file is not yet known,
163 takes any necessary post-attaching actions, fetches the target
164 description and syncs the shared library list. */
166 extern void setup_inferior (int from_tty
);
168 extern void post_create_inferior (struct target_ops
*, int);
170 extern void attach_command (char *, int);
172 extern char *get_inferior_args (void);
174 extern void set_inferior_args (char *);
176 extern void set_inferior_args_vector (int, char **);
178 extern void registers_info (char *, int);
180 extern void continue_1 (int all_threads
);
182 extern void interrupt_target_1 (int all_threads
);
184 extern void delete_longjmp_breakpoint_cleanup (void *arg
);
186 extern void detach_command (char *, int);
188 extern void notice_new_inferior (ptid_t
, int, int);
190 extern struct value
*get_return_value (struct value
*function
,
191 struct type
*value_type
);
193 /* Prepare for execution command. TARGET is the target that will run
194 the command. BACKGROUND determines whether this is a foreground
195 (synchronous) or background (asynchronous) command. */
197 extern void prepare_execution_command (struct target_ops
*target
,
200 /* Whether to start up the debuggee under a shell.
202 If startup-with-shell is set, GDB's "run" will attempt to start up
203 the debuggee under a shell.
205 This is in order for argument-expansion to occur. E.g.,
209 The "*" gets expanded by the shell into a list of files.
211 While this is a nice feature, it may be handy to bypass the shell
212 in some cases. To disable this feature, do "set startup-with-shell
215 The catch-exec traps expected during start-up will be one more if
216 the target is started up with a shell. */
217 extern int startup_with_shell
;
219 /* Address at which inferior stopped. */
221 extern CORE_ADDR stop_pc
;
223 /* Nonzero if stopped due to completion of a stack dummy routine. */
225 extern enum stop_stack_kind stop_stack_dummy
;
227 /* Nonzero if program stopped due to a random (unexpected) signal in
230 extern int stopped_by_random_signal
;
232 /* STEP_OVER_ALL means step over all subroutine calls.
233 STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
234 STEP_OVER_NONE means don't step over any subroutine calls. */
236 enum step_over_calls_kind
240 STEP_OVER_UNDEBUGGABLE
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. */
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.
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
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. */
273 STOP_QUIETLY_NO_SIGSTOP
277 /* Possible values for gdbarch_call_dummy_location. */
279 #define AT_ENTRY_POINT 4
281 /* Number of traps that happen between exec'ing the shell to run an
282 inferior and when we finally get to the inferior code, not counting
283 the exec for the shell. This is 1 on all supported
285 #define START_INFERIOR_TRAPS_EXPECTED 1
287 struct private_inferior
;
289 /* Inferior process specific part of `struct infcall_control_state'.
291 Inferior thread counterpart is `struct thread_control_state'. */
293 struct inferior_control_state
295 /* See the definition of stop_kind above. */
296 enum stop_kind stop_soon
;
299 /* GDB represents the state of each program execution with an object
300 called an inferior. An inferior typically corresponds to a process
301 but is more general and applies also to targets that do not have a
302 notion of processes. Each run of an executable creates a new
303 inferior, as does each attachment to an existing process.
304 Inferiors have unique internal identifiers that are different from
305 target process ids. Each inferior may in turn have multiple
306 threads running in it. */
310 /* Pointer to next inferior in singly-linked list of inferiors. */
311 struct inferior
*next
;
313 /* Convenient handle (GDB inferior id). Unique across all
317 /* Actual target inferior id, usually, a process id. This matches
318 the ptid_t.pid member of threads of this inferior. */
320 /* True if the PID was actually faked by GDB. */
323 /* The highest thread number this inferior ever had. */
324 int highest_thread_num
;
326 /* State of GDB control of inferior process execution.
327 See `struct inferior_control_state'. */
328 struct inferior_control_state control
;
330 /* True if this was an auto-created inferior, e.g. created from
331 following a fork; false, if this inferior was manually added by
332 the user, and we should not attempt to prune it
336 /* The address space bound to this inferior. */
337 struct address_space
*aspace
;
339 /* The program space bound to this inferior. */
340 struct program_space
*pspace
;
342 /* The arguments string to use when running. */
345 /* The size of elements in argv. */
348 /* The vector version of arguments. If ARGC is nonzero,
349 then we must compute ARGS from this (via the target).
350 This is always coming from main's argv and therefore
351 should never be freed. */
354 /* The name of terminal device to use for I/O. */
357 /* Environment to use for running inferior,
358 in format described in environ.h. */
359 struct gdb_environ
*environment
;
361 /* Nonzero if this child process was attached rather than
365 /* If this inferior is a vfork child, then this is the pointer to
366 its vfork parent, if GDB is still attached to it. */
367 struct inferior
*vfork_parent
;
369 /* If this process is a vfork parent, this is the pointer to the
370 child. Since a vfork parent is left frozen by the kernel until
371 the child execs or exits, a process can only have one vfork child
373 struct inferior
*vfork_child
;
375 /* True if this inferior should be detached when it's vfork sibling
379 /* True if this inferior is a vfork parent waiting for a vfork child
380 not under our control to be done with the shared memory region,
381 either by exiting or execing. */
382 int waiting_for_vfork_done
;
384 /* True if we're in the process of detaching from this inferior. */
387 /* What is left to do for an execution command after any thread of
388 this inferior stops. For continuations associated with a
389 specific thread, see `struct thread_info'. */
390 struct continuation
*continuations
;
392 /* True if setup_inferior wasn't called for this inferior yet.
393 Until that is done, we must not access inferior memory or
394 registers, as we haven't determined the target
395 architecture/description. */
398 /* Private data used by the target vector implementation. */
399 struct private_inferior
*priv
;
401 /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
402 In this case, the EXIT_CODE field is also valid. */
406 /* Default flags to pass to the symbol reading functions. These are
407 used whenever a new objfile is created. */
408 symfile_add_flags symfile_flags
;
410 /* Info about an inferior's target description (if it's fetched; the
411 user supplied description's filename, if any; etc.). */
412 struct target_desc_info
*tdesc_info
;
414 /* The architecture associated with the inferior through the
415 connection to the target.
417 The architecture vector provides some information that is really
418 a property of the inferior, accessed through a particular target:
419 ptrace operations; the layout of certain RSP packets; the
420 solib_ops vector; etc. To differentiate architecture accesses to
421 per-inferior/target properties from
422 per-thread/per-frame/per-objfile properties, accesses to
423 per-inferior/target properties should be made through
425 struct gdbarch
*gdbarch
;
427 /* Per inferior data-pointers required by other GDB modules. */
431 /* Keep a registry of per-inferior data-pointers required by other GDB
434 DECLARE_REGISTRY (inferior
);
436 /* Create an empty inferior list, or empty the existing one. */
437 extern void init_inferior_list (void);
439 /* Add an inferior to the inferior list, print a message that a new
440 inferior is found, and return the pointer to the new inferior.
441 Caller may use this pointer to initialize the private inferior
443 extern struct inferior
*add_inferior (int pid
);
445 /* Same as add_inferior, but don't print new inferior notifications to
447 extern struct inferior
*add_inferior_silent (int pid
);
449 extern void delete_inferior (struct inferior
*todel
);
451 /* Delete an existing inferior list entry, due to inferior detaching. */
452 extern void detach_inferior (int pid
);
454 extern void exit_inferior (int pid
);
456 extern void exit_inferior_silent (int pid
);
458 extern void exit_inferior_num_silent (int num
);
460 extern void inferior_appeared (struct inferior
*inf
, int pid
);
462 /* Get rid of all inferiors. */
463 extern void discard_all_inferiors (void);
465 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
466 into a "pid" (which may be overloaded with extra inferior information). */
467 extern int gdb_inferior_id_to_pid (int);
469 /* Translate a target 'pid' into the integer inferior id (GDB's
470 homegrown id, not the system's). */
471 extern int pid_to_gdb_inferior_id (int pid
);
473 /* Boolean test for an already-known pid. */
474 extern int in_inferior_list (int pid
);
476 /* Boolean test for an already-known inferior id (GDB's homegrown id,
477 not the system's). */
478 extern int valid_gdb_inferior_id (int num
);
480 /* Search function to lookup an inferior by target 'pid'. */
481 extern struct inferior
*find_inferior_pid (int pid
);
483 /* Search function to lookup an inferior whose pid is equal to 'ptid.pid'. */
484 extern struct inferior
*find_inferior_ptid (ptid_t ptid
);
486 /* Search function to lookup an inferior by GDB 'num'. */
487 extern struct inferior
*find_inferior_id (int num
);
489 /* Find an inferior bound to PSPACE, giving preference to the current
491 extern struct inferior
*
492 find_inferior_for_program_space (struct program_space
*pspace
);
494 /* Inferior iterator function.
496 Calls a callback function once for each inferior, so long as the
497 callback function returns false. If the callback function returns
498 true, the iteration will end and the current inferior will be
499 returned. This can be useful for implementing a search for a
500 inferior with arbitrary attributes, or for applying some operation
503 It is safe to delete the iterated inferior from the callback. */
504 extern struct inferior
*iterate_over_inferiors (int (*) (struct inferior
*,
508 /* Returns true if the inferior list is not empty. */
509 extern int have_inferiors (void);
511 /* Returns the number of live inferiors (real live processes). */
512 extern int number_of_live_inferiors (void);
514 /* Returns true if there are any live inferiors in the inferior list
515 (not cores, not executables, real live processes). */
516 extern int have_live_inferiors (void);
518 /* Return a pointer to the current inferior. It is an error to call
519 this if there is no current inferior. */
520 extern struct inferior
*current_inferior (void);
522 extern void set_current_inferior (struct inferior
*);
524 extern struct cleanup
*save_current_inferior (void);
526 /* Traverse all inferiors. */
528 #define ALL_INFERIORS(I) \
529 for ((I) = inferior_list; (I); (I) = (I)->next)
531 /* Traverse all non-exited inferiors. */
533 #define ALL_NON_EXITED_INFERIORS(I) \
537 extern struct inferior
*inferior_list
;
539 /* Prune away automatically added inferiors that aren't required
541 extern void prune_inferiors (void);
543 extern int number_of_inferiors (void);
545 extern struct inferior
*add_inferior_with_spaces (void);
547 /* Print the current selected inferior. */
548 extern void print_selected_inferior (struct ui_out
*uiout
);
550 #endif /* !defined (INFERIOR_H) */