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, 2009 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 struct terminal_info; 34 35 /* For bpstat. */ 36 #include "breakpoint.h" 37 38 /* For enum target_signal. */ 39 #include "target.h" 40 41 /* For struct frame_id. */ 42 #include "frame.h" 43 44 /* Two structures are used to record inferior state. 45 46 inferior_thread_state contains state about the program itself like its 47 registers and any signal it received when it last stopped. 48 This state must be restored regardless of how the inferior function call 49 ends (either successfully, or after it hits a breakpoint or signal) 50 if the program is to properly continue where it left off. 51 52 inferior_status contains state regarding gdb's control of the inferior 53 itself like stepping control. It also contains session state like the 54 user's currently selected frame. 55 56 Call these routines around hand called functions, including function calls 57 in conditional breakpoints for example. */ 58 59 struct inferior_thread_state; 60 struct inferior_status; 61 62 extern struct inferior_thread_state *save_inferior_thread_state (void); 63 extern struct inferior_status *save_inferior_status (void); 64 65 extern void restore_inferior_thread_state (struct inferior_thread_state *); 66 extern void restore_inferior_status (struct inferior_status *); 67 68 extern struct cleanup *make_cleanup_restore_inferior_thread_state (struct inferior_thread_state *); 69 extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *); 70 71 extern void discard_inferior_thread_state (struct inferior_thread_state *); 72 extern void discard_inferior_status (struct inferior_status *); 73 74 extern struct regcache *get_inferior_thread_state_regcache (struct inferior_thread_state *); 75 76 /* The -1 ptid, often used to indicate either an error condition 77 or a "don't care" condition, i.e, "run all threads." */ 78 extern ptid_t minus_one_ptid; 79 80 /* The null or zero ptid, often used to indicate no process. */ 81 extern ptid_t null_ptid; 82 83 /* Attempt to find and return an existing ptid with the given PID, LWP, 84 and TID components. If none exists, create a new one and return 85 that. */ 86 ptid_t ptid_build (int pid, long lwp, long tid); 87 88 /* Find/Create a ptid from just a pid. */ 89 ptid_t pid_to_ptid (int pid); 90 91 /* Fetch the pid (process id) component from a ptid. */ 92 int ptid_get_pid (ptid_t ptid); 93 94 /* Fetch the lwp (lightweight process) component from a ptid. */ 95 long ptid_get_lwp (ptid_t ptid); 96 97 /* Fetch the tid (thread id) component from a ptid. */ 98 long ptid_get_tid (ptid_t ptid); 99 100 /* Compare two ptids to see if they are equal */ 101 extern int ptid_equal (ptid_t p1, ptid_t p2); 102 103 /* Return true if PTID represents a process id. */ 104 extern int ptid_is_pid (ptid_t ptid); 105 106 /* Save value of inferior_ptid so that it may be restored by 107 a later call to do_cleanups(). Returns the struct cleanup 108 pointer needed for later doing the cleanup. */ 109 extern struct cleanup * save_inferior_ptid (void); 110 111 extern void set_sigint_trap (void); 112 113 extern void clear_sigint_trap (void); 114 115 /* Set/get file name for default use for standard in/out in the inferior. */ 116 117 extern void set_inferior_io_terminal (const char *terminal_name); 118 extern const char *get_inferior_io_terminal (void); 119 120 /* Collected pid, tid, etc. of the debugged inferior. When there's 121 no inferior, PIDGET (inferior_ptid) will be 0. */ 122 123 extern ptid_t inferior_ptid; 124 125 /* Are we simulating synchronous execution? This is used in async gdb 126 to implement the 'run', 'continue' etc commands, which will not 127 redisplay the prompt until the execution is actually over. */ 128 extern int sync_execution; 129 130 /* Inferior environment. */ 131 132 extern struct gdb_environ *inferior_environ; 133 134 extern void clear_proceed_status (void); 135 136 extern void proceed (CORE_ADDR, enum target_signal, int); 137 138 extern int sched_multi; 139 140 /* When set, stop the 'step' command if we enter a function which has 141 no line number information. The normal behavior is that we step 142 over such function. */ 143 extern int step_stop_if_no_debug; 144 145 /* If set, the inferior should be controlled in non-stop mode. In 146 this mode, each thread is controlled independently. Execution 147 commands apply only to the the selected thread by default, and stop 148 events stop only the thread that had the event -- the other threads 149 are kept running freely. */ 150 extern int non_stop; 151 152 extern void generic_mourn_inferior (void); 153 154 extern void terminal_save_ours (void); 155 156 extern void terminal_ours (void); 157 158 extern CORE_ADDR unsigned_pointer_to_address (struct gdbarch *gdbarch, 159 struct type *type, 160 const gdb_byte *buf); 161 extern void unsigned_address_to_pointer (struct gdbarch *gdbarch, 162 struct type *type, gdb_byte *buf, 163 CORE_ADDR addr); 164 extern CORE_ADDR signed_pointer_to_address (struct gdbarch *gdbarch, 165 struct type *type, 166 const gdb_byte *buf); 167 extern void address_to_signed_pointer (struct gdbarch *gdbarch, 168 struct type *type, gdb_byte *buf, 169 CORE_ADDR addr); 170 171 extern void wait_for_inferior (int treat_exec_as_sigtrap); 172 173 extern void fetch_inferior_event (void *); 174 175 extern void init_wait_for_inferior (void); 176 177 extern void close_exec_file (void); 178 179 extern void reopen_exec_file (void); 180 181 /* The `resume' routine should only be called in special circumstances. 182 Normally, use `proceed', which handles a lot of bookkeeping. */ 183 184 extern void resume (int, enum target_signal); 185 186 /* From misc files */ 187 188 extern void default_print_registers_info (struct gdbarch *gdbarch, 189 struct ui_file *file, 190 struct frame_info *frame, 191 int regnum, int all); 192 193 extern void child_terminal_info (char *, int); 194 195 extern void term_info (char *, int); 196 197 extern void terminal_ours_for_output (void); 198 199 extern void terminal_inferior (void); 200 201 extern void terminal_init_inferior (void); 202 203 extern void terminal_init_inferior_with_pgrp (int pgrp); 204 205 /* From fork-child.c */ 206 207 extern int fork_inferior (char *, char *, char **, 208 void (*)(void), 209 void (*)(int), void (*)(void), char *); 210 211 212 extern void startup_inferior (int); 213 214 extern char *construct_inferior_arguments (int, char **); 215 216 /* From infrun.c */ 217 218 extern void start_remote (int from_tty); 219 220 extern void normal_stop (void); 221 222 extern int signal_stop_state (int); 223 224 extern int signal_print_state (int); 225 226 extern int signal_pass_state (int); 227 228 extern int signal_stop_update (int, int); 229 230 extern int signal_print_update (int, int); 231 232 extern int signal_pass_update (int, int); 233 234 extern void get_last_target_status(ptid_t *ptid, 235 struct target_waitstatus *status); 236 237 extern void follow_inferior_reset_breakpoints (void); 238 239 /* Throw an error indicating the current thread is running. */ 240 extern void error_is_running (void); 241 242 /* Calls error_is_running if the current thread is running. */ 243 extern void ensure_not_running (void); 244 245 void set_step_info (struct frame_info *frame, struct symtab_and_line sal); 246 247 /* From infcmd.c */ 248 249 extern void tty_command (char *, int); 250 251 extern void post_create_inferior (struct target_ops *, int); 252 253 extern void attach_command (char *, int); 254 255 extern char *get_inferior_args (void); 256 257 extern char *set_inferior_args (char *); 258 259 extern void set_inferior_args_vector (int, char **); 260 261 extern void registers_info (char *, int); 262 263 extern void nexti_command (char *, int); 264 265 extern void stepi_command (char *, int); 266 267 extern void continue_1 (int all_threads); 268 269 extern void continue_command (char *, int); 270 271 extern void interrupt_target_command (char *args, int from_tty); 272 273 extern void interrupt_target_1 (int all_threads); 274 275 extern void detach_command (char *, int); 276 277 extern void notice_new_inferior (ptid_t, int, int); 278 279 /* Address at which inferior stopped. */ 280 281 extern CORE_ADDR stop_pc; 282 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 292 /* STEP_OVER_ALL means step over all subroutine calls. 293 STEP_OVER_UNDEBUGGABLE means step over calls to undebuggable functions. 294 STEP_OVER_NONE means don't step over any subroutine calls. */ 295 296 enum step_over_calls_kind 297 { 298 STEP_OVER_NONE, 299 STEP_OVER_ALL, 300 STEP_OVER_UNDEBUGGABLE 301 }; 302 303 /* Anything but NO_STOP_QUIETLY means we expect a trap and the caller 304 will handle it themselves. STOP_QUIETLY is used when running in 305 the shell before the child program has been exec'd and when running 306 through shared library loading. STOP_QUIETLY_REMOTE is used when 307 setting up a remote connection; it is like STOP_QUIETLY_NO_SIGSTOP 308 except that there is no need to hide a signal. */ 309 310 /* It is also used after attach, due to attaching to a process. This 311 is a bit trickier. When doing an attach, the kernel stops the 312 debuggee with a SIGSTOP. On newer GNU/Linux kernels (>= 2.5.61) 313 the handling of SIGSTOP for a ptraced process has changed. Earlier 314 versions of the kernel would ignore these SIGSTOPs, while now 315 SIGSTOP is treated like any other signal, i.e. it is not muffled. 316 317 If the gdb user does a 'continue' after the 'attach', gdb passes 318 the global variable stop_signal (which stores the signal from the 319 attach, SIGSTOP) to the ptrace(PTRACE_CONT,...) call. This is 320 problematic, because the kernel doesn't ignore such SIGSTOP 321 now. I.e. it is reported back to gdb, which in turn presents it 322 back to the user. 323 324 To avoid the problem, we use STOP_QUIETLY_NO_SIGSTOP, which allows 325 gdb to clear the value of stop_signal after the attach, so that it 326 is not passed back down to the kernel. */ 327 328 enum stop_kind 329 { 330 NO_STOP_QUIETLY = 0, 331 STOP_QUIETLY, 332 STOP_QUIETLY_REMOTE, 333 STOP_QUIETLY_NO_SIGSTOP 334 }; 335 336 /* Reverse execution. */ 337 enum exec_direction_kind 338 { 339 EXEC_FORWARD, 340 EXEC_REVERSE, 341 EXEC_ERROR 342 }; 343 344 extern enum exec_direction_kind execution_direction; 345 346 /* Save register contents here when executing a "finish" command or are 347 about to pop a stack dummy frame, if-and-only-if proceed_to_finish is set. 348 Thus this contains the return value from the called function (assuming 349 values are returned in a register). */ 350 351 extern struct regcache *stop_registers; 352 353 /* True if we are debugging displaced stepping. */ 354 extern int debug_displaced; 355 356 /* Dump LEN bytes at BUF in hex to FILE, followed by a newline. */ 357 void displaced_step_dump_bytes (struct ui_file *file, 358 const gdb_byte *buf, size_t len); 359 360 361 /* Possible values for gdbarch_call_dummy_location. */ 362 #define ON_STACK 1 363 #define AT_ENTRY_POINT 4 364 #define AT_SYMBOL 5 365 366 /* If STARTUP_WITH_SHELL is set, GDB's "run" 367 will attempts to start up the debugee under a shell. 368 This is in order for argument-expansion to occur. E.g., 369 (gdb) run * 370 The "*" gets expanded by the shell into a list of files. 371 While this is a nice feature, it turns out to interact badly 372 with some of the catch-fork/catch-exec features we have added. 373 In particular, if the shell does any fork/exec's before 374 the exec of the target program, that can confuse GDB. 375 To disable this feature, set STARTUP_WITH_SHELL to 0. 376 To enable this feature, set STARTUP_WITH_SHELL to 1. 377 The catch-exec traps expected during start-up will 378 be 1 if target is not started up with a shell, 2 if it is. 379 - RT 380 If you disable this, you need to decrement 381 START_INFERIOR_TRAPS_EXPECTED in tm.h. */ 382 #define STARTUP_WITH_SHELL 1 383 #if !defined(START_INFERIOR_TRAPS_EXPECTED) 384 #define START_INFERIOR_TRAPS_EXPECTED 2 385 #endif 386 387 struct private_inferior; 388 389 /* GDB represents the state of each program execution with an object 390 called an inferior. An inferior typically corresponds to a process 391 but is more general and applies also to targets that do not have a 392 notion of processes. Each run of an executable creates a new 393 inferior, as does each attachment to an existing process. 394 Inferiors have unique internal identifiers that are different from 395 target process ids. Each inferior may in turn have multiple 396 threads running in it. */ 397 398 struct inferior 399 { 400 /* Pointer to next inferior in singly-linked list of inferiors. */ 401 struct inferior *next; 402 403 /* Convenient handle (GDB inferior id). Unique across all 404 inferiors. */ 405 int num; 406 407 /* Actual target inferior id, usually, a process id. This matches 408 the ptid_t.pid member of threads of this inferior. */ 409 int pid; 410 411 /* See the definition of stop_kind above. */ 412 enum stop_kind stop_soon; 413 414 /* Nonzero if this child process was attached rather than 415 forked. */ 416 int attach_flag; 417 418 /* What is left to do for an execution command after any thread of 419 this inferior stops. For continuations associated with a 420 specific thread, see `struct thread_info'. */ 421 struct continuation *continuations; 422 423 /* Terminal info and state managed by inflow.c. */ 424 struct terminal_info *terminal_info; 425 426 /* Private data used by the target vector implementation. */ 427 struct private_inferior *private; 428 429 /* We keep a count of the number of times the user has requested a 430 particular syscall to be tracked, and pass this information to the 431 target. This lets capable targets implement filtering directly. */ 432 433 /* Number of times that "any" syscall is requested. */ 434 int any_syscall_count; 435 436 /* Count of each system call. */ 437 VEC(int) *syscalls_counts; 438 439 /* This counts all syscall catch requests, so we can readily determine 440 if any catching is necessary. */ 441 int total_syscalls_count; 442 }; 443 444 /* Create an empty inferior list, or empty the existing one. */ 445 extern void init_inferior_list (void); 446 447 /* Add an inferior to the inferior list, print a message that a new 448 inferior is found, and return the pointer to the new inferior. 449 Caller may use this pointer to initialize the private inferior 450 data. */ 451 extern struct inferior *add_inferior (int pid); 452 453 /* Same as add_inferior, but don't print new inferior notifications to 454 the CLI. */ 455 extern struct inferior *add_inferior_silent (int pid); 456 457 /* Delete an existing inferior list entry, due to inferior exit. */ 458 extern void delete_inferior (int pid); 459 460 /* Same as delete_inferior, but don't print new inferior notifications 461 to the CLI. */ 462 extern void delete_inferior_silent (int pid); 463 464 /* Delete an existing inferior list entry, due to inferior detaching. */ 465 extern void detach_inferior (int pid); 466 467 /* Get rid of all inferiors. */ 468 extern void discard_all_inferiors (void); 469 470 /* Translate the integer inferior id (GDB's homegrown id, not the system's) 471 into a "pid" (which may be overloaded with extra inferior information). */ 472 extern int gdb_inferior_id_to_pid (int); 473 474 /* Translate a target 'pid' into the integer inferior id (GDB's 475 homegrown id, not the system's). */ 476 extern int pid_to_gdb_inferior_id (int pid); 477 478 /* Boolean test for an already-known pid. */ 479 extern int in_inferior_list (int pid); 480 481 /* Boolean test for an already-known inferior id (GDB's homegrown id, 482 not the system's). */ 483 extern int valid_gdb_inferior_id (int num); 484 485 /* Search function to lookup a inferior by target 'pid'. */ 486 extern struct inferior *find_inferior_pid (int pid); 487 488 /* Inferior iterator function. 489 490 Calls a callback function once for each inferior, so long as the 491 callback function returns false. If the callback function returns 492 true, the iteration will end and the current inferior will be 493 returned. This can be useful for implementing a search for a 494 inferior with arbitrary attributes, or for applying some operation 495 to every inferior. 496 497 It is safe to delete the iterated inferior from the callback. */ 498 extern struct inferior *iterate_over_inferiors (int (*) (struct inferior *, 499 void *), 500 void *); 501 502 /* Prints the list of inferiors and their details on UIOUT. 503 504 If REQUESTED_INFERIOR is not -1, it's the GDB id of the inferior 505 that should be printed. Otherwise, all inferiors are printed. */ 506 extern void print_inferior (struct ui_out *uiout, int requested_inferior); 507 508 /* Returns true if the inferior list is not empty. */ 509 extern int have_inferiors (void); 510 511 /* Returns true if there are any live inferiors in the inferior list 512 (not cores, not executables, real live processes). */ 513 extern int have_live_inferiors (void); 514 515 /* Return a pointer to the current inferior. It is an error to call 516 this if there is no current inferior. */ 517 extern struct inferior *current_inferior (void); 518 519 #endif /* !defined (INFERIOR_H) */ 520