2003-05-15 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 Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 59 Temple Place - Suite 330,
20    Boston, MA 02111-1307, USA.  */
21
22 #ifndef GDBARCH_UTILS_H
23 #define GDBARCH_UTILS_H
24
25 struct gdbarch;
26 struct frame_info;
27 struct minimal_symbol;
28 struct type;
29 struct gdbarch_info;
30
31 /* gdbarch trace variable */
32 extern int gdbarch_debug;
33
34 /* Fallback for register convertible. */
35 extern gdbarch_register_convertible_ftype generic_register_convertible_not;
36
37 extern CORE_ADDR generic_cannot_extract_struct_value_address (char *dummy);
38
39 /* Helper function for targets that don't know how my arguments are
40    being passed */
41 extern gdbarch_frame_num_args_ftype frame_num_args_unknown;
42
43 /* Implementation of extract return value that grubs around in the
44    register cache.  */
45 extern gdbarch_extract_return_value_ftype legacy_extract_return_value;
46
47 /* Implementation of store return value that grubs the register cache.  */
48 extern gdbarch_store_return_value_ftype legacy_store_return_value;
49
50 /* Frameless functions not identifable. */
51 extern gdbarch_frameless_function_invocation_ftype generic_frameless_function_invocation_not;
52
53 /* Only structures, unions, and arrays are returned using the struct
54    convention.  Note that arrays are never passed by value in the C
55    language family, so that case is irrelevant for C.  */
56 extern gdbarch_return_value_on_stack_ftype generic_return_value_on_stack_not;
57
58 /* Map onto old REGISTER_NAMES. */
59 extern const char *legacy_register_name (int i);
60
61 /* Accessor for old global function pointer for disassembly. */
62 extern int legacy_print_insn (bfd_vma vma, disassemble_info *info);
63
64 /* Backward compatible call_dummy_words. */
65 extern LONGEST legacy_call_dummy_words[];
66 extern int legacy_sizeof_call_dummy_words;
67
68 /* Typical remote_translate_xfer_address */
69 extern gdbarch_remote_translate_xfer_address_ftype generic_remote_translate_xfer_address;
70
71 /* Generic implementation of prologue_frameless_p.  Just calls
72    SKIP_PROLOG and checks the return value to see if it actually
73    changed. */
74 extern gdbarch_prologue_frameless_p_ftype generic_prologue_frameless_p;
75
76 /* The only possible cases for inner_than. */
77 extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
78 extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
79
80 /* Floating point values. */
81 extern const struct floatformat *default_float_format (struct gdbarch *gdbarch);
82 extern const struct floatformat *default_double_format (struct gdbarch *gdbarch);
83
84 /* Helper function for targets that don't know how my arguments are
85    being passed */
86 extern int frame_num_args_unknown (struct frame_info *fi);
87
88
89 /* The following DEPRECATED interfaces are for pre- multi-arch legacy
90    targets. */
91
92 /* DEPRECATED pre- multi-arch interface.  Explicitly set the dynamic
93    target-system-dependent parameters based on bfd_architecture and
94    machine.  This function is deprecated, use
95    set_gdbarch_from_arch_machine(). */
96
97 extern void set_architecture_from_arch_mach (enum bfd_architecture, unsigned long);
98
99 /* DEPRECATED pre- multi-arch interface.  Notify the target dependent
100    backend of a change to the selected architecture. A zero return
101    status indicates that the target did not like the change. */
102
103 extern int (*target_architecture_hook) (const struct bfd_arch_info *);
104
105 /* Identity function on a CORE_ADDR.  Just returns its parameter.  */
106
107 extern CORE_ADDR core_addr_identity (CORE_ADDR addr);
108
109 /* No-op conversion of reg to regnum. */
110
111 extern int no_op_reg_to_regnum (int reg);
112
113 /* Default prepare_to_procced. */
114
115 extern int default_prepare_to_proceed (int select_it);
116
117 extern int generic_prepare_to_proceed (int select_it);
118
119 /* Versions of init_frame_pc().  Do nothing; do the default. */
120
121 extern CORE_ADDR init_frame_pc_noop (int fromleaf, struct frame_info *prev);
122
123 extern CORE_ADDR init_frame_pc_default (int fromleaf, struct frame_info *prev);
124
125 /* Do nothing version of elf_make_msymbol_special. */
126
127 void default_elf_make_msymbol_special (asymbol *sym, struct minimal_symbol *msym);
128
129 /* Do nothing version of coff_make_msymbol_special. */
130
131 void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
132
133 /* Version of cannot_fetch_register() / cannot_store_register() that
134    always fails. */
135
136 int cannot_register_not (int regnum);
137
138 /* Legacy version of target_virtual_frame_pointer().  Assumes that
139    there is an DEPRECATED_FP_REGNUM and that it is the same, cooked or
140    raw.  */
141
142 extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
143
144 extern CORE_ADDR generic_skip_trampoline_code (CORE_ADDR pc);
145
146 extern int generic_in_solib_call_trampoline (CORE_ADDR pc, char *name);
147
148 extern int generic_in_solib_return_trampoline (CORE_ADDR pc, char *name);
149
150 extern int generic_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR pc);
151
152 /* Assume that the world is sane, a registers raw and virtual size
153    both match its type.  */
154
155 extern int generic_register_size (int regnum);
156
157 /* Assume that the world is sane, the registers are all adjacent.  */
158 extern int generic_register_byte (int regnum);
159
160 /* Prop up old targets that use various IN_SIGTRAMP() macros.  */
161 extern int legacy_pc_in_sigtramp (CORE_ADDR pc, char *name);
162
163 /* The orginal register_convert*() functions were overloaded.  They
164    were used to both: convert between virtual and raw register formats
165    (something that is discouraged); and to convert a register to the
166    type of a corresponding variable.  These legacy functions preserve
167    that overloaded behavour in existing targets.  */
168 extern int legacy_convert_register_p (int regnum);
169 extern void legacy_register_to_value (int regnum, struct type *type, char *from, char *to);
170 extern void legacy_value_to_register (struct type *type, int regnum, char *from, char *to);
171
172 /* For compatibility with older architectures, returns
173    (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
174    name.  */
175
176 extern int legacy_register_sim_regno (int regnum);
177
178 /* Initialize a ``struct info''.  Can't use memset(0) since some
179    default values are not zero.  */
180 extern void gdbarch_info_init (struct gdbarch_info *info);
181
182 #endif