2004-06-20 Andrew Cagney <cagney@gnu.org>
[platform/upstream/binutils.git] / gdb / arch-utils.h
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
26 struct gdbarch;
27 struct frame_info;
28 struct minimal_symbol;
29 struct type;
30 struct gdbarch_info;
31
32 /* gdbarch trace variable */
33 extern int gdbarch_debug;
34
35 /* Implementation of extract return value that grubs around in the
36    register cache.  */
37 extern gdbarch_extract_return_value_ftype legacy_extract_return_value;
38
39 /* Implementation of store return value that grubs the register cache.  */
40 extern 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.  */
44 extern gdbarch_deprecated_use_struct_convention_ftype always_use_struct_convention;
45
46 /* Typical remote_translate_xfer_address */
47 extern gdbarch_remote_translate_xfer_address_ftype generic_remote_translate_xfer_address;
48
49 /* The only possible cases for inner_than. */
50 extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
51 extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
52
53 /* Floating point values. */
54 extern const struct floatformat *default_float_format (struct gdbarch *gdbarch);
55 extern const struct floatformat *default_double_format (struct gdbarch *gdbarch);
56
57 /* Identity functions on a CORE_ADDR.  Just return the "addr".  */
58
59 extern CORE_ADDR core_addr_identity (CORE_ADDR addr);
60 extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
61
62 /* No-op conversion of reg to regnum. */
63
64 extern int no_op_reg_to_regnum (int reg);
65
66 /* Versions of init_frame_pc().  Do nothing; do the default. */
67
68 extern CORE_ADDR deprecated_init_frame_pc_default (int fromleaf, struct frame_info *prev);
69
70 /* Do nothing version of elf_make_msymbol_special. */
71
72 void default_elf_make_msymbol_special (asymbol *sym, struct minimal_symbol *msym);
73
74 /* Do nothing version of coff_make_msymbol_special. */
75
76 void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
77
78 /* Version of cannot_fetch_register() / cannot_store_register() that
79    always fails. */
80
81 int cannot_register_not (int regnum);
82
83 /* Legacy version of target_virtual_frame_pointer().  Assumes that
84    there is an DEPRECATED_FP_REGNUM and that it is the same, cooked or
85    raw.  */
86
87 extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
88
89 extern CORE_ADDR generic_skip_trampoline_code (CORE_ADDR pc);
90
91 extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
92                                               CORE_ADDR pc);
93
94 extern int generic_in_solib_call_trampoline (CORE_ADDR pc, char *name);
95
96 extern int generic_in_solib_return_trampoline (CORE_ADDR pc, char *name);
97
98 extern int generic_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR pc);
99
100 /* Assume that the world is sane, a registers raw and virtual size
101    both match its type.  */
102
103 extern int generic_register_size (int regnum);
104
105 /* Assume that the world is sane, the registers are all adjacent.  */
106 extern int generic_register_byte (int regnum);
107
108 /* Prop up old targets that use various sigtramp macros.  */
109 extern int legacy_pc_in_sigtramp (CORE_ADDR pc, char *name);
110
111 /* By default, registers are not convertible.  */
112 extern int generic_convert_register_p (int regnum, struct type *type);
113
114 extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
115                                             struct type *type);
116
117 /* For compatibility with older architectures, returns
118    (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
119    name.  */
120
121 extern int legacy_register_sim_regno (int regnum);
122
123 /* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
124    order was explicitly selected.  */
125 extern enum bfd_endian selected_byte_order (void);
126
127 /* Return the selected architecture's name, or NULL if no architecture
128    was explicitly selected.  */
129 extern const char *selected_architecture_name (void);
130
131 /* Initialize a ``struct info''.  Can't use memset(0) since some
132    default values are not zero.  "fill" takes all available
133    information and fills in any unspecified fields.  */
134
135 extern void gdbarch_info_init (struct gdbarch_info *info);
136 extern void gdbarch_info_fill (struct gdbarch *gdbarch,
137                                struct gdbarch_info *info);
138
139 /* Similar to init, but this time fill in the blanks.  Information is
140    obtained from the specified architecture, global "set ..." options,
141    and explicitly initialized INFO fields.  */
142 extern void gdbarch_info_fill (struct gdbarch *gdbarch,
143                                struct gdbarch_info *info);
144
145 /* Return the architecture for ABFD.  If no suitable architecture
146    could be find, return NULL.  */
147
148 extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
149
150 #endif