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