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