Automatic date update in version.in
[deliverable/binutils-gdb.git] / gdb / arch-utils.h
CommitLineData
c0e8c252 1/* Dynamic architecture support for GDB, the GNU debugger.
d7bd68ca 2
3666a048 3 Copyright (C) 1998-2021 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 19
1a5c2598
TT
20#ifndef ARCH_UTILS_H
21#define ARCH_UTILS_H
c0e8c252 22
0d12e84c
TT
23#include "gdbarch.h"
24
da3331ec
AC
25struct frame_info;
26struct minimal_symbol;
27struct type;
28struct gdbarch_info;
b41c5a85 29struct dwarf2_frame_state;
da3331ec 30
04180708
YQ
31template <size_t bp_size, const gdb_byte *break_insn>
32struct bp_manipulation
33{
34 static int
35 kind_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr)
36 {
37 return bp_size;
22f13eb8 38 }
598cc9dc 39
04180708
YQ
40 static const gdb_byte *
41 bp_from_kind (struct gdbarch *gdbarch, int kind, int *size)
42 {
43 *size = kind;
44 return break_insn;
22f13eb8 45 }
04180708
YQ
46};
47
48template <size_t bp_size,
49 const gdb_byte *break_insn_little,
50 const gdb_byte *break_insn_big>
51struct bp_manipulation_endian
52{
53 static int
54 kind_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr)
55 {
56 return bp_size;
57 }
58
59 static const gdb_byte *
60 bp_from_kind (struct gdbarch *gdbarch, int kind, int *size)
61 {
62 *size = kind;
63 if (gdbarch_byte_order (gdbarch) == BFD_ENDIAN_BIG)
64 return break_insn_big;
65 else
66 return break_insn_little;
67 }
68};
69
70#define BP_MANIPULATION(BREAK_INSN) \
71 bp_manipulation<sizeof (BREAK_INSN), BREAK_INSN>
72
73#define BP_MANIPULATION_ENDIAN(BREAK_INSN_LITTLE, BREAK_INSN_BIG) \
74 bp_manipulation_endian<sizeof (BREAK_INSN_LITTLE), \
75 BREAK_INSN_LITTLE, BREAK_INSN_BIG>
d19280ad 76
99e40580 77/* Default implementation of gdbarch_displaced_hw_singlestep. */
40a53766 78extern bool default_displaced_step_hw_singlestep (struct gdbarch *);
99e40580 79
237fc4c9
PA
80/* Possible value for gdbarch_displaced_step_location:
81 Place displaced instructions at the program's entry point,
82 leaving space for inferior function call return breakpoints. */
83extern CORE_ADDR displaced_step_at_entry_point (struct gdbarch *gdbarch);
84
0e2de366 85/* The only possible cases for inner_than. */
3339cf8b
AC
86extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
87extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
88
e2d0e7eb 89/* Identity functions on a CORE_ADDR. Just return the "addr". */
f517ea4e 90
24568a2c 91extern CORE_ADDR core_addr_identity (struct gdbarch *gdbarch, CORE_ADDR addr);
e2d0e7eb 92extern gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity;
f517ea4e 93
0e2de366 94/* No-op conversion of reg to regnum. */
88c72b7d 95
d3f73121 96extern int no_op_reg_to_regnum (struct gdbarch *gdbarch, int reg);
88c72b7d 97
0e2de366 98/* Do nothing version of coff_make_msymbol_special. */
a2cf933a
EZ
99
100void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
101
3e29f34a
MR
102/* Do nothing default implementation of gdbarch_make_symbol_special. */
103
104void default_make_symbol_special (struct symbol *sym, struct objfile *objfile);
105
106/* Do nothing default implementation of gdbarch_adjust_dwarf2_addr. */
107
108CORE_ADDR default_adjust_dwarf2_addr (CORE_ADDR pc);
109
110/* Do nothing default implementation of gdbarch_adjust_dwarf2_line. */
111
112CORE_ADDR default_adjust_dwarf2_line (CORE_ADDR addr, int rel);
113
b41c5a85
JW
114/* Default DWARF vendor CFI handler. */
115
116bool default_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdb_byte op,
117 struct dwarf2_frame_state *fs);
118
01fb7433 119/* Version of cannot_fetch_register() / cannot_store_register() that
0e2de366 120 always fails. */
01fb7433 121
64a3914f 122int cannot_register_not (struct gdbarch *gdbarch, int regnum);
01fb7433 123
39d4ef09 124/* Legacy version of target_virtual_frame_pointer(). Assumes that
064f5156 125 there is an gdbarch_deprecated_fp_regnum and that it is the same, cooked or
0ba6dca9 126 raw. */
39d4ef09
AC
127
128extern gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer;
129
9b790ce7
UW
130/* Default implementation of gdbarch_floatformat_for_type. */
131extern const struct floatformat **
132 default_floatformat_for_type (struct gdbarch *gdbarch,
133 const char *name, int len);
134
c193949e
LM
135/* Default implementation of gdbarch_memtag_to_string. */
136extern std::string default_memtag_to_string (struct gdbarch *gdbarch,
137 struct value *tag);
138
139/* Default implementation of gdbarch_tagged_address_p. */
140bool default_tagged_address_p (struct gdbarch *gdbarch, struct value *address);
141
142/* Default implementation of gdbarch_memtag_matches_p. */
143extern bool default_memtag_matches_p (struct gdbarch *gdbarch,
144 struct value *address);
145
146/* Default implementation of gdbarch_set_memtags. */
147bool default_set_memtags (struct gdbarch *gdbarch,
148 struct value *address, size_t length,
149 const gdb::byte_vector &tags,
150 memtag_type tag_type);
151
152/* Default implementation of gdbarch_get_memtag. */
153struct value *default_get_memtag (struct gdbarch *gdbarch,
154 struct value *address,
155 memtag_type tag_type);
156
52f729a7
UW
157extern CORE_ADDR generic_skip_trampoline_code (struct frame_info *frame,
158 CORE_ADDR pc);
bdcd319a 159
4c8c40e6
MK
160extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
161 CORE_ADDR pc);
dea0c52f 162
e17a4113 163extern int generic_in_solib_return_trampoline (struct gdbarch *gdbarch,
2c02bd72 164 CORE_ADDR pc, const char *name);
d50355b6 165
c9cf6e20
MG
166extern int generic_stack_frame_destroyed_p (struct gdbarch *gdbarch,
167 CORE_ADDR pc);
c12260ac 168
7eb89530
YQ
169extern int default_code_of_frame_writable (struct gdbarch *gdbarch,
170 struct frame_info *frame);
171
a1f4a1b6 172/* By default, registers are not convertible. */
76a8ddb9
UW
173extern int generic_convert_register_p (struct gdbarch *gdbarch, int regnum,
174 struct type *type);
13d01224 175
192cb3d4
MK
176extern int default_stabs_argument_has_addr (struct gdbarch *gdbarch,
177 struct type *type);
178
3ca64954
RC
179extern int generic_instruction_nullified (struct gdbarch *gdbarch,
180 struct regcache *regcache);
181
123dc839
DJ
182int default_remote_register_number (struct gdbarch *gdbarch,
183 int regno);
184
4182591f
AC
185/* For compatibility with older architectures, returns
186 (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
187 name. */
188
e7faf938 189extern int legacy_register_sim_regno (struct gdbarch *gdbarch, int regnum);
4182591f 190
b6d373df
DJ
191/* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
192 order was explicitly selected. */
193extern enum bfd_endian selected_byte_order (void);
194
a8cf2722
AC
195/* Return the selected architecture's name, or NULL if no architecture
196 was explicitly selected. */
197extern const char *selected_architecture_name (void);
198
100bcc3f 199/* Similar to init, but this time fill in the blanks. Information is
7a107747
DJ
200 obtained from the global "set ..." options and explicitly
201 initialized INFO fields. */
202extern void gdbarch_info_fill (struct gdbarch_info *info);
bf922ad9 203
2b026650
MK
204/* Return the architecture for ABFD. If no suitable architecture
205 could be find, return NULL. */
206
207extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
208
e17c207e
UW
209/* Return "current" architecture. If the target is running, this is the
210 architecture of the selected frame. Otherwise, the "current" architecture
211 defaults to the target architecture.
212
213 This function should normally be called solely by the command interpreter
214 routines to determine the architecture to execute a command in. */
215extern struct gdbarch *get_current_arch (void);
216
6c95b8df
PA
217extern int default_has_shared_address_space (struct gdbarch *);
218
7a697b8d 219extern int default_fast_tracepoint_valid_at (struct gdbarch *gdbarch,
281d762b 220 CORE_ADDR addr, std::string *msg);
7a697b8d 221
22f13eb8
YQ
222extern const gdb_byte *default_breakpoint_from_pc (struct gdbarch *gdbarch,
223 CORE_ADDR *pcptr,
224 int *lenptr);
225
833b7ab5
YQ
226extern int default_breakpoint_kind_from_current_state (struct gdbarch *gdbarch,
227 struct regcache *regcache,
228 CORE_ADDR *pcptr);
229
6710bf39
SS
230extern void default_gen_return_address (struct gdbarch *gdbarch,
231 struct agent_expr *ax,
232 struct axs_value *value,
233 CORE_ADDR scope);
234
f870a310
TT
235extern const char *default_auto_charset (void);
236extern const char *default_auto_wide_charset (void);
237
18648a37
YQ
238extern int default_return_in_first_hidden_param_p (struct gdbarch *,
239 struct type *);
c2170eef
MM
240
241extern int default_insn_is_call (struct gdbarch *, CORE_ADDR);
242extern int default_insn_is_ret (struct gdbarch *, CORE_ADDR);
243extern int default_insn_is_jump (struct gdbarch *, CORE_ADDR);
3437254d 244
5133a315
LM
245/* Default implementation of gdbarch_program_breakpoint_here_p. */
246extern bool default_program_breakpoint_here_p (struct gdbarch *gdbarch,
247 CORE_ADDR addr);
248
3437254d
PA
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);
953cff56 268extern std::string 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
39503f82
YQ
276extern int default_print_insn (bfd_vma memaddr, disassemble_info *info);
277
46a62268
YQ
278/* Wrapper to gdbarch_skip_prologue, but doesn't throw exception. Catch
279 exception thrown from gdbarch_skip_prologue, and return PC. */
280
281extern CORE_ADDR gdbarch_skip_prologue_noexcept (gdbarch *gdbarch,
282 CORE_ADDR pc) noexcept;
283
1d509aa6
MM
284/* Default implementation of gdbarch_in_indirect_branch_thunk that returns
285 false. */
286extern bool default_in_indirect_branch_thunk (gdbarch *gdbarch,
287 CORE_ADDR pc);
288
2b4424c3
TT
289/* Default implementation of gdbarch type_align method. */
290extern ULONGEST default_type_align (struct gdbarch *gdbarch,
291 struct type *type);
292
aa7ca1bb
AH
293/* Default implementation of gdbarch get_pc_address_flags method. */
294extern std::string default_get_pc_address_flags (frame_info *frame,
295 CORE_ADDR pc);
296
7e183d27
KB
297/* Default implementation of gdbarch read_core_file_mappings method. */
298extern void default_read_core_file_mappings (struct gdbarch *gdbarch,
299 struct bfd *cbfd,
300 gdb::function_view<void (ULONGEST count)>
301 pre_loop_cb,
302 gdb::function_view<void (int num,
303 ULONGEST start,
304 ULONGEST end,
305 ULONGEST file_ofs,
70125a45 306 const char *filename)>
7e183d27 307 loop_cb);
1a5c2598 308#endif /* ARCH_UTILS_H */
This page took 1.251862 seconds and 4 git commands to generate.