gdb/arch-utils.h

   1 /* Dynamic architecture support for GDB, the GNU debugger.
   2
   3    Copyright (C) 1998-2017 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 struct dwarf2_frame_state;
  29
  30 template <size_t bp_size, const gdb_byte *break_insn>
  31 struct bp_manipulation
  32 {
  33   static int
  34   kind_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr)
  35   {
  36     return bp_size;
  37   }
  38
  39   static const gdb_byte *
  40   bp_from_kind (struct gdbarch *gdbarch, int kind, int *size)
  41   {
  42     *size = kind;
  43     return break_insn;
  44   }
  45 };
  46
  47 template <size_t bp_size,
  48           const gdb_byte *break_insn_little,
  49           const gdb_byte *break_insn_big>
  50 struct bp_manipulation_endian
  51 {
  52   static int
  53   kind_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr)
  54   {
  55     return bp_size;
  56   }
  57
  58   static const gdb_byte *
  59   bp_from_kind (struct gdbarch *gdbarch, int kind, int *size)
  60   {
  61     *size = kind;
  62     if (gdbarch_byte_order (gdbarch) == BFD_ENDIAN_BIG)
  63       return break_insn_big;
  64     else
  65       return break_insn_little;
  66   }
  67 };
  68
  69 #define BP_MANIPULATION(BREAK_INSN) \
  70   bp_manipulation<sizeof (BREAK_INSN), BREAK_INSN>
  71
  72 #define BP_MANIPULATION_ENDIAN(BREAK_INSN_LITTLE, BREAK_INSN_BIG) \
  73   bp_manipulation_endian<sizeof (BREAK_INSN_LITTLE),              \
  74   BREAK_INSN_LITTLE, BREAK_INSN_BIG>
  75
  76 /* An implementation of gdbarch_displaced_step_copy_insn for
  77    processors that don't need to modify the instruction before
  78    single-stepping the displaced copy.
  79
  80    Simply copy gdbarch_max_insn_length (ARCH) bytes from FROM to TO.
  81    The closure is an array of that many bytes containing the
  82    instruction's bytes, allocated with xmalloc.  */
  83 extern struct displaced_step_closure *
  84   simple_displaced_step_copy_insn (struct gdbarch *gdbarch,
  85                                    CORE_ADDR from, CORE_ADDR to,
  86                                    struct regcache *regs);
  87
  88 /* Default implementation of gdbarch_displaced_hw_singlestep.  */
  89 extern int
  90   default_displaced_step_hw_singlestep (struct gdbarch *,
  91                                         struct displaced_step_closure *);
  92
  93 /* Possible value for gdbarch_displaced_step_location:
  94    Place displaced instructions at the program's entry point,
  95    leaving space for inferior function call return breakpoints.  */
  96 extern CORE_ADDR displaced_step_at_entry_point (struct gdbarch *gdbarch);
  97
  98 /* The only possible cases for inner_than.  */
  99 extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
 100 extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
 101
 102 /* Identity functions on a CORE_ADDR.  Just return the "addr".  */
 103
 104 extern CORE_ADDR core_addr_identity (struct gdbarch *gdbarch, CORE_ADDR addr);
 105 extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
 106
 107 /* No-op conversion of reg to regnum.  */
 108
 109 extern int no_op_reg_to_regnum (struct gdbarch *gdbarch, int reg);
 110
 111 /* Do nothing version of coff_make_msymbol_special.  */
 112
 113 void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
 114
 115 /* Do nothing default implementation of gdbarch_make_symbol_special.  */
 116
 117 void default_make_symbol_special (struct symbol *sym, struct objfile *objfile);
 118
 119 /* Do nothing default implementation of gdbarch_adjust_dwarf2_addr.  */
 120
 121 CORE_ADDR default_adjust_dwarf2_addr (CORE_ADDR pc);
 122
 123 /* Do nothing default implementation of gdbarch_adjust_dwarf2_line.  */
 124
 125 CORE_ADDR default_adjust_dwarf2_line (CORE_ADDR addr, int rel);
 126
 127 /* Default DWARF vendor CFI handler.  */
 128
 129 bool default_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdb_byte op,
 130                                           struct dwarf2_frame_state *fs);
 131
 132 /* Version of cannot_fetch_register() / cannot_store_register() that
 133    always fails.  */
 134
 135 int cannot_register_not (struct gdbarch *gdbarch, int regnum);
 136
 137 /* Legacy version of target_virtual_frame_pointer().  Assumes that
 138    there is an gdbarch_deprecated_fp_regnum and that it is the same, cooked or
 139    raw.  */
 140
 141 extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
 142
 143 /* Default implementation of gdbarch_floatformat_for_type.  */
 144 extern const struct floatformat **
 145   default_floatformat_for_type (struct gdbarch *gdbarch,
 146                                 const char *name, int len);
 147
 148 extern CORE_ADDR generic_skip_trampoline_code (struct frame_info *frame,
 149                                                CORE_ADDR pc);
 150
 151 extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
 152                                               CORE_ADDR pc);
 153
 154 extern int generic_in_solib_return_trampoline (struct gdbarch *gdbarch,
 155                                                CORE_ADDR pc, const char *name);
 156
 157 extern int generic_stack_frame_destroyed_p (struct gdbarch *gdbarch,
 158                                             CORE_ADDR pc);
 159
 160 extern int default_code_of_frame_writable (struct gdbarch *gdbarch,
 161                                            struct frame_info *frame);
 162
 163 /* By default, registers are not convertible.  */
 164 extern int generic_convert_register_p (struct gdbarch *gdbarch, int regnum,
 165                                        struct type *type);
 166
 167 extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
 168                                             struct type *type);
 169
 170 extern int generic_instruction_nullified (struct gdbarch *gdbarch,
 171                                           struct regcache *regcache);
 172
 173 int default_remote_register_number (struct gdbarch *gdbarch,
 174                                     int regno);
 175
 176 /* For compatibility with older architectures, returns
 177    (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
 178    name.  */
 179
 180 extern int legacy_register_sim_regno (struct gdbarch *gdbarch, int regnum);
 181
 182 /* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
 183    order was explicitly selected.  */
 184 extern enum bfd_endian selected_byte_order (void);
 185
 186 /* Return the selected architecture's name, or NULL if no architecture
 187    was explicitly selected.  */
 188 extern const char *selected_architecture_name (void);
 189
 190 /* Initialize a ``struct info''.  Can't use memset(0) since some
 191    default values are not zero.  "fill" takes all available
 192    information and fills in any unspecified fields.  */
 193
 194 extern void gdbarch_info_init (struct gdbarch_info *info);
 195
 196 /* Similar to init, but this time fill in the blanks.  Information is
 197    obtained from the global "set ..." options and explicitly
 198    initialized INFO fields.  */
 199 extern void gdbarch_info_fill (struct gdbarch_info *info);
 200
 201 /* Return the architecture for ABFD.  If no suitable architecture
 202    could be find, return NULL.  */
 203
 204 extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
 205
 206 /* Return "current" architecture.  If the target is running, this is the
 207    architecture of the selected frame.  Otherwise, the "current" architecture
 208    defaults to the target architecture.
 209
 210    This function should normally be called solely by the command interpreter
 211    routines to determine the architecture to execute a command in.  */
 212 extern struct gdbarch *get_current_arch (void);
 213
 214 extern int default_has_shared_address_space (struct gdbarch *);
 215
 216 extern int default_fast_tracepoint_valid_at (struct gdbarch *gdbarch,
 217                                              CORE_ADDR addr, char **msg);
 218
 219 extern const gdb_byte *default_breakpoint_from_pc (struct gdbarch *gdbarch,
 220                                                    CORE_ADDR *pcptr,
 221                                                    int *lenptr);
 222
 223 extern int default_breakpoint_kind_from_current_state (struct gdbarch *gdbarch,
 224                                                        struct regcache *regcache,
 225                                                        CORE_ADDR *pcptr);
 226
 227 extern void default_gen_return_address (struct gdbarch *gdbarch,
 228                                         struct agent_expr *ax,
 229                                         struct axs_value *value,
 230                                         CORE_ADDR scope);
 231
 232 extern const char *default_auto_charset (void);
 233 extern const char *default_auto_wide_charset (void);
 234
 235 extern int default_return_in_first_hidden_param_p (struct gdbarch *,
 236                                                    struct type *);
 237
 238 extern int default_insn_is_call (struct gdbarch *, CORE_ADDR);
 239 extern int default_insn_is_ret (struct gdbarch *, CORE_ADDR);
 240 extern int default_insn_is_jump (struct gdbarch *, CORE_ADDR);
 241
 242 /* Do-nothing version of vsyscall_range.  Returns false.  */
 243
 244 extern int default_vsyscall_range (struct gdbarch *gdbarch, struct mem_range *range);
 245
 246 /* Default way to advance the PC to the next instruction in order to
 247    skip a permanent breakpoint.  Increments the PC by the size of a
 248    software breakpoint instruction, as determined with
 249    gdbarch_breakpoint_from_pc.  This matches how the breakpoints
 250    module determines whether a breakpoint is permanent.  */
 251 extern void default_skip_permanent_breakpoint (struct regcache *regcache);
 252
 253 /* Symbols for gdbarch_infcall_mmap; their Linux PROT_* system
 254    definitions would be dependent on compilation host.  */
 255 #define GDB_MMAP_PROT_READ      0x1     /* Page can be read.  */
 256 #define GDB_MMAP_PROT_WRITE     0x2     /* Page can be written.  */
 257 #define GDB_MMAP_PROT_EXEC      0x4     /* Page can be executed.  */
 258
 259 extern CORE_ADDR default_infcall_mmap (CORE_ADDR size, unsigned prot);
 260 extern void default_infcall_munmap (CORE_ADDR addr, CORE_ADDR size);
 261 extern char *default_gcc_target_options (struct gdbarch *gdbarch);
 262 extern const char *default_gnu_triplet_regexp (struct gdbarch *gdbarch);
 263 extern int default_addressable_memory_unit_size (struct gdbarch *gdbarch);
 264
 265 extern void default_guess_tracepoint_registers (struct gdbarch *gdbarch,
 266                                                 struct regcache *regcache,
 267                                                 CORE_ADDR addr);
 268
 269 extern int default_print_insn (bfd_vma memaddr, disassemble_info *info);
 270
 271 /* Wrapper to gdbarch_skip_prologue, but doesn't throw exception.  Catch
 272    exception thrown from gdbarch_skip_prologue, and return PC.  */
 273
 274 extern CORE_ADDR gdbarch_skip_prologue_noexcept (gdbarch *gdbarch,
 275                                                  CORE_ADDR pc) noexcept;
 276
 277 #endif