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