gdb/arch-utils.h

   1 /* Dynamic architecture support for GDB, the GNU debugger.
   2
   3    Copyright (C) 1998-2000, 2002-2004, 2007-2012 Free Software
   4    Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef GDBARCH_UTILS_H
  22 #define GDBARCH_UTILS_H
  23
  24 struct gdbarch;
  25 struct frame_info;
  26 struct minimal_symbol;
  27 struct type;
  28 struct gdbarch_info;
  29
  30 /* An implementation of gdbarch_displaced_step_copy_insn for
  31    processors that don't need to modify the instruction before
  32    single-stepping the displaced copy.
  33
  34    Simply copy gdbarch_max_insn_length (ARCH) bytes from FROM to TO.
  35    The closure is an array of that many bytes containing the
  36    instruction's bytes, allocated with xmalloc.  */
  37 extern struct displaced_step_closure *
  38   simple_displaced_step_copy_insn (struct gdbarch *gdbarch,
  39                                    CORE_ADDR from, CORE_ADDR to,
  40                                    struct regcache *regs);
  41
  42 /* Simple implementation of gdbarch_displaced_step_free_closure: Call
  43    xfree.
  44    This is appropriate for use with simple_displaced_step_copy_insn.  */
  45 extern void
  46   simple_displaced_step_free_closure (struct gdbarch *gdbarch,
  47                                       struct displaced_step_closure *closure);
  48
  49 /* Default implementation of gdbarch_displaced_hw_singlestep.  */
  50 extern int
  51   default_displaced_step_hw_singlestep (struct gdbarch *,
  52                                         struct displaced_step_closure *);
  53
  54 /* Possible value for gdbarch_displaced_step_location:
  55    Place displaced instructions at the program's entry point,
  56    leaving space for inferior function call return breakpoints.  */
  57 extern CORE_ADDR displaced_step_at_entry_point (struct gdbarch *gdbarch);
  58
  59 /* The only possible cases for inner_than.  */
  60 extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
  61 extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
  62
  63 /* Identity functions on a CORE_ADDR.  Just return the "addr".  */
  64
  65 extern CORE_ADDR core_addr_identity (struct gdbarch *gdbarch, CORE_ADDR addr);
  66 extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
  67
  68 /* No-op conversion of reg to regnum.  */
  69
  70 extern int no_op_reg_to_regnum (struct gdbarch *gdbarch, int reg);
  71
  72 /* Do nothing version of elf_make_msymbol_special.  */
  73
  74 void default_elf_make_msymbol_special (asymbol *sym,
  75                                        struct minimal_symbol *msym);
  76
  77 /* Do nothing version of coff_make_msymbol_special.  */
  78
  79 void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
  80
  81 /* Version of cannot_fetch_register() / cannot_store_register() that
  82    always fails.  */
  83
  84 int cannot_register_not (struct gdbarch *gdbarch, int regnum);
  85
  86 /* Legacy version of target_virtual_frame_pointer().  Assumes that
  87    there is an gdbarch_deprecated_fp_regnum and that it is the same, cooked or
  88    raw.  */
  89
  90 extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
  91
  92 extern CORE_ADDR generic_skip_trampoline_code (struct frame_info *frame,
  93                                                CORE_ADDR pc);
  94
  95 extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
  96                                               CORE_ADDR pc);
  97
  98 extern int generic_in_solib_return_trampoline (struct gdbarch *gdbarch,
  99                                                CORE_ADDR pc, const char *name);
 100
 101 extern int generic_in_function_epilogue_p (struct gdbarch *gdbarch,
 102                                            CORE_ADDR pc);
 103
 104 /* By default, registers are not convertible.  */
 105 extern int generic_convert_register_p (struct gdbarch *gdbarch, int regnum,
 106                                        struct type *type);
 107
 108 extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
 109                                             struct type *type);
 110
 111 extern int generic_instruction_nullified (struct gdbarch *gdbarch,
 112                                           struct regcache *regcache);
 113
 114 int default_remote_register_number (struct gdbarch *gdbarch,
 115                                     int regno);
 116
 117 /* For compatibility with older architectures, returns
 118    (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
 119    name.  */
 120
 121 extern int legacy_register_sim_regno (struct gdbarch *gdbarch, int regnum);
 122
 123 /* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
 124    order was explicitly selected.  */
 125 extern enum bfd_endian selected_byte_order (void);
 126
 127 /* Return the selected architecture's name, or NULL if no architecture
 128    was explicitly selected.  */
 129 extern const char *selected_architecture_name (void);
 130
 131 /* Initialize a ``struct info''.  Can't use memset(0) since some
 132    default values are not zero.  "fill" takes all available
 133    information and fills in any unspecified fields.  */
 134
 135 extern void gdbarch_info_init (struct gdbarch_info *info);
 136
 137 /* Similar to init, but this time fill in the blanks.  Information is
 138    obtained from the global "set ..." options and explicitly
 139    initialized INFO fields.  */
 140 extern void gdbarch_info_fill (struct gdbarch_info *info);
 141
 142 /* Return the architecture for ABFD.  If no suitable architecture
 143    could be find, return NULL.  */
 144
 145 extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
 146
 147 /* Return "current" architecture.  If the target is running, this is the
 148    architecture of the selected frame.  Otherwise, the "current" architecture
 149    defaults to the target architecture.
 150
 151    This function should normally be called solely by the command interpreter
 152    routines to determine the architecture to execute a command in.  */
 153 extern struct gdbarch *get_current_arch (void);
 154
 155 extern int default_has_shared_address_space (struct gdbarch *);
 156
 157 extern int default_fast_tracepoint_valid_at (struct gdbarch *gdbarch,
 158                                              CORE_ADDR addr,
 159                                              int *isize, char **msg);
 160
 161 extern void default_remote_breakpoint_from_pc (struct gdbarch *,
 162                                                CORE_ADDR *pcptr, int *kindptr);
 163
 164 extern void default_gen_return_address (struct gdbarch *gdbarch,
 165                                         struct agent_expr *ax,
 166                                         struct axs_value *value,
 167                                         CORE_ADDR scope);
 168
 169 extern const char *default_auto_charset (void);
 170 extern const char *default_auto_wide_charset (void);
 171
 172 extern int default_return_in_first_hidden_param_p (struct gdbarch *,
 173                                                    struct type *);
 174 #endif