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 /* For struct frame_id. */
38 /* Structure in which to save the status of the inferior. Create/Save
39 through "save_inferior_status", restore through
40 "restore_inferior_status".
42 This pair of routines should be called around any transfer of
43 control to the inferior which you don't want showing up in your
46 struct inferior_status
;
48 extern struct inferior_status
*save_inferior_status (int);
50 extern void restore_inferior_status (struct inferior_status
*);
52 extern struct cleanup
*make_cleanup_restore_inferior_status (struct inferior_status
*);
54 extern void discard_inferior_status (struct inferior_status
*);
56 extern void write_inferior_status_register (struct inferior_status
57 *inf_status
, int regno
,
60 /* The -1 ptid, often used to indicate either an error condition
61 or a "don't care" condition, i.e, "run all threads." */
62 extern ptid_t minus_one_ptid
;
64 /* The null or zero ptid, often used to indicate no process. */
65 extern ptid_t null_ptid
;
67 /* Attempt to find and return an existing ptid with the given PID, LWP,
68 and TID components. If none exists, create a new one and return
70 ptid_t
ptid_build (int pid
, long lwp
, long tid
);
72 /* Find/Create a ptid from just a pid. */
73 ptid_t
pid_to_ptid (int pid
);
75 /* Fetch the pid (process id) component from a ptid. */
76 int ptid_get_pid (ptid_t ptid
);
78 /* Fetch the lwp (lightweight process) component from a ptid. */
79 long ptid_get_lwp (ptid_t ptid
);
81 /* Fetch the tid (thread id) component from a ptid. */
82 long ptid_get_tid (ptid_t ptid
);
84 /* Compare two ptids to see if they are equal */
85 extern int ptid_equal (ptid_t p1
, ptid_t p2
);
87 /* Save value of inferior_ptid so that it may be restored by
88 a later call to do_cleanups(). Returns the struct cleanup
89 pointer needed for later doing the cleanup. */
90 extern struct cleanup
* save_inferior_ptid (void);
92 extern void set_sigint_trap (void);
94 extern void clear_sigint_trap (void);
96 extern void set_sigio_trap (void);
98 extern void clear_sigio_trap (void);
100 /* File name for default use for standard in/out in the inferior. */
102 extern char *inferior_io_terminal
;
104 /* Collected pid, tid, etc. of the debugged inferior. When there's
105 no inferior, PIDGET (inferior_ptid) will be 0. */
107 extern ptid_t inferior_ptid
;
109 /* Is the inferior running right now, as a result of a 'run&',
110 'continue&' etc command? This is used in asycn gdb to determine
111 whether a command that the user enters while the target is running
112 is allowed or not. */
113 extern int target_executing
;
115 /* Are we simulating synchronous execution? This is used in async gdb
116 to implement the 'run', 'continue' etc commands, which will not
117 redisplay the prompt until the execution is actually over. */
118 extern int sync_execution
;
120 /* This is only valid when inferior_ptid is non-zero.
122 If this is 0, then exec events should be noticed and responded to
123 by the debugger (i.e., be reported to the user).
125 If this is > 0, then that many subsequent exec events should be
126 ignored (i.e., not be reported to the user).
128 extern int inferior_ignoring_startup_exec_events
;
130 /* This is only valid when inferior_ignoring_startup_exec_events is
133 Some targets (stupidly) report more than one exec event per actual
134 call to an event() system call. If only the last such exec event
135 need actually be noticed and responded to by the debugger (i.e.,
136 be reported to the user), then this is the number of "leading"
137 exec events which should be ignored.
139 extern int inferior_ignoring_leading_exec_events
;
141 /* Inferior environment. */
143 extern struct environ
*inferior_environ
;
145 extern void clear_proceed_status (void);
147 extern void proceed (CORE_ADDR
, enum target_signal
, int);
149 /* When set, stop the 'step' command if we enter a function which has
150 no line number information. The normal behavior is that we step
151 over such function. */
152 extern int step_stop_if_no_debug
;
154 extern void kill_inferior (void);
156 extern void generic_mourn_inferior (void);
158 extern void terminal_save_ours (void);
160 extern void terminal_ours (void);
162 extern int run_stack_dummy (CORE_ADDR
, struct regcache
*);
164 extern CORE_ADDR
read_pc (void);
166 extern CORE_ADDR
read_pc_pid (ptid_t
);
168 extern CORE_ADDR
generic_target_read_pc (ptid_t
);
170 extern void write_pc (CORE_ADDR
);
172 extern void write_pc_pid (CORE_ADDR
, ptid_t
);
174 extern void generic_target_write_pc (CORE_ADDR
, ptid_t
);
176 extern CORE_ADDR
read_sp (void);
178 extern CORE_ADDR
generic_target_read_sp (void);
180 extern void write_sp (CORE_ADDR
);
182 extern void generic_target_write_sp (CORE_ADDR
);
184 extern CORE_ADDR
read_fp (void);
186 extern CORE_ADDR
generic_target_read_fp (void);
188 extern CORE_ADDR
unsigned_pointer_to_address (struct type
*type
, void *buf
);
190 extern void unsigned_address_to_pointer (struct type
*type
, void *buf
,
192 extern CORE_ADDR
signed_pointer_to_address (struct type
*type
, void *buf
);
193 extern void address_to_signed_pointer (struct type
*type
, void *buf
,
196 extern void wait_for_inferior (void);
198 extern void fetch_inferior_event (void *);
200 extern void init_wait_for_inferior (void);
202 extern void close_exec_file (void);
204 extern void reopen_exec_file (void);
206 /* The `resume' routine should only be called in special circumstances.
207 Normally, use `proceed', which handles a lot of bookkeeping. */
209 extern void resume (int, enum target_signal
);
211 /* From misc files */
213 extern void default_print_registers_info (struct gdbarch
*gdbarch
,
214 struct ui_file
*file
,
215 struct frame_info
*frame
,
216 int regnum
, int all
);
218 extern void store_inferior_registers (int);
220 extern void fetch_inferior_registers (int);
222 extern void solib_create_inferior_hook (void);
224 extern void child_terminal_info (char *, int);
226 extern void term_info (char *, int);
228 extern void terminal_ours_for_output (void);
230 extern void terminal_inferior (void);
232 extern void terminal_init_inferior (void);
234 extern void terminal_init_inferior_with_pgrp (int pgrp
);
236 /* From infptrace.c or infttrace.c */
238 extern int attach (int);
240 #if !defined(REQUIRE_ATTACH)
241 #define REQUIRE_ATTACH attach
244 #if !defined(REQUIRE_DETACH)
245 #define REQUIRE_DETACH(pid,siggnal) detach (siggnal)
248 extern void detach (int);
250 /* PTRACE method of waiting for inferior process. */
251 int ptrace_wait (ptid_t
, int *);
253 extern void child_resume (ptid_t
, int, enum target_signal
);
255 #ifndef PTRACE_ARG3_TYPE
256 #define PTRACE_ARG3_TYPE int /* Correct definition for most systems. */
259 extern int call_ptrace (int, int, PTRACE_ARG3_TYPE
, int);
261 extern void pre_fork_inferior (void);
265 extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR
));
267 extern ptid_t
procfs_first_available (void);
269 /* From fork-child.c */
271 extern void fork_inferior (char *, char *, char **,
273 void (*)(int), void (*)(void), char *);
276 extern void startup_inferior (int);
278 extern char *construct_inferior_arguments (struct gdbarch
*, int, char **);
282 extern void new_tty_prefork (char *);
284 extern int gdb_has_a_terminal (void);
288 extern void start_remote (void);
290 extern void normal_stop (void);
292 extern int signal_stop_state (int);
294 extern int signal_print_state (int);
296 extern int signal_pass_state (int);
298 extern int signal_stop_update (int, int);
300 extern int signal_print_update (int, int);
302 extern int signal_pass_update (int, int);
304 extern void get_last_target_status(ptid_t
*ptid
,
305 struct target_waitstatus
*status
);
307 extern void follow_inferior_reset_breakpoints (void);
311 extern void tty_command (char *, int);
313 extern void attach_command (char *, int);
315 extern char *get_inferior_args (void);
317 extern char *set_inferior_args (char *);
319 extern void set_inferior_args_vector (int, char **);
321 extern void registers_info (char *, int);
323 extern void nexti_command (char *, int);
325 extern void stepi_command (char *, int);
327 extern void continue_command (char *, int);
329 extern void interrupt_target_command (char *args
, int from_tty
);
331 /* Last signal that the inferior received (why it stopped). */
333 extern enum target_signal stop_signal
;
335 /* Address at which inferior stopped. */
337 extern CORE_ADDR stop_pc
;
339 /* Chain containing status of breakpoint(s) that we have stopped at. */
341 extern bpstat stop_bpstat
;
343 /* Flag indicating that a command has proceeded the inferior past the
344 current breakpoint. */
346 extern int breakpoint_proceeded
;
348 /* Nonzero if stopped due to a step command. */
350 extern int stop_step
;
352 /* Nonzero if stopped due to completion of a stack dummy routine. */
354 extern int stop_stack_dummy
;
356 /* Nonzero if program stopped due to a random (unexpected) signal in
359 extern int stopped_by_random_signal
;
361 /* Range to single step within.
362 If this is nonzero, respond to a single-step signal
363 by continuing to step if the pc is in this range.
365 If step_range_start and step_range_end are both 1, it means to step for
366 a single instruction (FIXME: it might clean up wait_for_inferior in a
367 minor way if this were changed to the address of the instruction and
368 that address plus one. But maybe not.). */
370 extern CORE_ADDR step_range_start
; /* Inclusive */
371 extern CORE_ADDR step_range_end
; /* Exclusive */
373 /* Stack frame address as of when stepping command was issued.
374 This is how we know when we step into a subroutine call,
375 and how to set the frame for the breakpoint used to step out. */
377 extern struct frame_id step_frame_id
;
379 /* Our notion of the current stack pointer. */
381 extern CORE_ADDR step_sp
;
383 /* 1 means step over all subroutine calls.
384 -1 means step over calls to undebuggable functions. */
386 enum step_over_calls_kind
390 STEP_OVER_UNDEBUGGABLE
393 extern enum step_over_calls_kind step_over_calls
;
395 /* If stepping, nonzero means step count is > 1
396 so don't print frame next time inferior stops
397 if it stops due to stepping. */
399 extern int step_multi
;
401 /* Nonzero means expecting a trap and caller will handle it themselves.
402 It is used after attach, due to attaching to a process;
403 when running in the shell before the child program has been exec'd;
404 and when running some kinds of remote stuff (FIXME?). */
406 extern int stop_soon_quietly
;
408 /* Nonzero if proceed is being used for a "finish" command or a similar
409 situation when stop_registers should be saved. */
411 extern int proceed_to_finish
;
413 /* Save register contents here when about to pop a stack dummy frame,
414 if-and-only-if proceed_to_finish is set.
415 Thus this contains the return value from the called function (assuming
416 values are returned in a register). */
418 extern struct regcache
*stop_registers
;
420 /* Nonzero if the child process in inferior_ptid was attached rather
423 extern int attach_flag
;
425 /* Possible values for CALL_DUMMY_LOCATION. */
427 #define BEFORE_TEXT_END 2
428 #define AFTER_TEXT_END 3
429 #define AT_ENTRY_POINT 4
431 #if !defined (CALL_DUMMY_ADDRESS)
432 #define CALL_DUMMY_ADDRESS() (internal_error (__FILE__, __LINE__, "CALL_DUMMY_ADDRESS"), 0)
434 #if !defined (CALL_DUMMY_START_OFFSET)
435 #define CALL_DUMMY_START_OFFSET (internal_error (__FILE__, __LINE__, "CALL_DUMMY_START_OFFSET"), 0)
437 #if !defined (CALL_DUMMY_BREAKPOINT_OFFSET)
438 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (0)
439 #define CALL_DUMMY_BREAKPOINT_OFFSET (internal_error (__FILE__, __LINE__, "CALL_DUMMY_BREAKPOINT_OFFSET"), 0)
441 #if !defined CALL_DUMMY_BREAKPOINT_OFFSET_P
442 #define CALL_DUMMY_BREAKPOINT_OFFSET_P (1)
444 #if !defined (CALL_DUMMY_LENGTH)
445 #define CALL_DUMMY_LENGTH (internal_error (__FILE__, __LINE__, "CALL_DUMMY_LENGTH"), 0)
448 #if defined (CALL_DUMMY_STACK_ADJUST)
449 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
450 #define CALL_DUMMY_STACK_ADJUST_P (1)
453 #if !defined (CALL_DUMMY_STACK_ADJUST)
454 #define CALL_DUMMY_STACK_ADJUST (internal_error (__FILE__, __LINE__, "CALL_DUMMY_STACK_ADJUST"), 0)
456 #if !defined (CALL_DUMMY_STACK_ADJUST_P)
457 #define CALL_DUMMY_STACK_ADJUST_P (0)
460 /* FIXME: cagney/2000-04-17: gdbarch should manage this. The default
461 shouldn't be necessary. */
463 #if !defined (CALL_DUMMY_P)
464 #if defined (CALL_DUMMY)
465 #define CALL_DUMMY_P 1
467 #define CALL_DUMMY_P 0
471 #if !defined PUSH_DUMMY_FRAME
472 #define PUSH_DUMMY_FRAME (internal_error (__FILE__, __LINE__, "PUSH_DUMMY_FRAME"), 0)
475 #if !defined FIX_CALL_DUMMY
476 #define FIX_CALL_DUMMY(a1,a2,a3,a4,a5,a6,a7) (internal_error (__FILE__, __LINE__, "FIX_CALL_DUMMY"), 0)
479 #if !defined STORE_STRUCT_RETURN
480 #define STORE_STRUCT_RETURN(a1,a2) (internal_error (__FILE__, __LINE__, "STORE_STRUCT_RETURN"), 0)
484 /* Are we in a call dummy? */
486 /* NOTE: cagney/2002-11-24: Targets need to both switch to generic
487 dummy frames, and use generic_pc_in_call_dummy(). The generic
488 version should be able to handle all cases since that code works by
489 saving the address of the dummy's breakpoint (where ever it is). */
491 extern int deprecated_pc_in_call_dummy_before_text_end (CORE_ADDR pc
,
493 CORE_ADDR frame_address
);
495 /* NOTE: cagney/2002-11-24: Targets need to both switch to generic
496 dummy frames, and use generic_pc_in_call_dummy(). The generic
497 version should be able to handle all cases since that code works by
498 saving the address of the dummy's breakpoint (where ever it is). */
500 extern int deprecated_pc_in_call_dummy_after_text_end (CORE_ADDR pc
,
502 CORE_ADDR frame_address
);
504 /* NOTE: cagney/2002-11-24: Targets need to both switch to generic
505 dummy frames, and use generic_pc_in_call_dummy(). The generic
506 version should be able to handle all cases since that code works by
507 saving the address of the dummy's breakpoint (where ever it is). */
509 extern int deprecated_pc_in_call_dummy_on_stack (CORE_ADDR pc
,
511 CORE_ADDR frame_address
);
513 /* NOTE: cagney/2002-11-24: Targets need to both switch to generic
514 dummy frames, and use generic_pc_in_call_dummy(). The generic
515 version should be able to handle all cases since that code works by
516 saving the address of the dummy's breakpoint (where ever it is). */
518 extern int deprecated_pc_in_call_dummy_at_entry_point (CORE_ADDR pc
,
520 CORE_ADDR frame_address
);
522 /* It's often not enough for our clients to know whether the PC is merely
523 somewhere within the call dummy. They may need to know whether the
524 call dummy has actually completed. (For example, wait_for_inferior
525 wants to know when it should truly stop because the call dummy has
526 completed. If we're single-stepping because of slow watchpoints,
527 then we may find ourselves stopped at the entry of the call dummy,
528 and want to continue stepping until we reach the end.)
530 Note that this macro is intended for targets (like HP-UX) which
531 require more than a single breakpoint in their call dummies, and
532 therefore cannot use the CALL_DUMMY_BREAKPOINT_OFFSET mechanism.
534 If a target does define CALL_DUMMY_BREAKPOINT_OFFSET, then this
535 default implementation of CALL_DUMMY_HAS_COMPLETED is sufficient.
536 Else, a target may wish to supply an implementation that works in
537 the presense of multiple breakpoints in its call dummy.
539 #if !defined(CALL_DUMMY_HAS_COMPLETED)
540 #define CALL_DUMMY_HAS_COMPLETED(pc, sp, frame_address) \
541 DEPRECATED_PC_IN_CALL_DUMMY((pc), (sp), (frame_address))
544 /* If STARTUP_WITH_SHELL is set, GDB's "run"
545 will attempts to start up the debugee under a shell.
546 This is in order for argument-expansion to occur. E.g.,
548 The "*" gets expanded by the shell into a list of files.
549 While this is a nice feature, it turns out to interact badly
550 with some of the catch-fork/catch-exec features we have added.
551 In particular, if the shell does any fork/exec's before
552 the exec of the target program, that can confuse GDB.
553 To disable this feature, set STARTUP_WITH_SHELL to 0.
554 To enable this feature, set STARTUP_WITH_SHELL to 1.
555 The catch-exec traps expected during start-up will
556 be 1 if target is not started up with a shell, 2 if it is.
558 If you disable this, you need to decrement
559 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
560 #define STARTUP_WITH_SHELL 1
561 #if !defined(START_INFERIOR_TRAPS_EXPECTED)
562 #define START_INFERIOR_TRAPS_EXPECTED 2
564 #endif /* !defined (INFERIOR_H) */