Don't include gdbarch.h from defs.h
[deliverable/binutils-gdb.git] / gdb / arch-utils.h
index 8fce25236feb994c7c4b8e50d87c15ff5a8843a3..588e7c07624618652f43fe817b43d85948ed2b0c 100644 (file)
@@ -1,12 +1,12 @@
 /* Dynamic architecture support for GDB, the GNU debugger.
 
-   Copyright 1998, 1999, 2000, 2002 Free Software Foundation, Inc.
+   Copyright (C) 1998-2019 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
-#ifndef GDBARCH_UTILS_H
-#define GDBARCH_UTILS_H
+#ifndef ARCH_UTILS_H
+#define ARCH_UTILS_H
+
+#include "gdbarch.h"
 
-struct gdbarch;
 struct frame_info;
 struct minimal_symbol;
 struct type;
 struct gdbarch_info;
+struct dwarf2_frame_state;
+
+template <size_t bp_size, const gdb_byte *break_insn>
+struct bp_manipulation
+{
+  static int
+  kind_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr)
+  {
+    return bp_size;
+  }
+
+  static const gdb_byte *
+  bp_from_kind (struct gdbarch *gdbarch, int kind, int *size)
+  {
+    *size = kind;
+    return break_insn;
+  }
+};
+
+template <size_t bp_size,
+         const gdb_byte *break_insn_little,
+         const gdb_byte *break_insn_big>
+struct bp_manipulation_endian
+{
+  static int
+  kind_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr)
+  {
+    return bp_size;
+  }
+
+  static const gdb_byte *
+  bp_from_kind (struct gdbarch *gdbarch, int kind, int *size)
+  {
+    *size = kind;
+    if (gdbarch_byte_order (gdbarch) == BFD_ENDIAN_BIG)
+      return break_insn_big;
+    else
+      return break_insn_little;
+  }
+};
+
+#define BP_MANIPULATION(BREAK_INSN) \
+  bp_manipulation<sizeof (BREAK_INSN), BREAK_INSN>
+
+#define BP_MANIPULATION_ENDIAN(BREAK_INSN_LITTLE, BREAK_INSN_BIG) \
+  bp_manipulation_endian<sizeof (BREAK_INSN_LITTLE),             \
+  BREAK_INSN_LITTLE, BREAK_INSN_BIG>
+
+/* Default implementation of gdbarch_displaced_hw_singlestep.  */
+extern int
+  default_displaced_step_hw_singlestep (struct gdbarch *,
+                                       struct displaced_step_closure *);
+
+/* Possible value for gdbarch_displaced_step_location:
+   Place displaced instructions at the program's entry point,
+   leaving space for inferior function call return breakpoints.  */
+extern CORE_ADDR displaced_step_at_entry_point (struct gdbarch *gdbarch);
+
+/* The only possible cases for inner_than.  */
+extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
+extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
 
-/* gdbarch trace variable */
-extern int gdbarch_debug;
+/* Identity functions on a CORE_ADDR.  Just return the "addr".  */
 
-/* Fallback for register convertible. */
-extern gdbarch_deprecated_register_convertible_ftype deprecated_register_convertible_not;
+extern CORE_ADDR core_addr_identity (struct gdbarch *gdbarch, CORE_ADDR addr);
+extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
 
-extern CORE_ADDR generic_cannot_extract_struct_value_address (char *dummy);
+/* No-op conversion of reg to regnum.  */
 
-/* Implementation of extract return value that grubs around in the
-   register cache.  */
-extern gdbarch_extract_return_value_ftype legacy_extract_return_value;
+extern int no_op_reg_to_regnum (struct gdbarch *gdbarch, int reg);
 
-/* Implementation of store return value that grubs the register cache.  */
-extern gdbarch_store_return_value_ftype legacy_store_return_value;
+/* Do nothing version of coff_make_msymbol_special.  */
 
-/* To return any structure or union type by value, store it at the
-   address passed as an invisible first argument to the function.  */
-extern gdbarch_use_struct_convention_ftype always_use_struct_convention;
+void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
 
-/* Frameless functions not identifable. */
-extern gdbarch_frameless_function_invocation_ftype generic_frameless_function_invocation_not;
+/* Do nothing default implementation of gdbarch_make_symbol_special.  */
 
-/* Only structures, unions, and arrays are returned using the struct
-   convention.  Note that arrays are never passed by value in the C
-   language family, so that case is irrelevant for C.  */
-extern gdbarch_return_value_on_stack_ftype generic_return_value_on_stack_not;
+void default_make_symbol_special (struct symbol *sym, struct objfile *objfile);
 
-/* Map onto old REGISTER_NAMES. */
-extern const char *legacy_register_name (int i);
+/* Do nothing default implementation of gdbarch_adjust_dwarf2_addr.  */
 
-/* Accessor for old global function pointer for disassembly. */
-extern int legacy_print_insn (bfd_vma vma, disassemble_info *info);
+CORE_ADDR default_adjust_dwarf2_addr (CORE_ADDR pc);
 
-/* Backward compatible call_dummy_words. */
-extern LONGEST legacy_call_dummy_words[];
-extern int legacy_sizeof_call_dummy_words;
+/* Do nothing default implementation of gdbarch_adjust_dwarf2_line.  */
 
-/* Typical remote_translate_xfer_address */
-extern gdbarch_remote_translate_xfer_address_ftype generic_remote_translate_xfer_address;
+CORE_ADDR default_adjust_dwarf2_line (CORE_ADDR addr, int rel);
 
-/* Generic implementation of prologue_frameless_p.  Just calls
-   SKIP_PROLOG and checks the return value to see if it actually
-   changed. */
-extern gdbarch_prologue_frameless_p_ftype generic_prologue_frameless_p;
+/* Default DWARF vendor CFI handler.  */
 
-/* The only possible cases for inner_than. */
-extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
-extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
+bool default_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdb_byte op,
+                                         struct dwarf2_frame_state *fs);
 
-/* Floating point values. */
-extern const struct floatformat *default_float_format (struct gdbarch *gdbarch);
-extern const struct floatformat *default_double_format (struct gdbarch *gdbarch);
+/* Version of cannot_fetch_register() / cannot_store_register() that
+   always fails.  */
 
-/* The following DEPRECATED interfaces are for pre- multi-arch legacy
-   targets. */
+int cannot_register_not (struct gdbarch *gdbarch, int regnum);
 
-/* DEPRECATED pre- multi-arch interface.  Explicitly set the dynamic
-   target-system-dependent parameters based on bfd_architecture and
-   machine.  This function is deprecated, use
-   set_gdbarch_from_arch_machine(). */
+/* Legacy version of target_virtual_frame_pointer().  Assumes that
+   there is an gdbarch_deprecated_fp_regnum and that it is the same, cooked or
+   raw.  */
 
-extern void set_architecture_from_arch_mach (enum bfd_architecture, unsigned long);
+extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
 
-/* DEPRECATED pre- multi-arch interface.  Notify the target dependent
-   backend of a change to the selected architecture. A zero return
-   status indicates that the target did not like the change. */
+/* Default implementation of gdbarch_floatformat_for_type.  */
+extern const struct floatformat **
+  default_floatformat_for_type (struct gdbarch *gdbarch,
+                               const char *name, int len);
 
-extern int (*target_architecture_hook) (const struct bfd_arch_info *);
+extern CORE_ADDR generic_skip_trampoline_code (struct frame_info *frame,
+                                              CORE_ADDR pc);
 
-/* Identity function on a CORE_ADDR.  Just returns its parameter.  */
+extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
+                                             CORE_ADDR pc);
 
-extern CORE_ADDR core_addr_identity (CORE_ADDR addr);
+extern int generic_in_solib_return_trampoline (struct gdbarch *gdbarch,
+                                              CORE_ADDR pc, const char *name);
 
-/* No-op conversion of reg to regnum. */
+extern int generic_stack_frame_destroyed_p (struct gdbarch *gdbarch,
+                                           CORE_ADDR pc);
 
-extern int no_op_reg_to_regnum (int reg);
+extern int default_code_of_frame_writable (struct gdbarch *gdbarch,
+                                          struct frame_info *frame);
 
-/* Default prepare_to_procced. */
+/* By default, registers are not convertible.  */
+extern int generic_convert_register_p (struct gdbarch *gdbarch, int regnum,
+                                      struct type *type);
 
-extern int default_prepare_to_proceed (int select_it);
+extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
+                                           struct type *type);
 
-extern int generic_prepare_to_proceed (int select_it);
+extern int generic_instruction_nullified (struct gdbarch *gdbarch,
+                                         struct regcache *regcache);
 
-/* Versions of init_frame_pc().  Do nothing; do the default. */
+int default_remote_register_number (struct gdbarch *gdbarch,
+                                   int regno);
 
-extern CORE_ADDR init_frame_pc_noop (int fromleaf, struct frame_info *prev);
+/* For compatibility with older architectures, returns
+   (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
+   name.  */
 
-extern CORE_ADDR init_frame_pc_default (int fromleaf, struct frame_info *prev);
+extern int legacy_register_sim_regno (struct gdbarch *gdbarch, int regnum);
 
-/* Do nothing version of elf_make_msymbol_special. */
+/* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
+   order was explicitly selected.  */
+extern enum bfd_endian selected_byte_order (void);
 
-void default_elf_make_msymbol_special (asymbol *sym, struct minimal_symbol *msym);
+/* Return the selected architecture's name, or NULL if no architecture
+   was explicitly selected.  */
+extern const char *selected_architecture_name (void);
 
-/* Do nothing version of coff_make_msymbol_special. */
+/* Initialize a ``struct info''.  Can't use memset(0) since some
+   default values are not zero.  "fill" takes all available
+   information and fills in any unspecified fields.  */
 
-void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
+extern void gdbarch_info_init (struct gdbarch_info *info);
 
-/* Version of cannot_fetch_register() / cannot_store_register() that
-   always fails. */
+/* Similar to init, but this time fill in the blanks.  Information is
+   obtained from the global "set ..." options and explicitly
+   initialized INFO fields.  */
+extern void gdbarch_info_fill (struct gdbarch_info *info);
 
-int cannot_register_not (int regnum);
+/* Return the architecture for ABFD.  If no suitable architecture
+   could be find, return NULL.  */
 
-/* Legacy version of target_virtual_frame_pointer().  Assumes that
-   there is an DEPRECATED_FP_REGNUM and that it is the same, cooked or
-   raw.  */
+extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
 
-extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
+/* Return "current" architecture.  If the target is running, this is the
+   architecture of the selected frame.  Otherwise, the "current" architecture
+   defaults to the target architecture.
 
-extern CORE_ADDR generic_skip_trampoline_code (CORE_ADDR pc);
+   This function should normally be called solely by the command interpreter
+   routines to determine the architecture to execute a command in.  */
+extern struct gdbarch *get_current_arch (void);
 
-extern int generic_in_solib_call_trampoline (CORE_ADDR pc, char *name);
+extern int default_has_shared_address_space (struct gdbarch *);
 
-extern int generic_in_solib_return_trampoline (CORE_ADDR pc, char *name);
+extern int default_fast_tracepoint_valid_at (struct gdbarch *gdbarch,
+                                            CORE_ADDR addr, std::string *msg);
 
-extern int generic_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR pc);
+extern const gdb_byte *default_breakpoint_from_pc (struct gdbarch *gdbarch,
+                                                  CORE_ADDR *pcptr,
+                                                  int *lenptr);
 
-/* Assume that the world is sane, a registers raw and virtual size
-   both match its type.  */
+extern int default_breakpoint_kind_from_current_state (struct gdbarch *gdbarch,
+                                                      struct regcache *regcache,
+                                                      CORE_ADDR *pcptr);
 
-extern int generic_register_size (int regnum);
+extern void default_gen_return_address (struct gdbarch *gdbarch,
+                                       struct agent_expr *ax,
+                                       struct axs_value *value,
+                                       CORE_ADDR scope);
 
-/* Assume that the world is sane, the registers are all adjacent.  */
-extern int generic_register_byte (int regnum);
+extern const char *default_auto_charset (void);
+extern const char *default_auto_wide_charset (void);
 
-/* Prop up old targets that use various IN_SIGTRAMP() macros.  */
-extern int legacy_pc_in_sigtramp (CORE_ADDR pc, char *name);
+extern int default_return_in_first_hidden_param_p (struct gdbarch *,
+                                                  struct type *);
 
-/* The orginal register_convert*() functions were overloaded.  They
-   were used to both: convert between virtual and raw register formats
-   (something that is discouraged); and to convert a register to the
-   type of a corresponding variable.  These legacy functions preserve
-   that overloaded behavour in existing targets.  */
-extern int legacy_convert_register_p (int regnum);
-extern void legacy_register_to_value (int regnum, struct type *type, char *from, char *to);
-extern void legacy_value_to_register (struct type *type, int regnum, char *from, char *to);
+extern int default_insn_is_call (struct gdbarch *, CORE_ADDR);
+extern int default_insn_is_ret (struct gdbarch *, CORE_ADDR);
+extern int default_insn_is_jump (struct gdbarch *, CORE_ADDR);
 
-/* For compatibility with older architectures, returns
-   (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
-   name.  */
+/* Do-nothing version of vsyscall_range.  Returns false.  */
 
-extern int legacy_register_sim_regno (int regnum);
+extern int default_vsyscall_range (struct gdbarch *gdbarch, struct mem_range *range);
 
-/* Initialize a ``struct info''.  Can't use memset(0) since some
-   default values are not zero.  */
-extern void gdbarch_info_init (struct gdbarch_info *info);
+/* Default way to advance the PC to the next instruction in order to
+   skip a permanent breakpoint.  Increments the PC by the size of a
+   software breakpoint instruction, as determined with
+   gdbarch_breakpoint_from_pc.  This matches how the breakpoints
+   module determines whether a breakpoint is permanent.  */
+extern void default_skip_permanent_breakpoint (struct regcache *regcache);
+
+/* Symbols for gdbarch_infcall_mmap; their Linux PROT_* system
+   definitions would be dependent on compilation host.  */
+#define GDB_MMAP_PROT_READ     0x1     /* Page can be read.  */
+#define GDB_MMAP_PROT_WRITE    0x2     /* Page can be written.  */
+#define GDB_MMAP_PROT_EXEC     0x4     /* Page can be executed.  */
+
+extern CORE_ADDR default_infcall_mmap (CORE_ADDR size, unsigned prot);
+extern void default_infcall_munmap (CORE_ADDR addr, CORE_ADDR size);
+extern char *default_gcc_target_options (struct gdbarch *gdbarch);
+extern const char *default_gnu_triplet_regexp (struct gdbarch *gdbarch);
+extern int default_addressable_memory_unit_size (struct gdbarch *gdbarch);
+
+extern void default_guess_tracepoint_registers (struct gdbarch *gdbarch,
+                                               struct regcache *regcache,
+                                               CORE_ADDR addr);
+
+extern int default_print_insn (bfd_vma memaddr, disassemble_info *info);
+
+/* Wrapper to gdbarch_skip_prologue, but doesn't throw exception.  Catch
+   exception thrown from gdbarch_skip_prologue, and return PC.  */
+
+extern CORE_ADDR gdbarch_skip_prologue_noexcept (gdbarch *gdbarch,
+                                                CORE_ADDR pc) noexcept;
+
+/* Default implementation of gdbarch_in_indirect_branch_thunk that returns
+   false.  */
+extern bool default_in_indirect_branch_thunk (gdbarch *gdbarch,
+                                             CORE_ADDR pc);
+
+/* Default implementation of gdbarch type_align method.  */
+extern ULONGEST default_type_align (struct gdbarch *gdbarch,
+                                   struct type *type);
 
-#endif
+#endif /* ARCH_UTILS_H */
This page took 0.029727 seconds and 4 git commands to generate.