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