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