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