gdb/arch-utils.h

   1 /* Dynamic architecture support for GDB, the GNU debugger.
   2
   3    Copyright (C) 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., 51 Franklin Street, Fifth Floor,
  21    Boston, MA 02110-1301, 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 /* 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".  */
  38 enum return_value_convention legacy_return_value (struct gdbarch *gdbarch,
  39                                                   struct type *valtype,
  40                                                   struct regcache *regcache,
  41                                                   gdb_byte *readbuf,
  42                                                   const gdb_byte *writebuf);
  43
  44 /* Implementation of extract return value that grubs around in the
  45    register cache.  */
  46 extern gdbarch_extract_return_value_ftype legacy_extract_return_value;
  47
  48 /* Implementation of store return value that grubs the register cache.  */
  49 extern 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.  */
  53 extern gdbarch_deprecated_use_struct_convention_ftype always_use_struct_convention;
  54
  55 /* Typical remote_translate_xfer_address */
  56 extern gdbarch_remote_translate_xfer_address_ftype generic_remote_translate_xfer_address;
  57
  58 /* The only possible cases for inner_than. */
  59 extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
  60 extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
  61
  62 /* Floating point values. */
  63 extern const struct floatformat *default_float_format (struct gdbarch *gdbarch);
  64 extern const struct floatformat *default_double_format (struct gdbarch *gdbarch);
  65
  66 /* Identity functions on a CORE_ADDR.  Just return the "addr".  */
  67
  68 extern CORE_ADDR core_addr_identity (CORE_ADDR addr);
  69 extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
  70
  71 /* No-op conversion of reg to regnum. */
  72
  73 extern int no_op_reg_to_regnum (int reg);
  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_return_trampoline (CORE_ADDR pc, char *name);
 100
 101 extern int generic_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR pc);
 102
 103 /* Assume that the world is sane, a registers raw and virtual size
 104    both match its type.  */
 105
 106 extern int generic_register_size (int regnum);
 107
 108 /* Assume that the world is sane, the registers are all adjacent.  */
 109 extern int generic_register_byte (int regnum);
 110
 111 /* Prop up old targets that use various sigtramp macros.  */
 112 extern int legacy_pc_in_sigtramp (CORE_ADDR pc, char *name);
 113
 114 /* By default, registers are not convertible.  */
 115 extern int generic_convert_register_p (int regnum, struct type *type);
 116
 117 extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
 118                                             struct type *type);
 119
 120 extern int generic_instruction_nullified (struct gdbarch *gdbarch,
 121                                           struct regcache *regcache);
 122
 123 /* For compatibility with older architectures, returns
 124    (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
 125    name.  */
 126
 127 extern int legacy_register_sim_regno (int regnum);
 128
 129 /* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
 130    order was explicitly selected.  */
 131 extern enum bfd_endian selected_byte_order (void);
 132
 133 /* Return the selected architecture's name, or NULL if no architecture
 134    was explicitly selected.  */
 135 extern const char *selected_architecture_name (void);
 136
 137 /* Initialize a ``struct info''.  Can't use memset(0) since some
 138    default values are not zero.  "fill" takes all available
 139    information and fills in any unspecified fields.  */
 140
 141 extern void gdbarch_info_init (struct gdbarch_info *info);
 142 extern void gdbarch_info_fill (struct gdbarch *gdbarch,
 143                                struct gdbarch_info *info);
 144
 145 /* Similar to init, but this time fill in the blanks.  Information is
 146    obtained from the specified architecture, global "set ..." options,
 147    and explicitly initialized INFO fields.  */
 148 extern void gdbarch_info_fill (struct gdbarch *gdbarch,
 149                                struct gdbarch_info *info);
 150
 151 /* Return the architecture for ABFD.  If no suitable architecture
 152    could be find, return NULL.  */
 153
 154 extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
 155
 156 #endif