GDB (xrefs)
Loading...
Searching...
No Matches
arch-utils.h
Go to the documentation of this file.
1/* Dynamic architecture support for GDB, the GNU debugger.
2
3 Copyright (C) 1998-2023 Free Software Foundation, Inc.
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
9 the Free Software Foundation; either version 3 of the License, or
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
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19
20#ifndef ARCH_UTILS_H
21#define ARCH_UTILS_H
22
23#include "gdbarch.h"
24
25class frame_info_ptr;
26struct minimal_symbol;
27struct type;
28struct gdbarch_info;
30
31template <size_t bp_size, const gdb_byte *break_insn>
33{
34 static int
35 kind_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr)
36 {
37 return bp_size;
38 }
39
40 static const gdb_byte *
41 bp_from_kind (struct gdbarch *gdbarch, int kind, int *size)
42 {
43 *size = kind;
44 return break_insn;
45 }
46};
47
48template <size_t bp_size,
49 const gdb_byte *break_insn_little,
50 const gdb_byte *break_insn_big>
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>
76
77/* Default implementation of gdbarch_displaced_hw_singlestep. */
79
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
85/* The only possible cases for inner_than. */
86extern int core_addr_lessthan (CORE_ADDR lhs, CORE_ADDR rhs);
87extern int core_addr_greaterthan (CORE_ADDR lhs, CORE_ADDR rhs);
88
89/* Identity functions on a CORE_ADDR. Just return the "addr". */
90
91extern CORE_ADDR core_addr_identity (struct gdbarch *gdbarch, CORE_ADDR addr);
93
94/* No-op conversion of reg to regnum. */
95
96extern int no_op_reg_to_regnum (struct gdbarch *gdbarch, int reg);
97
98/* Do nothing version of coff_make_msymbol_special. */
99
100void default_coff_make_msymbol_special (int val, struct minimal_symbol *msym);
101
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
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
119/* Version of cannot_fetch_register() / cannot_store_register() that
120 always fails. */
121
122int cannot_register_not (struct gdbarch *gdbarch, int regnum);
123
124/* Legacy version of target_virtual_frame_pointer(). Assumes that
125 there is an gdbarch_deprecated_fp_regnum and that it is the same, cooked or
126 raw. */
127
129
130/* Default implementation of gdbarch_floatformat_for_type. */
131extern const struct floatformat **
133 const char *name, int len);
134
135/* Default implementation of gdbarch_remove_non_address_bits. */
137 CORE_ADDR pointer);
138
139/* Default implementation of gdbarch_memtag_to_string. */
140extern std::string default_memtag_to_string (struct gdbarch *gdbarch,
141 struct value *tag);
142
143/* Default implementation of gdbarch_tagged_address_p. */
144bool default_tagged_address_p (struct gdbarch *gdbarch, struct value *address);
145
146/* Default implementation of gdbarch_memtag_matches_p. */
147extern bool default_memtag_matches_p (struct gdbarch *gdbarch,
148 struct value *address);
149
150/* Default implementation of gdbarch_set_memtags. */
152 struct value *address, size_t length,
153 const gdb::byte_vector &tags,
154 memtag_type tag_type);
155
156/* Default implementation of gdbarch_get_memtag. */
157struct value *default_get_memtag (struct gdbarch *gdbarch,
158 struct value *address,
159 memtag_type tag_type);
160
161extern CORE_ADDR generic_skip_trampoline_code (frame_info_ptr frame,
162 CORE_ADDR pc);
163
164extern CORE_ADDR generic_skip_solib_resolver (struct gdbarch *gdbarch,
165 CORE_ADDR pc);
166
168 CORE_ADDR pc, const char *name);
169
171 CORE_ADDR pc);
172
174 frame_info_ptr frame);
175
176/* By default, registers are not convertible. */
177extern int generic_convert_register_p (struct gdbarch *gdbarch, int regnum,
178 struct type *type);
179
181 struct type *type);
182
184 struct regcache *regcache);
185
187 int regno);
188
189/* For compatibility with older architectures, returns
190 (LEGACY_SIM_REGNO_IGNORE) when the register doesn't have a valid
191 name. */
192
193extern int legacy_register_sim_regno (struct gdbarch *gdbarch, int regnum);
194
195/* Return the selected byte order, or BFD_ENDIAN_UNKNOWN if no byte
196 order was explicitly selected. */
197extern enum bfd_endian selected_byte_order (void);
198
199/* Return the selected architecture's name, or NULL if no architecture
200 was explicitly selected. */
201extern const char *selected_architecture_name (void);
202
203/* Similar to init, but this time fill in the blanks. Information is
204 obtained from the global "set ..." options and explicitly
205 initialized INFO fields. */
206extern void gdbarch_info_fill (struct gdbarch_info *info);
207
208/* Return the architecture for ABFD. If no suitable architecture
209 could be find, return NULL. */
210
211extern struct gdbarch *gdbarch_from_bfd (bfd *abfd);
212
213/* Return "current" architecture. If the target is running, this is the
214 architecture of the selected frame. Otherwise, the "current" architecture
215 defaults to the target architecture.
216
217 This function should normally be called solely by the command interpreter
218 routines to determine the architecture to execute a command in. */
219extern struct gdbarch *get_current_arch (void);
220
221extern int default_has_shared_address_space (struct gdbarch *);
222
224 CORE_ADDR addr, std::string *msg);
225
226extern const gdb_byte *default_breakpoint_from_pc (struct gdbarch *gdbarch,
227 CORE_ADDR *pcptr,
228 int *lenptr);
229
231 struct regcache *regcache,
232 CORE_ADDR *pcptr);
233
234extern void default_gen_return_address (struct gdbarch *gdbarch,
235 struct agent_expr *ax,
236 struct axs_value *value,
237 CORE_ADDR scope);
238
239extern const char *default_auto_charset (void);
240extern const char *default_auto_wide_charset (void);
241
243 struct type *);
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);
248
249/* Default implementation of gdbarch_program_breakpoint_here_p. */
251 CORE_ADDR addr);
252
253/* Do-nothing version of vsyscall_range. Returns false. */
254
255extern int default_vsyscall_range (struct gdbarch *gdbarch, struct mem_range *range);
256
257/* Default way to advance the PC to the next instruction in order to
258 skip a permanent breakpoint. Increments the PC by the size of a
259 software breakpoint instruction, as determined with
260 gdbarch_breakpoint_from_pc. This matches how the breakpoints
261 module determines whether a breakpoint is permanent. */
263
264/* Symbols for gdbarch_infcall_mmap; their Linux PROT_* system
265 definitions would be dependent on compilation host. */
266#define GDB_MMAP_PROT_READ 0x1 /* Page can be read. */
267#define GDB_MMAP_PROT_WRITE 0x2 /* Page can be written. */
268#define GDB_MMAP_PROT_EXEC 0x4 /* Page can be executed. */
269
270extern CORE_ADDR default_infcall_mmap (CORE_ADDR size, unsigned prot);
271extern void default_infcall_munmap (CORE_ADDR addr, CORE_ADDR size);
272extern std::string default_gcc_target_options (struct gdbarch *gdbarch);
273extern const char *default_gnu_triplet_regexp (struct gdbarch *gdbarch);
275
277 struct regcache *regcache,
278 CORE_ADDR addr);
279
280extern int default_print_insn (bfd_vma memaddr, disassemble_info *info);
281
282/* Wrapper to gdbarch_skip_prologue, but doesn't throw exception. Catch
283 exception thrown from gdbarch_skip_prologue, and return PC. */
284
286 CORE_ADDR pc) noexcept;
287
288/* Default implementation of gdbarch_in_indirect_branch_thunk that returns
289 false. */
291 CORE_ADDR pc);
292
293/* Default implementation of gdbarch type_align method. */
294extern ULONGEST default_type_align (struct gdbarch *gdbarch,
295 struct type *type);
296
297/* Default implementation of gdbarch get_pc_address_flags method. */
298extern std::string default_get_pc_address_flags (frame_info_ptr frame,
299 CORE_ADDR pc);
300
301/* Default implementation of gdbarch read_core_file_mappings method. */
303 (struct gdbarch *gdbarch,
304 struct bfd *cbfd,
307
308/* Default implementation of gdbarch
309 use_target_description_from_corefile_notes. */
311 (struct gdbarch *gdbarch,
312 struct bfd *corefile_bfd);
313
314/* Default implementation of gdbarch default_get_return_buf_addr method. */
315extern CORE_ADDR default_get_return_buf_addr (struct type *val_typegdbarch,
316 frame_info_ptr cur_frame);
317
318/* Default implementation of gdbarch default_dwarf2_omit_typedef_p method. */
319extern bool default_dwarf2_omit_typedef_p (struct type *target_type,
320 const char *producer,
321 const char *name);
322
324 (struct gdbarch *gdbarch, struct value *function, struct type *valtype,
325 struct regcache *regcache, struct value **read_value,
326 const gdb_byte *writebuf);
327
328#endif /* ARCH_UTILS_H */
int regnum
const char *const name
std::string default_get_pc_address_flags(frame_info_ptr frame, CORE_ADDR pc)
ULONGEST default_type_align(struct gdbarch *gdbarch, struct type *type)
struct gdbarch * gdbarch_from_bfd(bfd *abfd)
Definition arch-utils.c:637
bool default_execute_dwarf_cfa_vendor_op(struct gdbarch *gdbarch, gdb_byte op, struct dwarf2_frame_state *fs)
Definition arch-utils.c:242
int generic_in_solib_return_trampoline(struct gdbarch *gdbarch, CORE_ADDR pc, const char *name)
Definition arch-utils.c:155
int default_return_in_first_hidden_param_p(struct gdbarch *, struct type *)
Definition arch-utils.c:899
int default_print_insn(bfd_vma memaddr, disassemble_info *info)
const struct floatformat ** default_floatformat_for_type(struct gdbarch *gdbarch, const char *name, int len)
Definition arch-utils.c:289
gdbarch_virtual_frame_pointer_ftype legacy_virtual_frame_pointer
CORE_ADDR generic_skip_trampoline_code(frame_info_ptr frame, CORE_ADDR pc)
Definition arch-utils.c:143
void default_skip_permanent_breakpoint(struct regcache *regcache)
Definition arch-utils.c:956
CORE_ADDR displaced_step_at_entry_point(struct gdbarch *gdbarch)
Definition arch-utils.c:54
CORE_ADDR default_get_return_buf_addr(struct type *val_typegdbarch, frame_info_ptr cur_frame)
const char * default_auto_charset(void)
Definition charset.c:920
void gdbarch_info_fill(struct gdbarch_info *info)
Definition arch-utils.c:780
void default_guess_tracepoint_registers(struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr)
int default_insn_is_ret(struct gdbarch *, CORE_ADDR)
Definition arch-utils.c:913
struct gdbarch * get_current_arch(void)
Definition arch-utils.c:846
bool default_use_target_description_from_corefile_notes(struct gdbarch *gdbarch, struct bfd *corefile_bfd)
int default_addressable_memory_unit_size(struct gdbarch *gdbarch)
void default_read_core_file_mappings(struct gdbarch *gdbarch, struct bfd *cbfd, read_core_file_mappings_pre_loop_ftype pre_loop_cb, read_core_file_mappings_loop_ftype loop_cb)
int generic_instruction_nullified(struct gdbarch *gdbarch, struct regcache *regcache)
Definition arch-utils.c:333
CORE_ADDR default_adjust_dwarf2_line(CORE_ADDR addr, int rel)
Definition arch-utils.c:234
struct value * default_get_memtag(struct gdbarch *gdbarch, struct value *address, memtag_type tag_type)
Definition arch-utils.c:135
CORE_ADDR default_remove_non_address_bits(struct gdbarch *gdbarch, CORE_ADDR pointer)
Definition arch-utils.c:88
int default_breakpoint_kind_from_current_state(struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR *pcptr)
Definition arch-utils.c:882
int default_fast_tracepoint_valid_at(struct gdbarch *gdbarch, CORE_ADDR addr, std::string *msg)
Definition arch-utils.c:863
const char * default_gnu_triplet_regexp(struct gdbarch *gdbarch)
Definition arch-utils.c:993
int legacy_register_sim_regno(struct gdbarch *gdbarch, int regnum)
Definition arch-utils.c:71
CORE_ADDR gdbarch_skip_prologue_noexcept(gdbarch *gdbarch, CORE_ADDR pc) noexcept
int generic_stack_frame_destroyed_p(struct gdbarch *gdbarch, CORE_ADDR pc)
Definition arch-utils.c:162
void default_infcall_munmap(CORE_ADDR addr, CORE_ADDR size)
Definition arch-utils.c:974
void default_make_symbol_special(struct symbol *sym, struct objfile *objfile)
Definition arch-utils.c:218
int default_has_shared_address_space(struct gdbarch *)
Definition arch-utils.c:855
bool default_tagged_address_p(struct gdbarch *gdbarch, struct value *address)
Definition arch-utils.c:106
int core_addr_greaterthan(CORE_ADDR lhs, CORE_ADDR rhs)
Definition arch-utils.c:183
bool default_memtag_matches_p(struct gdbarch *gdbarch, struct value *address)
Definition arch-utils.c:115
CORE_ADDR core_addr_identity(struct gdbarch *gdbarch, CORE_ADDR addr)
Definition arch-utils.c:191
gdbarch_convert_from_func_ptr_addr_ftype convert_from_func_ptr_addr_identity
const gdb_byte * default_breakpoint_from_pc(struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr)
Definition arch-utils.c:874
int default_insn_is_jump(struct gdbarch *, CORE_ADDR)
Definition arch-utils.c:918
bool default_program_breakpoint_here_p(struct gdbarch *gdbarch, CORE_ADDR addr)
Definition arch-utils.c:926
bool default_dwarf2_omit_typedef_p(struct type *target_type, const char *producer, const char *name)
int core_addr_lessthan(CORE_ADDR lhs, CORE_ADDR rhs)
Definition arch-utils.c:177
enum bfd_endian selected_byte_order(void)
Definition arch-utils.c:372
std::string default_memtag_to_string(struct gdbarch *gdbarch, struct value *tag)
Definition arch-utils.c:97
int default_insn_is_call(struct gdbarch *, CORE_ADDR)
Definition arch-utils.c:908
int generic_convert_register_p(struct gdbarch *gdbarch, int regnum, struct type *type)
Definition arch-utils.c:320
int no_op_reg_to_regnum(struct gdbarch *gdbarch, int reg)
Definition arch-utils.c:204
int default_stabs_argument_has_addr(struct gdbarch *gdbarch, struct type *type)
Definition arch-utils.c:327
std::string default_gcc_target_options(struct gdbarch *gdbarch)
Definition arch-utils.c:983
bool default_set_memtags(struct gdbarch *gdbarch, struct value *address, size_t length, const gdb::byte_vector &tags, memtag_type tag_type)
Definition arch-utils.c:124
const char * selected_architecture_name(void)
Definition arch-utils.c:527
int default_vsyscall_range(struct gdbarch *gdbarch, struct mem_range *range)
Definition arch-utils.c:349
void default_coff_make_msymbol_special(int val, struct minimal_symbol *msym)
Definition arch-utils.c:210
int cannot_register_not(struct gdbarch *gdbarch, int regnum)
Definition arch-utils.c:249
bool default_in_indirect_branch_thunk(gdbarch *gdbarch, CORE_ADDR pc)
void default_gen_return_address(struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope)
Definition arch-utils.c:891
const char * default_auto_wide_charset(void)
Definition charset.c:926
bool default_displaced_step_hw_singlestep(struct gdbarch *)
Definition arch-utils.c:48
int default_code_of_frame_writable(struct gdbarch *gdbarch, frame_info_ptr frame)
Definition arch-utils.c:168
CORE_ADDR generic_skip_solib_resolver(struct gdbarch *gdbarch, CORE_ADDR pc)
Definition arch-utils.c:149
enum return_value_convention default_gdbarch_return_value(struct gdbarch *gdbarch, struct value *function, struct type *valtype, struct regcache *regcache, struct value **read_value, const gdb_byte *writebuf)
int default_remote_register_number(struct gdbarch *gdbarch, int regno)
Definition arch-utils.c:340
CORE_ADDR default_adjust_dwarf2_addr(CORE_ADDR pc)
Definition arch-utils.c:226
CORE_ADDR default_infcall_mmap(CORE_ADDR size, unsigned prot)
Definition arch-utils.c:968
return_value_convention
Definition defs.h:257
enum bfd_endian gdbarch_byte_order(struct gdbarch *gdbarch)
Definition gdbarch.c:1396
void gdbarch_virtual_frame_pointer_ftype(struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset)
CORE_ADDR gdbarch_convert_from_func_ptr_addr_ftype(struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ)
gdb::function_view< void(ULONGEST count)> read_core_file_mappings_pre_loop_ftype
Definition gdbarch.h:143
memtag_type
Definition gdbarch.h:130
gdb::function_view< void(int num, ULONGEST start, ULONGEST end, ULONGEST file_ofs, const char *filename, const bfd_build_id *build_id)> read_core_file_mappings_loop_ftype
Definition gdbarch.h:146
size_t size
Definition go32-nat.c:239
info(Component c)
Definition gdbarch.py:41
static const gdb_byte * bp_from_kind(struct gdbarch *gdbarch, int kind, int *size)
Definition arch-utils.h:60
static int kind_from_pc(struct gdbarch *gdbarch, CORE_ADDR *pcptr)
Definition arch-utils.h:54
static int kind_from_pc(struct gdbarch *gdbarch, CORE_ADDR *pcptr)
Definition arch-utils.h:35
static const gdb_byte * bp_from_kind(struct gdbarch *gdbarch, int kind, int *size)
Definition arch-utils.h:41
Definition value.h:90
Definition value.h:130
CORE_ADDR address
Definition value.h:658