1/* Dynamic architecture support for GDB, the GNU debugger.
2
3   Copyright 1998, 1999, 2000, 2002, 2003, 2004 Free Software
4   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 2 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, write to the Free Software
20   Foundation, Inc., 59 Temple Place - Suite 330,
21   Boston, MA 02111-1307, USA.  */
22
23#ifndef GDBARCH_UTILS_H
24#define GDBARCH_UTILS_H
25
26struct gdbarch;
27struct frame_info;
28struct minimal_symbol;
29struct type;
30struct gdbarch_info;
31
32/* gdbarch trace variable */
33extern int gdbarch_debug;
34
35/* An implementation of return_value that props up architectures still
36   using USE_STRUCT_RETURN, EXTRACT_RETURN_VALUE and
37   STORE_RETURN_VALUE.  See also the hacks in "stack.c".  */
38enum return_value_convention legacy_return_value (struct gdbarch *gdbarch,
39						  struct type *valtype,
40						  struct regcache *regcache,
41						  void *readbuf,
42						  const void *writebuf);
43
44/* Implementation of extract return value that grubs around in the
45   register cache.  */
46extern gdbarch_extract_return_value_ftype legacy_extract_return_value;
47
48/* Implementation of store return value that grubs the register cache.  */
49extern gdbarch_store_return_value_ftype legacy_store_return_value;
50
51/* To return any structure or union type by value, store it at the
52   address passed as an invisible first argument to the function.  */
53extern gdbarch_deprecated_use_struct_convention_ftype always_use_struct_convention;
54
55/* Typical remote_translate_xfer_address */
56extern gdbarch_remote_translate_xfer_address_ftype generic_remote_translate_xfer_address;
57
58/* The only possible cases for inner_than. */
59extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
60extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
61
62/* Floating point values. */
63extern const struct floatformat *default_float_format (struct gdbarch *gdbarch);
64extern const struct floatformat *default_double_format (struct gdbarch *gdbarch);
65
66/* Identity functions on a CORE_ADDR.  Just return the "addr".  */
67
68extern CORE_ADDR core_addr_identity (CORE_ADDR addr);
69extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
70
71/* No-op conversion of reg to regnum. */
72
73extern int no_op_reg_to_regnum (int reg);
74
75/* Do nothing version of elf_make_msymbol_special. */
76
77void default_elf_make_msymbol_special (asymbol *sym, struct minimal_symbol *msym);
78
79/* Do nothing version of coff_make_msymbol_special. */
80
81void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
82
83/* Version of cannot_fetch_register() / cannot_store_register() that
84   always fails. */
85
86int cannot_register_not (int regnum);
87
88/* Legacy version of target_virtual_frame_pointer().  Assumes that
89   there is an DEPRECATED_FP_REGNUM and that it is the same, cooked or
90   raw.  */
91
92extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
93
94extern CORE_ADDR generic_skip_trampoline_code (CORE_ADDR pc);
95
96extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
97					      CORE_ADDR pc);
98
99extern int generic_in_solib_call_trampoline (CORE_ADDR pc, char *name);
100
101extern int generic_in_solib_return_trampoline (CORE_ADDR pc, char *name);
102
103extern int generic_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR pc);
104
105/* Assume that the world is sane, a registers raw and virtual size
106   both match its type.  */
107
108extern int generic_register_size (int regnum);
109
110/* Assume that the world is sane, the registers are all adjacent.  */
111extern int generic_register_byte (int regnum);
112
113/* Prop up old targets that use various sigtramp macros.  */
114extern int legacy_pc_in_sigtramp (CORE_ADDR pc, char *name);
115
116/* By default, registers are not convertible.  */
117extern int generic_convert_register_p (int regnum, struct type *type);
118
119extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
120					    struct type *type);
121
122/* For compatibility with older architectures, returns
123   (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
124   name.  */
125
126extern int legacy_register_sim_regno (int regnum);
127
128/* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
129   order was explicitly selected.  */
130extern enum bfd_endian selected_byte_order (void);
131
132/* Return the selected architecture's name, or NULL if no architecture
133   was explicitly selected.  */
134extern const char *selected_architecture_name (void);
135
136/* Initialize a ``struct info''.  Can't use memset(0) since some
137   default values are not zero.  "fill" takes all available
138   information and fills in any unspecified fields.  */
139
140extern void gdbarch_info_init (struct gdbarch_info *info);
141extern void gdbarch_info_fill (struct gdbarch *gdbarch,
142			       struct gdbarch_info *info);
143
144/* Similar to init, but this time fill in the blanks.  Information is
145   obtained from the specified architecture, global "set ..." options,
146   and explicitly initialized INFO fields.  */
147extern void gdbarch_info_fill (struct gdbarch *gdbarch,
148			       struct gdbarch_info *info);
149
150/* Return the architecture for ABFD.  If no suitable architecture
151   could be find, return NULL.  */
152
153extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
154
155#endif
156