gdb/arch-utils.h

   1 /* Dynamic architecture support for GDB, the GNU debugger.
   2
   3    Copyright (C) 1998-2014 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef GDBARCH_UTILS_H
  21 #define GDBARCH_UTILS_H
  22
  23 struct gdbarch;
  24 struct frame_info;
  25 struct minimal_symbol;
  26 struct type;
  27 struct gdbarch_info;
  28
  29 /* An implementation of gdbarch_displaced_step_copy_insn for
  30    processors that don't need to modify the instruction before
  31    single-stepping the displaced copy.
  32
  33    Simply copy gdbarch_max_insn_length (ARCH) bytes from FROM to TO.
  34    The closure is an array of that many bytes containing the
  35    instruction's bytes, allocated with xmalloc.  */
  36 extern struct displaced_step_closure *
  37   simple_displaced_step_copy_insn (struct gdbarch *gdbarch,
  38                                    CORE_ADDR from, CORE_ADDR to,
  39                                    struct regcache *regs);
  40
  41 /* Simple implementation of gdbarch_displaced_step_free_closure: Call
  42    xfree.
  43    This is appropriate for use with simple_displaced_step_copy_insn.  */
  44 extern void
  45   simple_displaced_step_free_closure (struct gdbarch *gdbarch,
  46                                       struct displaced_step_closure *closure);
  47
  48 /* Default implementation of gdbarch_displaced_hw_singlestep.  */
  49 extern int
  50   default_displaced_step_hw_singlestep (struct gdbarch *,
  51                                         struct displaced_step_closure *);
  52
  53 /* Possible value for gdbarch_displaced_step_location:
  54    Place displaced instructions at the program's entry point,
  55    leaving space for inferior function call return breakpoints.  */
  56 extern CORE_ADDR displaced_step_at_entry_point (struct gdbarch *gdbarch);
  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 /* Identity functions on a CORE_ADDR.  Just return the "addr".  */
  63
  64 extern CORE_ADDR core_addr_identity (struct gdbarch *gdbarch, 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 (struct gdbarch *gdbarch, int reg);
  70
  71 /* Do nothing version of elf_make_msymbol_special.  */
  72
  73 void default_elf_make_msymbol_special (asymbol *sym,
  74                                        struct minimal_symbol *msym);
  75
  76 /* Do nothing version of coff_make_msymbol_special.  */
  77
  78 void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
  79
  80 /* Version of cannot_fetch_register() / cannot_store_register() that
  81    always fails.  */
  82
  83 int cannot_register_not (struct gdbarch *gdbarch, int regnum);
  84
  85 /* Legacy version of target_virtual_frame_pointer().  Assumes that
  86    there is an gdbarch_deprecated_fp_regnum and that it is the same, cooked or
  87    raw.  */
  88
  89 extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
  90
  91 extern CORE_ADDR generic_skip_trampoline_code (struct frame_info *frame,
  92                                                CORE_ADDR pc);
  93
  94 extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
  95                                               CORE_ADDR pc);
  96
  97 extern int generic_in_solib_return_trampoline (struct gdbarch *gdbarch,
  98                                                CORE_ADDR pc, const char *name);
  99
 100 extern int generic_in_function_epilogue_p (struct gdbarch *gdbarch,
 101                                            CORE_ADDR pc);
 102
 103 /* By default, registers are not convertible.  */
 104 extern int generic_convert_register_p (struct gdbarch *gdbarch, int regnum,
 105                                        struct type *type);
 106
 107 extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
 108                                             struct type *type);
 109
 110 extern int generic_instruction_nullified (struct gdbarch *gdbarch,
 111                                           struct regcache *regcache);
 112
 113 int default_remote_register_number (struct gdbarch *gdbarch,
 114                                     int regno);
 115
 116 /* For compatibility with older architectures, returns
 117    (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
 118    name.  */
 119
 120 extern int legacy_register_sim_regno (struct gdbarch *gdbarch, int regnum);
 121
 122 /* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
 123    order was explicitly selected.  */
 124 extern enum bfd_endian selected_byte_order (void);
 125
 126 /* Return the selected architecture's name, or NULL if no architecture
 127    was explicitly selected.  */
 128 extern const char *selected_architecture_name (void);
 129
 130 /* Initialize a ``struct info''.  Can't use memset(0) since some
 131    default values are not zero.  "fill" takes all available
 132    information and fills in any unspecified fields.  */
 133
 134 extern void gdbarch_info_init (struct gdbarch_info *info);
 135
 136 /* Similar to init, but this time fill in the blanks.  Information is
 137    obtained from the global "set ..." options and explicitly
 138    initialized INFO fields.  */
 139 extern void gdbarch_info_fill (struct gdbarch_info *info);
 140
 141 /* Return the architecture for ABFD.  If no suitable architecture
 142    could be find, return NULL.  */
 143
 144 extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
 145
 146 /* Return "current" architecture.  If the target is running, this is the
 147    architecture of the selected frame.  Otherwise, the "current" architecture
 148    defaults to the target architecture.
 149
 150    This function should normally be called solely by the command interpreter
 151    routines to determine the architecture to execute a command in.  */
 152 extern struct gdbarch *get_current_arch (void);
 153
 154 extern int default_has_shared_address_space (struct gdbarch *);
 155
 156 extern int default_fast_tracepoint_valid_at (struct gdbarch *gdbarch,
 157                                              CORE_ADDR addr,
 158                                              int *isize, char **msg);
 159
 160 extern void default_remote_breakpoint_from_pc (struct gdbarch *,
 161                                                CORE_ADDR *pcptr, int *kindptr);
 162
 163 extern void default_gen_return_address (struct gdbarch *gdbarch,
 164                                         struct agent_expr *ax,
 165                                         struct axs_value *value,
 166                                         CORE_ADDR scope);
 167
 168 extern const char *default_auto_charset (void);
 169 extern const char *default_auto_wide_charset (void);
 170
 171 extern int default_return_in_first_hidden_param_p (struct gdbarch *,
 172                                                    struct type *);
 173
 174 extern int default_insn_is_call (struct gdbarch *, CORE_ADDR);
 175 extern int default_insn_is_ret (struct gdbarch *, CORE_ADDR);
 176 extern int default_insn_is_jump (struct gdbarch *, CORE_ADDR);
 177
 178 /* Do-nothing version of vsyscall_range.  Returns false.  */
 179
 180 extern int default_vsyscall_range (struct gdbarch *gdbarch, struct mem_range *range);
 181 #endif