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