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