[deliverable/binutils-gdb.git] / gdb / arch-utils.h

/* Dynamic architecture support for GDB, the GNU debugger.

   Copyright 1998, 1999, 2000, 2002, 2003 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.  */

#ifndef GDBARCH_UTILS_H
#define GDBARCH_UTILS_H

struct gdbarch;
struct frame_info;
struct minimal_symbol;
struct type;
struct gdbarch_info;

/* gdbarch trace variable */
extern int gdbarch_debug;

/* Fallback for register convertible. */
extern gdbarch_deprecated_register_convertible_ftype deprecated_register_convertible_not;

/* Implementation of extract return value that grubs around in the
   register cache.  */
extern gdbarch_extract_return_value_ftype legacy_extract_return_value;

/* Implementation of store return value that grubs the register cache.  */
extern gdbarch_store_return_value_ftype legacy_store_return_value;

/* To return any structure or union type by value, store it at the
   address passed as an invisible first argument to the function.  */
extern gdbarch_use_struct_convention_ftype always_use_struct_convention;

/* Frameless functions not identifable. */
extern gdbarch_frameless_function_invocation_ftype generic_frameless_function_invocation_not;

/* Only structures, unions, and arrays are returned using the struct
   convention.  Note that arrays are never passed by value in the C
   language family, so that case is irrelevant for C.  */
extern gdbarch_return_value_on_stack_ftype generic_return_value_on_stack_not;

/* Backward compatible call_dummy_words. */
extern LONGEST legacy_call_dummy_words[];
extern int legacy_sizeof_call_dummy_words;

/* Typical remote_translate_xfer_address */
extern gdbarch_remote_translate_xfer_address_ftype generic_remote_translate_xfer_address;

/* Generic implementation of prologue_frameless_p.  Just calls
   SKIP_PROLOG and checks the return value to see if it actually
   changed. */
extern gdbarch_prologue_frameless_p_ftype generic_prologue_frameless_p;

/* The only possible cases for inner_than. */
extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);

/* Floating point values. */
extern const struct floatformat *default_float_format (struct gdbarch *gdbarch);
extern const struct floatformat *default_double_format (struct gdbarch *gdbarch);

/* Identity functions on a CORE_ADDR.  Just return the "addr".  */

extern CORE_ADDR core_addr_identity (CORE_ADDR addr);
extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;

/* No-op conversion of reg to regnum. */

extern int no_op_reg_to_regnum (int reg);

/* Versions of init_frame_pc().  Do nothing; do the default. */

extern CORE_ADDR deprecated_init_frame_pc_default (int fromleaf, struct frame_info *prev);

/* Do nothing version of elf_make_msymbol_special. */

void default_elf_make_msymbol_special (asymbol *sym, struct minimal_symbol *msym);

/* Do nothing version of coff_make_msymbol_special. */

void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);

/* Version of cannot_fetch_register() / cannot_store_register() that
   always fails. */

int cannot_register_not (int regnum);

/* Legacy version of target_virtual_frame_pointer().  Assumes that
   there is an DEPRECATED_FP_REGNUM and that it is the same, cooked or
   raw.  */

extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;

extern CORE_ADDR generic_skip_trampoline_code (CORE_ADDR pc);

extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
					      CORE_ADDR pc);

extern int generic_in_solib_call_trampoline (CORE_ADDR pc, char *name);

extern int generic_in_solib_return_trampoline (CORE_ADDR pc, char *name);

extern int generic_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR pc);

/* Assume that the world is sane, a registers raw and virtual size
   both match its type.  */

extern int generic_register_size (int regnum);

/* Assume that the world is sane, the registers are all adjacent.  */
extern int generic_register_byte (int regnum);

/* Prop up old targets that use various IN_SIGTRAMP() macros.  */
extern int legacy_pc_in_sigtramp (CORE_ADDR pc, char *name);

/* The orginal register_convert*() functions were overloaded.  They
   were used to both: convert between virtual and raw register formats
   (something that is discouraged); and to convert a register to the
   type of a corresponding variable.  These legacy functions preserve
   that overloaded behavour in existing targets.  */
extern int legacy_convert_register_p (int regnum, struct type *type);
extern void legacy_register_to_value (struct frame_info *frame, int regnum,
				      struct type *type, void *to);
extern void legacy_value_to_register (struct frame_info *frame, int regnum,
				      struct type *type, const void *from);

extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
					    struct type *type);

/* For compatibility with older architectures, returns
   (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
   name.  */

extern int legacy_register_sim_regno (int regnum);

/* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
   order was explicitly selected.  */
extern enum bfd_endian selected_byte_order (void);

/* Return the selected architecture's name, or NULL if no architecture
   was explicitly selected.  */
extern const char *selected_architecture_name (void);

/* Initialize a ``struct info''.  Can't use memset(0) since some
   default values are not zero.  "fill" takes all available
   information and fills in any unspecified fields.  */

extern void gdbarch_info_init (struct gdbarch_info *info);
extern void gdbarch_info_fill (struct gdbarch *gdbarch,
			       struct gdbarch_info *info);

/* Similar to init, but this time fill in the blanks.  Information is
   obtained from the specified architecture, global "set ..." options,
   and explicitly initialized INFO fields.  */
extern void gdbarch_info_fill (struct gdbarch *gdbarch,
			       struct gdbarch_info *info);

/* Return the architecture for ABFD.  If no suitable architecture
   could be find, return NULL.  */

extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);

#endif
Commit	Line	Data
c0e8c252	1	/* Dynamic architecture support for GDB, the GNU debugger.
d7bd68ca	2
e2d0e7eb AC	3	Copyright 1998, 1999, 2000, 2002, 2003 Free Software Foundation,
e2d0e7eb AC	4	Inc.
c0e8c252 AC	5
	6	This file is part of GDB.
	7
	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.
	12
	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.
	17
	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. */
	22
	23	#ifndef GDBARCH_UTILS_H
	24	#define GDBARCH_UTILS_H
	25
da3331ec AC	26	struct gdbarch;
	27	struct frame_info;
	28	struct minimal_symbol;
	29	struct type;
	30	struct gdbarch_info;
	31
c0e8c252 AC	32	/* gdbarch trace variable */
	33	extern int gdbarch_debug;
	34
	35	/* Fallback for register convertible. */
781a750d	36	extern gdbarch_deprecated_register_convertible_ftype deprecated_register_convertible_not;
c0e8c252	37
049ee0e4 AC	38	/* Implementation of extract return value that grubs around in the
	39	register cache. */
	40	extern gdbarch_extract_return_value_ftype legacy_extract_return_value;
	41
ebba8386 AC	42	/* Implementation of store return value that grubs the register cache. */
	43	extern gdbarch_store_return_value_ftype legacy_store_return_value;
	44
1fd35568 JB	45	/* To return any structure or union type by value, store it at the
	46	address passed as an invisible first argument to the function. */
	47	extern gdbarch_use_struct_convention_ftype always_use_struct_convention;
	48
c0e8c252 AC	49	/* Frameless functions not identifable. */
	50	extern gdbarch_frameless_function_invocation_ftype generic_frameless_function_invocation_not;
	51
71a9f22e JB	52	/* Only structures, unions, and arrays are returned using the struct
	53	convention. Note that arrays are never passed by value in the C
	54	language family, so that case is irrelevant for C. */
	55	extern gdbarch_return_value_on_stack_ftype generic_return_value_on_stack_not;
	56
c0e8c252 AC	57	/* Backward compatible call_dummy_words. */
	58	extern LONGEST legacy_call_dummy_words[];
	59	extern int legacy_sizeof_call_dummy_words;
	60
	61	/* Typical remote_translate_xfer_address */
	62	extern gdbarch_remote_translate_xfer_address_ftype generic_remote_translate_xfer_address;
	63
dad41f9a AC	64	/* Generic implementation of prologue_frameless_p. Just calls
	65	SKIP_PROLOG and checks the return value to see if it actually
	66	changed. */
	67	extern gdbarch_prologue_frameless_p_ftype generic_prologue_frameless_p;
	68
3339cf8b AC	69	/* The only possible cases for inner_than. */
	70	extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
	71	extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
	72
f0d4cc9e AC	73	/* Floating point values. */
	74	extern const struct floatformat default_float_format (struct gdbarch gdbarch);
	75	extern const struct floatformat default_double_format (struct gdbarch gdbarch);
	76
e2d0e7eb	77	/* Identity functions on a CORE_ADDR. Just return the "addr". */
f517ea4e	78
875e1767	79	extern CORE_ADDR core_addr_identity (CORE_ADDR addr);
e2d0e7eb	80	extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
f517ea4e	81
88c72b7d AC	82	/* No-op conversion of reg to regnum. */
	83
	84	extern int no_op_reg_to_regnum (int reg);
	85
7824d2f2	86	/* Versions of init_frame_pc(). Do nothing; do the default. */
10312cc4	87
0968aa8c	88	extern CORE_ADDR deprecated_init_frame_pc_default (int fromleaf, struct frame_info *prev);
7824d2f2	89
a2cf933a EZ	90	/* Do nothing version of elf_make_msymbol_special. */
	91
	92	void default_elf_make_msymbol_special (asymbol sym, struct minimal_symbol msym);
	93
	94	/* Do nothing version of coff_make_msymbol_special. */
	95
	96	void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
	97
01fb7433 AC	98	/* Version of cannot_fetch_register() / cannot_store_register() that
	99	always fails. */
	100
	101	int cannot_register_not (int regnum);
	102
39d4ef09	103	/* Legacy version of target_virtual_frame_pointer(). Assumes that
0ba6dca9 AC	104	there is an DEPRECATED_FP_REGNUM and that it is the same, cooked or
0ba6dca9 AC	105	raw. */
39d4ef09 AC	106
	107	extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
	108
bdcd319a CV	109	extern CORE_ADDR generic_skip_trampoline_code (CORE_ADDR pc);
bdcd319a CV	110
4c8c40e6 MK	111	extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
4c8c40e6 MK	112	CORE_ADDR pc);
dea0c52f	113
68e9cc94 CV	114	extern int generic_in_solib_call_trampoline (CORE_ADDR pc, char *name);
68e9cc94 CV	115
d50355b6 MS	116	extern int generic_in_solib_return_trampoline (CORE_ADDR pc, char *name);
d50355b6 MS	117
c12260ac CV	118	extern int generic_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR pc);
c12260ac CV	119
b2e75d78 AC	120	/* Assume that the world is sane, a registers raw and virtual size
b2e75d78 AC	121	both match its type. */
46cd78fb	122
b2e75d78	123	extern int generic_register_size (int regnum);
ce29138a	124
a7e3c2ad AC	125	/* Assume that the world is sane, the registers are all adjacent. */
	126	extern int generic_register_byte (int regnum);
	127
d7bd68ca AC	128	/* Prop up old targets that use various IN_SIGTRAMP() macros. */
	129	extern int legacy_pc_in_sigtramp (CORE_ADDR pc, char *name);
	130
13d01224 AC	131	/* The orginal register_convert*() functions were overloaded. They
	132	were used to both: convert between virtual and raw register formats
	133	(something that is discouraged); and to convert a register to the
	134	type of a corresponding variable. These legacy functions preserve
	135	that overloaded behavour in existing targets. */
ff2e87ac AC	136	extern int legacy_convert_register_p (int regnum, struct type *type);
	137	extern void legacy_register_to_value (struct frame_info *frame, int regnum,
	138	struct type type, void to);
	139	extern void legacy_value_to_register (struct frame_info *frame, int regnum,
	140	struct type type, const void from);
13d01224	141
192cb3d4 MK	142	extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
	143	struct type *type);
	144
4182591f AC	145	/* For compatibility with older architectures, returns
	146	(LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
	147	name. */
	148
	149	extern int legacy_register_sim_regno (int regnum);
	150
a8cf2722 AC	151	/* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
	152	order was explicitly selected. */
	153	extern enum bfd_endian selected_byte_order (void);
	154
	155	/* Return the selected architecture's name, or NULL if no architecture
	156	was explicitly selected. */
	157	extern const char *selected_architecture_name (void);
	158
fb6ecb0f	159	/* Initialize a ``struct info''. Can't use memset(0) since some
a8cf2722 AC	160	default values are not zero. "fill" takes all available
	161	information and fills in any unspecified fields. */
	162
fb6ecb0f	163	extern void gdbarch_info_init (struct gdbarch_info *info);
a8cf2722 AC	164	extern void gdbarch_info_fill (struct gdbarch *gdbarch,
a8cf2722 AC	165	struct gdbarch_info *info);
fb6ecb0f	166
100bcc3f	167	/* Similar to init, but this time fill in the blanks. Information is
bf922ad9 AC	168	obtained from the specified architecture, global "set ..." options,
	169	and explicitly initialized INFO fields. */
	170	extern void gdbarch_info_fill (struct gdbarch *gdbarch,
	171	struct gdbarch_info *info);
	172
2b026650 MK	173	/* Return the architecture for ABFD. If no suitable architecture
	174	could be find, return NULL. */
	175
	176	extern struct gdbarch gdbarch_from_bfd (bfd abfd);
	177
c0e8c252	178	#endif