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 /* Default implementation of gdbarch_memtag_to_string.  */
 136 extern std::string default_memtag_to_string (struct gdbarch *gdbarch,
 137                                              struct value *tag);
 138
 139 /* Default implementation of gdbarch_tagged_address_p.  */
 140 bool default_tagged_address_p (struct gdbarch *gdbarch, struct value *address);
 141
 142 /* Default implementation of gdbarch_memtag_matches_p.  */
 143 extern bool default_memtag_matches_p (struct gdbarch *gdbarch,
 144                                        struct value *address);
 145
 146 /* Default implementation of gdbarch_set_memtags.  */
 147 bool default_set_memtags (struct gdbarch *gdbarch,
 148                           struct value *address, size_t length,
 149                           const gdb::byte_vector &tags,
 150                           memtag_type tag_type);
 151
 152 /* Default implementation of gdbarch_get_memtag.  */
 153 struct value *default_get_memtag (struct gdbarch *gdbarch,
 154                                   struct value *address,
 155                                   memtag_type tag_type);
 156
 157 extern CORE_ADDR generic_skip_trampoline_code (struct frame_info *frame,
 158                                                CORE_ADDR pc);
 159
 160 extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
 161                                               CORE_ADDR pc);
 162
 163 extern int generic_in_solib_return_trampoline (struct gdbarch *gdbarch,
 164                                                CORE_ADDR pc, const char *name);
 165
 166 extern int generic_stack_frame_destroyed_p (struct gdbarch *gdbarch,
 167                                             CORE_ADDR pc);
 168
 169 extern int default_code_of_frame_writable (struct gdbarch *gdbarch,
 170                                            struct frame_info *frame);
 171
 172 /* By default, registers are not convertible.  */
 173 extern int generic_convert_register_p (struct gdbarch *gdbarch, int regnum,
 174                                        struct type *type);
 175
 176 extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
 177                                             struct type *type);
 178
 179 extern int generic_instruction_nullified (struct gdbarch *gdbarch,
 180                                           struct regcache *regcache);
 181
 182 int default_remote_register_number (struct gdbarch *gdbarch,
 183                                     int regno);
 184
 185 /* For compatibility with older architectures, returns
 186    (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
 187    name.  */
 188
 189 extern int legacy_register_sim_regno (struct gdbarch *gdbarch, int regnum);
 190
 191 /* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
 192    order was explicitly selected.  */
 193 extern enum bfd_endian selected_byte_order (void);
 194
 195 /* Return the selected architecture's name, or NULL if no architecture
 196    was explicitly selected.  */
 197 extern const char *selected_architecture_name (void);
 198
 199 /* Initialize a ``struct info''.  Can't use memset(0) since some
 200    default values are not zero.  "fill" takes all available
 201    information and fills in any unspecified fields.  */
 202
 203 extern void gdbarch_info_init (struct gdbarch_info *info);
 204
 205 /* Similar to init, but this time fill in the blanks.  Information is
 206    obtained from the global "set ..." options and explicitly
 207    initialized INFO fields.  */
 208 extern void gdbarch_info_fill (struct gdbarch_info *info);
 209
 210 /* Return the architecture for ABFD.  If no suitable architecture
 211    could be find, return NULL.  */
 212
 213 extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
 214
 215 /* Return "current" architecture.  If the target is running, this is the
 216    architecture of the selected frame.  Otherwise, the "current" architecture
 217    defaults to the target architecture.
 218
 219    This function should normally be called solely by the command interpreter
 220    routines to determine the architecture to execute a command in.  */
 221 extern struct gdbarch *get_current_arch (void);
 222
 223 extern int default_has_shared_address_space (struct gdbarch *);
 224
 225 extern int default_fast_tracepoint_valid_at (struct gdbarch *gdbarch,
 226                                              CORE_ADDR addr, std::string *msg);
 227
 228 extern const gdb_byte *default_breakpoint_from_pc (struct gdbarch *gdbarch,
 229                                                    CORE_ADDR *pcptr,
 230                                                    int *lenptr);
 231
 232 extern int default_breakpoint_kind_from_current_state (struct gdbarch *gdbarch,
 233                                                        struct regcache *regcache,
 234                                                        CORE_ADDR *pcptr);
 235
 236 extern void default_gen_return_address (struct gdbarch *gdbarch,
 237                                         struct agent_expr *ax,
 238                                         struct axs_value *value,
 239                                         CORE_ADDR scope);
 240
 241 extern const char *default_auto_charset (void);
 242 extern const char *default_auto_wide_charset (void);
 243
 244 extern int default_return_in_first_hidden_param_p (struct gdbarch *,
 245                                                    struct type *);
 246
 247 extern int default_insn_is_call (struct gdbarch *, CORE_ADDR);
 248 extern int default_insn_is_ret (struct gdbarch *, CORE_ADDR);
 249 extern int default_insn_is_jump (struct gdbarch *, CORE_ADDR);
 250
 251 /* Default implementation of gdbarch_program_breakpoint_here_p.  */
 252 extern bool default_program_breakpoint_here_p (struct gdbarch *gdbarch,
 253                                                CORE_ADDR addr);
 254
 255 /* Do-nothing version of vsyscall_range.  Returns false.  */
 256
 257 extern int default_vsyscall_range (struct gdbarch *gdbarch, struct mem_range *range);
 258
 259 /* Default way to advance the PC to the next instruction in order to
 260    skip a permanent breakpoint.  Increments the PC by the size of a
 261    software breakpoint instruction, as determined with
 262    gdbarch_breakpoint_from_pc.  This matches how the breakpoints
 263    module determines whether a breakpoint is permanent.  */
 264 extern void default_skip_permanent_breakpoint (struct regcache *regcache);
 265
 266 /* Symbols for gdbarch_infcall_mmap; their Linux PROT_* system
 267    definitions would be dependent on compilation host.  */
 268 #define GDB_MMAP_PROT_READ      0x1     /* Page can be read.  */
 269 #define GDB_MMAP_PROT_WRITE     0x2     /* Page can be written.  */
 270 #define GDB_MMAP_PROT_EXEC      0x4     /* Page can be executed.  */
 271
 272 extern CORE_ADDR default_infcall_mmap (CORE_ADDR size, unsigned prot);
 273 extern void default_infcall_munmap (CORE_ADDR addr, CORE_ADDR size);
 274 extern std::string default_gcc_target_options (struct gdbarch *gdbarch);
 275 extern const char *default_gnu_triplet_regexp (struct gdbarch *gdbarch);
 276 extern int default_addressable_memory_unit_size (struct gdbarch *gdbarch);
 277
 278 extern void default_guess_tracepoint_registers (struct gdbarch *gdbarch,
 279                                                 struct regcache *regcache,
 280                                                 CORE_ADDR addr);
 281
 282 extern int default_print_insn (bfd_vma memaddr, disassemble_info *info);
 283
 284 /* Wrapper to gdbarch_skip_prologue, but doesn't throw exception.  Catch
 285    exception thrown from gdbarch_skip_prologue, and return PC.  */
 286
 287 extern CORE_ADDR gdbarch_skip_prologue_noexcept (gdbarch *gdbarch,
 288                                                  CORE_ADDR pc) noexcept;
 289
 290 /* Default implementation of gdbarch_in_indirect_branch_thunk that returns
 291    false.  */
 292 extern bool default_in_indirect_branch_thunk (gdbarch *gdbarch,
 293                                               CORE_ADDR pc);
 294
 295 /* Default implementation of gdbarch type_align method.  */
 296 extern ULONGEST default_type_align (struct gdbarch *gdbarch,
 297                                     struct type *type);
 298
 299 /* Default implementation of gdbarch get_pc_address_flags method.  */
 300 extern std::string default_get_pc_address_flags (frame_info *frame,
 301                                                  CORE_ADDR pc);
 302
 303 /* Default implementation of gdbarch read_core_file_mappings method.  */
 304 extern void default_read_core_file_mappings (struct gdbarch *gdbarch,
 305                                              struct bfd *cbfd,
 306                                              gdb::function_view<void (ULONGEST count)>
 307                                                pre_loop_cb,
 308                                              gdb::function_view<void (int num,
 309                                                                       ULONGEST start,
 310                                                                       ULONGEST end,
 311                                                                       ULONGEST file_ofs,
 312                                                                       const char *filename)>
 313                                                loop_cb);
 314 #endif /* ARCH_UTILS_H */