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