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