[deliverable/binutils-gdb.git] / gdb / dummy-frame.h

/* Code dealing with dummy stack frames, for GDB, the GNU debugger.

   Copyright 2002 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., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.  */

#if !defined (DUMMY_FRAME_H)
#define DUMMY_FRAME_H 1

struct frame_info;
struct regcache;
struct frame_unwind;
struct frame_id;

/* GENERIC DUMMY FRAMES
  
   The following code serves to maintain the dummy stack frames for
   inferior function calls (ie. when gdb calls into the inferior via
   call_function_by_hand).  This code saves the machine state before
   the call in host memory, so we must maintain an independent stack
   and keep it consistant etc.  I am attempting to make this code
   generic enough to be used by many targets.
 
   The cheapest and most generic way to do CALL_DUMMY on a new target
   is probably to define CALL_DUMMY to be empty,
   DEPRECATED_CALL_DUMMY_LENGTH to zero, and CALL_DUMMY_LOCATION to
   AT_ENTRY.  Then you must remember to define PUSH_RETURN_ADDRESS,
   because no call instruction will be being executed by the target.
   Also DEPRECATED_FRAME_CHAIN_VALID as
   generic_{file,func}_frame_chain_valid and do not set
   DEPRECATED_FIX_CALL_DUMMY.  */

/* If the PC falls in a dummy frame, return a dummy frame
   unwinder.  */

extern const struct frame_unwind *dummy_frame_sniffer (struct frame_info *next_frame);

/* Return the regcache that belongs to the dummy-frame identifed by PC
   and FP, or NULL if no such frame exists.  */
/* FIXME: cagney/2002-11-08: The function only exists because of
   deprecated_generic_get_saved_register.  Eliminate that function and
   this, to, can go.  */

extern struct regcache *deprecated_find_dummy_frame_regcache (CORE_ADDR pc,
							      CORE_ADDR fp);
#endif /* !defined (DUMMY_FRAME_H)  */
Commit	Line	Data
9c1412c1 AC	1	/* Code dealing with dummy stack frames, for GDB, the GNU debugger.
	2
	3	Copyright 2002 Free Software Foundation, Inc.
	4
	5	This file is part of GDB.
	6
	7	This program is free software; you can redistribute it and/or modify
	8	it under the terms of the GNU General Public License as published by
	9	the Free Software Foundation; either version 2 of the License, or
	10	(at your option) any later version.
	11
	12	This program is distributed in the hope that it will be useful,
	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
	18	along with this program; if not, write to the Free Software
	19	Foundation, Inc., 59 Temple Place - Suite 330,
	20	Boston, MA 02111-1307, USA. */
	21
	22	#if !defined (DUMMY_FRAME_H)
	23	#define DUMMY_FRAME_H 1
	24
	25	struct frame_info;
	26	struct regcache;
494cca16	27	struct frame_unwind;
c170fb60	28	struct frame_id;
9c1412c1 AC	29
	30	/* GENERIC DUMMY FRAMES
	31
	32	The following code serves to maintain the dummy stack frames for
	33	inferior function calls (ie. when gdb calls into the inferior via
	34	call_function_by_hand). This code saves the machine state before
	35	the call in host memory, so we must maintain an independent stack
	36	and keep it consistant etc. I am attempting to make this code
	37	generic enough to be used by many targets.
	38
	39	The cheapest and most generic way to do CALL_DUMMY on a new target
b1e29e33 AC	40	is probably to define CALL_DUMMY to be empty,
	41	DEPRECATED_CALL_DUMMY_LENGTH to zero, and CALL_DUMMY_LOCATION to
	42	AT_ENTRY. Then you must remember to define PUSH_RETURN_ADDRESS,
	43	because no call instruction will be being executed by the target.
	44	Also DEPRECATED_FRAME_CHAIN_VALID as
e8ab51f7	45	generic_{file,func}_frame_chain_valid and do not set
b1e29e33	46	DEPRECATED_FIX_CALL_DUMMY. */
9c1412c1	47
494cca16 AC	48	/* If the PC falls in a dummy frame, return a dummy frame
494cca16 AC	49	unwinder. */
9c1412c1	50
336d1bba	51	extern const struct frame_unwind dummy_frame_sniffer (struct frame_info next_frame);
c689142b	52
9c1412c1 AC	53	/* Return the regcache that belongs to the dummy-frame identifed by PC
	54	and FP, or NULL if no such frame exists. */
	55	/* FIXME: cagney/2002-11-08: The function only exists because of
	56	deprecated_generic_get_saved_register. Eliminate that function and
	57	this, to, can go. */
	58
cc8c88f3 AC	59	extern struct regcache *deprecated_find_dummy_frame_regcache (CORE_ADDR pc,
cc8c88f3 AC	60	CORE_ADDR fp);
9c1412c1	61	#endif /* !defined (DUMMY_FRAME_H) */