]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - gdb/gdbarch.h
gdb: Add aliases for read_core_file_mappings callbacks
[thirdparty/binutils-gdb.git] / gdb / gdbarch.h
CommitLineData
c4bfde41
JK
1/* *INDENT-OFF* */ /* THIS FILE IS GENERATED -*- buffer-read-only: t -*- */
2/* vi:set ro: */
59233f88 3
adf40b2e 4/* Dynamic architecture support for GDB, the GNU debugger.
79d45cd4 5
3666a048 6 Copyright (C) 1998-2021 Free Software Foundation, Inc.
c906108c 7
c5aa993b 8 This file is part of GDB.
c906108c 9
c5aa993b
JM
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
a9762ec7 12 the Free Software Foundation; either version 3 of the License, or
c5aa993b 13 (at your option) any later version.
618f726f 14
c5aa993b
JM
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
618f726f 19
c5aa993b 20 You should have received a copy of the GNU General Public License
a9762ec7 21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
c906108c 22
41a77cba 23/* This file was created with the aid of ``gdbarch.sh''. */
adf40b2e 24
c906108c
SS
25#ifndef GDBARCH_H
26#define GDBARCH_H
27
a0ff9e1a 28#include <vector>
eb7a547a 29#include "frame.h"
65b48a81 30#include "dis-asm.h"
284a0e3c 31#include "gdb_obstack.h"
fdb61c6c 32#include "infrun.h"
fe4b2ee6 33#include "osabi.h"
c7acb87b 34#include "displaced-stepping.h"
eb7a547a 35
da3331ec
AC
36struct floatformat;
37struct ui_file;
cce74817 38struct value;
b6af0555 39struct objfile;
1c772458 40struct obj_section;
a2cf933a 41struct minimal_symbol;
049ee0e4 42struct regcache;
b59ff9d5 43struct reggroup;
6ce6d90f 44struct regset;
a89aa300 45struct disassemble_info;
e2d0e7eb 46struct target_ops;
030f20e1 47struct obstack;
8181d85f 48struct bp_target_info;
424163ea 49struct target_desc;
3e29f34a 50struct symbol;
a96d9b2e 51struct syscall;
175ff332 52struct agent_expr;
6710bf39 53struct axs_value;
55aa24fb 54struct stap_parse_info;
37eedb39 55struct expr_builder;
7e35103a 56struct ravenscar_arch_ops;
3437254d 57struct mem_range;
458c8db8 58struct syscalls_info;
4dfc5dbc 59struct thread_info;
012b3a21 60struct ui_out;
187b041e 61struct inferior;
0f71a2f6 62
8a526fa6
PA
63#include "regcache.h"
64
345bd07c
SM
65struct gdbarch_tdep {};
66
6ecd4729
PA
67/* The architecture associated with the inferior through the
68 connection to the target.
69
70 The architecture vector provides some information that is really a
71 property of the inferior, accessed through a particular target:
72 ptrace operations; the layout of certain RSP packets; the solib_ops
73 vector; etc. To differentiate architecture accesses to
74 per-inferior/target properties from
75 per-thread/per-frame/per-objfile properties, accesses to
76 per-inferior/target properties should be made through this
77 gdbarch. */
78
79/* This is a convenience wrapper for 'current_inferior ()->gdbarch'. */
f5656ead 80extern struct gdbarch *target_gdbarch (void);
6ecd4729 81
19630284
JB
82/* Callback type for the 'iterate_over_objfiles_in_search_order'
83 gdbarch method. */
84
85typedef int (iterate_over_objfiles_in_search_order_cb_ftype)
86 (struct objfile *objfile, void *cb_data);
87
1528345d
AA
88/* Callback type for regset section iterators. The callback usually
89 invokes the REGSET's supply or collect method, to which it must
a616bb94
AH
90 pass a buffer - for collects this buffer will need to be created using
91 COLLECT_SIZE, for supply the existing buffer being read from should
92 be at least SUPPLY_SIZE. SECT_NAME is a BFD section name, and HUMAN_NAME
93 is used for diagnostic messages. CB_DATA should have been passed
94 unchanged through the iterator. */
1528345d 95
5aa82d05 96typedef void (iterate_over_regset_sections_cb)
a616bb94
AH
97 (const char *sect_name, int supply_size, int collect_size,
98 const struct regset *regset, const char *human_name, void *cb_data);
5aa82d05 99
c5ac5cbb
AH
100/* For a function call, does the function return a value using a
101 normal value return or a structure return - passing a hidden
102 argument pointing to storage. For the latter, there are two
103 cases: language-mandated structure return and target ABI
104 structure return. */
105
106enum function_call_return_method
107{
108 /* Standard value return. */
109 return_method_normal = 0,
110
111 /* Language ABI structure return. This is handled
112 by passing the return location as the first parameter to
113 the function, even preceding "this". */
114 return_method_hidden_param,
115
116 /* Target ABI struct return. This is target-specific; for instance,
117 on ia64 the first argument is passed in out0 but the hidden
118 structure return pointer would normally be passed in r8. */
119 return_method_struct,
120};
121
c193949e
LM
122enum class memtag_type
123{
124 /* Logical tag, the tag that is stored in unused bits of a pointer to a
125 virtual address. */
126 logical = 0,
127
128 /* Allocation tag, the tag that is associated with every granule of memory in
129 the physical address space. Allocation tags are used to validate memory
130 accesses via pointers containing logical tags. */
131 allocation,
132};
133
aa95b2d4
AM
134/* Callback types for 'read_core_file_mappings' gdbarch method. */
135
136using read_core_file_mappings_pre_loop_ftype =
137 gdb::function_view<void (ULONGEST count)>;
138
139using read_core_file_mappings_loop_ftype =
140 gdb::function_view<void (int num,
141 ULONGEST start,
142 ULONGEST end,
143 ULONGEST file_ofs,
144 const char *filename,
145 const bfd_build_id *build_id)>;
c5ac5cbb 146
0f71a2f6 147
0963b4bd 148/* The following are pre-initialized by GDBARCH. */
0f71a2f6 149
104c1213 150extern const struct bfd_arch_info * gdbarch_bfd_arch_info (struct gdbarch *gdbarch);
0963b4bd 151/* set_gdbarch_bfd_arch_info() - not applicable - pre-initialized. */
0f71a2f6 152
94123b4f 153extern enum bfd_endian gdbarch_byte_order (struct gdbarch *gdbarch);
0963b4bd 154/* set_gdbarch_byte_order() - not applicable - pre-initialized. */
0f71a2f6 155
94123b4f 156extern enum bfd_endian gdbarch_byte_order_for_code (struct gdbarch *gdbarch);
0963b4bd 157/* set_gdbarch_byte_order_for_code() - not applicable - pre-initialized. */
9d4fde75 158
4be87837 159extern enum gdb_osabi gdbarch_osabi (struct gdbarch *gdbarch);
0963b4bd 160/* set_gdbarch_osabi() - not applicable - pre-initialized. */
4be87837 161
424163ea 162extern const struct target_desc * gdbarch_target_desc (struct gdbarch *gdbarch);
0963b4bd 163/* set_gdbarch_target_desc() - not applicable - pre-initialized. */
424163ea 164
0f71a2f6 165
0963b4bd 166/* The following are initialized by the target dependent code. */
0f71a2f6 167
35837774 168/* Number of bits in a short or unsigned short for the target machine. */
c4093a6a 169
104c1213
JM
170extern int gdbarch_short_bit (struct gdbarch *gdbarch);
171extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
0f71a2f6 172
66b43ecb
AC
173/* Number of bits in an int or unsigned int for the target machine. */
174
104c1213
JM
175extern int gdbarch_int_bit (struct gdbarch *gdbarch);
176extern void set_gdbarch_int_bit (struct gdbarch *gdbarch, int int_bit);
0f71a2f6 177
66b43ecb
AC
178/* Number of bits in a long or unsigned long for the target machine. */
179
104c1213
JM
180extern int gdbarch_long_bit (struct gdbarch *gdbarch);
181extern void set_gdbarch_long_bit (struct gdbarch *gdbarch, int long_bit);
0f71a2f6 182
66b43ecb
AC
183/* Number of bits in a long long or unsigned long long for the target
184 machine. */
185
104c1213
JM
186extern int gdbarch_long_long_bit (struct gdbarch *gdbarch);
187extern void set_gdbarch_long_long_bit (struct gdbarch *gdbarch, int long_long_bit);
0f71a2f6 188
2a67f09d 189/* The ABI default bit-size and format for "bfloat16", "half", "float", "double", and
f9e9243a
UW
190 "long double". These bit/format pairs should eventually be combined
191 into a single object. For the moment, just initialize them as a pair.
8da61cc4
DJ
192 Each format describes both the big and little endian layouts (if
193 useful). */
66b43ecb 194
2a67f09d
FW
195extern int gdbarch_bfloat16_bit (struct gdbarch *gdbarch);
196extern void set_gdbarch_bfloat16_bit (struct gdbarch *gdbarch, int bfloat16_bit);
197
198extern const struct floatformat ** gdbarch_bfloat16_format (struct gdbarch *gdbarch);
199extern void set_gdbarch_bfloat16_format (struct gdbarch *gdbarch, const struct floatformat ** bfloat16_format);
200
f9e9243a
UW
201extern int gdbarch_half_bit (struct gdbarch *gdbarch);
202extern void set_gdbarch_half_bit (struct gdbarch *gdbarch, int half_bit);
203
204extern const struct floatformat ** gdbarch_half_format (struct gdbarch *gdbarch);
205extern void set_gdbarch_half_format (struct gdbarch *gdbarch, const struct floatformat ** half_format);
206
104c1213
JM
207extern int gdbarch_float_bit (struct gdbarch *gdbarch);
208extern void set_gdbarch_float_bit (struct gdbarch *gdbarch, int float_bit);
0f71a2f6 209
8da61cc4
DJ
210extern const struct floatformat ** gdbarch_float_format (struct gdbarch *gdbarch);
211extern void set_gdbarch_float_format (struct gdbarch *gdbarch, const struct floatformat ** float_format);
66b43ecb 212
104c1213
JM
213extern int gdbarch_double_bit (struct gdbarch *gdbarch);
214extern void set_gdbarch_double_bit (struct gdbarch *gdbarch, int double_bit);
0f71a2f6 215
8da61cc4
DJ
216extern const struct floatformat ** gdbarch_double_format (struct gdbarch *gdbarch);
217extern void set_gdbarch_double_format (struct gdbarch *gdbarch, const struct floatformat ** double_format);
66b43ecb 218
104c1213
JM
219extern int gdbarch_long_double_bit (struct gdbarch *gdbarch);
220extern void set_gdbarch_long_double_bit (struct gdbarch *gdbarch, int long_double_bit);
0f71a2f6 221
8da61cc4
DJ
222extern const struct floatformat ** gdbarch_long_double_format (struct gdbarch *gdbarch);
223extern void set_gdbarch_long_double_format (struct gdbarch *gdbarch, const struct floatformat ** long_double_format);
456fcf94 224
53375380
PA
225/* The ABI default bit-size for "wchar_t". wchar_t is a built-in type
226 starting with C++11. */
227
228extern int gdbarch_wchar_bit (struct gdbarch *gdbarch);
229extern void set_gdbarch_wchar_bit (struct gdbarch *gdbarch, int wchar_bit);
230
231/* One if `wchar_t' is signed, zero if unsigned. */
232
233extern int gdbarch_wchar_signed (struct gdbarch *gdbarch);
234extern void set_gdbarch_wchar_signed (struct gdbarch *gdbarch, int wchar_signed);
235
9b790ce7
UW
236/* Returns the floating-point format to be used for values of length LENGTH.
237 NAME, if non-NULL, is the type name, which may be used to distinguish
238 different target formats of the same length. */
239
240typedef const struct floatformat ** (gdbarch_floatformat_for_type_ftype) (struct gdbarch *gdbarch, const char *name, int length);
241extern const struct floatformat ** gdbarch_floatformat_for_type (struct gdbarch *gdbarch, const char *name, int length);
242extern void set_gdbarch_floatformat_for_type (struct gdbarch *gdbarch, gdbarch_floatformat_for_type_ftype *floatformat_for_type);
243
52204a0b
DT
244/* For most targets, a pointer on the target and its representation as an
245 address in GDB have the same size and "look the same". For such a
17a912b6 246 target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
52204a0b
DT
247 / addr_bit will be set from it.
248
17a912b6 249 If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
8da614df
CV
250 also need to set gdbarch_dwarf2_addr_size, gdbarch_pointer_to_address and
251 gdbarch_address_to_pointer as well.
52204a0b
DT
252
253 ptr_bit is the size of a pointer on the target */
66b43ecb 254
66b43ecb
AC
255extern int gdbarch_ptr_bit (struct gdbarch *gdbarch);
256extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
66b43ecb 257
52204a0b
DT
258/* addr_bit is the size of a target address as represented in gdb */
259
52204a0b
DT
260extern int gdbarch_addr_bit (struct gdbarch *gdbarch);
261extern void set_gdbarch_addr_bit (struct gdbarch *gdbarch, int addr_bit);
66b43ecb 262
8da614df
CV
263/* dwarf2_addr_size is the target address size as used in the Dwarf debug
264 info. For .debug_frame FDEs, this is supposed to be the target address
265 size from the associated CU header, and which is equivalent to the
266 DWARF2_ADDR_SIZE as defined by the target specific GCC back-end.
267 Unfortunately there is no good way to determine this value. Therefore
268 dwarf2_addr_size simply defaults to the target pointer size.
269
270 dwarf2_addr_size is not used for .eh_frame FDEs, which are generally
271 defined using the target's pointer size so far.
272
273 Note that dwarf2_addr_size only needs to be redefined by a target if the
274 GCC back-end defines a DWARF2_ADDR_SIZE other than the target pointer size,
275 and if Dwarf versions < 4 need to be supported. */
276
277extern int gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch);
278extern void set_gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch, int dwarf2_addr_size);
279
4e409299
JB
280/* One if `char' acts like `signed char', zero if `unsigned char'. */
281
4e409299
JB
282extern int gdbarch_char_signed (struct gdbarch *gdbarch);
283extern void set_gdbarch_char_signed (struct gdbarch *gdbarch, int char_signed);
4e409299 284
39535193 285extern bool gdbarch_read_pc_p (struct gdbarch *gdbarch);
61a1198a 286
c113ed0c
YQ
287typedef CORE_ADDR (gdbarch_read_pc_ftype) (readable_regcache *regcache);
288extern CORE_ADDR gdbarch_read_pc (struct gdbarch *gdbarch, readable_regcache *regcache);
104c1213 289extern void set_gdbarch_read_pc (struct gdbarch *gdbarch, gdbarch_read_pc_ftype *read_pc);
61a1198a 290
39535193 291extern bool gdbarch_write_pc_p (struct gdbarch *gdbarch);
61a1198a
UW
292
293typedef void (gdbarch_write_pc_ftype) (struct regcache *regcache, CORE_ADDR val);
294extern void gdbarch_write_pc (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR val);
104c1213 295extern void set_gdbarch_write_pc (struct gdbarch *gdbarch, gdbarch_write_pc_ftype *write_pc);
0f71a2f6 296
39d4ef09
AC
297/* Function for getting target's idea of a frame pointer. FIXME: GDB's
298 whole scheme for dealing with "frames" and "frame pointers" needs a
299 serious shakedown. */
300
a54fba4c 301typedef void (gdbarch_virtual_frame_pointer_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
39d4ef09
AC
302extern void gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
303extern void set_gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, gdbarch_virtual_frame_pointer_ftype *virtual_frame_pointer);
39d4ef09 304
39535193 305extern bool gdbarch_pseudo_register_read_p (struct gdbarch *gdbarch);
61a0eb5b 306
849d0ba8
YQ
307typedef enum register_status (gdbarch_pseudo_register_read_ftype) (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum, gdb_byte *buf);
308extern enum register_status gdbarch_pseudo_register_read (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum, gdb_byte *buf);
d8124050 309extern void set_gdbarch_pseudo_register_read (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_ftype *pseudo_register_read);
61a0eb5b 310
3543a589
TT
311/* Read a register into a new struct value. If the register is wholly
312 or partly unavailable, this should call mark_value_bytes_unavailable
313 as appropriate. If this is defined, then pseudo_register_read will
314 never be called. */
315
39535193 316extern bool gdbarch_pseudo_register_read_value_p (struct gdbarch *gdbarch);
3543a589 317
849d0ba8
YQ
318typedef struct value * (gdbarch_pseudo_register_read_value_ftype) (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum);
319extern struct value * gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum);
3543a589
TT
320extern void set_gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_value_ftype *pseudo_register_read_value);
321
39535193 322extern bool gdbarch_pseudo_register_write_p (struct gdbarch *gdbarch);
61a0eb5b 323
b60c417a
AC
324typedef void (gdbarch_pseudo_register_write_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
325extern void gdbarch_pseudo_register_write (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
d8124050 326extern void set_gdbarch_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_pseudo_register_write_ftype *pseudo_register_write);
61a0eb5b 327
104c1213
JM
328extern int gdbarch_num_regs (struct gdbarch *gdbarch);
329extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
0f71a2f6 330
34620563
AC
331/* This macro gives the number of pseudo-registers that live in the
332 register namespace but do not get fetched or stored on the target.
333 These pseudo-registers may be aliases for other registers,
334 combinations of other registers, or they may be computed by GDB. */
335
0aba1244
EZ
336extern int gdbarch_num_pseudo_regs (struct gdbarch *gdbarch);
337extern void set_gdbarch_num_pseudo_regs (struct gdbarch *gdbarch, int num_pseudo_regs);
0aba1244 338
175ff332
HZ
339/* Assemble agent expression bytecode to collect pseudo-register REG.
340 Return -1 if something goes wrong, 0 otherwise. */
341
39535193 342extern bool gdbarch_ax_pseudo_register_collect_p (struct gdbarch *gdbarch);
175ff332
HZ
343
344typedef int (gdbarch_ax_pseudo_register_collect_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
345extern int gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
346extern void set_gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_collect_ftype *ax_pseudo_register_collect);
347
348/* Assemble agent expression bytecode to push the value of pseudo-register
349 REG on the interpreter stack.
350 Return -1 if something goes wrong, 0 otherwise. */
351
39535193 352extern bool gdbarch_ax_pseudo_register_push_stack_p (struct gdbarch *gdbarch);
175ff332
HZ
353
354typedef int (gdbarch_ax_pseudo_register_push_stack_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
355extern int gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
356extern void set_gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_push_stack_ftype *ax_pseudo_register_push_stack);
357
272bb05c
JB
358/* Some architectures can display additional information for specific
359 signals.
360 UIOUT is the output stream where the handler will place information. */
361
39535193 362extern bool gdbarch_report_signal_info_p (struct gdbarch *gdbarch);
272bb05c
JB
363
364typedef void (gdbarch_report_signal_info_ftype) (struct gdbarch *gdbarch, struct ui_out *uiout, enum gdb_signal siggnal);
365extern void gdbarch_report_signal_info (struct gdbarch *gdbarch, struct ui_out *uiout, enum gdb_signal siggnal);
366extern void set_gdbarch_report_signal_info (struct gdbarch *gdbarch, gdbarch_report_signal_info_ftype *report_signal_info);
367
c2169756
AC
368/* GDB's standard (or well known) register numbers. These can map onto
369 a real register or a pseudo (computed) register or not be defined at
a9e5fdc2 370 all (-1).
3e8c568d 371 gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP. */
1200cd6e 372
104c1213
JM
373extern int gdbarch_sp_regnum (struct gdbarch *gdbarch);
374extern void set_gdbarch_sp_regnum (struct gdbarch *gdbarch, int sp_regnum);
0f71a2f6 375
104c1213
JM
376extern int gdbarch_pc_regnum (struct gdbarch *gdbarch);
377extern void set_gdbarch_pc_regnum (struct gdbarch *gdbarch, int pc_regnum);
0f71a2f6 378
c2169756
AC
379extern int gdbarch_ps_regnum (struct gdbarch *gdbarch);
380extern void set_gdbarch_ps_regnum (struct gdbarch *gdbarch, int ps_regnum);
c2169756 381
60054393
MS
382extern int gdbarch_fp0_regnum (struct gdbarch *gdbarch);
383extern void set_gdbarch_fp0_regnum (struct gdbarch *gdbarch, int fp0_regnum);
60054393 384
88c72b7d
AC
385/* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
386
d3f73121 387typedef int (gdbarch_stab_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int stab_regnr);
88c72b7d
AC
388extern int gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, int stab_regnr);
389extern void set_gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_stab_reg_to_regnum_ftype *stab_reg_to_regnum);
88c72b7d
AC
390
391/* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
392
d3f73121 393typedef int (gdbarch_ecoff_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int ecoff_regnr);
88c72b7d
AC
394extern int gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, int ecoff_regnr);
395extern void set_gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_ecoff_reg_to_regnum_ftype *ecoff_reg_to_regnum);
88c72b7d 396
77949794 397/* Convert from an sdb register number to an internal gdb register number. */
88c72b7d 398
d3f73121 399typedef int (gdbarch_sdb_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int sdb_regnr);
88c72b7d
AC
400extern int gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, int sdb_regnr);
401extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
88c72b7d 402
0fde2c53
DE
403/* Provide a default mapping from a DWARF2 register number to a gdb REGNUM.
404 Return -1 for bad REGNUM. Note: Several targets get this wrong. */
ba2b1c56 405
d3f73121 406typedef int (gdbarch_dwarf2_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int dwarf2_regnr);
88c72b7d
AC
407extern int gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, int dwarf2_regnr);
408extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
88c72b7d 409
d93859e2 410typedef const char * (gdbarch_register_name_ftype) (struct gdbarch *gdbarch, int regnr);
fa88f677 411extern const char * gdbarch_register_name (struct gdbarch *gdbarch, int regnr);
104c1213 412extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
0f71a2f6 413
7b9ee6a8
DJ
414/* Return the type of a register specified by the architecture. Only
415 the register cache should call this function directly; others should
416 use "register_type". */
9c04cab7 417
39535193 418extern bool gdbarch_register_type_p (struct gdbarch *gdbarch);
9c04cab7
AC
419
420typedef struct type * (gdbarch_register_type_ftype) (struct gdbarch *gdbarch, int reg_nr);
421extern struct type * gdbarch_register_type (struct gdbarch *gdbarch, int reg_nr);
422extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
423
8bcb5208
AB
424/* Generate a dummy frame_id for THIS_FRAME assuming that the frame is
425 a dummy frame. A dummy frame is created before an inferior call,
426 the frame_id returned here must match the frame_id that was built
427 for the inferior call. Usually this means the returned frame_id's
428 stack address should match the address returned by
429 gdbarch_push_dummy_call, and the returned frame_id's code address
430 should match the address at which the breakpoint was set in the dummy
431 frame. */
f3be58bc 432
669fac23
DJ
433typedef struct frame_id (gdbarch_dummy_id_ftype) (struct gdbarch *gdbarch, struct frame_info *this_frame);
434extern struct frame_id gdbarch_dummy_id (struct gdbarch *gdbarch, struct frame_info *this_frame);
435extern void set_gdbarch_dummy_id (struct gdbarch *gdbarch, gdbarch_dummy_id_ftype *dummy_id);
f3be58bc 436
669fac23 437/* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
064f5156 438 deprecated_fp_regnum. */
f3be58bc 439
f3be58bc
AC
440extern int gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch);
441extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
f3be58bc 442
39535193 443extern bool gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
b8de8283 444
cf84fa6b
AH
445typedef CORE_ADDR (gdbarch_push_dummy_call_ftype) (struct gdbarch *gdbarch, struct value *function, struct regcache *regcache, CORE_ADDR bp_addr, int nargs, struct value **args, CORE_ADDR sp, function_call_return_method return_method, CORE_ADDR struct_addr);
446extern CORE_ADDR gdbarch_push_dummy_call (struct gdbarch *gdbarch, struct value *function, struct regcache *regcache, CORE_ADDR bp_addr, int nargs, struct value **args, CORE_ADDR sp, function_call_return_method return_method, CORE_ADDR struct_addr);
b8de8283
AC
447extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
448
b8de8283
AC
449extern int gdbarch_call_dummy_location (struct gdbarch *gdbarch);
450extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, int call_dummy_location);
b8de8283 451
39535193 452extern bool gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
b8de8283 453
82585c72
UW
454typedef CORE_ADDR (gdbarch_push_dummy_code_ftype) (struct gdbarch *gdbarch, CORE_ADDR sp, CORE_ADDR funaddr, struct value **args, int nargs, struct type *value_type, CORE_ADDR *real_pc, CORE_ADDR *bp_addr, struct regcache *regcache);
455extern CORE_ADDR gdbarch_push_dummy_code (struct gdbarch *gdbarch, CORE_ADDR sp, CORE_ADDR funaddr, struct value **args, int nargs, struct type *value_type, CORE_ADDR *real_pc, CORE_ADDR *bp_addr, struct regcache *regcache);
b8de8283
AC
456extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
457
7eb89530
YQ
458/* Return true if the code of FRAME is writable. */
459
460typedef int (gdbarch_code_of_frame_writable_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
461extern int gdbarch_code_of_frame_writable (struct gdbarch *gdbarch, struct frame_info *frame);
462extern void set_gdbarch_code_of_frame_writable (struct gdbarch *gdbarch, gdbarch_code_of_frame_writable_ftype *code_of_frame_writable);
463
0ab7a791
AC
464typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
465extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
466extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
467
23e3a7ac
AC
468typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
469extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
5e74b15c 470extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
5e74b15c 471
39535193 472extern bool gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
e76f1f2e
AC
473
474typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
475extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
476extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
477
7c7651b2
AC
478/* MAP a GDB RAW register number onto a simulator register number. See
479 also include/...-sim.h. */
480
e7faf938 481typedef int (gdbarch_register_sim_regno_ftype) (struct gdbarch *gdbarch, int reg_nr);
7c7651b2
AC
482extern int gdbarch_register_sim_regno (struct gdbarch *gdbarch, int reg_nr);
483extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
7c7651b2 484
64a3914f 485typedef int (gdbarch_cannot_fetch_register_ftype) (struct gdbarch *gdbarch, int regnum);
01fb7433
AC
486extern int gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, int regnum);
487extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
01fb7433 488
64a3914f 489typedef int (gdbarch_cannot_store_register_ftype) (struct gdbarch *gdbarch, int regnum);
01fb7433
AC
490extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
491extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
01fb7433 492
eade6471
JB
493/* Determine the address where a longjmp will land and save this address
494 in PC. Return nonzero on success.
495
496 FRAME corresponds to the longjmp frame. */
9df628e0 497
39535193 498extern bool gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
0f71a2f6 499
60ade65d
UW
500typedef int (gdbarch_get_longjmp_target_ftype) (struct frame_info *frame, CORE_ADDR *pc);
501extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR *pc);
b8de8283 502extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
0f71a2f6 503
104c1213
JM
504extern int gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch);
505extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
0f71a2f6 506
0abe36f5 507typedef int (gdbarch_convert_register_p_ftype) (struct gdbarch *gdbarch, int regnum, struct type *type);
ff2e87ac 508extern int gdbarch_convert_register_p (struct gdbarch *gdbarch, int regnum, struct type *type);
13d01224 509extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
13d01224 510
8dccd430
PA
511typedef int (gdbarch_register_to_value_ftype) (struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
512extern int gdbarch_register_to_value (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
13d01224 513extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
13d01224 514
b60c417a
AC
515typedef void (gdbarch_value_to_register_ftype) (struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
516extern void gdbarch_value_to_register (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
13d01224 517extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
13d01224 518
9acbedc0 519/* Construct a value representing the contents of register REGNUM in
2ed3c037 520 frame FRAME_ID, interpreted as type TYPE. The routine needs to
9acbedc0
UW
521 allocate and return a struct value with all value attributes
522 (but not the value contents) filled in. */
523
2ed3c037
UW
524typedef struct value * (gdbarch_value_from_register_ftype) (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
525extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
9acbedc0
UW
526extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
527
9898f801 528typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
b60c417a 529extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
4478b372 530extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
33489c5b 531
9898f801 532typedef void (gdbarch_address_to_pointer_ftype) (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
b60c417a 533extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
4478b372 534extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
33489c5b 535
39535193 536extern bool gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
fc0c74b1 537
fc1a4b47
AC
538typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
539extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
fc0c74b1 540extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
fc0c74b1 541
6a3a010b
MR
542/* Return the return-value convention that will be used by FUNCTION
543 to return a value of type VALTYPE. FUNCTION may be NULL in which
ea42b34a
JB
544 case the return convention is computed based only on VALTYPE.
545
546 If READBUF is not NULL, extract the return value and save it in this buffer.
547
548 If WRITEBUF is not NULL, it contains a return value which will be
549 stored into the appropriate register. This can be used when we want
550 to force the value returned by a function (see the "return" command
551 for instance). */
92ad9cd9 552
39535193 553extern bool gdbarch_return_value_p (struct gdbarch *gdbarch);
92ad9cd9 554
6a3a010b
MR
555typedef enum return_value_convention (gdbarch_return_value_ftype) (struct gdbarch *gdbarch, struct value *function, struct type *valtype, struct regcache *regcache, gdb_byte *readbuf, const gdb_byte *writebuf);
556extern enum return_value_convention gdbarch_return_value (struct gdbarch *gdbarch, struct value *function, struct type *valtype, struct regcache *regcache, gdb_byte *readbuf, const gdb_byte *writebuf);
92ad9cd9
AC
557extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
558
18648a37
YQ
559/* Return true if the return value of function is stored in the first hidden
560 parameter. In theory, this feature should be language-dependent, specified
561 by language and its ABI, such as C++. Unfortunately, compiler may
562 implement it to a target-dependent feature. So that we need such hook here
563 to be aware of this in GDB. */
564
565typedef int (gdbarch_return_in_first_hidden_param_p_ftype) (struct gdbarch *gdbarch, struct type *type);
566extern int gdbarch_return_in_first_hidden_param_p (struct gdbarch *gdbarch, struct type *type);
567extern void set_gdbarch_return_in_first_hidden_param_p (struct gdbarch *gdbarch, gdbarch_return_in_first_hidden_param_p_ftype *return_in_first_hidden_param_p);
568
6093d2eb 569typedef CORE_ADDR (gdbarch_skip_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
104c1213
JM
570extern CORE_ADDR gdbarch_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
571extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
0f71a2f6 572
39535193 573extern bool gdbarch_skip_main_prologue_p (struct gdbarch *gdbarch);
4309257c
PM
574
575typedef CORE_ADDR (gdbarch_skip_main_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
576extern CORE_ADDR gdbarch_skip_main_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
577extern void set_gdbarch_skip_main_prologue (struct gdbarch *gdbarch, gdbarch_skip_main_prologue_ftype *skip_main_prologue);
578
591a12a1
UW
579/* On some platforms, a single function may provide multiple entry points,
580 e.g. one that is used for function-pointer calls and a different one
581 that is used for direct function calls.
582 In order to ensure that breakpoints set on the function will trigger
583 no matter via which entry point the function is entered, a platform
584 may provide the skip_entrypoint callback. It is called with IP set
585 to the main entry point of a function (as determined by the symbol table),
586 and should return the address of the innermost entry point, where the
587 actual breakpoint needs to be set. Note that skip_entrypoint is used
588 by GDB common code even when debugging optimized code, where skip_prologue
589 is not used. */
590
39535193 591extern bool gdbarch_skip_entrypoint_p (struct gdbarch *gdbarch);
591a12a1
UW
592
593typedef CORE_ADDR (gdbarch_skip_entrypoint_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
594extern CORE_ADDR gdbarch_skip_entrypoint (struct gdbarch *gdbarch, CORE_ADDR ip);
595extern void set_gdbarch_skip_entrypoint (struct gdbarch *gdbarch, gdbarch_skip_entrypoint_ftype *skip_entrypoint);
596
104c1213
JM
597typedef int (gdbarch_inner_than_ftype) (CORE_ADDR lhs, CORE_ADDR rhs);
598extern int gdbarch_inner_than (struct gdbarch *gdbarch, CORE_ADDR lhs, CORE_ADDR rhs);
599extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
0f71a2f6 600
67d57894 601typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
fc1a4b47 602extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
104c1213 603extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
33489c5b 604
cd6c3b4f
YQ
605/* Return the breakpoint kind for this target based on *PCPTR. */
606
607typedef int (gdbarch_breakpoint_kind_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr);
608extern int gdbarch_breakpoint_kind_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr);
609extern void set_gdbarch_breakpoint_kind_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_kind_from_pc_ftype *breakpoint_kind_from_pc);
610
611/* Return the software breakpoint from KIND. KIND can have target
612 specific meaning like the Z0 kind parameter.
613 SIZE is set to the software breakpoint's length in memory. */
614
615typedef const gdb_byte * (gdbarch_sw_breakpoint_from_kind_ftype) (struct gdbarch *gdbarch, int kind, int *size);
616extern const gdb_byte * gdbarch_sw_breakpoint_from_kind (struct gdbarch *gdbarch, int kind, int *size);
617extern void set_gdbarch_sw_breakpoint_from_kind (struct gdbarch *gdbarch, gdbarch_sw_breakpoint_from_kind_ftype *sw_breakpoint_from_kind);
618
833b7ab5
YQ
619/* Return the breakpoint kind for this target based on the current
620 processor state (e.g. the current instruction mode on ARM) and the
621 *PCPTR. In default, it is gdbarch->breakpoint_kind_from_pc. */
622
623typedef int (gdbarch_breakpoint_kind_from_current_state_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR *pcptr);
624extern int gdbarch_breakpoint_kind_from_current_state (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR *pcptr);
625extern void set_gdbarch_breakpoint_kind_from_current_state (struct gdbarch *gdbarch, gdbarch_breakpoint_kind_from_current_state_ftype *breakpoint_kind_from_current_state);
626
39535193 627extern bool gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
a1131521
KB
628
629typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
630extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
631extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
632
ae4b2284 633typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
8181d85f 634extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
917317f4 635extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
33489c5b 636
ae4b2284 637typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
8181d85f 638extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
917317f4 639extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
917317f4 640
104c1213
JM
641extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
642extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
0f71a2f6 643
782263ab
AC
644/* A function can be addressed by either it's "pointer" (possibly a
645 descriptor address) or "entry point" (first executable instruction).
646 The method "convert_from_func_ptr_addr" converting the former to the
cbf3b44a 647 latter. gdbarch_deprecated_function_start_offset is being used to implement
782263ab
AC
648 a simplified subset of that functionality - the function's address
649 corresponds to the "function pointer" and the function's start
650 corresponds to the "function entry point" - and hence is redundant. */
651
652extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
653extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
0f71a2f6 654
123dc839
DJ
655/* Return the remote protocol register number associated with this
656 register. Normally the identity mapping. */
657
658typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
659extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
660extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
661
b2756930
KB
662/* Fetch the target specific address used to represent a load module. */
663
39535193 664extern bool gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
b2756930
KB
665
666typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
667extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
668extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
b2756930 669
6e056c81
JB
670/* Return the thread-local address at OFFSET in the thread-local
671 storage for the thread PTID and the shared library or executable
672 file given by LM_ADDR. If that block of thread-local storage hasn't
673 been allocated yet, this function may throw an error. LM_ADDR may
674 be zero for statically linked multithreaded inferiors. */
675
39535193 676extern bool gdbarch_get_thread_local_address_p (struct gdbarch *gdbarch);
6e056c81
JB
677
678typedef CORE_ADDR (gdbarch_get_thread_local_address_ftype) (struct gdbarch *gdbarch, ptid_t ptid, CORE_ADDR lm_addr, CORE_ADDR offset);
679extern CORE_ADDR gdbarch_get_thread_local_address (struct gdbarch *gdbarch, ptid_t ptid, CORE_ADDR lm_addr, CORE_ADDR offset);
680extern void set_gdbarch_get_thread_local_address (struct gdbarch *gdbarch, gdbarch_get_thread_local_address_ftype *get_thread_local_address);
681
104c1213
JM
682extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
683extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
0f71a2f6 684
12cc2063
AC
685typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
686extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, struct frame_info *next_frame);
687extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
688
a9e5fdc2
AC
689typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
690extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, struct frame_info *next_frame);
691extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
692
42efa47a
AC
693/* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
694 frame-base. Enable frame-base before frame-unwind. */
695
39535193 696extern bool gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
983a287a 697
104c1213
JM
698typedef int (gdbarch_frame_num_args_ftype) (struct frame_info *frame);
699extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, struct frame_info *frame);
700extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
0f71a2f6 701
39535193 702extern bool gdbarch_frame_align_p (struct gdbarch *gdbarch);
dc604539
AC
703
704typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
705extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
706extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
707
192cb3d4
MK
708typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
709extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
710extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
711
8b148df9
AC
712extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
713extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
8b148df9 714
e2d0e7eb
AC
715typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
716extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
f517ea4e 717extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
f517ea4e 718
875e1767
AC
719/* On some machines there are bits in addresses which are not really
720 part of the address, but are used by the kernel, the hardware, etc.
bf6ae464 721 for special purposes. gdbarch_addr_bits_remove takes out any such bits so
875e1767
AC
722 we get a "real" address such as one would find in a symbol table.
723 This is used only for addresses of instructions, and even then I'm
724 not sure it's used in all contexts. It exists to deal with there
725 being a few stray bits in the PC which would mislead us, not as some
726 sort of generic thing to handle alignment or segmentation (it's
727 possible it should be in TARGET_READ_PC instead). */
728
24568a2c 729typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
875e1767
AC
730extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
731extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
875e1767 732
a738ea1d
YQ
733/* On some machines, not all bits of an address word are significant.
734 For example, on AArch64, the top bits of an address known as the "tag"
735 are ignored by the kernel, the hardware, etc. and can be regarded as
736 additional data associated with the address. */
737
738extern int gdbarch_significant_addr_bit (struct gdbarch *gdbarch);
739extern void set_gdbarch_significant_addr_bit (struct gdbarch *gdbarch, int significant_addr_bit);
740
c193949e
LM
741/* Return a string representation of the memory tag TAG. */
742
743typedef std::string (gdbarch_memtag_to_string_ftype) (struct gdbarch *gdbarch, struct value *tag);
744extern std::string gdbarch_memtag_to_string (struct gdbarch *gdbarch, struct value *tag);
745extern void set_gdbarch_memtag_to_string (struct gdbarch *gdbarch, gdbarch_memtag_to_string_ftype *memtag_to_string);
746
05558223
LM
747/* Return true if ADDRESS contains a tag and false otherwise. ADDRESS
748 must be either a pointer or a reference type. */
c193949e
LM
749
750typedef bool (gdbarch_tagged_address_p_ftype) (struct gdbarch *gdbarch, struct value *address);
751extern bool gdbarch_tagged_address_p (struct gdbarch *gdbarch, struct value *address);
752extern void set_gdbarch_tagged_address_p (struct gdbarch *gdbarch, gdbarch_tagged_address_p_ftype *tagged_address_p);
753
754/* Return true if the tag from ADDRESS matches the memory tag for that
755 particular address. Return false otherwise. */
756
757typedef bool (gdbarch_memtag_matches_p_ftype) (struct gdbarch *gdbarch, struct value *address);
758extern bool gdbarch_memtag_matches_p (struct gdbarch *gdbarch, struct value *address);
759extern void set_gdbarch_memtag_matches_p (struct gdbarch *gdbarch, gdbarch_memtag_matches_p_ftype *memtag_matches_p);
760
761/* Set the tags of type TAG_TYPE, for the memory address range
762 [ADDRESS, ADDRESS + LENGTH) to TAGS.
763 Return true if successful and false otherwise. */
764
765typedef bool (gdbarch_set_memtags_ftype) (struct gdbarch *gdbarch, struct value *address, size_t length, const gdb::byte_vector &tags, memtag_type tag_type);
766extern bool gdbarch_set_memtags (struct gdbarch *gdbarch, struct value *address, size_t length, const gdb::byte_vector &tags, memtag_type tag_type);
767extern void set_gdbarch_set_memtags (struct gdbarch *gdbarch, gdbarch_set_memtags_ftype *set_memtags);
768
769/* Return the tag of type TAG_TYPE associated with the memory address ADDRESS,
770 assuming ADDRESS is tagged. */
771
772typedef struct value * (gdbarch_get_memtag_ftype) (struct gdbarch *gdbarch, struct value *address, memtag_type tag_type);
773extern struct value * gdbarch_get_memtag (struct gdbarch *gdbarch, struct value *address, memtag_type tag_type);
774extern void set_gdbarch_get_memtag (struct gdbarch *gdbarch, gdbarch_get_memtag_ftype *get_memtag);
775
776/* memtag_granule_size is the size of the allocation tag granule, for
777 architectures that support memory tagging.
778 This is 0 for architectures that do not support memory tagging.
779 For a non-zero value, this represents the number of bytes of memory per tag. */
780
781extern CORE_ADDR gdbarch_memtag_granule_size (struct gdbarch *gdbarch);
782extern void set_gdbarch_memtag_granule_size (struct gdbarch *gdbarch, CORE_ADDR memtag_granule_size);
783
e6590a1b
UW
784/* FIXME/cagney/2001-01-18: This should be split in two. A target method that
785 indicates if the target needs software single step. An ISA method to
786 implement it.
64c4637f 787
e6590a1b
UW
788 FIXME/cagney/2001-01-18: The logic is backwards. It should be asking if the
789 target can single step. If not, then implement single step using breakpoints.
790
93f9a11f
YQ
791 Return a vector of addresses on which the software single step
792 breakpoints should be inserted. NULL means software single step is
793 not used.
794 Multiple breakpoints may be inserted for some instructions such as
795 conditional branch. However, each implementation must always evaluate
796 the condition and only put the breakpoint at the branch destination if
797 the condition is true, so that we ensure forward progress when stepping
798 past a conditional branch to self. */
64c4637f 799
39535193 800extern bool gdbarch_software_single_step_p (struct gdbarch *gdbarch);
64c4637f 801
a0ff9e1a
SM
802typedef std::vector<CORE_ADDR> (gdbarch_software_single_step_ftype) (struct regcache *regcache);
803extern std::vector<CORE_ADDR> gdbarch_software_single_step (struct gdbarch *gdbarch, struct regcache *regcache);
64c4637f 804extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
64c4637f 805
3352ef37
AC
806/* Return non-zero if the processor is executing a delay slot and a
807 further single-step is needed before the instruction finishes. */
808
39535193 809extern bool gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
3352ef37
AC
810
811typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
812extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, struct frame_info *frame);
813extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
814
f6c40618 815/* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
b2fa5097 816 disassembler. Perhaps objdump can handle it? */
f6c40618 817
a89aa300
AC
818typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
819extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
2bf0cb65 820extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
2bf0cb65 821
52f729a7
UW
822typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (struct frame_info *frame, CORE_ADDR pc);
823extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR pc);
bdcd319a 824extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
bdcd319a 825
cfd8ab24 826/* If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
dea0c52f
MK
827 evaluates non-zero, this is the address where the debugger will place
828 a step-resume breakpoint to get us past the dynamic linker. */
829
4c8c40e6 830typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
dea0c52f
MK
831extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
832extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
dea0c52f 833
d50355b6
MS
834/* Some systems also have trampoline code for returning from shared libs. */
835
2c02bd72
DE
836typedef int (gdbarch_in_solib_return_trampoline_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
837extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
d50355b6 838extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
d50355b6 839
1d509aa6
MM
840/* Return true if PC lies inside an indirect branch thunk. */
841
842typedef bool (gdbarch_in_indirect_branch_thunk_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
843extern bool gdbarch_in_indirect_branch_thunk (struct gdbarch *gdbarch, CORE_ADDR pc);
844extern void set_gdbarch_in_indirect_branch_thunk (struct gdbarch *gdbarch, gdbarch_in_indirect_branch_thunk_ftype *in_indirect_branch_thunk);
845
c12260ac
CV
846/* A target might have problems with watchpoints as soon as the stack
847 frame of the current function has been destroyed. This mostly happens
c9cf6e20 848 as the first action in a function's epilogue. stack_frame_destroyed_p()
c12260ac
CV
849 is defined to return a non-zero value if either the given addr is one
850 instruction after the stack destroying instruction up to the trailing
851 return instruction or if we can figure out that the stack frame has
852 already been invalidated regardless of the value of addr. Targets
853 which don't suffer from that problem could just let this functionality
854 untouched. */
855
c9cf6e20
MG
856typedef int (gdbarch_stack_frame_destroyed_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
857extern int gdbarch_stack_frame_destroyed_p (struct gdbarch *gdbarch, CORE_ADDR addr);
858extern void set_gdbarch_stack_frame_destroyed_p (struct gdbarch *gdbarch, gdbarch_stack_frame_destroyed_p_ftype *stack_frame_destroyed_p);
c12260ac 859
3e29f34a
MR
860/* Process an ELF symbol in the minimal symbol table in a backend-specific
861 way. Normally this hook is supposed to do nothing, however if required,
862 then this hook can be used to apply tranformations to symbols that are
863 considered special in some way. For example the MIPS backend uses it
864 to interpret `st_other' information to mark compressed code symbols so
865 that they can be treated in the appropriate manner in the processing of
866 the main symbol table and DWARF-2 records. */
867
39535193 868extern bool gdbarch_elf_make_msymbol_special_p (struct gdbarch *gdbarch);
3e29f34a 869
a2cf933a
EZ
870typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
871extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
872extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
a2cf933a 873
a2cf933a
EZ
874typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
875extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
876extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
a2cf933a 877
3e29f34a
MR
878/* Process a symbol in the main symbol table in a backend-specific way.
879 Normally this hook is supposed to do nothing, however if required,
880 then this hook can be used to apply tranformations to symbols that
881 are considered special in some way. This is currently used by the
882 MIPS backend to make sure compressed code symbols have the ISA bit
883 set. This in turn is needed for symbol values seen in GDB to match
884 the values used at the runtime by the program itself, for function
885 and label references. */
886
887typedef void (gdbarch_make_symbol_special_ftype) (struct symbol *sym, struct objfile *objfile);
888extern void gdbarch_make_symbol_special (struct gdbarch *gdbarch, struct symbol *sym, struct objfile *objfile);
889extern void set_gdbarch_make_symbol_special (struct gdbarch *gdbarch, gdbarch_make_symbol_special_ftype *make_symbol_special);
890
891/* Adjust the address retrieved from a DWARF-2 record other than a line
892 entry in a backend-specific way. Normally this hook is supposed to
893 return the address passed unchanged, however if that is incorrect for
894 any reason, then this hook can be used to fix the address up in the
895 required manner. This is currently used by the MIPS backend to make
896 sure addresses in FDE, range records, etc. referring to compressed
897 code have the ISA bit set, matching line information and the symbol
898 table. */
899
900typedef CORE_ADDR (gdbarch_adjust_dwarf2_addr_ftype) (CORE_ADDR pc);
901extern CORE_ADDR gdbarch_adjust_dwarf2_addr (struct gdbarch *gdbarch, CORE_ADDR pc);
902extern void set_gdbarch_adjust_dwarf2_addr (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_addr_ftype *adjust_dwarf2_addr);
903
904/* Adjust the address updated by a line entry in a backend-specific way.
905 Normally this hook is supposed to return the address passed unchanged,
906 however in the case of inconsistencies in these records, this hook can
907 be used to fix them up in the required manner. This is currently used
908 by the MIPS backend to make sure all line addresses in compressed code
909 are presented with the ISA bit set, which is not always the case. This
910 in turn ensures breakpoint addresses are correctly matched against the
911 stop PC. */
912
913typedef CORE_ADDR (gdbarch_adjust_dwarf2_line_ftype) (CORE_ADDR addr, int rel);
914extern CORE_ADDR gdbarch_adjust_dwarf2_line (struct gdbarch *gdbarch, CORE_ADDR addr, int rel);
915extern void set_gdbarch_adjust_dwarf2_line (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_line_ftype *adjust_dwarf2_line);
916
c4ed33b9
AC
917extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
918extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
c4ed33b9 919
0c888588
PA
920/* See comment in target.h about continuable, steppable and
921 non-steppable watchpoints. */
7ea65f08 922
f74fa174
MM
923extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
924extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
f74fa174 925
39535193 926extern bool gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
8b2dbe47 927
314ad88d
PA
928typedef type_instance_flags (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
929extern type_instance_flags gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
8b2dbe47 930extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
8b2dbe47 931
39535193 932extern bool gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
8b2dbe47 933
314ad88d
PA
934typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, type_instance_flags type_flags);
935extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, type_instance_flags type_flags);
8b2dbe47 936extern void set_gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_to_name_ftype *address_class_type_flags_to_name);
8b2dbe47 937
b41c5a85
JW
938/* Execute vendor-specific DWARF Call Frame Instruction. OP is the instruction.
939 FS are passed from the generic execute_cfa_program function. */
940
941typedef bool (gdbarch_execute_dwarf_cfa_vendor_op_ftype) (struct gdbarch *gdbarch, gdb_byte op, struct dwarf2_frame_state *fs);
942extern bool gdbarch_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdb_byte op, struct dwarf2_frame_state *fs);
943extern void set_gdbarch_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdbarch_execute_dwarf_cfa_vendor_op_ftype *execute_dwarf_cfa_vendor_op);
944
69f97648 945/* Return the appropriate type_flags for the supplied address class.
314ad88d
PA
946 This function should return true if the address class was recognized and
947 type_flags was set, false otherwise. */
69f97648 948
39535193 949extern bool gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
8b2dbe47 950
314ad88d
PA
951typedef bool (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, type_instance_flags *type_flags_ptr);
952extern bool gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, type_instance_flags *type_flags_ptr);
8b2dbe47 953extern void set_gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_name_to_type_flags_ftype *address_class_name_to_type_flags);
8b2dbe47 954
b59ff9d5
AC
955/* Is a register in a group */
956
957typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
958extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
959extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
960
2e092625 961/* Fetch the pointer to the ith function argument. */
143985b7 962
39535193 963extern bool gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
143985b7 964
143985b7
AF
965typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (struct frame_info *frame, int argi, struct type *type);
966extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, struct frame_info *frame, int argi, struct type *type);
967extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
143985b7 968
5aa82d05
AA
969/* Iterate over all supported register notes in a core file. For each
970 supported register note section, the iterator must call CB and pass
971 CB_DATA unchanged. If REGCACHE is not NULL, the iterator can limit
972 the supported register note sections based on the current register
973 values. Otherwise it should enumerate all supported register note
974 sections. */
975
39535193 976extern bool gdbarch_iterate_over_regset_sections_p (struct gdbarch *gdbarch);
17ea7499 977
5aa82d05
AA
978typedef void (gdbarch_iterate_over_regset_sections_ftype) (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
979extern void gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
980extern void set_gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, gdbarch_iterate_over_regset_sections_ftype *iterate_over_regset_sections);
17ea7499 981
6432734d
UW
982/* Create core file notes */
983
39535193 984extern bool gdbarch_make_corefile_notes_p (struct gdbarch *gdbarch);
6432734d 985
c21f37a8
SM
986typedef gdb::unique_xmalloc_ptr<char> (gdbarch_make_corefile_notes_ftype) (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
987extern gdb::unique_xmalloc_ptr<char> gdbarch_make_corefile_notes (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
6432734d
UW
988extern void set_gdbarch_make_corefile_notes (struct gdbarch *gdbarch, gdbarch_make_corefile_notes_ftype *make_corefile_notes);
989
35c2fab7
UW
990/* Find core file memory regions */
991
39535193 992extern bool gdbarch_find_memory_regions_p (struct gdbarch *gdbarch);
35c2fab7
UW
993
994typedef int (gdbarch_find_memory_regions_ftype) (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
995extern int gdbarch_find_memory_regions (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
996extern void set_gdbarch_find_memory_regions (struct gdbarch *gdbarch, gdbarch_find_memory_regions_ftype *find_memory_regions);
997
de584861 998/* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
c09f20e4
YQ
999 core file into buffer READBUF with length LEN. Return the number of bytes read
1000 (zero indicates failure).
1001 failed, otherwise, return the red length of READBUF. */
de584861 1002
39535193 1003extern bool gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
de584861 1004
c09f20e4
YQ
1005typedef ULONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
1006extern ULONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
de584861
PA
1007extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
1008
356a5233 1009/* Read offset OFFSET of TARGET_OBJECT_LIBRARIES_AIX formatted shared
c09f20e4
YQ
1010 libraries list from core file into buffer READBUF with length LEN.
1011 Return the number of bytes read (zero indicates failure). */
356a5233 1012
39535193 1013extern bool gdbarch_core_xfer_shared_libraries_aix_p (struct gdbarch *gdbarch);
356a5233 1014
c09f20e4
YQ
1015typedef ULONGEST (gdbarch_core_xfer_shared_libraries_aix_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
1016extern ULONGEST gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
356a5233
JB
1017extern void set_gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_aix_ftype *core_xfer_shared_libraries_aix);
1018
c0edd9ed 1019/* How the core target converts a PTID from a core file to a string. */
28439f5e 1020
39535193 1021extern bool gdbarch_core_pid_to_str_p (struct gdbarch *gdbarch);
28439f5e 1022
a068643d
TT
1023typedef std::string (gdbarch_core_pid_to_str_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
1024extern std::string gdbarch_core_pid_to_str (struct gdbarch *gdbarch, ptid_t ptid);
28439f5e
PA
1025extern void set_gdbarch_core_pid_to_str (struct gdbarch *gdbarch, gdbarch_core_pid_to_str_ftype *core_pid_to_str);
1026
4dfc5dbc
JB
1027/* How the core target extracts the name of a thread from a core file. */
1028
39535193 1029extern bool gdbarch_core_thread_name_p (struct gdbarch *gdbarch);
4dfc5dbc
JB
1030
1031typedef const char * (gdbarch_core_thread_name_ftype) (struct gdbarch *gdbarch, struct thread_info *thr);
1032extern const char * gdbarch_core_thread_name (struct gdbarch *gdbarch, struct thread_info *thr);
1033extern void set_gdbarch_core_thread_name (struct gdbarch *gdbarch, gdbarch_core_thread_name_ftype *core_thread_name);
1034
382b69bb
JB
1035/* Read offset OFFSET of TARGET_OBJECT_SIGNAL_INFO signal information
1036 from core file into buffer READBUF with length LEN. Return the number
1037 of bytes read (zero indicates EOF, a negative value indicates failure). */
1038
39535193 1039extern bool gdbarch_core_xfer_siginfo_p (struct gdbarch *gdbarch);
382b69bb
JB
1040
1041typedef LONGEST (gdbarch_core_xfer_siginfo_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
1042extern LONGEST gdbarch_core_xfer_siginfo (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
1043extern void set_gdbarch_core_xfer_siginfo (struct gdbarch *gdbarch, gdbarch_core_xfer_siginfo_ftype *core_xfer_siginfo);
1044
a78c2d62
UW
1045/* BFD target to use when generating a core file. */
1046
39535193 1047extern bool gdbarch_gcore_bfd_target_p (struct gdbarch *gdbarch);
a78c2d62
UW
1048
1049extern const char * gdbarch_gcore_bfd_target (struct gdbarch *gdbarch);
1050extern void set_gdbarch_gcore_bfd_target (struct gdbarch *gdbarch, const char * gcore_bfd_target);
1051
0d5de010
DJ
1052/* If the elements of C++ vtables are in-place function descriptors rather
1053 than normal function pointers (which may point to code or a descriptor),
1054 set this to one. */
1055
1056extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
1057extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
1058
1059/* Set if the least significant bit of the delta is used instead of the least
1060 significant bit of the pfn for pointers to virtual member functions. */
1061
1062extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
1063extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
1064
6d350bb5
UW
1065/* Advance PC to next instruction in order to skip a permanent breakpoint. */
1066
6d350bb5
UW
1067typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
1068extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
1069extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
1070
1668ae25 1071/* The maximum length of an instruction on this architecture in bytes. */
237fc4c9 1072
39535193 1073extern bool gdbarch_max_insn_length_p (struct gdbarch *gdbarch);
237fc4c9
PA
1074
1075extern ULONGEST gdbarch_max_insn_length (struct gdbarch *gdbarch);
1076extern void set_gdbarch_max_insn_length (struct gdbarch *gdbarch, ULONGEST max_insn_length);
1077
1078/* Copy the instruction at FROM to TO, and make any adjustments
1079 necessary to single-step it at that address.
1080
1081 REGS holds the state the thread's registers will have before
1082 executing the copied instruction; the PC in REGS will refer to FROM,
1083 not the copy at TO. The caller should update it to point at TO later.
1084
1085 Return a pointer to data of the architecture's choice to be passed
19b187a9 1086 to gdbarch_displaced_step_fixup.
237fc4c9
PA
1087
1088 For a general explanation of displaced stepping and how GDB uses it,
1089 see the comments in infrun.c.
1090
1091 The TO area is only guaranteed to have space for
1092 gdbarch_max_insn_length (arch) bytes, so this function must not
1093 write more bytes than that to that area.
1094
1095 If you do not provide this function, GDB assumes that the
1096 architecture does not support displaced stepping.
1097
7f03bd92
PA
1098 If the instruction cannot execute out of line, return NULL. The
1099 core falls back to stepping past the instruction in-line instead in
1100 that case. */
237fc4c9 1101
39535193 1102extern bool gdbarch_displaced_step_copy_insn_p (struct gdbarch *gdbarch);
237fc4c9 1103
1152d984
SM
1104typedef displaced_step_copy_insn_closure_up (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1105extern displaced_step_copy_insn_closure_up gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
237fc4c9
PA
1106extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
1107
58103c33
SM
1108/* Return true if GDB should use hardware single-stepping to execute a displaced
1109 step instruction. If false, GDB will simply restart execution at the
1110 displaced instruction location, and it is up to the target to ensure GDB will
1111 receive control again (e.g. by placing a software breakpoint instruction into
1112 the displaced instruction buffer).
99e40580 1113
58103c33
SM
1114 The default implementation returns false on all targets that provide a
1115 gdbarch_software_single_step routine, and true otherwise. */
99e40580 1116
40a53766
SM
1117typedef bool (gdbarch_displaced_step_hw_singlestep_ftype) (struct gdbarch *gdbarch);
1118extern bool gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch);
99e40580
UW
1119extern void set_gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, gdbarch_displaced_step_hw_singlestep_ftype *displaced_step_hw_singlestep);
1120
237fc4c9
PA
1121/* Fix up the state resulting from successfully single-stepping a
1122 displaced instruction, to give the result we would have gotten from
1123 stepping the instruction in its original location.
1124
1125 REGS is the register state resulting from single-stepping the
1126 displaced instruction.
1127
1128 CLOSURE is the result from the matching call to
1129 gdbarch_displaced_step_copy_insn.
1130
1131 If you provide gdbarch_displaced_step_copy_insn.but not this
1132 function, then GDB assumes that no fixup is needed after
1133 single-stepping the instruction.
1134
1135 For a general explanation of displaced stepping and how GDB uses it,
1136 see the comments in infrun.c. */
1137
39535193 1138extern bool gdbarch_displaced_step_fixup_p (struct gdbarch *gdbarch);
237fc4c9 1139
1152d984
SM
1140typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_copy_insn_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1141extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_copy_insn_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
237fc4c9
PA
1142extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
1143
187b041e 1144/* Prepare THREAD for it to displaced step the instruction at its current PC.
237fc4c9 1145
187b041e
SM
1146 Throw an exception if any unexpected error happens. */
1147
1148extern bool gdbarch_displaced_step_prepare_p (struct gdbarch *gdbarch);
1149
1150typedef displaced_step_prepare_status (gdbarch_displaced_step_prepare_ftype) (struct gdbarch *gdbarch, thread_info *thread, CORE_ADDR &displaced_pc);
1151extern displaced_step_prepare_status gdbarch_displaced_step_prepare (struct gdbarch *gdbarch, thread_info *thread, CORE_ADDR &displaced_pc);
1152extern void set_gdbarch_displaced_step_prepare (struct gdbarch *gdbarch, gdbarch_displaced_step_prepare_ftype *displaced_step_prepare);
1153
1154/* Clean up after a displaced step of THREAD. */
1155
1156typedef displaced_step_finish_status (gdbarch_displaced_step_finish_ftype) (struct gdbarch *gdbarch, thread_info *thread, gdb_signal sig);
1157extern displaced_step_finish_status gdbarch_displaced_step_finish (struct gdbarch *gdbarch, thread_info *thread, gdb_signal sig);
1158extern void set_gdbarch_displaced_step_finish (struct gdbarch *gdbarch, gdbarch_displaced_step_finish_ftype *displaced_step_finish);
1159
1160/* Return the closure associated to the displaced step buffer that is at ADDR. */
1161
1162extern bool gdbarch_displaced_step_copy_insn_closure_by_addr_p (struct gdbarch *gdbarch);
1163
1164typedef const displaced_step_copy_insn_closure * (gdbarch_displaced_step_copy_insn_closure_by_addr_ftype) (inferior *inf, CORE_ADDR addr);
1165extern const displaced_step_copy_insn_closure * gdbarch_displaced_step_copy_insn_closure_by_addr (struct gdbarch *gdbarch, inferior *inf, CORE_ADDR addr);
1166extern void set_gdbarch_displaced_step_copy_insn_closure_by_addr (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_closure_by_addr_ftype *displaced_step_copy_insn_closure_by_addr);
1167
1168/* PARENT_INF has forked and CHILD_PTID is the ptid of the child. Restore the
1169 contents of all displaced step buffers in the child's address space. */
237fc4c9 1170
187b041e
SM
1171typedef void (gdbarch_displaced_step_restore_all_in_ptid_ftype) (inferior *parent_inf, ptid_t child_ptid);
1172extern void gdbarch_displaced_step_restore_all_in_ptid (struct gdbarch *gdbarch, inferior *parent_inf, ptid_t child_ptid);
1173extern void set_gdbarch_displaced_step_restore_all_in_ptid (struct gdbarch *gdbarch, gdbarch_displaced_step_restore_all_in_ptid_ftype *displaced_step_restore_all_in_ptid);
237fc4c9 1174
dde08ee1
PA
1175/* Relocate an instruction to execute at a different address. OLDLOC
1176 is the address in the inferior memory where the instruction to
1177 relocate is currently at. On input, TO points to the destination
1178 where we want the instruction to be copied (and possibly adjusted)
1179 to. On output, it points to one past the end of the resulting
1180 instruction(s). The effect of executing the instruction at TO shall
1181 be the same as if executing it at FROM. For example, call
1182 instructions that implicitly push the return address on the stack
1183 should be adjusted to return to the instruction after OLDLOC;
1184 relative branches, and other PC-relative instructions need the
1185 offset adjusted; etc. */
1186
39535193 1187extern bool gdbarch_relocate_instruction_p (struct gdbarch *gdbarch);
dde08ee1
PA
1188
1189typedef void (gdbarch_relocate_instruction_ftype) (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
1190extern void gdbarch_relocate_instruction (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
1191extern void set_gdbarch_relocate_instruction (struct gdbarch *gdbarch, gdbarch_relocate_instruction_ftype *relocate_instruction);
1192
1c772458
UW
1193/* Refresh overlay mapped state for section OSECT. */
1194
39535193 1195extern bool gdbarch_overlay_update_p (struct gdbarch *gdbarch);
1c772458
UW
1196
1197typedef void (gdbarch_overlay_update_ftype) (struct obj_section *osect);
1198extern void gdbarch_overlay_update (struct gdbarch *gdbarch, struct obj_section *osect);
1199extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
1200
39535193 1201extern bool gdbarch_core_read_description_p (struct gdbarch *gdbarch);
4eb0ad19
DJ
1202
1203typedef const struct target_desc * (gdbarch_core_read_description_ftype) (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
1204extern const struct target_desc * gdbarch_core_read_description (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
1205extern void set_gdbarch_core_read_description (struct gdbarch *gdbarch, gdbarch_core_read_description_ftype *core_read_description);
1206
203c3895
UW
1207/* Set if the address in N_SO or N_FUN stabs may be zero. */
1208
1209extern int gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch);
1210extern void set_gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch, int sofun_address_maybe_missing);
1211
0508c3ec
HZ
1212/* Parse the instruction at ADDR storing in the record execution log
1213 the registers REGCACHE and memory ranges that will be affected when
1214 the instruction executes, along with their current values.
1215 Return -1 if something goes wrong, 0 otherwise. */
1216
39535193 1217extern bool gdbarch_process_record_p (struct gdbarch *gdbarch);
0508c3ec
HZ
1218
1219typedef int (gdbarch_process_record_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1220extern int gdbarch_process_record (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1221extern void set_gdbarch_process_record (struct gdbarch *gdbarch, gdbarch_process_record_ftype *process_record);
3846b520
HZ
1222
1223/* Save process state after a signal.
1224 Return -1 if something goes wrong, 0 otherwise. */
1225
39535193 1226extern bool gdbarch_process_record_signal_p (struct gdbarch *gdbarch);
3846b520 1227
2ea28649
PA
1228typedef int (gdbarch_process_record_signal_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
1229extern int gdbarch_process_record_signal (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
3846b520 1230extern void set_gdbarch_process_record_signal (struct gdbarch *gdbarch, gdbarch_process_record_signal_ftype *process_record_signal);
0508c3ec 1231
22203bbf 1232/* Signal translation: translate inferior's signal (target's) number
86b49880
PA
1233 into GDB's representation. The implementation of this method must
1234 be host independent. IOW, don't rely on symbols of the NAT_FILE
1235 header (the nm-*.h files), the host <signal.h> header, or similar
1236 headers. This is mainly used when cross-debugging core files ---
1237 "Live" targets hide the translation behind the target interface
1f8cf220
PA
1238 (target_wait, target_resume, etc.). */
1239
39535193 1240extern bool gdbarch_gdb_signal_from_target_p (struct gdbarch *gdbarch);
22203bbf
PA
1241
1242typedef enum gdb_signal (gdbarch_gdb_signal_from_target_ftype) (struct gdbarch *gdbarch, int signo);
1243extern enum gdb_signal gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, int signo);
1244extern void set_gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_from_target_ftype *gdb_signal_from_target);
1cded358 1245
eb14d406
SDJ
1246/* Signal translation: translate the GDB's internal signal number into
1247 the inferior's signal (target's) representation. The implementation
1248 of this method must be host independent. IOW, don't rely on symbols
1249 of the NAT_FILE header (the nm-*.h files), the host <signal.h>
1250 header, or similar headers.
1251 Return the target signal number if found, or -1 if the GDB internal
1252 signal number is invalid. */
1253
39535193 1254extern bool gdbarch_gdb_signal_to_target_p (struct gdbarch *gdbarch);
eb14d406
SDJ
1255
1256typedef int (gdbarch_gdb_signal_to_target_ftype) (struct gdbarch *gdbarch, enum gdb_signal signal);
1257extern int gdbarch_gdb_signal_to_target (struct gdbarch *gdbarch, enum gdb_signal signal);
1258extern void set_gdbarch_gdb_signal_to_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_to_target_ftype *gdb_signal_to_target);
1259
4aa995e1 1260/* Extra signal info inspection.
959b8724 1261
4aa995e1
PA
1262 Return a type suitable to inspect extra signal information. */
1263
39535193 1264extern bool gdbarch_get_siginfo_type_p (struct gdbarch *gdbarch);
4aa995e1
PA
1265
1266typedef struct type * (gdbarch_get_siginfo_type_ftype) (struct gdbarch *gdbarch);
1267extern struct type * gdbarch_get_siginfo_type (struct gdbarch *gdbarch);
1268extern void set_gdbarch_get_siginfo_type (struct gdbarch *gdbarch, gdbarch_get_siginfo_type_ftype *get_siginfo_type);
1269
60c5725c
DJ
1270/* Record architecture-specific information from the symbol table. */
1271
39535193 1272extern bool gdbarch_record_special_symbol_p (struct gdbarch *gdbarch);
60c5725c
DJ
1273
1274typedef void (gdbarch_record_special_symbol_ftype) (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1275extern void gdbarch_record_special_symbol (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1276extern void set_gdbarch_record_special_symbol (struct gdbarch *gdbarch, gdbarch_record_special_symbol_ftype *record_special_symbol);
1277
a96d9b2e
SDJ
1278/* Function for the 'catch syscall' feature.
1279 Get architecture-specific system calls information from registers. */
1280
39535193 1281extern bool gdbarch_get_syscall_number_p (struct gdbarch *gdbarch);
a96d9b2e 1282
00431a78
PA
1283typedef LONGEST (gdbarch_get_syscall_number_ftype) (struct gdbarch *gdbarch, thread_info *thread);
1284extern LONGEST gdbarch_get_syscall_number (struct gdbarch *gdbarch, thread_info *thread);
a96d9b2e
SDJ
1285extern void set_gdbarch_get_syscall_number (struct gdbarch *gdbarch, gdbarch_get_syscall_number_ftype *get_syscall_number);
1286
458c8db8
SDJ
1287/* The filename of the XML syscall for this architecture. */
1288
1289extern const char * gdbarch_xml_syscall_file (struct gdbarch *gdbarch);
1290extern void set_gdbarch_xml_syscall_file (struct gdbarch *gdbarch, const char * xml_syscall_file);
1291
1292/* Information about system calls from this architecture */
1293
1294extern struct syscalls_info * gdbarch_syscalls_info (struct gdbarch *gdbarch);
1295extern void set_gdbarch_syscalls_info (struct gdbarch *gdbarch, struct syscalls_info * syscalls_info);
1296
55aa24fb 1297/* SystemTap related fields and functions.
05c0465e
SDJ
1298 A NULL-terminated array of prefixes used to mark an integer constant
1299 on the architecture's assembly.
55aa24fb
SDJ
1300 For example, on x86 integer constants are written as:
1301
1302 $10 ;; integer constant 10
1303
1304 in this case, this prefix would be the character `$'. */
1305
05c0465e
SDJ
1306extern const char *const * gdbarch_stap_integer_prefixes (struct gdbarch *gdbarch);
1307extern void set_gdbarch_stap_integer_prefixes (struct gdbarch *gdbarch, const char *const * stap_integer_prefixes);
55aa24fb 1308
05c0465e
SDJ
1309/* A NULL-terminated array of suffixes used to mark an integer constant
1310 on the architecture's assembly. */
55aa24fb 1311
05c0465e
SDJ
1312extern const char *const * gdbarch_stap_integer_suffixes (struct gdbarch *gdbarch);
1313extern void set_gdbarch_stap_integer_suffixes (struct gdbarch *gdbarch, const char *const * stap_integer_suffixes);
55aa24fb 1314
05c0465e
SDJ
1315/* A NULL-terminated array of prefixes used to mark a register name on
1316 the architecture's assembly.
55aa24fb
SDJ
1317 For example, on x86 the register name is written as:
1318
1319 %eax ;; register eax
1320
1321 in this case, this prefix would be the character `%'. */
1322
05c0465e
SDJ
1323extern const char *const * gdbarch_stap_register_prefixes (struct gdbarch *gdbarch);
1324extern void set_gdbarch_stap_register_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_prefixes);
55aa24fb 1325
05c0465e
SDJ
1326/* A NULL-terminated array of suffixes used to mark a register name on
1327 the architecture's assembly. */
55aa24fb 1328
05c0465e
SDJ
1329extern const char *const * gdbarch_stap_register_suffixes (struct gdbarch *gdbarch);
1330extern void set_gdbarch_stap_register_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_suffixes);
55aa24fb 1331
05c0465e
SDJ
1332/* A NULL-terminated array of prefixes used to mark a register
1333 indirection on the architecture's assembly.
55aa24fb
SDJ
1334 For example, on x86 the register indirection is written as:
1335
1336 (%eax) ;; indirecting eax
1337
1338 in this case, this prefix would be the charater `('.
1339
1340 Please note that we use the indirection prefix also for register
1341 displacement, e.g., `4(%eax)' on x86. */
1342
05c0465e
SDJ
1343extern const char *const * gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch);
1344extern void set_gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_prefixes);
55aa24fb 1345
05c0465e
SDJ
1346/* A NULL-terminated array of suffixes used to mark a register
1347 indirection on the architecture's assembly.
55aa24fb
SDJ
1348 For example, on x86 the register indirection is written as:
1349
1350 (%eax) ;; indirecting eax
1351
1352 in this case, this prefix would be the charater `)'.
1353
1354 Please note that we use the indirection suffix also for register
1355 displacement, e.g., `4(%eax)' on x86. */
1356
05c0465e
SDJ
1357extern const char *const * gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch);
1358extern void set_gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_suffixes);
55aa24fb 1359
05c0465e 1360/* Prefix(es) used to name a register using GDB's nomenclature.
55aa24fb
SDJ
1361
1362 For example, on PPC a register is represented by a number in the assembly
1363 language (e.g., `10' is the 10th general-purpose register). However,
1364 inside GDB this same register has an `r' appended to its name, so the 10th
1365 register would be represented as `r10' internally. */
1366
1367extern const char * gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch);
1368extern void set_gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch, const char * stap_gdb_register_prefix);
1369
1370/* Suffix used to name a register using GDB's nomenclature. */
1371
1372extern const char * gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch);
1373extern void set_gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch, const char * stap_gdb_register_suffix);
1374
1375/* Check if S is a single operand.
1376
1377 Single operands can be:
1378 - Literal integers, e.g. `$10' on x86
1379 - Register access, e.g. `%eax' on x86
1380 - Register indirection, e.g. `(%eax)' on x86
1381 - Register displacement, e.g. `4(%eax)' on x86
1382
1383 This function should check for these patterns on the string
1384 and return 1 if some were found, or zero otherwise. Please try to match
1385 as much info as you can from the string, i.e., if you have to match
1386 something like `(%', do not match just the `('. */
1387
39535193 1388extern bool gdbarch_stap_is_single_operand_p (struct gdbarch *gdbarch);
55aa24fb
SDJ
1389
1390typedef int (gdbarch_stap_is_single_operand_ftype) (struct gdbarch *gdbarch, const char *s);
1391extern int gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, const char *s);
1392extern void set_gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, gdbarch_stap_is_single_operand_ftype *stap_is_single_operand);
1393
1394/* Function used to handle a "special case" in the parser.
1395
1396 A "special case" is considered to be an unknown token, i.e., a token
1397 that the parser does not know how to parse. A good example of special
1398 case would be ARM's register displacement syntax:
1399
1400 [R0, #4] ;; displacing R0 by 4
1401
1402 Since the parser assumes that a register displacement is of the form:
1403
1404 <number> <indirection_prefix> <register_name> <indirection_suffix>
1405
1406 it means that it will not be able to recognize and parse this odd syntax.
1407 Therefore, we should add a special case function that will handle this token.
1408
1409 This function should generate the proper expression form of the expression
1410 using GDB's internal expression mechanism (e.g., `write_exp_elt_opcode'
1411 and so on). It should also return 1 if the parsing was successful, or zero
1412 if the token was not recognized as a special token (in this case, returning
1413 zero means that the special parser is deferring the parsing to the generic
1414 parser), and should advance the buffer pointer (p->arg). */
1415
39535193 1416extern bool gdbarch_stap_parse_special_token_p (struct gdbarch *gdbarch);
55aa24fb 1417
4c5e7a93
TT
1418typedef expr::operation_up (gdbarch_stap_parse_special_token_ftype) (struct gdbarch *gdbarch, struct stap_parse_info *p);
1419extern expr::operation_up gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, struct stap_parse_info *p);
55aa24fb
SDJ
1420extern void set_gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, gdbarch_stap_parse_special_token_ftype *stap_parse_special_token);
1421
7d7571f0
SDJ
1422/* Perform arch-dependent adjustments to a register name.
1423
1424 In very specific situations, it may be necessary for the register
1425 name present in a SystemTap probe's argument to be handled in a
1426 special way. For example, on i386, GCC may over-optimize the
1427 register allocation and use smaller registers than necessary. In
1428 such cases, the client that is reading and evaluating the SystemTap
1429 probe (ourselves) will need to actually fetch values from the wider
1430 version of the register in question.
1431
1432 To illustrate the example, consider the following probe argument
1433 (i386):
1434
1435 4@%ax
1436
1437 This argument says that its value can be found at the %ax register,
1438 which is a 16-bit register. However, the argument's prefix says
1439 that its type is "uint32_t", which is 32-bit in size. Therefore, in
1440 this case, GDB should actually fetch the probe's value from register
1441 %eax, not %ax. In this scenario, this function would actually
1442 replace the register name from %ax to %eax.
1443
1444 The rationale for this can be found at PR breakpoints/24541. */
1445
39535193 1446extern bool gdbarch_stap_adjust_register_p (struct gdbarch *gdbarch);
7d7571f0 1447
6b78c3f8
AB
1448typedef std::string (gdbarch_stap_adjust_register_ftype) (struct gdbarch *gdbarch, struct stap_parse_info *p, const std::string &regname, int regnum);
1449extern std::string gdbarch_stap_adjust_register (struct gdbarch *gdbarch, struct stap_parse_info *p, const std::string &regname, int regnum);
7d7571f0
SDJ
1450extern void set_gdbarch_stap_adjust_register (struct gdbarch *gdbarch, gdbarch_stap_adjust_register_ftype *stap_adjust_register);
1451
8b367e17
JM
1452/* DTrace related functions.
1453 The expression to compute the NARTGth+1 argument to a DTrace USDT probe.
1454 NARG must be >= 0. */
1455
39535193 1456extern bool gdbarch_dtrace_parse_probe_argument_p (struct gdbarch *gdbarch);
8b367e17 1457
482ddd69
TT
1458typedef expr::operation_up (gdbarch_dtrace_parse_probe_argument_ftype) (struct gdbarch *gdbarch, int narg);
1459extern expr::operation_up gdbarch_dtrace_parse_probe_argument (struct gdbarch *gdbarch, int narg);
8b367e17
JM
1460extern void set_gdbarch_dtrace_parse_probe_argument (struct gdbarch *gdbarch, gdbarch_dtrace_parse_probe_argument_ftype *dtrace_parse_probe_argument);
1461
1462/* True if the given ADDR does not contain the instruction sequence
1463 corresponding to a disabled DTrace is-enabled probe. */
1464
39535193 1465extern bool gdbarch_dtrace_probe_is_enabled_p (struct gdbarch *gdbarch);
8b367e17
JM
1466
1467typedef int (gdbarch_dtrace_probe_is_enabled_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1468extern int gdbarch_dtrace_probe_is_enabled (struct gdbarch *gdbarch, CORE_ADDR addr);
1469extern void set_gdbarch_dtrace_probe_is_enabled (struct gdbarch *gdbarch, gdbarch_dtrace_probe_is_enabled_ftype *dtrace_probe_is_enabled);
1470
1471/* Enable a DTrace is-enabled probe at ADDR. */
1472
39535193 1473extern bool gdbarch_dtrace_enable_probe_p (struct gdbarch *gdbarch);
8b367e17
JM
1474
1475typedef void (gdbarch_dtrace_enable_probe_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1476extern void gdbarch_dtrace_enable_probe (struct gdbarch *gdbarch, CORE_ADDR addr);
1477extern void set_gdbarch_dtrace_enable_probe (struct gdbarch *gdbarch, gdbarch_dtrace_enable_probe_ftype *dtrace_enable_probe);
1478
1479/* Disable a DTrace is-enabled probe at ADDR. */
1480
39535193 1481extern bool gdbarch_dtrace_disable_probe_p (struct gdbarch *gdbarch);
8b367e17
JM
1482
1483typedef void (gdbarch_dtrace_disable_probe_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1484extern void gdbarch_dtrace_disable_probe (struct gdbarch *gdbarch, CORE_ADDR addr);
1485extern void set_gdbarch_dtrace_disable_probe (struct gdbarch *gdbarch, gdbarch_dtrace_disable_probe_ftype *dtrace_disable_probe);
1486
50c71eaf 1487/* True if the list of shared libraries is one and only for all
9bc9e927 1488 processes, as opposed to a list of shared libraries per inferior.
2567c7d9
PA
1489 This usually means that all processes, although may or may not share
1490 an address space, will see the same set of symbols at the same
1491 addresses. */
50c71eaf
PA
1492
1493extern int gdbarch_has_global_solist (struct gdbarch *gdbarch);
1494extern void set_gdbarch_has_global_solist (struct gdbarch *gdbarch, int has_global_solist);
1495
2567c7d9
PA
1496/* On some targets, even though each inferior has its own private
1497 address space, the debug interface takes care of making breakpoints
1498 visible to all address spaces automatically. For such cases,
1499 this property should be set to true. */
1500
1501extern int gdbarch_has_global_breakpoints (struct gdbarch *gdbarch);
1502extern void set_gdbarch_has_global_breakpoints (struct gdbarch *gdbarch, int has_global_breakpoints);
1503
6c95b8df
PA
1504/* True if inferiors share an address space (e.g., uClinux). */
1505
1506typedef int (gdbarch_has_shared_address_space_ftype) (struct gdbarch *gdbarch);
1507extern int gdbarch_has_shared_address_space (struct gdbarch *gdbarch);
1508extern void set_gdbarch_has_shared_address_space (struct gdbarch *gdbarch, gdbarch_has_shared_address_space_ftype *has_shared_address_space);
1509
7a697b8d
SS
1510/* True if a fast tracepoint can be set at an address. */
1511
281d762b
TT
1512typedef int (gdbarch_fast_tracepoint_valid_at_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, std::string *msg);
1513extern int gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, CORE_ADDR addr, std::string *msg);
7a697b8d
SS
1514extern void set_gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, gdbarch_fast_tracepoint_valid_at_ftype *fast_tracepoint_valid_at);
1515
5f034a78
MK
1516/* Guess register state based on tracepoint location. Used for tracepoints
1517 where no registers have been collected, but there's only one location,
1518 allowing us to guess the PC value, and perhaps some other registers.
1519 On entry, regcache has all registers marked as unavailable. */
1520
1521typedef void (gdbarch_guess_tracepoint_registers_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1522extern void gdbarch_guess_tracepoint_registers (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1523extern void set_gdbarch_guess_tracepoint_registers (struct gdbarch *gdbarch, gdbarch_guess_tracepoint_registers_ftype *guess_tracepoint_registers);
1524
f870a310
TT
1525/* Return the "auto" target charset. */
1526
1527typedef const char * (gdbarch_auto_charset_ftype) (void);
1528extern const char * gdbarch_auto_charset (struct gdbarch *gdbarch);
1529extern void set_gdbarch_auto_charset (struct gdbarch *gdbarch, gdbarch_auto_charset_ftype *auto_charset);
1530
1531/* Return the "auto" target wide charset. */
1532
1533typedef const char * (gdbarch_auto_wide_charset_ftype) (void);
1534extern const char * gdbarch_auto_wide_charset (struct gdbarch *gdbarch);
1535extern void set_gdbarch_auto_wide_charset (struct gdbarch *gdbarch, gdbarch_auto_wide_charset_ftype *auto_wide_charset);
1536
08105857
PA
1537/* If non-empty, this is a file extension that will be opened in place
1538 of the file extension reported by the shared library list.
1539
1540 This is most useful for toolchains that use a post-linker tool,
1541 where the names of the files run on the target differ in extension
1542 compared to the names of the files GDB should load for debug info. */
1543
1544extern const char * gdbarch_solib_symbols_extension (struct gdbarch *gdbarch);
1545extern void set_gdbarch_solib_symbols_extension (struct gdbarch *gdbarch, const char * solib_symbols_extension);
1546
1412f70b
HZ
1547/* If true, the target OS has DOS-based file system semantics. That
1548 is, absolute paths include a drive name, and the backslash is
1549 considered a directory separator. */
ab38a727
PA
1550
1551extern int gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch);
1552extern void set_gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch, int has_dos_based_file_system);
1553
6710bf39
SS
1554/* Generate bytecodes to collect the return address in a frame.
1555 Since the bytecodes run on the target, possibly with GDB not even
1556 connected, the full unwinding machinery is not available, and
1557 typically this function will issue bytecodes for one or more likely
1558 places that the return address may be found. */
1559
1560typedef void (gdbarch_gen_return_address_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1561extern void gdbarch_gen_return_address (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1562extern void set_gdbarch_gen_return_address (struct gdbarch *gdbarch, gdbarch_gen_return_address_ftype *gen_return_address);
1563
3030c96e
UW
1564/* Implement the "info proc" command. */
1565
39535193 1566extern bool gdbarch_info_proc_p (struct gdbarch *gdbarch);
3030c96e 1567
7bc112c1
TT
1568typedef void (gdbarch_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1569extern void gdbarch_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
3030c96e
UW
1570extern void set_gdbarch_info_proc (struct gdbarch *gdbarch, gdbarch_info_proc_ftype *info_proc);
1571
451b7c33
TT
1572/* Implement the "info proc" command for core files. Noe that there
1573 are two "info_proc"-like methods on gdbarch -- one for core files,
1574 one for live targets. */
1575
39535193 1576extern bool gdbarch_core_info_proc_p (struct gdbarch *gdbarch);
451b7c33 1577
7bc112c1
TT
1578typedef void (gdbarch_core_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1579extern void gdbarch_core_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
451b7c33
TT
1580extern void set_gdbarch_core_info_proc (struct gdbarch *gdbarch, gdbarch_core_info_proc_ftype *core_info_proc);
1581
19630284
JB
1582/* Iterate over all objfiles in the order that makes the most sense
1583 for the architecture to make global symbol searches.
1584
1585 CB is a callback function where OBJFILE is the objfile to be searched,
1586 and CB_DATA a pointer to user-defined data (the same data that is passed
1587 when calling this gdbarch method). The iteration stops if this function
1588 returns nonzero.
1589
1590 CB_DATA is a pointer to some user-defined data to be passed to
1591 the callback.
1592
1593 If not NULL, CURRENT_OBJFILE corresponds to the objfile being
1594 inspected when the symbol search was requested. */
1595
1596typedef void (gdbarch_iterate_over_objfiles_in_search_order_ftype) (struct gdbarch *gdbarch, iterate_over_objfiles_in_search_order_cb_ftype *cb, void *cb_data, struct objfile *current_objfile);
1597extern void gdbarch_iterate_over_objfiles_in_search_order (struct gdbarch *gdbarch, iterate_over_objfiles_in_search_order_cb_ftype *cb, void *cb_data, struct objfile *current_objfile);
1598extern void set_gdbarch_iterate_over_objfiles_in_search_order (struct gdbarch *gdbarch, gdbarch_iterate_over_objfiles_in_search_order_ftype *iterate_over_objfiles_in_search_order);
1599
7e35103a
JB
1600/* Ravenscar arch-dependent ops. */
1601
1602extern struct ravenscar_arch_ops * gdbarch_ravenscar_ops (struct gdbarch *gdbarch);
1603extern void set_gdbarch_ravenscar_ops (struct gdbarch *gdbarch, struct ravenscar_arch_ops * ravenscar_ops);
1604
c2170eef
MM
1605/* Return non-zero if the instruction at ADDR is a call; zero otherwise. */
1606
1607typedef int (gdbarch_insn_is_call_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1608extern int gdbarch_insn_is_call (struct gdbarch *gdbarch, CORE_ADDR addr);
1609extern void set_gdbarch_insn_is_call (struct gdbarch *gdbarch, gdbarch_insn_is_call_ftype *insn_is_call);
1610
1611/* Return non-zero if the instruction at ADDR is a return; zero otherwise. */
1612
1613typedef int (gdbarch_insn_is_ret_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1614extern int gdbarch_insn_is_ret (struct gdbarch *gdbarch, CORE_ADDR addr);
1615extern void set_gdbarch_insn_is_ret (struct gdbarch *gdbarch, gdbarch_insn_is_ret_ftype *insn_is_ret);
1616
1617/* Return non-zero if the instruction at ADDR is a jump; zero otherwise. */
1618
1619typedef int (gdbarch_insn_is_jump_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1620extern int gdbarch_insn_is_jump (struct gdbarch *gdbarch, CORE_ADDR addr);
1621extern void set_gdbarch_insn_is_jump (struct gdbarch *gdbarch, gdbarch_insn_is_jump_ftype *insn_is_jump);
1622
5133a315
LM
1623/* Return true if there's a program/permanent breakpoint planted in
1624 memory at ADDRESS, return false otherwise. */
1625
1626typedef bool (gdbarch_program_breakpoint_here_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
1627extern bool gdbarch_program_breakpoint_here_p (struct gdbarch *gdbarch, CORE_ADDR address);
1628extern void set_gdbarch_program_breakpoint_here_p (struct gdbarch *gdbarch, gdbarch_program_breakpoint_here_p_ftype *program_breakpoint_here_p);
1629
27a48a92
MK
1630/* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
1631 Return 0 if *READPTR is already at the end of the buffer.
1632 Return -1 if there is insufficient buffer for a whole entry.
1633 Return 1 if an entry was read into *TYPEP and *VALP. */
1634
39535193 1635extern bool gdbarch_auxv_parse_p (struct gdbarch *gdbarch);
27a48a92
MK
1636
1637typedef int (gdbarch_auxv_parse_ftype) (struct gdbarch *gdbarch, gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1638extern int gdbarch_auxv_parse (struct gdbarch *gdbarch, gdb_byte **readptr, gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1639extern void set_gdbarch_auxv_parse (struct gdbarch *gdbarch, gdbarch_auxv_parse_ftype *auxv_parse);
1640
2faa3447
JB
1641/* Print the description of a single auxv entry described by TYPE and VAL
1642 to FILE. */
1643
1644typedef void (gdbarch_print_auxv_entry_ftype) (struct gdbarch *gdbarch, struct ui_file *file, CORE_ADDR type, CORE_ADDR val);
1645extern void gdbarch_print_auxv_entry (struct gdbarch *gdbarch, struct ui_file *file, CORE_ADDR type, CORE_ADDR val);
1646extern void set_gdbarch_print_auxv_entry (struct gdbarch *gdbarch, gdbarch_print_auxv_entry_ftype *print_auxv_entry);
1647
3437254d
PA
1648/* Find the address range of the current inferior's vsyscall/vDSO, and
1649 write it to *RANGE. If the vsyscall's length can't be determined, a
1650 range with zero length is returned. Returns true if the vsyscall is
1651 found, false otherwise. */
1652
1653typedef int (gdbarch_vsyscall_range_ftype) (struct gdbarch *gdbarch, struct mem_range *range);
1654extern int gdbarch_vsyscall_range (struct gdbarch *gdbarch, struct mem_range *range);
1655extern void set_gdbarch_vsyscall_range (struct gdbarch *gdbarch, gdbarch_vsyscall_range_ftype *vsyscall_range);
1656
f208eee0
JK
1657/* Allocate SIZE bytes of PROT protected page aligned memory in inferior.
1658 PROT has GDB_MMAP_PROT_* bitmask format.
1659 Throw an error if it is not possible. Returned address is always valid. */
1660
1661typedef CORE_ADDR (gdbarch_infcall_mmap_ftype) (CORE_ADDR size, unsigned prot);
1662extern CORE_ADDR gdbarch_infcall_mmap (struct gdbarch *gdbarch, CORE_ADDR size, unsigned prot);
1663extern void set_gdbarch_infcall_mmap (struct gdbarch *gdbarch, gdbarch_infcall_mmap_ftype *infcall_mmap);
1664
7f361056
JK
1665/* Deallocate SIZE bytes of memory at ADDR in inferior from gdbarch_infcall_mmap.
1666 Print a warning if it is not possible. */
1667
1668typedef void (gdbarch_infcall_munmap_ftype) (CORE_ADDR addr, CORE_ADDR size);
1669extern void gdbarch_infcall_munmap (struct gdbarch *gdbarch, CORE_ADDR addr, CORE_ADDR size);
1670extern void set_gdbarch_infcall_munmap (struct gdbarch *gdbarch, gdbarch_infcall_munmap_ftype *infcall_munmap);
1671
f208eee0
JK
1672/* Return string (caller has to use xfree for it) with options for GCC
1673 to produce code for this target, typically "-m64", "-m32" or "-m31".
1674 These options are put before CU's DW_AT_producer compilation options so that
953cff56 1675 they can override it. */
f208eee0 1676
953cff56
TT
1677typedef std::string (gdbarch_gcc_target_options_ftype) (struct gdbarch *gdbarch);
1678extern std::string gdbarch_gcc_target_options (struct gdbarch *gdbarch);
f208eee0
JK
1679extern void set_gdbarch_gcc_target_options (struct gdbarch *gdbarch, gdbarch_gcc_target_options_ftype *gcc_target_options);
1680
ac04f72b
TT
1681/* Return a regular expression that matches names used by this
1682 architecture in GNU configury triplets. The result is statically
1683 allocated and must not be freed. The default implementation simply
1684 returns the BFD architecture name, which is correct in nearly every
1685 case. */
1686
1687typedef const char * (gdbarch_gnu_triplet_regexp_ftype) (struct gdbarch *gdbarch);
1688extern const char * gdbarch_gnu_triplet_regexp (struct gdbarch *gdbarch);
1689extern void set_gdbarch_gnu_triplet_regexp (struct gdbarch *gdbarch, gdbarch_gnu_triplet_regexp_ftype *gnu_triplet_regexp);
1690
3374165f
SM
1691/* Return the size in 8-bit bytes of an addressable memory unit on this
1692 architecture. This corresponds to the number of 8-bit bytes associated to
1693 each address in memory. */
1694
1695typedef int (gdbarch_addressable_memory_unit_size_ftype) (struct gdbarch *gdbarch);
1696extern int gdbarch_addressable_memory_unit_size (struct gdbarch *gdbarch);
1697extern void set_gdbarch_addressable_memory_unit_size (struct gdbarch *gdbarch, gdbarch_addressable_memory_unit_size_ftype *addressable_memory_unit_size);
1698
65b48a81
PB
1699/* Functions for allowing a target to modify its disassembler options. */
1700
471b9d15
MR
1701extern const char * gdbarch_disassembler_options_implicit (struct gdbarch *gdbarch);
1702extern void set_gdbarch_disassembler_options_implicit (struct gdbarch *gdbarch, const char * disassembler_options_implicit);
1703
65b48a81
PB
1704extern char ** gdbarch_disassembler_options (struct gdbarch *gdbarch);
1705extern void set_gdbarch_disassembler_options (struct gdbarch *gdbarch, char ** disassembler_options);
1706
471b9d15
MR
1707extern const disasm_options_and_args_t * gdbarch_valid_disassembler_options (struct gdbarch *gdbarch);
1708extern void set_gdbarch_valid_disassembler_options (struct gdbarch *gdbarch, const disasm_options_and_args_t * valid_disassembler_options);
65b48a81 1709
5561fc30
AB
1710/* Type alignment override method. Return the architecture specific
1711 alignment required for TYPE. If there is no special handling
1712 required for TYPE then return the value 0, GDB will then apply the
1713 default rules as laid out in gdbtypes.c:type_align. */
2b4424c3
TT
1714
1715typedef ULONGEST (gdbarch_type_align_ftype) (struct gdbarch *gdbarch, struct type *type);
1716extern ULONGEST gdbarch_type_align (struct gdbarch *gdbarch, struct type *type);
1717extern void set_gdbarch_type_align (struct gdbarch *gdbarch, gdbarch_type_align_ftype *type_align);
1718
aa7ca1bb
AH
1719/* Return a string containing any flags for the given PC in the given FRAME. */
1720
1721typedef std::string (gdbarch_get_pc_address_flags_ftype) (frame_info *frame, CORE_ADDR pc);
1722extern std::string gdbarch_get_pc_address_flags (struct gdbarch *gdbarch, frame_info *frame, CORE_ADDR pc);
1723extern void set_gdbarch_get_pc_address_flags (struct gdbarch *gdbarch, gdbarch_get_pc_address_flags_ftype *get_pc_address_flags);
1724
7e183d27
KB
1725/* Read core file mappings */
1726
aa95b2d4
AM
1727typedef void (gdbarch_read_core_file_mappings_ftype) (struct gdbarch *gdbarch, struct bfd *cbfd, read_core_file_mappings_pre_loop_ftype pre_loop_cb, read_core_file_mappings_loop_ftype loop_cb);
1728extern void gdbarch_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);
7e183d27
KB
1729extern void set_gdbarch_read_core_file_mappings (struct gdbarch *gdbarch, gdbarch_read_core_file_mappings_ftype *read_core_file_mappings);
1730
104c1213 1731extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
0f71a2f6
JM
1732
1733
1734/* Mechanism for co-ordinating the selection of a specific
1735 architecture.
1736
1737 GDB targets (*-tdep.c) can register an interest in a specific
1738 architecture. Other GDB components can register a need to maintain
1739 per-architecture data.
1740
1741 The mechanisms below ensures that there is only a loose connection
1742 between the set-architecture command and the various GDB
99e7bb18 1743 components. Each component can independently register their need
0f71a2f6
JM
1744 to maintain architecture specific data with gdbarch.
1745
1746 Pragmatics:
1747
1748 Previously, a single TARGET_ARCHITECTURE_HOOK was provided. It
1749 didn't scale.
1750
1751 The more traditional mega-struct containing architecture specific
1752 data for all the various GDB components was also considered. Since
99e7bb18 1753 GDB is built from a variable number of (fairly independent)
0f71a2f6 1754 components it was determined that the global aproach was not
0963b4bd 1755 applicable. */
0f71a2f6
JM
1756
1757
1758/* Register a new architectural family with GDB.
1759
1760 Register support for the specified ARCHITECTURE with GDB. When
1761 gdbarch determines that the specified architecture has been
1762 selected, the corresponding INIT function is called.
1763
1764 --
1765
1766 The INIT function takes two parameters: INFO which contains the
1767 information available to gdbarch about the (possibly new)
1768 architecture; ARCHES which is a list of the previously created
1769 ``struct gdbarch'' for this architecture.
1770
0f79675b 1771 The INFO parameter is, as far as possible, be pre-initialized with
7a107747 1772 information obtained from INFO.ABFD or the global defaults.
0f79675b
AC
1773
1774 The ARCHES parameter is a linked list (sorted most recently used)
1775 of all the previously created architures for this architecture
1776 family. The (possibly NULL) ARCHES->gdbarch can used to access
1777 values from the previously selected architecture for this
59837fe0 1778 architecture family.
0f71a2f6
JM
1779
1780 The INIT function shall return any of: NULL - indicating that it
ec3d358c 1781 doesn't recognize the selected architecture; an existing ``struct
0f71a2f6
JM
1782 gdbarch'' from the ARCHES list - indicating that the new
1783 architecture is just a synonym for an earlier architecture (see
1784 gdbarch_list_lookup_by_info()); a newly created ``struct gdbarch''
4b9b3959
AC
1785 - that describes the selected architecture (see gdbarch_alloc()).
1786
1787 The DUMP_TDEP function shall print out all target specific values.
1788 Care should be taken to ensure that the function works in both the
0963b4bd 1789 multi-arch and non- multi-arch cases. */
0f71a2f6 1790
adf40b2e
JM
1791struct gdbarch_list
1792{
1793 struct gdbarch *gdbarch;
1794 struct gdbarch_list *next;
1795};
0f71a2f6 1796
adf40b2e
JM
1797struct gdbarch_info
1798{
b447dd03
SM
1799 gdbarch_info ()
1800 /* Ensure the union is zero-initialized. Relies on the fact that there's
1801 no member larger than TDESC_DATA. */
1802 : tdesc_data ()
1803 {}
0f71a2f6 1804
b447dd03 1805 const struct bfd_arch_info *bfd_arch_info = nullptr;
0f71a2f6 1806
b447dd03 1807 enum bfd_endian byte_order = BFD_ENDIAN_UNKNOWN;
9d4fde75 1808
b447dd03
SM
1809 enum bfd_endian byte_order_for_code = BFD_ENDIAN_UNKNOWN;
1810
1811 bfd *abfd = nullptr;
0f71a2f6 1812
0dba2a6c
MR
1813 union
1814 {
0dba2a6c
MR
1815 /* Architecture-specific target description data. Numerous targets
1816 need only this, so give them an easy way to hold it. */
1817 struct tdesc_arch_data *tdesc_data;
1818
1819 /* SPU file system ID. This is a single integer, so using the
1820 generic form would only complicate code. Other targets may
1821 reuse this member if suitable. */
1822 int *id;
1823 };
4be87837 1824
b447dd03 1825 enum gdb_osabi osabi = GDB_OSABI_UNKNOWN;
424163ea 1826
b447dd03 1827 const struct target_desc *target_desc = nullptr;
adf40b2e 1828};
0f71a2f6 1829
104c1213 1830typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
4b9b3959 1831typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
0f71a2f6 1832
4b9b3959 1833/* DEPRECATED - use gdbarch_register() */
104c1213 1834extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
0f71a2f6 1835
4b9b3959 1836extern void gdbarch_register (enum bfd_architecture architecture,
dda83cd7
SM
1837 gdbarch_init_ftype *,
1838 gdbarch_dump_tdep_ftype *);
4b9b3959 1839
0f71a2f6 1840
9b1f59fc
SM
1841/* Return a vector of the valid architecture names. Since architectures are
1842 registered during the _initialize phase this function only returns useful
1843 information once initialization has been completed. */
b4a20239 1844
9b1f59fc 1845extern std::vector<const char *> gdbarch_printable_names ();
b4a20239
AC
1846
1847
0f71a2f6 1848/* Helper function. Search the list of ARCHES for a GDBARCH that
0963b4bd 1849 matches the information provided by INFO. */
0f71a2f6 1850
424163ea 1851extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
0f71a2f6
JM
1852
1853
1854/* Helper function. Create a preliminary ``struct gdbarch''. Perform
424163ea 1855 basic initialization using values obtained from the INFO and TDEP
0f71a2f6 1856 parameters. set_gdbarch_*() functions are called to complete the
0963b4bd 1857 initialization of the object. */
0f71a2f6 1858
104c1213 1859extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
0f71a2f6
JM
1860
1861
4b9b3959
AC
1862/* Helper function. Free a partially-constructed ``struct gdbarch''.
1863 It is assumed that the caller freeds the ``struct
0963b4bd 1864 gdbarch_tdep''. */
4b9b3959 1865
058f20d5
JB
1866extern void gdbarch_free (struct gdbarch *);
1867
284a0e3c
SM
1868/* Get the obstack owned by ARCH. */
1869
1870extern obstack *gdbarch_obstack (gdbarch *arch);
058f20d5 1871
aebd7893
AC
1872/* Helper function. Allocate memory from the ``struct gdbarch''
1873 obstack. The memory is freed when the corresponding architecture
1874 is also freed. */
1875
284a0e3c
SM
1876#define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) obstack_calloc<TYPE> (gdbarch_obstack ((GDBARCH)), (NR))
1877
1878#define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) obstack_zalloc<TYPE> (gdbarch_obstack ((GDBARCH)))
aebd7893 1879
6c214e7c
PP
1880/* Duplicate STRING, returning an equivalent string that's allocated on the
1881 obstack associated with GDBARCH. The string is freed when the corresponding
1882 architecture is also freed. */
1883
1884extern char *gdbarch_obstack_strdup (struct gdbarch *arch, const char *string);
aebd7893 1885
0963b4bd 1886/* Helper function. Force an update of the current architecture.
0f71a2f6 1887
b732d07d
AC
1888 The actual architecture selected is determined by INFO, ``(gdb) set
1889 architecture'' et.al., the existing architecture and BFD's default
1890 architecture. INFO should be initialized to zero and then selected
1891 fields should be updated.
0f71a2f6 1892
0963b4bd 1893 Returns non-zero if the update succeeds. */
16f33e29
AC
1894
1895extern int gdbarch_update_p (struct gdbarch_info info);
0f71a2f6
JM
1896
1897
ebdba546
AC
1898/* Helper function. Find an architecture matching info.
1899
b447dd03
SM
1900 INFO should have relevant fields set, and then finished using
1901 gdbarch_info_fill.
ebdba546
AC
1902
1903 Returns the corresponding architecture, or NULL if no matching
59837fe0 1904 architecture was found. */
ebdba546
AC
1905
1906extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
1907
1908
aff68abb 1909/* Helper function. Set the target gdbarch to "gdbarch". */
ebdba546 1910
aff68abb 1911extern void set_target_gdbarch (struct gdbarch *gdbarch);
ebdba546 1912
0f71a2f6
JM
1913
1914/* Register per-architecture data-pointer.
1915
1916 Reserve space for a per-architecture data-pointer. An identifier
1917 for the reserved data-pointer is returned. That identifer should
95160752 1918 be saved in a local static variable.
0f71a2f6 1919
fcc1c85c
AC
1920 Memory for the per-architecture data shall be allocated using
1921 gdbarch_obstack_zalloc. That memory will be deleted when the
1922 corresponding architecture object is deleted.
0f71a2f6 1923
95160752
AC
1924 When a previously created architecture is re-selected, the
1925 per-architecture data-pointer for that previous architecture is
76860b5f 1926 restored. INIT() is not re-called.
0f71a2f6
JM
1927
1928 Multiple registrarants for any architecture are allowed (and
1929 strongly encouraged). */
1930
95160752 1931struct gdbarch_data;
0f71a2f6 1932
030f20e1
AC
1933typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
1934extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
1935typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
1936extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
0f71a2f6 1937
451fbdda 1938extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
0f71a2f6
JM
1939
1940
99e7bb18 1941/* Set the dynamic target-system-dependent parameters (architecture,
0963b4bd 1942 byte-order, ...) using information found in the BFD. */
c906108c 1943
104c1213 1944extern void set_gdbarch_from_file (bfd *);
c906108c
SS
1945
1946
e514a9d6
JM
1947/* Initialize the current architecture to the "first" one we find on
1948 our list. */
1949
1950extern void initialize_current_architecture (void);
1951
c906108c 1952/* gdbarch trace variable */
ccce17b0 1953extern unsigned int gdbarch_debug;
c906108c 1954
4b9b3959 1955extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);
0f71a2f6 1956
f6efe3f8
SM
1957/* Return the number of cooked registers (raw + pseudo) for ARCH. */
1958
1959static inline int
1960gdbarch_num_cooked_regs (gdbarch *arch)
1961{
1962 return gdbarch_num_regs (arch) + gdbarch_num_pseudo_regs (arch);
1963}
1964
c906108c 1965#endif