]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - gdb/gdbarch-gen.h
PowerPC, function ppc64_sysv_abi_return_value add missing return value convention
[thirdparty/binutils-gdb.git] / gdb / gdbarch-gen.h
CommitLineData
2b7c3f1d
TT
1/* *INDENT-OFF* */ /* THIS FILE IS GENERATED -*- buffer-read-only: t -*- */
2/* vi:set ro: */
3
4/* Dynamic architecture support for GDB, the GNU debugger.
5
4a94e368 6 Copyright (C) 1998-2022 Free Software Foundation, Inc.
2b7c3f1d
TT
7
8 This file is part of GDB.
9
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
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
14
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.
19
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22
a8ab094a
TT
23/* To regenerate this file, run:
24 ./gdbarch.py
25*/
2b7c3f1d
TT
26
27
28
29/* The following are pre-initialized by GDBARCH. */
30
31extern const struct bfd_arch_info * gdbarch_bfd_arch_info (struct gdbarch *gdbarch);
32/* set_gdbarch_bfd_arch_info() - not applicable - pre-initialized. */
33
34extern enum bfd_endian gdbarch_byte_order (struct gdbarch *gdbarch);
35/* set_gdbarch_byte_order() - not applicable - pre-initialized. */
36
37extern enum bfd_endian gdbarch_byte_order_for_code (struct gdbarch *gdbarch);
38/* set_gdbarch_byte_order_for_code() - not applicable - pre-initialized. */
39
40extern enum gdb_osabi gdbarch_osabi (struct gdbarch *gdbarch);
41/* set_gdbarch_osabi() - not applicable - pre-initialized. */
42
43extern const struct target_desc * gdbarch_target_desc (struct gdbarch *gdbarch);
44/* set_gdbarch_target_desc() - not applicable - pre-initialized. */
45
46
47/* The following are initialized by the target dependent code. */
48
49/* Number of bits in a short or unsigned short for the target machine. */
50
51extern int gdbarch_short_bit (struct gdbarch *gdbarch);
52extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
53
54/* Number of bits in an int or unsigned int for the target machine. */
55
56extern int gdbarch_int_bit (struct gdbarch *gdbarch);
57extern void set_gdbarch_int_bit (struct gdbarch *gdbarch, int int_bit);
58
59/* Number of bits in a long or unsigned long for the target machine. */
60
61extern int gdbarch_long_bit (struct gdbarch *gdbarch);
62extern void set_gdbarch_long_bit (struct gdbarch *gdbarch, int long_bit);
63
64/* Number of bits in a long long or unsigned long long for the target
65 machine. */
66
67extern int gdbarch_long_long_bit (struct gdbarch *gdbarch);
68extern void set_gdbarch_long_long_bit (struct gdbarch *gdbarch, int long_long_bit);
69
70/* The ABI default bit-size and format for "bfloat16", "half", "float", "double", and
71 "long double". These bit/format pairs should eventually be combined
72 into a single object. For the moment, just initialize them as a pair.
73 Each format describes both the big and little endian layouts (if
74 useful). */
75
76extern int gdbarch_bfloat16_bit (struct gdbarch *gdbarch);
77extern void set_gdbarch_bfloat16_bit (struct gdbarch *gdbarch, int bfloat16_bit);
78
79extern const struct floatformat ** gdbarch_bfloat16_format (struct gdbarch *gdbarch);
80extern void set_gdbarch_bfloat16_format (struct gdbarch *gdbarch, const struct floatformat ** bfloat16_format);
81
82extern int gdbarch_half_bit (struct gdbarch *gdbarch);
83extern void set_gdbarch_half_bit (struct gdbarch *gdbarch, int half_bit);
84
85extern const struct floatformat ** gdbarch_half_format (struct gdbarch *gdbarch);
86extern void set_gdbarch_half_format (struct gdbarch *gdbarch, const struct floatformat ** half_format);
87
88extern int gdbarch_float_bit (struct gdbarch *gdbarch);
89extern void set_gdbarch_float_bit (struct gdbarch *gdbarch, int float_bit);
90
91extern const struct floatformat ** gdbarch_float_format (struct gdbarch *gdbarch);
92extern void set_gdbarch_float_format (struct gdbarch *gdbarch, const struct floatformat ** float_format);
93
94extern int gdbarch_double_bit (struct gdbarch *gdbarch);
95extern void set_gdbarch_double_bit (struct gdbarch *gdbarch, int double_bit);
96
97extern const struct floatformat ** gdbarch_double_format (struct gdbarch *gdbarch);
98extern void set_gdbarch_double_format (struct gdbarch *gdbarch, const struct floatformat ** double_format);
99
100extern int gdbarch_long_double_bit (struct gdbarch *gdbarch);
101extern void set_gdbarch_long_double_bit (struct gdbarch *gdbarch, int long_double_bit);
102
103extern const struct floatformat ** gdbarch_long_double_format (struct gdbarch *gdbarch);
104extern void set_gdbarch_long_double_format (struct gdbarch *gdbarch, const struct floatformat ** long_double_format);
105
106/* The ABI default bit-size for "wchar_t". wchar_t is a built-in type
107 starting with C++11. */
108
109extern int gdbarch_wchar_bit (struct gdbarch *gdbarch);
110extern void set_gdbarch_wchar_bit (struct gdbarch *gdbarch, int wchar_bit);
111
112/* One if `wchar_t' is signed, zero if unsigned. */
113
114extern int gdbarch_wchar_signed (struct gdbarch *gdbarch);
115extern void set_gdbarch_wchar_signed (struct gdbarch *gdbarch, int wchar_signed);
116
117/* Returns the floating-point format to be used for values of length LENGTH.
118 NAME, if non-NULL, is the type name, which may be used to distinguish
119 different target formats of the same length. */
120
121typedef const struct floatformat ** (gdbarch_floatformat_for_type_ftype) (struct gdbarch *gdbarch, const char *name, int length);
122extern const struct floatformat ** gdbarch_floatformat_for_type (struct gdbarch *gdbarch, const char *name, int length);
123extern void set_gdbarch_floatformat_for_type (struct gdbarch *gdbarch, gdbarch_floatformat_for_type_ftype *floatformat_for_type);
124
125/* For most targets, a pointer on the target and its representation as an
126 address in GDB have the same size and "look the same". For such a
127 target, you need only set gdbarch_ptr_bit and gdbarch_addr_bit
128 / addr_bit will be set from it.
fb14eb08 129
2b7c3f1d
TT
130 If gdbarch_ptr_bit and gdbarch_addr_bit are different, you'll probably
131 also need to set gdbarch_dwarf2_addr_size, gdbarch_pointer_to_address and
132 gdbarch_address_to_pointer as well.
fb14eb08 133
2b7c3f1d
TT
134 ptr_bit is the size of a pointer on the target */
135
136extern int gdbarch_ptr_bit (struct gdbarch *gdbarch);
137extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
138
139/* addr_bit is the size of a target address as represented in gdb */
140
141extern int gdbarch_addr_bit (struct gdbarch *gdbarch);
142extern void set_gdbarch_addr_bit (struct gdbarch *gdbarch, int addr_bit);
143
144/* dwarf2_addr_size is the target address size as used in the Dwarf debug
145 info. For .debug_frame FDEs, this is supposed to be the target address
146 size from the associated CU header, and which is equivalent to the
147 DWARF2_ADDR_SIZE as defined by the target specific GCC back-end.
148 Unfortunately there is no good way to determine this value. Therefore
149 dwarf2_addr_size simply defaults to the target pointer size.
fb14eb08 150
2b7c3f1d
TT
151 dwarf2_addr_size is not used for .eh_frame FDEs, which are generally
152 defined using the target's pointer size so far.
fb14eb08 153
2b7c3f1d
TT
154 Note that dwarf2_addr_size only needs to be redefined by a target if the
155 GCC back-end defines a DWARF2_ADDR_SIZE other than the target pointer size,
156 and if Dwarf versions < 4 need to be supported. */
157
158extern int gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch);
159extern void set_gdbarch_dwarf2_addr_size (struct gdbarch *gdbarch, int dwarf2_addr_size);
160
161/* One if `char' acts like `signed char', zero if `unsigned char'. */
162
163extern int gdbarch_char_signed (struct gdbarch *gdbarch);
164extern void set_gdbarch_char_signed (struct gdbarch *gdbarch, int char_signed);
165
166extern bool gdbarch_read_pc_p (struct gdbarch *gdbarch);
167
168typedef CORE_ADDR (gdbarch_read_pc_ftype) (readable_regcache *regcache);
169extern CORE_ADDR gdbarch_read_pc (struct gdbarch *gdbarch, readable_regcache *regcache);
170extern void set_gdbarch_read_pc (struct gdbarch *gdbarch, gdbarch_read_pc_ftype *read_pc);
171
172extern bool gdbarch_write_pc_p (struct gdbarch *gdbarch);
173
174typedef void (gdbarch_write_pc_ftype) (struct regcache *regcache, CORE_ADDR val);
175extern void gdbarch_write_pc (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR val);
176extern void set_gdbarch_write_pc (struct gdbarch *gdbarch, gdbarch_write_pc_ftype *write_pc);
177
178/* Function for getting target's idea of a frame pointer. FIXME: GDB's
179 whole scheme for dealing with "frames" and "frame pointers" needs a
180 serious shakedown. */
181
182typedef void (gdbarch_virtual_frame_pointer_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
183extern void gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, CORE_ADDR pc, int *frame_regnum, LONGEST *frame_offset);
184extern void set_gdbarch_virtual_frame_pointer (struct gdbarch *gdbarch, gdbarch_virtual_frame_pointer_ftype *virtual_frame_pointer);
185
186extern bool gdbarch_pseudo_register_read_p (struct gdbarch *gdbarch);
187
188typedef enum register_status (gdbarch_pseudo_register_read_ftype) (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum, gdb_byte *buf);
189extern enum register_status gdbarch_pseudo_register_read (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum, gdb_byte *buf);
190extern void set_gdbarch_pseudo_register_read (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_ftype *pseudo_register_read);
191
192/* Read a register into a new struct value. If the register is wholly
193 or partly unavailable, this should call mark_value_bytes_unavailable
194 as appropriate. If this is defined, then pseudo_register_read will
195 never be called. */
196
197extern bool gdbarch_pseudo_register_read_value_p (struct gdbarch *gdbarch);
198
199typedef struct value * (gdbarch_pseudo_register_read_value_ftype) (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum);
200extern struct value * gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, readable_regcache *regcache, int cookednum);
201extern void set_gdbarch_pseudo_register_read_value (struct gdbarch *gdbarch, gdbarch_pseudo_register_read_value_ftype *pseudo_register_read_value);
202
203extern bool gdbarch_pseudo_register_write_p (struct gdbarch *gdbarch);
204
205typedef void (gdbarch_pseudo_register_write_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
206extern void gdbarch_pseudo_register_write (struct gdbarch *gdbarch, struct regcache *regcache, int cookednum, const gdb_byte *buf);
207extern void set_gdbarch_pseudo_register_write (struct gdbarch *gdbarch, gdbarch_pseudo_register_write_ftype *pseudo_register_write);
208
209extern int gdbarch_num_regs (struct gdbarch *gdbarch);
210extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
211
212/* This macro gives the number of pseudo-registers that live in the
213 register namespace but do not get fetched or stored on the target.
214 These pseudo-registers may be aliases for other registers,
215 combinations of other registers, or they may be computed by GDB. */
216
217extern int gdbarch_num_pseudo_regs (struct gdbarch *gdbarch);
218extern void set_gdbarch_num_pseudo_regs (struct gdbarch *gdbarch, int num_pseudo_regs);
219
220/* Assemble agent expression bytecode to collect pseudo-register REG.
221 Return -1 if something goes wrong, 0 otherwise. */
222
223extern bool gdbarch_ax_pseudo_register_collect_p (struct gdbarch *gdbarch);
224
225typedef int (gdbarch_ax_pseudo_register_collect_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
226extern int gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
227extern void set_gdbarch_ax_pseudo_register_collect (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_collect_ftype *ax_pseudo_register_collect);
228
229/* Assemble agent expression bytecode to push the value of pseudo-register
230 REG on the interpreter stack.
231 Return -1 if something goes wrong, 0 otherwise. */
232
233extern bool gdbarch_ax_pseudo_register_push_stack_p (struct gdbarch *gdbarch);
234
235typedef int (gdbarch_ax_pseudo_register_push_stack_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
236extern int gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, struct agent_expr *ax, int reg);
237extern void set_gdbarch_ax_pseudo_register_push_stack (struct gdbarch *gdbarch, gdbarch_ax_pseudo_register_push_stack_ftype *ax_pseudo_register_push_stack);
238
239/* Some architectures can display additional information for specific
240 signals.
241 UIOUT is the output stream where the handler will place information. */
242
243extern bool gdbarch_report_signal_info_p (struct gdbarch *gdbarch);
244
245typedef void (gdbarch_report_signal_info_ftype) (struct gdbarch *gdbarch, struct ui_out *uiout, enum gdb_signal siggnal);
246extern void gdbarch_report_signal_info (struct gdbarch *gdbarch, struct ui_out *uiout, enum gdb_signal siggnal);
247extern void set_gdbarch_report_signal_info (struct gdbarch *gdbarch, gdbarch_report_signal_info_ftype *report_signal_info);
248
249/* GDB's standard (or well known) register numbers. These can map onto
250 a real register or a pseudo (computed) register or not be defined at
251 all (-1).
252 gdbarch_sp_regnum will hopefully be replaced by UNWIND_SP. */
253
254extern int gdbarch_sp_regnum (struct gdbarch *gdbarch);
255extern void set_gdbarch_sp_regnum (struct gdbarch *gdbarch, int sp_regnum);
256
257extern int gdbarch_pc_regnum (struct gdbarch *gdbarch);
258extern void set_gdbarch_pc_regnum (struct gdbarch *gdbarch, int pc_regnum);
259
260extern int gdbarch_ps_regnum (struct gdbarch *gdbarch);
261extern void set_gdbarch_ps_regnum (struct gdbarch *gdbarch, int ps_regnum);
262
263extern int gdbarch_fp0_regnum (struct gdbarch *gdbarch);
264extern void set_gdbarch_fp0_regnum (struct gdbarch *gdbarch, int fp0_regnum);
265
266/* Convert stab register number (from `r' declaration) to a gdb REGNUM. */
267
268typedef int (gdbarch_stab_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int stab_regnr);
269extern int gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, int stab_regnr);
270extern void set_gdbarch_stab_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_stab_reg_to_regnum_ftype *stab_reg_to_regnum);
271
272/* Provide a default mapping from a ecoff register number to a gdb REGNUM. */
273
274typedef int (gdbarch_ecoff_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int ecoff_regnr);
275extern int gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, int ecoff_regnr);
276extern void set_gdbarch_ecoff_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_ecoff_reg_to_regnum_ftype *ecoff_reg_to_regnum);
277
278/* Convert from an sdb register number to an internal gdb register number. */
279
280typedef int (gdbarch_sdb_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int sdb_regnr);
281extern int gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, int sdb_regnr);
282extern void set_gdbarch_sdb_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_sdb_reg_to_regnum_ftype *sdb_reg_to_regnum);
283
284/* Provide a default mapping from a DWARF2 register number to a gdb REGNUM.
285 Return -1 for bad REGNUM. Note: Several targets get this wrong. */
286
287typedef int (gdbarch_dwarf2_reg_to_regnum_ftype) (struct gdbarch *gdbarch, int dwarf2_regnr);
288extern int gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, int dwarf2_regnr);
289extern void set_gdbarch_dwarf2_reg_to_regnum (struct gdbarch *gdbarch, gdbarch_dwarf2_reg_to_regnum_ftype *dwarf2_reg_to_regnum);
290
89e601ac
AB
291/* Return the name of register REGNR for the specified architecture.
292 REGNR can be any value greater than, or equal to zero, and less than
293 'gdbarch_num_cooked_regs (GDBARCH)'. If REGNR is not supported for
294 GDBARCH, then this function will return an empty string, this function
295 should never return nullptr. */
296
2b7c3f1d
TT
297typedef const char * (gdbarch_register_name_ftype) (struct gdbarch *gdbarch, int regnr);
298extern const char * gdbarch_register_name (struct gdbarch *gdbarch, int regnr);
299extern void set_gdbarch_register_name (struct gdbarch *gdbarch, gdbarch_register_name_ftype *register_name);
300
301/* Return the type of a register specified by the architecture. Only
302 the register cache should call this function directly; others should
303 use "register_type". */
304
2b7c3f1d
TT
305typedef struct type * (gdbarch_register_type_ftype) (struct gdbarch *gdbarch, int reg_nr);
306extern struct type * gdbarch_register_type (struct gdbarch *gdbarch, int reg_nr);
307extern void set_gdbarch_register_type (struct gdbarch *gdbarch, gdbarch_register_type_ftype *register_type);
308
309/* Generate a dummy frame_id for THIS_FRAME assuming that the frame is
310 a dummy frame. A dummy frame is created before an inferior call,
311 the frame_id returned here must match the frame_id that was built
312 for the inferior call. Usually this means the returned frame_id's
313 stack address should match the address returned by
314 gdbarch_push_dummy_call, and the returned frame_id's code address
315 should match the address at which the breakpoint was set in the dummy
316 frame. */
317
bd2b40ac
TT
318typedef struct frame_id (gdbarch_dummy_id_ftype) (struct gdbarch *gdbarch, frame_info_ptr this_frame);
319extern struct frame_id gdbarch_dummy_id (struct gdbarch *gdbarch, frame_info_ptr this_frame);
2b7c3f1d
TT
320extern void set_gdbarch_dummy_id (struct gdbarch *gdbarch, gdbarch_dummy_id_ftype *dummy_id);
321
322/* Implement DUMMY_ID and PUSH_DUMMY_CALL, then delete
323 deprecated_fp_regnum. */
324
325extern int gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch);
326extern void set_gdbarch_deprecated_fp_regnum (struct gdbarch *gdbarch, int deprecated_fp_regnum);
327
328extern bool gdbarch_push_dummy_call_p (struct gdbarch *gdbarch);
329
330typedef CORE_ADDR (gdbarch_push_dummy_call_ftype) (struct gdbarch *gdbarch, struct value *function, struct regcache *regcache, CORE_ADDR bp_addr, int nargs, struct value **args, CORE_ADDR sp, function_call_return_method return_method, CORE_ADDR struct_addr);
331extern CORE_ADDR gdbarch_push_dummy_call (struct gdbarch *gdbarch, struct value *function, struct regcache *regcache, CORE_ADDR bp_addr, int nargs, struct value **args, CORE_ADDR sp, function_call_return_method return_method, CORE_ADDR struct_addr);
332extern void set_gdbarch_push_dummy_call (struct gdbarch *gdbarch, gdbarch_push_dummy_call_ftype *push_dummy_call);
333
7807dfae
TT
334extern enum call_dummy_location_type gdbarch_call_dummy_location (struct gdbarch *gdbarch);
335extern void set_gdbarch_call_dummy_location (struct gdbarch *gdbarch, enum call_dummy_location_type call_dummy_location);
2b7c3f1d
TT
336
337extern bool gdbarch_push_dummy_code_p (struct gdbarch *gdbarch);
338
339typedef 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);
340extern 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);
341extern void set_gdbarch_push_dummy_code (struct gdbarch *gdbarch, gdbarch_push_dummy_code_ftype *push_dummy_code);
342
343/* Return true if the code of FRAME is writable. */
344
bd2b40ac
TT
345typedef int (gdbarch_code_of_frame_writable_ftype) (struct gdbarch *gdbarch, frame_info_ptr frame);
346extern int gdbarch_code_of_frame_writable (struct gdbarch *gdbarch, frame_info_ptr frame);
2b7c3f1d
TT
347extern void set_gdbarch_code_of_frame_writable (struct gdbarch *gdbarch, gdbarch_code_of_frame_writable_ftype *code_of_frame_writable);
348
bd2b40ac
TT
349typedef void (gdbarch_print_registers_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, frame_info_ptr frame, int regnum, int all);
350extern void gdbarch_print_registers_info (struct gdbarch *gdbarch, struct ui_file *file, frame_info_ptr frame, int regnum, int all);
2b7c3f1d
TT
351extern void set_gdbarch_print_registers_info (struct gdbarch *gdbarch, gdbarch_print_registers_info_ftype *print_registers_info);
352
bd2b40ac
TT
353typedef void (gdbarch_print_float_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, frame_info_ptr frame, const char *args);
354extern void gdbarch_print_float_info (struct gdbarch *gdbarch, struct ui_file *file, frame_info_ptr frame, const char *args);
2b7c3f1d
TT
355extern void set_gdbarch_print_float_info (struct gdbarch *gdbarch, gdbarch_print_float_info_ftype *print_float_info);
356
357extern bool gdbarch_print_vector_info_p (struct gdbarch *gdbarch);
358
bd2b40ac
TT
359typedef void (gdbarch_print_vector_info_ftype) (struct gdbarch *gdbarch, struct ui_file *file, frame_info_ptr frame, const char *args);
360extern void gdbarch_print_vector_info (struct gdbarch *gdbarch, struct ui_file *file, frame_info_ptr frame, const char *args);
2b7c3f1d
TT
361extern void set_gdbarch_print_vector_info (struct gdbarch *gdbarch, gdbarch_print_vector_info_ftype *print_vector_info);
362
363/* MAP a GDB RAW register number onto a simulator register number. See
364 also include/...-sim.h. */
365
366typedef int (gdbarch_register_sim_regno_ftype) (struct gdbarch *gdbarch, int reg_nr);
367extern int gdbarch_register_sim_regno (struct gdbarch *gdbarch, int reg_nr);
368extern void set_gdbarch_register_sim_regno (struct gdbarch *gdbarch, gdbarch_register_sim_regno_ftype *register_sim_regno);
369
370typedef int (gdbarch_cannot_fetch_register_ftype) (struct gdbarch *gdbarch, int regnum);
371extern int gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, int regnum);
372extern void set_gdbarch_cannot_fetch_register (struct gdbarch *gdbarch, gdbarch_cannot_fetch_register_ftype *cannot_fetch_register);
373
374typedef int (gdbarch_cannot_store_register_ftype) (struct gdbarch *gdbarch, int regnum);
375extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
376extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
377
378/* Determine the address where a longjmp will land and save this address
379 in PC. Return nonzero on success.
fb14eb08 380
2b7c3f1d
TT
381 FRAME corresponds to the longjmp frame. */
382
383extern bool gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
384
bd2b40ac
TT
385typedef int (gdbarch_get_longjmp_target_ftype) (frame_info_ptr frame, CORE_ADDR *pc);
386extern int gdbarch_get_longjmp_target (struct gdbarch *gdbarch, frame_info_ptr frame, CORE_ADDR *pc);
2b7c3f1d
TT
387extern void set_gdbarch_get_longjmp_target (struct gdbarch *gdbarch, gdbarch_get_longjmp_target_ftype *get_longjmp_target);
388
389extern int gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch);
390extern void set_gdbarch_believe_pcc_promotion (struct gdbarch *gdbarch, int believe_pcc_promotion);
391
392typedef int (gdbarch_convert_register_p_ftype) (struct gdbarch *gdbarch, int regnum, struct type *type);
393extern int gdbarch_convert_register_p (struct gdbarch *gdbarch, int regnum, struct type *type);
394extern void set_gdbarch_convert_register_p (struct gdbarch *gdbarch, gdbarch_convert_register_p_ftype *convert_register_p);
395
bd2b40ac
TT
396typedef int (gdbarch_register_to_value_ftype) (frame_info_ptr frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
397extern int gdbarch_register_to_value (struct gdbarch *gdbarch, frame_info_ptr frame, int regnum, struct type *type, gdb_byte *buf, int *optimizedp, int *unavailablep);
2b7c3f1d
TT
398extern void set_gdbarch_register_to_value (struct gdbarch *gdbarch, gdbarch_register_to_value_ftype *register_to_value);
399
bd2b40ac
TT
400typedef void (gdbarch_value_to_register_ftype) (frame_info_ptr frame, int regnum, struct type *type, const gdb_byte *buf);
401extern void gdbarch_value_to_register (struct gdbarch *gdbarch, frame_info_ptr frame, int regnum, struct type *type, const gdb_byte *buf);
2b7c3f1d
TT
402extern void set_gdbarch_value_to_register (struct gdbarch *gdbarch, gdbarch_value_to_register_ftype *value_to_register);
403
404/* Construct a value representing the contents of register REGNUM in
405 frame FRAME_ID, interpreted as type TYPE. The routine needs to
406 allocate and return a struct value with all value attributes
407 (but not the value contents) filled in. */
408
409typedef struct value * (gdbarch_value_from_register_ftype) (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
410extern struct value * gdbarch_value_from_register (struct gdbarch *gdbarch, struct type *type, int regnum, struct frame_id frame_id);
411extern void set_gdbarch_value_from_register (struct gdbarch *gdbarch, gdbarch_value_from_register_ftype *value_from_register);
412
413typedef CORE_ADDR (gdbarch_pointer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
414extern CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
415extern void set_gdbarch_pointer_to_address (struct gdbarch *gdbarch, gdbarch_pointer_to_address_ftype *pointer_to_address);
416
417typedef void (gdbarch_address_to_pointer_ftype) (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
418extern void gdbarch_address_to_pointer (struct gdbarch *gdbarch, struct type *type, gdb_byte *buf, CORE_ADDR addr);
419extern void set_gdbarch_address_to_pointer (struct gdbarch *gdbarch, gdbarch_address_to_pointer_ftype *address_to_pointer);
420
421extern bool gdbarch_integer_to_address_p (struct gdbarch *gdbarch);
422
423typedef CORE_ADDR (gdbarch_integer_to_address_ftype) (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
424extern CORE_ADDR gdbarch_integer_to_address (struct gdbarch *gdbarch, struct type *type, const gdb_byte *buf);
425extern void set_gdbarch_integer_to_address (struct gdbarch *gdbarch, gdbarch_integer_to_address_ftype *integer_to_address);
426
427/* Return the return-value convention that will be used by FUNCTION
428 to return a value of type VALTYPE. FUNCTION may be NULL in which
429 case the return convention is computed based only on VALTYPE.
fb14eb08 430
2b7c3f1d 431 If READBUF is not NULL, extract the return value and save it in this buffer.
fb14eb08 432
2b7c3f1d
TT
433 If WRITEBUF is not NULL, it contains a return value which will be
434 stored into the appropriate register. This can be used when we want
435 to force the value returned by a function (see the "return" command
436 for instance). */
437
438extern bool gdbarch_return_value_p (struct gdbarch *gdbarch);
439
440typedef 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);
441extern 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);
442extern void set_gdbarch_return_value (struct gdbarch *gdbarch, gdbarch_return_value_ftype *return_value);
443
444/* Return true if the return value of function is stored in the first hidden
445 parameter. In theory, this feature should be language-dependent, specified
446 by language and its ABI, such as C++. Unfortunately, compiler may
447 implement it to a target-dependent feature. So that we need such hook here
448 to be aware of this in GDB. */
449
450typedef int (gdbarch_return_in_first_hidden_param_p_ftype) (struct gdbarch *gdbarch, struct type *type);
451extern int gdbarch_return_in_first_hidden_param_p (struct gdbarch *gdbarch, struct type *type);
452extern 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);
453
454typedef CORE_ADDR (gdbarch_skip_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
455extern CORE_ADDR gdbarch_skip_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
456extern void set_gdbarch_skip_prologue (struct gdbarch *gdbarch, gdbarch_skip_prologue_ftype *skip_prologue);
457
458extern bool gdbarch_skip_main_prologue_p (struct gdbarch *gdbarch);
459
460typedef CORE_ADDR (gdbarch_skip_main_prologue_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
461extern CORE_ADDR gdbarch_skip_main_prologue (struct gdbarch *gdbarch, CORE_ADDR ip);
462extern void set_gdbarch_skip_main_prologue (struct gdbarch *gdbarch, gdbarch_skip_main_prologue_ftype *skip_main_prologue);
463
464/* On some platforms, a single function may provide multiple entry points,
465 e.g. one that is used for function-pointer calls and a different one
466 that is used for direct function calls.
467 In order to ensure that breakpoints set on the function will trigger
468 no matter via which entry point the function is entered, a platform
469 may provide the skip_entrypoint callback. It is called with IP set
470 to the main entry point of a function (as determined by the symbol table),
471 and should return the address of the innermost entry point, where the
472 actual breakpoint needs to be set. Note that skip_entrypoint is used
473 by GDB common code even when debugging optimized code, where skip_prologue
474 is not used. */
475
476extern bool gdbarch_skip_entrypoint_p (struct gdbarch *gdbarch);
477
478typedef CORE_ADDR (gdbarch_skip_entrypoint_ftype) (struct gdbarch *gdbarch, CORE_ADDR ip);
479extern CORE_ADDR gdbarch_skip_entrypoint (struct gdbarch *gdbarch, CORE_ADDR ip);
480extern void set_gdbarch_skip_entrypoint (struct gdbarch *gdbarch, gdbarch_skip_entrypoint_ftype *skip_entrypoint);
481
482typedef int (gdbarch_inner_than_ftype) (CORE_ADDR lhs, CORE_ADDR rhs);
483extern int gdbarch_inner_than (struct gdbarch *gdbarch, CORE_ADDR lhs, CORE_ADDR rhs);
484extern void set_gdbarch_inner_than (struct gdbarch *gdbarch, gdbarch_inner_than_ftype *inner_than);
485
486typedef const gdb_byte * (gdbarch_breakpoint_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
487extern const gdb_byte * gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr, int *lenptr);
488extern void set_gdbarch_breakpoint_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_from_pc_ftype *breakpoint_from_pc);
489
490/* Return the breakpoint kind for this target based on *PCPTR. */
491
492typedef int (gdbarch_breakpoint_kind_from_pc_ftype) (struct gdbarch *gdbarch, CORE_ADDR *pcptr);
493extern int gdbarch_breakpoint_kind_from_pc (struct gdbarch *gdbarch, CORE_ADDR *pcptr);
494extern void set_gdbarch_breakpoint_kind_from_pc (struct gdbarch *gdbarch, gdbarch_breakpoint_kind_from_pc_ftype *breakpoint_kind_from_pc);
495
496/* Return the software breakpoint from KIND. KIND can have target
497 specific meaning like the Z0 kind parameter.
498 SIZE is set to the software breakpoint's length in memory. */
499
500typedef const gdb_byte * (gdbarch_sw_breakpoint_from_kind_ftype) (struct gdbarch *gdbarch, int kind, int *size);
501extern const gdb_byte * gdbarch_sw_breakpoint_from_kind (struct gdbarch *gdbarch, int kind, int *size);
502extern void set_gdbarch_sw_breakpoint_from_kind (struct gdbarch *gdbarch, gdbarch_sw_breakpoint_from_kind_ftype *sw_breakpoint_from_kind);
503
504/* Return the breakpoint kind for this target based on the current
505 processor state (e.g. the current instruction mode on ARM) and the
506 *PCPTR. In default, it is gdbarch->breakpoint_kind_from_pc. */
507
508typedef int (gdbarch_breakpoint_kind_from_current_state_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR *pcptr);
509extern int gdbarch_breakpoint_kind_from_current_state (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR *pcptr);
510extern void set_gdbarch_breakpoint_kind_from_current_state (struct gdbarch *gdbarch, gdbarch_breakpoint_kind_from_current_state_ftype *breakpoint_kind_from_current_state);
511
512extern bool gdbarch_adjust_breakpoint_address_p (struct gdbarch *gdbarch);
513
514typedef CORE_ADDR (gdbarch_adjust_breakpoint_address_ftype) (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
515extern CORE_ADDR gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, CORE_ADDR bpaddr);
516extern void set_gdbarch_adjust_breakpoint_address (struct gdbarch *gdbarch, gdbarch_adjust_breakpoint_address_ftype *adjust_breakpoint_address);
517
518typedef int (gdbarch_memory_insert_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
519extern int gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
520extern void set_gdbarch_memory_insert_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_insert_breakpoint_ftype *memory_insert_breakpoint);
521
522typedef int (gdbarch_memory_remove_breakpoint_ftype) (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
523extern int gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, struct bp_target_info *bp_tgt);
524extern void set_gdbarch_memory_remove_breakpoint (struct gdbarch *gdbarch, gdbarch_memory_remove_breakpoint_ftype *memory_remove_breakpoint);
525
526extern CORE_ADDR gdbarch_decr_pc_after_break (struct gdbarch *gdbarch);
527extern void set_gdbarch_decr_pc_after_break (struct gdbarch *gdbarch, CORE_ADDR decr_pc_after_break);
528
529/* A function can be addressed by either it's "pointer" (possibly a
530 descriptor address) or "entry point" (first executable instruction).
531 The method "convert_from_func_ptr_addr" converting the former to the
532 latter. gdbarch_deprecated_function_start_offset is being used to implement
533 a simplified subset of that functionality - the function's address
534 corresponds to the "function pointer" and the function's start
535 corresponds to the "function entry point" - and hence is redundant. */
536
537extern CORE_ADDR gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch);
538extern void set_gdbarch_deprecated_function_start_offset (struct gdbarch *gdbarch, CORE_ADDR deprecated_function_start_offset);
539
540/* Return the remote protocol register number associated with this
541 register. Normally the identity mapping. */
542
543typedef int (gdbarch_remote_register_number_ftype) (struct gdbarch *gdbarch, int regno);
544extern int gdbarch_remote_register_number (struct gdbarch *gdbarch, int regno);
545extern void set_gdbarch_remote_register_number (struct gdbarch *gdbarch, gdbarch_remote_register_number_ftype *remote_register_number);
546
547/* Fetch the target specific address used to represent a load module. */
548
549extern bool gdbarch_fetch_tls_load_module_address_p (struct gdbarch *gdbarch);
550
551typedef CORE_ADDR (gdbarch_fetch_tls_load_module_address_ftype) (struct objfile *objfile);
552extern CORE_ADDR gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, struct objfile *objfile);
553extern void set_gdbarch_fetch_tls_load_module_address (struct gdbarch *gdbarch, gdbarch_fetch_tls_load_module_address_ftype *fetch_tls_load_module_address);
554
555/* Return the thread-local address at OFFSET in the thread-local
556 storage for the thread PTID and the shared library or executable
557 file given by LM_ADDR. If that block of thread-local storage hasn't
558 been allocated yet, this function may throw an error. LM_ADDR may
559 be zero for statically linked multithreaded inferiors. */
560
561extern bool gdbarch_get_thread_local_address_p (struct gdbarch *gdbarch);
562
563typedef CORE_ADDR (gdbarch_get_thread_local_address_ftype) (struct gdbarch *gdbarch, ptid_t ptid, CORE_ADDR lm_addr, CORE_ADDR offset);
564extern CORE_ADDR gdbarch_get_thread_local_address (struct gdbarch *gdbarch, ptid_t ptid, CORE_ADDR lm_addr, CORE_ADDR offset);
565extern void set_gdbarch_get_thread_local_address (struct gdbarch *gdbarch, gdbarch_get_thread_local_address_ftype *get_thread_local_address);
566
567extern CORE_ADDR gdbarch_frame_args_skip (struct gdbarch *gdbarch);
568extern void set_gdbarch_frame_args_skip (struct gdbarch *gdbarch, CORE_ADDR frame_args_skip);
569
bd2b40ac
TT
570typedef CORE_ADDR (gdbarch_unwind_pc_ftype) (struct gdbarch *gdbarch, frame_info_ptr next_frame);
571extern CORE_ADDR gdbarch_unwind_pc (struct gdbarch *gdbarch, frame_info_ptr next_frame);
2b7c3f1d
TT
572extern void set_gdbarch_unwind_pc (struct gdbarch *gdbarch, gdbarch_unwind_pc_ftype *unwind_pc);
573
bd2b40ac
TT
574typedef CORE_ADDR (gdbarch_unwind_sp_ftype) (struct gdbarch *gdbarch, frame_info_ptr next_frame);
575extern CORE_ADDR gdbarch_unwind_sp (struct gdbarch *gdbarch, frame_info_ptr next_frame);
2b7c3f1d
TT
576extern void set_gdbarch_unwind_sp (struct gdbarch *gdbarch, gdbarch_unwind_sp_ftype *unwind_sp);
577
578/* DEPRECATED_FRAME_LOCALS_ADDRESS as been replaced by the per-frame
579 frame-base. Enable frame-base before frame-unwind. */
580
581extern bool gdbarch_frame_num_args_p (struct gdbarch *gdbarch);
582
bd2b40ac
TT
583typedef int (gdbarch_frame_num_args_ftype) (frame_info_ptr frame);
584extern int gdbarch_frame_num_args (struct gdbarch *gdbarch, frame_info_ptr frame);
2b7c3f1d
TT
585extern void set_gdbarch_frame_num_args (struct gdbarch *gdbarch, gdbarch_frame_num_args_ftype *frame_num_args);
586
587extern bool gdbarch_frame_align_p (struct gdbarch *gdbarch);
588
589typedef CORE_ADDR (gdbarch_frame_align_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
590extern CORE_ADDR gdbarch_frame_align (struct gdbarch *gdbarch, CORE_ADDR address);
591extern void set_gdbarch_frame_align (struct gdbarch *gdbarch, gdbarch_frame_align_ftype *frame_align);
592
593typedef int (gdbarch_stabs_argument_has_addr_ftype) (struct gdbarch *gdbarch, struct type *type);
594extern int gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, struct type *type);
595extern void set_gdbarch_stabs_argument_has_addr (struct gdbarch *gdbarch, gdbarch_stabs_argument_has_addr_ftype *stabs_argument_has_addr);
596
597extern int gdbarch_frame_red_zone_size (struct gdbarch *gdbarch);
598extern void set_gdbarch_frame_red_zone_size (struct gdbarch *gdbarch, int frame_red_zone_size);
599
600typedef CORE_ADDR (gdbarch_convert_from_func_ptr_addr_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
601extern CORE_ADDR gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, CORE_ADDR addr, struct target_ops *targ);
602extern void set_gdbarch_convert_from_func_ptr_addr (struct gdbarch *gdbarch, gdbarch_convert_from_func_ptr_addr_ftype *convert_from_func_ptr_addr);
603
604/* On some machines there are bits in addresses which are not really
605 part of the address, but are used by the kernel, the hardware, etc.
606 for special purposes. gdbarch_addr_bits_remove takes out any such bits so
607 we get a "real" address such as one would find in a symbol table.
608 This is used only for addresses of instructions, and even then I'm
609 not sure it's used in all contexts. It exists to deal with there
610 being a few stray bits in the PC which would mislead us, not as some
611 sort of generic thing to handle alignment or segmentation (it's
612 possible it should be in TARGET_READ_PC instead). */
613
614typedef CORE_ADDR (gdbarch_addr_bits_remove_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
615extern CORE_ADDR gdbarch_addr_bits_remove (struct gdbarch *gdbarch, CORE_ADDR addr);
616extern void set_gdbarch_addr_bits_remove (struct gdbarch *gdbarch, gdbarch_addr_bits_remove_ftype *addr_bits_remove);
617
618/* On some machines, not all bits of an address word are significant.
619 For example, on AArch64, the top bits of an address known as the "tag"
620 are ignored by the kernel, the hardware, etc. and can be regarded as
621 additional data associated with the address. */
622
623extern int gdbarch_significant_addr_bit (struct gdbarch *gdbarch);
624extern void set_gdbarch_significant_addr_bit (struct gdbarch *gdbarch, int significant_addr_bit);
625
626/* Return a string representation of the memory tag TAG. */
627
628typedef std::string (gdbarch_memtag_to_string_ftype) (struct gdbarch *gdbarch, struct value *tag);
629extern std::string gdbarch_memtag_to_string (struct gdbarch *gdbarch, struct value *tag);
630extern void set_gdbarch_memtag_to_string (struct gdbarch *gdbarch, gdbarch_memtag_to_string_ftype *memtag_to_string);
631
632/* Return true if ADDRESS contains a tag and false otherwise. ADDRESS
633 must be either a pointer or a reference type. */
634
635typedef bool (gdbarch_tagged_address_p_ftype) (struct gdbarch *gdbarch, struct value *address);
636extern bool gdbarch_tagged_address_p (struct gdbarch *gdbarch, struct value *address);
637extern void set_gdbarch_tagged_address_p (struct gdbarch *gdbarch, gdbarch_tagged_address_p_ftype *tagged_address_p);
638
639/* Return true if the tag from ADDRESS matches the memory tag for that
640 particular address. Return false otherwise. */
641
642typedef bool (gdbarch_memtag_matches_p_ftype) (struct gdbarch *gdbarch, struct value *address);
643extern bool gdbarch_memtag_matches_p (struct gdbarch *gdbarch, struct value *address);
644extern void set_gdbarch_memtag_matches_p (struct gdbarch *gdbarch, gdbarch_memtag_matches_p_ftype *memtag_matches_p);
645
646/* Set the tags of type TAG_TYPE, for the memory address range
647 [ADDRESS, ADDRESS + LENGTH) to TAGS.
648 Return true if successful and false otherwise. */
649
650typedef bool (gdbarch_set_memtags_ftype) (struct gdbarch *gdbarch, struct value *address, size_t length, const gdb::byte_vector &tags, memtag_type tag_type);
651extern bool gdbarch_set_memtags (struct gdbarch *gdbarch, struct value *address, size_t length, const gdb::byte_vector &tags, memtag_type tag_type);
652extern void set_gdbarch_set_memtags (struct gdbarch *gdbarch, gdbarch_set_memtags_ftype *set_memtags);
653
654/* Return the tag of type TAG_TYPE associated with the memory address ADDRESS,
655 assuming ADDRESS is tagged. */
656
657typedef struct value * (gdbarch_get_memtag_ftype) (struct gdbarch *gdbarch, struct value *address, memtag_type tag_type);
658extern struct value * gdbarch_get_memtag (struct gdbarch *gdbarch, struct value *address, memtag_type tag_type);
659extern void set_gdbarch_get_memtag (struct gdbarch *gdbarch, gdbarch_get_memtag_ftype *get_memtag);
660
661/* memtag_granule_size is the size of the allocation tag granule, for
662 architectures that support memory tagging.
663 This is 0 for architectures that do not support memory tagging.
664 For a non-zero value, this represents the number of bytes of memory per tag. */
665
666extern CORE_ADDR gdbarch_memtag_granule_size (struct gdbarch *gdbarch);
667extern void set_gdbarch_memtag_granule_size (struct gdbarch *gdbarch, CORE_ADDR memtag_granule_size);
668
669/* FIXME/cagney/2001-01-18: This should be split in two. A target method that
670 indicates if the target needs software single step. An ISA method to
671 implement it.
fb14eb08 672
2b7c3f1d
TT
673 FIXME/cagney/2001-01-18: The logic is backwards. It should be asking if the
674 target can single step. If not, then implement single step using breakpoints.
fb14eb08 675
2b7c3f1d
TT
676 Return a vector of addresses on which the software single step
677 breakpoints should be inserted. NULL means software single step is
678 not used.
679 Multiple breakpoints may be inserted for some instructions such as
680 conditional branch. However, each implementation must always evaluate
681 the condition and only put the breakpoint at the branch destination if
682 the condition is true, so that we ensure forward progress when stepping
683 past a conditional branch to self. */
684
685extern bool gdbarch_software_single_step_p (struct gdbarch *gdbarch);
686
687typedef std::vector<CORE_ADDR> (gdbarch_software_single_step_ftype) (struct regcache *regcache);
688extern std::vector<CORE_ADDR> gdbarch_software_single_step (struct gdbarch *gdbarch, struct regcache *regcache);
689extern void set_gdbarch_software_single_step (struct gdbarch *gdbarch, gdbarch_software_single_step_ftype *software_single_step);
690
691/* Return non-zero if the processor is executing a delay slot and a
692 further single-step is needed before the instruction finishes. */
693
694extern bool gdbarch_single_step_through_delay_p (struct gdbarch *gdbarch);
695
bd2b40ac
TT
696typedef int (gdbarch_single_step_through_delay_ftype) (struct gdbarch *gdbarch, frame_info_ptr frame);
697extern int gdbarch_single_step_through_delay (struct gdbarch *gdbarch, frame_info_ptr frame);
2b7c3f1d
TT
698extern void set_gdbarch_single_step_through_delay (struct gdbarch *gdbarch, gdbarch_single_step_through_delay_ftype *single_step_through_delay);
699
700/* FIXME: cagney/2003-08-28: Need to find a better way of selecting the
701 disassembler. Perhaps objdump can handle it? */
702
703typedef int (gdbarch_print_insn_ftype) (bfd_vma vma, struct disassemble_info *info);
704extern int gdbarch_print_insn (struct gdbarch *gdbarch, bfd_vma vma, struct disassemble_info *info);
705extern void set_gdbarch_print_insn (struct gdbarch *gdbarch, gdbarch_print_insn_ftype *print_insn);
706
bd2b40ac
TT
707typedef CORE_ADDR (gdbarch_skip_trampoline_code_ftype) (frame_info_ptr frame, CORE_ADDR pc);
708extern CORE_ADDR gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, frame_info_ptr frame, CORE_ADDR pc);
2b7c3f1d
TT
709extern void set_gdbarch_skip_trampoline_code (struct gdbarch *gdbarch, gdbarch_skip_trampoline_code_ftype *skip_trampoline_code);
710
9e468e95
TT
711/* Vtable of solib operations functions. */
712
713extern const struct target_so_ops * gdbarch_so_ops (struct gdbarch *gdbarch);
714extern void set_gdbarch_so_ops (struct gdbarch *gdbarch, const struct target_so_ops * so_ops);
715
2b7c3f1d
TT
716/* If in_solib_dynsym_resolve_code() returns true, and SKIP_SOLIB_RESOLVER
717 evaluates non-zero, this is the address where the debugger will place
718 a step-resume breakpoint to get us past the dynamic linker. */
719
720typedef CORE_ADDR (gdbarch_skip_solib_resolver_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
721extern CORE_ADDR gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, CORE_ADDR pc);
722extern void set_gdbarch_skip_solib_resolver (struct gdbarch *gdbarch, gdbarch_skip_solib_resolver_ftype *skip_solib_resolver);
723
724/* Some systems also have trampoline code for returning from shared libs. */
725
726typedef int (gdbarch_in_solib_return_trampoline_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
727extern int gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, CORE_ADDR pc, const char *name);
728extern void set_gdbarch_in_solib_return_trampoline (struct gdbarch *gdbarch, gdbarch_in_solib_return_trampoline_ftype *in_solib_return_trampoline);
729
730/* Return true if PC lies inside an indirect branch thunk. */
731
732typedef bool (gdbarch_in_indirect_branch_thunk_ftype) (struct gdbarch *gdbarch, CORE_ADDR pc);
733extern bool gdbarch_in_indirect_branch_thunk (struct gdbarch *gdbarch, CORE_ADDR pc);
734extern void set_gdbarch_in_indirect_branch_thunk (struct gdbarch *gdbarch, gdbarch_in_indirect_branch_thunk_ftype *in_indirect_branch_thunk);
735
736/* A target might have problems with watchpoints as soon as the stack
737 frame of the current function has been destroyed. This mostly happens
738 as the first action in a function's epilogue. stack_frame_destroyed_p()
739 is defined to return a non-zero value if either the given addr is one
740 instruction after the stack destroying instruction up to the trailing
741 return instruction or if we can figure out that the stack frame has
742 already been invalidated regardless of the value of addr. Targets
743 which don't suffer from that problem could just let this functionality
744 untouched. */
745
746typedef int (gdbarch_stack_frame_destroyed_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
747extern int gdbarch_stack_frame_destroyed_p (struct gdbarch *gdbarch, CORE_ADDR addr);
748extern void set_gdbarch_stack_frame_destroyed_p (struct gdbarch *gdbarch, gdbarch_stack_frame_destroyed_p_ftype *stack_frame_destroyed_p);
749
750/* Process an ELF symbol in the minimal symbol table in a backend-specific
751 way. Normally this hook is supposed to do nothing, however if required,
752 then this hook can be used to apply tranformations to symbols that are
753 considered special in some way. For example the MIPS backend uses it
754 to interpret `st_other' information to mark compressed code symbols so
755 that they can be treated in the appropriate manner in the processing of
756 the main symbol table and DWARF-2 records. */
757
758extern bool gdbarch_elf_make_msymbol_special_p (struct gdbarch *gdbarch);
759
760typedef void (gdbarch_elf_make_msymbol_special_ftype) (asymbol *sym, struct minimal_symbol *msym);
761extern void gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, asymbol *sym, struct minimal_symbol *msym);
762extern void set_gdbarch_elf_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_elf_make_msymbol_special_ftype *elf_make_msymbol_special);
763
764typedef void (gdbarch_coff_make_msymbol_special_ftype) (int val, struct minimal_symbol *msym);
765extern void gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, int val, struct minimal_symbol *msym);
766extern void set_gdbarch_coff_make_msymbol_special (struct gdbarch *gdbarch, gdbarch_coff_make_msymbol_special_ftype *coff_make_msymbol_special);
767
768/* Process a symbol in the main symbol table in a backend-specific way.
769 Normally this hook is supposed to do nothing, however if required,
770 then this hook can be used to apply tranformations to symbols that
771 are considered special in some way. This is currently used by the
772 MIPS backend to make sure compressed code symbols have the ISA bit
773 set. This in turn is needed for symbol values seen in GDB to match
774 the values used at the runtime by the program itself, for function
775 and label references. */
776
777typedef void (gdbarch_make_symbol_special_ftype) (struct symbol *sym, struct objfile *objfile);
778extern void gdbarch_make_symbol_special (struct gdbarch *gdbarch, struct symbol *sym, struct objfile *objfile);
779extern void set_gdbarch_make_symbol_special (struct gdbarch *gdbarch, gdbarch_make_symbol_special_ftype *make_symbol_special);
780
781/* Adjust the address retrieved from a DWARF-2 record other than a line
782 entry in a backend-specific way. Normally this hook is supposed to
783 return the address passed unchanged, however if that is incorrect for
784 any reason, then this hook can be used to fix the address up in the
785 required manner. This is currently used by the MIPS backend to make
786 sure addresses in FDE, range records, etc. referring to compressed
787 code have the ISA bit set, matching line information and the symbol
788 table. */
789
790typedef CORE_ADDR (gdbarch_adjust_dwarf2_addr_ftype) (CORE_ADDR pc);
791extern CORE_ADDR gdbarch_adjust_dwarf2_addr (struct gdbarch *gdbarch, CORE_ADDR pc);
792extern void set_gdbarch_adjust_dwarf2_addr (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_addr_ftype *adjust_dwarf2_addr);
793
794/* Adjust the address updated by a line entry in a backend-specific way.
795 Normally this hook is supposed to return the address passed unchanged,
796 however in the case of inconsistencies in these records, this hook can
797 be used to fix them up in the required manner. This is currently used
798 by the MIPS backend to make sure all line addresses in compressed code
799 are presented with the ISA bit set, which is not always the case. This
800 in turn ensures breakpoint addresses are correctly matched against the
801 stop PC. */
802
803typedef CORE_ADDR (gdbarch_adjust_dwarf2_line_ftype) (CORE_ADDR addr, int rel);
804extern CORE_ADDR gdbarch_adjust_dwarf2_line (struct gdbarch *gdbarch, CORE_ADDR addr, int rel);
805extern void set_gdbarch_adjust_dwarf2_line (struct gdbarch *gdbarch, gdbarch_adjust_dwarf2_line_ftype *adjust_dwarf2_line);
806
807extern int gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch);
808extern void set_gdbarch_cannot_step_breakpoint (struct gdbarch *gdbarch, int cannot_step_breakpoint);
809
810/* See comment in target.h about continuable, steppable and
811 non-steppable watchpoints. */
812
813extern int gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch);
814extern void set_gdbarch_have_nonsteppable_watchpoint (struct gdbarch *gdbarch, int have_nonsteppable_watchpoint);
815
816extern bool gdbarch_address_class_type_flags_p (struct gdbarch *gdbarch);
817
818typedef type_instance_flags (gdbarch_address_class_type_flags_ftype) (int byte_size, int dwarf2_addr_class);
819extern type_instance_flags gdbarch_address_class_type_flags (struct gdbarch *gdbarch, int byte_size, int dwarf2_addr_class);
820extern void set_gdbarch_address_class_type_flags (struct gdbarch *gdbarch, gdbarch_address_class_type_flags_ftype *address_class_type_flags);
821
822extern bool gdbarch_address_class_type_flags_to_name_p (struct gdbarch *gdbarch);
823
824typedef const char * (gdbarch_address_class_type_flags_to_name_ftype) (struct gdbarch *gdbarch, type_instance_flags type_flags);
825extern const char * gdbarch_address_class_type_flags_to_name (struct gdbarch *gdbarch, type_instance_flags type_flags);
826extern 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);
827
828/* Execute vendor-specific DWARF Call Frame Instruction. OP is the instruction.
829 FS are passed from the generic execute_cfa_program function. */
830
831typedef bool (gdbarch_execute_dwarf_cfa_vendor_op_ftype) (struct gdbarch *gdbarch, gdb_byte op, struct dwarf2_frame_state *fs);
832extern bool gdbarch_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdb_byte op, struct dwarf2_frame_state *fs);
833extern void set_gdbarch_execute_dwarf_cfa_vendor_op (struct gdbarch *gdbarch, gdbarch_execute_dwarf_cfa_vendor_op_ftype *execute_dwarf_cfa_vendor_op);
834
835/* Return the appropriate type_flags for the supplied address class.
836 This function should return true if the address class was recognized and
837 type_flags was set, false otherwise. */
838
839extern bool gdbarch_address_class_name_to_type_flags_p (struct gdbarch *gdbarch);
840
841typedef bool (gdbarch_address_class_name_to_type_flags_ftype) (struct gdbarch *gdbarch, const char *name, type_instance_flags *type_flags_ptr);
842extern bool gdbarch_address_class_name_to_type_flags (struct gdbarch *gdbarch, const char *name, type_instance_flags *type_flags_ptr);
843extern 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);
844
845/* Is a register in a group */
846
dbf5d61b
AB
847typedef int (gdbarch_register_reggroup_p_ftype) (struct gdbarch *gdbarch, int regnum, const struct reggroup *reggroup);
848extern int gdbarch_register_reggroup_p (struct gdbarch *gdbarch, int regnum, const struct reggroup *reggroup);
2b7c3f1d
TT
849extern void set_gdbarch_register_reggroup_p (struct gdbarch *gdbarch, gdbarch_register_reggroup_p_ftype *register_reggroup_p);
850
851/* Fetch the pointer to the ith function argument. */
852
853extern bool gdbarch_fetch_pointer_argument_p (struct gdbarch *gdbarch);
854
bd2b40ac
TT
855typedef CORE_ADDR (gdbarch_fetch_pointer_argument_ftype) (frame_info_ptr frame, int argi, struct type *type);
856extern CORE_ADDR gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, frame_info_ptr frame, int argi, struct type *type);
2b7c3f1d
TT
857extern void set_gdbarch_fetch_pointer_argument (struct gdbarch *gdbarch, gdbarch_fetch_pointer_argument_ftype *fetch_pointer_argument);
858
859/* Iterate over all supported register notes in a core file. For each
860 supported register note section, the iterator must call CB and pass
861 CB_DATA unchanged. If REGCACHE is not NULL, the iterator can limit
862 the supported register note sections based on the current register
863 values. Otherwise it should enumerate all supported register note
864 sections. */
865
866extern bool gdbarch_iterate_over_regset_sections_p (struct gdbarch *gdbarch);
867
868typedef void (gdbarch_iterate_over_regset_sections_ftype) (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
869extern void gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache);
870extern void set_gdbarch_iterate_over_regset_sections (struct gdbarch *gdbarch, gdbarch_iterate_over_regset_sections_ftype *iterate_over_regset_sections);
871
872/* Create core file notes */
873
874extern bool gdbarch_make_corefile_notes_p (struct gdbarch *gdbarch);
875
876typedef gdb::unique_xmalloc_ptr<char> (gdbarch_make_corefile_notes_ftype) (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
877extern gdb::unique_xmalloc_ptr<char> gdbarch_make_corefile_notes (struct gdbarch *gdbarch, bfd *obfd, int *note_size);
878extern void set_gdbarch_make_corefile_notes (struct gdbarch *gdbarch, gdbarch_make_corefile_notes_ftype *make_corefile_notes);
879
880/* Find core file memory regions */
881
882extern bool gdbarch_find_memory_regions_p (struct gdbarch *gdbarch);
883
884typedef int (gdbarch_find_memory_regions_ftype) (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
885extern int gdbarch_find_memory_regions (struct gdbarch *gdbarch, find_memory_region_ftype func, void *data);
886extern void set_gdbarch_find_memory_regions (struct gdbarch *gdbarch, gdbarch_find_memory_regions_ftype *find_memory_regions);
887
68cffbbd
LM
888/* Given a bfd OBFD, segment ADDRESS and SIZE, create a memory tag section to be dumped to a core file */
889
890extern bool gdbarch_create_memtag_section_p (struct gdbarch *gdbarch);
891
892typedef asection * (gdbarch_create_memtag_section_ftype) (struct gdbarch *gdbarch, bfd *obfd, CORE_ADDR address, size_t size);
893extern asection * gdbarch_create_memtag_section (struct gdbarch *gdbarch, bfd *obfd, CORE_ADDR address, size_t size);
894extern void set_gdbarch_create_memtag_section (struct gdbarch *gdbarch, gdbarch_create_memtag_section_ftype *create_memtag_section);
895
896/* Given a memory tag section OSEC, fill OSEC's contents with the appropriate tag data */
897
898extern bool gdbarch_fill_memtag_section_p (struct gdbarch *gdbarch);
899
900typedef bool (gdbarch_fill_memtag_section_ftype) (struct gdbarch *gdbarch, asection *osec);
901extern bool gdbarch_fill_memtag_section (struct gdbarch *gdbarch, asection *osec);
902extern void set_gdbarch_fill_memtag_section (struct gdbarch *gdbarch, gdbarch_fill_memtag_section_ftype *fill_memtag_section);
903
904/* Decode a memory tag SECTION and return the tags of type TYPE contained in
905 the memory range [ADDRESS, ADDRESS + LENGTH).
906 If no tags were found, return an empty vector. */
907
908extern bool gdbarch_decode_memtag_section_p (struct gdbarch *gdbarch);
909
910typedef gdb::byte_vector (gdbarch_decode_memtag_section_ftype) (struct gdbarch *gdbarch, bfd_section *section, int type, CORE_ADDR address, size_t length);
911extern gdb::byte_vector gdbarch_decode_memtag_section (struct gdbarch *gdbarch, bfd_section *section, int type, CORE_ADDR address, size_t length);
912extern void set_gdbarch_decode_memtag_section (struct gdbarch *gdbarch, gdbarch_decode_memtag_section_ftype *decode_memtag_section);
913
2b7c3f1d
TT
914/* Read offset OFFSET of TARGET_OBJECT_LIBRARIES formatted shared libraries list from
915 core file into buffer READBUF with length LEN. Return the number of bytes read
916 (zero indicates failure).
917 failed, otherwise, return the red length of READBUF. */
918
919extern bool gdbarch_core_xfer_shared_libraries_p (struct gdbarch *gdbarch);
920
921typedef ULONGEST (gdbarch_core_xfer_shared_libraries_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
922extern ULONGEST gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
923extern void set_gdbarch_core_xfer_shared_libraries (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_ftype *core_xfer_shared_libraries);
924
925/* Read offset OFFSET of TARGET_OBJECT_LIBRARIES_AIX formatted shared
926 libraries list from core file into buffer READBUF with length LEN.
927 Return the number of bytes read (zero indicates failure). */
928
929extern bool gdbarch_core_xfer_shared_libraries_aix_p (struct gdbarch *gdbarch);
930
931typedef ULONGEST (gdbarch_core_xfer_shared_libraries_aix_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
932extern ULONGEST gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
933extern void set_gdbarch_core_xfer_shared_libraries_aix (struct gdbarch *gdbarch, gdbarch_core_xfer_shared_libraries_aix_ftype *core_xfer_shared_libraries_aix);
934
935/* How the core target converts a PTID from a core file to a string. */
936
937extern bool gdbarch_core_pid_to_str_p (struct gdbarch *gdbarch);
938
939typedef std::string (gdbarch_core_pid_to_str_ftype) (struct gdbarch *gdbarch, ptid_t ptid);
940extern std::string gdbarch_core_pid_to_str (struct gdbarch *gdbarch, ptid_t ptid);
941extern void set_gdbarch_core_pid_to_str (struct gdbarch *gdbarch, gdbarch_core_pid_to_str_ftype *core_pid_to_str);
942
943/* How the core target extracts the name of a thread from a core file. */
944
945extern bool gdbarch_core_thread_name_p (struct gdbarch *gdbarch);
946
947typedef const char * (gdbarch_core_thread_name_ftype) (struct gdbarch *gdbarch, struct thread_info *thr);
948extern const char * gdbarch_core_thread_name (struct gdbarch *gdbarch, struct thread_info *thr);
949extern void set_gdbarch_core_thread_name (struct gdbarch *gdbarch, gdbarch_core_thread_name_ftype *core_thread_name);
950
951/* Read offset OFFSET of TARGET_OBJECT_SIGNAL_INFO signal information
952 from core file into buffer READBUF with length LEN. Return the number
953 of bytes read (zero indicates EOF, a negative value indicates failure). */
954
955extern bool gdbarch_core_xfer_siginfo_p (struct gdbarch *gdbarch);
956
957typedef LONGEST (gdbarch_core_xfer_siginfo_ftype) (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
958extern LONGEST gdbarch_core_xfer_siginfo (struct gdbarch *gdbarch, gdb_byte *readbuf, ULONGEST offset, ULONGEST len);
959extern void set_gdbarch_core_xfer_siginfo (struct gdbarch *gdbarch, gdbarch_core_xfer_siginfo_ftype *core_xfer_siginfo);
960
961/* BFD target to use when generating a core file. */
962
963extern bool gdbarch_gcore_bfd_target_p (struct gdbarch *gdbarch);
964
965extern const char * gdbarch_gcore_bfd_target (struct gdbarch *gdbarch);
966extern void set_gdbarch_gcore_bfd_target (struct gdbarch *gdbarch, const char * gcore_bfd_target);
967
968/* If the elements of C++ vtables are in-place function descriptors rather
969 than normal function pointers (which may point to code or a descriptor),
970 set this to one. */
971
972extern int gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch);
973extern void set_gdbarch_vtable_function_descriptors (struct gdbarch *gdbarch, int vtable_function_descriptors);
974
975/* Set if the least significant bit of the delta is used instead of the least
976 significant bit of the pfn for pointers to virtual member functions. */
977
978extern int gdbarch_vbit_in_delta (struct gdbarch *gdbarch);
979extern void set_gdbarch_vbit_in_delta (struct gdbarch *gdbarch, int vbit_in_delta);
980
981/* Advance PC to next instruction in order to skip a permanent breakpoint. */
982
983typedef void (gdbarch_skip_permanent_breakpoint_ftype) (struct regcache *regcache);
984extern void gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, struct regcache *regcache);
985extern void set_gdbarch_skip_permanent_breakpoint (struct gdbarch *gdbarch, gdbarch_skip_permanent_breakpoint_ftype *skip_permanent_breakpoint);
986
987/* The maximum length of an instruction on this architecture in bytes. */
988
989extern bool gdbarch_max_insn_length_p (struct gdbarch *gdbarch);
990
991extern ULONGEST gdbarch_max_insn_length (struct gdbarch *gdbarch);
992extern void set_gdbarch_max_insn_length (struct gdbarch *gdbarch, ULONGEST max_insn_length);
993
994/* Copy the instruction at FROM to TO, and make any adjustments
995 necessary to single-step it at that address.
fb14eb08 996
2b7c3f1d
TT
997 REGS holds the state the thread's registers will have before
998 executing the copied instruction; the PC in REGS will refer to FROM,
999 not the copy at TO. The caller should update it to point at TO later.
fb14eb08 1000
2b7c3f1d
TT
1001 Return a pointer to data of the architecture's choice to be passed
1002 to gdbarch_displaced_step_fixup.
fb14eb08 1003
2b7c3f1d
TT
1004 For a general explanation of displaced stepping and how GDB uses it,
1005 see the comments in infrun.c.
fb14eb08 1006
2b7c3f1d
TT
1007 The TO area is only guaranteed to have space for
1008 gdbarch_max_insn_length (arch) bytes, so this function must not
1009 write more bytes than that to that area.
fb14eb08 1010
2b7c3f1d
TT
1011 If you do not provide this function, GDB assumes that the
1012 architecture does not support displaced stepping.
fb14eb08 1013
2b7c3f1d
TT
1014 If the instruction cannot execute out of line, return NULL. The
1015 core falls back to stepping past the instruction in-line instead in
1016 that case. */
1017
1018extern bool gdbarch_displaced_step_copy_insn_p (struct gdbarch *gdbarch);
1019
1020typedef displaced_step_copy_insn_closure_up (gdbarch_displaced_step_copy_insn_ftype) (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1021extern displaced_step_copy_insn_closure_up gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1022extern void set_gdbarch_displaced_step_copy_insn (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_ftype *displaced_step_copy_insn);
1023
1024/* Return true if GDB should use hardware single-stepping to execute a displaced
1025 step instruction. If false, GDB will simply restart execution at the
1026 displaced instruction location, and it is up to the target to ensure GDB will
1027 receive control again (e.g. by placing a software breakpoint instruction into
1028 the displaced instruction buffer).
fb14eb08 1029
2b7c3f1d
TT
1030 The default implementation returns false on all targets that provide a
1031 gdbarch_software_single_step routine, and true otherwise. */
1032
1033typedef bool (gdbarch_displaced_step_hw_singlestep_ftype) (struct gdbarch *gdbarch);
1034extern bool gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch);
1035extern void set_gdbarch_displaced_step_hw_singlestep (struct gdbarch *gdbarch, gdbarch_displaced_step_hw_singlestep_ftype *displaced_step_hw_singlestep);
1036
1037/* Fix up the state resulting from successfully single-stepping a
1038 displaced instruction, to give the result we would have gotten from
1039 stepping the instruction in its original location.
fb14eb08 1040
2b7c3f1d
TT
1041 REGS is the register state resulting from single-stepping the
1042 displaced instruction.
fb14eb08 1043
2b7c3f1d
TT
1044 CLOSURE is the result from the matching call to
1045 gdbarch_displaced_step_copy_insn.
fb14eb08 1046
2b7c3f1d
TT
1047 If you provide gdbarch_displaced_step_copy_insn.but not this
1048 function, then GDB assumes that no fixup is needed after
1049 single-stepping the instruction.
fb14eb08 1050
2b7c3f1d
TT
1051 For a general explanation of displaced stepping and how GDB uses it,
1052 see the comments in infrun.c. */
1053
1054extern bool gdbarch_displaced_step_fixup_p (struct gdbarch *gdbarch);
1055
1056typedef void (gdbarch_displaced_step_fixup_ftype) (struct gdbarch *gdbarch, struct displaced_step_copy_insn_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1057extern void gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, struct displaced_step_copy_insn_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs);
1058extern void set_gdbarch_displaced_step_fixup (struct gdbarch *gdbarch, gdbarch_displaced_step_fixup_ftype *displaced_step_fixup);
1059
1060/* Prepare THREAD for it to displaced step the instruction at its current PC.
fb14eb08 1061
2b7c3f1d
TT
1062 Throw an exception if any unexpected error happens. */
1063
1064extern bool gdbarch_displaced_step_prepare_p (struct gdbarch *gdbarch);
1065
1066typedef displaced_step_prepare_status (gdbarch_displaced_step_prepare_ftype) (struct gdbarch *gdbarch, thread_info *thread, CORE_ADDR &displaced_pc);
1067extern displaced_step_prepare_status gdbarch_displaced_step_prepare (struct gdbarch *gdbarch, thread_info *thread, CORE_ADDR &displaced_pc);
1068extern void set_gdbarch_displaced_step_prepare (struct gdbarch *gdbarch, gdbarch_displaced_step_prepare_ftype *displaced_step_prepare);
1069
1070/* Clean up after a displaced step of THREAD. */
1071
1072typedef displaced_step_finish_status (gdbarch_displaced_step_finish_ftype) (struct gdbarch *gdbarch, thread_info *thread, gdb_signal sig);
1073extern displaced_step_finish_status gdbarch_displaced_step_finish (struct gdbarch *gdbarch, thread_info *thread, gdb_signal sig);
1074extern void set_gdbarch_displaced_step_finish (struct gdbarch *gdbarch, gdbarch_displaced_step_finish_ftype *displaced_step_finish);
1075
1076/* Return the closure associated to the displaced step buffer that is at ADDR. */
1077
1078extern bool gdbarch_displaced_step_copy_insn_closure_by_addr_p (struct gdbarch *gdbarch);
1079
1080typedef const displaced_step_copy_insn_closure * (gdbarch_displaced_step_copy_insn_closure_by_addr_ftype) (inferior *inf, CORE_ADDR addr);
1081extern const displaced_step_copy_insn_closure * gdbarch_displaced_step_copy_insn_closure_by_addr (struct gdbarch *gdbarch, inferior *inf, CORE_ADDR addr);
1082extern void set_gdbarch_displaced_step_copy_insn_closure_by_addr (struct gdbarch *gdbarch, gdbarch_displaced_step_copy_insn_closure_by_addr_ftype *displaced_step_copy_insn_closure_by_addr);
1083
1084/* PARENT_INF has forked and CHILD_PTID is the ptid of the child. Restore the
1085 contents of all displaced step buffers in the child's address space. */
1086
1087typedef void (gdbarch_displaced_step_restore_all_in_ptid_ftype) (inferior *parent_inf, ptid_t child_ptid);
1088extern void gdbarch_displaced_step_restore_all_in_ptid (struct gdbarch *gdbarch, inferior *parent_inf, ptid_t child_ptid);
1089extern void set_gdbarch_displaced_step_restore_all_in_ptid (struct gdbarch *gdbarch, gdbarch_displaced_step_restore_all_in_ptid_ftype *displaced_step_restore_all_in_ptid);
1090
1091/* Relocate an instruction to execute at a different address. OLDLOC
1092 is the address in the inferior memory where the instruction to
1093 relocate is currently at. On input, TO points to the destination
1094 where we want the instruction to be copied (and possibly adjusted)
1095 to. On output, it points to one past the end of the resulting
1096 instruction(s). The effect of executing the instruction at TO shall
1097 be the same as if executing it at FROM. For example, call
1098 instructions that implicitly push the return address on the stack
1099 should be adjusted to return to the instruction after OLDLOC;
1100 relative branches, and other PC-relative instructions need the
1101 offset adjusted; etc. */
1102
1103extern bool gdbarch_relocate_instruction_p (struct gdbarch *gdbarch);
1104
1105typedef void (gdbarch_relocate_instruction_ftype) (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
1106extern void gdbarch_relocate_instruction (struct gdbarch *gdbarch, CORE_ADDR *to, CORE_ADDR from);
1107extern void set_gdbarch_relocate_instruction (struct gdbarch *gdbarch, gdbarch_relocate_instruction_ftype *relocate_instruction);
1108
1109/* Refresh overlay mapped state for section OSECT. */
1110
1111extern bool gdbarch_overlay_update_p (struct gdbarch *gdbarch);
1112
1113typedef void (gdbarch_overlay_update_ftype) (struct obj_section *osect);
1114extern void gdbarch_overlay_update (struct gdbarch *gdbarch, struct obj_section *osect);
1115extern void set_gdbarch_overlay_update (struct gdbarch *gdbarch, gdbarch_overlay_update_ftype *overlay_update);
1116
1117extern bool gdbarch_core_read_description_p (struct gdbarch *gdbarch);
1118
1119typedef const struct target_desc * (gdbarch_core_read_description_ftype) (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
1120extern const struct target_desc * gdbarch_core_read_description (struct gdbarch *gdbarch, struct target_ops *target, bfd *abfd);
1121extern void set_gdbarch_core_read_description (struct gdbarch *gdbarch, gdbarch_core_read_description_ftype *core_read_description);
1122
1123/* Set if the address in N_SO or N_FUN stabs may be zero. */
1124
1125extern int gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch);
1126extern void set_gdbarch_sofun_address_maybe_missing (struct gdbarch *gdbarch, int sofun_address_maybe_missing);
1127
1128/* Parse the instruction at ADDR storing in the record execution log
1129 the registers REGCACHE and memory ranges that will be affected when
1130 the instruction executes, along with their current values.
1131 Return -1 if something goes wrong, 0 otherwise. */
1132
1133extern bool gdbarch_process_record_p (struct gdbarch *gdbarch);
1134
1135typedef int (gdbarch_process_record_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1136extern int gdbarch_process_record (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1137extern void set_gdbarch_process_record (struct gdbarch *gdbarch, gdbarch_process_record_ftype *process_record);
1138
1139/* Save process state after a signal.
1140 Return -1 if something goes wrong, 0 otherwise. */
1141
1142extern bool gdbarch_process_record_signal_p (struct gdbarch *gdbarch);
1143
1144typedef int (gdbarch_process_record_signal_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
1145extern int gdbarch_process_record_signal (struct gdbarch *gdbarch, struct regcache *regcache, enum gdb_signal signal);
1146extern void set_gdbarch_process_record_signal (struct gdbarch *gdbarch, gdbarch_process_record_signal_ftype *process_record_signal);
1147
1148/* Signal translation: translate inferior's signal (target's) number
1149 into GDB's representation. The implementation of this method must
1150 be host independent. IOW, don't rely on symbols of the NAT_FILE
1151 header (the nm-*.h files), the host <signal.h> header, or similar
1152 headers. This is mainly used when cross-debugging core files ---
1153 "Live" targets hide the translation behind the target interface
1154 (target_wait, target_resume, etc.). */
1155
1156extern bool gdbarch_gdb_signal_from_target_p (struct gdbarch *gdbarch);
1157
1158typedef enum gdb_signal (gdbarch_gdb_signal_from_target_ftype) (struct gdbarch *gdbarch, int signo);
1159extern enum gdb_signal gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, int signo);
1160extern void set_gdbarch_gdb_signal_from_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_from_target_ftype *gdb_signal_from_target);
1161
1162/* Signal translation: translate the GDB's internal signal number into
1163 the inferior's signal (target's) representation. The implementation
1164 of this method must be host independent. IOW, don't rely on symbols
1165 of the NAT_FILE header (the nm-*.h files), the host <signal.h>
1166 header, or similar headers.
1167 Return the target signal number if found, or -1 if the GDB internal
1168 signal number is invalid. */
1169
1170extern bool gdbarch_gdb_signal_to_target_p (struct gdbarch *gdbarch);
1171
1172typedef int (gdbarch_gdb_signal_to_target_ftype) (struct gdbarch *gdbarch, enum gdb_signal signal);
1173extern int gdbarch_gdb_signal_to_target (struct gdbarch *gdbarch, enum gdb_signal signal);
1174extern void set_gdbarch_gdb_signal_to_target (struct gdbarch *gdbarch, gdbarch_gdb_signal_to_target_ftype *gdb_signal_to_target);
1175
1176/* Extra signal info inspection.
fb14eb08 1177
2b7c3f1d
TT
1178 Return a type suitable to inspect extra signal information. */
1179
1180extern bool gdbarch_get_siginfo_type_p (struct gdbarch *gdbarch);
1181
1182typedef struct type * (gdbarch_get_siginfo_type_ftype) (struct gdbarch *gdbarch);
1183extern struct type * gdbarch_get_siginfo_type (struct gdbarch *gdbarch);
1184extern void set_gdbarch_get_siginfo_type (struct gdbarch *gdbarch, gdbarch_get_siginfo_type_ftype *get_siginfo_type);
1185
1186/* Record architecture-specific information from the symbol table. */
1187
1188extern bool gdbarch_record_special_symbol_p (struct gdbarch *gdbarch);
1189
1190typedef void (gdbarch_record_special_symbol_ftype) (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1191extern void gdbarch_record_special_symbol (struct gdbarch *gdbarch, struct objfile *objfile, asymbol *sym);
1192extern void set_gdbarch_record_special_symbol (struct gdbarch *gdbarch, gdbarch_record_special_symbol_ftype *record_special_symbol);
1193
1194/* Function for the 'catch syscall' feature.
1195 Get architecture-specific system calls information from registers. */
1196
1197extern bool gdbarch_get_syscall_number_p (struct gdbarch *gdbarch);
1198
1199typedef LONGEST (gdbarch_get_syscall_number_ftype) (struct gdbarch *gdbarch, thread_info *thread);
1200extern LONGEST gdbarch_get_syscall_number (struct gdbarch *gdbarch, thread_info *thread);
1201extern void set_gdbarch_get_syscall_number (struct gdbarch *gdbarch, gdbarch_get_syscall_number_ftype *get_syscall_number);
1202
1203/* The filename of the XML syscall for this architecture. */
1204
1205extern const char * gdbarch_xml_syscall_file (struct gdbarch *gdbarch);
1206extern void set_gdbarch_xml_syscall_file (struct gdbarch *gdbarch, const char * xml_syscall_file);
1207
1208/* Information about system calls from this architecture */
1209
1210extern struct syscalls_info * gdbarch_syscalls_info (struct gdbarch *gdbarch);
1211extern void set_gdbarch_syscalls_info (struct gdbarch *gdbarch, struct syscalls_info * syscalls_info);
1212
1213/* SystemTap related fields and functions.
1214 A NULL-terminated array of prefixes used to mark an integer constant
1215 on the architecture's assembly.
1216 For example, on x86 integer constants are written as:
fb14eb08
TT
1217
1218 $10 ;; integer constant 10
1219
2b7c3f1d
TT
1220 in this case, this prefix would be the character `$'. */
1221
1222extern const char *const * gdbarch_stap_integer_prefixes (struct gdbarch *gdbarch);
1223extern void set_gdbarch_stap_integer_prefixes (struct gdbarch *gdbarch, const char *const * stap_integer_prefixes);
1224
1225/* A NULL-terminated array of suffixes used to mark an integer constant
1226 on the architecture's assembly. */
1227
1228extern const char *const * gdbarch_stap_integer_suffixes (struct gdbarch *gdbarch);
1229extern void set_gdbarch_stap_integer_suffixes (struct gdbarch *gdbarch, const char *const * stap_integer_suffixes);
1230
1231/* A NULL-terminated array of prefixes used to mark a register name on
1232 the architecture's assembly.
1233 For example, on x86 the register name is written as:
fb14eb08
TT
1234
1235 %eax ;; register eax
1236
2b7c3f1d
TT
1237 in this case, this prefix would be the character `%'. */
1238
1239extern const char *const * gdbarch_stap_register_prefixes (struct gdbarch *gdbarch);
1240extern void set_gdbarch_stap_register_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_prefixes);
1241
1242/* A NULL-terminated array of suffixes used to mark a register name on
1243 the architecture's assembly. */
1244
1245extern const char *const * gdbarch_stap_register_suffixes (struct gdbarch *gdbarch);
1246extern void set_gdbarch_stap_register_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_suffixes);
1247
1248/* A NULL-terminated array of prefixes used to mark a register
1249 indirection on the architecture's assembly.
1250 For example, on x86 the register indirection is written as:
fb14eb08
TT
1251
1252 (%eax) ;; indirecting eax
1253
2b7c3f1d 1254 in this case, this prefix would be the charater `('.
fb14eb08 1255
2b7c3f1d
TT
1256 Please note that we use the indirection prefix also for register
1257 displacement, e.g., `4(%eax)' on x86. */
1258
1259extern const char *const * gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch);
1260extern void set_gdbarch_stap_register_indirection_prefixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_prefixes);
1261
1262/* A NULL-terminated array of suffixes used to mark a register
1263 indirection on the architecture's assembly.
1264 For example, on x86 the register indirection is written as:
fb14eb08
TT
1265
1266 (%eax) ;; indirecting eax
1267
2b7c3f1d 1268 in this case, this prefix would be the charater `)'.
fb14eb08 1269
2b7c3f1d
TT
1270 Please note that we use the indirection suffix also for register
1271 displacement, e.g., `4(%eax)' on x86. */
1272
1273extern const char *const * gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch);
1274extern void set_gdbarch_stap_register_indirection_suffixes (struct gdbarch *gdbarch, const char *const * stap_register_indirection_suffixes);
1275
1276/* Prefix(es) used to name a register using GDB's nomenclature.
fb14eb08 1277
2b7c3f1d
TT
1278 For example, on PPC a register is represented by a number in the assembly
1279 language (e.g., `10' is the 10th general-purpose register). However,
1280 inside GDB this same register has an `r' appended to its name, so the 10th
1281 register would be represented as `r10' internally. */
1282
1283extern const char * gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch);
1284extern void set_gdbarch_stap_gdb_register_prefix (struct gdbarch *gdbarch, const char * stap_gdb_register_prefix);
1285
1286/* Suffix used to name a register using GDB's nomenclature. */
1287
1288extern const char * gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch);
1289extern void set_gdbarch_stap_gdb_register_suffix (struct gdbarch *gdbarch, const char * stap_gdb_register_suffix);
1290
1291/* Check if S is a single operand.
fb14eb08 1292
2b7c3f1d 1293 Single operands can be:
fb14eb08
TT
1294 - Literal integers, e.g. `$10' on x86
1295 - Register access, e.g. `%eax' on x86
1296 - Register indirection, e.g. `(%eax)' on x86
1297 - Register displacement, e.g. `4(%eax)' on x86
1298
2b7c3f1d
TT
1299 This function should check for these patterns on the string
1300 and return 1 if some were found, or zero otherwise. Please try to match
1301 as much info as you can from the string, i.e., if you have to match
1302 something like `(%', do not match just the `('. */
1303
1304extern bool gdbarch_stap_is_single_operand_p (struct gdbarch *gdbarch);
1305
1306typedef int (gdbarch_stap_is_single_operand_ftype) (struct gdbarch *gdbarch, const char *s);
1307extern int gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, const char *s);
1308extern void set_gdbarch_stap_is_single_operand (struct gdbarch *gdbarch, gdbarch_stap_is_single_operand_ftype *stap_is_single_operand);
1309
1310/* Function used to handle a "special case" in the parser.
fb14eb08 1311
2b7c3f1d
TT
1312 A "special case" is considered to be an unknown token, i.e., a token
1313 that the parser does not know how to parse. A good example of special
1314 case would be ARM's register displacement syntax:
fb14eb08
TT
1315
1316 [R0, #4] ;; displacing R0 by 4
1317
2b7c3f1d 1318 Since the parser assumes that a register displacement is of the form:
fb14eb08
TT
1319
1320 <number> <indirection_prefix> <register_name> <indirection_suffix>
1321
2b7c3f1d
TT
1322 it means that it will not be able to recognize and parse this odd syntax.
1323 Therefore, we should add a special case function that will handle this token.
fb14eb08 1324
2b7c3f1d
TT
1325 This function should generate the proper expression form of the expression
1326 using GDB's internal expression mechanism (e.g., `write_exp_elt_opcode'
1327 and so on). It should also return 1 if the parsing was successful, or zero
1328 if the token was not recognized as a special token (in this case, returning
1329 zero means that the special parser is deferring the parsing to the generic
1330 parser), and should advance the buffer pointer (p->arg). */
1331
1332extern bool gdbarch_stap_parse_special_token_p (struct gdbarch *gdbarch);
1333
1334typedef expr::operation_up (gdbarch_stap_parse_special_token_ftype) (struct gdbarch *gdbarch, struct stap_parse_info *p);
1335extern expr::operation_up gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, struct stap_parse_info *p);
1336extern void set_gdbarch_stap_parse_special_token (struct gdbarch *gdbarch, gdbarch_stap_parse_special_token_ftype *stap_parse_special_token);
1337
1338/* Perform arch-dependent adjustments to a register name.
fb14eb08 1339
2b7c3f1d
TT
1340 In very specific situations, it may be necessary for the register
1341 name present in a SystemTap probe's argument to be handled in a
1342 special way. For example, on i386, GCC may over-optimize the
1343 register allocation and use smaller registers than necessary. In
1344 such cases, the client that is reading and evaluating the SystemTap
1345 probe (ourselves) will need to actually fetch values from the wider
1346 version of the register in question.
fb14eb08 1347
2b7c3f1d
TT
1348 To illustrate the example, consider the following probe argument
1349 (i386):
fb14eb08
TT
1350
1351 4@%ax
1352
2b7c3f1d
TT
1353 This argument says that its value can be found at the %ax register,
1354 which is a 16-bit register. However, the argument's prefix says
1355 that its type is "uint32_t", which is 32-bit in size. Therefore, in
1356 this case, GDB should actually fetch the probe's value from register
1357 %eax, not %ax. In this scenario, this function would actually
1358 replace the register name from %ax to %eax.
fb14eb08 1359
2b7c3f1d
TT
1360 The rationale for this can be found at PR breakpoints/24541. */
1361
1362extern bool gdbarch_stap_adjust_register_p (struct gdbarch *gdbarch);
1363
1364typedef std::string (gdbarch_stap_adjust_register_ftype) (struct gdbarch *gdbarch, struct stap_parse_info *p, const std::string &regname, int regnum);
1365extern std::string gdbarch_stap_adjust_register (struct gdbarch *gdbarch, struct stap_parse_info *p, const std::string &regname, int regnum);
1366extern void set_gdbarch_stap_adjust_register (struct gdbarch *gdbarch, gdbarch_stap_adjust_register_ftype *stap_adjust_register);
1367
1368/* DTrace related functions.
1369 The expression to compute the NARTGth+1 argument to a DTrace USDT probe.
1370 NARG must be >= 0. */
1371
1372extern bool gdbarch_dtrace_parse_probe_argument_p (struct gdbarch *gdbarch);
1373
1374typedef expr::operation_up (gdbarch_dtrace_parse_probe_argument_ftype) (struct gdbarch *gdbarch, int narg);
1375extern expr::operation_up gdbarch_dtrace_parse_probe_argument (struct gdbarch *gdbarch, int narg);
1376extern void set_gdbarch_dtrace_parse_probe_argument (struct gdbarch *gdbarch, gdbarch_dtrace_parse_probe_argument_ftype *dtrace_parse_probe_argument);
1377
1378/* True if the given ADDR does not contain the instruction sequence
1379 corresponding to a disabled DTrace is-enabled probe. */
1380
1381extern bool gdbarch_dtrace_probe_is_enabled_p (struct gdbarch *gdbarch);
1382
1383typedef int (gdbarch_dtrace_probe_is_enabled_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1384extern int gdbarch_dtrace_probe_is_enabled (struct gdbarch *gdbarch, CORE_ADDR addr);
1385extern void set_gdbarch_dtrace_probe_is_enabled (struct gdbarch *gdbarch, gdbarch_dtrace_probe_is_enabled_ftype *dtrace_probe_is_enabled);
1386
1387/* Enable a DTrace is-enabled probe at ADDR. */
1388
1389extern bool gdbarch_dtrace_enable_probe_p (struct gdbarch *gdbarch);
1390
1391typedef void (gdbarch_dtrace_enable_probe_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1392extern void gdbarch_dtrace_enable_probe (struct gdbarch *gdbarch, CORE_ADDR addr);
1393extern void set_gdbarch_dtrace_enable_probe (struct gdbarch *gdbarch, gdbarch_dtrace_enable_probe_ftype *dtrace_enable_probe);
1394
1395/* Disable a DTrace is-enabled probe at ADDR. */
1396
1397extern bool gdbarch_dtrace_disable_probe_p (struct gdbarch *gdbarch);
1398
1399typedef void (gdbarch_dtrace_disable_probe_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1400extern void gdbarch_dtrace_disable_probe (struct gdbarch *gdbarch, CORE_ADDR addr);
1401extern void set_gdbarch_dtrace_disable_probe (struct gdbarch *gdbarch, gdbarch_dtrace_disable_probe_ftype *dtrace_disable_probe);
1402
1403/* True if the list of shared libraries is one and only for all
1404 processes, as opposed to a list of shared libraries per inferior.
1405 This usually means that all processes, although may or may not share
1406 an address space, will see the same set of symbols at the same
1407 addresses. */
1408
1409extern int gdbarch_has_global_solist (struct gdbarch *gdbarch);
1410extern void set_gdbarch_has_global_solist (struct gdbarch *gdbarch, int has_global_solist);
1411
1412/* On some targets, even though each inferior has its own private
1413 address space, the debug interface takes care of making breakpoints
1414 visible to all address spaces automatically. For such cases,
1415 this property should be set to true. */
1416
1417extern int gdbarch_has_global_breakpoints (struct gdbarch *gdbarch);
1418extern void set_gdbarch_has_global_breakpoints (struct gdbarch *gdbarch, int has_global_breakpoints);
1419
1420/* True if inferiors share an address space (e.g., uClinux). */
1421
1422typedef int (gdbarch_has_shared_address_space_ftype) (struct gdbarch *gdbarch);
1423extern int gdbarch_has_shared_address_space (struct gdbarch *gdbarch);
1424extern void set_gdbarch_has_shared_address_space (struct gdbarch *gdbarch, gdbarch_has_shared_address_space_ftype *has_shared_address_space);
1425
1426/* True if a fast tracepoint can be set at an address. */
1427
1428typedef int (gdbarch_fast_tracepoint_valid_at_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr, std::string *msg);
1429extern int gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, CORE_ADDR addr, std::string *msg);
1430extern void set_gdbarch_fast_tracepoint_valid_at (struct gdbarch *gdbarch, gdbarch_fast_tracepoint_valid_at_ftype *fast_tracepoint_valid_at);
1431
1432/* Guess register state based on tracepoint location. Used for tracepoints
1433 where no registers have been collected, but there's only one location,
1434 allowing us to guess the PC value, and perhaps some other registers.
1435 On entry, regcache has all registers marked as unavailable. */
1436
1437typedef void (gdbarch_guess_tracepoint_registers_ftype) (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1438extern void gdbarch_guess_tracepoint_registers (struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr);
1439extern void set_gdbarch_guess_tracepoint_registers (struct gdbarch *gdbarch, gdbarch_guess_tracepoint_registers_ftype *guess_tracepoint_registers);
1440
1441/* Return the "auto" target charset. */
1442
fb14eb08 1443typedef const char * (gdbarch_auto_charset_ftype) ();
2b7c3f1d
TT
1444extern const char * gdbarch_auto_charset (struct gdbarch *gdbarch);
1445extern void set_gdbarch_auto_charset (struct gdbarch *gdbarch, gdbarch_auto_charset_ftype *auto_charset);
1446
1447/* Return the "auto" target wide charset. */
1448
fb14eb08 1449typedef const char * (gdbarch_auto_wide_charset_ftype) ();
2b7c3f1d
TT
1450extern const char * gdbarch_auto_wide_charset (struct gdbarch *gdbarch);
1451extern void set_gdbarch_auto_wide_charset (struct gdbarch *gdbarch, gdbarch_auto_wide_charset_ftype *auto_wide_charset);
1452
1453/* If non-empty, this is a file extension that will be opened in place
1454 of the file extension reported by the shared library list.
fb14eb08 1455
2b7c3f1d
TT
1456 This is most useful for toolchains that use a post-linker tool,
1457 where the names of the files run on the target differ in extension
1458 compared to the names of the files GDB should load for debug info. */
1459
1460extern const char * gdbarch_solib_symbols_extension (struct gdbarch *gdbarch);
1461extern void set_gdbarch_solib_symbols_extension (struct gdbarch *gdbarch, const char * solib_symbols_extension);
1462
1463/* If true, the target OS has DOS-based file system semantics. That
1464 is, absolute paths include a drive name, and the backslash is
1465 considered a directory separator. */
1466
1467extern int gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch);
1468extern void set_gdbarch_has_dos_based_file_system (struct gdbarch *gdbarch, int has_dos_based_file_system);
1469
1470/* Generate bytecodes to collect the return address in a frame.
1471 Since the bytecodes run on the target, possibly with GDB not even
1472 connected, the full unwinding machinery is not available, and
1473 typically this function will issue bytecodes for one or more likely
1474 places that the return address may be found. */
1475
1476typedef void (gdbarch_gen_return_address_ftype) (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1477extern void gdbarch_gen_return_address (struct gdbarch *gdbarch, struct agent_expr *ax, struct axs_value *value, CORE_ADDR scope);
1478extern void set_gdbarch_gen_return_address (struct gdbarch *gdbarch, gdbarch_gen_return_address_ftype *gen_return_address);
1479
1480/* Implement the "info proc" command. */
1481
1482extern bool gdbarch_info_proc_p (struct gdbarch *gdbarch);
1483
1484typedef void (gdbarch_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1485extern void gdbarch_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1486extern void set_gdbarch_info_proc (struct gdbarch *gdbarch, gdbarch_info_proc_ftype *info_proc);
1487
1488/* Implement the "info proc" command for core files. Noe that there
1489 are two "info_proc"-like methods on gdbarch -- one for core files,
1490 one for live targets. */
1491
1492extern bool gdbarch_core_info_proc_p (struct gdbarch *gdbarch);
1493
1494typedef void (gdbarch_core_info_proc_ftype) (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1495extern void gdbarch_core_info_proc (struct gdbarch *gdbarch, const char *args, enum info_proc_what what);
1496extern void set_gdbarch_core_info_proc (struct gdbarch *gdbarch, gdbarch_core_info_proc_ftype *core_info_proc);
1497
1498/* Iterate over all objfiles in the order that makes the most sense
1499 for the architecture to make global symbol searches.
fb14eb08 1500
6e9cd73e
SM
1501 CB is a callback function passed an objfile to be searched. The iteration stops
1502 if this function returns nonzero.
fb14eb08 1503
2b7c3f1d
TT
1504 If not NULL, CURRENT_OBJFILE corresponds to the objfile being
1505 inspected when the symbol search was requested. */
1506
6e9cd73e
SM
1507typedef void (gdbarch_iterate_over_objfiles_in_search_order_ftype) (struct gdbarch *gdbarch, iterate_over_objfiles_in_search_order_cb_ftype cb, struct objfile *current_objfile);
1508extern void gdbarch_iterate_over_objfiles_in_search_order (struct gdbarch *gdbarch, iterate_over_objfiles_in_search_order_cb_ftype cb, struct objfile *current_objfile);
2b7c3f1d
TT
1509extern 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);
1510
1511/* Ravenscar arch-dependent ops. */
1512
1513extern struct ravenscar_arch_ops * gdbarch_ravenscar_ops (struct gdbarch *gdbarch);
1514extern void set_gdbarch_ravenscar_ops (struct gdbarch *gdbarch, struct ravenscar_arch_ops * ravenscar_ops);
1515
1516/* Return non-zero if the instruction at ADDR is a call; zero otherwise. */
1517
1518typedef int (gdbarch_insn_is_call_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1519extern int gdbarch_insn_is_call (struct gdbarch *gdbarch, CORE_ADDR addr);
1520extern void set_gdbarch_insn_is_call (struct gdbarch *gdbarch, gdbarch_insn_is_call_ftype *insn_is_call);
1521
1522/* Return non-zero if the instruction at ADDR is a return; zero otherwise. */
1523
1524typedef int (gdbarch_insn_is_ret_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1525extern int gdbarch_insn_is_ret (struct gdbarch *gdbarch, CORE_ADDR addr);
1526extern void set_gdbarch_insn_is_ret (struct gdbarch *gdbarch, gdbarch_insn_is_ret_ftype *insn_is_ret);
1527
1528/* Return non-zero if the instruction at ADDR is a jump; zero otherwise. */
1529
1530typedef int (gdbarch_insn_is_jump_ftype) (struct gdbarch *gdbarch, CORE_ADDR addr);
1531extern int gdbarch_insn_is_jump (struct gdbarch *gdbarch, CORE_ADDR addr);
1532extern void set_gdbarch_insn_is_jump (struct gdbarch *gdbarch, gdbarch_insn_is_jump_ftype *insn_is_jump);
1533
1534/* Return true if there's a program/permanent breakpoint planted in
1535 memory at ADDRESS, return false otherwise. */
1536
1537typedef bool (gdbarch_program_breakpoint_here_p_ftype) (struct gdbarch *gdbarch, CORE_ADDR address);
1538extern bool gdbarch_program_breakpoint_here_p (struct gdbarch *gdbarch, CORE_ADDR address);
1539extern void set_gdbarch_program_breakpoint_here_p (struct gdbarch *gdbarch, gdbarch_program_breakpoint_here_p_ftype *program_breakpoint_here_p);
1540
1541/* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
1542 Return 0 if *READPTR is already at the end of the buffer.
1543 Return -1 if there is insufficient buffer for a whole entry.
1544 Return 1 if an entry was read into *TYPEP and *VALP. */
1545
1546extern bool gdbarch_auxv_parse_p (struct gdbarch *gdbarch);
1547
3fe639b8
SM
1548typedef int (gdbarch_auxv_parse_ftype) (struct gdbarch *gdbarch, const gdb_byte **readptr, const gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
1549extern int gdbarch_auxv_parse (struct gdbarch *gdbarch, const gdb_byte **readptr, const gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp);
2b7c3f1d
TT
1550extern void set_gdbarch_auxv_parse (struct gdbarch *gdbarch, gdbarch_auxv_parse_ftype *auxv_parse);
1551
1552/* Print the description of a single auxv entry described by TYPE and VAL
1553 to FILE. */
1554
1555typedef void (gdbarch_print_auxv_entry_ftype) (struct gdbarch *gdbarch, struct ui_file *file, CORE_ADDR type, CORE_ADDR val);
1556extern void gdbarch_print_auxv_entry (struct gdbarch *gdbarch, struct ui_file *file, CORE_ADDR type, CORE_ADDR val);
1557extern void set_gdbarch_print_auxv_entry (struct gdbarch *gdbarch, gdbarch_print_auxv_entry_ftype *print_auxv_entry);
1558
1559/* Find the address range of the current inferior's vsyscall/vDSO, and
1560 write it to *RANGE. If the vsyscall's length can't be determined, a
1561 range with zero length is returned. Returns true if the vsyscall is
1562 found, false otherwise. */
1563
1564typedef int (gdbarch_vsyscall_range_ftype) (struct gdbarch *gdbarch, struct mem_range *range);
1565extern int gdbarch_vsyscall_range (struct gdbarch *gdbarch, struct mem_range *range);
1566extern void set_gdbarch_vsyscall_range (struct gdbarch *gdbarch, gdbarch_vsyscall_range_ftype *vsyscall_range);
1567
1568/* Allocate SIZE bytes of PROT protected page aligned memory in inferior.
1569 PROT has GDB_MMAP_PROT_* bitmask format.
1570 Throw an error if it is not possible. Returned address is always valid. */
1571
1572typedef CORE_ADDR (gdbarch_infcall_mmap_ftype) (CORE_ADDR size, unsigned prot);
1573extern CORE_ADDR gdbarch_infcall_mmap (struct gdbarch *gdbarch, CORE_ADDR size, unsigned prot);
1574extern void set_gdbarch_infcall_mmap (struct gdbarch *gdbarch, gdbarch_infcall_mmap_ftype *infcall_mmap);
1575
1576/* Deallocate SIZE bytes of memory at ADDR in inferior from gdbarch_infcall_mmap.
1577 Print a warning if it is not possible. */
1578
1579typedef void (gdbarch_infcall_munmap_ftype) (CORE_ADDR addr, CORE_ADDR size);
1580extern void gdbarch_infcall_munmap (struct gdbarch *gdbarch, CORE_ADDR addr, CORE_ADDR size);
1581extern void set_gdbarch_infcall_munmap (struct gdbarch *gdbarch, gdbarch_infcall_munmap_ftype *infcall_munmap);
1582
1583/* Return string (caller has to use xfree for it) with options for GCC
1584 to produce code for this target, typically "-m64", "-m32" or "-m31".
1585 These options are put before CU's DW_AT_producer compilation options so that
1586 they can override it. */
1587
1588typedef std::string (gdbarch_gcc_target_options_ftype) (struct gdbarch *gdbarch);
1589extern std::string gdbarch_gcc_target_options (struct gdbarch *gdbarch);
1590extern void set_gdbarch_gcc_target_options (struct gdbarch *gdbarch, gdbarch_gcc_target_options_ftype *gcc_target_options);
1591
1592/* Return a regular expression that matches names used by this
1593 architecture in GNU configury triplets. The result is statically
1594 allocated and must not be freed. The default implementation simply
1595 returns the BFD architecture name, which is correct in nearly every
1596 case. */
1597
1598typedef const char * (gdbarch_gnu_triplet_regexp_ftype) (struct gdbarch *gdbarch);
1599extern const char * gdbarch_gnu_triplet_regexp (struct gdbarch *gdbarch);
1600extern void set_gdbarch_gnu_triplet_regexp (struct gdbarch *gdbarch, gdbarch_gnu_triplet_regexp_ftype *gnu_triplet_regexp);
1601
1602/* Return the size in 8-bit bytes of an addressable memory unit on this
1603 architecture. This corresponds to the number of 8-bit bytes associated to
1604 each address in memory. */
1605
1606typedef int (gdbarch_addressable_memory_unit_size_ftype) (struct gdbarch *gdbarch);
1607extern int gdbarch_addressable_memory_unit_size (struct gdbarch *gdbarch);
1608extern void set_gdbarch_addressable_memory_unit_size (struct gdbarch *gdbarch, gdbarch_addressable_memory_unit_size_ftype *addressable_memory_unit_size);
1609
1610/* Functions for allowing a target to modify its disassembler options. */
1611
1612extern const char * gdbarch_disassembler_options_implicit (struct gdbarch *gdbarch);
1613extern void set_gdbarch_disassembler_options_implicit (struct gdbarch *gdbarch, const char * disassembler_options_implicit);
1614
1615extern char ** gdbarch_disassembler_options (struct gdbarch *gdbarch);
1616extern void set_gdbarch_disassembler_options (struct gdbarch *gdbarch, char ** disassembler_options);
1617
1618extern const disasm_options_and_args_t * gdbarch_valid_disassembler_options (struct gdbarch *gdbarch);
1619extern void set_gdbarch_valid_disassembler_options (struct gdbarch *gdbarch, const disasm_options_and_args_t * valid_disassembler_options);
1620
1621/* Type alignment override method. Return the architecture specific
1622 alignment required for TYPE. If there is no special handling
1623 required for TYPE then return the value 0, GDB will then apply the
1624 default rules as laid out in gdbtypes.c:type_align. */
1625
1626typedef ULONGEST (gdbarch_type_align_ftype) (struct gdbarch *gdbarch, struct type *type);
1627extern ULONGEST gdbarch_type_align (struct gdbarch *gdbarch, struct type *type);
1628extern void set_gdbarch_type_align (struct gdbarch *gdbarch, gdbarch_type_align_ftype *type_align);
1629
1630/* Return a string containing any flags for the given PC in the given FRAME. */
1631
bd2b40ac
TT
1632typedef std::string (gdbarch_get_pc_address_flags_ftype) (frame_info_ptr frame, CORE_ADDR pc);
1633extern std::string gdbarch_get_pc_address_flags (struct gdbarch *gdbarch, frame_info_ptr frame, CORE_ADDR pc);
2b7c3f1d
TT
1634extern void set_gdbarch_get_pc_address_flags (struct gdbarch *gdbarch, gdbarch_get_pc_address_flags_ftype *get_pc_address_flags);
1635
1636/* Read core file mappings */
1637
1638typedef void (gdbarch_read_core_file_mappings_ftype) (struct gdbarch *gdbarch, struct bfd *cbfd, read_core_file_mappings_pre_loop_ftype pre_loop_cb, read_core_file_mappings_loop_ftype loop_cb);
1639extern void gdbarch_read_core_file_mappings (struct gdbarch *gdbarch, struct bfd *cbfd, read_core_file_mappings_pre_loop_ftype pre_loop_cb, read_core_file_mappings_loop_ftype loop_cb);
1640extern void set_gdbarch_read_core_file_mappings (struct gdbarch *gdbarch, gdbarch_read_core_file_mappings_ftype *read_core_file_mappings);