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