gdb/arch-utils.h

   1 /* Dynamic architecture support for GDB, the GNU debugger.
   2
   3    Copyright (C) 1998, 1999, 2000, 2002, 2003, 2004, 2007, 2008
   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 gdbarch_displaced_step_copy_insn for
  34    processors that don't need to modify the instruction before
  35    single-stepping the displaced copy.
  36
  37    Simply copy gdbarch_max_insn_length (ARCH) bytes from FROM to TO.
  38    The closure is an array of that many bytes containing the
  39    instruction's bytes, allocated with xmalloc.  */
  40 extern struct displaced_step_closure *
  41   simple_displaced_step_copy_insn (struct gdbarch *gdbarch,
  42                                    CORE_ADDR from, CORE_ADDR to,
  43                                    struct regcache *regs);
  44
  45 /* Simple implementation of gdbarch_displaced_step_free_closure: Call
  46    xfree.
  47    This is appropriate for use with simple_displaced_step_copy_insn.  */
  48 extern void
  49   simple_displaced_step_free_closure (struct gdbarch *gdbarch,
  50                                       struct displaced_step_closure *closure);
  51
  52 /* Possible value for gdbarch_displaced_step_location:
  53    Place displaced instructions at the program's entry point,
  54    leaving space for inferior function call return breakpoints.  */
  55 extern CORE_ADDR displaced_step_at_entry_point (struct gdbarch *gdbarch);
  56
  57 /* The only possible cases for inner_than. */
  58 extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
  59 extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
  60
  61 /* Identity functions on a CORE_ADDR.  Just return the "addr".  */
  62
  63 extern CORE_ADDR core_addr_identity (CORE_ADDR addr);
  64 extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
  65
  66 /* No-op conversion of reg to regnum. */
  67
  68 extern int no_op_reg_to_regnum (struct gdbarch *gdbarch, int reg);
  69
  70 /* Do nothing version of elf_make_msymbol_special. */
  71
  72 void default_elf_make_msymbol_special (asymbol *sym, struct minimal_symbol *msym);
  73
  74 /* Do nothing version of coff_make_msymbol_special. */
  75
  76 void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
  77
  78 /* Version of cannot_fetch_register() / cannot_store_register() that
  79    always fails. */
  80
  81 int cannot_register_not (struct gdbarch *gdbarch, int regnum);
  82
  83 /* Legacy version of target_virtual_frame_pointer().  Assumes that
  84    there is an gdbarch_deprecated_fp_regnum and that it is the same, cooked or
  85    raw.  */
  86
  87 extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
  88
  89 extern CORE_ADDR generic_skip_trampoline_code (struct frame_info *frame,
  90                                                CORE_ADDR pc);
  91
  92 extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
  93                                               CORE_ADDR pc);
  94
  95 extern int generic_in_solib_return_trampoline (CORE_ADDR pc, char *name);
  96
  97 extern int generic_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR pc);
  98
  99 /* By default, registers are not convertible.  */
 100 extern int generic_convert_register_p (struct gdbarch *gdbarch, int regnum,
 101                                        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 (struct gdbarch *gdbarch, 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