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