gdb: Add guess_tracepoint_registers hook to gdbarch.

[deliverable/binutils-gdb.git] / gdb / arch-utils.h

diff --git a/gdb/arch-utils.h b/gdb/arch-utils.h
index 8fce25236feb994c7c4b8e50d87c15ff5a8843a3..9e1e70ea5e7cabc9268cbf71f595b6529ca91524 100644 (file)
--- a/gdb/arch-utils.h
+++ b/gdb/arch-utils.h
@@ -1,12 +1,12 @@
 /* Dynamic architecture support for GDB, the GNU debugger.
 
 /* Dynamic architecture support for GDB, the GNU debugger.
 

-   Copyright 1998, 1999, 2000, 2002 Free Software Foundation, Inc.
+   Copyright (C) 1998-2016 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
 
    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,
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,


@@ -15,9 +15,7 @@
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    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 GDBARCH_UTILS_H
 #define GDBARCH_UTILS_H


@@ -28,150 +26,186 @@ struct minimal_symbol;
 struct type;
 struct gdbarch_info;
 
 struct type;
 struct gdbarch_info;
 

-/* gdbarch trace variable */
-extern int gdbarch_debug;
+/* An implementation of gdbarch_displaced_step_copy_insn for
+   processors that don't need to modify the instruction before
+   single-stepping the displaced copy.
+
+   Simply copy gdbarch_max_insn_length (ARCH) bytes from FROM to TO.
+   The closure is an array of that many bytes containing the
+   instruction's bytes, allocated with xmalloc.  */
+extern struct displaced_step_closure *
+  simple_displaced_step_copy_insn (struct gdbarch *gdbarch,
+                                   CORE_ADDR from, CORE_ADDR to,
+                                   struct regcache *regs);
+
+/* Simple implementation of gdbarch_displaced_step_free_closure: Call
+   xfree.
+   This is appropriate for use with simple_displaced_step_copy_insn.  */
+extern void
+  simple_displaced_step_free_closure (struct gdbarch *gdbarch,
+                                      struct displaced_step_closure *closure);
+
+/* 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);

 
 

-/* Fallback for register convertible. */
-extern gdbarch_deprecated_register_convertible_ftype deprecated_register_convertible_not;
+/* Identity functions on a CORE_ADDR.  Just return the "addr".  */

 
 

-extern CORE_ADDR generic_cannot_extract_struct_value_address (char *dummy);
+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;

 
 

-/* Implementation of extract return value that grubs around in the
-   register cache.  */
-extern gdbarch_extract_return_value_ftype legacy_extract_return_value;
+/* No-op conversion of reg to regnum.  */

 
 

-/* Implementation of store return value that grubs the register cache.  */
-extern gdbarch_store_return_value_ftype legacy_store_return_value;
+extern int no_op_reg_to_regnum (struct gdbarch *gdbarch, int reg);

 
 

-/* 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;
+/* Do nothing version of coff_make_msymbol_special.  */

 
 

-/* Frameless functions not identifable. */
-extern gdbarch_frameless_function_invocation_ftype generic_frameless_function_invocation_not;
+void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);

 
 

-/* 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;
+/* Do nothing default implementation of gdbarch_make_symbol_special.  */

 
 

-/* Map onto old REGISTER_NAMES. */
-extern const char *legacy_register_name (int i);
+void default_make_symbol_special (struct symbol *sym, struct objfile *objfile);

 
 

-/* Accessor for old global function pointer for disassembly. */
-extern int legacy_print_insn (bfd_vma vma, disassemble_info *info);
+/* Do nothing default implementation of gdbarch_adjust_dwarf2_addr.  */

 
 

-/* Backward compatible call_dummy_words. */
-extern LONGEST legacy_call_dummy_words[];
-extern int legacy_sizeof_call_dummy_words;
+CORE_ADDR default_adjust_dwarf2_addr (CORE_ADDR pc);

 
 

-/* Typical remote_translate_xfer_address */
-extern gdbarch_remote_translate_xfer_address_ftype generic_remote_translate_xfer_address;
+/* Do nothing default implementation of gdbarch_adjust_dwarf2_line.  */

 
 

-/* 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;
+CORE_ADDR default_adjust_dwarf2_line (CORE_ADDR addr, int rel);

 
 

-/* 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);
-
-/* 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. */
+extern CORE_ADDR generic_skip_trampoline_code (struct frame_info *frame,
+                                              CORE_ADDR pc);

 
 

-extern int (*target_architecture_hook) (const struct bfd_arch_info *);
+extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
+                                             CORE_ADDR pc);

 
 

-/* Identity function on a CORE_ADDR.  Just returns its parameter.  */
+extern int generic_in_solib_return_trampoline (struct gdbarch *gdbarch,
+                                              CORE_ADDR pc, const char *name);

 
 

-extern CORE_ADDR core_addr_identity (CORE_ADDR addr);
+extern int generic_stack_frame_destroyed_p (struct gdbarch *gdbarch,
+                                           CORE_ADDR pc);

 
 

-/* No-op conversion of reg to regnum. */
+/* By default, registers are not convertible.  */
+extern int generic_convert_register_p (struct gdbarch *gdbarch, int regnum,
+                                      struct type *type);

 
 

-extern int no_op_reg_to_regnum (int reg);
+extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
+                                           struct type *type);

 
 

-/* Default prepare_to_procced. */
+extern int generic_instruction_nullified (struct gdbarch *gdbarch,
+                                         struct regcache *regcache);

 
 

-extern int default_prepare_to_proceed (int select_it);
+int default_remote_register_number (struct gdbarch *gdbarch,
+                                   int regno);

 
 

-extern int generic_prepare_to_proceed (int select_it);
+/* For compatibility with older architectures, returns
+   (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
+   name.  */

 
 

-/* Versions of init_frame_pc().  Do nothing; do the default. */
+extern int legacy_register_sim_regno (struct gdbarch *gdbarch, int regnum);

 
 

-extern CORE_ADDR init_frame_pc_noop (int fromleaf, struct frame_info *prev);
+/* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
+   order was explicitly selected.  */
+extern enum bfd_endian selected_byte_order (void);

 
 

-extern CORE_ADDR init_frame_pc_default (int fromleaf, struct frame_info *prev);
+/* 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 elf_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_elf_make_msymbol_special (asymbol *sym, struct minimal_symbol *msym);
+extern void gdbarch_info_init (struct gdbarch_info *info);

 
 

-/* Do nothing version of coff_make_msymbol_special. */
+/* 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);

 
 

-void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
+/* Return the architecture for ABFD.  If no suitable architecture
+   could be find, return NULL.  */

 
 

-/* Version of cannot_fetch_register() / cannot_store_register() that
-   always fails. */
+extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);

 
 

-int cannot_register_not (int regnum);
+/* 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.

 
 

-/* Legacy version of target_virtual_frame_pointer().  Assumes that
-   there is an DEPRECATED_FP_REGNUM and that it is the same, cooked or
-   raw.  */
+   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 gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
+extern int default_has_shared_address_space (struct gdbarch *);

 
 

-extern CORE_ADDR generic_skip_trampoline_code (CORE_ADDR pc);
+extern int default_fast_tracepoint_valid_at (struct gdbarch *gdbarch,
+                                            CORE_ADDR addr, char **msg);

 
 

-extern int generic_in_solib_call_trampoline (CORE_ADDR pc, char *name);
+extern void default_remote_breakpoint_from_pc (struct gdbarch *,
+                                              CORE_ADDR *pcptr, int *kindptr);

 
 

-extern int generic_in_solib_return_trampoline (CORE_ADDR pc, char *name);
+extern void default_gen_return_address (struct gdbarch *gdbarch,
+                                       struct agent_expr *ax,
+                                       struct axs_value *value,
+                                       CORE_ADDR scope);

 
 

-extern int generic_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR pc);
+extern const char *default_auto_charset (void);
+extern const char *default_auto_wide_charset (void);

 
 

-/* Assume that the world is sane, a registers raw and virtual size
-   both match its type.  */
+extern int default_return_in_first_hidden_param_p (struct gdbarch *,
+                                                  struct type *);

 
 

-extern int generic_register_size (int regnum);
+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);

 
 

-/* Assume that the world is sane, the registers are all adjacent.  */
-extern int generic_register_byte (int regnum);
+/* Do-nothing version of vsyscall_range.  Returns false.  */

 
 

-/* Prop up old targets that use various IN_SIGTRAMP() macros.  */
-extern int legacy_pc_in_sigtramp (CORE_ADDR pc, char *name);
+extern int default_vsyscall_range (struct gdbarch *gdbarch, struct mem_range *range);

 
 

-/* 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);
+/* 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);

 
 

-/* For compatibility with older architectures, returns
-   (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
-   name.  */
+/* 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 int legacy_register_sim_regno (int regnum);
+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);

 
 

-/* 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);
+extern void default_guess_tracepoint_registers (struct gdbarch *gdbarch,
+                                               struct regcache *regcache,
+                                               CORE_ADDR addr);

 
 #endif
 
 #endif