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