gdb/arch-utils.h

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