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-2016 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 extern int fork_inferior (char *, char *, char **,
137 void (*)(int), void (*)(void), char *,
138 void (*)(const char *,
139 char * const *, char * const *));
142 extern void startup_inferior (int);
144 extern char *construct_inferior_arguments (int, char **);
148 /* Initial inferior setup. Determines the exec file is not yet known,
149 takes any necessary post-attaching actions, fetches the target
150 description and syncs the shared library list. */
152 extern void setup_inferior (int from_tty
);
154 extern void post_create_inferior (struct target_ops
*, int);
156 extern void attach_command (char *, int);
158 extern char *get_inferior_args (void);
160 extern void set_inferior_args (char *);
162 extern void set_inferior_args_vector (int, char **);
164 extern void registers_info (char *, int);
166 extern void continue_1 (int all_threads
);
168 extern void interrupt_target_1 (int all_threads
);
170 extern void delete_longjmp_breakpoint_cleanup (void *arg
);
172 extern void detach_command (char *, int);
174 extern void notice_new_inferior (ptid_t
, int, int);
176 extern struct value
*get_return_value (struct value
*function
,
177 struct type
*value_type
);
179 /* Prepare for execution command. TARGET is the target that will run
180 the command. BACKGROUND determines whether this is a foreground
181 (synchronous) or background (asynchronous) command. */
183 extern void prepare_execution_command (struct target_ops
*target
,
186 /* Whether to start up the debuggee under a shell.
188 If startup-with-shell is set, GDB's "run" will attempt to start up
189 the debuggee under a shell.
191 This is in order for argument-expansion to occur. E.g.,
195 The "*" gets expanded by the shell into a list of files.
197 While this is a nice feature, it may be handy to bypass the shell
198 in some cases. To disable this feature, do "set startup-with-shell
201 The catch-exec traps expected during start-up will be one more if
202 the target is started up with a shell. */
203 extern int startup_with_shell
;
205 /* Address at which inferior stopped. */
207 extern CORE_ADDR stop_pc
;
209 /* Nonzero if stopped due to completion of a stack dummy routine. */
211 extern enum stop_stack_kind stop_stack_dummy
;
213 /* Nonzero if program stopped due to a random (unexpected) signal in
216 extern int stopped_by_random_signal
;
218 /* STEP_OVER_ALL means step over all subroutine calls.
219 STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions.
220 STEP_OVER_NONE means don't step over any subroutine calls. */
222 enum step_over_calls_kind
226 STEP_OVER_UNDEBUGGABLE
229 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller
230 will handle it themselves. STOP_QUIETLY is used when running in
231 the shell before the child program has been exec'd and when running
232 through shared library loading. STOP_QUIETLY_REMOTE is used when
233 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP
234 except that there is no need to hide a signal. */
236 /* STOP_QUIETLY_NO_SIGSTOP is used to handle a tricky situation with attach.
237 When doing an attach, the kernel stops the debuggee with a SIGSTOP.
238 On newer GNU/Linux kernels (>= 2.5.61) the handling of SIGSTOP for
239 a ptraced process has changed. Earlier versions of the kernel
240 would ignore these SIGSTOPs, while now SIGSTOP is treated like any
241 other signal, i.e. it is not muffled.
243 If the gdb user does a 'continue' after the 'attach', gdb passes
244 the global variable stop_signal (which stores the signal from the
245 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is
246 problematic, because the kernel doesn't ignore such SIGSTOP
247 now. I.e. it is reported back to gdb, which in turn presents it
250 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows
251 gdb to clear the value of stop_signal after the attach, so that it
252 is not passed back down to the kernel. */
259 STOP_QUIETLY_NO_SIGSTOP
263 /* Possible values for gdbarch_call_dummy_location. */
265 #define AT_ENTRY_POINT 4
267 /* Number of traps that happen between exec'ing the shell to run an
268 inferior and when we finally get to the inferior code, not counting
269 the exec for the shell. This is 1 on all supported
271 #define START_INFERIOR_TRAPS_EXPECTED 1
273 struct private_inferior
;
275 /* Inferior process specific part of `struct infcall_control_state'.
277 Inferior thread counterpart is `struct thread_control_state'. */
279 struct inferior_control_state
281 /* See the definition of stop_kind above. */
282 enum stop_kind stop_soon
;
285 /* GDB represents the state of each program execution with an object
286 called an inferior. An inferior typically corresponds to a process
287 but is more general and applies also to targets that do not have a
288 notion of processes. Each run of an executable creates a new
289 inferior, as does each attachment to an existing process.
290 Inferiors have unique internal identifiers that are different from
291 target process ids. Each inferior may in turn have multiple
292 threads running in it. */
296 /* Pointer to next inferior in singly-linked list of inferiors. */
297 struct inferior
*next
;
299 /* Convenient handle (GDB inferior id). Unique across all
303 /* Actual target inferior id, usually, a process id. This matches
304 the ptid_t.pid member of threads of this inferior. */
306 /* True if the PID was actually faked by GDB. */
309 /* The highest thread number this inferior ever had. */
310 int highest_thread_num
;
312 /* State of GDB control of inferior process execution.
313 See `struct inferior_control_state'. */
314 struct inferior_control_state control
;
316 /* True if this was an auto-created inferior, e.g. created from
317 following a fork; false, if this inferior was manually added by
318 the user, and we should not attempt to prune it
322 /* The address space bound to this inferior. */
323 struct address_space
*aspace
;
325 /* The program space bound to this inferior. */
326 struct program_space
*pspace
;
328 /* The arguments string to use when running. */
331 /* The size of elements in argv. */
334 /* The vector version of arguments. If ARGC is nonzero,
335 then we must compute ARGS from this (via the target).
336 This is always coming from main's argv and therefore
337 should never be freed. */
340 /* The name of terminal device to use for I/O. */
343 /* Environment to use for running inferior,
344 in format described in environ.h. */
345 struct gdb_environ
*environment
;
347 /* Nonzero if this child process was attached rather than
351 /* If this inferior is a vfork child, then this is the pointer to
352 its vfork parent, if GDB is still attached to it. */
353 struct inferior
*vfork_parent
;
355 /* If this process is a vfork parent, this is the pointer to the
356 child. Since a vfork parent is left frozen by the kernel until
357 the child execs or exits, a process can only have one vfork child
359 struct inferior
*vfork_child
;
361 /* True if this inferior should be detached when it's vfork sibling
365 /* True if this inferior is a vfork parent waiting for a vfork child
366 not under our control to be done with the shared memory region,
367 either by exiting or execing. */
368 int waiting_for_vfork_done
;
370 /* True if we're in the process of detaching from this inferior. */
373 /* What is left to do for an execution command after any thread of
374 this inferior stops. For continuations associated with a
375 specific thread, see `struct thread_info'. */
376 struct continuation
*continuations
;
378 /* True if setup_inferior wasn't called for this inferior yet.
379 Until that is done, we must not access inferior memory or
380 registers, as we haven't determined the target
381 architecture/description. */
384 /* Private data used by the target vector implementation. */
385 struct private_inferior
*priv
;
387 /* HAS_EXIT_CODE is true if the inferior exited with an exit code.
388 In this case, the EXIT_CODE field is also valid. */
392 /* Default flags to pass to the symbol reading functions. These are
393 used whenever a new objfile is created. */
394 symfile_add_flags symfile_flags
;
396 /* Info about an inferior's target description (if it's fetched; the
397 user supplied description's filename, if any; etc.). */
398 struct target_desc_info
*tdesc_info
;
400 /* The architecture associated with the inferior through the
401 connection to the target.
403 The architecture vector provides some information that is really
404 a property of the inferior, accessed through a particular target:
405 ptrace operations; the layout of certain RSP packets; the
406 solib_ops vector; etc. To differentiate architecture accesses to
407 per-inferior/target properties from
408 per-thread/per-frame/per-objfile properties, accesses to
409 per-inferior/target properties should be made through
411 struct gdbarch
*gdbarch
;
413 /* Per inferior data-pointers required by other GDB modules. */
417 /* Keep a registry of per-inferior data-pointers required by other GDB
420 DECLARE_REGISTRY (inferior
);
422 /* Create an empty inferior list, or empty the existing one. */
423 extern void init_inferior_list (void);
425 /* Add an inferior to the inferior list, print a message that a new
426 inferior is found, and return the pointer to the new inferior.
427 Caller may use this pointer to initialize the private inferior
429 extern struct inferior
*add_inferior (int pid
);
431 /* Same as add_inferior, but don't print new inferior notifications to
433 extern struct inferior
*add_inferior_silent (int pid
);
435 extern void delete_inferior (struct inferior
*todel
);
437 /* Delete an existing inferior list entry, due to inferior detaching. */
438 extern void detach_inferior (int pid
);
440 extern void exit_inferior (int pid
);
442 extern void exit_inferior_silent (int pid
);
444 extern void exit_inferior_num_silent (int num
);
446 extern void inferior_appeared (struct inferior
*inf
, int pid
);
448 /* Get rid of all inferiors. */
449 extern void discard_all_inferiors (void);
451 /* Translate the integer inferior id (GDB's homegrown id, not the system's)
452 into a "pid" (which may be overloaded with extra inferior information). */
453 extern int gdb_inferior_id_to_pid (int);
455 /* Translate a target 'pid' into the integer inferior id (GDB's
456 homegrown id, not the system's). */
457 extern int pid_to_gdb_inferior_id (int pid
);
459 /* Boolean test for an already-known pid. */
460 extern int in_inferior_list (int pid
);
462 /* Boolean test for an already-known inferior id (GDB's homegrown id,
463 not the system's). */
464 extern int valid_gdb_inferior_id (int num
);
466 /* Search function to lookup an inferior by target 'pid'. */
467 extern struct inferior
*find_inferior_pid (int pid
);
469 /* Search function to lookup an inferior whose pid is equal to 'ptid.pid'. */
470 extern struct inferior
*find_inferior_ptid (ptid_t ptid
);
472 /* Search function to lookup an inferior by GDB 'num'. */
473 extern struct inferior
*find_inferior_id (int num
);
475 /* Find an inferior bound to PSPACE, giving preference to the current
477 extern struct inferior
*
478 find_inferior_for_program_space (struct program_space
*pspace
);
480 /* Inferior iterator function.
482 Calls a callback function once for each inferior, so long as the
483 callback function returns false. If the callback function returns
484 true, the iteration will end and the current inferior will be
485 returned. This can be useful for implementing a search for a
486 inferior with arbitrary attributes, or for applying some operation
489 It is safe to delete the iterated inferior from the callback. */
490 extern struct inferior
*iterate_over_inferiors (int (*) (struct inferior
*,
494 /* Returns true if the inferior list is not empty. */
495 extern int have_inferiors (void);
497 /* Returns the number of live inferiors (real live processes). */
498 extern int number_of_live_inferiors (void);
500 /* Returns true if there are any live inferiors in the inferior list
501 (not cores, not executables, real live processes). */
502 extern int have_live_inferiors (void);
504 /* Return a pointer to the current inferior. It is an error to call
505 this if there is no current inferior. */
506 extern struct inferior
*current_inferior (void);
508 extern void set_current_inferior (struct inferior
*);
510 extern struct cleanup
*save_current_inferior (void);
512 /* Traverse all inferiors. */
514 #define ALL_INFERIORS(I) \
515 for ((I) = inferior_list; (I); (I) = (I)->next)
517 /* Traverse all non-exited inferiors. */
519 #define ALL_NON_EXITED_INFERIORS(I) \
523 extern struct inferior
*inferior_list
;
525 /* Prune away automatically added inferiors that aren't required
527 extern void prune_inferiors (void);
529 extern int number_of_inferiors (void);
531 extern struct inferior
*add_inferior_with_spaces (void);
533 /* Print the current selected inferior. */
534 extern void print_selected_inferior (struct ui_out
*uiout
);
536 #endif /* !defined (INFERIOR_H) */