gdb/arch-utils.h

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