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

/* Dynamic architecture support for GDB, the GNU debugger.

   Copyright (C) 1998-2018 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 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   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, see <http://www.gnu.org/licenses/>.  */

#ifndef GDBARCH_UTILS_H
#define GDBARCH_UTILS_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);

/* Identity functions on a CORE_ADDR.  Just return the "addr".  */

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;

/* No-op conversion of reg to regnum.  */

extern int no_op_reg_to_regnum (struct gdbarch *gdbarch, int reg);

/* Do nothing version of coff_make_msymbol_special.  */

void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);

/* Do nothing default implementation of gdbarch_make_symbol_special.  */

void default_make_symbol_special (struct symbol *sym, struct objfile *objfile);

/* Do nothing default implementation of gdbarch_adjust_dwarf2_addr.  */

CORE_ADDR default_adjust_dwarf2_addr (CORE_ADDR pc);

/* Do nothing default implementation of gdbarch_adjust_dwarf2_line.  */

CORE_ADDR default_adjust_dwarf2_line (CORE_ADDR addr, int rel);

/* Default DWARF vendor CFI handler.  */

bool default_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdb_byte op,
					  struct dwarf2_frame_state *fs);

/* Version of cannot_fetch_register() / cannot_store_register() that
   always fails.  */

int cannot_register_not (struct gdbarch *gdbarch, int regnum);

/* 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 gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;

/* Default implementation of gdbarch_floatformat_for_type.  */
extern const struct floatformat **
  default_floatformat_for_type (struct gdbarch *gdbarch,
				const char *name, int len);

extern CORE_ADDR generic_skip_trampoline_code (struct frame_info *frame,
					       CORE_ADDR pc);

extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
					      CORE_ADDR pc);

extern int generic_in_solib_return_trampoline (struct gdbarch *gdbarch,
					       CORE_ADDR pc, const char *name);

extern int generic_stack_frame_destroyed_p (struct gdbarch *gdbarch,
					    CORE_ADDR pc);

extern int default_code_of_frame_writable (struct gdbarch *gdbarch,
					   struct frame_info *frame);

/* By default, registers are not convertible.  */
extern int generic_convert_register_p (struct gdbarch *gdbarch, int regnum,
				       struct type *type);

extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
					    struct type *type);

extern int generic_instruction_nullified (struct gdbarch *gdbarch,
					  struct regcache *regcache);

int default_remote_register_number (struct gdbarch *gdbarch,
				    int regno);

/* For compatibility with older architectures, returns
   (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
   name.  */

extern int legacy_register_sim_regno (struct gdbarch *gdbarch, int regnum);

/* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
   order was explicitly selected.  */
extern enum bfd_endian selected_byte_order (void);

/* Return the selected architecture's name, or NULL if no architecture
   was explicitly selected.  */
extern const char *selected_architecture_name (void);

/* 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.  */

extern void gdbarch_info_init (struct gdbarch_info *info);

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

/* Return the architecture for ABFD.  If no suitable architecture
   could be find, return NULL.  */

extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);

/* 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.

   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 default_has_shared_address_space (struct gdbarch *);

extern int default_fast_tracepoint_valid_at (struct gdbarch *gdbarch,
					     CORE_ADDR addr, std::string *msg);

extern const gdb_byte *default_breakpoint_from_pc (struct gdbarch *gdbarch,
						   CORE_ADDR *pcptr,
						   int *lenptr);

extern int default_breakpoint_kind_from_current_state (struct gdbarch *gdbarch,
						       struct regcache *regcache,
						       CORE_ADDR *pcptr);

extern void default_gen_return_address (struct gdbarch *gdbarch,
					struct agent_expr *ax,
					struct axs_value *value,
					CORE_ADDR scope);

extern const char *default_auto_charset (void);
extern const char *default_auto_wide_charset (void);

extern int default_return_in_first_hidden_param_p (struct gdbarch *,
						   struct type *);

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);

/* Do-nothing version of vsyscall_range.  Returns false.  */

extern int default_vsyscall_range (struct gdbarch *gdbarch, struct mem_range *range);

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

#endif
Commit	Line	Data
c0e8c252	1	/* Dynamic architecture support for GDB, the GNU debugger.
d7bd68ca	2
e2882c85	3	Copyright (C) 1998-2018 Free Software Foundation, Inc.
c0e8c252 AC	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
a9762ec7	9	the Free Software Foundation; either version 3 of the License, or
c0e8c252 AC	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
a9762ec7	18	along with this program. If not, see <http://www.gnu.org/licenses/>. */
c0e8c252 AC	19
	20	#ifndef GDBARCH_UTILS_H
	21	#define GDBARCH_UTILS_H
	22
da3331ec AC	23	struct gdbarch;
	24	struct frame_info;
	25	struct minimal_symbol;
	26	struct type;
	27	struct gdbarch_info;
b41c5a85	28	struct dwarf2_frame_state;
da3331ec	29
04180708 YQ	30	template <size_t bp_size, const gdb_byte *break_insn>
	31	struct bp_manipulation
	32	{
	33	static int
	34	kind_from_pc (struct gdbarch gdbarch, CORE_ADDR pcptr)
	35	{
	36	return bp_size;
22f13eb8	37	}
598cc9dc	38
04180708 YQ	39	static const gdb_byte *
	40	bp_from_kind (struct gdbarch gdbarch, int kind, int size)
	41	{
	42	*size = kind;
	43	return break_insn;
22f13eb8	44	}
04180708 YQ	45	};
	46
	47	template <size_t bp_size,
	48	const gdb_byte *break_insn_little,
	49	const gdb_byte *break_insn_big>
	50	struct bp_manipulation_endian
	51	{
	52	static int
	53	kind_from_pc (struct gdbarch gdbarch, CORE_ADDR pcptr)
	54	{
	55	return bp_size;
	56	}
	57
	58	static const gdb_byte *
	59	bp_from_kind (struct gdbarch gdbarch, int kind, int size)
	60	{
	61	*size = kind;
	62	if (gdbarch_byte_order (gdbarch) == BFD_ENDIAN_BIG)
	63	return break_insn_big;
	64	else
	65	return break_insn_little;
	66	}
	67	};
	68
	69	#define BP_MANIPULATION(BREAK_INSN) \
	70	bp_manipulation<sizeof (BREAK_INSN), BREAK_INSN>
	71
	72	#define BP_MANIPULATION_ENDIAN(BREAK_INSN_LITTLE, BREAK_INSN_BIG) \
	73	bp_manipulation_endian<sizeof (BREAK_INSN_LITTLE), \
	74	BREAK_INSN_LITTLE, BREAK_INSN_BIG>
d19280ad	75
99e40580 UW	76	/* Default implementation of gdbarch_displaced_hw_singlestep. */
99e40580 UW	77	extern int
3e43a32a MS	78	default_displaced_step_hw_singlestep (struct gdbarch *,
3e43a32a MS	79	struct displaced_step_closure *);
99e40580	80
237fc4c9 PA	81	/* Possible value for gdbarch_displaced_step_location:
	82	Place displaced instructions at the program's entry point,
	83	leaving space for inferior function call return breakpoints. */
	84	extern CORE_ADDR displaced_step_at_entry_point (struct gdbarch *gdbarch);
	85
0e2de366	86	/* The only possible cases for inner_than. */
3339cf8b AC	87	extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
	88	extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
	89
e2d0e7eb	90	/* Identity functions on a CORE_ADDR. Just return the "addr". */
f517ea4e	91
24568a2c	92	extern CORE_ADDR core_addr_identity (struct gdbarch *gdbarch, CORE_ADDR addr);
e2d0e7eb	93	extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
f517ea4e	94
0e2de366	95	/* No-op conversion of reg to regnum. */
88c72b7d	96
d3f73121	97	extern int no_op_reg_to_regnum (struct gdbarch *gdbarch, int reg);
88c72b7d	98
0e2de366	99	/* Do nothing version of coff_make_msymbol_special. */
a2cf933a EZ	100
	101	void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
	102
3e29f34a MR	103	/* Do nothing default implementation of gdbarch_make_symbol_special. */
	104
	105	void default_make_symbol_special (struct symbol sym, struct objfile objfile);
	106
	107	/* Do nothing default implementation of gdbarch_adjust_dwarf2_addr. */
	108
	109	CORE_ADDR default_adjust_dwarf2_addr (CORE_ADDR pc);
	110
	111	/* Do nothing default implementation of gdbarch_adjust_dwarf2_line. */
	112
	113	CORE_ADDR default_adjust_dwarf2_line (CORE_ADDR addr, int rel);
	114
b41c5a85 JW	115	/* Default DWARF vendor CFI handler. */
	116
	117	bool default_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdb_byte op,
	118	struct dwarf2_frame_state *fs);
	119
01fb7433	120	/* Version of cannot_fetch_register() / cannot_store_register() that
0e2de366	121	always fails. */
01fb7433	122
64a3914f	123	int cannot_register_not (struct gdbarch *gdbarch, int regnum);
01fb7433	124
39d4ef09	125	/* Legacy version of target_virtual_frame_pointer(). Assumes that
064f5156	126	there is an gdbarch_deprecated_fp_regnum and that it is the same, cooked or
0ba6dca9	127	raw. */
39d4ef09 AC	128
	129	extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
	130
9b790ce7 UW	131	/* Default implementation of gdbarch_floatformat_for_type. */
	132	extern const struct floatformat **
	133	default_floatformat_for_type (struct gdbarch *gdbarch,
	134	const char *name, int len);
	135
52f729a7 UW	136	extern CORE_ADDR generic_skip_trampoline_code (struct frame_info *frame,
52f729a7 UW	137	CORE_ADDR pc);
bdcd319a	138
4c8c40e6 MK	139	extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
4c8c40e6 MK	140	CORE_ADDR pc);
dea0c52f	141
e17a4113	142	extern int generic_in_solib_return_trampoline (struct gdbarch *gdbarch,
2c02bd72	143	CORE_ADDR pc, const char *name);
d50355b6	144
c9cf6e20 MG	145	extern int generic_stack_frame_destroyed_p (struct gdbarch *gdbarch,
c9cf6e20 MG	146	CORE_ADDR pc);
c12260ac	147
7eb89530 YQ	148	extern int default_code_of_frame_writable (struct gdbarch *gdbarch,
	149	struct frame_info *frame);
	150
a1f4a1b6	151	/* By default, registers are not convertible. */
76a8ddb9 UW	152	extern int generic_convert_register_p (struct gdbarch *gdbarch, int regnum,
76a8ddb9 UW	153	struct type *type);
13d01224	154
192cb3d4 MK	155	extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
	156	struct type *type);
	157
3ca64954 RC	158	extern int generic_instruction_nullified (struct gdbarch *gdbarch,
	159	struct regcache *regcache);
	160
123dc839 DJ	161	int default_remote_register_number (struct gdbarch *gdbarch,
	162	int regno);
	163
4182591f AC	164	/* For compatibility with older architectures, returns
	165	(LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
	166	name. */
	167
e7faf938	168	extern int legacy_register_sim_regno (struct gdbarch *gdbarch, int regnum);
4182591f	169
b6d373df DJ	170	/* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
	171	order was explicitly selected. */
	172	extern enum bfd_endian selected_byte_order (void);
	173
a8cf2722 AC	174	/* Return the selected architecture's name, or NULL if no architecture
	175	was explicitly selected. */
	176	extern const char *selected_architecture_name (void);
	177
fb6ecb0f	178	/* Initialize a ``struct info''. Can't use memset(0) since some
a8cf2722 AC	179	default values are not zero. "fill" takes all available
	180	information and fills in any unspecified fields. */
	181
fb6ecb0f AC	182	extern void gdbarch_info_init (struct gdbarch_info *info);
fb6ecb0f AC	183
100bcc3f	184	/* Similar to init, but this time fill in the blanks. Information is
7a107747 DJ	185	obtained from the global "set ..." options and explicitly
	186	initialized INFO fields. */
	187	extern void gdbarch_info_fill (struct gdbarch_info *info);
bf922ad9	188
2b026650 MK	189	/* Return the architecture for ABFD. If no suitable architecture
	190	could be find, return NULL. */
	191
	192	extern struct gdbarch gdbarch_from_bfd (bfd abfd);
	193
e17c207e UW	194	/* Return "current" architecture. If the target is running, this is the
	195	architecture of the selected frame. Otherwise, the "current" architecture
	196	defaults to the target architecture.
	197
	198	This function should normally be called solely by the command interpreter
	199	routines to determine the architecture to execute a command in. */
	200	extern struct gdbarch *get_current_arch (void);
	201
6c95b8df PA	202	extern int default_has_shared_address_space (struct gdbarch *);
6c95b8df PA	203
7a697b8d	204	extern int default_fast_tracepoint_valid_at (struct gdbarch *gdbarch,
281d762b	205	CORE_ADDR addr, std::string *msg);
7a697b8d	206
22f13eb8 YQ	207	extern const gdb_byte default_breakpoint_from_pc (struct gdbarch gdbarch,
	208	CORE_ADDR *pcptr,
	209	int *lenptr);
	210
833b7ab5 YQ	211	extern int default_breakpoint_kind_from_current_state (struct gdbarch *gdbarch,
	212	struct regcache *regcache,
	213	CORE_ADDR *pcptr);
	214
6710bf39 SS	215	extern void default_gen_return_address (struct gdbarch *gdbarch,
	216	struct agent_expr *ax,
	217	struct axs_value *value,
	218	CORE_ADDR scope);
	219
f870a310 TT	220	extern const char *default_auto_charset (void);
	221	extern const char *default_auto_wide_charset (void);
	222
18648a37 YQ	223	extern int default_return_in_first_hidden_param_p (struct gdbarch *,
18648a37 YQ	224	struct type *);
c2170eef MM	225
	226	extern int default_insn_is_call (struct gdbarch *, CORE_ADDR);
	227	extern int default_insn_is_ret (struct gdbarch *, CORE_ADDR);
	228	extern int default_insn_is_jump (struct gdbarch *, CORE_ADDR);
3437254d PA	229
	230	/* Do-nothing version of vsyscall_range. Returns false. */
	231
	232	extern int default_vsyscall_range (struct gdbarch gdbarch, struct mem_range range);
ae9bb220 PA	233
	234	/* Default way to advance the PC to the next instruction in order to
	235	skip a permanent breakpoint. Increments the PC by the size of a
	236	software breakpoint instruction, as determined with
	237	gdbarch_breakpoint_from_pc. This matches how the breakpoints
	238	module determines whether a breakpoint is permanent. */
	239	extern void default_skip_permanent_breakpoint (struct regcache *regcache);
	240
f208eee0 JK	241	/* Symbols for gdbarch_infcall_mmap; their Linux PROT_* system
	242	definitions would be dependent on compilation host. */
	243	#define GDB_MMAP_PROT_READ 0x1 /* Page can be read. */
	244	#define GDB_MMAP_PROT_WRITE 0x2 /* Page can be written. */
	245	#define GDB_MMAP_PROT_EXEC 0x4 /* Page can be executed. */
	246
	247	extern CORE_ADDR default_infcall_mmap (CORE_ADDR size, unsigned prot);
7f361056	248	extern void default_infcall_munmap (CORE_ADDR addr, CORE_ADDR size);
f208eee0	249	extern char default_gcc_target_options (struct gdbarch gdbarch);
ac04f72b	250	extern const char default_gnu_triplet_regexp (struct gdbarch gdbarch);
3374165f	251	extern int default_addressable_memory_unit_size (struct gdbarch *gdbarch);
f208eee0	252
5f034a78 MK	253	extern void default_guess_tracepoint_registers (struct gdbarch *gdbarch,
	254	struct regcache *regcache,
	255	CORE_ADDR addr);
	256
39503f82 YQ	257	extern int default_print_insn (bfd_vma memaddr, disassemble_info *info);
39503f82 YQ	258
46a62268 YQ	259	/* Wrapper to gdbarch_skip_prologue, but doesn't throw exception. Catch
	260	exception thrown from gdbarch_skip_prologue, and return PC. */
	261
	262	extern CORE_ADDR gdbarch_skip_prologue_noexcept (gdbarch *gdbarch,
	263	CORE_ADDR pc) noexcept;
	264
1d509aa6 MM	265	/* Default implementation of gdbarch_in_indirect_branch_thunk that returns
	266	false. */
	267	extern bool default_in_indirect_branch_thunk (gdbarch *gdbarch,
	268	CORE_ADDR pc);
	269
c0e8c252	270	#endif