]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - gdb/gdbarch.h
gdbarch-ification of ravenscar-thread support.
[thirdparty/binutils-gdb.git] / gdb / gdbarch.h
CommitLineData
c4bfde41
JK
1/* *INDENT-OFF* */ /* THIS FILE IS GENERATED -*- buffer-read-only: t -*- */
2/* vi:set ro: */
59233f88 3
adf40b2e 4/* Dynamic architecture support for GDB, the GNU debugger.
79d45cd4 5
f801e1e0
MS
6 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
7 2007, 2008, 2009 Free Software Foundation, Inc.
c906108c 8
c5aa993b 9 This file is part of GDB.
c906108c 10
c5aa993b
JM
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
a9762ec7 13 the Free Software Foundation; either version 3 of the License, or
c5aa993b 14 (at your option) any later version.
de584861 15
c5aa993b
JM
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
de584861 20
c5aa993b 21 You should have received a copy of the GNU General Public License
a9762ec7 22 along with this program. If not, see <http://www.gnu.org/licenses/>. */
c906108c 23
104c1213
JM
24/* This file was created with the aid of ``gdbarch.sh''.
25
52204a0b 26 The Bourne shell script ``gdbarch.sh'' creates the files
104c1213
JM
27 ``new-gdbarch.c'' and ``new-gdbarch.h and then compares them
28 against the existing ``gdbarch.[hc]''. Any differences found
29 being reported.
30
31 If editing this file, please also run gdbarch.sh and merge any
52204a0b 32 changes into that script. Conversely, when making sweeping changes
104c1213 33 to this file, modifying gdbarch.sh and using its output may prove
0963b4bd 34 easier. */
adf40b2e 35
c906108c
SS
36#ifndef GDBARCH_H
37#define GDBARCH_H
38
da3331ec
AC
39struct floatformat;
40struct ui_file;
cce74817
JM
41struct frame_info;
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;
237fc4c9 54struct displaced_step_closure;
17ea7499 55struct core_regset_section;
a96d9b2e 56struct syscall;
175ff332 57struct agent_expr;
6710bf39 58struct axs_value;
55aa24fb 59struct stap_parse_info;
7e35103a 60struct ravenscar_arch_ops;
0f71a2f6 61
6ecd4729
PA
62/* The architecture associated with the inferior through the
63 connection to the target.
64
65 The architecture vector provides some information that is really a
66 property of the inferior, accessed through a particular target:
67 ptrace operations; the layout of certain RSP packets; the solib_ops
68 vector; etc. To differentiate architecture accesses to
69 per-inferior/target properties from
70 per-thread/per-frame/per-objfile properties, accesses to
71 per-inferior/target properties should be made through this
72 gdbarch. */
73
74/* This is a convenience wrapper for 'current_inferior ()->gdbarch'. */
f5656ead 75extern struct gdbarch *target_gdbarch (void);
6ecd4729
PA
76
77/* The initial, default architecture. It uses host values (for want of a better
78 choice). */
79extern struct gdbarch startup_gdbarch;
80
0f71a2f6 81
19630284
JB
82/* Callback type for the 'iterate_over_objfiles_in_search_order'
83 gdbarch method. */
84
85typedef int (iterate_over_objfiles_in_search_order_cb_ftype)
86 (struct objfile *objfile, void *cb_data);
87
0f71a2f6 88
0963b4bd 89/* The following are pre-initialized by GDBARCH. */
0f71a2f6 90
104c1213 91extern const struct bfd_arch_info * gdbarch_bfd_arch_info (struct gdbarch *gdbarch);
0963b4bd 92/* set_gdbarch_bfd_arch_info() - not applicable - pre-initialized. */
0f71a2f6 93
104c1213 94extern int gdbarch_byte_order (struct gdbarch *gdbarch);
0963b4bd 95/* set_gdbarch_byte_order() - not applicable - pre-initialized. */
0f71a2f6 96
9d4fde75 97extern int gdbarch_byte_order_for_code (struct gdbarch *gdbarch);
0963b4bd 98/* set_gdbarch_byte_order_for_code() - not applicable - pre-initialized. */
9d4fde75 99
4be87837 100extern enum gdb_osabi gdbarch_osabi (struct gdbarch *gdbarch);
0963b4bd 101/* set_gdbarch_osabi() - not applicable - pre-initialized. */
4be87837 102
424163ea 103extern const struct target_desc * gdbarch_target_desc (struct gdbarch *gdbarch);
0963b4bd 104/* set_gdbarch_target_desc() - not applicable - pre-initialized. */
424163ea 105
0f71a2f6 106
0963b4bd 107/* The following are initialized by the target dependent code. */
0f71a2f6 108
32c9a795
MD
109/* The bit byte-order has to do just with numbering of bits in debugging symbols
110 and such. Conceptually, it's quite separate from byte/word byte order. */
111
112extern int gdbarch_bits_big_endian (struct gdbarch *gdbarch);
113extern void set_gdbarch_bits_big_endian (struct gdbarch *gdbarch, int bits_big_endian);
114
66b43ecb
AC
115/* Number of bits in a char or unsigned char for the target machine.
116 Just like CHAR_BIT in <limits.h> but describes the target machine.
57010b1c 117 v:TARGET_CHAR_BIT:int:char_bit::::8 * sizeof (char):8::0:
66b43ecb
AC
118
119 Number of bits in a short or unsigned short for the target machine. */
c4093a6a 120
104c1213
JM
121extern int gdbarch_short_bit (struct gdbarch *gdbarch);
122extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
0f71a2f6 123
66b43ecb
AC
124/* Number of bits in an int or unsigned int for the target machine. */
125
104c1213
JM
126extern int gdbarch_int_bit (struct gdbarch *gdbarch);
127extern void set_gdbarch_int_bit (struct gdbarch *gdbarch, int int_bit);
0f71a2f6 128
66b43ecb
AC
129/* Number of bits in a long or unsigned long for the target machine. */
130
104c1213
JM
131extern int gdbarch_long_bit (struct gdbarch *gdbarch);
132extern void set_gdbarch_long_bit (struct gdbarch *gdbarch, int long_bit);
0f71a2f6 133
66b43ecb
AC
134/* Number of bits in a long long or unsigned long long for the target
135 machine. */
136
104c1213
JM
137extern int gdbarch_long_long_bit (struct gdbarch *gdbarch);
138extern void set_gdbarch_long_long_bit (struct gdbarch *gdbarch, int long_long_bit);
0f71a2f6 139
205c306f
DM
140/* Alignment of a long long or unsigned long long for the target
141 machine. */
142
143extern int gdbarch_long_long_align_bit (struct gdbarch *gdbarch);
144extern void set_gdbarch_long_long_align_bit (struct gdbarch *gdbarch, int long_long_align_bit);
145
f9e9243a
UW
146/* The ABI default bit-size and format for "half", "float", "double", and
147 "long double". These bit/format pairs should eventually be combined
148 into a single object. For the moment, just initialize them as a pair.
8da61cc4
DJ
149 Each format describes both the big and little endian layouts (if
150 useful). */
66b43ecb 151
f9e9243a
UW
152extern int gdbarch_half_bit (struct gdbarch *gdbarch);
153extern void set_gdbarch_half_bit (struct gdbarch *gdbarch, int half_bit);
154
155extern const struct floatformat ** gdbarch_half_format (struct gdbarch *gdbarch);
156extern void set_gdbarch_half_format (struct gdbarch *gdbarch, const struct floatformat ** half_format);
157
104c1213
JM
158extern int gdbarch_float_bit (struct gdbarch *gdbarch);
159extern void set_gdbarch_float_bit (struct gdbarch *gdbarch, int float_bit);
0f71a2f6 160
8da61cc4
DJ
161extern const struct floatformat ** gdbarch_float_format (struct gdbarch *gdbarch);
162extern void set_gdbarch_float_format (struct gdbarch *gdbarch, const struct floatformat ** float_format);
66b43ecb 163
104c1213
JM
164extern int gdbarch_double_bit (struct gdbarch *gdbarch);
165extern void set_gdbarch_double_bit (struct gdbarch *gdbarch, int double_bit);
0f71a2f6 166
8da61cc4
DJ
167extern const struct floatformat ** gdbarch_double_format (struct gdbarch *gdbarch);
168extern void set_gdbarch_double_format (struct gdbarch *gdbarch, const struct floatformat ** double_format);
66b43ecb 169
104c1213
JM
170extern int gdbarch_long_double_bit (struct gdbarch *gdbarch);
171extern void set_gdbarch_long_double_bit (struct gdbarch *gdbarch, int long_double_bit);
0f71a2f6 172
8da61cc4
DJ
173extern const struct floatformat ** gdbarch_long_double_format (struct gdbarch *gdbarch);
174extern void set_gdbarch_long_double_format (struct gdbarch *gdbarch, const struct floatformat ** long_double_format);
456fcf94 175
52204a0b
DT
176/* For most targets, a pointer on the target and its representation as an
177 address in GDB have the same size and "look the same". For such a
17a912b6 178 target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
52204a0b
DT
179 / addr_bit will be set from it.
180
17a912b6 181 If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
8da614df
CV
182 also need to set gdbarch_dwarf2_addr_size, gdbarch_pointer_to_address and
183 gdbarch_address_to_pointer as well.
52204a0b
DT
184
185 ptr_bit is the size of a pointer on the target */
66b43ecb 186
66b43ecb
AC
187extern int gdbarch_ptr_bit (struct gdbarch *gdbarch);
188extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
66b43ecb 189
52204a0b
DT
190/* addr_bit is the size of a target address as represented in gdb */
191
52204a0b
DT
192extern int gdbarch_addr_bit (struct gdbarch *gdbarch);
193extern void set_gdbarch_addr_bit (struct gdbarch *gdbarch, int addr_bit);
66b43ecb 194
8da614df
CV
195/* dwarf2_addr_size is the target address size as used in the Dwarf debug
196 info. For .debug_frame FDEs, this is supposed to be the target address
197 size from the associated CU header, and which is equivalent to the
198 DWARF2_ADDR_SIZE as defined by the target specific GCC back-end.
199 Unfortunately there is no good way to determine this value. Therefore
200 dwarf2_addr_size simply defaults to the target pointer size.
201
202 dwarf2_addr_size is not used for .eh_frame FDEs, which are generally
203 defined using the target's pointer size so far.
204
205 Note that dwarf2_addr_size only needs to be redefined by a target if the
206 GCC back-end defines a DWARF2_ADDR_SIZE other than the target pointer size,
207 and if Dwarf versions < 4 need to be supported. */
208
209extern int gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch);
210extern void set_gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch, int dwarf2_addr_size);
211
4e409299
JB
212/* One if `char' acts like `signed char', zero if `unsigned char'. */
213
4e409299
JB
214extern int gdbarch_char_signed (struct gdbarch *gdbarch);
215extern void set_gdbarch_char_signed (struct gdbarch *gdbarch, int char_signed);
4e409299 216
cde9ea48 217extern int gdbarch_read_pc_p (struct gdbarch *gdbarch);
61a1198a
UW
218
219typedef CORE_ADDR (gdbarch_read_pc_ftype) (struct regcache *regcache);
220extern CORE_ADDR gdbarch_read_pc (struct gdbarch *gdbarch, struct regcache *regcache);
104c1213 221extern void set_gdbarch_read_pc (struct gdbarch *gdbarch, gdbarch_read_pc_ftype *read_pc);
61a1198a
UW
222
223extern int gdbarch_write_pc_p (struct gdbarch *gdbarch);
224
225typedef void (gdbarch_write_pc_ftype) (struct regcache *regcache, CORE_ADDR val);
226extern void gdbarch_write_pc (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR val);
104c1213 227extern void set_gdbarch_write_pc (struct gdbarch *gdbarch, gdbarch_write_pc_ftype *write_pc);
0f71a2f6 228
39d4ef09
AC
229/* Function for getting target's idea of a frame pointer. FIXME: GDB's
230 whole scheme for dealing with "frames" and "frame pointers" needs a
231 serious shakedown. */
232
a54fba4c 233typedef void (gdbarch_virtual_frame_pointer_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
39d4ef09
AC
234extern void gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
235extern void set_gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, gdbarch_virtual_frame_pointer_ftype *virtual_frame_pointer);
39d4ef09 236
d8124050 237extern int gdbarch_pseudo_register_read_p (struct gdbarch *gdbarch);
61a0eb5b 238
05d1431c
PA
239typedef enum register_status (gdbarch_pseudo_register_read_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
240extern enum register_status gdbarch_pseudo_register_read (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, gdb_byte *buf);
d8124050 241extern void set_gdbarch_pseudo_register_read (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_ftype *pseudo_register_read);
61a0eb5b 242
3543a589
TT
243/* Read a register into a new struct value. If the register is wholly
244 or partly unavailable, this should call mark_value_bytes_unavailable
245 as appropriate. If this is defined, then pseudo_register_read will
246 never be called. */
247
248extern int gdbarch_pseudo_register_read_value_p (struct gdbarch *gdbarch);
249
250typedef struct value * (gdbarch_pseudo_register_read_value_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum);
251extern struct value * gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum);
252extern void set_gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_value_ftype *pseudo_register_read_value);
253
d8124050 254extern int gdbarch_pseudo_register_write_p (struct gdbarch *gdbarch);
61a0eb5b 255
b60c417a
AC
256typedef void (gdbarch_pseudo_register_write_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
257extern void gdbarch_pseudo_register_write (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
d8124050 258extern void set_gdbarch_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_pseudo_register_write_ftype *pseudo_register_write);
61a0eb5b 259
104c1213
JM
260extern int gdbarch_num_regs (struct gdbarch *gdbarch);
261extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
0f71a2f6 262
34620563
AC
263/* This macro gives the number of pseudo-registers that live in the
264 register namespace but do not get fetched or stored on the target.
265 These pseudo-registers may be aliases for other registers,
266 combinations of other registers, or they may be computed by GDB. */
267
0aba1244
EZ
268extern int gdbarch_num_pseudo_regs (struct gdbarch *gdbarch);
269extern void set_gdbarch_num_pseudo_regs (struct gdbarch *gdbarch, int num_pseudo_regs);
0aba1244 270
175ff332
HZ
271/* Assemble agent expression bytecode to collect pseudo-register REG.
272 Return -1 if something goes wrong, 0 otherwise. */
273
274extern int gdbarch_ax_pseudo_register_collect_p (struct gdbarch *gdbarch);
275
276typedef int (gdbarch_ax_pseudo_register_collect_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
277extern int gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
278extern void set_gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_collect_ftype *ax_pseudo_register_collect);
279
280/* Assemble agent expression bytecode to push the value of pseudo-register
281 REG on the interpreter stack.
282 Return -1 if something goes wrong, 0 otherwise. */
283
284extern int gdbarch_ax_pseudo_register_push_stack_p (struct gdbarch *gdbarch);
285
286typedef int (gdbarch_ax_pseudo_register_push_stack_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
287extern int gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
288extern void set_gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_push_stack_ftype *ax_pseudo_register_push_stack);
289
c2169756
AC
290/* GDB's standard (or well known) register numbers. These can map onto
291 a real register or a pseudo (computed) register or not be defined at
a9e5fdc2 292 all (-1).
3e8c568d 293 gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP. */
1200cd6e 294
104c1213
JM
295extern int gdbarch_sp_regnum (struct gdbarch *gdbarch);
296extern void set_gdbarch_sp_regnum (struct gdbarch *gdbarch, int sp_regnum);
0f71a2f6 297
104c1213
JM
298extern int gdbarch_pc_regnum (struct gdbarch *gdbarch);
299extern void set_gdbarch_pc_regnum (struct gdbarch *gdbarch, int pc_regnum);
0f71a2f6 300
c2169756
AC
301extern int gdbarch_ps_regnum (struct gdbarch *gdbarch);
302extern void set_gdbarch_ps_regnum (struct gdbarch *gdbarch, int ps_regnum);
c2169756 303
60054393
MS
304extern int gdbarch_fp0_regnum (struct gdbarch *gdbarch);
305extern void set_gdbarch_fp0_regnum (struct gdbarch *gdbarch, int fp0_regnum);
60054393 306
88c72b7d
AC
307/* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
308
d3f73121 309typedef int (gdbarch_stab_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int stab_regnr);
88c72b7d
AC
310extern int gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, int stab_regnr);
311extern void set_gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_stab_reg_to_regnum_ftype *stab_reg_to_regnum);
88c72b7d
AC
312
313/* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
314
d3f73121 315typedef int (gdbarch_ecoff_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int ecoff_regnr);
88c72b7d
AC
316extern int gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, int ecoff_regnr);
317extern void set_gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_ecoff_reg_to_regnum_ftype *ecoff_reg_to_regnum);
88c72b7d 318
77949794 319/* Convert from an sdb register number to an internal gdb register number. */
88c72b7d 320
d3f73121 321typedef int (gdbarch_sdb_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int sdb_regnr);
88c72b7d
AC
322extern int gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, int sdb_regnr);
323extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
88c72b7d 324
ba2b1c56
DJ
325/* Provide a default mapping from a DWARF2 register number to a gdb REGNUM. */
326
d3f73121 327typedef int (gdbarch_dwarf2_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int dwarf2_regnr);
88c72b7d
AC
328extern int gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, int dwarf2_regnr);
329extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
88c72b7d 330
d93859e2 331typedef const char * (gdbarch_register_name_ftype) (struct gdbarch *gdbarch, int regnr);
fa88f677 332extern const char * gdbarch_register_name (struct gdbarch *gdbarch, int regnr);
104c1213 333extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
0f71a2f6 334
7b9ee6a8
DJ
335/* Return the type of a register specified by the architecture. Only
336 the register cache should call this function directly; others should
337 use "register_type". */
9c04cab7
AC
338
339extern int gdbarch_register_type_p (struct gdbarch *gdbarch);
340
341typedef struct type * (gdbarch_register_type_ftype) (struct gdbarch *gdbarch, int reg_nr);
342extern struct type * gdbarch_register_type (struct gdbarch *gdbarch, int reg_nr);
343extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
344
f3be58bc
AC
345/* See gdbint.texinfo, and PUSH_DUMMY_CALL. */
346
669fac23 347extern int gdbarch_dummy_id_p (struct gdbarch *gdbarch);
f3be58bc 348
669fac23
DJ
349typedef struct frame_id (gdbarch_dummy_id_ftype) (struct gdbarch *gdbarch, struct frame_info *this_frame);
350extern struct frame_id gdbarch_dummy_id (struct gdbarch *gdbarch, struct frame_info *this_frame);
351extern void set_gdbarch_dummy_id (struct gdbarch *gdbarch, gdbarch_dummy_id_ftype *dummy_id);
f3be58bc 352
669fac23 353/* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
064f5156 354 deprecated_fp_regnum. */
f3be58bc 355
f3be58bc
AC
356extern int gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch);
357extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
f3be58bc 358
a86c5fc9 359/* See gdbint.texinfo. See infcall.c. */
b8de8283
AC
360
361extern int gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
362
7d9b040b
RC
363typedef 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);
364extern 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
365extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
366
b8de8283
AC
367extern int gdbarch_call_dummy_location (struct gdbarch *gdbarch);
368extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, int call_dummy_location);
b8de8283 369
b8de8283
AC
370extern int gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
371
82585c72
UW
372typedef 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);
373extern 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
374extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
375
0ab7a791
AC
376typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
377extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, int regnum, int all);
378extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
379
23e3a7ac
AC
380extern int gdbarch_print_float_info_p (struct gdbarch *gdbarch);
381
382typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
383extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
5e74b15c 384extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
5e74b15c 385
e76f1f2e
AC
386extern int gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
387
388typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
389extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, struct frame_info *frame, const char *args);
390extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
391
7c7651b2
AC
392/* MAP a GDB RAW register number onto a simulator register number. See
393 also include/...-sim.h. */
394
e7faf938 395typedef int (gdbarch_register_sim_regno_ftype) (struct gdbarch *gdbarch, int reg_nr);
7c7651b2
AC
396extern int gdbarch_register_sim_regno (struct gdbarch *gdbarch, int reg_nr);
397extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
7c7651b2 398
64a3914f 399typedef int (gdbarch_cannot_fetch_register_ftype) (struct gdbarch *gdbarch, int regnum);
01fb7433
AC
400extern int gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, int regnum);
401extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
01fb7433 402
64a3914f 403typedef int (gdbarch_cannot_store_register_ftype) (struct gdbarch *gdbarch, int regnum);
01fb7433
AC
404extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
405extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
01fb7433 406
9df628e0
RE
407/* setjmp/longjmp support. */
408
9df628e0 409extern int gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
0f71a2f6 410
60ade65d
UW
411typedef int (gdbarch_get_longjmp_target_ftype) (struct frame_info *frame, CORE_ADDR *pc);
412extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR *pc);
b8de8283 413extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
0f71a2f6 414
104c1213
JM
415extern int gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch);
416extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
0f71a2f6 417
0abe36f5 418typedef int (gdbarch_convert_register_p_ftype) (struct gdbarch *gdbarch, int regnum, struct type *type);
ff2e87ac 419extern int gdbarch_convert_register_p (struct gdbarch *gdbarch, int regnum, struct type *type);
13d01224 420extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
13d01224 421
8dccd430
PA
422typedef int (gdbarch_register_to_value_ftype) (struct frame_info *frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
423extern 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 424extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
13d01224 425
b60c417a
AC
426typedef void (gdbarch_value_to_register_ftype) (struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
427extern void gdbarch_value_to_register (struct gdbarch *gdbarch, struct frame_info *frame, int regnum, struct type *type, const gdb_byte *buf);
13d01224 428extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
13d01224 429
9acbedc0
UW
430/* Construct a value representing the contents of register REGNUM in
431 frame FRAME, interpreted as type TYPE. The routine needs to
432 allocate and return a struct value with all value attributes
433 (but not the value contents) filled in. */
434
435typedef struct value * (gdbarch_value_from_register_ftype) (struct type *type, int regnum, struct frame_info *frame);
436extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_info *frame);
437extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
438
9898f801 439typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
b60c417a 440extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
4478b372 441extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
33489c5b 442
9898f801 443typedef void (gdbarch_address_to_pointer_ftype) (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
b60c417a 444extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
4478b372 445extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
33489c5b 446
fc0c74b1 447extern int gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
fc0c74b1 448
fc1a4b47
AC
449typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
450extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
fc0c74b1 451extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
fc0c74b1 452
6a3a010b
MR
453/* Return the return-value convention that will be used by FUNCTION
454 to return a value of type VALTYPE. FUNCTION may be NULL in which
ea42b34a
JB
455 case the return convention is computed based only on VALTYPE.
456
457 If READBUF is not NULL, extract the return value and save it in this buffer.
458
459 If WRITEBUF is not NULL, it contains a return value which will be
460 stored into the appropriate register. This can be used when we want
461 to force the value returned by a function (see the "return" command
462 for instance). */
92ad9cd9
AC
463
464extern int gdbarch_return_value_p (struct gdbarch *gdbarch);
465
6a3a010b
MR
466typedef 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);
467extern 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
468extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
469
18648a37
YQ
470/* Return true if the return value of function is stored in the first hidden
471 parameter. In theory, this feature should be language-dependent, specified
472 by language and its ABI, such as C++. Unfortunately, compiler may
473 implement it to a target-dependent feature. So that we need such hook here
474 to be aware of this in GDB. */
475
476typedef int (gdbarch_return_in_first_hidden_param_p_ftype) (struct gdbarch *gdbarch, struct type *type);
477extern int gdbarch_return_in_first_hidden_param_p (struct gdbarch *gdbarch, struct type *type);
478extern 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);
479
6093d2eb 480typedef CORE_ADDR (gdbarch_skip_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
104c1213
JM
481extern CORE_ADDR gdbarch_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
482extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
0f71a2f6 483
4309257c
PM
484extern int gdbarch_skip_main_prologue_p (struct gdbarch *gdbarch);
485
486typedef CORE_ADDR (gdbarch_skip_main_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
487extern CORE_ADDR gdbarch_skip_main_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
488extern void set_gdbarch_skip_main_prologue (struct gdbarch *gdbarch, gdbarch_skip_main_prologue_ftype *skip_main_prologue);
489
104c1213
JM
490typedef int (gdbarch_inner_than_ftype) (CORE_ADDR lhs, CORE_ADDR rhs);
491extern int gdbarch_inner_than (struct gdbarch *gdbarch, CORE_ADDR lhs, CORE_ADDR rhs);
492extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
0f71a2f6 493
67d57894 494typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
fc1a4b47 495extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
104c1213 496extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
33489c5b 497
a1dcb23a
DJ
498/* Return the adjusted address and kind to use for Z0/Z1 packets.
499 KIND is usually the memory length of the breakpoint, but may have a
500 different target-specific meaning. */
501
502typedef void (gdbarch_remote_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *kindptr);
503extern void gdbarch_remote_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *kindptr);
504extern void set_gdbarch_remote_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_remote_breakpoint_from_pc_ftype *remote_breakpoint_from_pc);
505
a1131521
KB
506extern int gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
507
508typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
509extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
510extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
511
ae4b2284 512typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
8181d85f 513extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
917317f4 514extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
33489c5b 515
ae4b2284 516typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
8181d85f 517extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
917317f4 518extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
917317f4 519
104c1213
JM
520extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
521extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
0f71a2f6 522
782263ab
AC
523/* A function can be addressed by either it's "pointer" (possibly a
524 descriptor address) or "entry point" (first executable instruction).
525 The method "convert_from_func_ptr_addr" converting the former to the
cbf3b44a 526 latter. gdbarch_deprecated_function_start_offset is being used to implement
782263ab
AC
527 a simplified subset of that functionality - the function's address
528 corresponds to the "function pointer" and the function's start
529 corresponds to the "function entry point" - and hence is redundant. */
530
531extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
532extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
0f71a2f6 533
123dc839
DJ
534/* Return the remote protocol register number associated with this
535 register. Normally the identity mapping. */
536
537typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
538extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
539extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
540
b2756930
KB
541/* Fetch the target specific address used to represent a load module. */
542
b2756930 543extern int gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
b2756930
KB
544
545typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
546extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
547extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
b2756930 548
104c1213
JM
549extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
550extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
0f71a2f6 551
12cc2063
AC
552extern int gdbarch_unwind_pc_p (struct gdbarch *gdbarch);
553
554typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
555extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, struct frame_info *next_frame);
556extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
557
a9e5fdc2
AC
558extern int gdbarch_unwind_sp_p (struct gdbarch *gdbarch);
559
560typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, struct frame_info *next_frame);
561extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, struct frame_info *next_frame);
562extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
563
42efa47a
AC
564/* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
565 frame-base. Enable frame-base before frame-unwind. */
566
983a287a 567extern int gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
983a287a 568
104c1213
JM
569typedef int (gdbarch_frame_num_args_ftype) (struct frame_info *frame);
570extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, struct frame_info *frame);
571extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
0f71a2f6 572
dc604539
AC
573extern int gdbarch_frame_align_p (struct gdbarch *gdbarch);
574
575typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
576extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
577extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
578
192cb3d4
MK
579typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
580extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
581extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
582
8b148df9
AC
583extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
584extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
8b148df9 585
e2d0e7eb
AC
586typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
587extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
f517ea4e 588extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
f517ea4e 589
875e1767
AC
590/* On some machines there are bits in addresses which are not really
591 part of the address, but are used by the kernel, the hardware, etc.
bf6ae464 592 for special purposes. gdbarch_addr_bits_remove takes out any such bits so
875e1767
AC
593 we get a "real" address such as one would find in a symbol table.
594 This is used only for addresses of instructions, and even then I'm
595 not sure it's used in all contexts. It exists to deal with there
596 being a few stray bits in the PC which would mislead us, not as some
597 sort of generic thing to handle alignment or segmentation (it's
598 possible it should be in TARGET_READ_PC instead). */
599
24568a2c 600typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
875e1767
AC
601extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
602extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
875e1767 603
e6590a1b
UW
604/* FIXME/cagney/2001-01-18: This should be split in two. A target method that
605 indicates if the target needs software single step. An ISA method to
606 implement it.
64c4637f 607
e6590a1b
UW
608 FIXME/cagney/2001-01-18: This should be replaced with something that inserts
609 breakpoints using the breakpoint system instead of blatting memory directly
610 (as with rs6000).
64c4637f 611
e6590a1b
UW
612 FIXME/cagney/2001-01-18: The logic is backwards. It should be asking if the
613 target can single step. If not, then implement single step using breakpoints.
614
f17b6955 615 A return value of 1 means that the software_single_step breakpoints
e6590a1b 616 were inserted; 0 means they were not. */
64c4637f 617
64c4637f 618extern int gdbarch_software_single_step_p (struct gdbarch *gdbarch);
64c4637f 619
0b1b3e42
UW
620typedef int (gdbarch_software_single_step_ftype) (struct frame_info *frame);
621extern int gdbarch_software_single_step (struct gdbarch *gdbarch, struct frame_info *frame);
64c4637f 622extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
64c4637f 623
3352ef37
AC
624/* Return non-zero if the processor is executing a delay slot and a
625 further single-step is needed before the instruction finishes. */
626
627extern int gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
628
629typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, struct frame_info *frame);
630extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, struct frame_info *frame);
631extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
632
f6c40618 633/* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
b2fa5097 634 disassembler. Perhaps objdump can handle it? */
f6c40618 635
a89aa300
AC
636typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
637extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
2bf0cb65 638extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
2bf0cb65 639
52f729a7
UW
640typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (struct frame_info *frame, CORE_ADDR pc);
641extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, struct frame_info *frame, CORE_ADDR pc);
bdcd319a 642extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
bdcd319a 643
cfd8ab24 644/* If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
dea0c52f
MK
645 evaluates non-zero, this is the address where the debugger will place
646 a step-resume breakpoint to get us past the dynamic linker. */
647
4c8c40e6 648typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
dea0c52f
MK
649extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
650extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
dea0c52f 651
d50355b6
MS
652/* Some systems also have trampoline code for returning from shared libs. */
653
2c02bd72
DE
654typedef int (gdbarch_in_solib_return_trampoline_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
655extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
d50355b6 656extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
d50355b6 657
c12260ac
CV
658/* A target might have problems with watchpoints as soon as the stack
659 frame of the current function has been destroyed. This mostly happens
660 as the first action in a funtion's epilogue. in_function_epilogue_p()
661 is defined to return a non-zero value if either the given addr is one
662 instruction after the stack destroying instruction up to the trailing
663 return instruction or if we can figure out that the stack frame has
664 already been invalidated regardless of the value of addr. Targets
665 which don't suffer from that problem could just let this functionality
666 untouched. */
667
668typedef int (gdbarch_in_function_epilogue_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
669extern int gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, CORE_ADDR addr);
670extern void set_gdbarch_in_function_epilogue_p (struct gdbarch *gdbarch, gdbarch_in_function_epilogue_p_ftype *in_function_epilogue_p);
671
a2cf933a
EZ
672typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
673extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
674extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
a2cf933a 675
a2cf933a
EZ
676typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
677extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
678extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
a2cf933a 679
c4ed33b9
AC
680extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
681extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
c4ed33b9 682
f74fa174
MM
683extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
684extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
f74fa174 685
8b2dbe47 686extern int gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
8b2dbe47 687
8b2dbe47
KB
688typedef int (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
689extern int gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
690extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
8b2dbe47 691
8b2dbe47 692extern int gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
8b2dbe47 693
321432c0
KB
694typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, int type_flags);
695extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, int type_flags);
8b2dbe47 696extern 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
KB
697
698extern int gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
8b2dbe47 699
321432c0
KB
700typedef int (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
701extern int gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, int *type_flags_ptr);
8b2dbe47 702extern 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 703
b59ff9d5
AC
704/* Is a register in a group */
705
706typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
707extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, struct reggroup *reggroup);
708extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
709
2e092625 710/* Fetch the pointer to the ith function argument. */
143985b7 711
143985b7 712extern int gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
143985b7 713
143985b7
AF
714typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (struct frame_info *frame, int argi, struct type *type);
715extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, struct frame_info *frame, int argi, struct type *type);
716extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
143985b7 717
6ce6d90f
MK
718/* Return the appropriate register set for a core file section with
719 name SECT_NAME and size SECT_SIZE. */
720
721extern int gdbarch_regset_from_core_section_p (struct gdbarch *gdbarch);
722
723typedef const struct regset * (gdbarch_regset_from_core_section_ftype) (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
724extern const struct regset * gdbarch_regset_from_core_section (struct gdbarch *gdbarch, const char *sect_name, size_t sect_size);
725extern void set_gdbarch_regset_from_core_section (struct gdbarch *gdbarch, gdbarch_regset_from_core_section_ftype *regset_from_core_section);
726
17ea7499
CES
727/* Supported register notes in a core file. */
728
729extern struct core_regset_section * gdbarch_core_regset_sections (struct gdbarch *gdbarch);
730extern void set_gdbarch_core_regset_sections (struct gdbarch *gdbarch, struct core_regset_section * core_regset_sections);
731
6432734d
UW
732/* Create core file notes */
733
734extern int gdbarch_make_corefile_notes_p (struct gdbarch *gdbarch);
735
736typedef char * (gdbarch_make_corefile_notes_ftype) (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
737extern char * gdbarch_make_corefile_notes (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
738extern void set_gdbarch_make_corefile_notes (struct gdbarch *gdbarch, gdbarch_make_corefile_notes_ftype *make_corefile_notes);
739
35c2fab7
UW
740/* Find core file memory regions */
741
742extern int gdbarch_find_memory_regions_p (struct gdbarch *gdbarch);
743
744typedef int (gdbarch_find_memory_regions_ftype) (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
745extern int gdbarch_find_memory_regions (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
746extern void set_gdbarch_find_memory_regions (struct gdbarch *gdbarch, gdbarch_find_memory_regions_ftype *find_memory_regions);
747
de584861
PA
748/* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
749 core file into buffer READBUF with length LEN. */
750
751extern int gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
752
753typedef LONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
754extern LONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, LONGEST len);
755extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
756
c0edd9ed 757/* How the core target converts a PTID from a core file to a string. */
28439f5e
PA
758
759extern int gdbarch_core_pid_to_str_p (struct gdbarch *gdbarch);
760
761typedef char * (gdbarch_core_pid_to_str_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
762extern char * gdbarch_core_pid_to_str (struct gdbarch *gdbarch, ptid_t ptid);
763extern void set_gdbarch_core_pid_to_str (struct gdbarch *gdbarch, gdbarch_core_pid_to_str_ftype *core_pid_to_str);
764
a78c2d62
UW
765/* BFD target to use when generating a core file. */
766
767extern int gdbarch_gcore_bfd_target_p (struct gdbarch *gdbarch);
768
769extern const char * gdbarch_gcore_bfd_target (struct gdbarch *gdbarch);
770extern void set_gdbarch_gcore_bfd_target (struct gdbarch *gdbarch, const char * gcore_bfd_target);
771
0d5de010
DJ
772/* If the elements of C++ vtables are in-place function descriptors rather
773 than normal function pointers (which may point to code or a descriptor),
774 set this to one. */
775
776extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
777extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
778
779/* Set if the least significant bit of the delta is used instead of the least
780 significant bit of the pfn for pointers to virtual member functions. */
781
782extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
783extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
784
6d350bb5
UW
785/* Advance PC to next instruction in order to skip a permanent breakpoint. */
786
787extern int gdbarch_skip_permanent_breakpoint_p (struct gdbarch *gdbarch);
788
789typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
790extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
791extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
792
1668ae25 793/* The maximum length of an instruction on this architecture in bytes. */
237fc4c9
PA
794
795extern int gdbarch_max_insn_length_p (struct gdbarch *gdbarch);
796
797extern ULONGEST gdbarch_max_insn_length (struct gdbarch *gdbarch);
798extern void set_gdbarch_max_insn_length (struct gdbarch *gdbarch, ULONGEST max_insn_length);
799
800/* Copy the instruction at FROM to TO, and make any adjustments
801 necessary to single-step it at that address.
802
803 REGS holds the state the thread's registers will have before
804 executing the copied instruction; the PC in REGS will refer to FROM,
805 not the copy at TO. The caller should update it to point at TO later.
806
807 Return a pointer to data of the architecture's choice to be passed
808 to gdbarch_displaced_step_fixup. Or, return NULL to indicate that
809 the instruction's effects have been completely simulated, with the
810 resulting state written back to REGS.
811
812 For a general explanation of displaced stepping and how GDB uses it,
813 see the comments in infrun.c.
814
815 The TO area is only guaranteed to have space for
816 gdbarch_max_insn_length (arch) bytes, so this function must not
817 write more bytes than that to that area.
818
819 If you do not provide this function, GDB assumes that the
820 architecture does not support displaced stepping.
821
822 If your architecture doesn't need to adjust instructions before
823 single-stepping them, consider using simple_displaced_step_copy_insn
824 here. */
825
826extern int gdbarch_displaced_step_copy_insn_p (struct gdbarch *gdbarch);
827
828typedef struct displaced_step_closure * (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
829extern struct displaced_step_closure * gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
830extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
831
99e40580
UW
832/* Return true if GDB should use hardware single-stepping to execute
833 the displaced instruction identified by CLOSURE. If false,
834 GDB will simply restart execution at the displaced instruction
835 location, and it is up to the target to ensure GDB will receive
836 control again (e.g. by placing a software breakpoint instruction
837 into the displaced instruction buffer).
838
839 The default implementation returns false on all targets that
840 provide a gdbarch_software_single_step routine, and true otherwise. */
841
842typedef int (gdbarch_displaced_step_hw_singlestep_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
843extern int gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
844extern void set_gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, gdbarch_displaced_step_hw_singlestep_ftype *displaced_step_hw_singlestep);
845
237fc4c9
PA
846/* Fix up the state resulting from successfully single-stepping a
847 displaced instruction, to give the result we would have gotten from
848 stepping the instruction in its original location.
849
850 REGS is the register state resulting from single-stepping the
851 displaced instruction.
852
853 CLOSURE is the result from the matching call to
854 gdbarch_displaced_step_copy_insn.
855
856 If you provide gdbarch_displaced_step_copy_insn.but not this
857 function, then GDB assumes that no fixup is needed after
858 single-stepping the instruction.
859
860 For a general explanation of displaced stepping and how GDB uses it,
861 see the comments in infrun.c. */
862
863extern int gdbarch_displaced_step_fixup_p (struct gdbarch *gdbarch);
864
865typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
866extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
867extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
868
869/* Free a closure returned by gdbarch_displaced_step_copy_insn.
870
871 If you provide gdbarch_displaced_step_copy_insn, you must provide
872 this function as well.
873
874 If your architecture uses closures that don't need to be freed, then
875 you can use simple_displaced_step_free_closure here.
876
877 For a general explanation of displaced stepping and how GDB uses it,
878 see the comments in infrun.c. */
879
880typedef void (gdbarch_displaced_step_free_closure_ftype) (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
881extern void gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, struct displaced_step_closure *closure);
882extern void set_gdbarch_displaced_step_free_closure (struct gdbarch *gdbarch, gdbarch_displaced_step_free_closure_ftype *displaced_step_free_closure);
883
884/* Return the address of an appropriate place to put displaced
885 instructions while we step over them. There need only be one such
886 place, since we're only stepping one thread over a breakpoint at a
887 time.
888
889 For a general explanation of displaced stepping and how GDB uses it,
890 see the comments in infrun.c. */
891
892typedef CORE_ADDR (gdbarch_displaced_step_location_ftype) (struct gdbarch *gdbarch);
893extern CORE_ADDR gdbarch_displaced_step_location (struct gdbarch *gdbarch);
894extern void set_gdbarch_displaced_step_location (struct gdbarch *gdbarch, gdbarch_displaced_step_location_ftype *displaced_step_location);
895
dde08ee1
PA
896/* Relocate an instruction to execute at a different address. OLDLOC
897 is the address in the inferior memory where the instruction to
898 relocate is currently at. On input, TO points to the destination
899 where we want the instruction to be copied (and possibly adjusted)
900 to. On output, it points to one past the end of the resulting
901 instruction(s). The effect of executing the instruction at TO shall
902 be the same as if executing it at FROM. For example, call
903 instructions that implicitly push the return address on the stack
904 should be adjusted to return to the instruction after OLDLOC;
905 relative branches, and other PC-relative instructions need the
906 offset adjusted; etc. */
907
908extern int gdbarch_relocate_instruction_p (struct gdbarch *gdbarch);
909
910typedef void (gdbarch_relocate_instruction_ftype) (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
911extern void gdbarch_relocate_instruction (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
912extern void set_gdbarch_relocate_instruction (struct gdbarch *gdbarch, gdbarch_relocate_instruction_ftype *relocate_instruction);
913
1c772458
UW
914/* Refresh overlay mapped state for section OSECT. */
915
916extern int gdbarch_overlay_update_p (struct gdbarch *gdbarch);
917
918typedef void (gdbarch_overlay_update_ftype) (struct obj_section *osect);
919extern void gdbarch_overlay_update (struct gdbarch *gdbarch, struct obj_section *osect);
920extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
921
4eb0ad19
DJ
922extern int gdbarch_core_read_description_p (struct gdbarch *gdbarch);
923
924typedef const struct target_desc * (gdbarch_core_read_description_ftype) (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
925extern const struct target_desc * gdbarch_core_read_description (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
926extern void set_gdbarch_core_read_description (struct gdbarch *gdbarch, gdbarch_core_read_description_ftype *core_read_description);
927
149ad273
UW
928/* Handle special encoding of static variables in stabs debug info. */
929
930extern int gdbarch_static_transform_name_p (struct gdbarch *gdbarch);
931
0d5cff50
DE
932typedef const char * (gdbarch_static_transform_name_ftype) (const char *name);
933extern const char * gdbarch_static_transform_name (struct gdbarch *gdbarch, const char *name);
149ad273
UW
934extern void set_gdbarch_static_transform_name (struct gdbarch *gdbarch, gdbarch_static_transform_name_ftype *static_transform_name);
935
203c3895
UW
936/* Set if the address in N_SO or N_FUN stabs may be zero. */
937
938extern int gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch);
939extern void set_gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch, int sofun_address_maybe_missing);
940
0508c3ec
HZ
941/* Parse the instruction at ADDR storing in the record execution log
942 the registers REGCACHE and memory ranges that will be affected when
943 the instruction executes, along with their current values.
944 Return -1 if something goes wrong, 0 otherwise. */
945
946extern int gdbarch_process_record_p (struct gdbarch *gdbarch);
947
948typedef int (gdbarch_process_record_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
949extern int gdbarch_process_record (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
950extern void set_gdbarch_process_record (struct gdbarch *gdbarch, gdbarch_process_record_ftype *process_record);
3846b520
HZ
951
952/* Save process state after a signal.
953 Return -1 if something goes wrong, 0 otherwise. */
954
955extern int gdbarch_process_record_signal_p (struct gdbarch *gdbarch);
956
2ea28649
PA
957typedef int (gdbarch_process_record_signal_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
958extern int gdbarch_process_record_signal (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
3846b520 959extern void set_gdbarch_process_record_signal (struct gdbarch *gdbarch, gdbarch_process_record_signal_ftype *process_record_signal);
0508c3ec 960
22203bbf 961/* Signal translation: translate inferior's signal (target's) number
86b49880
PA
962 into GDB's representation. The implementation of this method must
963 be host independent. IOW, don't rely on symbols of the NAT_FILE
964 header (the nm-*.h files), the host <signal.h> header, or similar
965 headers. This is mainly used when cross-debugging core files ---
966 "Live" targets hide the translation behind the target interface
1f8cf220
PA
967 (target_wait, target_resume, etc.). */
968
969extern int gdbarch_gdb_signal_from_target_p (struct gdbarch *gdbarch);
22203bbf
PA
970
971typedef enum gdb_signal (gdbarch_gdb_signal_from_target_ftype) (struct gdbarch *gdbarch, int signo);
972extern enum gdb_signal gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, int signo);
973extern void set_gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_from_target_ftype *gdb_signal_from_target);
1cded358 974
4aa995e1 975/* Extra signal info inspection.
959b8724 976
4aa995e1
PA
977 Return a type suitable to inspect extra signal information. */
978
979extern int gdbarch_get_siginfo_type_p (struct gdbarch *gdbarch);
980
981typedef struct type * (gdbarch_get_siginfo_type_ftype) (struct gdbarch *gdbarch);
982extern struct type * gdbarch_get_siginfo_type (struct gdbarch *gdbarch);
983extern void set_gdbarch_get_siginfo_type (struct gdbarch *gdbarch, gdbarch_get_siginfo_type_ftype *get_siginfo_type);
984
60c5725c
DJ
985/* Record architecture-specific information from the symbol table. */
986
987extern int gdbarch_record_special_symbol_p (struct gdbarch *gdbarch);
988
989typedef void (gdbarch_record_special_symbol_ftype) (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
990extern void gdbarch_record_special_symbol (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
991extern void set_gdbarch_record_special_symbol (struct gdbarch *gdbarch, gdbarch_record_special_symbol_ftype *record_special_symbol);
992
a96d9b2e
SDJ
993/* Function for the 'catch syscall' feature.
994 Get architecture-specific system calls information from registers. */
995
996extern int gdbarch_get_syscall_number_p (struct gdbarch *gdbarch);
997
998typedef LONGEST (gdbarch_get_syscall_number_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
999extern LONGEST gdbarch_get_syscall_number (struct gdbarch *gdbarch, ptid_t ptid);
1000extern void set_gdbarch_get_syscall_number (struct gdbarch *gdbarch, gdbarch_get_syscall_number_ftype *get_syscall_number);
1001
55aa24fb
SDJ
1002/* SystemTap related fields and functions.
1003 Prefix used to mark an integer constant on the architecture's assembly
1004 For example, on x86 integer constants are written as:
1005
1006 $10 ;; integer constant 10
1007
1008 in this case, this prefix would be the character `$'. */
1009
1010extern const char * gdbarch_stap_integer_prefix (struct gdbarch *gdbarch);
1011extern void set_gdbarch_stap_integer_prefix (struct gdbarch *gdbarch, const char * stap_integer_prefix);
1012
1013/* Suffix used to mark an integer constant on the architecture's assembly. */
1014
1015extern const char * gdbarch_stap_integer_suffix (struct gdbarch *gdbarch);
1016extern void set_gdbarch_stap_integer_suffix (struct gdbarch *gdbarch, const char * stap_integer_suffix);
1017
1018/* Prefix used to mark a register name on the architecture's assembly.
1019 For example, on x86 the register name is written as:
1020
1021 %eax ;; register eax
1022
1023 in this case, this prefix would be the character `%'. */
1024
1025extern const char * gdbarch_stap_register_prefix (struct gdbarch *gdbarch);
1026extern void set_gdbarch_stap_register_prefix (struct gdbarch *gdbarch, const char * stap_register_prefix);
1027
1028/* Suffix used to mark a register name on the architecture's assembly */
1029
1030extern const char * gdbarch_stap_register_suffix (struct gdbarch *gdbarch);
1031extern void set_gdbarch_stap_register_suffix (struct gdbarch *gdbarch, const char * stap_register_suffix);
1032
1033/* Prefix used to mark a register indirection on the architecture's assembly.
1034 For example, on x86 the register indirection is written as:
1035
1036 (%eax) ;; indirecting eax
1037
1038 in this case, this prefix would be the charater `('.
1039
1040 Please note that we use the indirection prefix also for register
1041 displacement, e.g., `4(%eax)' on x86. */
1042
1043extern const char * gdbarch_stap_register_indirection_prefix (struct gdbarch *gdbarch);
1044extern void set_gdbarch_stap_register_indirection_prefix (struct gdbarch *gdbarch, const char * stap_register_indirection_prefix);
1045
1046/* Suffix used to mark a register indirection on the architecture's assembly.
1047 For example, on x86 the register indirection is written as:
1048
1049 (%eax) ;; indirecting eax
1050
1051 in this case, this prefix would be the charater `)'.
1052
1053 Please note that we use the indirection suffix also for register
1054 displacement, e.g., `4(%eax)' on x86. */
1055
1056extern const char * gdbarch_stap_register_indirection_suffix (struct gdbarch *gdbarch);
1057extern void set_gdbarch_stap_register_indirection_suffix (struct gdbarch *gdbarch, const char * stap_register_indirection_suffix);
1058
1059/* Prefix used to name a register using GDB's nomenclature.
1060
1061 For example, on PPC a register is represented by a number in the assembly
1062 language (e.g., `10' is the 10th general-purpose register). However,
1063 inside GDB this same register has an `r' appended to its name, so the 10th
1064 register would be represented as `r10' internally. */
1065
1066extern const char * gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch);
1067extern void set_gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch, const char * stap_gdb_register_prefix);
1068
1069/* Suffix used to name a register using GDB's nomenclature. */
1070
1071extern const char * gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch);
1072extern void set_gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch, const char * stap_gdb_register_suffix);
1073
1074/* Check if S is a single operand.
1075
1076 Single operands can be:
1077 - Literal integers, e.g. `$10' on x86
1078 - Register access, e.g. `%eax' on x86
1079 - Register indirection, e.g. `(%eax)' on x86
1080 - Register displacement, e.g. `4(%eax)' on x86
1081
1082 This function should check for these patterns on the string
1083 and return 1 if some were found, or zero otherwise. Please try to match
1084 as much info as you can from the string, i.e., if you have to match
1085 something like `(%', do not match just the `('. */
1086
1087extern int gdbarch_stap_is_single_operand_p (struct gdbarch *gdbarch);
1088
1089typedef int (gdbarch_stap_is_single_operand_ftype) (struct gdbarch *gdbarch, const char *s);
1090extern int gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, const char *s);
1091extern void set_gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, gdbarch_stap_is_single_operand_ftype *stap_is_single_operand);
1092
1093/* Function used to handle a "special case" in the parser.
1094
1095 A "special case" is considered to be an unknown token, i.e., a token
1096 that the parser does not know how to parse. A good example of special
1097 case would be ARM's register displacement syntax:
1098
1099 [R0, #4] ;; displacing R0 by 4
1100
1101 Since the parser assumes that a register displacement is of the form:
1102
1103 <number> <indirection_prefix> <register_name> <indirection_suffix>
1104
1105 it means that it will not be able to recognize and parse this odd syntax.
1106 Therefore, we should add a special case function that will handle this token.
1107
1108 This function should generate the proper expression form of the expression
1109 using GDB's internal expression mechanism (e.g., `write_exp_elt_opcode'
1110 and so on). It should also return 1 if the parsing was successful, or zero
1111 if the token was not recognized as a special token (in this case, returning
1112 zero means that the special parser is deferring the parsing to the generic
1113 parser), and should advance the buffer pointer (p->arg). */
1114
1115extern int gdbarch_stap_parse_special_token_p (struct gdbarch *gdbarch);
1116
1117typedef int (gdbarch_stap_parse_special_token_ftype) (struct gdbarch *gdbarch, struct stap_parse_info *p);
1118extern int gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, struct stap_parse_info *p);
1119extern void set_gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, gdbarch_stap_parse_special_token_ftype *stap_parse_special_token);
1120
50c71eaf 1121/* True if the list of shared libraries is one and only for all
9bc9e927 1122 processes, as opposed to a list of shared libraries per inferior.
2567c7d9
PA
1123 This usually means that all processes, although may or may not share
1124 an address space, will see the same set of symbols at the same
1125 addresses. */
50c71eaf
PA
1126
1127extern int gdbarch_has_global_solist (struct gdbarch *gdbarch);
1128extern void set_gdbarch_has_global_solist (struct gdbarch *gdbarch, int has_global_solist);
1129
2567c7d9
PA
1130/* On some targets, even though each inferior has its own private
1131 address space, the debug interface takes care of making breakpoints
1132 visible to all address spaces automatically. For such cases,
1133 this property should be set to true. */
1134
1135extern int gdbarch_has_global_breakpoints (struct gdbarch *gdbarch);
1136extern void set_gdbarch_has_global_breakpoints (struct gdbarch *gdbarch, int has_global_breakpoints);
1137
6c95b8df
PA
1138/* True if inferiors share an address space (e.g., uClinux). */
1139
1140typedef int (gdbarch_has_shared_address_space_ftype) (struct gdbarch *gdbarch);
1141extern int gdbarch_has_shared_address_space (struct gdbarch *gdbarch);
1142extern void set_gdbarch_has_shared_address_space (struct gdbarch *gdbarch, gdbarch_has_shared_address_space_ftype *has_shared_address_space);
1143
7a697b8d
SS
1144/* True if a fast tracepoint can be set at an address. */
1145
1146typedef int (gdbarch_fast_tracepoint_valid_at_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, int *isize, char **msg);
1147extern int gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, CORE_ADDR addr, int *isize, char **msg);
1148extern void set_gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, gdbarch_fast_tracepoint_valid_at_ftype *fast_tracepoint_valid_at);
1149
f870a310
TT
1150/* Return the "auto" target charset. */
1151
1152typedef const char * (gdbarch_auto_charset_ftype) (void);
1153extern const char * gdbarch_auto_charset (struct gdbarch *gdbarch);
1154extern void set_gdbarch_auto_charset (struct gdbarch *gdbarch, gdbarch_auto_charset_ftype *auto_charset);
1155
1156/* Return the "auto" target wide charset. */
1157
1158typedef const char * (gdbarch_auto_wide_charset_ftype) (void);
1159extern const char * gdbarch_auto_wide_charset (struct gdbarch *gdbarch);
1160extern void set_gdbarch_auto_wide_charset (struct gdbarch *gdbarch, gdbarch_auto_wide_charset_ftype *auto_wide_charset);
1161
08105857
PA
1162/* If non-empty, this is a file extension that will be opened in place
1163 of the file extension reported by the shared library list.
1164
1165 This is most useful for toolchains that use a post-linker tool,
1166 where the names of the files run on the target differ in extension
1167 compared to the names of the files GDB should load for debug info. */
1168
1169extern const char * gdbarch_solib_symbols_extension (struct gdbarch *gdbarch);
1170extern void set_gdbarch_solib_symbols_extension (struct gdbarch *gdbarch, const char * solib_symbols_extension);
1171
1412f70b
HZ
1172/* If true, the target OS has DOS-based file system semantics. That
1173 is, absolute paths include a drive name, and the backslash is
1174 considered a directory separator. */
ab38a727
PA
1175
1176extern int gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch);
1177extern void set_gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch, int has_dos_based_file_system);
1178
6710bf39
SS
1179/* Generate bytecodes to collect the return address in a frame.
1180 Since the bytecodes run on the target, possibly with GDB not even
1181 connected, the full unwinding machinery is not available, and
1182 typically this function will issue bytecodes for one or more likely
1183 places that the return address may be found. */
1184
1185typedef void (gdbarch_gen_return_address_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1186extern void gdbarch_gen_return_address (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1187extern void set_gdbarch_gen_return_address (struct gdbarch *gdbarch, gdbarch_gen_return_address_ftype *gen_return_address);
1188
3030c96e
UW
1189/* Implement the "info proc" command. */
1190
1191extern int gdbarch_info_proc_p (struct gdbarch *gdbarch);
1192
1193typedef void (gdbarch_info_proc_ftype) (struct gdbarch *gdbarch, char *args, enum info_proc_what what);
1194extern void gdbarch_info_proc (struct gdbarch *gdbarch, char *args, enum info_proc_what what);
1195extern void set_gdbarch_info_proc (struct gdbarch *gdbarch, gdbarch_info_proc_ftype *info_proc);
1196
451b7c33
TT
1197/* Implement the "info proc" command for core files. Noe that there
1198 are two "info_proc"-like methods on gdbarch -- one for core files,
1199 one for live targets. */
1200
1201extern int gdbarch_core_info_proc_p (struct gdbarch *gdbarch);
1202
1203typedef void (gdbarch_core_info_proc_ftype) (struct gdbarch *gdbarch, char *args, enum info_proc_what what);
1204extern void gdbarch_core_info_proc (struct gdbarch *gdbarch, char *args, enum info_proc_what what);
1205extern void set_gdbarch_core_info_proc (struct gdbarch *gdbarch, gdbarch_core_info_proc_ftype *core_info_proc);
1206
19630284
JB
1207/* Iterate over all objfiles in the order that makes the most sense
1208 for the architecture to make global symbol searches.
1209
1210 CB is a callback function where OBJFILE is the objfile to be searched,
1211 and CB_DATA a pointer to user-defined data (the same data that is passed
1212 when calling this gdbarch method). The iteration stops if this function
1213 returns nonzero.
1214
1215 CB_DATA is a pointer to some user-defined data to be passed to
1216 the callback.
1217
1218 If not NULL, CURRENT_OBJFILE corresponds to the objfile being
1219 inspected when the symbol search was requested. */
1220
1221typedef 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);
1222extern 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);
1223extern 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);
1224
7e35103a
JB
1225/* Ravenscar arch-dependent ops. */
1226
1227extern struct ravenscar_arch_ops * gdbarch_ravenscar_ops (struct gdbarch *gdbarch);
1228extern void set_gdbarch_ravenscar_ops (struct gdbarch *gdbarch, struct ravenscar_arch_ops * ravenscar_ops);
1229
a96d9b2e
SDJ
1230/* Definition for an unknown syscall, used basically in error-cases. */
1231#define UNKNOWN_SYSCALL (-1)
1232
104c1213 1233extern struct gdbarch_tdep *gdbarch_tdep (struct gdbarch *gdbarch);
0f71a2f6
JM
1234
1235
1236/* Mechanism for co-ordinating the selection of a specific
1237 architecture.
1238
1239 GDB targets (*-tdep.c) can register an interest in a specific
1240 architecture. Other GDB components can register a need to maintain
1241 per-architecture data.
1242
1243 The mechanisms below ensures that there is only a loose connection
1244 between the set-architecture command and the various GDB
99e7bb18 1245 components. Each component can independently register their need
0f71a2f6
JM
1246 to maintain architecture specific data with gdbarch.
1247
1248 Pragmatics:
1249
1250 Previously, a single TARGET_ARCHITECTURE_HOOK was provided. It
1251 didn't scale.
1252
1253 The more traditional mega-struct containing architecture specific
1254 data for all the various GDB components was also considered. Since
99e7bb18 1255 GDB is built from a variable number of (fairly independent)
0f71a2f6 1256 components it was determined that the global aproach was not
0963b4bd 1257 applicable. */
0f71a2f6
JM
1258
1259
1260/* Register a new architectural family with GDB.
1261
1262 Register support for the specified ARCHITECTURE with GDB. When
1263 gdbarch determines that the specified architecture has been
1264 selected, the corresponding INIT function is called.
1265
1266 --
1267
1268 The INIT function takes two parameters: INFO which contains the
1269 information available to gdbarch about the (possibly new)
1270 architecture; ARCHES which is a list of the previously created
1271 ``struct gdbarch'' for this architecture.
1272
0f79675b 1273 The INFO parameter is, as far as possible, be pre-initialized with
7a107747 1274 information obtained from INFO.ABFD or the global defaults.
0f79675b
AC
1275
1276 The ARCHES parameter is a linked list (sorted most recently used)
1277 of all the previously created architures for this architecture
1278 family. The (possibly NULL) ARCHES->gdbarch can used to access
1279 values from the previously selected architecture for this
59837fe0 1280 architecture family.
0f71a2f6
JM
1281
1282 The INIT function shall return any of: NULL - indicating that it
ec3d358c 1283 doesn't recognize the selected architecture; an existing ``struct
0f71a2f6
JM
1284 gdbarch'' from the ARCHES list - indicating that the new
1285 architecture is just a synonym for an earlier architecture (see
1286 gdbarch_list_lookup_by_info()); a newly created ``struct gdbarch''
4b9b3959
AC
1287 - that describes the selected architecture (see gdbarch_alloc()).
1288
1289 The DUMP_TDEP function shall print out all target specific values.
1290 Care should be taken to ensure that the function works in both the
0963b4bd 1291 multi-arch and non- multi-arch cases. */
0f71a2f6 1292
adf40b2e
JM
1293struct gdbarch_list
1294{
1295 struct gdbarch *gdbarch;
1296 struct gdbarch_list *next;
1297};
0f71a2f6 1298
adf40b2e
JM
1299struct gdbarch_info
1300{
0963b4bd 1301 /* Use default: NULL (ZERO). */
adf40b2e 1302 const struct bfd_arch_info *bfd_arch_info;
0f71a2f6 1303
428721aa 1304 /* Use default: BFD_ENDIAN_UNKNOWN (NB: is not ZERO). */
adf40b2e 1305 int byte_order;
0f71a2f6 1306
9d4fde75
SS
1307 int byte_order_for_code;
1308
0963b4bd 1309 /* Use default: NULL (ZERO). */
adf40b2e 1310 bfd *abfd;
0f71a2f6 1311
0963b4bd 1312 /* Use default: NULL (ZERO). */
adf40b2e 1313 struct gdbarch_tdep_info *tdep_info;
4be87837
DJ
1314
1315 /* Use default: GDB_OSABI_UNINITIALIZED (-1). */
1316 enum gdb_osabi osabi;
424163ea
DJ
1317
1318 /* Use default: NULL (ZERO). */
1319 const struct target_desc *target_desc;
adf40b2e 1320};
0f71a2f6 1321
104c1213 1322typedef struct gdbarch *(gdbarch_init_ftype) (struct gdbarch_info info, struct gdbarch_list *arches);
4b9b3959 1323typedef void (gdbarch_dump_tdep_ftype) (struct gdbarch *gdbarch, struct ui_file *file);
0f71a2f6 1324
4b9b3959 1325/* DEPRECATED - use gdbarch_register() */
104c1213 1326extern void register_gdbarch_init (enum bfd_architecture architecture, gdbarch_init_ftype *);
0f71a2f6 1327
4b9b3959
AC
1328extern void gdbarch_register (enum bfd_architecture architecture,
1329 gdbarch_init_ftype *,
1330 gdbarch_dump_tdep_ftype *);
1331
0f71a2f6 1332
b4a20239
AC
1333/* Return a freshly allocated, NULL terminated, array of the valid
1334 architecture names. Since architectures are registered during the
1335 _initialize phase this function only returns useful information
0963b4bd 1336 once initialization has been completed. */
b4a20239
AC
1337
1338extern const char **gdbarch_printable_names (void);
1339
1340
0f71a2f6 1341/* Helper function. Search the list of ARCHES for a GDBARCH that
0963b4bd 1342 matches the information provided by INFO. */
0f71a2f6 1343
424163ea 1344extern struct gdbarch_list *gdbarch_list_lookup_by_info (struct gdbarch_list *arches, const struct gdbarch_info *info);
0f71a2f6
JM
1345
1346
1347/* Helper function. Create a preliminary ``struct gdbarch''. Perform
424163ea 1348 basic initialization using values obtained from the INFO and TDEP
0f71a2f6 1349 parameters. set_gdbarch_*() functions are called to complete the
0963b4bd 1350 initialization of the object. */
0f71a2f6 1351
104c1213 1352extern struct gdbarch *gdbarch_alloc (const struct gdbarch_info *info, struct gdbarch_tdep *tdep);
0f71a2f6
JM
1353
1354
4b9b3959
AC
1355/* Helper function. Free a partially-constructed ``struct gdbarch''.
1356 It is assumed that the caller freeds the ``struct
0963b4bd 1357 gdbarch_tdep''. */
4b9b3959 1358
058f20d5
JB
1359extern void gdbarch_free (struct gdbarch *);
1360
1361
aebd7893
AC
1362/* Helper function. Allocate memory from the ``struct gdbarch''
1363 obstack. The memory is freed when the corresponding architecture
1364 is also freed. */
1365
1366extern void *gdbarch_obstack_zalloc (struct gdbarch *gdbarch, long size);
1367#define GDBARCH_OBSTACK_CALLOC(GDBARCH, NR, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), (NR) * sizeof (TYPE)))
1368#define GDBARCH_OBSTACK_ZALLOC(GDBARCH, TYPE) ((TYPE *) gdbarch_obstack_zalloc ((GDBARCH), sizeof (TYPE)))
1369
1370
0963b4bd 1371/* Helper function. Force an update of the current architecture.
0f71a2f6 1372
b732d07d
AC
1373 The actual architecture selected is determined by INFO, ``(gdb) set
1374 architecture'' et.al., the existing architecture and BFD's default
1375 architecture. INFO should be initialized to zero and then selected
1376 fields should be updated.
0f71a2f6 1377
0963b4bd 1378 Returns non-zero if the update succeeds. */
16f33e29
AC
1379
1380extern int gdbarch_update_p (struct gdbarch_info info);
0f71a2f6
JM
1381
1382
ebdba546
AC
1383/* Helper function. Find an architecture matching info.
1384
1385 INFO should be initialized using gdbarch_info_init, relevant fields
1386 set, and then finished using gdbarch_info_fill.
1387
1388 Returns the corresponding architecture, or NULL if no matching
59837fe0 1389 architecture was found. */
ebdba546
AC
1390
1391extern struct gdbarch *gdbarch_find_by_info (struct gdbarch_info info);
1392
1393
aff68abb 1394/* Helper function. Set the target gdbarch to "gdbarch". */
ebdba546 1395
aff68abb 1396extern void set_target_gdbarch (struct gdbarch *gdbarch);
ebdba546 1397
0f71a2f6
JM
1398
1399/* Register per-architecture data-pointer.
1400
1401 Reserve space for a per-architecture data-pointer. An identifier
1402 for the reserved data-pointer is returned. That identifer should
95160752 1403 be saved in a local static variable.
0f71a2f6 1404
fcc1c85c
AC
1405 Memory for the per-architecture data shall be allocated using
1406 gdbarch_obstack_zalloc. That memory will be deleted when the
1407 corresponding architecture object is deleted.
0f71a2f6 1408
95160752
AC
1409 When a previously created architecture is re-selected, the
1410 per-architecture data-pointer for that previous architecture is
76860b5f 1411 restored. INIT() is not re-called.
0f71a2f6
JM
1412
1413 Multiple registrarants for any architecture are allowed (and
1414 strongly encouraged). */
1415
95160752 1416struct gdbarch_data;
0f71a2f6 1417
030f20e1
AC
1418typedef void *(gdbarch_data_pre_init_ftype) (struct obstack *obstack);
1419extern struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *init);
1420typedef void *(gdbarch_data_post_init_ftype) (struct gdbarch *gdbarch);
1421extern struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *init);
1422extern void deprecated_set_gdbarch_data (struct gdbarch *gdbarch,
1423 struct gdbarch_data *data,
1424 void *pointer);
0f71a2f6 1425
451fbdda 1426extern void *gdbarch_data (struct gdbarch *gdbarch, struct gdbarch_data *);
0f71a2f6
JM
1427
1428
99e7bb18 1429/* Set the dynamic target-system-dependent parameters (architecture,
0963b4bd 1430 byte-order, ...) using information found in the BFD. */
c906108c 1431
104c1213 1432extern void set_gdbarch_from_file (bfd *);
c906108c
SS
1433
1434
e514a9d6
JM
1435/* Initialize the current architecture to the "first" one we find on
1436 our list. */
1437
1438extern void initialize_current_architecture (void);
1439
c906108c 1440/* gdbarch trace variable */
ccce17b0 1441extern unsigned int gdbarch_debug;
c906108c 1442
4b9b3959 1443extern void gdbarch_dump (struct gdbarch *gdbarch, struct ui_file *file);
0f71a2f6 1444
c906108c 1445#endif