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

/* Frame unwinder for frames with DWARF Call Frame Information.

   Copyright (C) 2003, 2004, 2005, 2007 Free Software Foundation, Inc.

   Contributed by Mark Kettenis.

   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 3 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, see <http://www.gnu.org/licenses/>.  */

#ifndef DWARF2_FRAME_H
#define DWARF2_FRAME_H 1

struct gdbarch;
struct objfile;
struct frame_info;

/* Register rule.  */

enum dwarf2_frame_reg_rule
{
  /* Make certain that 0 maps onto the correct enum value; the
     corresponding structure is being initialized using memset zero.
     This indicates that CFI didn't provide any information at all
     about a register, leaving how to obtain its value totally
     unspecified.  */
  DWARF2_FRAME_REG_UNSPECIFIED = 0,

  /* The term "undefined" comes from the DWARF2 CFI spec which this
     code is moddeling; it indicates that the register's value is
     "undefined".  GCC uses the less formal term "unsaved".  Its
     definition is a combination of REG_UNDEFINED and REG_UNSPECIFIED.
     The failure to differentiate the two helps explain a few problems
     with the CFI generated by GCC.  */
  DWARF2_FRAME_REG_UNDEFINED,
  DWARF2_FRAME_REG_SAVED_OFFSET,
  DWARF2_FRAME_REG_SAVED_REG,
  DWARF2_FRAME_REG_SAVED_EXP,
  DWARF2_FRAME_REG_SAME_VALUE,

  /* These are defined in Dwarf3.  */
  DWARF2_FRAME_REG_SAVED_VAL_OFFSET,
  DWARF2_FRAME_REG_SAVED_VAL_EXP,

  /* These aren't defined by the DWARF2 CFI specification, but are
     used internally by GDB.  */
  DWARF2_FRAME_REG_RA,		/* Return Address.  */
  DWARF2_FRAME_REG_RA_OFFSET,	/* Return Address with offset.  */
  DWARF2_FRAME_REG_CFA,		/* Call Frame Address.  */
  DWARF2_FRAME_REG_CFA_OFFSET	/* Call Frame Address with offset.  */
};

/* Register state.  */

struct dwarf2_frame_state_reg
{
  /* Each register save state can be described in terms of a CFA slot,
     another register, or a location expression.  */
  union {
    LONGEST offset;
    ULONGEST reg;
    unsigned char *exp;
  } loc;
  ULONGEST exp_len;
  enum dwarf2_frame_reg_rule how;
};

/* Set the architecture-specific register state initialization
   function for GDBARCH to INIT_REG.  */

extern void dwarf2_frame_set_init_reg (struct gdbarch *gdbarch,
				       void (*init_reg) (struct gdbarch *, int,
					     struct dwarf2_frame_state_reg *,
					     struct frame_info *));

/* Set the architecture-specific signal trampoline recognition
   function for GDBARCH to SIGNAL_FRAME_P.  */

extern void
  dwarf2_frame_set_signal_frame_p (struct gdbarch *gdbarch,
				   int (*signal_frame_p) (struct gdbarch *,
							  struct frame_info *));

/* Set the architecture-specific adjustment of .eh_frame and .debug_frame
   register numbers.  */

extern void
  dwarf2_frame_set_adjust_regnum (struct gdbarch *gdbarch,
				  int (*adjust_regnum) (struct gdbarch *,
							int, int));

/* Return the frame unwind methods for the function that contains PC,
   or NULL if it can't be handled by DWARF CFI frame unwinder.  */

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

/* Return the frame base methods for the function that contains PC, or
   NULL if it can't be handled by the DWARF CFI frame unwinder.  */

extern const struct frame_base *
  dwarf2_frame_base_sniffer (struct frame_info *next_frame);

/* Register the DWARF CFI for OBJFILE.  */

void dwarf2_frame_build_info (struct objfile *objfile);

#endif /* dwarf2-frame.h */
Commit	Line	Data
	1	/* Frame unwinder for frames with DWARF Call Frame Information.
	2
	3	Copyright (C) 2003, 2004, 2005, 2007 Free Software Foundation, Inc.
	4
	5	Contributed by Mark Kettenis.
	6
	7	This file is part of GDB.
	8
	9	This program is free software; you can redistribute it and/or modify
	10	it under the terms of the GNU General Public License as published by
	11	the Free Software Foundation; either version 3 of the License, or
	12	(at your option) any later version.
	13
	14	This program is distributed in the hope that it will be useful,
	15	but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	GNU General Public License for more details.
	18
	19	You should have received a copy of the GNU General Public License
	20	along with this program. If not, see <http://www.gnu.org/licenses/>. */
	21
	22	#ifndef DWARF2_FRAME_H
	23	#define DWARF2_FRAME_H 1
	24
	25	struct gdbarch;
	26	struct objfile;
	27	struct frame_info;
	28
	29	/* Register rule. */
	30
	31	enum dwarf2_frame_reg_rule
	32	{
	33	/* Make certain that 0 maps onto the correct enum value; the
	34	corresponding structure is being initialized using memset zero.
	35	This indicates that CFI didn't provide any information at all
	36	about a register, leaving how to obtain its value totally
	37	unspecified. */
	38	DWARF2_FRAME_REG_UNSPECIFIED = 0,
	39
	40	/* The term "undefined" comes from the DWARF2 CFI spec which this
	41	code is moddeling; it indicates that the register's value is
	42	"undefined". GCC uses the less formal term "unsaved". Its
	43	definition is a combination of REG_UNDEFINED and REG_UNSPECIFIED.
	44	The failure to differentiate the two helps explain a few problems
	45	with the CFI generated by GCC. */
	46	DWARF2_FRAME_REG_UNDEFINED,
	47	DWARF2_FRAME_REG_SAVED_OFFSET,
	48	DWARF2_FRAME_REG_SAVED_REG,
	49	DWARF2_FRAME_REG_SAVED_EXP,
	50	DWARF2_FRAME_REG_SAME_VALUE,
	51
	52	/* These are defined in Dwarf3. */
	53	DWARF2_FRAME_REG_SAVED_VAL_OFFSET,
	54	DWARF2_FRAME_REG_SAVED_VAL_EXP,
	55
	56	/* These aren't defined by the DWARF2 CFI specification, but are
	57	used internally by GDB. */
	58	DWARF2_FRAME_REG_RA, /* Return Address. */
	59	DWARF2_FRAME_REG_RA_OFFSET, /* Return Address with offset. */
	60	DWARF2_FRAME_REG_CFA, /* Call Frame Address. */
	61	DWARF2_FRAME_REG_CFA_OFFSET /* Call Frame Address with offset. */
	62	};
	63
	64	/* Register state. */
	65
	66	struct dwarf2_frame_state_reg
	67	{
	68	/* Each register save state can be described in terms of a CFA slot,
	69	another register, or a location expression. */
	70	union {
	71	LONGEST offset;
	72	ULONGEST reg;
	73	unsigned char *exp;
	74	} loc;
	75	ULONGEST exp_len;
	76	enum dwarf2_frame_reg_rule how;
	77	};
	78
	79	/* Set the architecture-specific register state initialization
	80	function for GDBARCH to INIT_REG. */
	81
	82	extern void dwarf2_frame_set_init_reg (struct gdbarch *gdbarch,
	83	void (init_reg) (struct gdbarch , int,
	84	struct dwarf2_frame_state_reg *,
	85	struct frame_info *));
	86
	87	/* Set the architecture-specific signal trampoline recognition
	88	function for GDBARCH to SIGNAL_FRAME_P. */
	89
	90	extern void
	91	dwarf2_frame_set_signal_frame_p (struct gdbarch *gdbarch,
	92	int (signal_frame_p) (struct gdbarch ,
	93	struct frame_info *));
	94
	95	/* Set the architecture-specific adjustment of .eh_frame and .debug_frame
	96	register numbers. */
	97
	98	extern void
	99	dwarf2_frame_set_adjust_regnum (struct gdbarch *gdbarch,
	100	int (adjust_regnum) (struct gdbarch ,
	101	int, int));
	102
	103	/* Return the frame unwind methods for the function that contains PC,
	104	or NULL if it can't be handled by DWARF CFI frame unwinder. */
	105
	106	extern const struct frame_unwind *
	107	dwarf2_frame_sniffer (struct frame_info *next_frame);
	108
	109	/* Return the frame base methods for the function that contains PC, or
	110	NULL if it can't be handled by the DWARF CFI frame unwinder. */
	111
	112	extern const struct frame_base *
	113	dwarf2_frame_base_sniffer (struct frame_info *next_frame);
	114
	115	/* Register the DWARF CFI for OBJFILE. */
	116
	117	void dwarf2_frame_build_info (struct objfile *objfile);
	118
	119	#endif /* dwarf2-frame.h */