1 /* Variables that describe the inferior process running under GDB:
2 Where it is, why it stopped, and how to step it.
3 Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
4 1998, 1999, 2000, 2001 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 2 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, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 #if !defined (INFERIOR_H)
30 #include "breakpoint.h"
32 /* For enum target_signal. */
35 /* Structure in which to save the status of the inferior. Create/Save
36 through "save_inferior_status", restore through
37 "restore_inferior_status".
39 This pair of routines should be called around any transfer of
40 control to the inferior which you don't want showing up in your
43 struct inferior_status;
45 extern struct inferior_status *save_inferior_status (int);
47 extern void restore_inferior_status (struct inferior_status *);
49 extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *);
51 extern void discard_inferior_status (struct inferior_status *);
53 extern void write_inferior_status_register (struct inferior_status
54 *inf_status, int regno,
57 /* The -1 ptid, often used to indicate either an error condition
58 or a "don't care" condition, i.e, "run all threads." */
59 extern ptid_t minus_one_ptid;
61 /* The null or zero ptid, often used to indicate no process. */
62 extern ptid_t null_ptid;
64 /* Attempt to find and return an existing ptid with the given PID, LWP,
65 and TID components. If none exists, create a new one and return
67 ptid_t ptid_build (int pid, long lwp, long tid);
69 /* Find/Create a ptid from just a pid. */
70 ptid_t pid_to_ptid (int pid);
72 /* Fetch the pid (process id) component from a ptid. */
73 int ptid_get_pid (ptid_t ptid);
75 /* Fetch the lwp (lightweight process) component from a ptid. */
76 long ptid_get_lwp (ptid_t ptid);
78 /* Fetch the tid (thread id) component from a ptid. */
79 long ptid_get_tid (ptid_t ptid);
81 /* Compare two ptids to see if they are equal */
82 extern int ptid_equal (ptid_t p1, ptid_t p2);
84 /* Save value of inferior_ptid so that it may be restored by
85 a later call to do_cleanups(). Returns the struct cleanup
86 pointer needed for later doing the cleanup. */
87 extern struct cleanup * save_inferior_ptid (void);
89 extern void set_sigint_trap (void);
91 extern void clear_sigint_trap (void);
93 extern void set_sigio_trap (void);
95 extern void clear_sigio_trap (void);
97 /* File name for default use for standard in/out in the inferior. */
99 extern char *inferior_io_terminal;
101 /* Collected pid, tid, etc. of the debugged inferior. When there's
102 no inferior, PIDGET (inferior_ptid) will be 0. */
104 extern ptid_t inferior_ptid;
106 /* Is the inferior running right now, as a result of a 'run&',
107 'continue&' etc command? This is used in asycn gdb to determine
108 whether a command that the user enters while the target is running
109 is allowed or not. */
110 extern int target_executing;
112 /* Are we simulating synchronous execution? This is used in async gdb
113 to implement the 'run', 'continue' etc commands, which will not
114 redisplay the prompt until the execution is actually over. */
115 extern int sync_execution;
117 /* This is only valid when inferior_ptid is non-zero.
119 If this is 0, then exec events should be noticed and responded to
120 by the debugger (i.e., be reported to the user).
122 If this is > 0, then that many subsequent exec events should be
123 ignored (i.e., not be reported to the user).
125 extern int inferior_ignoring_startup_exec_events;
127 /* This is only valid when inferior_ignoring_startup_exec_events is
130 Some targets (stupidly) report more than one exec event per actual
131 call to an event() system call. If only the last such exec event
132 need actually be noticed and responded to by the debugger (i.e.,
133 be reported to the user), then this is the number of "leading"
134 exec events which should be ignored.
136 extern int inferior_ignoring_leading_exec_events;
138 /* Inferior environment. */
140 extern struct environ *inferior_environ;
142 extern void clear_proceed_status (void);
144 extern void proceed (CORE_ADDR, enum target_signal, int);
146 /* When set, stop the 'step' command if we enter a function which has
147 no line number information. The normal behavior is that we step
148 over such function. */
149 extern int step_stop_if_no_debug;
151 extern void kill_inferior (void);
153 extern void generic_mourn_inferior (void);
155 extern void terminal_ours (void);
157 extern int run_stack_dummy (CORE_ADDR, char *);
159 extern CORE_ADDR read_pc (void);
161 extern CORE_ADDR read_pc_pid (ptid_t);
163 extern CORE_ADDR generic_target_read_pc (ptid_t);
165 extern void write_pc (CORE_ADDR);
167 extern void write_pc_pid (CORE_ADDR, ptid_t);
169 extern void generic_target_write_pc (CORE_ADDR, ptid_t);
171 extern CORE_ADDR read_sp (void);
173 extern CORE_ADDR generic_target_read_sp (void);
175 extern void write_sp (CORE_ADDR);
177 extern void generic_target_write_sp (CORE_ADDR);
179 extern CORE_ADDR read_fp (void);
181 extern CORE_ADDR generic_target_read_fp (void);
183 extern CORE_ADDR unsigned_pointer_to_address (struct type *type, void *buf);
185 extern void unsigned_address_to_pointer (struct type *type, void *buf,
187 extern CORE_ADDR signed_pointer_to_address (struct type *type, void *buf);
188 extern void address_to_signed_pointer (struct type *type, void *buf,
191 extern void wait_for_inferior (void);
193 extern void fetch_inferior_event (void *);
195 extern void init_wait_for_inferior (void);
197 extern void close_exec_file (void);
199 extern void reopen_exec_file (void);
201 /* The `resume' routine should only be called in special circumstances.
202 Normally, use `proceed', which handles a lot of bookkeeping. */
204 extern void resume (int, enum target_signal);
206 /* From misc files */
208 extern void do_registers_info (int, int);
210 extern void store_inferior_registers (int);
212 extern void fetch_inferior_registers (int);
214 extern void solib_create_inferior_hook (void);
216 extern void child_terminal_info (char *, int);
218 extern void term_info (char *, int);
220 extern void terminal_ours_for_output (void);
222 extern void terminal_inferior (void);
224 extern void terminal_init_inferior (void);
226 extern void terminal_init_inferior_with_pgrp (int pgrp);
228 /* From infptrace.c or infttrace.c */
230 extern int attach (int);
232 #if !defined(REQUIRE_ATTACH)
233 #define REQUIRE_ATTACH attach
236 #if !defined(REQUIRE_DETACH)
237 #define REQUIRE_DETACH(pid,siggnal) detach (siggnal)
240 extern void detach (int);
242 /* PTRACE method of waiting for inferior process. */
243 int ptrace_wait (ptid_t, int *);
245 extern void child_resume (ptid_t, int, enum target_signal);
247 #ifndef PTRACE_ARG3_TYPE
248 #define PTRACE_ARG3_TYPE int /* Correct definition for most systems. */
251 extern int call_ptrace (int, int, PTRACE_ARG3_TYPE, int);
253 extern void pre_fork_inferior (void);
257 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
259 extern ptid_t procfs_first_available (void);
261 /* From fork-child.c */
263 extern void fork_inferior (char *, char *, char **,
265 void (*)(int), void (*)(void), char *);
268 extern void clone_and_follow_inferior (int, int *);
270 extern void startup_inferior (int);
272 extern char *construct_inferior_arguments (struct gdbarch *, int, char **);
276 extern void new_tty_prefork (char *);
278 extern int gdb_has_a_terminal (void);
282 extern void start_remote (void);
284 extern void normal_stop (void);
286 extern int signal_stop_state (int);
288 extern int signal_print_state (int);
290 extern int signal_pass_state (int);
292 extern int signal_stop_update (int, int);
294 extern int signal_print_update (int, int);
296 extern int signal_pass_update (int, int);
298 extern void get_last_target_status(ptid_t *ptid,
299 struct target_waitstatus *status);
303 extern void tty_command (char *, int);
305 extern void attach_command (char *, int);
307 extern char *get_inferior_args (void);
309 extern char *set_inferior_args (char *);
311 extern void set_inferior_args_vector (int, char **);
313 /* Last signal that the inferior received (why it stopped). */
315 extern enum target_signal stop_signal;
317 /* Address at which inferior stopped. */
319 extern CORE_ADDR stop_pc;
321 /* Chain containing status of breakpoint(s) that we have stopped at. */
323 extern bpstat stop_bpstat;
325 /* Flag indicating that a command has proceeded the inferior past the
326 current breakpoint. */
328 extern int breakpoint_proceeded;
330 /* Nonzero if stopped due to a step command. */
332 extern int stop_step;
334 /* Nonzero if stopped due to completion of a stack dummy routine. */
336 extern int stop_stack_dummy;
338 /* Nonzero if program stopped due to a random (unexpected) signal in
341 extern int stopped_by_random_signal;
343 /* Range to single step within.
344 If this is nonzero, respond to a single-step signal
345 by continuing to step if the pc is in this range.
347 If step_range_start and step_range_end are both 1, it means to step for
348 a single instruction (FIXME: it might clean up wait_for_inferior in a
349 minor way if this were changed to the address of the instruction and
350 that address plus one. But maybe not.). */
352 extern CORE_ADDR step_range_start; /* Inclusive */
353 extern CORE_ADDR step_range_end; /* Exclusive */
355 /* Stack frame address as of when stepping command was issued.
356 This is how we know when we step into a subroutine call,
357 and how to set the frame for the breakpoint used to step out. */
359 extern CORE_ADDR step_frame_address;
361 /* Our notion of the current stack pointer. */
363 extern CORE_ADDR step_sp;
365 /* 1 means step over all subroutine calls.
366 -1 means step over calls to undebuggable functions. */
368 enum step_over_calls_kind
372 STEP_OVER_UNDEBUGGABLE
375 extern enum step_over_calls_kind step_over_calls;
377 /* If stepping, nonzero means step count is > 1
378 so don't print frame next time inferior stops
379 if it stops due to stepping. */
381 extern int step_multi;
383 /* Nonzero means expecting a trap and caller will handle it themselves.
384 It is used after attach, due to attaching to a process;
385 when running in the shell before the child program has been exec'd;
386 and when running some kinds of remote stuff (FIXME?). */
388 extern int stop_soon_quietly;
390 /* Nonzero if proceed is being used for a "finish" command or a similar
391 situation when stop_registers should be saved. */
393 extern int proceed_to_finish;
395 /* Save register contents here when about to pop a stack dummy frame,
396 if-and-only-if proceed_to_finish is set.
397 Thus this contains the return value from the called function (assuming
398 values are returned in a register). */
400 extern struct regcache *stop_registers;
402 /* Nonzero if the child process in inferior_ptid was attached rather
405 extern int attach_flag;
407 /* Possible values for CALL_DUMMY_LOCATION. */
409 #define BEFORE_TEXT_END 2
410 #define AFTER_TEXT_END 3
411 #define AT_ENTRY_POINT 4
413 #if !defined (USE_GENERIC_DUMMY_FRAMES)
414 #define USE_GENERIC_DUMMY_FRAMES 0
417 #if !defined (CALL_DUMMY_LOCATION)
418 #define CALL_DUMMY_LOCATION ON_STACK
419 #endif /* No CALL_DUMMY_LOCATION. */
421 #if !defined (CALL_DUMMY_ADDRESS)
422 #define CALL_DUMMY_ADDRESS() (internal_error (__FILE__, __LINE__, "CALL_DUMMY_ADDRESS"), 0)
424 #if !defined (CALL_DUMMY_START_OFFSET)
425 #define CALL_DUMMY_START_OFFSET (internal_error (__FILE__, __LINE__, "CALL_DUMMY_START_OFFSET"), 0)
427 #if !defined (CALL_DUMMY_BREAKPOINT_OFFSET)
428 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (0)
429 #define CALL_DUMMY_BREAKPOINT_OFFSET (internal_error (__FILE__, __LINE__, "CALL_DUMMY_BREAKPOINT_OFFSET"), 0)
431 #if !defined CALL_DUMMY_BREAKPOINT_OFFSET_P
432 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (1)
434 #if !defined (CALL_DUMMY_LENGTH)
435 #define CALL_DUMMY_LENGTH (internal_error (__FILE__, __LINE__, "CALL_DUMMY_LENGTH"), 0)
438 #if defined (CALL_DUMMY_STACK_ADJUST)
439 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
440 #define CALL_DUMMY_STACK_ADJUST_P (1)
443 #if !defined (CALL_DUMMY_STACK_ADJUST)
444 #define CALL_DUMMY_STACK_ADJUST (internal_error (__FILE__, __LINE__, "CALL_DUMMY_STACK_ADJUST"), 0)
446 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
447 #define CALL_DUMMY_STACK_ADJUST_P (0)
450 /* FIXME: cagney/2000-04-17: gdbarch should manage this. The default
451 shouldn't be necessary. */
453 #if !defined (CALL_DUMMY_P)
454 #if defined (CALL_DUMMY)
455 #define CALL_DUMMY_P 1
457 #define CALL_DUMMY_P 0
461 #if !defined PUSH_DUMMY_FRAME
462 #define PUSH_DUMMY_FRAME (internal_error (__FILE__, __LINE__, "PUSH_DUMMY_FRAME"), 0)
465 #if !defined FIX_CALL_DUMMY
466 #define FIX_CALL_DUMMY(a1,a2,a3,a4,a5,a6,a7) (internal_error (__FILE__, __LINE__, "FIX_CALL_DUMMY"), 0)
469 #if !defined STORE_STRUCT_RETURN
470 #define STORE_STRUCT_RETURN(a1,a2) (internal_error (__FILE__, __LINE__, "STORE_STRUCT_RETURN"), 0)
474 /* Are we in a call dummy? */
476 extern int pc_in_call_dummy_before_text_end (CORE_ADDR pc, CORE_ADDR sp,
477 CORE_ADDR frame_address);
479 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == BEFORE_TEXT_END
480 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_before_text_end (pc, sp, frame_address)
481 #endif /* Before text_end. */
484 extern int pc_in_call_dummy_after_text_end (CORE_ADDR pc, CORE_ADDR sp,
485 CORE_ADDR frame_address);
487 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == AFTER_TEXT_END
488 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_after_text_end (pc, sp, frame_address)
492 extern int pc_in_call_dummy_on_stack (CORE_ADDR pc, CORE_ADDR sp,
493 CORE_ADDR frame_address);
495 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == ON_STACK
496 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_on_stack (pc, sp, frame_address)
500 extern int pc_in_call_dummy_at_entry_point (CORE_ADDR pc, CORE_ADDR sp,
501 CORE_ADDR frame_address);
503 #if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == AT_ENTRY_POINT
504 #define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_at_entry_point (pc, sp, frame_address)
508 /* It's often not enough for our clients to know whether the PC is merely
509 somewhere within the call dummy. They may need to know whether the
510 call dummy has actually completed. (For example, wait_for_inferior
511 wants to know when it should truly stop because the call dummy has
512 completed. If we're single-stepping because of slow watchpoints,
513 then we may find ourselves stopped at the entry of the call dummy,
514 and want to continue stepping until we reach the end.)
516 Note that this macro is intended for targets (like HP-UX) which
517 require more than a single breakpoint in their call dummies, and
518 therefore cannot use the CALL_DUMMY_BREAKPOINT_OFFSET mechanism.
520 If a target does define CALL_DUMMY_BREAKPOINT_OFFSET, then this
521 default implementation of CALL_DUMMY_HAS_COMPLETED is sufficient.
522 Else, a target may wish to supply an implementation that works in
523 the presense of multiple breakpoints in its call dummy.
525 #if !defined(CALL_DUMMY_HAS_COMPLETED)
526 #define CALL_DUMMY_HAS_COMPLETED(pc, sp, frame_address) \
527 PC_IN_CALL_DUMMY((pc), (sp), (frame_address))
530 /* If STARTUP_WITH_SHELL is set, GDB's "run"
531 will attempts to start up the debugee under a shell.
532 This is in order for argument-expansion to occur. E.g.,
534 The "*" gets expanded by the shell into a list of files.
535 While this is a nice feature, it turns out to interact badly
536 with some of the catch-fork/catch-exec features we have added.
537 In particular, if the shell does any fork/exec's before
538 the exec of the target program, that can confuse GDB.
539 To disable this feature, set STARTUP_WITH_SHELL to 0.
540 To enable this feature, set STARTUP_WITH_SHELL to 1.
541 The catch-exec traps expected during start-up will
542 be 1 if target is not started up with a shell, 2 if it is.
544 If you disable this, you need to decrement
545 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
546 #define STARTUP_WITH_SHELL 1
547 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
548 #define START_INFERIOR_TRAPS_EXPECTED 2
550 #endif /* !defined (INFERIOR_H) */