Commit | Line | Data |
---|---|---|
c906108c SS |
1 | /* Variables that describe the inferior process running under GDB: |
2 | Where it is, why it stopped, and how to step it. | |
1bac305b | 3 | |
6aba47ca | 4 | Copyright (C) 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, |
9b254dd1 | 5 | 1998, 1999, 2000, 2001, 2003, 2004, 2005, 2006, 2007, 2008 |
1bf1958d | 6 | Free Software Foundation, Inc. |
c906108c | 7 | |
c5aa993b | 8 | This file is part of GDB. |
c906108c | 9 | |
c5aa993b JM |
10 | This program is free software; you can redistribute it and/or modify |
11 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 12 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 13 | (at your option) any later version. |
c906108c | 14 | |
c5aa993b JM |
15 | This program is distributed in the hope that it will be useful, |
16 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | GNU General Public License for more details. | |
c906108c | 19 | |
c5aa993b | 20 | You should have received a copy of the GNU General Public License |
a9762ec7 | 21 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
22 | |
23 | #if !defined (INFERIOR_H) | |
24 | #define INFERIOR_H 1 | |
25 | ||
da3331ec AC |
26 | struct target_waitstatus; |
27 | struct frame_info; | |
28 | struct ui_file; | |
29 | struct type; | |
67a2b77e | 30 | struct gdbarch; |
72cec141 | 31 | struct regcache; |
b77209e0 | 32 | struct ui_out; |
67a2b77e | 33 | |
c906108c SS |
34 | /* For bpstat. */ |
35 | #include "breakpoint.h" | |
36 | ||
37 | /* For enum target_signal. */ | |
38 | #include "target.h" | |
39 | ||
aa0cd9c1 AC |
40 | /* For struct frame_id. */ |
41 | #include "frame.h" | |
42 | ||
7a292a7a | 43 | /* Structure in which to save the status of the inferior. Create/Save |
c906108c SS |
44 | through "save_inferior_status", restore through |
45 | "restore_inferior_status". | |
7a292a7a | 46 | |
c906108c SS |
47 | This pair of routines should be called around any transfer of |
48 | control to the inferior which you don't want showing up in your | |
49 | control variables. */ | |
50 | ||
7a292a7a | 51 | struct inferior_status; |
7a292a7a | 52 | |
a14ed312 | 53 | extern struct inferior_status *save_inferior_status (int); |
7a292a7a | 54 | |
a14ed312 | 55 | extern void restore_inferior_status (struct inferior_status *); |
7a292a7a | 56 | |
74b7792f AC |
57 | extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *); |
58 | ||
a14ed312 | 59 | extern void discard_inferior_status (struct inferior_status *); |
7a292a7a | 60 | |
ca6724c1 KB |
61 | /* The -1 ptid, often used to indicate either an error condition |
62 | or a "don't care" condition, i.e, "run all threads." */ | |
63 | extern ptid_t minus_one_ptid; | |
64 | ||
65 | /* The null or zero ptid, often used to indicate no process. */ | |
66 | extern ptid_t null_ptid; | |
67 | ||
68 | /* Attempt to find and return an existing ptid with the given PID, LWP, | |
69 | and TID components. If none exists, create a new one and return | |
70 | that. */ | |
71 | ptid_t ptid_build (int pid, long lwp, long tid); | |
72 | ||
73 | /* Find/Create a ptid from just a pid. */ | |
74 | ptid_t pid_to_ptid (int pid); | |
75 | ||
76 | /* Fetch the pid (process id) component from a ptid. */ | |
77 | int ptid_get_pid (ptid_t ptid); | |
78 | ||
79 | /* Fetch the lwp (lightweight process) component from a ptid. */ | |
80 | long ptid_get_lwp (ptid_t ptid); | |
81 | ||
82 | /* Fetch the tid (thread id) component from a ptid. */ | |
83 | long ptid_get_tid (ptid_t ptid); | |
84 | ||
85 | /* Compare two ptids to see if they are equal */ | |
86 | extern int ptid_equal (ptid_t p1, ptid_t p2); | |
87 | ||
252fbfc8 PA |
88 | /* Return true if PTID represents a process id. */ |
89 | extern int ptid_is_pid (ptid_t ptid); | |
90 | ||
ce696e05 KB |
91 | /* Save value of inferior_ptid so that it may be restored by |
92 | a later call to do_cleanups(). Returns the struct cleanup | |
93 | pointer needed for later doing the cleanup. */ | |
94 | extern struct cleanup * save_inferior_ptid (void); | |
95 | ||
a14ed312 | 96 | extern void set_sigint_trap (void); |
c906108c | 97 | |
a14ed312 | 98 | extern void clear_sigint_trap (void); |
c906108c | 99 | |
a14ed312 | 100 | extern void set_sigio_trap (void); |
c906108c | 101 | |
a14ed312 | 102 | extern void clear_sigio_trap (void); |
c906108c | 103 | |
3cb3b8df | 104 | /* Set/get file name for default use for standard in/out in the inferior. */ |
c906108c | 105 | |
3cb3b8df BR |
106 | extern void set_inferior_io_terminal (const char *terminal_name); |
107 | extern const char *get_inferior_io_terminal (void); | |
c906108c | 108 | |
39f77062 KB |
109 | /* Collected pid, tid, etc. of the debugged inferior. When there's |
110 | no inferior, PIDGET (inferior_ptid) will be 0. */ | |
c906108c | 111 | |
39f77062 | 112 | extern ptid_t inferior_ptid; |
c906108c | 113 | |
43ff13b4 JM |
114 | /* Are we simulating synchronous execution? This is used in async gdb |
115 | to implement the 'run', 'continue' etc commands, which will not | |
116 | redisplay the prompt until the execution is actually over. */ | |
117 | extern int sync_execution; | |
118 | ||
c906108c SS |
119 | /* Inferior environment. */ |
120 | ||
1bf1958d | 121 | extern struct gdb_environ *inferior_environ; |
c906108c | 122 | |
a14ed312 | 123 | extern void clear_proceed_status (void); |
c906108c | 124 | |
a14ed312 | 125 | extern void proceed (CORE_ADDR, enum target_signal, int); |
c906108c | 126 | |
5fbbeb29 CF |
127 | /* When set, stop the 'step' command if we enter a function which has |
128 | no line number information. The normal behavior is that we step | |
129 | over such function. */ | |
130 | extern int step_stop_if_no_debug; | |
131 | ||
ad52ddc6 PA |
132 | /* If set, the inferior should be controlled in non-stop mode. In |
133 | this mode, each thread is controlled independently. Execution | |
134 | commands apply only to the the selected thread by default, and stop | |
135 | events stop only the thread that had the event -- the other threads | |
136 | are kept running freely. */ | |
137 | extern int non_stop; | |
138 | ||
a14ed312 | 139 | extern void generic_mourn_inferior (void); |
c906108c | 140 | |
a790ad35 SC |
141 | extern void terminal_save_ours (void); |
142 | ||
a14ed312 | 143 | extern void terminal_ours (void); |
c906108c | 144 | |
a14ed312 | 145 | extern CORE_ADDR read_pc (void); |
c906108c | 146 | |
a14ed312 | 147 | extern void write_pc (CORE_ADDR); |
c906108c | 148 | |
b60c417a AC |
149 | extern CORE_ADDR unsigned_pointer_to_address (struct type *type, |
150 | const gdb_byte *buf); | |
151 | extern void unsigned_address_to_pointer (struct type *type, gdb_byte *buf, | |
ac2e2ef7 | 152 | CORE_ADDR addr); |
66140c26 | 153 | extern CORE_ADDR signed_pointer_to_address (struct type *type, |
b60c417a AC |
154 | const gdb_byte *buf); |
155 | extern void address_to_signed_pointer (struct type *type, gdb_byte *buf, | |
ac2e2ef7 | 156 | CORE_ADDR addr); |
4478b372 | 157 | |
ae123ec6 | 158 | extern void wait_for_inferior (int treat_exec_as_sigtrap); |
c906108c | 159 | |
a14ed312 | 160 | extern void fetch_inferior_event (void *); |
43ff13b4 | 161 | |
a14ed312 | 162 | extern void init_wait_for_inferior (void); |
c906108c | 163 | |
a14ed312 | 164 | extern void close_exec_file (void); |
c906108c | 165 | |
a14ed312 | 166 | extern void reopen_exec_file (void); |
c906108c SS |
167 | |
168 | /* The `resume' routine should only be called in special circumstances. | |
169 | Normally, use `proceed', which handles a lot of bookkeeping. */ | |
170 | ||
a14ed312 | 171 | extern void resume (int, enum target_signal); |
c906108c SS |
172 | |
173 | /* From misc files */ | |
174 | ||
0ab7a791 AC |
175 | extern void default_print_registers_info (struct gdbarch *gdbarch, |
176 | struct ui_file *file, | |
177 | struct frame_info *frame, | |
178 | int regnum, int all); | |
666e11c5 | 179 | |
a14ed312 | 180 | extern void child_terminal_info (char *, int); |
c906108c | 181 | |
a14ed312 | 182 | extern void term_info (char *, int); |
c906108c | 183 | |
a14ed312 | 184 | extern void terminal_ours_for_output (void); |
c906108c | 185 | |
a14ed312 | 186 | extern void terminal_inferior (void); |
c906108c | 187 | |
a14ed312 | 188 | extern void terminal_init_inferior (void); |
c906108c | 189 | |
a14ed312 | 190 | extern void terminal_init_inferior_with_pgrp (int pgrp); |
c906108c | 191 | |
c906108c SS |
192 | /* From procfs.c */ |
193 | ||
a14ed312 | 194 | extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR)); |
c906108c | 195 | |
39f77062 | 196 | extern ptid_t procfs_first_available (void); |
c906108c | 197 | |
c906108c SS |
198 | /* From fork-child.c */ |
199 | ||
136d6dae VP |
200 | extern int fork_inferior (char *, char *, char **, |
201 | void (*)(void), | |
202 | void (*)(int), void (*)(void), char *); | |
c906108c SS |
203 | |
204 | ||
a14ed312 | 205 | extern void startup_inferior (int); |
c906108c | 206 | |
552c04a7 TT |
207 | extern char *construct_inferior_arguments (struct gdbarch *, int, char **); |
208 | ||
c906108c SS |
209 | /* From inflow.c */ |
210 | ||
3cb3b8df | 211 | extern void new_tty_prefork (const char *); |
c906108c | 212 | |
a14ed312 | 213 | extern int gdb_has_a_terminal (void); |
c906108c SS |
214 | |
215 | /* From infrun.c */ | |
216 | ||
8621d6a9 | 217 | extern void start_remote (int from_tty); |
c906108c | 218 | |
a14ed312 | 219 | extern void normal_stop (void); |
c906108c | 220 | |
a14ed312 | 221 | extern int signal_stop_state (int); |
c906108c | 222 | |
a14ed312 | 223 | extern int signal_print_state (int); |
c906108c | 224 | |
a14ed312 | 225 | extern int signal_pass_state (int); |
c906108c | 226 | |
a14ed312 | 227 | extern int signal_stop_update (int, int); |
d4f3574e | 228 | |
a14ed312 | 229 | extern int signal_print_update (int, int); |
d4f3574e | 230 | |
a14ed312 | 231 | extern int signal_pass_update (int, int); |
d4f3574e | 232 | |
39f77062 KB |
233 | extern void get_last_target_status(ptid_t *ptid, |
234 | struct target_waitstatus *status); | |
e02bc4cc | 235 | |
6604731b DJ |
236 | extern void follow_inferior_reset_breakpoints (void); |
237 | ||
94cc34af PA |
238 | /* Throw an error indicating the current thread is running. */ |
239 | extern void error_is_running (void); | |
240 | ||
241 | /* Calls error_is_running if the current thread is running. */ | |
242 | extern void ensure_not_running (void); | |
243 | ||
c906108c SS |
244 | /* From infcmd.c */ |
245 | ||
a14ed312 | 246 | extern void tty_command (char *, int); |
c906108c | 247 | |
281b533b DJ |
248 | extern void post_create_inferior (struct target_ops *, int); |
249 | ||
a14ed312 | 250 | extern void attach_command (char *, int); |
c906108c | 251 | |
a250df2e | 252 | extern char *get_inferior_args (void); |
07091751 | 253 | |
a250df2e | 254 | extern char *set_inferior_args (char *); |
07091751 | 255 | |
552c04a7 TT |
256 | extern void set_inferior_args_vector (int, char **); |
257 | ||
36dc181b EZ |
258 | extern void registers_info (char *, int); |
259 | ||
260 | extern void nexti_command (char *, int); | |
261 | ||
262 | extern void stepi_command (char *, int); | |
263 | ||
77ebaa5a VP |
264 | extern void continue_1 (int all_threads); |
265 | ||
36dc181b EZ |
266 | extern void continue_command (char *, int); |
267 | ||
268 | extern void interrupt_target_command (char *args, int from_tty); | |
269 | ||
77ebaa5a VP |
270 | extern void interrupt_target_1 (int all_threads); |
271 | ||
6418d433 VP |
272 | extern void detach_command (char *, int); |
273 | ||
c906108c SS |
274 | /* Address at which inferior stopped. */ |
275 | ||
276 | extern CORE_ADDR stop_pc; | |
277 | ||
c906108c SS |
278 | /* Flag indicating that a command has proceeded the inferior past the |
279 | current breakpoint. */ | |
280 | ||
281 | extern int breakpoint_proceeded; | |
282 | ||
c906108c SS |
283 | /* Nonzero if stopped due to completion of a stack dummy routine. */ |
284 | ||
285 | extern int stop_stack_dummy; | |
286 | ||
287 | /* Nonzero if program stopped due to a random (unexpected) signal in | |
288 | inferior process. */ | |
289 | ||
290 | extern int stopped_by_random_signal; | |
291 | ||
c906108c SS |
292 | /* 1 means step over all subroutine calls. |
293 | -1 means step over calls to undebuggable functions. */ | |
294 | ||
5fbbeb29 CF |
295 | enum step_over_calls_kind |
296 | { | |
297 | STEP_OVER_NONE, | |
298 | STEP_OVER_ALL, | |
a4acd088 CF |
299 | STEP_OVER_UNDEBUGGABLE |
300 | }; | |
301 | ||
b0f4b84b DJ |
302 | /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller |
303 | will handle it themselves. STOP_QUIETLY is used when running in | |
304 | the shell before the child program has been exec'd and when running | |
305 | through shared library loading. STOP_QUIETLY_REMOTE is used when | |
306 | setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP | |
307 | except that there is no need to hide a signal. */ | |
c54cfec8 EZ |
308 | |
309 | /* It is also used after attach, due to attaching to a process. This | |
310 | is a bit trickier. When doing an attach, the kernel stops the | |
311 | debuggee with a SIGSTOP. On newer GNU/Linux kernels (>= 2.5.61) | |
312 | the handling of SIGSTOP for a ptraced process has changed. Earlier | |
313 | versions of the kernel would ignore these SIGSTOPs, while now | |
314 | SIGSTOP is treated like any other signal, i.e. it is not muffled. | |
315 | ||
316 | If the gdb user does a 'continue' after the 'attach', gdb passes | |
317 | the global variable stop_signal (which stores the signal from the | |
318 | attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is | |
319 | problematic, because the kernel doesn't ignore such SIGSTOP | |
320 | now. I.e. it is reported back to gdb, which in turn presents it | |
321 | back to the user. | |
322 | ||
323 | To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows | |
324 | gdb to clear the value of stop_signal after the attach, so that it | |
325 | is not passed back down to the kernel. */ | |
326 | ||
327 | enum stop_kind | |
328 | { | |
329 | NO_STOP_QUIETLY = 0, | |
330 | STOP_QUIETLY, | |
b0f4b84b | 331 | STOP_QUIETLY_REMOTE, |
c54cfec8 EZ |
332 | STOP_QUIETLY_NO_SIGSTOP |
333 | }; | |
c906108c | 334 | |
b2175913 MS |
335 | /* Reverse execution. */ |
336 | enum exec_direction_kind | |
337 | { | |
338 | EXEC_FORWARD, | |
339 | EXEC_REVERSE, | |
340 | EXEC_ERROR | |
341 | }; | |
342 | ||
343 | extern enum exec_direction_kind execution_direction; | |
344 | ||
642fd101 DE |
345 | /* Save register contents here when executing a "finish" command or are |
346 | about to pop a stack dummy frame, if-and-only-if proceed_to_finish is set. | |
c906108c SS |
347 | Thus this contains the return value from the called function (assuming |
348 | values are returned in a register). */ | |
349 | ||
72cec141 | 350 | extern struct regcache *stop_registers; |
c906108c | 351 | |
237fc4c9 PA |
352 | /* True if we are debugging displaced stepping. */ |
353 | extern int debug_displaced; | |
354 | ||
355 | /* Dump LEN bytes at BUF in hex to FILE, followed by a newline. */ | |
356 | void displaced_step_dump_bytes (struct ui_file *file, | |
357 | const gdb_byte *buf, size_t len); | |
358 | ||
f5871ec0 VP |
359 | |
360 | /* When set, normal_stop will not call the normal_stop observer. */ | |
8f6a8e84 VP |
361 | extern int suppress_stop_observer; |
362 | ||
363 | /* When set, no calls to target_resumed observer will be made. */ | |
364 | extern int suppress_resume_observer; | |
365 | ||
c906108c | 366 | \f |
faaf634c | 367 | /* Possible values for gdbarch_call_dummy_location. */ |
c906108c | 368 | #define ON_STACK 1 |
c906108c | 369 | #define AT_ENTRY_POINT 4 |
9710e734 | 370 | #define AT_SYMBOL 5 |
c906108c | 371 | |
c906108c SS |
372 | /* If STARTUP_WITH_SHELL is set, GDB's "run" |
373 | will attempts to start up the debugee under a shell. | |
374 | This is in order for argument-expansion to occur. E.g., | |
375 | (gdb) run * | |
376 | The "*" gets expanded by the shell into a list of files. | |
377 | While this is a nice feature, it turns out to interact badly | |
378 | with some of the catch-fork/catch-exec features we have added. | |
379 | In particular, if the shell does any fork/exec's before | |
380 | the exec of the target program, that can confuse GDB. | |
381 | To disable this feature, set STARTUP_WITH_SHELL to 0. | |
382 | To enable this feature, set STARTUP_WITH_SHELL to 1. | |
383 | The catch-exec traps expected during start-up will | |
384 | be 1 if target is not started up with a shell, 2 if it is. | |
385 | - RT | |
386 | If you disable this, you need to decrement | |
387 | START_INFERIOR_TRAPS_EXPECTED in tm.h. */ | |
388 | #define STARTUP_WITH_SHELL 1 | |
389 | #if !defined(START_INFERIOR_TRAPS_EXPECTED) | |
390 | #define START_INFERIOR_TRAPS_EXPECTED 2 | |
391 | #endif | |
b77209e0 PA |
392 | |
393 | struct private_inferior; | |
394 | ||
395 | /* GDB represents the state of each program execution with an object | |
396 | called an inferior. An inferior typically corresponds to a process | |
397 | but is more general and applies also to targets that do not have a | |
398 | notion of processes. Each run of an executable creates a new | |
399 | inferior, as does each attachment to an existing process. | |
400 | Inferiors have unique internal identifiers that are different from | |
401 | target process ids. Each inferior may in turn have multiple | |
402 | threads running in it. */ | |
403 | ||
404 | struct inferior | |
405 | { | |
406 | /* Pointer to next inferior in singly-linked list of inferiors. */ | |
407 | struct inferior *next; | |
408 | ||
409 | /* Convenient handle (GDB inferior id). Unique across all | |
410 | inferiors. */ | |
411 | int num; | |
412 | ||
413 | /* Actual target inferior id, usually, a process id. This matches | |
414 | the ptid_t.pid member of threads of this inferior. */ | |
415 | int pid; | |
416 | ||
d6b48e9c PA |
417 | /* See the definition of stop_kind above. */ |
418 | enum stop_kind stop_soon; | |
419 | ||
181e7f93 PA |
420 | /* Nonzero if this child process was attached rather than |
421 | forked. */ | |
422 | int attach_flag; | |
423 | ||
e0ba6746 PA |
424 | /* What is left to do for an execution command after any thread of |
425 | this inferior stops. For continuations associated with a | |
426 | specific thread, see `struct thread_info'. */ | |
427 | struct continuation *continuations; | |
428 | ||
b77209e0 PA |
429 | /* Private data used by the target vector implementation. */ |
430 | struct private_inferior *private; | |
431 | }; | |
432 | ||
433 | /* Create an empty inferior list, or empty the existing one. */ | |
434 | extern void init_inferior_list (void); | |
435 | ||
436 | /* Add an inferior to the inferior list, print a message that a new | |
437 | inferior is found, and return the pointer to the new inferior. | |
438 | Caller may use this pointer to initialize the private inferior | |
439 | data. */ | |
440 | extern struct inferior *add_inferior (int pid); | |
441 | ||
442 | /* Same as add_inferior, but don't print new inferior notifications to | |
443 | the CLI. */ | |
444 | extern struct inferior *add_inferior_silent (int pid); | |
445 | ||
446 | /* Delete an existing inferior list entry, due to inferior exit. */ | |
447 | extern void delete_inferior (int pid); | |
448 | ||
449 | /* Same as delete_inferior, but don't print new inferior notifications | |
450 | to the CLI. */ | |
451 | extern void delete_inferior_silent (int pid); | |
452 | ||
453 | /* Delete an existing inferior list entry, due to inferior detaching. */ | |
454 | extern void detach_inferior (int pid); | |
455 | ||
82f73884 PA |
456 | /* Get rid of all inferiors. */ |
457 | extern void discard_all_inferiors (void); | |
458 | ||
b77209e0 PA |
459 | /* Translate the integer inferior id (GDB's homegrown id, not the system's) |
460 | into a "pid" (which may be overloaded with extra inferior information). */ | |
461 | extern int gdb_inferior_id_to_pid (int); | |
462 | ||
463 | /* Translate a target 'pid' into the integer inferior id (GDB's | |
464 | homegrown id, not the system's). */ | |
465 | extern int pid_to_gdb_inferior_id (int pid); | |
466 | ||
467 | /* Boolean test for an already-known pid. */ | |
468 | extern int in_inferior_list (int pid); | |
469 | ||
470 | /* Boolean test for an already-known inferior id (GDB's homegrown id, | |
471 | not the system's). */ | |
472 | extern int valid_inferior_id (int num); | |
473 | ||
474 | /* Search function to lookup a inferior by target 'pid'. */ | |
475 | extern struct inferior *find_inferior_pid (int pid); | |
476 | ||
477 | /* Inferior iterator function. | |
478 | ||
479 | Calls a callback function once for each inferior, so long as the | |
480 | callback function returns false. If the callback function returns | |
481 | true, the iteration will end and the current inferior will be | |
482 | returned. This can be useful for implementing a search for a | |
483 | inferior with arbitrary attributes, or for applying some operation | |
484 | to every inferior. | |
485 | ||
486 | It is safe to delete the iterated inferior from the callback. */ | |
487 | extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *, | |
488 | void *), | |
489 | void *); | |
490 | ||
491 | /* Prints the list of inferiors and their details on UIOUT. | |
492 | ||
493 | If REQUESTED_INFERIOR is not -1, it's the GDB id of the inferior | |
494 | that should be printed. Otherwise, all inferiors are printed. */ | |
495 | extern void print_inferior (struct ui_out *uiout, int requested_inferior); | |
496 | ||
497 | /* Returns true if the inferior list is not empty. */ | |
498 | extern int have_inferiors (void); | |
499 | ||
500 | /* Return a pointer to the current inferior. It is an error to call | |
501 | this if there is no current inferior. */ | |
502 | extern struct inferior *current_inferior (void); | |
503 | ||
c906108c | 504 | #endif /* !defined (INFERIOR_H) */ |