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