| 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, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, |
| 5 | 1998, 1999, 2000, 2001, 2003, 2004, 2005, 2006, 2007, 2008 |
| 6 | Free Software Foundation, Inc. |
| 7 | |
| 8 | This file is part of GDB. |
| 9 | |
| 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 |
| 12 | the Free Software Foundation; either version 3 of the License, or |
| 13 | (at your option) any later version. |
| 14 | |
| 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. |
| 19 | |
| 20 | You should have received a copy of the GNU General Public License |
| 21 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
| 22 | |
| 23 | #if !defined (INFERIOR_H) |
| 24 | #define INFERIOR_H 1 |
| 25 | |
| 26 | struct target_waitstatus; |
| 27 | struct frame_info; |
| 28 | struct ui_file; |
| 29 | struct type; |
| 30 | struct gdbarch; |
| 31 | struct regcache; |
| 32 | struct ui_out; |
| 33 | |
| 34 | /* For bpstat. */ |
| 35 | #include "breakpoint.h" |
| 36 | |
| 37 | /* For enum target_signal. */ |
| 38 | #include "target.h" |
| 39 | |
| 40 | /* For struct frame_id. */ |
| 41 | #include "frame.h" |
| 42 | |
| 43 | /* Structure in which to save the status of the inferior. Create/Save |
| 44 | through "save_inferior_status", restore through |
| 45 | "restore_inferior_status". |
| 46 | |
| 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 | |
| 51 | struct inferior_status; |
| 52 | |
| 53 | extern struct inferior_status *save_inferior_status (int); |
| 54 | |
| 55 | extern void restore_inferior_status (struct inferior_status *); |
| 56 | |
| 57 | extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *); |
| 58 | |
| 59 | extern void discard_inferior_status (struct inferior_status *); |
| 60 | |
| 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 | |
| 88 | /* Return true if PTID represents a process id. */ |
| 89 | extern int ptid_is_pid (ptid_t ptid); |
| 90 | |
| 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 | |
| 96 | extern void set_sigint_trap (void); |
| 97 | |
| 98 | extern void clear_sigint_trap (void); |
| 99 | |
| 100 | extern void set_sigio_trap (void); |
| 101 | |
| 102 | extern void clear_sigio_trap (void); |
| 103 | |
| 104 | /* Set/get file name for default use for standard in/out in the inferior. */ |
| 105 | |
| 106 | extern void set_inferior_io_terminal (const char *terminal_name); |
| 107 | extern const char *get_inferior_io_terminal (void); |
| 108 | |
| 109 | /* Collected pid, tid, etc. of the debugged inferior. When there's |
| 110 | no inferior, PIDGET (inferior_ptid) will be 0. */ |
| 111 | |
| 112 | extern ptid_t inferior_ptid; |
| 113 | |
| 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 | |
| 119 | /* Inferior environment. */ |
| 120 | |
| 121 | extern struct gdb_environ *inferior_environ; |
| 122 | |
| 123 | extern void clear_proceed_status (void); |
| 124 | |
| 125 | extern void proceed (CORE_ADDR, enum target_signal, int); |
| 126 | |
| 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 | |
| 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 | |
| 139 | extern void generic_mourn_inferior (void); |
| 140 | |
| 141 | extern void terminal_save_ours (void); |
| 142 | |
| 143 | extern void terminal_ours (void); |
| 144 | |
| 145 | extern CORE_ADDR read_pc (void); |
| 146 | |
| 147 | extern void write_pc (CORE_ADDR); |
| 148 | |
| 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, |
| 152 | CORE_ADDR addr); |
| 153 | extern CORE_ADDR signed_pointer_to_address (struct type *type, |
| 154 | const gdb_byte *buf); |
| 155 | extern void address_to_signed_pointer (struct type *type, gdb_byte *buf, |
| 156 | CORE_ADDR addr); |
| 157 | |
| 158 | extern void wait_for_inferior (int treat_exec_as_sigtrap); |
| 159 | |
| 160 | extern void fetch_inferior_event (void *); |
| 161 | |
| 162 | extern void init_wait_for_inferior (void); |
| 163 | |
| 164 | extern void close_exec_file (void); |
| 165 | |
| 166 | extern void reopen_exec_file (void); |
| 167 | |
| 168 | /* The `resume' routine should only be called in special circumstances. |
| 169 | Normally, use `proceed', which handles a lot of bookkeeping. */ |
| 170 | |
| 171 | extern void resume (int, enum target_signal); |
| 172 | |
| 173 | /* From misc files */ |
| 174 | |
| 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); |
| 179 | |
| 180 | extern void child_terminal_info (char *, int); |
| 181 | |
| 182 | extern void term_info (char *, int); |
| 183 | |
| 184 | extern void terminal_ours_for_output (void); |
| 185 | |
| 186 | extern void terminal_inferior (void); |
| 187 | |
| 188 | extern void terminal_init_inferior (void); |
| 189 | |
| 190 | extern void terminal_init_inferior_with_pgrp (int pgrp); |
| 191 | |
| 192 | /* From procfs.c */ |
| 193 | |
| 194 | extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR)); |
| 195 | |
| 196 | extern ptid_t procfs_first_available (void); |
| 197 | |
| 198 | /* From fork-child.c */ |
| 199 | |
| 200 | extern int fork_inferior (char *, char *, char **, |
| 201 | void (*)(void), |
| 202 | void (*)(int), void (*)(void), char *); |
| 203 | |
| 204 | |
| 205 | extern void startup_inferior (int); |
| 206 | |
| 207 | extern char *construct_inferior_arguments (struct gdbarch *, int, char **); |
| 208 | |
| 209 | /* From inflow.c */ |
| 210 | |
| 211 | extern void new_tty_prefork (const char *); |
| 212 | |
| 213 | extern int gdb_has_a_terminal (void); |
| 214 | |
| 215 | /* From infrun.c */ |
| 216 | |
| 217 | extern void start_remote (int from_tty); |
| 218 | |
| 219 | extern void normal_stop (void); |
| 220 | |
| 221 | extern int signal_stop_state (int); |
| 222 | |
| 223 | extern int signal_print_state (int); |
| 224 | |
| 225 | extern int signal_pass_state (int); |
| 226 | |
| 227 | extern int signal_stop_update (int, int); |
| 228 | |
| 229 | extern int signal_print_update (int, int); |
| 230 | |
| 231 | extern int signal_pass_update (int, int); |
| 232 | |
| 233 | extern void get_last_target_status(ptid_t *ptid, |
| 234 | struct target_waitstatus *status); |
| 235 | |
| 236 | extern void follow_inferior_reset_breakpoints (void); |
| 237 | |
| 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 | |
| 244 | /* From infcmd.c */ |
| 245 | |
| 246 | extern void tty_command (char *, int); |
| 247 | |
| 248 | extern void post_create_inferior (struct target_ops *, int); |
| 249 | |
| 250 | extern void attach_command (char *, int); |
| 251 | |
| 252 | extern char *get_inferior_args (void); |
| 253 | |
| 254 | extern char *set_inferior_args (char *); |
| 255 | |
| 256 | extern void set_inferior_args_vector (int, char **); |
| 257 | |
| 258 | extern void registers_info (char *, int); |
| 259 | |
| 260 | extern void nexti_command (char *, int); |
| 261 | |
| 262 | extern void stepi_command (char *, int); |
| 263 | |
| 264 | extern void continue_1 (int all_threads); |
| 265 | |
| 266 | extern void continue_command (char *, int); |
| 267 | |
| 268 | extern void interrupt_target_command (char *args, int from_tty); |
| 269 | |
| 270 | extern void interrupt_target_1 (int all_threads); |
| 271 | |
| 272 | /* Address at which inferior stopped. */ |
| 273 | |
| 274 | extern CORE_ADDR stop_pc; |
| 275 | |
| 276 | /* Flag indicating that a command has proceeded the inferior past the |
| 277 | current breakpoint. */ |
| 278 | |
| 279 | extern int breakpoint_proceeded; |
| 280 | |
| 281 | /* Nonzero if stopped due to completion of a stack dummy routine. */ |
| 282 | |
| 283 | extern int stop_stack_dummy; |
| 284 | |
| 285 | /* Nonzero if program stopped due to a random (unexpected) signal in |
| 286 | inferior process. */ |
| 287 | |
| 288 | extern int stopped_by_random_signal; |
| 289 | |
| 290 | /* 1 means step over all subroutine calls. |
| 291 | -1 means step over calls to undebuggable functions. */ |
| 292 | |
| 293 | enum step_over_calls_kind |
| 294 | { |
| 295 | STEP_OVER_NONE, |
| 296 | STEP_OVER_ALL, |
| 297 | STEP_OVER_UNDEBUGGABLE |
| 298 | }; |
| 299 | |
| 300 | /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller |
| 301 | will handle it themselves. STOP_QUIETLY is used when running in |
| 302 | the shell before the child program has been exec'd and when running |
| 303 | through shared library loading. STOP_QUIETLY_REMOTE is used when |
| 304 | setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP |
| 305 | except that there is no need to hide a signal. */ |
| 306 | |
| 307 | /* It is also used after attach, due to attaching to a process. This |
| 308 | is a bit trickier. When doing an attach, the kernel stops the |
| 309 | debuggee with a SIGSTOP. On newer GNU/Linux kernels (>= 2.5.61) |
| 310 | the handling of SIGSTOP for a ptraced process has changed. Earlier |
| 311 | versions of the kernel would ignore these SIGSTOPs, while now |
| 312 | SIGSTOP is treated like any other signal, i.e. it is not muffled. |
| 313 | |
| 314 | If the gdb user does a 'continue' after the 'attach', gdb passes |
| 315 | the global variable stop_signal (which stores the signal from the |
| 316 | attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is |
| 317 | problematic, because the kernel doesn't ignore such SIGSTOP |
| 318 | now. I.e. it is reported back to gdb, which in turn presents it |
| 319 | back to the user. |
| 320 | |
| 321 | To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows |
| 322 | gdb to clear the value of stop_signal after the attach, so that it |
| 323 | is not passed back down to the kernel. */ |
| 324 | |
| 325 | enum stop_kind |
| 326 | { |
| 327 | NO_STOP_QUIETLY = 0, |
| 328 | STOP_QUIETLY, |
| 329 | STOP_QUIETLY_REMOTE, |
| 330 | STOP_QUIETLY_NO_SIGSTOP |
| 331 | }; |
| 332 | |
| 333 | /* Reverse execution. */ |
| 334 | enum exec_direction_kind |
| 335 | { |
| 336 | EXEC_FORWARD, |
| 337 | EXEC_REVERSE, |
| 338 | EXEC_ERROR |
| 339 | }; |
| 340 | |
| 341 | extern enum exec_direction_kind execution_direction; |
| 342 | |
| 343 | /* Nonzero if proceed is being used for a "finish" command or a similar |
| 344 | situation when stop_registers should be saved. */ |
| 345 | |
| 346 | extern int proceed_to_finish; |
| 347 | |
| 348 | /* Save register contents here when about to pop a stack dummy frame, |
| 349 | if-and-only-if proceed_to_finish is set. |
| 350 | Thus this contains the return value from the called function (assuming |
| 351 | values are returned in a register). */ |
| 352 | |
| 353 | extern struct regcache *stop_registers; |
| 354 | |
| 355 | /* True if we are debugging displaced stepping. */ |
| 356 | extern int debug_displaced; |
| 357 | |
| 358 | /* Dump LEN bytes at BUF in hex to FILE, followed by a newline. */ |
| 359 | void displaced_step_dump_bytes (struct ui_file *file, |
| 360 | const gdb_byte *buf, size_t len); |
| 361 | |
| 362 | |
| 363 | /* When set, normal_stop will not call the normal_stop observer. */ |
| 364 | extern int suppress_stop_observer; |
| 365 | |
| 366 | /* When set, no calls to target_resumed observer will be made. */ |
| 367 | extern int suppress_resume_observer; |
| 368 | |
| 369 | \f |
| 370 | /* Possible values for gdbarch_call_dummy_location. */ |
| 371 | #define ON_STACK 1 |
| 372 | #define AT_ENTRY_POINT 4 |
| 373 | #define AT_SYMBOL 5 |
| 374 | |
| 375 | /* If STARTUP_WITH_SHELL is set, GDB's "run" |
| 376 | will attempts to start up the debugee under a shell. |
| 377 | This is in order for argument-expansion to occur. E.g., |
| 378 | (gdb) run * |
| 379 | The "*" gets expanded by the shell into a list of files. |
| 380 | While this is a nice feature, it turns out to interact badly |
| 381 | with some of the catch-fork/catch-exec features we have added. |
| 382 | In particular, if the shell does any fork/exec's before |
| 383 | the exec of the target program, that can confuse GDB. |
| 384 | To disable this feature, set STARTUP_WITH_SHELL to 0. |
| 385 | To enable this feature, set STARTUP_WITH_SHELL to 1. |
| 386 | The catch-exec traps expected during start-up will |
| 387 | be 1 if target is not started up with a shell, 2 if it is. |
| 388 | - RT |
| 389 | If you disable this, you need to decrement |
| 390 | START_INFERIOR_TRAPS_EXPECTED in tm.h. */ |
| 391 | #define STARTUP_WITH_SHELL 1 |
| 392 | #if !defined(START_INFERIOR_TRAPS_EXPECTED) |
| 393 | #define START_INFERIOR_TRAPS_EXPECTED 2 |
| 394 | #endif |
| 395 | |
| 396 | struct private_inferior; |
| 397 | |
| 398 | /* GDB represents the state of each program execution with an object |
| 399 | called an inferior. An inferior typically corresponds to a process |
| 400 | but is more general and applies also to targets that do not have a |
| 401 | notion of processes. Each run of an executable creates a new |
| 402 | inferior, as does each attachment to an existing process. |
| 403 | Inferiors have unique internal identifiers that are different from |
| 404 | target process ids. Each inferior may in turn have multiple |
| 405 | threads running in it. */ |
| 406 | |
| 407 | struct inferior |
| 408 | { |
| 409 | /* Pointer to next inferior in singly-linked list of inferiors. */ |
| 410 | struct inferior *next; |
| 411 | |
| 412 | /* Convenient handle (GDB inferior id). Unique across all |
| 413 | inferiors. */ |
| 414 | int num; |
| 415 | |
| 416 | /* Actual target inferior id, usually, a process id. This matches |
| 417 | the ptid_t.pid member of threads of this inferior. */ |
| 418 | int pid; |
| 419 | |
| 420 | /* See the definition of stop_kind above. */ |
| 421 | enum stop_kind stop_soon; |
| 422 | |
| 423 | /* Nonzero if this child process was attached rather than |
| 424 | forked. */ |
| 425 | int attach_flag; |
| 426 | |
| 427 | /* What is left to do for an execution command after any thread of |
| 428 | this inferior stops. For continuations associated with a |
| 429 | specific thread, see `struct thread_info'. */ |
| 430 | struct continuation *continuations; |
| 431 | |
| 432 | /* Private data used by the target vector implementation. */ |
| 433 | struct private_inferior *private; |
| 434 | }; |
| 435 | |
| 436 | /* Create an empty inferior list, or empty the existing one. */ |
| 437 | extern void init_inferior_list (void); |
| 438 | |
| 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 |
| 442 | data. */ |
| 443 | extern struct inferior *add_inferior (int pid); |
| 444 | |
| 445 | /* Same as add_inferior, but don't print new inferior notifications to |
| 446 | the CLI. */ |
| 447 | extern struct inferior *add_inferior_silent (int pid); |
| 448 | |
| 449 | /* Delete an existing inferior list entry, due to inferior exit. */ |
| 450 | extern void delete_inferior (int pid); |
| 451 | |
| 452 | /* Same as delete_inferior, but don't print new inferior notifications |
| 453 | to the CLI. */ |
| 454 | extern void delete_inferior_silent (int pid); |
| 455 | |
| 456 | /* Delete an existing inferior list entry, due to inferior detaching. */ |
| 457 | extern void detach_inferior (int pid); |
| 458 | |
| 459 | /* Get rid of all inferiors. */ |
| 460 | extern void discard_all_inferiors (void); |
| 461 | |
| 462 | /* Translate the integer inferior id (GDB's homegrown id, not the system's) |
| 463 | into a "pid" (which may be overloaded with extra inferior information). */ |
| 464 | extern int gdb_inferior_id_to_pid (int); |
| 465 | |
| 466 | /* Translate a target 'pid' into the integer inferior id (GDB's |
| 467 | homegrown id, not the system's). */ |
| 468 | extern int pid_to_gdb_inferior_id (int pid); |
| 469 | |
| 470 | /* Boolean test for an already-known pid. */ |
| 471 | extern int in_inferior_list (int pid); |
| 472 | |
| 473 | /* Boolean test for an already-known inferior id (GDB's homegrown id, |
| 474 | not the system's). */ |
| 475 | extern int valid_inferior_id (int num); |
| 476 | |
| 477 | /* Search function to lookup a inferior by target 'pid'. */ |
| 478 | extern struct inferior *find_inferior_pid (int pid); |
| 479 | |
| 480 | /* Inferior iterator function. |
| 481 | |
| 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 |
| 487 | to every inferior. |
| 488 | |
| 489 | It is safe to delete the iterated inferior from the callback. */ |
| 490 | extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *, |
| 491 | void *), |
| 492 | void *); |
| 493 | |
| 494 | /* Prints the list of inferiors and their details on UIOUT. |
| 495 | |
| 496 | If REQUESTED_INFERIOR is not -1, it's the GDB id of the inferior |
| 497 | that should be printed. Otherwise, all inferiors are printed. */ |
| 498 | extern void print_inferior (struct ui_out *uiout, int requested_inferior); |
| 499 | |
| 500 | /* Returns true if the inferior list is not empty. */ |
| 501 | extern int have_inferiors (void); |
| 502 | |
| 503 | /* Return a pointer to the current inferior. It is an error to call |
| 504 | this if there is no current inferior. */ |
| 505 | extern struct inferior *current_inferior (void); |
| 506 | |
| 507 | #endif /* !defined (INFERIOR_H) */ |