* arch-utils.h: Update copyright.
[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 /* gdbarch trace variable */
26 extern int gdbarch_debug;
27
28 /* Fallback for register convertible. */
29 extern gdbarch_register_convertible_ftype generic_register_convertible_not;
30
31 extern CORE_ADDR generic_cannot_extract_struct_value_address (char *dummy);
32
33 /* Helper function for targets that don't know how my arguments are
34    being passed */
35 extern gdbarch_frame_num_args_ftype frame_num_args_unknown;
36
37 /* Implementation of breakpoint from PC using any of the deprecated
38    macros BREAKPOINT, LITTLE_BREAKPOINT, BIG_BREAPOINT.  For legacy
39    targets that don't yet implement their own breakpoint_from_pc(). */
40 extern gdbarch_breakpoint_from_pc_ftype legacy_breakpoint_from_pc;
41
42 /* Frameless functions not identifable. */
43 extern gdbarch_frameless_function_invocation_ftype generic_frameless_function_invocation_not;
44
45 /* Only structures, unions, and arrays are returned using the struct
46    convention.  Note that arrays are never passed by value in the C
47    language family, so that case is irrelevant for C.  */
48 extern gdbarch_return_value_on_stack_ftype generic_return_value_on_stack_not;
49
50 /* Map onto old REGISTER_NAMES. */
51 extern char *legacy_register_name (int i);
52
53 /* Accessor for old global function pointer for disassembly. */
54 extern int legacy_print_insn (bfd_vma vma, disassemble_info *info);
55
56 /* Backward compatible call_dummy_words. */
57 extern LONGEST legacy_call_dummy_words[];
58 extern int legacy_sizeof_call_dummy_words;
59
60 /* Typical remote_translate_xfer_address */
61 extern gdbarch_remote_translate_xfer_address_ftype generic_remote_translate_xfer_address;
62
63 /* Generic implementation of prologue_frameless_p.  Just calls
64    SKIP_PROLOG and checks the return value to see if it actually
65    changed. */
66 extern gdbarch_prologue_frameless_p_ftype generic_prologue_frameless_p;
67
68 /* The only possible cases for inner_than. */
69 extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
70 extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
71
72 /* Floating point values. */
73 extern const struct floatformat *default_float_format (struct gdbarch *gdbarch);
74 extern const struct floatformat *default_double_format (struct gdbarch *gdbarch);
75
76 /* Helper function for targets that don't know how my arguments are
77    being passed */
78 extern int frame_num_args_unknown (struct frame_info *fi);
79
80
81 /* The following DEPRECATED interfaces are for pre- multi-arch legacy
82    targets. */
83
84 /* DEPRECATED pre- multi-arch interface.  Explicitly set the dynamic
85    target-system-dependent parameters based on bfd_architecture and
86    machine.  This function is deprecated, use
87    set_gdbarch_from_arch_machine(). */
88
89 extern void set_architecture_from_arch_mach (enum bfd_architecture, unsigned long);
90
91 /* DEPRECATED pre- multi-arch interface.  Notify the target dependent
92    backend of a change to the selected architecture. A zero return
93    status indicates that the target did not like the change. */
94
95 extern int (*target_architecture_hook) (const struct bfd_arch_info *);
96
97
98 /* Default raw->sim register re-numbering - does nothing. */
99
100 extern int default_register_sim_regno (int reg_nr);
101
102 /* Identity function on a CORE_ADDR.  Just returns its parameter.  */
103
104 extern CORE_ADDR core_addr_identity (CORE_ADDR addr);
105
106 /* No-op conversion of reg to regnum. */
107
108 extern int no_op_reg_to_regnum (int reg);
109
110 /* Default frame_args_address and frame_locals_address.  */
111
112 extern CORE_ADDR default_frame_address (struct frame_info *);
113
114 /* Default prepare_to_procced. */
115
116 extern int default_prepare_to_proceed (int select_it);
117
118 extern int generic_prepare_to_proceed (int select_it);
119
120 /* Versions of init_frame_pc().  Do nothing; do the default. */
121
122 void init_frame_pc_noop (int fromleaf, struct frame_info *prev);
123
124 void init_frame_pc_default (int fromleaf, struct frame_info *prev);
125
126 /* Do nothing version of elf_make_msymbol_special. */
127
128 void default_elf_make_msymbol_special (asymbol *sym, struct minimal_symbol *msym);
129
130 /* Do nothing version of coff_make_msymbol_special. */
131
132 void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
133
134 /* Version of cannot_fetch_register() / cannot_store_register() that
135    always fails. */
136
137 int cannot_register_not (int regnum);
138
139 /* Legacy version of target_virtual_frame_pointer().  Assumes that
140    there is an FP_REGNUM and that it is the same, cooked or 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_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR pc);
149
150 extern void default_print_float_info (void);
151
152 /* Assume all registers are the same size and a size identical to that
153    of the integer type.  */
154 extern int generic_register_raw_size (int regnum);
155
156 /* Assume the virtual size of registers corresponds to the virtual type.  */
157
158 extern int generic_register_virtual_size (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 /* Initialize a ``struct info''.  Can't use memset(0) since some
164    default values are not zero.  */
165 extern void gdbarch_info_init (struct gdbarch_info *info);
166
167 #endif