gdb/arch-utils.h

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