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