Switch the license of all .c files to GPLv3.
[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 /* An implementation of return_value that props up architectures still
34    using USE_STRUCT_RETURN, gdbarch_extract_return_value and
35    store_return_value.  See also the hacks in "stack.c".  */
36 enum return_value_convention legacy_return_value (struct gdbarch *gdbarch,
37                                                   struct type *valtype,
38                                                   struct regcache *regcache,
39                                                   gdb_byte *readbuf,
40                                                   const gdb_byte *writebuf);
41
42 /* To return any structure or union type by value, store it at the
43    address passed as an invisible first argument to the function.  */
44 extern gdbarch_deprecated_use_struct_convention_ftype always_use_struct_convention;
45
46 /* The only possible cases for inner_than. */
47 extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
48 extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
49
50 /* Identity functions on a CORE_ADDR.  Just return the "addr".  */
51
52 extern CORE_ADDR core_addr_identity (CORE_ADDR addr);
53 extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
54
55 /* No-op conversion of reg to regnum. */
56
57 extern int no_op_reg_to_regnum (int reg);
58
59 /* Do nothing version of elf_make_msymbol_special. */
60
61 void default_elf_make_msymbol_special (asymbol *sym, struct minimal_symbol *msym);
62
63 /* Do nothing version of coff_make_msymbol_special. */
64
65 void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
66
67 /* Version of cannot_fetch_register() / cannot_store_register() that
68    always fails. */
69
70 int cannot_register_not (int regnum);
71
72 /* Legacy version of target_virtual_frame_pointer().  Assumes that
73    there is an gdbarch_deprecated_fp_regnum and that it is the same, cooked or
74    raw.  */
75
76 extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
77
78 extern CORE_ADDR generic_skip_trampoline_code (struct frame_info *frame,
79                                                CORE_ADDR pc);
80
81 extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
82                                               CORE_ADDR pc);
83
84 extern int generic_in_solib_return_trampoline (CORE_ADDR pc, char *name);
85
86 extern int generic_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR pc);
87
88 /* By default, registers are not convertible.  */
89 extern int generic_convert_register_p (int regnum, struct type *type);
90
91 extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
92                                             struct type *type);
93
94 extern int generic_instruction_nullified (struct gdbarch *gdbarch,
95                                           struct regcache *regcache);
96
97 int default_remote_register_number (struct gdbarch *gdbarch,
98                                     int regno);
99
100 /* For compatibility with older architectures, returns
101    (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
102    name.  */
103
104 extern int legacy_register_sim_regno (int regnum);
105
106 /* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
107    order was explicitly selected.  */
108 extern enum bfd_endian selected_byte_order (void);
109
110 /* Return the selected architecture's name, or NULL if no architecture
111    was explicitly selected.  */
112 extern const char *selected_architecture_name (void);
113
114 /* Initialize a ``struct info''.  Can't use memset(0) since some
115    default values are not zero.  "fill" takes all available
116    information and fills in any unspecified fields.  */
117
118 extern void gdbarch_info_init (struct gdbarch_info *info);
119
120 /* Similar to init, but this time fill in the blanks.  Information is
121    obtained from the global "set ..." options and explicitly
122    initialized INFO fields.  */
123 extern void gdbarch_info_fill (struct gdbarch_info *info);
124
125 /* Return the architecture for ABFD.  If no suitable architecture
126    could be find, return NULL.  */
127
128 extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
129
130 #endif