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