2003-11-09 Andrew Cagney <cagney@redhat.com>
[external/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 /* Fallback for register convertible. */
36 extern gdbarch_deprecated_register_convertible_ftype deprecated_register_convertible_not;
37
38 extern CORE_ADDR generic_cannot_extract_struct_value_address (char *dummy);
39
40 /* Implementation of extract return value that grubs around in the
41    register cache.  */
42 extern gdbarch_extract_return_value_ftype legacy_extract_return_value;
43
44 /* Implementation of store return value that grubs the register cache.  */
45 extern gdbarch_store_return_value_ftype legacy_store_return_value;
46
47 /* To return any structure or union type by value, store it at the
48    address passed as an invisible first argument to the function.  */
49 extern gdbarch_use_struct_convention_ftype always_use_struct_convention;
50
51 /* Frameless functions not identifable. */
52 extern gdbarch_frameless_function_invocation_ftype generic_frameless_function_invocation_not;
53
54 /* Only structures, unions, and arrays are returned using the struct
55    convention.  Note that arrays are never passed by value in the C
56    language family, so that case is irrelevant for C.  */
57 extern gdbarch_return_value_on_stack_ftype generic_return_value_on_stack_not;
58
59 /* Backward compatible call_dummy_words. */
60 extern LONGEST legacy_call_dummy_words[];
61 extern int legacy_sizeof_call_dummy_words;
62
63 /* Typical remote_translate_xfer_address */
64 extern gdbarch_remote_translate_xfer_address_ftype generic_remote_translate_xfer_address;
65
66 /* Generic implementation of prologue_frameless_p.  Just calls
67    SKIP_PROLOG and checks the return value to see if it actually
68    changed. */
69 extern gdbarch_prologue_frameless_p_ftype generic_prologue_frameless_p;
70
71 /* The only possible cases for inner_than. */
72 extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
73 extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
74
75 /* Floating point values. */
76 extern const struct floatformat *default_float_format (struct gdbarch *gdbarch);
77 extern const struct floatformat *default_double_format (struct gdbarch *gdbarch);
78
79 /* Identity functions on a CORE_ADDR.  Just return the "addr".  */
80
81 extern CORE_ADDR core_addr_identity (CORE_ADDR addr);
82 extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
83
84 /* No-op conversion of reg to regnum. */
85
86 extern int no_op_reg_to_regnum (int reg);
87
88 /* Versions of init_frame_pc().  Do nothing; do the default. */
89
90 extern CORE_ADDR deprecated_init_frame_pc_default (int fromleaf, struct frame_info *prev);
91
92 /* Do nothing version of elf_make_msymbol_special. */
93
94 void default_elf_make_msymbol_special (asymbol *sym, struct minimal_symbol *msym);
95
96 /* Do nothing version of coff_make_msymbol_special. */
97
98 void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
99
100 /* Version of cannot_fetch_register() / cannot_store_register() that
101    always fails. */
102
103 int cannot_register_not (int regnum);
104
105 /* Legacy version of target_virtual_frame_pointer().  Assumes that
106    there is an DEPRECATED_FP_REGNUM and that it is the same, cooked or
107    raw.  */
108
109 extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
110
111 extern CORE_ADDR generic_skip_trampoline_code (CORE_ADDR pc);
112
113 extern CORE_ADDR generic_skip_solib_resolver (CORE_ADDR pc);
114
115 extern int generic_in_solib_call_trampoline (CORE_ADDR pc, char *name);
116
117 extern int generic_in_solib_return_trampoline (CORE_ADDR pc, char *name);
118
119 extern int generic_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR pc);
120
121 /* Assume that the world is sane, a registers raw and virtual size
122    both match its type.  */
123
124 extern int generic_register_size (int regnum);
125
126 /* Assume that the world is sane, the registers are all adjacent.  */
127 extern int generic_register_byte (int regnum);
128
129 /* Prop up old targets that use various IN_SIGTRAMP() macros.  */
130 extern int legacy_pc_in_sigtramp (CORE_ADDR pc, char *name);
131
132 /* The orginal register_convert*() functions were overloaded.  They
133    were used to both: convert between virtual and raw register formats
134    (something that is discouraged); and to convert a register to the
135    type of a corresponding variable.  These legacy functions preserve
136    that overloaded behavour in existing targets.  */
137 extern int legacy_convert_register_p (int regnum, struct type *type);
138 extern void legacy_register_to_value (struct frame_info *frame, int regnum,
139                                       struct type *type, void *to);
140 extern void legacy_value_to_register (struct frame_info *frame, int regnum,
141                                       struct type *type, const void *from);
142
143 extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
144                                             struct type *type);
145
146 /* For compatibility with older architectures, returns
147    (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
148    name.  */
149
150 extern int legacy_register_sim_regno (int regnum);
151
152 /* Initialize a ``struct info''.  Can't use memset(0) since some
153    default values are not zero.  */
154 extern void gdbarch_info_init (struct gdbarch_info *info);
155
156 /* Similar it 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.  */
159 extern 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
165 extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
166
167 #endif