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

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

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

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

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

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

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, char **msg);

extern void default_remote_breakpoint_from_pc (struct gdbarch *,
					       CORE_ADDR *pcptr, int *kindptr);

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

#endif
Commit	Line	Data
c0e8c252	1	/* Dynamic architecture support for GDB, the GNU debugger.
d7bd68ca	2
618f726f	3	Copyright (C) 1998-2016 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;
	28
237fc4c9 PA	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
99e40580 UW	48	/* Default implementation of gdbarch_displaced_hw_singlestep. */
99e40580 UW	49	extern int
3e43a32a MS	50	default_displaced_step_hw_singlestep (struct gdbarch *,
3e43a32a MS	51	struct displaced_step_closure *);
99e40580	52
237fc4c9 PA	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
0e2de366	58	/* The only possible cases for inner_than. */
3339cf8b AC	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
e2d0e7eb	62	/* Identity functions on a CORE_ADDR. Just return the "addr". */
f517ea4e	63
24568a2c	64	extern CORE_ADDR core_addr_identity (struct gdbarch *gdbarch, CORE_ADDR addr);
e2d0e7eb	65	extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
f517ea4e	66
0e2de366	67	/* No-op conversion of reg to regnum. */
88c72b7d	68
d3f73121	69	extern int no_op_reg_to_regnum (struct gdbarch *gdbarch, int reg);
88c72b7d	70
0e2de366	71	/* Do nothing version of coff_make_msymbol_special. */
a2cf933a EZ	72
	73	void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
	74
3e29f34a MR	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
01fb7433	87	/* Version of cannot_fetch_register() / cannot_store_register() that
0e2de366	88	always fails. */
01fb7433	89
64a3914f	90	int cannot_register_not (struct gdbarch *gdbarch, int regnum);
01fb7433	91
39d4ef09	92	/* Legacy version of target_virtual_frame_pointer(). Assumes that
064f5156	93	there is an gdbarch_deprecated_fp_regnum and that it is the same, cooked or
0ba6dca9	94	raw. */
39d4ef09 AC	95
	96	extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
	97
52f729a7 UW	98	extern CORE_ADDR generic_skip_trampoline_code (struct frame_info *frame,
52f729a7 UW	99	CORE_ADDR pc);
bdcd319a	100
4c8c40e6 MK	101	extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
4c8c40e6 MK	102	CORE_ADDR pc);
dea0c52f	103
e17a4113	104	extern int generic_in_solib_return_trampoline (struct gdbarch *gdbarch,
2c02bd72	105	CORE_ADDR pc, const char *name);
d50355b6	106
c9cf6e20 MG	107	extern int generic_stack_frame_destroyed_p (struct gdbarch *gdbarch,
c9cf6e20 MG	108	CORE_ADDR pc);
c12260ac	109
7eb89530 YQ	110	extern int default_code_of_frame_writable (struct gdbarch *gdbarch,
	111	struct frame_info *frame);
	112
a1f4a1b6	113	/* By default, registers are not convertible. */
76a8ddb9 UW	114	extern int generic_convert_register_p (struct gdbarch *gdbarch, int regnum,
76a8ddb9 UW	115	struct type *type);
13d01224	116
192cb3d4 MK	117	extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
	118	struct type *type);
	119
3ca64954 RC	120	extern int generic_instruction_nullified (struct gdbarch *gdbarch,
	121	struct regcache *regcache);
	122
123dc839 DJ	123	int default_remote_register_number (struct gdbarch *gdbarch,
	124	int regno);
	125
4182591f AC	126	/* For compatibility with older architectures, returns
	127	(LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
	128	name. */
	129
e7faf938	130	extern int legacy_register_sim_regno (struct gdbarch *gdbarch, int regnum);
4182591f	131
b6d373df DJ	132	/* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
	133	order was explicitly selected. */
	134	extern enum bfd_endian selected_byte_order (void);
	135
a8cf2722 AC	136	/* Return the selected architecture's name, or NULL if no architecture
	137	was explicitly selected. */
	138	extern const char *selected_architecture_name (void);
	139
fb6ecb0f	140	/* Initialize a ``struct info''. Can't use memset(0) since some
a8cf2722 AC	141	default values are not zero. "fill" takes all available
	142	information and fills in any unspecified fields. */
	143
fb6ecb0f AC	144	extern void gdbarch_info_init (struct gdbarch_info *info);
fb6ecb0f AC	145
100bcc3f	146	/* Similar to init, but this time fill in the blanks. Information is
7a107747 DJ	147	obtained from the global "set ..." options and explicitly
	148	initialized INFO fields. */
	149	extern void gdbarch_info_fill (struct gdbarch_info *info);
bf922ad9	150
2b026650 MK	151	/* Return the architecture for ABFD. If no suitable architecture
	152	could be find, return NULL. */
	153
	154	extern struct gdbarch gdbarch_from_bfd (bfd abfd);
	155
e17c207e UW	156	/* Return "current" architecture. If the target is running, this is the
	157	architecture of the selected frame. Otherwise, the "current" architecture
	158	defaults to the target architecture.
	159
	160	This function should normally be called solely by the command interpreter
	161	routines to determine the architecture to execute a command in. */
	162	extern struct gdbarch *get_current_arch (void);
	163
6c95b8df PA	164	extern int default_has_shared_address_space (struct gdbarch *);
6c95b8df PA	165
7a697b8d	166	extern int default_fast_tracepoint_valid_at (struct gdbarch *gdbarch,
6b940e6a	167	CORE_ADDR addr, char **msg);
7a697b8d	168
a1dcb23a DJ	169	extern void default_remote_breakpoint_from_pc (struct gdbarch *,
	170	CORE_ADDR pcptr, int kindptr);
	171
6710bf39 SS	172	extern void default_gen_return_address (struct gdbarch *gdbarch,
	173	struct agent_expr *ax,
	174	struct axs_value *value,
	175	CORE_ADDR scope);
	176
f870a310 TT	177	extern const char *default_auto_charset (void);
	178	extern const char *default_auto_wide_charset (void);
	179
18648a37 YQ	180	extern int default_return_in_first_hidden_param_p (struct gdbarch *,
18648a37 YQ	181	struct type *);
c2170eef MM	182
	183	extern int default_insn_is_call (struct gdbarch *, CORE_ADDR);
	184	extern int default_insn_is_ret (struct gdbarch *, CORE_ADDR);
	185	extern int default_insn_is_jump (struct gdbarch *, CORE_ADDR);
3437254d PA	186
	187	/* Do-nothing version of vsyscall_range. Returns false. */
	188
	189	extern int default_vsyscall_range (struct gdbarch gdbarch, struct mem_range range);
ae9bb220 PA	190
	191	/* Default way to advance the PC to the next instruction in order to
	192	skip a permanent breakpoint. Increments the PC by the size of a
	193	software breakpoint instruction, as determined with
	194	gdbarch_breakpoint_from_pc. This matches how the breakpoints
	195	module determines whether a breakpoint is permanent. */
	196	extern void default_skip_permanent_breakpoint (struct regcache *regcache);
	197
f208eee0 JK	198	/* Symbols for gdbarch_infcall_mmap; their Linux PROT_* system
	199	definitions would be dependent on compilation host. */
	200	#define GDB_MMAP_PROT_READ 0x1 /* Page can be read. */
	201	#define GDB_MMAP_PROT_WRITE 0x2 /* Page can be written. */
	202	#define GDB_MMAP_PROT_EXEC 0x4 /* Page can be executed. */
	203
	204	extern CORE_ADDR default_infcall_mmap (CORE_ADDR size, unsigned prot);
7f361056	205	extern void default_infcall_munmap (CORE_ADDR addr, CORE_ADDR size);
f208eee0	206	extern char default_gcc_target_options (struct gdbarch gdbarch);
ac04f72b	207	extern const char default_gnu_triplet_regexp (struct gdbarch gdbarch);
3374165f	208	extern int default_addressable_memory_unit_size (struct gdbarch *gdbarch);
f208eee0	209
5f034a78 MK	210	extern void default_guess_tracepoint_registers (struct gdbarch *gdbarch,
	211	struct regcache *regcache,
	212	CORE_ADDR addr);
	213
c0e8c252	214	#endif