gdb/arch-utils.h

   1 /* Dynamic architecture support for GDB, the GNU debugger.
   2
   3    Copyright 1998, 1999, 2000, 2002, 2003 Free Software Foundation,
   4    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
  26 struct gdbarch;
  27 struct frame_info;
  28 struct minimal_symbol;
  29 struct type;
  30 struct gdbarch_info;
  31
  32 /* gdbarch trace variable */
  33 extern int gdbarch_debug;
  34
  35 /* Implementation of extract return value that grubs around in the
  36    register cache.  */
  37 extern gdbarch_extract_return_value_ftype legacy_extract_return_value;
  38
  39 /* Implementation of store return value that grubs the register cache.  */
  40 extern gdbarch_store_return_value_ftype legacy_store_return_value;
  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_use_struct_convention_ftype always_use_struct_convention;
  45
  46 /* Only structures, unions, and arrays are returned using the struct
  47    convention.  Note that arrays are never passed by value in the C
  48    language family, so that case is irrelevant for C.  */
  49 extern gdbarch_return_value_on_stack_ftype generic_return_value_on_stack_not;
  50
  51 /* Typical remote_translate_xfer_address */
  52 extern gdbarch_remote_translate_xfer_address_ftype generic_remote_translate_xfer_address;
  53
  54 /* The only possible cases for inner_than. */
  55 extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
  56 extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
  57
  58 /* Floating point values. */
  59 extern const struct floatformat *default_float_format (struct gdbarch *gdbarch);
  60 extern const struct floatformat *default_double_format (struct gdbarch *gdbarch);
  61
  62 /* Identity functions on a CORE_ADDR.  Just return the "addr".  */
  63
  64 extern CORE_ADDR core_addr_identity (CORE_ADDR addr);
  65 extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
  66
  67 /* No-op conversion of reg to regnum. */
  68
  69 extern int no_op_reg_to_regnum (int reg);
  70
  71 /* Versions of init_frame_pc().  Do nothing; do the default. */
  72
  73 extern CORE_ADDR deprecated_init_frame_pc_default (int fromleaf, struct frame_info *prev);
  74
  75 /* Do nothing version of elf_make_msymbol_special. */
  76
  77 void default_elf_make_msymbol_special (asymbol *sym, struct minimal_symbol *msym);
  78
  79 /* Do nothing version of coff_make_msymbol_special. */
  80
  81 void 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
  86 int 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
  92 extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
  93
  94 extern CORE_ADDR generic_skip_trampoline_code (CORE_ADDR pc);
  95
  96 extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
  97                                               CORE_ADDR pc);
  98
  99 extern int generic_in_solib_call_trampoline (CORE_ADDR pc, char *name);
 100
 101 extern int generic_in_solib_return_trampoline (CORE_ADDR pc, char *name);
 102
 103 extern 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
 108 extern int generic_register_size (int regnum);
 109
 110 /* Assume that the world is sane, the registers are all adjacent.  */
 111 extern int generic_register_byte (int regnum);
 112
 113 /* Prop up old targets that use various sigtramp macros.  */
 114 extern int legacy_pc_in_sigtramp (CORE_ADDR pc, char *name);
 115
 116 /* The orginal register_convert*() functions were overloaded.  They
 117    were used to both: convert between virtual and raw register formats
 118    (something that is discouraged); and to convert a register to the
 119    type of a corresponding variable.  These legacy functions preserve
 120    that overloaded behavour in existing targets.  */
 121 extern int legacy_convert_register_p (int regnum, struct type *type);
 122 extern void legacy_register_to_value (struct frame_info *frame, int regnum,
 123                                       struct type *type, void *to);
 124 extern void legacy_value_to_register (struct frame_info *frame, int regnum,
 125                                       struct type *type, const void *from);
 126
 127 extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
 128                                             struct type *type);
 129
 130 /* For compatibility with older architectures, returns
 131    (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
 132    name.  */
 133
 134 extern int legacy_register_sim_regno (int regnum);
 135
 136 /* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
 137    order was explicitly selected.  */
 138 extern enum bfd_endian selected_byte_order (void);
 139
 140 /* Return the selected architecture's name, or NULL if no architecture
 141    was explicitly selected.  */
 142 extern const char *selected_architecture_name (void);
 143
 144 /* Initialize a ``struct info''.  Can't use memset(0) since some
 145    default values are not zero.  "fill" takes all available
 146    information and fills in any unspecified fields.  */
 147
 148 extern void gdbarch_info_init (struct gdbarch_info *info);
 149 extern void gdbarch_info_fill (struct gdbarch *gdbarch,
 150                                struct gdbarch_info *info);
 151
 152 /* Similar to init, but this time fill in the blanks.  Information is
 153    obtained from the specified architecture, global "set ..." options,
 154    and explicitly initialized INFO fields.  */
 155 extern void gdbarch_info_fill (struct gdbarch *gdbarch,
 156                                struct gdbarch_info *info);
 157
 158 /* Return the architecture for ABFD.  If no suitable architecture
 159    could be find, return NULL.  */
 160
 161 extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
 162
 163 #endif