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