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