[binutils.git] / gdb / inferior.h

/* Variables that describe the inferior process running under GDB:
   Where it is, why it stopped, and how to step it.
   Copyright 1986, 1989, 1992 Free Software Foundation, Inc.

This file is part of GDB.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */

#if !defined (INFERIOR_H)
#define INFERIOR_H 1

/* For symtab_and_line */
#include "symtab.h"

/* For bpstat.  */
#include "breakpoint.h"

/* For FRAME_ADDR.  */
#include "frame.h"

/*
 * Structure in which to save the status of the inferior.  Save
 * through "save_inferior_status", restore through
 * "restore_inferior_status".
 * This pair of routines should be called around any transfer of
 * control to the inferior which you don't want showing up in your
 * control variables.
 */
struct inferior_status {
  int pc_changed;
  int stop_signal;
  int stop_pc;
  FRAME_ADDR stop_frame_address;
  bpstat stop_bpstat;
  int stop_step;
  int stop_stack_dummy;
  int stopped_by_random_signal;
  int trap_expected;
  CORE_ADDR step_range_start;
  CORE_ADDR step_range_end;
  FRAME_ADDR step_frame_address;
  int step_over_calls;
  CORE_ADDR step_resume_break_address;
  int stop_after_trap;
  int stop_soon_quietly;
  FRAME_ADDR selected_frame_address;
  int selected_level;
  char stop_registers[REGISTER_BYTES];
  int breakpoint_proceeded;
  int restore_stack_info;
  int proceed_to_finish;
};

extern void
save_inferior_status PARAMS ((struct inferior_status *, int));

extern void
restore_inferior_status PARAMS ((struct inferior_status *));

/* File name for default use for standard in/out in the inferior.  */

extern char *inferior_io_terminal;

/* Pid of our debugged inferior, or 0 if no inferior now.  */

extern int inferior_pid;

/* Character array containing an image of the inferior programs' registers.  */

extern char registers[];

/* Array of validity bits (one per register).  Nonzero at position XXX_REGNUM
   means that `registers' contains a valid copy of inferior register XXX.  */

extern char register_valid[NUM_REGS];

extern void
clear_proceed_status PARAMS ((void));

extern void
proceed PARAMS ((CORE_ADDR, int, int));

extern void
kill_inferior PARAMS ((void));

extern void
generic_mourn_inferior PARAMS ((void));

extern void
terminal_ours PARAMS ((void));

extern void
run_stack_dummy PARAMS ((CORE_ADDR, char [REGISTER_BYTES]));

extern CORE_ADDR
read_pc PARAMS ((void));

extern void
write_pc PARAMS ((CORE_ADDR));

extern void
wait_for_inferior PARAMS ((void));

extern void
init_wait_for_inferior PARAMS ((void));

extern void
close_exec_file PARAMS ((void));

extern void
reopen_exec_file PARAMS ((void));

/* The `resume' routine should only be called in special circumstances.
   Normally, use `proceed', which handles a lot of bookkeeping.  */
extern void
resume PARAMS ((int, int));

/* From misc files */

extern void
store_inferior_registers PARAMS ((int));

extern void
fetch_inferior_registers PARAMS ((int));

extern void 
solib_create_inferior_hook PARAMS ((void));

extern void
child_terminal_info PARAMS ((char *, int));

extern void
term_info PARAMS ((char *, int));

extern void
terminal_ours_for_output PARAMS ((void));

extern void
terminal_inferior PARAMS ((void));

extern void
terminal_init_inferior PARAMS ((void));

/* From infptrace.c */

extern int
attach PARAMS ((int));

void
detach PARAMS ((int));

extern void
child_resume PARAMS ((int, int));

#ifndef PTRACE_ARG3_TYPE
#define PTRACE_ARG3_TYPE int	/* Correct definition for most systems. */
#endif

extern int
call_ptrace PARAMS ((int, int, PTRACE_ARG3_TYPE, int));

/* From procfs.c */

extern int
proc_iterate_over_mappings PARAMS ((int (*) (int, CORE_ADDR)));

extern void
proc_signal_handling_change PARAMS ((void));

/* From fork-child.c */

extern void
fork_inferior PARAMS ((char *, char *, char **,
		       void (*) (void),
		       void (*) (int)));

/* From inflow.c */

extern void
new_tty_prefork PARAMS ((char *));

/* From infrun.c */

extern void
start_remote PARAMS ((void));

extern void
normal_stop PARAMS ((void));

extern int
signal_stop_state PARAMS ((int));

extern int
signal_print_state PARAMS ((int));

extern int
signal_pass_state PARAMS ((int));

/* From infcmd.c */

extern void
tty_command PARAMS ((char *, int));

extern void
attach_command PARAMS ((char *, int));

/* Last signal that the inferior received (why it stopped).  */

extern int stop_signal;

/* Address at which inferior stopped.  */

extern CORE_ADDR stop_pc;

/* Stack frame when program stopped.  */

extern FRAME_ADDR stop_frame_address;

/* Chain containing status of breakpoint(s) that we have stopped at.  */

extern bpstat stop_bpstat;

/* Flag indicating that a command has proceeded the inferior past the
   current breakpoint.  */

extern int breakpoint_proceeded;

/* Nonzero if stopped due to a step command.  */

extern int stop_step;

/* Nonzero if stopped due to completion of a stack dummy routine.  */

extern int stop_stack_dummy;

/* Nonzero if program stopped due to a random (unexpected) signal in
   inferior process.  */

extern int stopped_by_random_signal;

/* Range to single step within.
   If this is nonzero, respond to a single-step signal
   by continuing to step if the pc is in this range.  */

extern CORE_ADDR step_range_start; /* Inclusive */
extern CORE_ADDR step_range_end; /* Exclusive */

/* Stack frame address as of when stepping command was issued.
   This is how we know when we step into a subroutine call,
   and how to set the frame for the breakpoint used to step out.  */

extern FRAME_ADDR step_frame_address;

/* 1 means step over all subroutine calls.
   -1 means step over calls to undebuggable functions.  */

extern int step_over_calls;

/* If stepping, nonzero means step count is > 1
   so don't print frame next time inferior stops
   if it stops due to stepping.  */

extern int step_multi;

/* Nonzero means expecting a trap and caller will handle it themselves.
   It is used after attach, due to attaching to a process;
   when running in the shell before the child program has been exec'd;
   and when running some kinds of remote stuff (FIXME?).  */

extern int stop_soon_quietly;

/* Nonzero if proceed is being used for a "finish" command or a similar
   situation when stop_registers should be saved.  */

extern int proceed_to_finish;

/* Save register contents here when about to pop a stack dummy frame,
   if-and-only-if proceed_to_finish is set.
   Thus this contains the return value from the called function (assuming
   values are returned in a register).  */

extern char stop_registers[REGISTER_BYTES];

/* Nonzero if pc has been changed by the debugger
   since the inferior stopped.  */

extern int pc_changed;

/* Nonzero if the child process in inferior_pid was attached rather
   than forked.  */

extern int attach_flag;
\f
/* Possible values for CALL_DUMMY_LOCATION.  */
#define ON_STACK 1
#define BEFORE_TEXT_END 2
#define AFTER_TEXT_END 3

#if !defined (CALL_DUMMY_LOCATION)
#define CALL_DUMMY_LOCATION ON_STACK
#endif /* No CALL_DUMMY_LOCATION.  */

/* Are we in a call dummy?  The code below which allows DECR_PC_AFTER_BREAK
   below is for infrun.c, which may give the macro a pc without that
   subtracted out.  */
#if !defined (PC_IN_CALL_DUMMY)
#if CALL_DUMMY_LOCATION == BEFORE_TEXT_END
extern CORE_ADDR text_end;
#define PC_IN_CALL_DUMMY(pc, sp, frame_address) \
  ((pc) >= text_end - CALL_DUMMY_LENGTH         \
   && (pc) <= text_end + DECR_PC_AFTER_BREAK)
#else /* Not before text_end.  */
#if CALL_DUMMY_LOCATION == AFTER_TEXT_END
extern CORE_ADDR text_end;
#define PC_IN_CALL_DUMMY(pc, sp, frame_address) \
  ((pc) >= text_end   \
   && (pc) <= text_end + CALL_DUMMY_LENGTH + DECR_PC_AFTER_BREAK)
#else /* On stack.  */
#define PC_IN_CALL_DUMMY(pc, sp, frame_address) \
  ((sp) INNER_THAN (pc) && (pc) INNER_THAN (frame_address))
#endif /* On stack.  */
#endif /* Not before text_end.  */
#endif /* No PC_IN_CALL_DUMMY.  */

#endif	/* !defined (INFERIOR_H) */
Commit	Line	Data
bd5635a1 RP	1	/* Variables that describe the inferior process running under GDB:
bd5635a1 RP	2	Where it is, why it stopped, and how to step it.
cc221e76	3	Copyright 1986, 1989, 1992 Free Software Foundation, Inc.
bd5635a1 RP	4
	5	This file is part of GDB.
	6
bdbd5f50	7	This program is free software; you can redistribute it and/or modify
bd5635a1	8	it under the terms of the GNU General Public License as published by
bdbd5f50 JG	9	the Free Software Foundation; either version 2 of the License, or
bdbd5f50 JG	10	(at your option) any later version.
bd5635a1	11
bdbd5f50	12	This program is distributed in the hope that it will be useful,
bd5635a1 RP	13	but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	GNU General Public License for more details.
	16
	17	You should have received a copy of the GNU General Public License
bdbd5f50 JG	18	along with this program; if not, write to the Free Software
bdbd5f50 JG	19	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
bd5635a1	20
cc221e76 FF	21	#if !defined (INFERIOR_H)
	22	#define INFERIOR_H 1
	23
	24	/* For symtab_and_line */
	25	#include "symtab.h"
	26
bd5635a1 RP	27	/* For bpstat. */
	28	#include "breakpoint.h"
	29
	30	/* For FRAME_ADDR. */
	31	#include "frame.h"
	32
	33	/*
	34	* Structure in which to save the status of the inferior. Save
	35	* through "save_inferior_status", restore through
	36	* "restore_inferior_status".
	37	* This pair of routines should be called around any transfer of
	38	* control to the inferior which you don't want showing up in your
	39	* control variables.
	40	*/
	41	struct inferior_status {
	42	int pc_changed;
	43	int stop_signal;
	44	int stop_pc;
	45	FRAME_ADDR stop_frame_address;
	46	bpstat stop_bpstat;
	47	int stop_step;
	48	int stop_stack_dummy;
	49	int stopped_by_random_signal;
	50	int trap_expected;
	51	CORE_ADDR step_range_start;
	52	CORE_ADDR step_range_end;
	53	FRAME_ADDR step_frame_address;
	54	int step_over_calls;
	55	CORE_ADDR step_resume_break_address;
	56	int stop_after_trap;
	57	int stop_soon_quietly;
	58	FRAME_ADDR selected_frame_address;
	59	int selected_level;
	60	char stop_registers[REGISTER_BYTES];
	61	int breakpoint_proceeded;
	62	int restore_stack_info;
	63	int proceed_to_finish;
	64	};
	65
cc221e76 FF	66	extern void
	67	save_inferior_status PARAMS ((struct inferior_status *, int));
	68
	69	extern void
	70	restore_inferior_status PARAMS ((struct inferior_status *));
bd5635a1 RP	71
	72	/* File name for default use for standard in/out in the inferior. */
	73
	74	extern char *inferior_io_terminal;
	75
	76	/* Pid of our debugged inferior, or 0 if no inferior now. */
	77
	78	extern int inferior_pid;
	79
	80	/* Character array containing an image of the inferior programs' registers. */
	81
	82	extern char registers[];
	83
310cc570 RP	84	/* Array of validity bits (one per register). Nonzero at position XXX_REGNUM
	85	means that `registers' contains a valid copy of inferior register XXX. */
	86
	87	extern char register_valid[NUM_REGS];
	88
cc221e76 FF	89	extern void
	90	clear_proceed_status PARAMS ((void));
	91
	92	extern void
	93	proceed PARAMS ((CORE_ADDR, int, int));
	94
	95	extern void
	96	kill_inferior PARAMS ((void));
	97
cc221e76 FF	98	extern void
	99	generic_mourn_inferior PARAMS ((void));
	100
	101	extern void
	102	terminal_ours PARAMS ((void));
	103
	104	extern void
	105	run_stack_dummy PARAMS ((CORE_ADDR, char [REGISTER_BYTES]));
	106
	107	extern CORE_ADDR
	108	read_pc PARAMS ((void));
	109
	110	extern void
	111	write_pc PARAMS ((CORE_ADDR));
	112
	113	extern void
	114	wait_for_inferior PARAMS ((void));
	115
	116	extern void
	117	init_wait_for_inferior PARAMS ((void));
	118
	119	extern void
	120	close_exec_file PARAMS ((void));
	121
	122	extern void
	123	reopen_exec_file PARAMS ((void));
	124
3aa6856a JG	125	/* The `resume' routine should only be called in special circumstances.
3aa6856a JG	126	Normally, use `proceed', which handles a lot of bookkeeping. */
310cc570 RP	127	extern void
	128	resume PARAMS ((int, int));
	129
cc221e76 FF	130	/* From misc files */
	131
	132	extern void
	133	store_inferior_registers PARAMS ((int));
	134
	135	extern void
	136	fetch_inferior_registers PARAMS ((int));
	137
	138	extern void
	139	solib_create_inferior_hook PARAMS ((void));
	140
cc221e76 FF	141	extern void
	142	child_terminal_info PARAMS ((char *, int));
	143
	144	extern void
	145	term_info PARAMS ((char *, int));
	146
	147	extern void
	148	terminal_ours_for_output PARAMS ((void));
	149
	150	extern void
	151	terminal_inferior PARAMS ((void));
	152
	153	extern void
	154	terminal_init_inferior PARAMS ((void));
	155
34517ebc	156	/* From infptrace.c */
cc221e76 FF	157
	158	extern int
	159	attach PARAMS ((int));
	160
	161	void
	162	detach PARAMS ((int));
	163
	164	extern void
	165	child_resume PARAMS ((int, int));
	166
310cc570 RP	167	#ifndef PTRACE_ARG3_TYPE
	168	#define PTRACE_ARG3_TYPE int /* Correct definition for most systems. */
	169	#endif
	170
	171	extern int
	172	call_ptrace PARAMS ((int, int, PTRACE_ARG3_TYPE, int));
	173
cc221e76 FF	174	/* From procfs.c */
cc221e76 FF	175
cc221e76 FF	176	extern int
	177	proc_iterate_over_mappings PARAMS ((int (*) (int, CORE_ADDR)));
	178
cc221e76 FF	179	extern void
	180	proc_signal_handling_change PARAMS ((void));
	181
34517ebc	182	/* From fork-child.c */
bd5635a1	183
34517ebc JG	184	extern void
	185	fork_inferior PARAMS ((char , char , char **,
	186	void (*) (void),
	187	void (*) (int)));
cc221e76 FF	188
	189	/* From inflow.c */
	190
	191	extern void
	192	new_tty_prefork PARAMS ((char *));
	193
	194	/* From infrun.c */
	195
	196	extern void
	197	start_remote PARAMS ((void));
	198
cc221e76 FF	199	extern void
	200	normal_stop PARAMS ((void));
	201
	202	extern int
	203	signal_stop_state PARAMS ((int));
	204
	205	extern int
	206	signal_print_state PARAMS ((int));
	207
	208	extern int
	209	signal_pass_state PARAMS ((int));
	210
	211	/* From infcmd.c */
	212
	213	extern void
	214	tty_command PARAMS ((char *, int));
	215
	216	extern void
	217	attach_command PARAMS ((char *, int));
	218
bd5635a1 RP	219	/* Last signal that the inferior received (why it stopped). */
	220
	221	extern int stop_signal;
	222
	223	/* Address at which inferior stopped. */
	224
	225	extern CORE_ADDR stop_pc;
	226
	227	/* Stack frame when program stopped. */
	228
	229	extern FRAME_ADDR stop_frame_address;
	230
	231	/* Chain containing status of breakpoint(s) that we have stopped at. */
	232
	233	extern bpstat stop_bpstat;
	234
	235	/* Flag indicating that a command has proceeded the inferior past the
	236	current breakpoint. */
	237
	238	extern int breakpoint_proceeded;
	239
	240	/* Nonzero if stopped due to a step command. */
	241
	242	extern int stop_step;
	243
	244	/* Nonzero if stopped due to completion of a stack dummy routine. */
	245
	246	extern int stop_stack_dummy;
	247
	248	/* Nonzero if program stopped due to a random (unexpected) signal in
	249	inferior process. */
	250
	251	extern int stopped_by_random_signal;
	252
	253	/* Range to single step within.
	254	If this is nonzero, respond to a single-step signal
	255	by continuing to step if the pc is in this range. */
	256
	257	extern CORE_ADDR step_range_start; /* Inclusive */
	258	extern CORE_ADDR step_range_end; /* Exclusive */
	259
	260	/* Stack frame address as of when stepping command was issued.
	261	This is how we know when we step into a subroutine call,
	262	and how to set the frame for the breakpoint used to step out. */
	263
	264	extern FRAME_ADDR step_frame_address;
	265
	266	/* 1 means step over all subroutine calls.
	267	-1 means step over calls to undebuggable functions. */
	268
	269	extern int step_over_calls;
	270
	271	/* If stepping, nonzero means step count is > 1
	272	so don't print frame next time inferior stops
	273	if it stops due to stepping. */
	274
	275	extern int step_multi;
	276
bdbd5f50 JG	277	/* Nonzero means expecting a trap and caller will handle it themselves.
	278	It is used after attach, due to attaching to a process;
	279	when running in the shell before the child program has been exec'd;
	280	and when running some kinds of remote stuff (FIXME?). */
	281
cc221e76	282	extern int stop_soon_quietly;
bdbd5f50	283
bd5635a1 RP	284	/* Nonzero if proceed is being used for a "finish" command or a similar
	285	situation when stop_registers should be saved. */
	286
	287	extern int proceed_to_finish;
	288
	289	/* Save register contents here when about to pop a stack dummy frame,
	290	if-and-only-if proceed_to_finish is set.
	291	Thus this contains the return value from the called function (assuming
	292	values are returned in a register). */
	293
	294	extern char stop_registers[REGISTER_BYTES];
	295
	296	/* Nonzero if pc has been changed by the debugger
	297	since the inferior stopped. */
	298
	299	extern int pc_changed;
	300
	301	/* Nonzero if the child process in inferior_pid was attached rather
	302	than forked. */
	303
cc221e76	304	extern int attach_flag;
bd5635a1 RP	305	\f
	306	/* Possible values for CALL_DUMMY_LOCATION. */
	307	#define ON_STACK 1
	308	#define BEFORE_TEXT_END 2
	309	#define AFTER_TEXT_END 3
	310
	311	#if !defined (CALL_DUMMY_LOCATION)
bd5635a1	312	#define CALL_DUMMY_LOCATION ON_STACK
bd5635a1 RP	313	#endif /* No CALL_DUMMY_LOCATION. */
	314
	315	/* Are we in a call dummy? The code below which allows DECR_PC_AFTER_BREAK
	316	below is for infrun.c, which may give the macro a pc without that
	317	subtracted out. */
	318	#if !defined (PC_IN_CALL_DUMMY)
	319	#if CALL_DUMMY_LOCATION == BEFORE_TEXT_END
cc221e76	320	extern CORE_ADDR text_end;
bd5635a1 RP	321	#define PC_IN_CALL_DUMMY(pc, sp, frame_address) \
bd5635a1 RP	322	((pc) >= text_end - CALL_DUMMY_LENGTH \
34517ebc	323	&& (pc) <= text_end + DECR_PC_AFTER_BREAK)
bd5635a1 RP	324	#else /* Not before text_end. */
bd5635a1 RP	325	#if CALL_DUMMY_LOCATION == AFTER_TEXT_END
cc221e76	326	extern CORE_ADDR text_end;
bd5635a1 RP	327	#define PC_IN_CALL_DUMMY(pc, sp, frame_address) \
bd5635a1 RP	328	((pc) >= text_end \
34517ebc	329	&& (pc) <= text_end + CALL_DUMMY_LENGTH + DECR_PC_AFTER_BREAK)
bd5635a1 RP	330	#else /* On stack. */
	331	#define PC_IN_CALL_DUMMY(pc, sp, frame_address) \
	332	((sp) INNER_THAN (pc) && (pc) INNER_THAN (frame_address))
	333	#endif /* On stack. */
	334	#endif /* Not before text_end. */
	335	#endif /* No PC_IN_CALL_DUMMY. */
cc221e76 FF	336
cc221e76 FF	337	#endif /* !defined (INFERIOR_H) */