* gdbarch.sh (deprecated_use_struct_convention): Remove.
[external/binutils.git] / gdb / arch-utils.h
1 /* Dynamic architecture support for GDB, the GNU debugger.
2
3    Copyright (C) 1998, 1999, 2000, 2002, 2003, 2004, 2007
4    Free Software Foundation, 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 3 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, see <http://www.gnu.org/licenses/>.  */
20
21 #ifndef GDBARCH_UTILS_H
22 #define GDBARCH_UTILS_H
23
24 struct gdbarch;
25 struct frame_info;
26 struct minimal_symbol;
27 struct type;
28 struct gdbarch_info;
29
30 /* gdbarch trace variable */
31 extern int gdbarch_debug;
32
33 /* The only possible cases for inner_than. */
34 extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
35 extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
36
37 /* Identity functions on a CORE_ADDR.  Just return the "addr".  */
38
39 extern CORE_ADDR core_addr_identity (CORE_ADDR addr);
40 extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
41
42 /* No-op conversion of reg to regnum. */
43
44 extern int no_op_reg_to_regnum (int reg);
45
46 /* Do nothing version of elf_make_msymbol_special. */
47
48 void default_elf_make_msymbol_special (asymbol *sym, struct minimal_symbol *msym);
49
50 /* Do nothing version of coff_make_msymbol_special. */
51
52 void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
53
54 /* Version of cannot_fetch_register() / cannot_store_register() that
55    always fails. */
56
57 int cannot_register_not (int regnum);
58
59 /* Legacy version of target_virtual_frame_pointer().  Assumes that
60    there is an gdbarch_deprecated_fp_regnum and that it is the same, cooked or
61    raw.  */
62
63 extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
64
65 extern CORE_ADDR generic_skip_trampoline_code (struct frame_info *frame,
66                                                CORE_ADDR pc);
67
68 extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
69                                               CORE_ADDR pc);
70
71 extern int generic_in_solib_return_trampoline (CORE_ADDR pc, char *name);
72
73 extern int generic_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR pc);
74
75 /* By default, registers are not convertible.  */
76 extern int generic_convert_register_p (int regnum, struct type *type);
77
78 extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
79                                             struct type *type);
80
81 extern int generic_instruction_nullified (struct gdbarch *gdbarch,
82                                           struct regcache *regcache);
83
84 int default_remote_register_number (struct gdbarch *gdbarch,
85                                     int regno);
86
87 /* For compatibility with older architectures, returns
88    (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
89    name.  */
90
91 extern int legacy_register_sim_regno (int regnum);
92
93 /* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
94    order was explicitly selected.  */
95 extern enum bfd_endian selected_byte_order (void);
96
97 /* Return the selected architecture's name, or NULL if no architecture
98    was explicitly selected.  */
99 extern const char *selected_architecture_name (void);
100
101 /* Initialize a ``struct info''.  Can't use memset(0) since some
102    default values are not zero.  "fill" takes all available
103    information and fills in any unspecified fields.  */
104
105 extern void gdbarch_info_init (struct gdbarch_info *info);
106
107 /* Similar to init, but this time fill in the blanks.  Information is
108    obtained from the global "set ..." options and explicitly
109    initialized INFO fields.  */
110 extern void gdbarch_info_fill (struct gdbarch_info *info);
111
112 /* Return the architecture for ABFD.  If no suitable architecture
113    could be find, return NULL.  */
114
115 extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
116
117 #endif