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